curl --request POST \
--url https://api.trieve.ai/api/chunks/scroll \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--header 'TR-Dataset: <tr-dataset>' \
--data '{
"filters": {
"must": [
{
"field": "tag_set",
"match_all": [
"A",
"B"
]
},
{
"field": "num_value",
"range": {
"gte": 10,
"lte": 25
}
}
]
},
"offset_chunk_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"page_size": 1,
"sort_by": {
"direction": "desc",
"field": "<string>",
"prefetch_amount": 1
}
}'
{
"chunks": [
{
"chunk_html": "<p>Hello, world!</p>",
"created_at": "2021-01-01 00:00:00.000",
"dataset_id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
"id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
"link": "https://trieve.ai",
"metadata": {
"key": "value"
},
"tag_set": "[tag1,tag2]",
"time_stamp": "2021-01-01 00:00:00.000",
"tracking_id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
"updated_at": "2021-01-01 00:00:00.000",
"weight": 0.5
}
]
}
Get paginated chunks from your dataset with filters and custom sorting. If sort by is not specified, the results will sort by the id’s of the chunks in ascending order. Sort by and offset_chunk_id cannot be used together; if you want to scroll with a sort by then you need to use a must_not filter with the ids you have already seen. There is a limit of 1000 id’s in a must_not filter at a time.
curl --request POST \
--url https://api.trieve.ai/api/chunks/scroll \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--header 'TR-Dataset: <tr-dataset>' \
--data '{
"filters": {
"must": [
{
"field": "tag_set",
"match_all": [
"A",
"B"
]
},
{
"field": "num_value",
"range": {
"gte": 10,
"lte": 25
}
}
]
},
"offset_chunk_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"page_size": 1,
"sort_by": {
"direction": "desc",
"field": "<string>",
"prefetch_amount": 1
}
}'
{
"chunks": [
{
"chunk_html": "<p>Hello, world!</p>",
"created_at": "2021-01-01 00:00:00.000",
"dataset_id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
"id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
"link": "https://trieve.ai",
"metadata": {
"key": "value"
},
"tag_set": "[tag1,tag2]",
"time_stamp": "2021-01-01 00:00:00.000",
"tracking_id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
"updated_at": "2021-01-01 00:00:00.000",
"weight": 0.5
}
]
}
The dataset id or tracking_id to use for the request. We assume you intend to use an id if the value is a valid uuid.
JSON request payload to scroll through chunks (chunks)
The body is of type object
.
Number of chunks equivalent to page_size starting from offset_chunk_id
The response is of type object
.
Was this page helpful?