Searches Documents in a DocumentCollection (cloud only)

Deprecated
POST

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

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_type"similarity" or "mmr"Optional
Allowed values: similaritymmr

The type of search to perform. Defaults to “similarity”. Must be one of “similarity” or “mmr”.

textstringOptional

The search text.

Response

OK

current_pageintegerOptional
query_vectorlist of doublesOptional
result_countintegerOptional
resultslist of objectsOptional
total_pagesintegerOptional

Errors