ruleContexts

Type: list of strings

Engine default: []

Parameter syntax

'ruleContexts' => [
  'context_value',
  ...
]

ruleContexts: [
  'context_value',
  ...
]

ruleContexts: [
  'context_value',
  ...
]

'ruleContexts': [
  'context_value',
  ...
]

ruleContexts = [
  "context_value",
  ...
]

ruleContexts {
    +"context_value"
    +...
}

.RuleContexts(
  new List<string> {
    "context_value",
    ...
  }
)

.setRuleContexts(
  Arrays.asList(
    "context_value",
    ...
  )
)

opt.RuleContexts(
  "context_value",
  ...
)

ruleContexts = Some(Seq(
  "context_value",
  ...
))

Can be used in these methods:
search, browseObjects, searchForFacetValues, generateSecuredApiKey, addApiKey, updateApiKey search, browse_objects, search_for_facet_values, generate_secured_api_key, add_api_key, update_api_key search, browseObjects, searchForFacetValues, generateSecuredApiKey, addApiKey, updateApiKey search, browse_objects, search_for_facet_values, generate_secured_api_key, add_api_key, update_api_key search, browse, searchForFacetValues, generateSecuredApiKey, addAPIKey, updateAPIKey search, browseObjects, searchForFacetValues, generateSecuredApiKey, addApiKey, updateApiKey Search, Browse, SearchForFacetValues, GenerateSecuredApiKey, AddApiKey, UpdateApiKey Search, browse, searchForFacetValues, generateSecuredApiKey, addApiKey, updateApiKey Search, BrowseObjects, SearchForFacetValues, GenerateSecuredAPIKey, AddAPIKey, UpdateAPIKey search, browse index, search into facet values, generateSecuredApiKey, add key, update key

See code examples

About this parameter

Assigns Rule contexts to search queries.

This parameter enables the listed Rule contexts at query time. However, you must first create your Rule contexts from the dashboard or with the save-rule method

A context controls whether a Rule should apply all the time or only in some situations. Common applications of context are when you want to apply Rules based on the following scenarios:

Mobile or desktop device usage
Landing or product category pages, such as those dedicated to Apple or Android products
User interactions with things like facets
Date such as promotional periods like Black Friday
Language such as French and English
Country such as Germany and Austria.

As well as using this API parameter, you can assign Rule contexts with InstantSearch, Autocomplete, and the Magento and Shopify integrations:

InstantSearch Use the `queryRuleContext` widget to apply contexts (JavaScript)

Use the `queryRuleContext` widget to apply contexts (React)

Use the `useQueryRules` Hooks to apply contexts (React Hooks)

Use the `queryRuleContext` widget to apply contexts (Vue)

Use the `queryRuleContext` widget to apply contexts (Angular)

Autocomplete Use the quick access plugin to apply contexts

Magento Add custom Rule contexts

Shopify How to change Rule contexts

Usage notes

A Rule context must consist only of alphanumeric characters, hyphens, and underscores
If ruleContexts is empty, only non-contextual Rules are activated.
For performance reasons, you may pass up to 10 different contexts to the API at once (at query time).

Examples

Specify Rule contexts for the current query

Copy

1
2
3
4
5
6
$results = $index->search('query', [
  'ruleContexts' => [
    'front_end',
    'website2'
  ]
]);

1
2
3
4
5
6
7
8
let query = Query("query")
  .set(\.ruleContexts, to: ["front_end", "website2"])

index.search(query: query) { result in
  if case .success(let response) = result {
    print("Response: \(response)")
  }
}

1
2
3
4
5
6
7
8
9
client.execute {
  search into "myIndex" query Query(
    query = Some("query"),
    ruleContexts = Some(Seq(
      "front_end",
      "website2"
    ))
  )
}

Did you find this page helpful?

ruleContexts

About this parameter

Usage notes

Examples

Specify Rule contexts for the current query

On this page