Generate

Generate Batch

Classify all files in a data connector in batches 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.
`total_data_sets`	`Optional[int]`	Total number of 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.
`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.
`conditions`	`Optional[Condition]`	Conditions to use for file filtering.

Response

200: Classification job started successfully
- Returns: { "message": str, "job_id": str }
500: Internal Server Error

Example

{
  "data_connector_name": "my-connector",
  "tag_names": ["category", "sentiment"],
  "overwrite": false,
  "dataslice_id": "abc123"
}

POST

classify_bulk

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_batch(
    data_connector_name="data_connector_name",
)
print(response.message)

import UnstructuredClient from 'unstructured-sdk';

const client = new UnstructuredClient({
  authMethod: 'My Auth Method',
  username: process.env['UNSTRUCTURED_USERNAME'], // This is the default and can be omitted
  password: process.env['UNSTRUCTURED_PASSWORD'], // This is the default and can be omitted
});

const response = await client.metadata.generate.generateBatch({
  data_connector_name: 'data_connector_name',
});

console.log(response.message);

{
  "message": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

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

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

data_connector_name

string

required

total_data_sets

integer | null

tag_names

string[] | null

tag_datas

Tag Datas · object | null

Show child attributes

overwrite

boolean

default:false

job_id

string | null

hierarchy_name

string | null

hierarchy_data

Hierarchy Data · object | null

dataslice_id

string | null

conditions

Condition · object | null

Show child attributes

Response

Successful Response

message

string

required

⌘I

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_batch(
    data_connector_name="data_connector_name",
)
print(response.message)

import UnstructuredClient from 'unstructured-sdk';

const client = new UnstructuredClient({
  authMethod: 'My Auth Method',
  username: process.env['UNSTRUCTURED_USERNAME'], // This is the default and can be omitted
  password: process.env['UNSTRUCTURED_PASSWORD'], // This is the default and can be omitted
});

const response = await client.metadata.generate.generateBatch({
  data_connector_name: 'data_connector_name',
});

console.log(response.message);

{
  "message": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

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

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

Overview

Data Connectors

Tags

Taxonomies

Metadata

Data Slices

Destinations

Projects

Workflows

Task Tracking

Generate Batch

Request Body

Response

Example

Authorizations

Body

Response