Client SDKDocument IndexesGA

Search

Perform a search against a document index.

Headers

X_API_KEYstringRequired

Request

This endpoint expects an object.
querystringRequired>=1 character

The query to search for.

index_idstringOptionalformat: "uuid"

The ID of the index to search against. Must provide either this, index_name or document_index.

index_namestringOptional>=1 character

The name of the index to search against. Must provide either this, index_id or document_index.

optionsobjectOptional

Configuration options for the search.

document_indexstringOptional>=1 character

Either the index name or index ID to search against. Must provide either this, index_id or index_name.

Response

resultslist of objects

The results of the search. Each result represents a chunk that matches the search query.

Errors