attributesToHighlight

Attributes to highlight

• Type: list<string>
• Default: null(all searchable attributes)
• Scope: settings,search

Usage

• By default, all searchable attributes are highlighted.
• The special value * may be used to highlight all attributes.
• Pass an empty array ([]) to turn off highlighting.
• Algolia highlights the first 50,000 characters of the whole result set (5,000 logograms for CJK languages). This limit prevents impacting the user experience by ensuring a fast response time even with large results.
• When highlighting is enabled, each hit in the response contains a _highlightResult object.
• When enabled, each hit includes a _highlightResult object with metadata about the matches.

_highlightResult

Hide child attributes

_highlightResult.value · string

Matching text, surrounded by HTML tags defined in the highlightPreTag and highlightPostTag settings.

_highlightResult.matchLevel · enum<string>

Indicates how well the attribute matched the search query. Possible values are none, partial, full.

_highlightResult.matchedWords · list<string>

List of query words that matched the record.

_highlightResult.fullyHighlighted · boolean

Whether the entire attribute value is highlighted.

Examples

Current API clients

Set default list of attributes to highlight

C#

var response = await client.SetSettingsAsync(
  "ALGOLIA_INDEX_NAME",
  new IndexSettings
  {
    AttributesToHighlight = new List<string> { "author", "title", "content" },
  }
);

Make all attributes highlighted by default

C#

var response = await client.SetSettingsAsync(
  "ALGOLIA_INDEX_NAME",
  new IndexSettings { AttributesToHighlight = new List<string> { "*" } }
);

Override list of attributes to highlight for the current search

C#

var response = await client.SearchSingleIndexAsync<Hit>(
  "ALGOLIA_INDEX_NAME",
  new SearchParams(
    new SearchParamsObject
    {
      Query = "query",
      AttributesToHighlight = new List<string> { "title", "content" },
    }
  )
);

Legacy API clients

Set default list of attributes to highlight

C#

IndexSettings settings = new IndexSettings()
settings.AttributesToHighlight = new List
{
    "author",
    "title",
    "content"
};

index.SetSettings(settings);

Make all attributes highlighted by default

C#

IndexSettings settings = new IndexSettings()
settings.AttributesToHighlight = new List
{
    "*"
};


index.SetSettings(settings);

Override list of attributes to highlight for the current search

C#

index.Search(new Query("query")
{
    AttributesToHighlight = new List { "title", "content" }
});