Part Search Relevancy

The Part Search Relevancy event us used to report that the user found the referenced part relevant or even irrelevant to the part being searched. This event is defined with a set of pre-defined options to be able to segment the different scenarios consistently.

The event is designed to contemplate a user making one choice only among the following relevancyvalues (see other fields in the body of the event below). References to the Partium app are provided for guidance and illustration purposes.

• matches_search_exactly: the user knows certainly that the part is exactly the one searched for. This is the “Yes” option in the Partium app. Note that the interpretation of this choice may be temporal. For final indications of the one real match see Event: Part Confirmation.
• best_match: the part is the best match in terms of closeness to the part the user was searching for. This option could be used for instance, when the user visually searches for an object that is not in the catalog but very close alternatives can be found.
• not_match_but_related: the part is related to the search for instance because they're typically ordered together.
• needs_check_elsewhere: the user is not certain whether this is the correct match and may do some checks in other systems. This is the “I don’t know yet” option in the Partium app.
• not_relevant: the user knows certainly that this is not relevant to the part that was being searched. This is the “No” option in the Partium app.
• other: catch for other cases. This is the “None of the above” option in the Partium app.

The list might evolve over time. The Versioning and ChangeLog page should indicate any change to the list of options. Knowing that a particular part is relevant to what the user was searching for helps improve the performance of the Partium Search Engine.

How to register this event

In order to register this event, use the Analytics API as described in the Getting started article. See the next section for the specific field values for this event.

Field values for this event

Request body field	Value
event	part_relevancy_to_search
data.partium_id	UUID of the part in Partium.
data.search_session_id	UUID of the search session.
data.relevancy	Single choice among the options listed above.
data.index	Index number from the list of parts the user was viewing from which the match was found. The top position would be 0. The pattern for this field is ^([0-9]+).

For references about how to obtain the partium_id and the search_session_id, refer to SearchResult of the Find API and SearchOutput of the Find SDK.

Example JSON schema

{
  "event": "part_relevancy_to_search",
  "data": {
    "partium_id": "641d6c1c-c2b8-4192-977c-c7c5a22dfc20",
    "search_session_id": "de8977f6-b8cb-4669-8e82-c4fa75acac41",
    "relevancy": "needs_check_elsewhere",
    "index": "4"
  }
}