Create or replace a rule

If a rule with the specified object ID doesn’t exist, it’s created. Otherwise, the existing rule is replaced.

To create or update more than one rule, use the batch operation.

PUT /1/indexes/{indexName}/rules/{objectID}

curl

cURL

curl --request PUT \
  --url 'https://algolia_application_id.algolia.net/1/indexes/ALGOLIA_INDEX_NAME/rules/lorem?forwardToReplicas=true' \
  --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":"lorem","conditions":[{"pattern":"{facet:genre}","anchoring":"is","alternatives":false,"context":"mobile","filters":"genre:comedy"}],"consequence":{"params":{"similarQuery":"comedy drama crime Macy Buscemi","filters":"(category:Book OR category:Ebook) AND _tags:published","facetFilters":[["category:Book","category:-Movie"],"author:John Doe"],"optionalFilters":["category:Book","author:John Doe"],"numericFilters":[["inStock = 1","deliveryDate < 1441755506"],"price < 1000"],"tagFilters":[["Book","Movie"],"SciFi"],"sumOrFiltersScores":false,"restrictSearchableAttributes":["title","author"],"facets":["*"],"facetingAfterDistinct":false,"page":0,"offset":42,"length":0,"aroundLatLng":"40.71,-74.01","aroundLatLngViaIP":false,"aroundRadius":1,"aroundPrecision":10,"minimumAroundRadius":1,"insideBoundingBox":"lorem","insidePolygon":[[47.3165,4.9665,47.3424,5.0201,47.32,4.9],[40.9234,2.1185,38.643,1.9916,39.2587,2.0104]],"naturalLanguages":[],"ruleContexts":["mobile"],"personalizationImpact":100,"userToken":"test-user-123","getRankingInfo":false,"synonyms":true,"clickAnalytics":false,"analytics":true,"analyticsTags":[],"percentileComputation":true,"enableABTest":true,"attributesToRetrieve":["author","title","content"],"ranking":["typo","geo","words","filters","proximity","attribute","exact","custom"],"relevancyStrictness":90,"attributesToHighlight":["author","title","conten","content"],"attributesToSnippet":["content:80","description"],"highlightPreTag":"<em>","highlightPostTag":"</em>","snippetEllipsisText":"…","restrictHighlightAndSnippetArrays":false,"hitsPerPage":20,"minWordSizefor1Typo":4,"minWordSizefor2Typos":8,"typoTolerance":true,"allowTyposOnNumericTokens":true,"disableTypoToleranceOnAttributes":["sku"],"ignorePlurals":["ca","es"],"removeStopWords":["ca","es"],"queryLanguages":["es"],"decompoundQuery":true,"enableRules":true,"enablePersonalization":false,"queryType":"prefixLast","removeWordsIfNoResults":"firstWords","mode":"keywordSearch","semanticSearch":{"eventSources":["lorem"]},"advancedSyntax":false,"optionalWords":"lorem","disableExactOnAttributes":["description"],"exactOnSingleWordQuery":"attribute","alternativesAsExact":["ignorePlurals","singleWordSynonym"],"advancedSyntaxFeatures":["exactPhrase","excludeWords"],"distinct":1,"replaceSynonymsInHighlight":false,"minProximity":1,"responseFields":["*"],"maxValuesPerFacet":100,"sortFacetValuesBy":"count","attributeCriteriaComputedByMinProximity":false,"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"}}]}},"enableReRanking":true,"reRankingApplyFilter":[[]],"query":{"remove":["lorem"],"edits":[{"type":"remove","delete":"lorem","insert":"lorem"}]},"automaticFacetFilters":[{"facet":"lorem","score":1,"disjunctive":false}],"automaticOptionalFacetFilters":[{"facet":"lorem","score":1,"disjunctive":false}]},"promote":[{"objectIDs":["test-record-123"],"position":0}],"filterPromotes":false,"hide":[{"objectID":"test-record-123"}],"userData":{"settingID":"f2a7b51e3503acc6a39b3784ffb84300","pluginVersion":"1.6.0"}},"description":"Display a promotional banner","enabled":true,"validity":[{"from":42,"until":42}],"tags":["lorem"],"scope":"lorem"}'

200

{
  "taskID": 1514562690001,
  "updatedAt": "2023-07-04T12:49:15Z"
}

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

indexName · string · required

Name of the index on which to perform the operation.

Example:

"ALGOLIA_INDEX_NAME"

objectID · string · required

Unique identifier of a rule object.

Query Parameters

forwardToReplicas · boolean

Whether changes are applied to replica indices.

Body

application/json

Rule object.

objectID · string · required

Unique identifier of a rule object.

consequence · object · required

Effect of the rule.

For more information, see Consequences.

Show child attributes

consequence. params · object

Parameters to apply to this search.

You can use all search parameters, plus special automaticFacetFilters, automaticOptionalFacetFilters, and query.

Show child attributes

consequence.params. similarQuery · string · default: ""

Keywords to be used instead of the search query to conduct a more broader search Using the similarQuery parameter changes other settings

• queryType is set to prefixNone.
• removeStopWords is set to true.
• words is set as the first ranking criterion.
• All remaining words are treated as optionalWords Since the similarQuery is supposed to do a broad search, they usually return many results. Combine it with filters to narrow down the list of results.

Example:

"comedy drama crime Macy Buscemi"

consequence.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.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.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.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.params. tagFilters

Filter the search by values of the special _tags attribute.

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

Different from regular facets, _tags can only be used for filtering (including or excluding records). You won't get a facet count. The same combination and escaping rules apply as for facetFilters.

Example:

[["Book", "Movie"], "SciFi"]

consequence.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.params. restrictSearchableAttributes · string[]

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

Example:

["title", "author"]

consequence.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 *. For more information, see facets.

Example:

["*"]

consequence.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.params. page · integer · default: 0

Page of search results to retrieve.

Required range: x >= 0

consequence.params. offset · integer

Position of the first hit to retrieve.

consequence.params. length · integer

Number of hits to retrieve (used in combination with offset).

Required range: 0 <= x <= 1000

consequence.params. aroundLatLng · string · default: ""

Coordinates for the center of a circle, expressed as a comma-separated string of latitude and longitude.

Only records included within a circle around this central location are included in the results. The radius of the circle is determined by the aroundRadius and minimumAroundRadius settings. This parameter is ignored if you also specify insidePolygon or insideBoundingBox.

Example:

"40.71,-74.01"

consequence.params. aroundLatLngViaIP · boolean · default: false

Whether to obtain the coordinates from the request's IP address.

consequence.params. aroundRadius

Maximum radius for a search around a central location.

This parameter works in combination with the aroundLatLng and aroundLatLngViaIP parameters. By default, the search radius is determined automatically from the density of hits around the central location. The search radius is small if there are many hits close to the central coordinates.

Required range: x >= 1

consequence.params. aroundPrecision · default: 10

Precision of a coordinate-based search in meters to group results with similar distances.

The Geo ranking criterion considers all matches within the same range of distances to be equal.

consequence.params. minimumAroundRadius · integer

Minimum radius (in meters) for a search around a location when aroundRadius isn't set.

Required range: x >= 1

consequence.params. insideBoundingBox

consequence.params. insidePolygon · number<double>[][]

Coordinates of a polygon in which to search.

Polygons are defined by 3 to 10,000 points. Each point is represented by its latitude and longitude. Provide multiple polygons as nested arrays. For more information, see filtering inside polygons. This parameter is ignored if you also specify insideBoundingBox.

Required array length: 6 - 20000 elements

Example:

[
  [
    47.3165,
    4.9665,
    47.3424,
    5.0201,
    47.32,
    4.9
  ],
  [
    40.9234,
    2.1185,
    38.643,
    1.9916,
    39.2587,
    2.0104
  ]
]

consequence.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.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.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.params. userToken · string

Unique pseudonymous or anonymous user identifier.

This helps with analytics and click and conversion events. For more information, see user token.

Example:

"test-user-123"

consequence.params. getRankingInfo · boolean · default: false

Whether the search response should include detailed ranking information.

consequence.params. synonyms · boolean · default: true

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

consequence.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.params. analytics · boolean · default: true

Whether this search will be included in Analytics.

consequence.params. analyticsTags · string[]

Tags to apply to the query for segmenting analytics data.

consequence.params. percentileComputation · boolean · default: true

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

consequence.params. enableABTest · boolean · default: true

Whether to enable A/B testing for this search.

consequence.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.params. ranking · string[]

Determines the order in which Algolia returns your results.

By default, each entry corresponds to a ranking criteria. The tie-breaking algorithm sequentially applies each criterion in the order they're specified. If you configure a replica index for sorting by an attribute, you put the sorting attribute at the top of the list.

Modifiers

• asc("ATTRIBUTE"). Sort the index by the values of an attribute, in ascending order.
• desc("ATTRIBUTE"). Sort the index by the values of an attribute, in descending order.

Before you modify the default setting, you should test your changes in the dashboard, and by A/B testing.

consequence.params. relevancyStrictness · integer · default: 100

Relevancy threshold below which less relevant results aren't included in the results You can only set relevancyStrictness on virtual replica indices. Use this setting to strike a balance between the relevance and number of returned results.

Example:

90

consequence.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.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.params. highlightPreTag · string · default: <em>

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

consequence.params. highlightPostTag · string · default: </em>

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

consequence.params. snippetEllipsisText · string · default: …

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

consequence.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.params. hitsPerPage · integer · default: 20

Number of hits per page.

Required range: 1 <= x <= 1000

consequence.params. minWordSizefor1Typo · integer · default: 4

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

consequence.params. minWordSizefor2Typos · integer · default: 8

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

consequence.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.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.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.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.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.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.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.params. enableRules · boolean · default: true

Whether to enable rules.

consequence.params. enablePersonalization · boolean · default: false

Whether to enable Personalization.

consequence.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.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.params. mode · enum<string> · default: keywordSearch

Search mode the index will use to query for results.

This setting only applies to indices, for which Algolia enabled NeuralSearch for you.

Available options: neuralSearch, keywordSearch

consequence.params. semanticSearch · object

Settings for the semantic search part of NeuralSearch. Only used when mode is neuralSearch.

Show child attributes

consequence.params.semanticSearch. eventSources · string[] | null

Indices from which to collect click and conversion events.

If null, the current index and all its replicas are used.

consequence.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.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.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.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.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.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.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.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.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.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.params. maxValuesPerFacet · integer · default: 100

Maximum number of facet values to return for each facet.

Required range: x <= 1000

consequence.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.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.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.

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.params.renderingContent. facetOrdering · object

Order of facet names and facet values in your UI. Order of facet names and facet values in your UI.

Show child attributes

consequence.params.renderingContent.facetOrdering. facets · object

Order of facet names. Order of facet names.

Show child attributes

consequence.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.

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.params.renderingContent.facetOrdering. values · object

Order of facet values. One object for each facet. Order of facet values. One object for each facet.

Show child attributes

consequence.params.renderingContent.facetOrdering.values. {key} · object

Show child attributes

consequence.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.

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.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.

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.params.renderingContent.facetOrdering.values.{key}. hide · string[]

Hide facet values. Hide facet values.

consequence.params.renderingContent. redirect · object

The redirect rule container. The redirect rule container.

Show child attributes

consequence.params.renderingContent.redirect. url · string

consequence.params.renderingContent. widgets · object

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

Show child attributes

consequence.params.renderingContent.widgets. banners · object[]

Banners defined in the Merchandising Studio for a given search. Banners defined in the Merchandising Studio for a given search.

Show child attributes

consequence.params.renderingContent.widgets.banners. image · object

Image to show inside a banner. Image to show inside a banner.

Show child attributes

consequence.params.renderingContent.widgets.banners.image. urls · object[]

Show child attributes

consequence.params.renderingContent.widgets.banners.image.urls. url · string

consequence.params.renderingContent.widgets.banners.image. title · string

consequence.params.renderingContent.widgets.banners. link · object

Link for a banner defined in the Merchandising Studio. Link for a banner defined in the Merchandising Studio.

Show child attributes

consequence.params.renderingContent.widgets.banners.link. url · string

consequence.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.params. reRankingApplyFilter

Restrict Dynamic Re-Ranking to records that match these filters.

consequence.params. query

Replace or edit the search query.

If consequenceQuery is a string, the entire search query is replaced with that string. If consequenceQuery is an object, it describes incremental edits made to the query.

Show child attributes

consequence.params.query. remove · string[]

Words to remove from the search query.

consequence.params.query. edits · object[]

Changes to make to the search query.

Show child attributes

consequence.params.query.edits. type · enum<string>

Type of edit.

Available options: remove, replace

consequence.params.query.edits. delete · string

Text or patterns to remove from the query string.

consequence.params.query.edits. insert · string

Text to be added in place of the deleted text inside the query string.

consequence.params. automaticFacetFilters

Filter to be applied to the search.

You can use this to respond to search queries that match a facet value. For example, if users search for "comedy", which matches a facet value of the "genre" facet, you can filter the results to show the top-ranked comedy movies.

Show child attributes

consequence.params.automaticFacetFilters. facet · string · required

Facet name to be applied as filter. The name must match placeholders in the pattern parameter. For example, with pattern: {facet:genre}, automaticFacetFilters must be genre.

consequence.params.automaticFacetFilters. score · integer · default: 1

Filter scores to give different weights to individual filters.

consequence.params.automaticFacetFilters. disjunctive · boolean · default: false

Whether the filter is disjunctive or conjunctive.

If true the filter has multiple matches, multiple occurrences are combined with the logical OR operation. If false, multiple occurrences are combined with the logical AND operation.

consequence.params. automaticOptionalFacetFilters

Filter to be applied to the search.

You can use this to respond to search queries that match a facet value. For example, if users search for "comedy", which matches a facet value of the "genre" facet, you can filter the results to show the top-ranked comedy movies.

Show child attributes

consequence.params.automaticOptionalFacetFilters. facet · string · required

Facet name to be applied as filter. The name must match placeholders in the pattern parameter. For example, with pattern: {facet:genre}, automaticFacetFilters must be genre.

consequence.params.automaticOptionalFacetFilters. score · integer · default: 1

Filter scores to give different weights to individual filters.

consequence.params.automaticOptionalFacetFilters. disjunctive · boolean · default: false

Whether the filter is disjunctive or conjunctive.

If true the filter has multiple matches, multiple occurrences are combined with the logical OR operation. If false, multiple occurrences are combined with the logical AND operation.

consequence. promote · (objectIDs · object | objectID · object)[]

Records you want to pin to a specific position in the search results.

You can promote up to 300 records, either individually, or as groups of up to 100 records each.

Maximum array length: 300

Records to promote.

objectIDs

Show child attributes

consequence.promote. objectIDs · string[] · required

Object IDs of the records you want to promote.

The records are placed as a group at the position. For example, if you want to promote four records to position 0, they will be the first four search results.

Maximum array length: 100

Unique record identifier.

consequence.promote. position · integer · required

Position in the search results where you want to show the promoted records.

Example:

0

consequence. filterPromotes · boolean · default: false

Determines whether promoted records must also match active filters for the consequence to apply.

This ensures user-applied filters take priority and irrelevant matches aren't shown. For example, if you promote a record with color: red but the user filters for color: blue, the "red" record won't be shown.

In the Algolia dashboard, when you use the Pin an item consequence, filterPromotes appears as the checkbox: Pinned items must match active filters to be displayed. For examples, see Promote results with rules.

consequence. hide · consequenceHide · object[]

Records you want to hide from the search results.

Maximum array length: 50

Show child attributes

consequence.hide. objectID · string · required

Unique record identifier.

Example:

"test-record-123"

consequence. userData · object

A JSON object with custom data that will be appended to the userData array in the response. This object isn't interpreted by the API and is limited to 1 kB of minified JSON.

Example:

{
  "settingID": "f2a7b51e3503acc6a39b3784ffb84300",
  "pluginVersion": "1.6.0"
}

conditions · object[]

Conditions that trigger a rule.

Some consequences require specific conditions or don't require any condition. For more information, see Conditions.

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. alternatives · boolean · default: false

Whether the pattern should match plurals, synonyms, and typos.

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 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. You can't combine multiple filters with OR and you can't use numeric filters.

Example:

"genre:comedy"

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[]

scope · string

Response

200

application/json

OK

Response, taskID, and update timestamp.

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

updatedAt · string · required

Date and time when the object was updated, in RFC 3339 format.

Example:

"2023-07-04T12:49:15Z"