Retrieve tag extractor
import requests
url = "https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/tag-extractors/{extractor_id}/"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/tag-extractors/{extractor_id}/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));curl --request GET \
--url https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/tag-extractors/{extractor_id}/ \
--header 'Authorization: Bearer <token>'{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "Department classifier",
"brief": "Classify each chunk into a department.",
"llm_model": "gpt-4o",
"tagging_tree": {
"id": "department",
"label": "Department",
"children": [
{
"id": "legal",
"label": "Legal",
"children": []
},
{
"id": "finance",
"label": "Finance",
"children": []
}
]
},
"extraction_prompt": "Choose the department this chunk most likely belongs to.",
"tag_level": "chunk",
"document_ids": [],
"compute_alerts": false,
"enforce_single_tag": false,
"pre_execution_filter": {},
"alerts_additional_instructions": "<string>",
"alerts_llm_model": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"prompt_generation_status": "<string>",
"deployed_tagging_tree": {},
"deployed_extraction_prompt": "<string>",
"deployed_llm_model": "<string>",
"extracted_tags_table": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"alerts_tags_table": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"chunks_table_version_info": {},
"filtering_options": [
{}
],
"table_version_updates": {},
"versions": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"is_default": true,
"tagging_tree": {
"id": "department",
"label": "Department",
"children": [
{
"id": "legal",
"label": "Legal",
"children": []
},
{
"id": "finance",
"label": "Finance",
"children": []
}
]
},
"extraction_prompt": "Choose the department this chunk most likely belongs to.",
"llm_model": "gpt-4o",
"enforce_single_tag": false,
"alerts_additional_instructions": "<string>"
}
],
"default_version": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"is_default": true,
"tagging_tree": {
"id": "department",
"label": "Department",
"children": [
{
"id": "legal",
"label": "Legal",
"children": []
},
{
"id": "finance",
"label": "Finance",
"children": []
}
]
},
"extraction_prompt": "Choose the department this chunk most likely belongs to.",
"llm_model": "gpt-4o",
"enforce_single_tag": false,
"alerts_additional_instructions": "<string>"
},
"latest_version": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"is_default": true,
"tagging_tree": {
"id": "department",
"label": "Department",
"children": [
{
"id": "legal",
"label": "Legal",
"children": []
},
{
"id": "finance",
"label": "Finance",
"children": []
}
]
},
"extraction_prompt": "Choose the department this chunk most likely belongs to.",
"llm_model": "gpt-4o",
"enforce_single_tag": false,
"alerts_additional_instructions": "<string>"
}
}{
"error": "Authentication credentials were not provided."
}{
"error": "You do not have permission to perform this action."
}{
"error": "Not found."
}Tag Extractors
Retrieve tag extractor
GET
/
projects
/
{project_id}
/
tag-extractors
/
{extractor_id}
/
Retrieve tag extractor
import requests
url = "https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/tag-extractors/{extractor_id}/"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/tag-extractors/{extractor_id}/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));curl --request GET \
--url https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/tag-extractors/{extractor_id}/ \
--header 'Authorization: Bearer <token>'{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "Department classifier",
"brief": "Classify each chunk into a department.",
"llm_model": "gpt-4o",
"tagging_tree": {
"id": "department",
"label": "Department",
"children": [
{
"id": "legal",
"label": "Legal",
"children": []
},
{
"id": "finance",
"label": "Finance",
"children": []
}
]
},
"extraction_prompt": "Choose the department this chunk most likely belongs to.",
"tag_level": "chunk",
"document_ids": [],
"compute_alerts": false,
"enforce_single_tag": false,
"pre_execution_filter": {},
"alerts_additional_instructions": "<string>",
"alerts_llm_model": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"prompt_generation_status": "<string>",
"deployed_tagging_tree": {},
"deployed_extraction_prompt": "<string>",
"deployed_llm_model": "<string>",
"extracted_tags_table": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"alerts_tags_table": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"chunks_table_version_info": {},
"filtering_options": [
{}
],
"table_version_updates": {},
"versions": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"is_default": true,
"tagging_tree": {
"id": "department",
"label": "Department",
"children": [
{
"id": "legal",
"label": "Legal",
"children": []
},
{
"id": "finance",
"label": "Finance",
"children": []
}
]
},
"extraction_prompt": "Choose the department this chunk most likely belongs to.",
"llm_model": "gpt-4o",
"enforce_single_tag": false,
"alerts_additional_instructions": "<string>"
}
],
"default_version": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"is_default": true,
"tagging_tree": {
"id": "department",
"label": "Department",
"children": [
{
"id": "legal",
"label": "Legal",
"children": []
},
{
"id": "finance",
"label": "Finance",
"children": []
}
]
},
"extraction_prompt": "Choose the department this chunk most likely belongs to.",
"llm_model": "gpt-4o",
"enforce_single_tag": false,
"alerts_additional_instructions": "<string>"
},
"latest_version": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"is_default": true,
"tagging_tree": {
"id": "department",
"label": "Department",
"children": [
{
"id": "legal",
"label": "Legal",
"children": []
},
{
"id": "finance",
"label": "Finance",
"children": []
}
]
},
"extraction_prompt": "Choose the department this chunk most likely belongs to.",
"llm_model": "gpt-4o",
"enforce_single_tag": false,
"alerts_additional_instructions": "<string>"
}
}{
"error": "Authentication credentials were not provided."
}{
"error": "You do not have permission to perform this action."
}{
"error": "Not found."
}Authorizations
BearerAuthTokenAuth
Use Authorization: Bearer
Path Parameters
UUID of the project
UUID of the extractor
Response
Successful response
Applies hierarchical metadata tags to chunks (or documents) using an LLM.
Example:
"Department classifier"
Example:
"Classify each chunk into a department."
Example:
"gpt-4o"
Nested tree describing the tag taxonomy. Each node has shape
{id: string, label: string, children: [...]}.
Example:
{
"id": "department",
"label": "Department",
"children": [
{
"id": "legal",
"label": "Legal",
"children": []
},
{
"id": "finance",
"label": "Finance",
"children": []
}
]
}
Example:
"Choose the department this chunk most likely belongs to."
Granularity at which tags are applied.
Available options:
chunk, document Example:
"chunk"
Example:
[]
When true, only one leaf tag per chunk is allowed.
Example:
false
Show child attributes
Show child attributes
Immutable snapshot of a TagExtractor's version-bearing configuration.
Show child attributes
Show child attributes
Immutable snapshot of a TagExtractor's version-bearing configuration.
Show child attributes
Show child attributes