Save Rule

Unique identifier for the rule (format: [A-Za-z0-9_-]+).

Note that for some languages, the objectID is duplicated in the queryRule.

The rule object, its condition(s) and consequence(s).

{
  objectID: objectID,
  condition: condition,
  consequence: consequence
}

By default, this method applies only to the specified index. By making this true, the method will also send the rule to all replicas.

Must contain the same value as the objectID above.

Condition of the rule, expressed using the following variables: pattern, anchoring, context.

{
  "pattern": pattern,
  "anchoring": anchoring,
  "context": context
}

Consequence of the rule. At least one of the following object must be used:

• params
• promote
• hide
• userData

This field is intended for rule management purposes, in particular to ease searching for rules and presenting them to human readers. It is not interpreted by the API.

Whether the rule is enabled. Disabled rules remain in the index, but are not applied at query time.

By default, rules are permanently valid. When validity periods are specified, the rule applies only during those periods; it is ignored the rest of the time. The list must not be empty.

Query pattern syntax

Query patterns are expressed as a string with a specific syntax. A pattern is a sequence of tokens, which can be either:

• Facet value placeholder: {facet:$facet_name}. Example: {facet:brand}.
• Literal: the world itself. Example: Algolia.

Special characters ({, }, : and \) must be escaped by preceding them with a backslash (\) if they are to be treated as literals.

An empty pattern is only allowed when the anchoring is set to is.

{ is | startsWith | endsWith | contains }: Whether the pattern must match the beginning or the end of the query string, or both, or none.

Rule context (format: [A-Za-z0-9_-]+). When specified, the rule is contextual and applies only when the same context is specified at query time (using the ruleContexts parameter). When absent, the rule is generic and always applies (provided that its other conditions are met, of course).

Additional search parameters. Any valid search parameter is allowed. Specific treatment is applied to these fields: query, automaticFacetFilters, automaticOptionalFacetFilters.

{
  "query": query,
  "automaticFacetFilters": automaticFacetFilters,
  "automaticOptionalFacetFilters": automaticOptionalFacetFilters
}

Objects to promote as hits. Each object must contain the following fields: objectID, position

{
  "objectID": objectID,
  "position": position
}

Objects to hide from hits. Each object must contain an objectID field.

{
  "objectID": objectID
}

Custom JSON object that will be appended to the userData array in the response. This object is not interpreted by the API. It is limited to 1kB of minified JSON.

When providing a string, it replaces the entire query string. When providing an object, it describes incremental edits to be made to the query string (but you can’t do both).

{
  "edits": list of edit
}

Names of facets to which automatic filtering must be applied; they must match the facet name of a facet value placeholder in the query pattern. Ex. facetName1, facetName2. You can specify a score: facetName1<score=5>, facetName2<score=1>.

Same syntax as automaticFacetFilters, but the engine treats the filters as optional. Behaves like optionalFilters.

Unique identifier of the object to promote.

Promoted rank for the object (zero-based).

Unique identifier of the object to hide.

Lower bound of the time range (Unix timestamp).

Upper bound of the time range (Unix timestamp).

Attribute to filter on. This must match a facet placeholder in the rule’s pattern.

Score for the filter. Typically used for optional or disjunctive filters.

Whether the filter is disjunctive (true) or conjunctive (false). If the filter applies multiple times, e.g. because the query string contains multiple values of the same facet, the multiple occurrences are combined with an AND operator by default (conjunctive mode). If the filter is specified as disjunctive, however, multiple occurrences are combined with an OR operator instead.

Type of edit. Must be one of:

• remove: when you want to delete some text and not replace it with anything
• replace: when you want to delete some text and replace it with something else

Text or patterns to remove from the query string.

[
  {
    "type": "remove",
    "delete": "red"
  }
]

Text that should be inserted in place of the removed text inside the query string.

[
  {
    "type": "replace",
    "delete": "red",
    "insert": "blue"
  }
]