Manage Tags
List
List all tags for the authenticated user.
Response
- 200: Tags retrieved successfully
- Returns:
{ "tags": List[Tag] }
- Returns:
- 500: Internal Server Error
Example Response
{
"tags": [
{
"name": "category",
"description": "Document category",
"type": "select",
"available_values": ["invoice", "receipt"]
},
{
"name": "date",
"description": "Document date",
"type": "date"
}
]
}
GET
/
tags
/
list
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
)
tags = client.tags.list()
print(tags.tags)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 tags = await client.tags.list();
console.log(tags.tags);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 examples{
"tags": [
{
"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>"
}
}
]
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}⌘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
)
tags = client.tags.list()
print(tags.tags)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 tags = await client.tags.list();
console.log(tags.tags);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 examples{
"tags": [
{
"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>"
}
}
]
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}{
"detail": "<string>"
}