File
Scroll Files with Groups
Scroll through the files along with their groups in a dataset. This is useful for paginating through files. The cursor is used to fetch the next page of files. The page size is used to specify how many files to fetch per page. The default page size is 10.
get/api/dataset/scroll_files
Query parameters
cursorstring uuid nullable
The cursor to fetch files from. If not specified, will fetch from the beginning. File ids are compared to the cursor using a greater than or equal to.
page_sizeinteger nullable
The page size of files you wish to fetch. Defaults to 10.
Headers
TR-Datasetstring uuid required
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.
Response
JSON body representing the files along with their associated groups in the current dataset
Example response
{
"file_with_chunk_groups": [
{
"chunk_groups": [
{
"created_at": "2021-01-01 00:00:00.000",
"dataset_id": "f83f08ef-c05d-421c-baf1-4f1509ea069b",
"description": "",
"id": "df1b73ec-1e62-44bc-b07e-b04485217842",
"metadata": {},
"name": "uploadme.pdf",
"tag_set": [],
"tracking_id": "file-upload-group",
"updated_at": "2021-01-01 00:00:00.000"
}
],
"created_at": "2021-01-01 00:00:00.000",
"dataset_id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
"file_name": "file.txt",
"id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
"link": "https://trieve.ai",
"metadata": {
"key": "value"
},
"size": 1000,
"tag_set": "tag1,tag2",
"time_stamp": "2021-01-01 00:00:00.000",
"updated_at": "2021-01-01 00:00:00.000"
}
]
}