POST
/
queries
/
top-snippets

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
collection_name
string
required

The name of the collection.

k
integer
required

The number of snippets to return. If there are not enough snippets matching your filters, then fewer may be returned. This number must be between 1 and 2048, inclusive.

query
string
required

The natural language query to search with. This cannot exceed 4096 characters (A single UTF-8 codepoint, is considered to be 1 character).

filter

The query filter to apply. Please read Metadata Filtering for more information. If not provided, then all documents will be searched.

precise_responses
boolean
default:
false

Enable precise responses. Precise responses will have higher latency, but provide much more precise snippets. When precise_responses is set to true, the responses will average 200 characters. If set to false, the responses will average 2000 characters. The default is false.

Response

200 - application/json
results
object[]
required