import requests
url = "https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/document-tag-extractors/"
payload = {
"name": "Confidentiality classifier",
"brief": "Tag each document with its confidentiality level.",
"tags": ["confidential", "internal", "public"],
"llm_model": "gpt-4o",
"document_ids": [],
"should_push_to_graph": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Confidentiality classifier',
brief: 'Tag each document with its confidentiality level.',
tags: ['confidential', 'internal', 'public'],
llm_model: 'gpt-4o',
document_ids: [],
should_push_to_graph: true
})
};
fetch('https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/document-tag-extractors/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));curl --request POST \
--url https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/document-tag-extractors/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Confidentiality classifier",
"brief": "Tag each document with its confidentiality level.",
"tags": [
"confidential",
"internal",
"public"
],
"llm_model": "gpt-4o",
"document_ids": [],
"should_push_to_graph": true
}
'{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "Confidentiality classifier",
"brief": "Tag each document with its confidentiality level.",
"tags": [
"confidential",
"public",
"internal"
],
"llm_model": "gpt-4o",
"document_ids": [],
"should_push_to_graph": true,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"extracted_document_tags_table": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"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,
"tags": [
"confidential",
"public",
"internal"
],
"llm_model": "gpt-4o"
}
],
"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,
"tags": [
"confidential",
"public",
"internal"
],
"llm_model": "gpt-4o"
},
"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,
"tags": [
"confidential",
"public",
"internal"
],
"llm_model": "gpt-4o"
}
}{
"error": "User not found"
}{
"error": "Authentication credentials were not provided."
}{
"error": "You do not have permission to perform this action."
}Create document tag extractor
Create a DocumentTagExtractor — applies a flat set of metadata tags
to each document.
import requests
url = "https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/document-tag-extractors/"
payload = {
"name": "Confidentiality classifier",
"brief": "Tag each document with its confidentiality level.",
"tags": ["confidential", "internal", "public"],
"llm_model": "gpt-4o",
"document_ids": [],
"should_push_to_graph": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Confidentiality classifier',
brief: 'Tag each document with its confidentiality level.',
tags: ['confidential', 'internal', 'public'],
llm_model: 'gpt-4o',
document_ids: [],
should_push_to_graph: true
})
};
fetch('https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/document-tag-extractors/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));curl --request POST \
--url https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/document-tag-extractors/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Confidentiality classifier",
"brief": "Tag each document with its confidentiality level.",
"tags": [
"confidential",
"internal",
"public"
],
"llm_model": "gpt-4o",
"document_ids": [],
"should_push_to_graph": true
}
'{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "Confidentiality classifier",
"brief": "Tag each document with its confidentiality level.",
"tags": [
"confidential",
"public",
"internal"
],
"llm_model": "gpt-4o",
"document_ids": [],
"should_push_to_graph": true,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"extracted_document_tags_table": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"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,
"tags": [
"confidential",
"public",
"internal"
],
"llm_model": "gpt-4o"
}
],
"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,
"tags": [
"confidential",
"public",
"internal"
],
"llm_model": "gpt-4o"
},
"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,
"tags": [
"confidential",
"public",
"internal"
],
"llm_model": "gpt-4o"
}
}{
"error": "User not found"
}{
"error": "Authentication credentials were not provided."
}{
"error": "You do not have permission to perform this action."
}Authorizations
Use Authorization: Bearer
Path Parameters
UUID of the project
Body
Applies a flat set of metadata tags to each document.
"Confidentiality classifier"
"Tag each document with its confidentiality level."
["confidential", "public", "internal"]
"gpt-4o"
[]
Whether extracted tags are pushed to the project's knowledge graph.
true
Response
Created
Applies a flat set of metadata tags to each document.
"Confidentiality classifier"
"Tag each document with its confidentiality level."
["confidential", "public", "internal"]
"gpt-4o"
[]
Whether extracted tags are pushed to the project's knowledge graph.
true
Show child attributes
Show child attributes
Immutable snapshot of a DocumentTagExtractor's version-bearing configuration.
Show child attributes
Show child attributes
Immutable snapshot of a DocumentTagExtractor's version-bearing configuration.
Show child attributes
Show child attributes