Define attributes

The attribute filters allow you to define which item features are available in the search results, which features the customers can use to filter the results, and so on.

The configuration of attributes in AI Search
The configuration of attributes in AI Search

To configure the attributes, go to AI Search. Create an index or select an existing one from the list. Go to the Settings tab. In the appropriate attribute section, click Define.

Note: The settings are saved automatically as you modify them.

Response attributes

This section defines which attributes will be included in the search response. For each item returned, only attributes defined in this section will be available in the search response. Only attributes defined in this section will be available in the search response so you can show them to the customers.

Searchable attributes

Searchable attributes are the main component of the index. These attributes are used by the search engine to calculate the item’s relevance to the query phrase provided by the customer.

Attributes can be assigned to three importance levels: high, medium and low. When a word from the phrase matches an attribute, the item’s score is assigned depending on this importance.

Filterable attributes

Filterable attributes are those that are enabled for use in item filters for including or excluding results.

Including an attribute value narrows down the search results to items with that attribute value. Excluding values of an attribute displays results with items that have different values of these attributes.

Examples

  • Products in your catalog have the sale attribute which can take the true (on sale) or false value. Include sale as a filterable attribute. Now, you can filter the results by the items’ sale status.
  • Products in your catalog have the last_item attribute that can take the yes(one item is available) or no (more than 1 item is on stock) values. Exclude last_item as a filterable attribute. Now, you can filter the items that have one item left from the search results.
  • You want to filter out the products that cost more than $100. Include price as the range-type filterable attribute and in the settings, filter items where price is equal to or greater than 100$.

Facetable attributes

Choose attributes that can be use as facets. Facets allow customers to sort search results by attributes and their values. For example, you can use the color attribute as facetable to let the customers select which colors they’re interested in.

The search result also includes information how many items have a particular value of a facetable attribute.

For a live example, see our use cases. “Challenges”, “Channel”, “Difficulty”, and so on are facetable attributes.

Example

You want to give a customer a possibility to filter results by some attributes - color and brand. Add these attributes to the Facetable attributes section. When this is done, the customers will be able to narrow down the results of the filter to desired brand and color of the item and additionally they will be shown information about the number of items in each facet in the search response. This information can be displayed along with the search results and based on that filtering can be applied to the results.

WARNING:
  1. The returned facets in the search response contain the top 50 distinct attribute values.
  2. The sum of distinct attribute values, for filterable and facetable attributes, can’t exceed 10000.
    That means that if the X attribute has 5000 different values and the Y attribute has 5000 different values, they cannot be used in filterable attributes at the same time. Remember that 10000 distinct values are shared for filterable AND facetable attributes. Therefore, we do not recommend filtering and/or faceting with attributes that have many distinct values in the item feed.

Sortable attributes

You can enable sorting the results by the chosen attributes. You can add both range and text attributes. Sorting by range attributes allows you to arrange the returned items from highest to lowest value of the specified attribute. Sorting by text attributes allows you to order the results in an alphabetic order, ascending or descending.

😕

We are sorry to hear that

Thank you for helping improve out documentation. If you need help or have any questions, please consider contacting support.

😉

Awesome!

Thank you for helping improve out documentation. If you need help or have any questions, please consider contacting support.

Close modal icon Placeholder alt for modal to satisfy link checker