Skip to main content
The attributesToSnippet parameter defines which attributes should return snippets—short text fragments surrounding matched query terms.

​
Usage

  • The default snippet length is 10 words unless otherwise specified, for example "content:80".
  • Use "*" to apply snippets to all attributes.
  • To turn off snippeting, pass an empty array ([]).
  • Snippeting is limited to the first 50,000 characters per result (or 5,000 logograms for CJK languages).
  • When enabled, the search response includes a _snippetResult object.

​
_snippetResult

​
Examples

​
Set default attributes to snippet

Current API clients

var response = await client.SetSettingsAsync(
  "ALGOLIA_INDEX_NAME",
  new IndexSettings
  {
    AttributesToSnippet = new List<string> { "content:80", "description" },
  }
);

IndexSettings settings = new IndexSettings()
settings.AttributesToSnippet = new List
{
    "content:80",
    "description"
};

index.SetSettings(settings);

​
Snippet all attributes by default

Current API clients

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

IndexSettings settings = new IndexSettings()
settings.AttributesToSnippet = new List
{
    "*:80"
};

index.SetSettings(settings);

Current API clients

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

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