Searches Documents in a DocumentCollection

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.

Authentication

AuthorizationApi-Key

Header authentication of the form Api-Key <token>

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_typeenumOptional

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

Allowed values:

textstringOptional

The search text.

Response

current_pageinteger or null

query_vectorlist of doubles or null

result_countinteger or null

resultslist of objects or null

total_pagesinteger or null

1	import requests
2
3	url = "https://api.getzep.com/api/v2/collections/collectionName/search"
4
5	payload = {}
6	headers = {
7	"Authorization": "Api-Key <apiKey>",
8	"Content-Type": "application/json"
9	}
10
11	response = requests.post(url, json=payload, headers=headers)
12
13	print(response.json())

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	}

Authentication

Path Parameters

Query Parameters

Request

Response

Errors