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

This endpoint returns an object.

current_pageintegerOptional

query_vectorlist of doublesOptional

result_countintegerOptional

resultslist of objectsOptional

total_pagesintegerOptional

Errors

Built with

1	curl -X POST https://api.getzep.com/api/v2/collections/collectionName/search \
2	-H "Authorization: Api-Key <apiKey>" \
3	-H "Content-Type: application/json" \
4	-d '{}'

1	{
2	"current_page": 1,
3	"query_vector": [
4	1.1
5	],
6	"result_count": 1,
7	"results": [
8	{
9	"content": "content",
10	"created_at": "created_at",
11	"document_id": "document_id",
12	"embedding": [
13	1.1
14	],
15	"is_embedded": true,
16	"metadata": {
17	"key": "value"
18	},
19	"score": 1.1,
20	"updated_at": "updated_at",
21	"uuid": "uuid"
22	}
23	],
24	"total_pages": 1
25	}