Get Chunks in Group by Tracking ID

Route to get all chunks for a group. The response is paginated, with each page containing 10 chunks. Support for custom page size is coming soon. Page is 1-indexed.

GET /api/chunk_group/tracking_id/{group_tracking_id}/{page}

Try it

Get Chunks in Group by Tracking ID

cURL

curl --request GET \
  --url https://api.trieve.ai/api/chunk_group/tracking_id/{group_tracking_id}/{page} \
  --header 'Authorization: <api-key>' \
  --header 'TR-Dataset: <tr-dataset>'

200

{
  "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

Authorization · string · header · required

Headers

TR-Dataset · string<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.

X-API-Version · enum<string>

The version of the API to use for the request

Available options: V1, V2

Path Parameters

group_tracking_id · string · required

The id of the group to get the chunks from

page · integer<int64> · required

The page of chunks to get from the group

Required range: x >= 0

Response

200

application/json

Chunks present within the specified group

V2

chunks · V2 · object[] · required

Show child attributes

chunks. created_at · string<date-time> · required

Timestamp of the creation of the chunk

chunks. dataset_id · string<uuid> · required

ID of the dataset which the chunk belongs to

chunks. id · string<uuid> · required

Unique identifier of the chunk, auto-generated uuid created by Trieve

chunks. updated_at · string<date-time> · required

Timestamp of the last update of the chunk

chunks. weight · number<double> · required

Weight of the chunk, can be any float. Used as a multiplier on a chunk's relevance score for ranking purposes.

chunks. chunk_html · string | null

HTML content of the chunk, can also be an arbitrary string which is not HTML

chunks. image_urls · (string | null)[] | null

Image URLs of the chunk, can be any list of strings. Used for image search and RAG.

chunks. link · string | null

Link to the chunk, should be a URL

chunks. location · object

Location that you want to use as the center of the search.

Show child attributes

chunks.location. lat · required

chunks.location. lon · required

chunks. metadata · any | null

Metadata of the chunk, can be any JSON object

chunks. num_value · number<double> | null

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.

chunks. tag_set · (string | null)[] | null

Tag set of the chunk, can be any list of strings. Used for tag-filtered searches.

chunks. time_stamp · string<date-time> | null

Timestamp of the chunk, can be any timestamp. Specified by the user.

chunks. tracking_id · string | null

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.

group · object · required

Show child attributes

group. created_at · string<date-time> · required

group. dataset_id · string<uuid> · required

group. description · string · required

group. id · string<uuid> · required

group. name · string · required

group. updated_at · string<date-time> · required

group. file_id · string<uuid> | null

group. metadata · unknown

group. tag_set · (string | null)[] | null

group. tracking_id · string | null

Example:

{
  "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 · integer<int64> · required

Required range: x >= 0