Chunk
Get Recommended Chunks
Chunk
- POSTCreate or Upsert Chunk or Chunks
- POSTSearch
- POSTAutocomplete
- POSTGet Recommended Chunks
- POSTScroll Chunks
- POSTCount chunks above threshold
- POSTGenerate suggested queries
- POSTRAG on Specified Chunks
- PUTUpdate Chunk
- PUTUpdate Chunk By Tracking Id
- GETGet Chunk By Id
- GETGet Chunk By Tracking Id
- POSTGet Chunks By Tracking Ids
- POSTGet Chunks By Ids
- DELDelete Chunk
- DELDelete Chunk By Tracking Id
- DELBulk Delete Chunks
- POSTSplit HTML Content into Chunks
Chunk Group
- POSTCreate or Upsert Group or Groups
- POSTSearch Over Groups
- POSTSearch Within Group
- POSTGet Recommended Groups
- POSTAdd Chunk to Group
- POSTAdd Chunk to Group by Tracking ID
- POSTGet Groups for Chunks
- GETGet Chunks in Group by Tracking ID
- GETGet Group by Tracking ID
- PUTUpdate Group
- DELRemove Chunk from Group
- DELDelete Group by Tracking ID
- DELDelete Group
- GETGet Group
- GETGet Chunks in Group
- GETGet Groups for Dataset
Message
Crawl
File
Analytics
Dataset
- POSTCreate Dataset
- POSTBatch Create Datasets
- POSTGet All Tags
- POSTGet events for the dataset
- PUTUpdate Dataset by ID or Tracking ID
- PUTClear Dataset
- GETGet Dataset By ID
- GETGet Dataset by Tracking ID
- GETGet Datasets from Organization
- POSTCreate ETL Job
- PUTCreate Pagefind Index for Dataset
- GETGet Pagefind Index Url for Dataset
- GETGet Usage By Dataset ID
- GETGet dataset crawl options
- GETGet apipublic page
- DELDelete Dataset
- DELDelete Dataset by Tracking ID
Organization
Health
Stripe
Metrics
Chunk
Get Recommended Chunks
Get recommendations of chunks similar to the positive samples in the request and dissimilar to the negative.
POST
/
api
/
chunk
/
recommend
curl --request POST \
--url https://api.trieve.ai/api/chunk/recommend \
--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
}
}
]
},
"limit": 1,
"metadata": "<any>",
"negative_chunk_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"negative_tracking_ids": [
"<string>"
],
"positive_chunk_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"positive_tracking_ids": [
"<string>"
],
"recommend_type": "semantic",
"slim_chunks": true,
"strategy": "average_vector",
"user_id": "<string>"
}'
{
"chunks": [
{
"chunk": {
"chunk_html": "<p>Some HTML content</p>",
"content": "Some content",
"id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
"link": "https://example.com",
"metadata": {
"key1": "value1",
"key2": "value2"
},
"time_stamp": "2021-01-01 00:00:00.000",
"weight": 0.5
},
"highlights": [
"highlight is two tokens: high, light",
"whereas hello is only one token: hello"
],
"score": 0.5
}
],
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
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.
The API version to use for this request. Defaults to V2 for orgs created after July 12, 2024 and V1 otherwise.
Available options:
V1
, V2
Body
application/json
JSON request payload to get recommendations of chunks similar to the chunks in the request
The body is of type object
.
Response
200
application/json
Chunks with embedding vectors which are similar to positives and dissimilar to negatives
The response is of type object
.
The response is of type object
.
The response is of type object[]
.
Was this page helpful?
curl --request POST \
--url https://api.trieve.ai/api/chunk/recommend \
--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
}
}
]
},
"limit": 1,
"metadata": "<any>",
"negative_chunk_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"negative_tracking_ids": [
"<string>"
],
"positive_chunk_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"positive_tracking_ids": [
"<string>"
],
"recommend_type": "semantic",
"slim_chunks": true,
"strategy": "average_vector",
"user_id": "<string>"
}'
{
"chunks": [
{
"chunk": {
"chunk_html": "<p>Some HTML content</p>",
"content": "Some content",
"id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
"link": "https://example.com",
"metadata": {
"key1": "value1",
"key2": "value2"
},
"time_stamp": "2021-01-01 00:00:00.000",
"weight": 0.5
},
"highlights": [
"highlight is two tokens: high, light",
"whereas hello is only one token: hello"
],
"score": 0.5
}
],
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}