Searches Documents in a DocumentCollection

Deprecated
Searches over documents in a collection based on provided search criteria. One of text or metadata must be provided. Returns an empty list if no documents are found.

Path parameters

collectionNamestringRequired
Name of the Document Collection

Headers

AuthorizationstringRequired

Header authentication of the form Api-Key <token>

Query parameters

limitintegerOptional
Limit the number of returned documents

Request

This endpoint expects an object.
metadatamap from strings to anyOptional
Document metadata to filter on.
min_scoredoubleOptional
mmr_lambdadoubleOptional
The lambda parameter for the MMR Reranking Algorithm.
search_typeenumOptional
The type of search to perform. Defaults to "similarity". Must be one of "similarity" or "mmr".
Allowed values:
textstringOptional
The search text.

Response

OK
current_pageinteger or null
query_vectorlist of doubles or null
result_countinteger or null
resultslist of objects or null
total_pagesinteger or null

Errors