Python

from unstructured import UnstructuredClient

client = UnstructuredClient(
    username="My Username",
    password="My Password",
)
response = client.taxonomy.suggest(
    data_connector_name="data_connector_name",
)
print(response.suggestion)

{
  "suggestion": {},
  "status_code": 200,
  "message": "",
  "suggested_tags": {},
  "node": {
    "label": "Root",
    "path": []
  },
  "tag_not_found_rates": {}
}

Taxonomies

Suggest

Suggest a tag taxonomy based on file content and existing metadata.

Request Body

Field	Type	Description
`data_connector_name`	`str`	Name of the data connector (vector database profile) to use.
`file_names`	`Optional[List[str]]`	List of specific files to analyze for the hierarchy suggestion.
`dataslice_id`	`Optional[str]`	ID of a dataslice to pull files from for the suggestion.
`progress_tracking_id`	`Optional[str]`	Custom tracking ID for monitoring the suggestion progress.
`schema_name`	`Optional[str]`	Name for the suggested schema/taxonomy.
`current_tree`	`Optional[Dict]`	Existing hierarchy tree to build upon.
`condition`	`Optional[Condition]`	Filtering condition to select specific files for analysis.
`node`	`Optional[GraphNode]`	Node location in the existing hierarchy tree to build upon. Default: `{}`
`user_context`	`Optional[str]`	User-provided context to guide the suggestion process.
`context_level`	`Optional[str]`	Level at which to analyze content: `file` or `chunk`. Default: `"file"`
`max_height`	`Optional[int]`	Maximum depth of the generated hierarchy tree. Default: `2`
`use_existing_tags`	`Optional[bool]`	Whether to incorporate existing tags in suggestions. Default: `false`
`use_extracted_tags`	`Optional[bool]`	Whether to use previously extracted tags. Default: `false`
`use_mix_llm_and_source`	`Optional[bool]`	Whether to mix LLM-generated and source-based tags. Default: `false`

Response

200: Schema suggestion generated successfully
- Returns: { "status_code": int, "message": str, "suggestion": Dict, "suggested_tags": Optional[Dict], "node": Optional[GraphNode], "tag_not_found_rates": Optional[Dict] }
500: Internal Server Error

Example

{
  "data_connector_name": "my-connector",
  "file_names": ["document1.pdf", "document2.pdf"],
  "context_level": "file",
  "max_height": 3,
  "use_existing_tags": true,
  "user_context": "Suggest categories for financial documents"
}

POST

suggest_schema

Python

from unstructured import UnstructuredClient

client = UnstructuredClient(
    username="My Username",
    password="My Password",
)
response = client.taxonomy.suggest(
    data_connector_name="data_connector_name",
)
print(response.suggestion)

{
  "suggestion": {},
  "status_code": 200,
  "message": "",
  "suggested_tags": {},
  "node": {
    "label": "Root",
    "path": []
  },
  "tag_not_found_rates": {}
}

Body

application/json

data_connector_name

string

required

file_names

string[] | null

dataslice_id

string | null

progress_tracking_id

string | null

schema_name

string | null

current_tree

Current Tree · object

condition

Condition · object

Show child attributes

condition.condition

enum<string> | null

Available options:

AND,

OR

condition.children

any[] | null

condition.tag

BaseTag · object

Show child attributes

condition.tag.name

string

required

condition.tag.values

(string | number | integer)[]

required

condition.tag.operator

string | null

default:any

node

GraphNode · object

Show child attributes

node.label

string | null

default:Root

node.path

string[] | null

user_context

string | null

context_level

string | null

default:file

max_height

integer | null

default:2

use_existing_tags

boolean | null

default:false

use_extracted_tags

boolean | null

default:false

use_mix_llm_and_source

boolean | null

default:false

graph_tag_type

enum<string> | null

default:open_ended

Available options:

open_ended,

binary,

mixed,

defined_values,

hierarchy

min_tags_per_level

integer | null

default:1

max_tags_per_level

integer | null

default:10

set_max_values

boolean | null

default:true

values_per_tag

integer | null

auto_save

boolean | null

default:true

validate_tags

boolean | null

default:true

validation_sample_size

integer | null

default:10

not_found_threshold

number | null

default:1

use_hierarchical_clustering

boolean | null

default:true

deep_suggestion_mode

boolean | null

default:false

Response

Successful Response

suggestion

Suggestion · object

required

status_code

integer | null

default:200

message

string | null

default:""

suggested_tags

Suggested Tags · object

Show child attributes

suggested_tags.{key}

DeasyInputTag · object

Show child attributes

suggested_tags.{key}.name

string

required

suggested_tags.{key}.output_type

string

required

suggested_tags.{key}.tag_id

string | null

suggested_tags.{key}.id

string | null

suggested_tags.{key}.description

string | null

default:""

suggested_tags.{key}.available_values

string[] | null

suggested_tags.{key}.examples

(string | object)[] | null

suggested_tags.{key}.maxValues

integer | null

suggested_tags.{key}.date_format

string | null

suggested_tags.{key}.tuned

integer | null

default:0

suggested_tags.{key}.enhance_file_metadata

boolean | null

default:true

suggested_tags.{key}.group

string | null

suggested_tags.{key}.min_confidence

number | null

suggested_tags.{key}.strategy

string | null

default:LLM

suggested_tags.{key}.patterns

RegexPattern · object[] | null

Show child attributes

suggested_tags.{key}.patterns.pattern

string

required

suggested_tags.{key}.patterns.description

string | null

suggested_tags.{key}.patterns.output_value

string | null

suggested_tags.{key}.patterns.confidence

number | null

suggested_tags.{key}.patterns.validator

string | null

suggested_tags.{key}.patterns.active

boolean | null

default:true

suggested_tags.{key}.visual_rules

RuleBasedRule · object[] | null

Show child attributes

suggested_tags.{key}.visual_rules.tag_value

suggested_tags.{key}.visual_rules.condition

Condition · object

Show child attributes

suggested_tags.{key}.visual_rules.condition.condition

enum<string> | null

Available options:

AND,

OR

suggested_tags.{key}.visual_rules.condition.children

any[] | null

suggested_tags.{key}.visual_rules.condition.tag

BaseTag · object

Show child attributes

suggested_tags.{key}.visual_rules.condition.tag.name

string

required

suggested_tags.{key}.visual_rules.condition.tag.values

(string | number | integer)[]

required

suggested_tags.{key}.visual_rules.condition.tag.operator

string | null

default:any

suggested_tags.{key}.visual_rules.description

string | null

suggested_tags.{key}.visual_rules.confidence

number | null

suggested_tags.{key}.scope

string | null

default:ALL_PAGES

node

GraphNode · object

Show child attributes

node.label

string | null

default:Root

node.path

string[] | null

tag_not_found_rates

Tag Not Found Rates · object

Show child attributes

tag_not_found_rates.{key}

number

Delete Generate

⌘I

Data Connectors

Tags

Taxonomies

Metadata

Task Tracking

Data Slices

Destinations

Suggest

Request Body

Response

Example

Body

Response