Add or update a composition rule

If a composition rule with the provided ID already exists, it’s replaced. Otherwise, a new one is added.

PUT /1/compositions/{compositionID}/rules/{objectID}

curl

cURL

curl --request PUT \
  --url https://algolia_application_id.algolia.net/1/compositions/my_composition_object_id/rules/lorem \
  --header 'accept: application/json' \
  --header 'content-type: application/json' \
  --header 'x-algolia-api-key: ALGOLIA_API_KEY' \
  --header 'x-algolia-application-id: ALGOLIA_APPLICATION_ID' \
  --data '{"objectID":"my_composition_rule_object_id","conditions":[{"pattern":"{facet:genre}","anchoring":"is","context":"mobile","filters":"genre:comedy","sortBy":"price-low-to-high"}],"consequence":{"behavior":{"injection":{"main":{"source":{"search":{"index":"Products","params":{"advancedSyntax":false,"advancedSyntaxFeatures":["exactPhrase","excludeWords"],"allowTyposOnNumericTokens":true,"alternativesAsExact":["ignorePlurals","singleWordSynonym"],"analytics":true,"attributeCriteriaComputedByMinProximity":false,"attributesToHighlight":["author","title","conten","content"],"attributesToRetrieve":["author","title","content"],"attributesToSnippet":["content:80","description"],"clickAnalytics":false,"decompoundQuery":true,"disableExactOnAttributes":["description"],"disableTypoToleranceOnAttributes":["sku"],"distinct":1,"enableABTest":true,"enablePersonalization":false,"enableReRanking":true,"enableRules":true,"exactOnSingleWordQuery":"attribute","facetFilters":[["category:Book","category:-Movie"],"author:John Doe"],"filters":"(category:Book OR category:Ebook) AND _tags:published","getRankingInfo":false,"highlightPostTag":"</em>","highlightPreTag":"<em>","ignorePlurals":["ca","es"],"maxFacetHits":10,"minProximity":1,"minWordSizefor1Typo":4,"minWordSizefor2Typos":8,"naturalLanguages":[],"numericFilters":[["inStock = 1","deliveryDate < 1441755506"],"price < 1000"],"optionalFilters":["category:Book","author:John Doe"],"optionalWords":"lorem","percentileComputation":true,"personalizationImpact":100,"queryLanguages":["es"],"queryType":"prefixLast","removeStopWords":["ca","es"],"removeWordsIfNoResults":"firstWords","replaceSynonymsInHighlight":false,"responseFields":["*"],"restrictHighlightAndSnippetArrays":false,"restrictSearchableAttributes":["title","author"],"ruleContexts":["mobile"],"snippetEllipsisText":"…","synonyms":true,"typoTolerance":true,"facetingAfterDistinct":false,"facets":{"facetSpecificList":{"summary":"Specify which facet to retrieve with some marked as disjunctive","value":[["category","disjunctive(brand)","price"]]},"facetAll":{"summary":"Retrieve all facets","value":[["*"]]}},"hitsPerPage":20,"maxValuesPerFacet":100,"renderingContent":{"facetOrdering":{"facets":{"order":["lorem"]},"values":{"property1":{"order":["lorem"],"sortRemainingBy":"count","hide":["lorem"]},"property2":{"order":["lorem"],"sortRemainingBy":"count","hide":["lorem"]}}},"redirect":{"url":"lorem"},"widgets":{"banners":[{"image":{"urls":[{"url":"lorem"}],"title":"lorem"},"link":{"url":"lorem"}}]}},"sortFacetValuesBy":"count","sumOrFiltersScores":false}}}},"injectedItems":[{"key":"lorem","source":{"search":{"index":"Products","params":{"advancedSyntax":false,"advancedSyntaxFeatures":["exactPhrase","excludeWords"],"allowTyposOnNumericTokens":true,"alternativesAsExact":["ignorePlurals","singleWordSynonym"],"analytics":true,"attributeCriteriaComputedByMinProximity":false,"attributesToHighlight":["author","title","conten","content"],"attributesToRetrieve":["author","title","content"],"attributesToSnippet":["content:80","description"],"clickAnalytics":false,"decompoundQuery":true,"disableExactOnAttributes":["description"],"disableTypoToleranceOnAttributes":["sku"],"distinct":1,"enableABTest":true,"enablePersonalization":false,"enableReRanking":true,"enableRules":true,"exactOnSingleWordQuery":"attribute","facetFilters":[["category:Book","category:-Movie"],"author:John Doe"],"filters":"(category:Book OR category:Ebook) AND _tags:published","getRankingInfo":false,"highlightPostTag":"</em>","highlightPreTag":"<em>","ignorePlurals":["ca","es"],"maxFacetHits":10,"minProximity":1,"minWordSizefor1Typo":4,"minWordSizefor2Typos":8,"naturalLanguages":[],"numericFilters":[["inStock = 1","deliveryDate < 1441755506"],"price < 1000"],"optionalFilters":["category:Book","author:John Doe"],"optionalWords":"lorem","percentileComputation":true,"personalizationImpact":100,"queryLanguages":["es"],"queryType":"prefixLast","removeStopWords":["ca","es"],"removeWordsIfNoResults":"firstWords","replaceSynonymsInHighlight":false,"responseFields":["*"],"restrictHighlightAndSnippetArrays":false,"restrictSearchableAttributes":["title","author"],"ruleContexts":["mobile"],"snippetEllipsisText":"…","synonyms":true,"typoTolerance":true}}},"position":0,"length":0,"metadata":{"hits":{"addItemKey":true,"extra":{}}}}],"deduplication":{"positioning":"highest"}}}},"description":"Display a promotional banner","enabled":true,"validity":[{"from":42,"until":42}],"tags":["conditional"]}'

200

{
  "taskID": 1514562690001
}

Required ACL: editSettings

Authorizations

x-algolia-application-id · string · header · required

Your Algolia application ID.

x-algolia-api-key · string · header · required

Your Algolia API key with the necessary permissions to make the request. Permissions are controlled through access control lists (ACL) and access restrictions. The required ACL to make a request is listed in each endpoint's reference.

Path Parameters

compositionID · string · required

Unique Composition ObjectID. Composition unique identifier.

Example:

"my_composition_object_id"

objectID · string · required

Unique identifier of a rule object.

Body

application/json

objectID · string · required

Composition rule unique identifier.

Example:

"my_composition_rule_object_id"

conditions · object[] · required

Conditions that trigger a composition rule.

Maximum array length: 25

Show child attributes

conditions. pattern · string

Query pattern that triggers the rule.

You can use either a literal string, or a special pattern {facet:ATTRIBUTE}, where ATTRIBUTE is a facet name. The rule is triggered if the query matches the literal string or a value of the specified facet. For example, with pattern: {facet:genre}, the rule is triggered when users search for a genre, such as "comedy".

Example:

"{facet:genre}"

conditions. anchoring · enum<string>

Which part of the search query the pattern should match:

• startsWith. The pattern must match the beginning of the query.
• endsWith. The pattern must match the end of the query.
• is. The pattern must match the query exactly.
• contains. The pattern must match anywhere in the query.

Empty queries are only allowed as patterns with anchoring: is.

Available options: is, startsWith, endsWith, contains

conditions. context · string

An additional restriction that only triggers the rule, when the search has the same value as ruleContexts parameter. For example, if context: mobile, the rule is only triggered when the search request has a matching ruleContexts: mobile. A rule context must only contain alphanumeric characters.

Example:

"mobile"

conditions. filters · string

Filters that trigger the rule.

You can add add filters using the syntax facet:value so that the rule is triggered, when the specific filter is selected. You can use filters on its own or combine it with the pattern parameter.

Example:

"genre:comedy"

conditions. sortBy · string

Sort criteria that trigger the rule.

You can trigger composition rules based on the selected sorting strategy set by the parameter sortBy. The rule will trigger if the value passed to sortBy matches the one defined in the condition.

Example:

"price-low-to-high"

consequence · compositionRuleConsequence · object · required

Effect of the rule.

Show child attributes

consequence. behavior · object · required

Show child attributes

consequence.behavior. injection · injection · object · required

Show child attributes

consequence.behavior.injection. main · main · object · required

Show child attributes

consequence.behavior.injection.main. source · compositionSource · object · required

Show child attributes

consequence.behavior.injection.main.source. search · compositionSourceSearch · object · required

Show child attributes

consequence.behavior.injection.main.source.search. index · string · required

Composition Main Index name.

Example:

"Products"

consequence.behavior.injection.main.source.search. params · Composition Main Injection Query parameters as object · object

Show child attributes

consequence.behavior.injection.main.source.search.params. advancedSyntax · boolean · default: false

Whether to support phrase matching and excluding words from search queries Use the advancedSyntaxFeatures parameter to control which feature is supported.

consequence.behavior.injection.main.source.search.params. advancedSyntaxFeatures · enum<string>[]

Advanced search syntax features you want to support

• exactPhrase. Phrases in quotes must match exactly. For example, sparkly blue "iPhone case" only returns records with the exact string "iPhone case"
• excludeWords. Query words prefixed with a - must not occur in a record. For example, search -engine matches records that contain "search" but not "engine" This setting only has an effect if advancedSyntax is true.

Available options: exactPhrase, excludeWords

consequence.behavior.injection.main.source.search.params. allowTyposOnNumericTokens · boolean · default: true

Whether to allow typos on numbers in the search query Turn off this setting to reduce the number of irrelevant matches when searching in large sets of similar numbers.

consequence.behavior.injection.main.source.search.params. alternativesAsExact · enum<string>[]

Determine which plurals and synonyms should be considered an exact matches By default, Algolia treats singular and plural forms of a word, and single-word synonyms, as exact matches when searching. For example

• "swimsuit" and "swimsuits" are treated the same
• "swimsuit" and "swimwear" are treated the same (if they are synonyms)
• ignorePlurals. Plurals and similar declensions added by the ignorePlurals setting are considered exact matches
• singleWordSynonym. Single-word synonyms, such as "NY" = "NYC", are considered exact matches
• multiWordsSynonym. Multi-word synonyms, such as "NY" = "New York", are considered exact matches.

Available options: ignorePlurals, singleWordSynonym, multiWordsSynonym, ignoreConjugations

consequence.behavior.injection.main.source.search.params. analytics · boolean · default: true

Whether this search will be included in Analytics.

consequence.behavior.injection.main.source.search.params. attributeCriteriaComputedByMinProximity · boolean · default: false

Whether the best matching attribute should be determined by minimum proximity This setting only affects ranking if the Attribute ranking criterion comes before Proximity in the ranking setting. If true, the best matching attribute is selected based on the minimum proximity of multiple matches. Otherwise, the best matching attribute is determined by the order in the searchableAttributes setting.

consequence.behavior.injection.main.source.search.params. attributesToHighlight · string[]

Attributes to highlight By default, all searchable attributes are highlighted. Use * to highlight all attributes or use an empty array [] to turn off highlighting. Attribute names are case-sensitive With highlighting, strings that match the search query are surrounded by HTML tags defined by highlightPreTag and highlightPostTag. You can use this to visually highlight matching parts of a search query in your UI For more information, see Highlighting and snippeting.

Example:

["author", "title", "conten", "content"]

consequence.behavior.injection.main.source.search.params. attributesToRetrieve · string[]

Attributes to include in the API response To reduce the size of your response, you can retrieve only some of the attributes. Attribute names are case-sensitive

• * retrieves all attributes, except attributes included in the customRanking and unretrievableAttributes settings.
• To retrieve all attributes except a specific one, prefix the attribute with a dash and combine it with the *: ["*", "-ATTRIBUTE"].
• The objectID attribute is always included.

Example:

["author", "title", "content"]

consequence.behavior.injection.main.source.search.params. attributesToSnippet · string[]

Attributes for which to enable snippets. Attribute names are case-sensitive Snippets provide additional context to matched words. If you enable snippets, they include 10 words, including the matched word. The matched word will also be wrapped by HTML tags for highlighting. You can adjust the number of words with the following notation: ATTRIBUTE:NUMBER, where NUMBER is the number of words to be extracted.

Example:

["content:80", "description"]

consequence.behavior.injection.main.source.search.params. clickAnalytics · boolean · default: false

Whether to include a queryID attribute in the response The query ID is a unique identifier for a search query and is required for tracking click and conversion events.

consequence.behavior.injection.main.source.search.params. decompoundQuery · boolean · default: true

Whether to split compound words in the query into their building blocks For more information, see Word segmentation. Word segmentation is supported for these languages: German, Dutch, Finnish, Swedish, and Norwegian. Decompounding doesn't work for words with non-spacing mark Unicode characters. For example, Gartenstühle won't be decompounded if the ü consists of u (U+0075) and ◌̈ (U+0308).

consequence.behavior.injection.main.source.search.params. disableExactOnAttributes · string[]

Searchable attributes for which you want to turn off the Exact ranking criterion. Attribute names are case-sensitive This can be useful for attributes with long values, where the likelihood of an exact match is high, such as product descriptions. Turning off the Exact ranking criterion for these attributes favors exact matching on other attributes. This reduces the impact of individual attributes with a lot of content on ranking.

Example:

["description"]

consequence.behavior.injection.main.source.search.params. disableTypoToleranceOnAttributes · string[]

Attributes for which you want to turn off typo tolerance. Attribute names are case-sensitive Returning only exact matches can help when

• Searching in hyphenated attributes.
• Reducing the number of matches when you have too many. This can happen with attributes that are long blocks of text, such as product descriptions Consider alternatives such as disableTypoToleranceOnWords or adding synonyms if your attributes have intentional unusual spellings that might look like typos.

Example:

["sku"]

consequence.behavior.injection.main.source.search.params. distinct

Determines how many records of a group are included in the search results.

Records with the same value for the attributeForDistinct attribute are considered a group. The distinct setting controls how many members of the group are returned. This is useful for deduplication and grouping.

The distinct setting is ignored if attributeForDistinct is not set.

Example:

1

consequence.behavior.injection.main.source.search.params. enableABTest · boolean · default: true

Whether to enable A/B testing for this search.

consequence.behavior.injection.main.source.search.params. enablePersonalization · boolean · default: false

Whether to enable Personalization.

consequence.behavior.injection.main.source.search.params. enableReRanking · boolean · default: true

Whether this search will use Dynamic Re-Ranking This setting only has an effect if you activated Dynamic Re-Ranking for this index in the Algolia dashboard.

consequence.behavior.injection.main.source.search.params. enableRules · boolean · default: true

Whether to enable rules.

consequence.behavior.injection.main.source.search.params. exactOnSingleWordQuery · enum<string> · default: attribute

Determines how the Exact ranking criterion is computed when the search query has only one word.

• attribute. The Exact ranking criterion is 1 if the query word and attribute value are the same. For example, a search for "road" will match the value "road", but not "road trip".

• none. The Exact ranking criterion is ignored on single-word searches.

• word. The Exact ranking criterion is 1 if the query word is found in the attribute value. The query word must have at least 3 characters and must not be a stop word. Only exact matches will be highlighted, partial and prefix matches won't.

Available options: attribute, none, word

consequence.behavior.injection.main.source.search.params. facetFilters

Filter the search by facet values, so that only records with the same facet values are retrieved.

Prefer using the filters parameter, which supports all filter types and combinations with boolean operators.

• [filter1, filter2] is interpreted as filter1 AND filter2.
• [[filter1, filter2], filter3] is interpreted as filter1 OR filter2 AND filter3.
• facet:-value is interpreted as NOT facet:value.

While it's best to avoid attributes that start with a -, you can still filter them by escaping with a backslash: facet:\-value.

Example:

[
  ["category:Book", "category:-Movie"],
  "author:John Doe"
]

consequence.behavior.injection.main.source.search.params. filters · string

Filter expression to only include items that match the filter criteria in the response.

You can use these filter expressions:

• Numeric filters. <facet> <op> <number>, where <op> is one of <, <=, =, !=, >, >=.
• Ranges. <facet>:<lower> TO <upper> where <lower> and <upper> are the lower and upper limits of the range (inclusive).
• Facet filters. <facet>:<value> where <facet> is a facet attribute (case-sensitive) and <value> a facet value.
• Tag filters. _tags:<value> or just <value> (case-sensitive).
• Boolean filters. <facet>: true | false.

You can combine filters with AND, OR, and NOT operators with the following restrictions:

• You can only combine filters of the same type with OR. Not supported: facet:value OR num > 3.
• You can't use NOT with combinations of filters. Not supported: NOT(facet:value OR facet:value)
• You can't combine conjunctions (AND) with OR. Not supported: facet:value OR (facet:value AND facet:value)

Use quotes around your filters, if the facet attribute name or facet value has spaces, keywords (OR, AND, NOT), or quotes. If a facet attribute is an array, the filter matches if it matches at least one element of the array.

For more information, see Filters.

Example:

"(category:Book OR category:Ebook) AND _tags:published"

consequence.behavior.injection.main.source.search.params. getRankingInfo · boolean · default: false

Whether the search response should include detailed ranking information.

consequence.behavior.injection.main.source.search.params. highlightPostTag · string · default: </em>

HTML tag to insert after the highlighted parts in all highlighted results and snippets.

consequence.behavior.injection.main.source.search.params. highlightPreTag · string · default: <em>

HTML tag to insert before the highlighted parts in all highlighted results and snippets.

consequence.behavior.injection.main.source.search.params. ignorePlurals

Treat singular, plurals, and other forms of declensions as equivalent. You should only use this feature for the languages used in your index.

ISO code for a supported language.

Available options: af, ar, az, bg, bn, ca, cs, cy, da, de, el, en, eo, es, et, eu, fa, fi, fo, fr, ga, gl, he, hi, hu, hy, id, is, it, ja, ka, kk, ko, ku, ky, lt, lv, mi, mn, mr, ms, mt, nb, nl, no, ns, pl, ps, pt, pt-br, qu, ro, ru, sk, sq, sv, sw, ta, te, th, tl, tn, tr, tt, uk, ur, uz, zh

Example:

["ca", "es"]

consequence.behavior.injection.main.source.search.params. maxFacetHits · integer · default: 10

Maximum number of facet values to return when searching for facet values.

Required range: x <= 100

consequence.behavior.injection.main.source.search.params. minProximity · integer · default: 1

Minimum proximity score for two matching words This adjusts the Proximity ranking criterion by equally scoring matches that are farther apart For example, if minProximity is 2, neighboring matches and matches with one word between them would have the same score.

Required range: 1 <= x <= 7

consequence.behavior.injection.main.source.search.params. minWordSizefor1Typo · integer · default: 4

Minimum number of characters a word in the search query must contain to accept matches with one typo.

consequence.behavior.injection.main.source.search.params. minWordSizefor2Typos · integer · default: 8

Minimum number of characters a word in the search query must contain to accept matches with two typos.

consequence.behavior.injection.main.source.search.params. naturalLanguages · enum<string>[]

ISO language codes that adjust settings that are useful for processing natural language queries (as opposed to keyword searches)

• Sets removeStopWords and ignorePlurals to the list of provided languages.
• Sets removeWordsIfNoResults to allOptional.
• Adds a natural_language attribute to ruleContexts and analyticsTags.

ISO code for a supported language.

Available options: af, ar, az, bg, bn, ca, cs, cy, da, de, el, en, eo, es, et, eu, fa, fi, fo, fr, ga, gl, he, hi, hu, hy, id, is, it, ja, ka, kk, ko, ku, ky, lt, lv, mi, mn, mr, ms, mt, nb, nl, no, ns, pl, ps, pt, pt-br, qu, ro, ru, sk, sq, sv, sw, ta, te, th, tl, tn, tr, tt, uk, ur, uz, zh

consequence.behavior.injection.main.source.search.params. numericFilters

Filter by numeric facets.

Prefer using the filters parameter, which supports all filter types and combinations with boolean operators.

You can use numeric comparison operators: <, <=, =, !=, >, >=. Comparisons are precise up to 3 decimals. You can also provide ranges: facet:<lower> TO <upper>. The range includes the lower and upper boundaries. The same combination rules apply as for facetFilters.

Example:

[
  ["inStock = 1", "deliveryDate < 1441755506"],
  "price < 1000"
]

consequence.behavior.injection.main.source.search.params. optionalFilters

Filters to promote or demote records in the search results.

Optional filters work like facet filters, but they don't exclude records from the search results. Records that match the optional filter rank before records that don't match. If you're using a negative filter facet:-value, matching records rank after records that don't match.

• Optional filters don't work on virtual replicas.
• Optional filters are applied after sort-by attributes.
• Optional filters are applied before custom ranking attributes (in the default ranking).
• Optional filters don't work with numeric attributes.

Example:

["category:Book", "author:John Doe"]

consequence.behavior.injection.main.source.search.params. optionalWords

Words that should be considered optional when found in the query.

By default, records must match all words in the search query to be included in the search results. Adding optional words can help to increase the number of search results by running an additional search query that doesn't include the optional words. For example, if the search query is "action video" and "video" is an optional word, the search engine runs two queries. One for "action video" and one for "action". Records that match all words are ranked higher.

For a search query with 4 or more words and all its words are optional, the number of matched words required for a record to be included in the search results increases for every 1,000 records:

• If optionalWords has less than 10 words, the required number of matched words increases by 1: results 1 to 1,000 require 1 matched word, results 1,001 to 2000 need 2 matched words.
• If optionalWords has 10 or more words, the number of required matched words increases by the number of optional words divided by 5 (rounded down). For example, with 18 optional words: results 1 to 1,000 require 1 matched word, results 1,001 to 2000 need 4 matched words.

For more information, see Optional words.

consequence.behavior.injection.main.source.search.params. percentileComputation · boolean · default: true

Whether to include this search when calculating processing-time percentiles.

consequence.behavior.injection.main.source.search.params. personalizationImpact · integer · default: 100

Impact that Personalization should have on this search The higher this value is, the more Personalization determines the ranking compared to other factors. For more information, see Understanding Personalization impact.

Required range: 0 <= x <= 100

consequence.behavior.injection.main.source.search.params. queryLanguages · enum<string>[]

Languages for language-specific query processing steps such as plurals, stop-word removal, and word-detection dictionaries This setting sets a default list of languages used by the removeStopWords and ignorePlurals settings. This setting also sets a dictionary for word detection in the logogram-based CJK languages. To support this, you must place the CJK language first You should always specify a query language. If you don't specify an indexing language, the search engine uses all supported languages, or the languages you specified with the ignorePlurals or removeStopWords parameters. This can lead to unexpected search results. For more information, see Language-specific configuration.

ISO code for a supported language.

Available options: af, ar, az, bg, bn, ca, cs, cy, da, de, el, en, eo, es, et, eu, fa, fi, fo, fr, ga, gl, he, hi, hu, hy, id, is, it, ja, ka, kk, ko, ku, ky, lt, lv, mi, mn, mr, ms, mt, nb, nl, no, ns, pl, ps, pt, pt-br, qu, ro, ru, sk, sq, sv, sw, ta, te, th, tl, tn, tr, tt, uk, ur, uz, zh

Example:

["es"]

consequence.behavior.injection.main.source.search.params. queryType · enum<string> · default: prefixLast

Determines if and how query words are interpreted as prefixes.

By default, only the last query word is treated as a prefix (prefixLast). To turn off prefix search, use prefixNone. Avoid prefixAll, which treats all query words as prefixes. This might lead to counterintuitive results and makes your search slower.

For more information, see Prefix searching.

Available options: prefixLast, prefixAll, prefixNone

consequence.behavior.injection.main.source.search.params. removeStopWords

Removes stop words from the search query.

Stop words are common words like articles, conjunctions, prepositions, or pronouns that have little or no meaning on their own. In English, "the", "a", or "and" are stop words.

You should only use this feature for the languages used in your index.

ISO code for a supported language.

Available options: af, ar, az, bg, bn, ca, cs, cy, da, de, el, en, eo, es, et, eu, fa, fi, fo, fr, ga, gl, he, hi, hu, hy, id, is, it, ja, ka, kk, ko, ku, ky, lt, lv, mi, mn, mr, ms, mt, nb, nl, no, ns, pl, ps, pt, pt-br, qu, ro, ru, sk, sq, sv, sw, ta, te, th, tl, tn, tr, tt, uk, ur, uz, zh

Example:

["ca", "es"]

consequence.behavior.injection.main.source.search.params. removeWordsIfNoResults · enum<string> · default: none

Strategy for removing words from the query when it doesn't return any results. This helps to avoid returning empty search results.

• none. No words are removed when a query doesn't return results.

• lastWords. Treat the last (then second to last, then third to last) word as optional, until there are results or at most 5 words have been removed.

• firstWords. Treat the first (then second, then third) word as optional, until there are results or at most 5 words have been removed.

• allOptional. Treat all words as optional.

For more information, see Remove words to improve results.

Available options: none, lastWords, firstWords, allOptional

Example:

"firstWords"

consequence.behavior.injection.main.source.search.params. replaceSynonymsInHighlight · boolean · default: false

Whether to replace a highlighted word with the matched synonym By default, the original words are highlighted even if a synonym matches. For example, with home as a synonym for house and a search for home, records matching either "home" or "house" are included in the search results, and either "home" or "house" are highlighted With replaceSynonymsInHighlight set to true, a search for home still matches the same records, but all occurrences of "house" are replaced by "home" in the highlighted response.

consequence.behavior.injection.main.source.search.params. responseFields · string[]

Properties to include in the API response of search and browse requests By default, all response properties are included. To reduce the response size, you can select which properties should be included An empty list may lead to an empty API response (except properties you can't exclude) You can't exclude these properties: message, warning, cursor, abTestVariantID, or any property added by setting getRankingInfo to true Your search depends on the hits field. If you omit this field, searches won't return any results. Your UI might also depend on other properties, for example, for pagination. Before restricting the response size, check the impact on your search experience.

consequence.behavior.injection.main.source.search.params. restrictHighlightAndSnippetArrays · boolean · default: false

Whether to restrict highlighting and snippeting to items that at least partially matched the search query. By default, all items are highlighted and snippeted.

consequence.behavior.injection.main.source.search.params. restrictSearchableAttributes · string[]

Restricts a search to a subset of your searchable attributes. Attribute names are case-sensitive.

Example:

["title", "author"]

consequence.behavior.injection.main.source.search.params. ruleContexts · string[]

Assigns a rule context to the search query Rule contexts are strings that you can use to trigger matching rules.

Example:

["mobile"]

consequence.behavior.injection.main.source.search.params. snippetEllipsisText · string · default: …

String used as an ellipsis indicator when a snippet is truncated.

consequence.behavior.injection.main.source.search.params. synonyms · boolean · default: true

Whether to take into account an index's synonyms for this search.

consequence.behavior.injection.main.source.search.params. typoTolerance · default: true

Whether typo tolerance is enabled and how it is applied.

If typo tolerance is true, min, or strict, word splitting and concatenation are also active.

consequence.behavior.injection.main.source.search.params. facetingAfterDistinct · boolean · default: false

Whether faceting should be applied after deduplication with distinct This leads to accurate facet counts when using faceting in combination with distinct. It's usually better to use afterDistinct modifiers in the attributesForFaceting setting, as facetingAfterDistinct only computes correct facet counts if all records have the same facet values for the attributeForDistinct.

consequence.behavior.injection.main.source.search.params. facets · string[]

Facets for which to retrieve facet values that match the search criteria and the number of matching facet values To retrieve all facets, use the wildcard character *. To retrieve disjunctive facets lists, annotate any facets with the disjunctive modifier. For more information, see facets and disjunctive faceting for Smart Groups.

Example:

{
  "facetSpecificList": {
    "summary": "Specify which facet to retrieve with some marked as disjunctive",
    "value": [["category", "disjunctive(brand)", "price"]]
  },
  "facetAll": {
    "summary": "Retrieve all facets",
    "value": [["*"]]
  }
}

consequence.behavior.injection.main.source.search.params. hitsPerPage · integer · default: 20

Number of hits per page.

Required range: 1 <= x <= 1000

consequence.behavior.injection.main.source.search.params. maxValuesPerFacet · integer · default: 100

Maximum number of facet values to return for each facet.

Required range: x <= 1000

consequence.behavior.injection.main.source.search.params. renderingContent · object

Extra data that can be used in the search UI.

You can use this to control aspects of your search UI, such as the order of facet names and values without changing your frontend code.

Show child attributes

consequence.behavior.injection.main.source.search.params.renderingContent. facetOrdering · object

Order of facet names and facet values in your UI.

Show child attributes

consequence.behavior.injection.main.source.search.params.renderingContent.facetOrdering. facets · object

Order of facet names.

Show child attributes

consequence.behavior.injection.main.source.search.params.renderingContent.facetOrdering.facets. order · string[]

Explicit order of facets or facet values.

This setting lets you always show specific facets or facet values at the top of the list.

consequence.behavior.injection.main.source.search.params.renderingContent.facetOrdering. values · object

Order of facet values. One object for each facet.

Show child attributes

consequence.behavior.injection.main.source.search.params.renderingContent.facetOrdering.values. {key} · object

Show child attributes

consequence.behavior.injection.main.source.search.params.renderingContent.facetOrdering.values.{key}. order · string[]

Explicit order of facets or facet values.

This setting lets you always show specific facets or facet values at the top of the list.

consequence.behavior.injection.main.source.search.params.renderingContent.facetOrdering.values.{key}. sortRemainingBy · enum<string>

Order of facet values that aren't explicitly positioned with the order setting.

• count. Order remaining facet values by decreasing count. The count is the number of matching records containing this facet value.

• alpha. Sort facet values alphabetically.

• hidden. Don't show facet values that aren't explicitly positioned.

Available options: count, alpha, hidden

consequence.behavior.injection.main.source.search.params.renderingContent.facetOrdering.values.{key}. hide · string[]

Hide facet values.

consequence.behavior.injection.main.source.search.params.renderingContent. redirect · object

The redirect rule container.

Show child attributes

consequence.behavior.injection.main.source.search.params.renderingContent.redirect. url · string

consequence.behavior.injection.main.source.search.params.renderingContent. widgets · object

Widgets returned from any rules that are applied to the current search.

Show child attributes

consequence.behavior.injection.main.source.search.params.renderingContent.widgets. banners · object[]

Banners defined in the Merchandising Studio for a given search.

Show child attributes

consequence.behavior.injection.main.source.search.params.renderingContent.widgets.banners. image · object

Image to show inside a banner.

Show child attributes

consequence.behavior.injection.main.source.search.params.renderingContent.widgets.banners.image. urls · object[]

Show child attributes

consequence.behavior.injection.main.source.search.params.renderingContent.widgets.banners.image.urls. url · string

consequence.behavior.injection.main.source.search.params.renderingContent.widgets.banners.image. title · string

consequence.behavior.injection.main.source.search.params.renderingContent.widgets.banners. link · object

Link for a banner defined in the Merchandising Studio.

Show child attributes

consequence.behavior.injection.main.source.search.params.renderingContent.widgets.banners.link. url · string

consequence.behavior.injection.main.source.search.params. sortFacetValuesBy · string · default: count

Order in which to retrieve facet values

• count. Facet values are retrieved by decreasing count. The count is the number of matching records containing this facet value
• alpha. Retrieve facet values alphabetically This setting doesn't influence how facet values are displayed in your UI (see renderingContent). For more information, see facet value display.

consequence.behavior.injection.main.source.search.params. sumOrFiltersScores · boolean · default: false

Whether to sum all filter scores If true, all filter scores are summed. Otherwise, the maximum filter score is kept. For more information, see filter scores.

consequence.behavior.injection. injectedItems · object[]

list of injected items of the current Composition.

Maximum array length: 2

Show child attributes

consequence.behavior.injection.injectedItems. key · string · required

injected Item unique identifier.

consequence.behavior.injection.injectedItems. source · searchSource · object · required

Search source to be used to inject items into result set.

searchSource

Show child attributes

consequence.behavior.injection.injectedItems.source. search · search · object · required

Show child attributes

consequence.behavior.injection.injectedItems.source.search. index · string · required

Composition Index name.

Example:

"Products"

consequence.behavior.injection.injectedItems.source.search. params · Composition common query parameters between main and injected items as object · object

Show child attributes

consequence.behavior.injection.injectedItems.source.search.params. advancedSyntax · boolean · default: false

Whether to support phrase matching and excluding words from search queries Use the advancedSyntaxFeatures parameter to control which feature is supported.

consequence.behavior.injection.injectedItems.source.search.params. advancedSyntaxFeatures · enum<string>[]

Advanced search syntax features you want to support

• exactPhrase. Phrases in quotes must match exactly. For example, sparkly blue "iPhone case" only returns records with the exact string "iPhone case"
• excludeWords. Query words prefixed with a - must not occur in a record. For example, search -engine matches records that contain "search" but not "engine" This setting only has an effect if advancedSyntax is true.

Available options: exactPhrase, excludeWords

consequence.behavior.injection.injectedItems.source.search.params. allowTyposOnNumericTokens · boolean · default: true

Whether to allow typos on numbers in the search query Turn off this setting to reduce the number of irrelevant matches when searching in large sets of similar numbers.

consequence.behavior.injection.injectedItems.source.search.params. alternativesAsExact · enum<string>[]

Determine which plurals and synonyms should be considered an exact matches By default, Algolia treats singular and plural forms of a word, and single-word synonyms, as exact matches when searching. For example

• "swimsuit" and "swimsuits" are treated the same
• "swimsuit" and "swimwear" are treated the same (if they are synonyms)
• ignorePlurals. Plurals and similar declensions added by the ignorePlurals setting are considered exact matches
• singleWordSynonym. Single-word synonyms, such as "NY" = "NYC", are considered exact matches
• multiWordsSynonym. Multi-word synonyms, such as "NY" = "New York", are considered exact matches.

Available options: ignorePlurals, singleWordSynonym, multiWordsSynonym, ignoreConjugations

consequence.behavior.injection.injectedItems.source.search.params. analytics · boolean · default: true

Whether this search will be included in Analytics.

consequence.behavior.injection.injectedItems.source.search.params. attributeCriteriaComputedByMinProximity · boolean · default: false

Whether the best matching attribute should be determined by minimum proximity This setting only affects ranking if the Attribute ranking criterion comes before Proximity in the ranking setting. If true, the best matching attribute is selected based on the minimum proximity of multiple matches. Otherwise, the best matching attribute is determined by the order in the searchableAttributes setting.

consequence.behavior.injection.injectedItems.source.search.params. attributesToHighlight · string[]

Attributes to highlight By default, all searchable attributes are highlighted. Use * to highlight all attributes or use an empty array [] to turn off highlighting. Attribute names are case-sensitive With highlighting, strings that match the search query are surrounded by HTML tags defined by highlightPreTag and highlightPostTag. You can use this to visually highlight matching parts of a search query in your UI For more information, see Highlighting and snippeting.

Example:

["author", "title", "conten", "content"]

consequence.behavior.injection.injectedItems.source.search.params. attributesToRetrieve · string[]

Attributes to include in the API response To reduce the size of your response, you can retrieve only some of the attributes. Attribute names are case-sensitive

• * retrieves all attributes, except attributes included in the customRanking and unretrievableAttributes settings.
• To retrieve all attributes except a specific one, prefix the attribute with a dash and combine it with the *: ["*", "-ATTRIBUTE"].
• The objectID attribute is always included.

Example:

["author", "title", "content"]

consequence.behavior.injection.injectedItems.source.search.params. attributesToSnippet · string[]

Attributes for which to enable snippets. Attribute names are case-sensitive Snippets provide additional context to matched words. If you enable snippets, they include 10 words, including the matched word. The matched word will also be wrapped by HTML tags for highlighting. You can adjust the number of words with the following notation: ATTRIBUTE:NUMBER, where NUMBER is the number of words to be extracted.

Example:

["content:80", "description"]

consequence.behavior.injection.injectedItems.source.search.params. clickAnalytics · boolean · default: false

Whether to include a queryID attribute in the response The query ID is a unique identifier for a search query and is required for tracking click and conversion events.

consequence.behavior.injection.injectedItems.source.search.params. decompoundQuery · boolean · default: true

Whether to split compound words in the query into their building blocks For more information, see Word segmentation. Word segmentation is supported for these languages: German, Dutch, Finnish, Swedish, and Norwegian. Decompounding doesn't work for words with non-spacing mark Unicode characters. For example, Gartenstühle won't be decompounded if the ü consists of u (U+0075) and ◌̈ (U+0308).

consequence.behavior.injection.injectedItems.source.search.params. disableExactOnAttributes · string[]

Searchable attributes for which you want to turn off the Exact ranking criterion. Attribute names are case-sensitive This can be useful for attributes with long values, where the likelihood of an exact match is high, such as product descriptions. Turning off the Exact ranking criterion for these attributes favors exact matching on other attributes. This reduces the impact of individual attributes with a lot of content on ranking.

Example:

["description"]

consequence.behavior.injection.injectedItems.source.search.params. disableTypoToleranceOnAttributes · string[]

Attributes for which you want to turn off typo tolerance. Attribute names are case-sensitive Returning only exact matches can help when

• Searching in hyphenated attributes.
• Reducing the number of matches when you have too many. This can happen with attributes that are long blocks of text, such as product descriptions Consider alternatives such as disableTypoToleranceOnWords or adding synonyms if your attributes have intentional unusual spellings that might look like typos.

Example:

["sku"]

consequence.behavior.injection.injectedItems.source.search.params. distinct

Determines how many records of a group are included in the search results.

Records with the same value for the attributeForDistinct attribute are considered a group. The distinct setting controls how many members of the group are returned. This is useful for deduplication and grouping.

The distinct setting is ignored if attributeForDistinct is not set.

Example:

1

consequence.behavior.injection.injectedItems.source.search.params. enableABTest · boolean · default: true

Whether to enable A/B testing for this search.

consequence.behavior.injection.injectedItems.source.search.params. enablePersonalization · boolean · default: false

Whether to enable Personalization.

consequence.behavior.injection.injectedItems.source.search.params. enableReRanking · boolean · default: true

Whether this search will use Dynamic Re-Ranking This setting only has an effect if you activated Dynamic Re-Ranking for this index in the Algolia dashboard.

consequence.behavior.injection.injectedItems.source.search.params. enableRules · boolean · default: true

Whether to enable rules.

consequence.behavior.injection.injectedItems.source.search.params. exactOnSingleWordQuery · enum<string> · default: attribute

Determines how the Exact ranking criterion is computed when the search query has only one word.

• attribute. The Exact ranking criterion is 1 if the query word and attribute value are the same. For example, a search for "road" will match the value "road", but not "road trip".

• none. The Exact ranking criterion is ignored on single-word searches.

• word. The Exact ranking criterion is 1 if the query word is found in the attribute value. The query word must have at least 3 characters and must not be a stop word. Only exact matches will be highlighted, partial and prefix matches won't.

Available options: attribute, none, word

consequence.behavior.injection.injectedItems.source.search.params. facetFilters

Filter the search by facet values, so that only records with the same facet values are retrieved.

Prefer using the filters parameter, which supports all filter types and combinations with boolean operators.

• [filter1, filter2] is interpreted as filter1 AND filter2.
• [[filter1, filter2], filter3] is interpreted as filter1 OR filter2 AND filter3.
• facet:-value is interpreted as NOT facet:value.

While it's best to avoid attributes that start with a -, you can still filter them by escaping with a backslash: facet:\-value.

Example:

[
  ["category:Book", "category:-Movie"],
  "author:John Doe"
]

consequence.behavior.injection.injectedItems.source.search.params. filters · string

Filter expression to only include items that match the filter criteria in the response.

You can use these filter expressions:

• Numeric filters. <facet> <op> <number>, where <op> is one of <, <=, =, !=, >, >=.
• Ranges. <facet>:<lower> TO <upper> where <lower> and <upper> are the lower and upper limits of the range (inclusive).
• Facet filters. <facet>:<value> where <facet> is a facet attribute (case-sensitive) and <value> a facet value.
• Tag filters. _tags:<value> or just <value> (case-sensitive).
• Boolean filters. <facet>: true | false.

You can combine filters with AND, OR, and NOT operators with the following restrictions:

• You can only combine filters of the same type with OR. Not supported: facet:value OR num > 3.
• You can't use NOT with combinations of filters. Not supported: NOT(facet:value OR facet:value)
• You can't combine conjunctions (AND) with OR. Not supported: facet:value OR (facet:value AND facet:value)

Use quotes around your filters, if the facet attribute name or facet value has spaces, keywords (OR, AND, NOT), or quotes. If a facet attribute is an array, the filter matches if it matches at least one element of the array.

For more information, see Filters.

Example:

"(category:Book OR category:Ebook) AND _tags:published"

consequence.behavior.injection.injectedItems.source.search.params. getRankingInfo · boolean · default: false

Whether the search response should include detailed ranking information.

consequence.behavior.injection.injectedItems.source.search.params. highlightPostTag · string · default: </em>

HTML tag to insert after the highlighted parts in all highlighted results and snippets.

consequence.behavior.injection.injectedItems.source.search.params. highlightPreTag · string · default: <em>

HTML tag to insert before the highlighted parts in all highlighted results and snippets.

consequence.behavior.injection.injectedItems.source.search.params. ignorePlurals

Treat singular, plurals, and other forms of declensions as equivalent. You should only use this feature for the languages used in your index.

ISO code for a supported language.

Available options: af, ar, az, bg, bn, ca, cs, cy, da, de, el, en, eo, es, et, eu, fa, fi, fo, fr, ga, gl, he, hi, hu, hy, id, is, it, ja, ka, kk, ko, ku, ky, lt, lv, mi, mn, mr, ms, mt, nb, nl, no, ns, pl, ps, pt, pt-br, qu, ro, ru, sk, sq, sv, sw, ta, te, th, tl, tn, tr, tt, uk, ur, uz, zh

Example:

["ca", "es"]

consequence.behavior.injection.injectedItems.source.search.params. maxFacetHits · integer · default: 10

Maximum number of facet values to return when searching for facet values.

Required range: x <= 100

consequence.behavior.injection.injectedItems.source.search.params. minProximity · integer · default: 1

Minimum proximity score for two matching words This adjusts the Proximity ranking criterion by equally scoring matches that are farther apart For example, if minProximity is 2, neighboring matches and matches with one word between them would have the same score.

Required range: 1 <= x <= 7

consequence.behavior.injection.injectedItems.source.search.params. minWordSizefor1Typo · integer · default: 4

Minimum number of characters a word in the search query must contain to accept matches with one typo.

consequence.behavior.injection.injectedItems.source.search.params. minWordSizefor2Typos · integer · default: 8

Minimum number of characters a word in the search query must contain to accept matches with two typos.

consequence.behavior.injection.injectedItems.source.search.params. naturalLanguages · enum<string>[]

ISO language codes that adjust settings that are useful for processing natural language queries (as opposed to keyword searches)

• Sets removeStopWords and ignorePlurals to the list of provided languages.
• Sets removeWordsIfNoResults to allOptional.
• Adds a natural_language attribute to ruleContexts and analyticsTags.

ISO code for a supported language.

Available options: af, ar, az, bg, bn, ca, cs, cy, da, de, el, en, eo, es, et, eu, fa, fi, fo, fr, ga, gl, he, hi, hu, hy, id, is, it, ja, ka, kk, ko, ku, ky, lt, lv, mi, mn, mr, ms, mt, nb, nl, no, ns, pl, ps, pt, pt-br, qu, ro, ru, sk, sq, sv, sw, ta, te, th, tl, tn, tr, tt, uk, ur, uz, zh

consequence.behavior.injection.injectedItems.source.search.params. numericFilters

Filter by numeric facets.

Prefer using the filters parameter, which supports all filter types and combinations with boolean operators.

You can use numeric comparison operators: <, <=, =, !=, >, >=. Comparisons are precise up to 3 decimals. You can also provide ranges: facet:<lower> TO <upper>. The range includes the lower and upper boundaries. The same combination rules apply as for facetFilters.

Example:

[
  ["inStock = 1", "deliveryDate < 1441755506"],
  "price < 1000"
]

consequence.behavior.injection.injectedItems.source.search.params. optionalFilters

Filters to promote or demote records in the search results.

Optional filters work like facet filters, but they don't exclude records from the search results. Records that match the optional filter rank before records that don't match. If you're using a negative filter facet:-value, matching records rank after records that don't match.

• Optional filters don't work on virtual replicas.
• Optional filters are applied after sort-by attributes.
• Optional filters are applied before custom ranking attributes (in the default ranking).
• Optional filters don't work with numeric attributes.

Example:

["category:Book", "author:John Doe"]

consequence.behavior.injection.injectedItems.source.search.params. optionalWords

Words that should be considered optional when found in the query.

By default, records must match all words in the search query to be included in the search results. Adding optional words can help to increase the number of search results by running an additional search query that doesn't include the optional words. For example, if the search query is "action video" and "video" is an optional word, the search engine runs two queries. One for "action video" and one for "action". Records that match all words are ranked higher.

For a search query with 4 or more words and all its words are optional, the number of matched words required for a record to be included in the search results increases for every 1,000 records:

• If optionalWords has less than 10 words, the required number of matched words increases by 1: results 1 to 1,000 require 1 matched word, results 1,001 to 2000 need 2 matched words.
• If optionalWords has 10 or more words, the number of required matched words increases by the number of optional words divided by 5 (rounded down). For example, with 18 optional words: results 1 to 1,000 require 1 matched word, results 1,001 to 2000 need 4 matched words.

For more information, see Optional words.

consequence.behavior.injection.injectedItems.source.search.params. percentileComputation · boolean · default: true

Whether to include this search when calculating processing-time percentiles.

consequence.behavior.injection.injectedItems.source.search.params. personalizationImpact · integer · default: 100

Impact that Personalization should have on this search The higher this value is, the more Personalization determines the ranking compared to other factors. For more information, see Understanding Personalization impact.

Required range: 0 <= x <= 100

consequence.behavior.injection.injectedItems.source.search.params. queryLanguages · enum<string>[]

Languages for language-specific query processing steps such as plurals, stop-word removal, and word-detection dictionaries This setting sets a default list of languages used by the removeStopWords and ignorePlurals settings. This setting also sets a dictionary for word detection in the logogram-based CJK languages. To support this, you must place the CJK language first You should always specify a query language. If you don't specify an indexing language, the search engine uses all supported languages, or the languages you specified with the ignorePlurals or removeStopWords parameters. This can lead to unexpected search results. For more information, see Language-specific configuration.

ISO code for a supported language.

Available options: af, ar, az, bg, bn, ca, cs, cy, da, de, el, en, eo, es, et, eu, fa, fi, fo, fr, ga, gl, he, hi, hu, hy, id, is, it, ja, ka, kk, ko, ku, ky, lt, lv, mi, mn, mr, ms, mt, nb, nl, no, ns, pl, ps, pt, pt-br, qu, ro, ru, sk, sq, sv, sw, ta, te, th, tl, tn, tr, tt, uk, ur, uz, zh

Example:

["es"]

consequence.behavior.injection.injectedItems.source.search.params. queryType · enum<string> · default: prefixLast

Determines if and how query words are interpreted as prefixes.

By default, only the last query word is treated as a prefix (prefixLast). To turn off prefix search, use prefixNone. Avoid prefixAll, which treats all query words as prefixes. This might lead to counterintuitive results and makes your search slower.

For more information, see Prefix searching.

Available options: prefixLast, prefixAll, prefixNone

consequence.behavior.injection.injectedItems.source.search.params. removeStopWords

Removes stop words from the search query.

Stop words are common words like articles, conjunctions, prepositions, or pronouns that have little or no meaning on their own. In English, "the", "a", or "and" are stop words.

You should only use this feature for the languages used in your index.

ISO code for a supported language.

Available options: af, ar, az, bg, bn, ca, cs, cy, da, de, el, en, eo, es, et, eu, fa, fi, fo, fr, ga, gl, he, hi, hu, hy, id, is, it, ja, ka, kk, ko, ku, ky, lt, lv, mi, mn, mr, ms, mt, nb, nl, no, ns, pl, ps, pt, pt-br, qu, ro, ru, sk, sq, sv, sw, ta, te, th, tl, tn, tr, tt, uk, ur, uz, zh

Example:

["ca", "es"]

consequence.behavior.injection.injectedItems.source.search.params. removeWordsIfNoResults · enum<string> · default: none

Strategy for removing words from the query when it doesn't return any results. This helps to avoid returning empty search results.

• none. No words are removed when a query doesn't return results.

• lastWords. Treat the last (then second to last, then third to last) word as optional, until there are results or at most 5 words have been removed.

• firstWords. Treat the first (then second, then third) word as optional, until there are results or at most 5 words have been removed.

• allOptional. Treat all words as optional.

For more information, see Remove words to improve results.

Available options: none, lastWords, firstWords, allOptional

Example:

"firstWords"

consequence.behavior.injection.injectedItems.source.search.params. replaceSynonymsInHighlight · boolean · default: false

Whether to replace a highlighted word with the matched synonym By default, the original words are highlighted even if a synonym matches. For example, with home as a synonym for house and a search for home, records matching either "home" or "house" are included in the search results, and either "home" or "house" are highlighted With replaceSynonymsInHighlight set to true, a search for home still matches the same records, but all occurrences of "house" are replaced by "home" in the highlighted response.

consequence.behavior.injection.injectedItems.source.search.params. responseFields · string[]

Properties to include in the API response of search and browse requests By default, all response properties are included. To reduce the response size, you can select which properties should be included An empty list may lead to an empty API response (except properties you can't exclude) You can't exclude these properties: message, warning, cursor, abTestVariantID, or any property added by setting getRankingInfo to true Your search depends on the hits field. If you omit this field, searches won't return any results. Your UI might also depend on other properties, for example, for pagination. Before restricting the response size, check the impact on your search experience.

consequence.behavior.injection.injectedItems.source.search.params. restrictHighlightAndSnippetArrays · boolean · default: false

Whether to restrict highlighting and snippeting to items that at least partially matched the search query. By default, all items are highlighted and snippeted.

consequence.behavior.injection.injectedItems.source.search.params. restrictSearchableAttributes · string[]

Restricts a search to a subset of your searchable attributes. Attribute names are case-sensitive.

Example:

["title", "author"]

consequence.behavior.injection.injectedItems.source.search.params. ruleContexts · string[]

Assigns a rule context to the search query Rule contexts are strings that you can use to trigger matching rules.

Example:

["mobile"]

consequence.behavior.injection.injectedItems.source.search.params. snippetEllipsisText · string · default: …

String used as an ellipsis indicator when a snippet is truncated.

consequence.behavior.injection.injectedItems.source.search.params. synonyms · boolean · default: true

Whether to take into account an index's synonyms for this search.

consequence.behavior.injection.injectedItems.source.search.params. typoTolerance · default: true

Whether typo tolerance is enabled and how it is applied.

If typo tolerance is true, min, or strict, word splitting and concatenation are also active.

consequence.behavior.injection.injectedItems. position · integer · required

Required range: 0 <= x <= 19

consequence.behavior.injection.injectedItems. length · integer · required

Required range: 0 <= x <= 20

consequence.behavior.injection.injectedItems. metadata · injectedItemMetadata · object

Used to add metadata to the results of the injectedItem.

Show child attributes

consequence.behavior.injection.injectedItems.metadata. hits · injectedItemHitsMetadata · object

Adds the provided metadata to each injected hit via an _extra attribute.

Show child attributes

consequence.behavior.injection.injectedItems.metadata.hits. addItemKey · boolean

When true, the _injectedItemKey field is set in the _extra object of each affected hit.

consequence.behavior.injection.injectedItems.metadata.hits. extra · object

The user-defined key-value pairs that will be placed in the _extra field of each affected hit.

consequence.behavior.injection. deduplication · deduplication · object

Deduplication configures the methods used to resolve duplicate items between main search results and injected group results.

Show child attributes

consequence.behavior.injection.deduplication. positioning · enum<string> · default: highestInjected · required

Deduplication positioning configures how a duplicate result should be resolved between an injected item and main search results. Current configuration supports:

• 'highest': always select the item in the highest position, and remove duplicates that appear lower in the results.
• 'highestInjected': duplicate result will be moved to its highest possible injected position, but not higher. If a duplicate appears higher in main search results, it will be removed to stay it's intended group position (which could be lower than main).

Available options: highest, highestInjected

Example:

"highest"

description · string

Description of the rule's purpose to help you distinguish between different rules.

Example:

"Display a promotional banner"

enabled · boolean · default: true

Whether the rule is active.

validity · object[]

Time periods when the rule is active.

Show child attributes

validity. from · integer<int64>

When the rule should start to be active, in Unix epoch time.

validity. until · integer<int64>

When the rule should stop to be active, in Unix epoch time.

tags · string[]

A list of tags.

Example:

["conditional"]

Response

200

application/json

OK

taskID · integer<int64> · required

Unique identifier of a task.

A successful API response means that a task was added to a queue. It might not run immediately. You can check the task's progress with the task operation and this task ID.

Example:

1514562690001