attributesToSnippet

Type: list of strings

Engine default: [] (no attribute is snippeted)

Parameter syntax

'attributesToSnippet' => [
  'attribute',
  'attribute2:number_of_words;', // limits the size of the snippet
  ...
]

attributesToSnippet: [
  'attribute',
  'attribute2:number_of_words;', # limits the size of the snippet
  ...
]

attributesToSnippet: [
  'attribute',
  'attribute2:number_of_words;', // limits the size of the snippet
  ...
]

'attributesToSnippet': [
  'attribute',
  'attribute2:number_of_words;', # limits the size of the snippet
  ...
]

attributesToSnippet: [
  .init(attribute: "attribute"),
  .init(attribute: "attribute2", count: number_of_words), // limits the size of the snippet
  ...
]

attributesToSnippet {
    +"attribute1"
    +"attribute2"(10) // limits the number of words of the snippet
}

IndexSettings settings = new IndexSettings()
settings.AttributesToSnippet = new List<string>
{
    "attribute",
    "attribute2:number_of_words", // limits the size of the snippet
};
  ...

.setAttributesToSnippet(
  Arrays.asList(
    "attribute",
    "attribute2:number_of_words", // limits the size of the snippet
    ...
  )
)

opt.AttributesToSnippet(
  "attribute",
  "attribute2:number_of_words", // limits the size of the snippet
  ...
)

attributesToSnippet = Some(Seq(
  "attribute",
  "attribute2:number_of_words", // limits the size of the snippet
  ...
))

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 snippet, with an optional maximum number of words to snippet.

Usage notes

The number of words can be omitted, and defaults to 10.
If not set, no attributes are snippeted.
The special value * may be used to snippet all attributes.

Impact on the response:

When snippeting is enabled, each hit in the response will contain an additional _snippetResult object (provided that at least one of its attributes is snippeted) with the following fields:
- value (string): Markup text with occurrences highlighted and optional ellipsis indicators. The tags used for highlighting are specified via highlightPreTag and highlightPostTag. The text used to indicate ellipsis is specified via snippetEllipsisText.
- matchLevel (string, enum) = {none | partial | full}: Indicates how well the attribute matched the search query.

Examples

Set default list of attributes to snippet

Copy

1
2
3
4
5
6
$index->setSettings([
  'attributesToSnippet' => [
    'content:80',
    'description'
  ]
]);

1
2
3
4
5
6
7
8
9
10
11
let settings = Settings()
  .set(\.attributesToSnippet, to: [
    .init(attribute: "content", count: 80),
    .init(attribute: "description")
  ])

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

1
2
3
4
5
6
7
8
IndexSettings settings = new IndexSettings()
settings.AttributesToSnippet = new List<string>
{
    "content:80",
    "description"
};

index.SetSettings(settings);

1
2
3
4
5
6
7
8
client.execute {
  setSettings of "myIndex" `with` IndexSettings(
    attributesToSnippet = Some(Seq(
      "content:80",
      "description",
    ))
  )
}

Make all attributes highlighted by default

Copy

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

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

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

Override default list of attributes to snippet for the current search

Copy

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

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

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

The Response Object

Copy
"_snippetResult":{
  "attribute":{
    "value":"to be or not to be that is ...",
    "matchLevel":"full"
  },
  ...
}

Did you find this page helpful?

attributesToSnippet

About this parameter

Usage notes

Impact on the response:

Examples

Set default list of attributes to snippet

Make all attributes highlighted by default

Override default list of attributes to snippet for the current search

The Response Object

On this page