Document Indexes

Search

GA
POST
Perform a search against a document index.

Request

This endpoint expects an object.
query
stringRequired
The query to search for.
index_id
stringOptional

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

index_name
stringOptional

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

options
objectOptional
Configuration options for the search.

Response

This endpoint returns an object
results
list of objects
The results of the search. Each result represents a chunk that matches the search query.
Built with