import requests
url = "https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/document-tag-extractors/{extractor_id}/"
payload = { "name": "Confidentiality classifier (renamed)" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text){
"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."
}{
"error": "Not found."
}Update document tag extractor (auto-creates new version)
Partial update. Version-bearing fields: tags, llm_model.
Pass set_latest_as_default: true to promote the new version.
import requests
url = "https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/document-tag-extractors/{extractor_id}/"
payload = { "name": "Confidentiality classifier (renamed)" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text){
"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."
}{
"error": "Not found."
}Authorizations
Use Authorization: Bearer <token>. The token is either a user token / OAuth access
token, or a service-account API key (cfk_...). A key is valid on every endpoint and
acts as its service account, an organization member with per-store permissions.
Refused keys answer 403 with Invalid API key., API key revoked.,
API key expired. or API key disabled..
Path Parameters
UUID of the project
UUID of the extractor
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
Updated
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