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

Enables contextual rules.

Provides a list of contexts for which rules are enabled. Contextual rules matching any of these contexts are activated, as well as generic rules.

Usage notes

When empty, only generic rules are activated.
For performance reasons, you may pass up to 10 different contexts to the API at a time at query time.

Examples

Specify query rules context for the current search

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 query rules context for the current search

On this page