The list of attributes you want to use for faceting. Also called filtering, faceted search is the dynamic clustering of records into categories that allows users to filter the search results by any value of an attribute.
If enabled, this option allows you to search inside values of a given facet.
The number of hits per page (default = 20).
This is the number of search results that the API will return in the JSON answer.
The list of attributes to snippet alongside the number of words to return. If not set, no snippet is computed.
A snippet is a subset of the words of the attributes. You can use it to display only N words of an attribute instead of the whole value.
Default list of attributes to highlight when they match a query. If not set, all indexed attributes are highlighted.
Specify the string that is inserted before the highlighted parts in the query result (defaults to <em>
).
Specify the string that is inserted after the highlighted parts in the query result (defaults to </em>
).
This feature is similar to the SQL DISTINCT
keyword: when enabled in a query with the distinct=1
parameter, all hits containing a duplicate value for theattributeForDistinct
attribute are removed from results. For example, if the chosen attribute is show_name
and several hits have the same value for show_name,
then only the best one is kept and others are removed.
The attribute used for the Distinct feature. This feature is similar to the SQL "distinct" one: when enabled at query-time with the distinct=true
parameter, all hits containing a duplicated value for this attribute are removed from results.
For example in a blog, if you have distinct=true
and the attribute author
, you'll retrieve only the first article of each author.
If you have distinct=2
, you'll get 2 articles per author.