Read

List Paginated

Get paginated filtered metadata based on conditions.

Request Body

Field	Type	Description
`datasource_id`	`Optional[UUID]`	Id of the data connector (vector database profile).
`dataslice_id`	`Optional[str]`	ID of the dataslice to get files from.
`tag_ids`	`Optional[List[str]]`	List of tag ids to include in the metadata.
`include_chunk_level`	`Optional[bool]`	Whether to include chunk-level metadata. Default: `true`
`offset`	`Optional[int]`	Pagination offset to start from. Default: `0`
`limit`	`Optional[int]`	Maximum number of metadata items to return. Default: `50`
`include_last_updated`	`Optional[bool]`	Whether to include the last updated timestamp. Default: `false`

Response

200: Metadata retrieved successfully
- Returns: { "metadata": Deasy_Metadata, "next_offset": Optional[int], "tag_names": Dict[str, str] }
500: Internal Server Error

Example

{
  "datasource_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "dataslice_id": "abc123",
  "tag_ids": ["3fa85f64-5717-4562-b3fc-2c963f66afa7"],
  "include_chunk_level": true,
  "offset": 0,
  "limit": 50
}

POST

metadata

list_paginated

Python

# pip install deasy-sdk
import os
from deasy import DeasyClient

client = DeasyClient(
    base_url=os.environ["UNSTRUCTURED_CLIENT_BASE_URL"],
    username=os.environ["UNSTRUCTURED_USERNAME"],
    password=os.environ["UNSTRUCTURED_PASSWORD"],
)

response = client.metadata.list_paginated()
print(response.metadata)

{
  "metadata": {},
  "next_offset": 123,
  "tag_names": {}
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

Authorizations

Authorization

string

header

required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json

datasource_id

string<uuid> | null

dataslice_id

string | null

tag_ids

string[] | null

include_chunk_level

boolean | null

default:true

offset

integer | null

default:0

limit

integer | null

default:50

include_last_updated

boolean | null

default:false

Response

Successful Response

metadata

Metadata · object

required

Metadata
Metadata

Show child attributes

next_offset

integer | null

required

tag_names

Tag Names · object

Show child attributes

⌘I

Python

# pip install deasy-sdk
import os
from deasy import DeasyClient

client = DeasyClient(
    base_url=os.environ["UNSTRUCTURED_CLIENT_BASE_URL"],
    username=os.environ["UNSTRUCTURED_USERNAME"],
    password=os.environ["UNSTRUCTURED_PASSWORD"],
)

response = client.metadata.list_paginated()
print(response.metadata)

{
  "metadata": {},
  "next_offset": 123,
  "tag_names": {}
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

Overview

Data Connectors

Tags

Taxonomies

Metadata

Data Slices

Deduplication

Destinations

Workflows

Task Tracking

List Paginated

Request Body

Response

Example

Authorizations

Body

Response