Sign in
Retrievers

Typeahead

Prefix suggestions for a search box (autocomplete/typeahead).

Suggests from three namespace-scoped sources concurrently: values of the requested metadata fields (index-backed, with per-value document counts), collection names, and the caller's own recent search queries. A source that cannot answer is dropped and named in warnings rather than failing the request.

get/v1/retrievers/typeahead

Query parameters

qstring required

The typed prefix.

The typed prefix.

fieldsstring nullable

Comma-separated metadata field paths to suggest values from (e.g. metadata.talent,metadata.production). Each field should carry a keyword index; at most 5 are consulted. Omit to skip the field-value source.

Comma-separated metadata field paths to suggest values from (e.g. metadata.talent,metadata.production). Each field should carry a keyword index; at most 5 are consulted. Omit to skip the field-value source.

limitinteger

Max suggestions per source.

Max suggestions per source.

Response

Successful Response

querystring required

The prefix that was matched.

suggestionsstring[]

Flat ranked suggestion texts across all sources.

recent_searchesstring[]

The caller's own recent queries matching the prefix, newest first.

warningsstring[]

Sources that could not be consulted this request.

Changes

Changed in 1 of the 33 revisions of this API.1