Skip to main content
POST
/
tags
/
upsert
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.tags.upsert(
    tag_data={
        "name": "name"
    },
)
print(response.available_values_added)
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.tags.upsert({ tag_data: { name: 'name' } });

console.log(response.available_values_added);
A valid request URL is required to generate request examples
A valid request URL is required to generate request examples
A valid request URL is required to generate request examples
A valid request URL is required to generate request examples
A 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": [],
    "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>"
    }
  },
  "available_values_added": [
    "<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
tag_data
Tag · object
required

Response

Successful Response

tag_name
string
required
tag
Tag · object
required
available_values_added
string[]
required