restrictHighlightAndSnippetArrays

Restrict highlighting and snippeting to items that matched the query.

• Type: boolean
• Default: false
• Scope: settings,search

Options

true

Only items that at least partialy matched are highlighted and snippeted.

false

All items are highlighted and snippeted.

Examples

Current API clients

Set default value

C#

var response = await client.SetSettingsAsync(
  "ALGOLIA_INDEX_NAME",
  new IndexSettings { RestrictHighlightAndSnippetArrays = true }
);

Override for the current search

C#

var response = await client.SearchSingleIndexAsync<Hit>(
  "ALGOLIA_INDEX_NAME",
  new SearchParams(
    new SearchParamsObject { Query = "query", RestrictHighlightAndSnippetArrays = false }
  )
);

Legacy API clients

Set default value

C#

IndexSettings settings = new IndexSettings()
settings.RestrictHighlightAndSnippetArrays = true;

index.SetSettings(settings);

Override for the current search

C#

index.Search(new Query("query")
{
    RestrictHighlightAndSnippetArrays = false
});