attributesToHighlight

Type: list of strings

Engine default: all searchable attributes

Parameter syntax

'attributesToHighlight' => [
  'attribute',
  '*', // returns all attributes in the index not just searchable attributes
  ...
]

attributesToHighlight: [
  'attribute',
  '*', # returns all attributes in the index not just searchable attributes
  ...
]

attributesToHighlight: [
  'attribute',
  '*', // returns all attributes in the index not just searchable attributes
  ...
]

'attributesToHighlight': [
  'attribute',
  '*', # returns all attributes in the index not just searchable attributes
  ...
]

attributesToHighlight = [
  "attribute",
  "*" // returns all attributes in the index not just searchable attributes
]

attributesToHighlight {
    +"attribute"
    +"*" // returns all attributes in the index not just searchable attributes
}

IndexSettings settings = new IndexSettings()
settings.AttributesToHighlight = new List<string>
{
    "attribute",
    "*" // returns all attributes in the index not just searchable attributes
};
  ...

.setAttributesToHighlight(Arrays.asList(
  "attribute",
  "*" // returns all attributes in the index not just searchable attributes
))

opt.AttributesToHighlight(
  "attribute",
  "*", // returns all attributes in the index not just searchable attributes
)

attributesToHighlight = Some(Seq(
  "attribute",
  "*" // returns all attributes in the index not just searchable attributes
))

Can be used in these methods:
search, setSettings, searchForFacetValues, generateSecuredApiKey, addApiKey, updateApiKey search, set_settings, search_for_facet_values, generate_secured_api_key, add_api_key, update_api_key search, setSettings, searchForFacetValues, generateSecuredApiKey, addApiKey, updateApiKey search, set_settings, search_for_facet_values, generate_secured_api_key, add_api_key, update_api_key search, setSettings, searchForFacetValues, generateSecuredApiKey, addAPIKey, updateAPIKey search, setSettings, searchForFacetValues, generateSecuredApiKey, addApiKey, updateApiKey Search, SetSettings, SearchForFacetValues, GenerateSecuredApiKey, AddApiKey, UpdateApiKey Search, setSettings, searchForFacetValues, generateSecuredApiKey, addApiKey, updateApiKey Search, SetSettings, SearchForFacetValues, GenerateSecuredAPIKey, AddAPIKey, UpdateAPIKey search, setSettings, search into facet values, generateSecuredApiKey, add key, update key

See code examples

About this parameter

List of attributes to highlight.

Usage notes

If not set, all searchable attributes are highlighted (see searchableAttributes).
The special value * may be used to highlight all attributes.
Pass an empty array ([]) to disable highlighting and remove the _highlightResult object in API responses.

Impact on the response:

When highlighting is enabled, each hit in the response will contain an additional _highlightResult object (provided that at least one of its attributes is highlighted) with the following fields:
- value (string): Markup text with occurrences highlighted. The tags used for highlighting are specified via highlightPreTag and highlightPostTag.
- matchLevel (string, enum) = {none | partial | full}: Indicates how well the attribute matched the search query.
- matchedWords (array): List of words from the query that matched the object.
- fullyHighlighted (boolean): Whether the entire attribute value is highlighted.

Examples

Set default list of attributes to highlight

Copy

1
2
3
4
5
6
7
$index->setSettings([
  'attributesToHighlight' => [
    "author",
    "title",
    "content"
  ]
]);

1
2
3
4
5
6
7
8
9
10
11
12
let settings = Settings()
  .set(\.attributesToHighlight, to: [
    "author",
    "title",
    "content"
  ])

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

1
2
3
4
5
6
7
8
9
IndexSettings settings = new IndexSettings()
settings.AttributesToHighlight = new List<string>
{
    "author",
    "title",
    "content"
};

index.SetSettings(settings);

1
2
3
4
5
6
7
8
9
client.execute {
  changeSettings of "myIndex" `with` IndexSettings(
    attributesToHighlight = Some(Seq(
      "author",
      "title",
      "content",
    ))
  )
}

Make all attributes highlighted by default

Copy

1
2
3
4
5
$index->setSettings([
  'attributesToHighlight' => [
    "*"
  ]
]);

1
2
3
4
5
6
7
8
9
10
let settings = Settings()
  .set(\.attributesToHighlight, to: [
    "*"
  ])

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

Override default list of attributes to highlight for the current search

Copy

1
2
3
4
5
6
$results = $index->search('query', [
  'attributesToHighlight' => [
    "title",
    "content"
  ]
]);

1
2
3
4
5
6
7
8
9
10
11
let query = Query("query")
  .set(\.attributesToHighlight, to: [
    "title",
    "content"
  ])

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"),
    attributesToHighlight = Some(Seq(
      "title",
      "content"
    ))
  )
}

The Response Object

Copy
"_highlightResult":{
  "attribute1":{
    "value":"<b>q<\/b>uery",
    "matchLevel":"full",
    "fullyHighlighted":false,
    "matchedWords": [ "q" ]
  },
  ...
}

Did you find this page helpful?

attributesToHighlight

About this parameter

Usage notes

Impact on the response:

Examples

Set default list of attributes to highlight

Make all attributes highlighted by default

Override default list of attributes to highlight for the current search

The Response Object

On this page