Queries
Top Documents
Get the top K documents that match the given query
POST
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Body
application/json
The name of the collection.
The number of documents to return. If there are not enough documents matching your filters, then fewer may be returned. This number must be between 1 and 2048, inclusive.
The natural language query to search with. This cannot exceed 4096 characters (A single UTF-8 codepoint, is considered to be 1 character).
The query filter to apply. Please read Metadata Filtering for more information. If not provided, then all documents will be searched.
Whether or not to include the metadata in the top documents response. If not provided, then the default will be False
.
Response
200 - application/json