Scroll Chunks
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": {
"field": "<string>",
"prefetch_amount": 1
}
}
'import requests
url = "https://api.trieve.ai/api/chunks/scroll"
payload = {
"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": {
"field": "<string>",
"prefetch_amount": 1
}
}
headers = {
"TR-Dataset": "<tr-dataset>",
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'TR-Dataset': '<tr-dataset>',
Authorization: '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
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: {field: '<string>', prefetch_amount: 1}
})
};
fetch('https://api.trieve.ai/api/chunks/scroll', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.trieve.ai/api/chunks/scroll",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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' => [
'field' => '<string>',
'prefetch_amount' => 1
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json",
"TR-Dataset: <tr-dataset>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.trieve.ai/api/chunks/scroll"
payload := strings.NewReader("{\n \"filters\": {\n \"must\": [\n {\n \"field\": \"tag_set\",\n \"match_all\": [\n \"A\",\n \"B\"\n ]\n },\n {\n \"field\": \"num_value\",\n \"range\": {\n \"gte\": 10,\n \"lte\": 25\n }\n }\n ]\n },\n \"offset_chunk_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"page_size\": 1,\n \"sort_by\": {\n \"field\": \"<string>\",\n \"prefetch_amount\": 1\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("TR-Dataset", "<tr-dataset>")
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.trieve.ai/api/chunks/scroll")
.header("TR-Dataset", "<tr-dataset>")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"filters\": {\n \"must\": [\n {\n \"field\": \"tag_set\",\n \"match_all\": [\n \"A\",\n \"B\"\n ]\n },\n {\n \"field\": \"num_value\",\n \"range\": {\n \"gte\": 10,\n \"lte\": 25\n }\n }\n ]\n },\n \"offset_chunk_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"page_size\": 1,\n \"sort_by\": {\n \"field\": \"<string>\",\n \"prefetch_amount\": 1\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.trieve.ai/api/chunks/scroll")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["TR-Dataset"] = '<tr-dataset>'
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"filters\": {\n \"must\": [\n {\n \"field\": \"tag_set\",\n \"match_all\": [\n \"A\",\n \"B\"\n ]\n },\n {\n \"field\": \"num_value\",\n \"range\": {\n \"gte\": 10,\n \"lte\": 25\n }\n }\n ]\n },\n \"offset_chunk_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"page_size\": 1,\n \"sort_by\": {\n \"field\": \"<string>\",\n \"prefetch_amount\": 1\n }\n}"
response = http.request(request)
puts response.read_body{
"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
}
]
}{
"message": "Bad Request"
}Chunk
Scroll Chunks
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.
POST
/
api
/
chunks
/
scroll
Scroll Chunks
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": {
"field": "<string>",
"prefetch_amount": 1
}
}
'import requests
url = "https://api.trieve.ai/api/chunks/scroll"
payload = {
"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": {
"field": "<string>",
"prefetch_amount": 1
}
}
headers = {
"TR-Dataset": "<tr-dataset>",
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'TR-Dataset': '<tr-dataset>',
Authorization: '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
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: {field: '<string>', prefetch_amount: 1}
})
};
fetch('https://api.trieve.ai/api/chunks/scroll', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.trieve.ai/api/chunks/scroll",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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' => [
'field' => '<string>',
'prefetch_amount' => 1
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json",
"TR-Dataset: <tr-dataset>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.trieve.ai/api/chunks/scroll"
payload := strings.NewReader("{\n \"filters\": {\n \"must\": [\n {\n \"field\": \"tag_set\",\n \"match_all\": [\n \"A\",\n \"B\"\n ]\n },\n {\n \"field\": \"num_value\",\n \"range\": {\n \"gte\": 10,\n \"lte\": 25\n }\n }\n ]\n },\n \"offset_chunk_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"page_size\": 1,\n \"sort_by\": {\n \"field\": \"<string>\",\n \"prefetch_amount\": 1\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("TR-Dataset", "<tr-dataset>")
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.trieve.ai/api/chunks/scroll")
.header("TR-Dataset", "<tr-dataset>")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"filters\": {\n \"must\": [\n {\n \"field\": \"tag_set\",\n \"match_all\": [\n \"A\",\n \"B\"\n ]\n },\n {\n \"field\": \"num_value\",\n \"range\": {\n \"gte\": 10,\n \"lte\": 25\n }\n }\n ]\n },\n \"offset_chunk_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"page_size\": 1,\n \"sort_by\": {\n \"field\": \"<string>\",\n \"prefetch_amount\": 1\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.trieve.ai/api/chunks/scroll")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["TR-Dataset"] = '<tr-dataset>'
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"filters\": {\n \"must\": [\n {\n \"field\": \"tag_set\",\n \"match_all\": [\n \"A\",\n \"B\"\n ]\n },\n {\n \"field\": \"num_value\",\n \"range\": {\n \"gte\": 10,\n \"lte\": 25\n }\n }\n ]\n },\n \"offset_chunk_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"page_size\": 1,\n \"sort_by\": {\n \"field\": \"<string>\",\n \"prefetch_amount\": 1\n }\n}"
response = http.request(request)
puts response.read_body{
"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
}
]
}{
"message": "Bad Request"
}Authorizations
Headers
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.
Body
application/json
JSON request payload to scroll through chunks (chunks)
ChunkFilter is a JSON object which can be used to filter chunks. This is useful for when you want to filter chunks by arbitrary metadata. Unlike with tag filtering, there is a performance hit for filtering on metadata.
Show child attributes
Show child attributes
Example:
{
"must": [
{
"field": "tag_set",
"match_all": ["A", "B"]
},
{
"field": "num_value",
"range": { "gte": 10, "lte": 25 }
}
]
}
Offset chunk id is the id of the chunk to start the page from. If not specified, this defaults to the first chunk in the dataset sorted by id ascending.
Page size is the number of chunks to fetch. This can be used to fetch more than 10 chunks at a time.
Required range:
x >= 0Show child attributes
Show child attributes
Response
Number of chunks equivalent to page_size starting from offset_chunk_id
Show child attributes
Show child attributes
Was this page helpful?