Python

import os
from unstructured import UnstructuredClient

client = UnstructuredClient(
    username=os.environ.get("UNSTRUCTURED_USERNAME"),  # This is the default and can be omitted
    password=os.environ.get("UNSTRUCTURED_PASSWORD"),  # This is the default and can be omitted
)
response = client.metadata.generate.generate(
    data_connector_name="data_connector_name",
)
print(response.message)

{
  "message": "<string>",
  "output": {}
}

Metadata

Generate

Classify specified files with the provided tags. To run sensitivity detection, use tags with a strategy of SENSITIVITY or a group which includes the magic word “Sensitivity”

Request Body

Field	Type	Description
`data_connector_name`	`str`	Name of the data connector (vector database profile) to use for classification.
`file_names`	`Optional[List[str]]`	Names of specific files to classify.
`tag_names`	`Optional[List[str]]`	Names of tags to use for classification (if `tag_datas` not provided).
`tag_datas`	`Optional[Dict]`	Tag data to use for classification.
`overwrite`	`bool`	Whether to overwrite existing tags. Default: `false`
`job_id`	`Optional[str]`	Custom job ID for tracking the classification task.
`soft_run`	`bool`	If `true`, classification will not save to Deasy and will return results. Default: `false`
`hierarchy_name`	`Optional[str]`	Name of the hierarchy/taxonomy to use (if `hierarchy_data` not provided).
`hierarchy_data`	`Optional[Dict]`	Hierarchy/taxonomy data to use for classification. Default: `{}`
`dataslice_id`	`Optional[str]`	ID of the dataslice to use for file filtering.

Response

200: Classification completed or job started successfully
- Returns: { "message": str, "job_id": str, "results": Optional[Dict] }
500: Internal Server Error

Example

{
  "data_connector_name": "my-connector",
  "file_names": ["document1.pdf", "document2.pdf"],
  "tag_names": ["category", "sentiment"],
  "overwrite": false,
  "soft_run": false
}

POST

classify

Python

import os
from unstructured import UnstructuredClient

client = UnstructuredClient(
    username=os.environ.get("UNSTRUCTURED_USERNAME"),  # This is the default and can be omitted
    password=os.environ.get("UNSTRUCTURED_PASSWORD"),  # This is the default and can be omitted
)
response = client.metadata.generate.generate(
    data_connector_name="data_connector_name",
)
print(response.message)

{
  "message": "<string>",
  "output": {}
}

Body

application/json

data_connector_name

string

required

file_names

string[] | null

tag_names

string[] | null

tag_datas

Tag Datas · object

Show child attributes

overwrite

boolean

default:false

job_id

string | null

soft_run

boolean

default:false

hierarchy_name

string | null

hierarchy_data

Hierarchy Data · object

dataslice_id

string | null

Response

Successful Response

message

string

required

output

Output · object

Suggest Generate Batch

⌘I

Data Connectors

Tags

Taxonomies

Metadata

Task Tracking

Data Slices

Destinations

Generate

Request Body

Response

Example

Body

Response