Python

from unstructured import UnstructuredClient

client = UnstructuredClient(
    username="My Username",
    password="My Password",
)
taxonomy_operation_response = client.taxonomy.upsert(
    taxonomy_name="taxonomy_name",
)
print(taxonomy_operation_response.taxonomy_name)

{
  "taxonomy_name": "<string>"
}

Taxonomies

Upsert

Insert or update a taxonomy (schema/hierarchy) in the database.

Request Body

Field	Type	Description
`taxonomy_name`	`str`	Name of the taxonomy to upsert.
`new_taxonomy_name`	`Optional[str]`	New name for the taxonomy (when updating).
`taxonomy_description`	`Optional[str]`	Description of the taxonomy.
`taxonomy_data`	`Optional[Dict]`	The taxonomy/hierarchy data structure.

Response

200: Taxonomy upserted successfully
- Returns: { "taxonomy_name": str }
500: Internal Server Error

Example

{
  "taxonomy_name": "document-categories",
  "taxonomy_description": "Main document classification taxonomy",
  "taxonomy_data": {
    "invoice": ["purchase_invoice", "sales_invoice"],
    "receipt": ["expense_receipt", "payment_receipt"]
  }
}

POST

taxonomy

upsert

Python

from unstructured import UnstructuredClient

client = UnstructuredClient(
    username="My Username",
    password="My Password",
)
taxonomy_operation_response = client.taxonomy.upsert(
    taxonomy_name="taxonomy_name",
)
print(taxonomy_operation_response.taxonomy_name)

{
  "taxonomy_name": "<string>"
}

Body

application/json

taxonomy_name

string

required

new_taxonomy_name

string | null

taxonomy_description

string | null

taxonomy_data

Taxonomy Data · object

Response

Successful Response

taxonomy_name

string

required

Suggest Patterns List

⌘I

Data Connectors

Tags

Taxonomies

Metadata

Task Tracking

Data Slices

Destinations

Upsert

Request Body

Response

Example

Body

Response