snippetEllipsisText

Text used to indicate truncation of snippets

The snippetEllipsisText parameter defines the string inserted at the end of a truncated snippet.

This applies to attributes defined in attributesToSnippet, and appears in the _snippetResult field of search results.

Examples

Set default snippet ellipsis text

Current API clients

C#

var response = await client.SetSettingsAsync(
  "INDEX_NAME",
  new IndexSettings { SnippetEllipsisText = "…" }
);

final response = await client.setSettings(
  indexName: "INDEX_NAME",
  indexSettings: IndexSettings(
    snippetEllipsisText: "…",
  ),
);

response, err := client.SetSettings(client.NewApiSetSettingsRequest(
  "INDEX_NAME",
  search.NewEmptyIndexSettings().SetSnippetEllipsisText("…")))
if err != nil {
  // handle the eventual error
  panic(err)
}

UpdatedAtResponse response = client.setSettings("INDEX_NAME", new IndexSettings().setSnippetEllipsisText("…"));

const response = await client.setSettings({ indexName: 'theIndexName', indexSettings: { snippetEllipsisText: '…' } });

var response =
  client.setSettings(
    indexName = "INDEX_NAME",
    indexSettings = IndexSettings(snippetEllipsisText = "…"),
  )

$response = $client->setSettings(
    'INDEX_NAME',
    ['snippetEllipsisText' => '…',
    ],
);

response = client.set_settings(
    index_name="INDEX_NAME",
    index_settings={
        "snippetEllipsisText": "…",
    },
)

response = client.set_settings("INDEX_NAME", Algolia::Search::IndexSettings.new(snippet_ellipsis_text: "…"))

val response = Await.result(
  client.setSettings(
    indexName = "INDEX_NAME",
    indexSettings = IndexSettings(
      snippetEllipsisText = Some("…")
    )
  ),
  Duration(100, "sec")
)

let response = try await client.setSettings(
    indexName: "INDEX_NAME",
    indexSettings: IndexSettings(snippetEllipsisText: "…")
)

Legacy API clients

C#

IndexSettings settings = new IndexSettings()
settings.SnippetEllipsisText = "...";

index.SetSettings(settings);

res, err := index.SetSettings(search.Settings{
	SnippetEllipsisText: opt.SnippetEllipsisText("…"),
})

index.setSettings(
  new IndexSettings()
    .setSnippetEllipsisText("…")
);

index
  .setSettings({
    snippetEllipsisText: "…",
  })
  .then(() => {
    // done
  });

val settings = settings {
    snippetEllipsisText = "…"
}

index.setSettings(settings)

$index->setSettings([
  'snippetEllipsisText' => '…'
]);

index.setSettings({"snippetEllipsisText": "…"})

index.set_settings(
  {
    snippetEllipsisText: "…"
  }
)

client.execute {
  setSettings of "myIndex" `with` IndexSettings(
    snippetEllipsisText = Some("…")
  )
}

let settings = Settings()
  .set(\.snippetEllipsisText, to: "…")

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

Override default snippet ellipsis text for the current search

Current API clients

C#

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

final response = await client.searchSingleIndex(
  indexName: "INDEX_NAME",
  searchParams: SearchParamsObject(
    query: "query",
    snippetEllipsisText: "",
  ),
);

response, err := client.SearchSingleIndex(client.NewApiSearchSingleIndexRequest(
  "INDEX_NAME").WithSearchParams(search.SearchParamsObjectAsSearchParams(
  search.NewEmptySearchParamsObject().SetQuery("query").SetSnippetEllipsisText(""))))
if err != nil {
  // handle the eventual error
  panic(err)
}

SearchResponse response = client.searchSingleIndex(
  "INDEX_NAME",
  new SearchParamsObject().setQuery("query").setSnippetEllipsisText(""),
  Hit.class
);

const response = await client.searchSingleIndex({
  indexName: 'indexName',
  searchParams: { query: 'query', snippetEllipsisText: '' },
});

var response =
  client.searchSingleIndex(
    indexName = "INDEX_NAME",
    searchParams = SearchParamsObject(query = "query", snippetEllipsisText = ""),
  )

$response = $client->searchSingleIndex(
    'INDEX_NAME',
    ['query' => 'query',
        'snippetEllipsisText' => '',
    ],
);

response = client.search_single_index(
    index_name="INDEX_NAME",
    search_params={
        "query": "query",
        "snippetEllipsisText": "",
    },
)

response = client.search_single_index(
  "INDEX_NAME",
  Algolia::Search::SearchParamsObject.new(query: "query", snippet_ellipsis_text: "")
)

val response = Await.result(
  client.searchSingleIndex(
    indexName = "INDEX_NAME",
    searchParams = Some(
      SearchParamsObject(
        query = Some("query"),
        snippetEllipsisText = Some("")
      )
    )
  ),
  Duration(100, "sec")
)

let response: SearchResponse<Hit> = try await client.searchSingleIndex(
    indexName: "INDEX_NAME",
    searchParams: SearchSearchParams.searchSearchParamsObject(SearchSearchParamsObject(
        query: "query",
        snippetEllipsisText: ""
    ))
)

Legacy API clients

C#

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

res, err := index.Search(
  "query",
  opt.SnippetEllipsisText(""),
})

index.search(
  new Query("query")
    .setSnippetEllipsisText("")
);

index
  .search("query", {
    snippetEllipsisText: "",
  })
  .then(({ hits }) => {
    console.log(hits);
  });

val query = query("query") {
    snippetEllipsisText = ""
}

index.search(query)

$results = $index->search('query', [
  'snippetEllipsisText' => ''
]);

results = index.search("query", {"snippetEllipsisText": ""})

results = index.search(
  "query",
  {
    snippetEllipsisText: ""
  }
)

client.execute {
  search into "myIndex" query Query(
    query = Some("query"),
    snippetEllipsisText = Some("")
  )
}

let query = Query("query")
  .set(\.snippetEllipsisText, to: "")

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