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
- POSTAutocomplete Search 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
- DELDelete Dataset
- DELDelete Dataset by Tracking ID
- POSTClone Dataset
- GETGet file and chunk creation queue lengths
Organization
Health
Stripe
Metrics
curl --request GET \
--url https://api.trieve.ai/api/chunk_group/{group_id}/{page} \
--header 'Authorization: <api-key>' \
--header 'TR-Dataset: <tr-dataset>'{
"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
}
],
"group": {
"created_at": "2021-01-01 00:00:00.000",
"dataset_id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
"description": "A group of chunks",
"file_id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
"id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
"name": "Trieve",
"tracking_id": "3",
"updated_at": "2021-01-01 00:00:00.000"
},
"total_pages": 1
}Get Chunks in Group
Route to get all chunks for a group. The response is paginated, with each page containing 10 chunks. Page is 1-indexed.
curl --request GET \
--url https://api.trieve.ai/api/chunk_group/{group_id}/{page} \
--header 'Authorization: <api-key>' \
--header 'TR-Dataset: <tr-dataset>'{
"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
}
],
"group": {
"created_at": "2021-01-01 00:00:00.000",
"dataset_id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
"description": "A group of chunks",
"file_id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
"id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
"name": "Trieve",
"tracking_id": "3",
"updated_at": "2021-01-01 00:00:00.000"
},
"total_pages": 1
}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 version of the API to use for the request
V1, V2 Path Parameters
Id of the group you want to fetch.
x >= 0Response
Chunks present within the specified group
- V2
- V1
Show child attributes
Show child attributes
Timestamp of the creation of the chunk
ID of the dataset which the chunk belongs to
Unique identifier of the chunk, auto-generated uuid created by Trieve
Timestamp of the last update of the chunk
Weight of the chunk, can be any float. Used as a multiplier on a chunk's relevance score for ranking purposes.
HTML content of the chunk, can also be an arbitrary string which is not HTML
Image URLs of the chunk, can be any list of strings. Used for image search and RAG.
Link to the chunk, should be a URL
Metadata of the chunk, can be any JSON object
Numeric value of the chunk, can be any float. Can represent the most relevant numeric value of the chunk, such as a price, quantity in stock, rating, etc.
Tag set of the chunk, can be any list of strings. Used for tag-filtered searches.
Timestamp of the chunk, can be any timestamp. Specified by the user.
Tracking ID of the chunk, can be any string, determined by the user. Tracking ID's are unique identifiers for chunks within a dataset. They are designed to match the unique identifier of the chunk in the user's system.
Show child attributes
Show child attributes
{
"created_at": "2021-01-01 00:00:00.000",
"dataset_id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
"description": "A group of chunks",
"file_id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
"id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
"name": "Trieve",
"tracking_id": "3",
"updated_at": "2021-01-01 00:00:00.000"
}x >= 0Was this page helpful?