Search Chunks

Perform a semantic search query over all stored chunks.

This endpoint allows for complex filtering of search results using PostgreSQL-based queries. Filters can be applied to various fields such as document_id, and internal metadata values.

Allowed operators include eq, neq, gt, gte, lt, lte, like, ilike, in, and nin.

Perform a semantic search query over all stored chunks. This endpoint allows for complex filtering of search results using PostgreSQL-based queries. Filters can be applied to various fields such as document_id, and internal metadata values. Allowed operators include `eq`, `neq`, `gt`, `gte`, `lt`, `lte`, `like`, `ilike`, `in`, and `nin`.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.

querystringRequired

search_settingsobjectOptional

Main search settings class that combines shared settings with specialized settings for chunks and graph.

Response

Successful Response

resultslist of objects

1	from r2r import R2RClient
2
3	client = R2RClient()
4	response = client.chunks.search(
5	query="search query",
6	search_settings={
7	"limit": 10
8	}
9	)

1	{
2	"results": [
3	{
4	"id": "3f3d47f3-8baf-58eb-8bc2-0171fb1c6e09",
5	"document_id": "3e157b3a-8469-51db-90d9-52e7d896b49b",
6	"collection_ids": [
7	"collection_ids"
8	],
9	"text": "Example text from the document",
10	"metadata": {
11	"associated_query": "What is the capital of France?",
12	"title": "example_document.pdf"
13	},
14	"owner_id": "2acb499e-8428-543b-bd85-0d9098718220",
15	"score": 0.23943702876567796
16	}
17	]
18	}

Authentication

Headers

Request

Response

Errors