Manage Tags
Upsert
Insert or update a tag definition.
Request Body
| Field | Type | Description |
|---|---|---|
tag_data | Tag | Tag data structure containing tag definition. |
Response
- 200: Tag upserted successfully
- Returns:
{ "tag_name": str, "tag": Tag, "available_values_added": List[str] }
- Returns:
- 400: Bad Request (e.g., invalid tag data)
- 500: Internal Server Error
Example
{
"tag_data": {
"name": "category",
"description": "Document category classification",
"type": "select",
"available_values": ["invoice", "receipt", "contract"]
}
}
POST
/
tags
/
upsert
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"],
auth_method="basic",
)
response = client.tags.upsert(
tag_data={
"name": "example_name",
},
)
print(response.tag_name)A valid request URL is required to generate request examplesA valid request URL is required to generate request examplesA valid request URL is required to generate request examplesA valid request URL is required to generate request examplesA valid request URL is required to generate request examplesA valid request URL is required to generate request examples{
"tag_name": "<string>",
"tag": {
"name": "<string>",
"tag_id": "<string>",
"username": "<string>",
"description": "",
"output_type": "string",
"available_values": [],
"examples": [],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"tuned": 0,
"maxValues": 123,
"neg_examples": [],
"retry_feedback": {},
"date_format": "<string>",
"strategy": "LLM",
"scope": "ALL_PAGES",
"truncated_available_values": false,
"enhance_file_metadata": true,
"regex": "<string>",
"patterns": [],
"visual_rules": [],
"run_dependent_tags": false,
"group": "<string>",
"min_confidence": 123,
"collibra_asset_id": "<string>",
"collibra_domain_id": "<string>",
"source_asset_type": "<string>",
"governance_metadata": {
"record_code": "<string>",
"retention_period": "<string>",
"retention_trigger": "<string>",
"disposition": "<string>",
"ingestion_id": "<string>"
},
"origin": "manual",
"curation_state": "<string>",
"is_owner": true,
"owner_name": "<string>",
"permissions": {
"can_register": false,
"can_edit": false,
"can_delete": false,
"locked_by": "<string>"
},
"avg_confidence": 123,
"usage": {
"files_with_tag": 0
},
"usage_stats_as_of": "2023-11-07T05:31:56Z",
"examples_count": 123
},
"available_values_added": [
"<string>"
]
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}{
"detail": "<string>"
}{
"detail": "<string>"
}Authorizations
BasicAuthBearerAuth & UserIdAuth
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Body
application/json
Show child attributes
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"],
auth_method="basic",
)
response = client.tags.upsert(
tag_data={
"name": "example_name",
},
)
print(response.tag_name)A valid request URL is required to generate request examplesA valid request URL is required to generate request examplesA valid request URL is required to generate request examplesA valid request URL is required to generate request examplesA valid request URL is required to generate request examplesA valid request URL is required to generate request examples{
"tag_name": "<string>",
"tag": {
"name": "<string>",
"tag_id": "<string>",
"username": "<string>",
"description": "",
"output_type": "string",
"available_values": [],
"examples": [],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"tuned": 0,
"maxValues": 123,
"neg_examples": [],
"retry_feedback": {},
"date_format": "<string>",
"strategy": "LLM",
"scope": "ALL_PAGES",
"truncated_available_values": false,
"enhance_file_metadata": true,
"regex": "<string>",
"patterns": [],
"visual_rules": [],
"run_dependent_tags": false,
"group": "<string>",
"min_confidence": 123,
"collibra_asset_id": "<string>",
"collibra_domain_id": "<string>",
"source_asset_type": "<string>",
"governance_metadata": {
"record_code": "<string>",
"retention_period": "<string>",
"retention_trigger": "<string>",
"disposition": "<string>",
"ingestion_id": "<string>"
},
"origin": "manual",
"curation_state": "<string>",
"is_owner": true,
"owner_name": "<string>",
"permissions": {
"can_register": false,
"can_edit": false,
"can_delete": false,
"locked_by": "<string>"
},
"avg_confidence": 123,
"usage": {
"files_with_tag": 0
},
"usage_stats_as_of": "2023-11-07T05:31:56Z",
"examples_count": 123
},
"available_values_added": [
"<string>"
]
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}{
"detail": "<string>"
}{
"detail": "<string>"
}