Update document tag extractor (auto-creates 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."
}

PATCH

projects

{project_id}

document-tag-extractors

{extractor_id}

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

Authorization

string

header

required

Use Authorization: Bearer

Path Parameters

project_id

string<uuid>

required

UUID of the project

extractor_id

string<uuid>

required

UUID of the extractor

Body

application/json

Applies a flat set of metadata tags to each document.

name

string

Example:

"Confidentiality classifier"

brief

string

Example:

"Tag each document with its confidentiality level."

Response

Updated

Applies a flat set of metadata tags to each document.

string<uuid>

read-only

name

string

Example:

"Confidentiality classifier"

brief

string

Example:

"Tag each document with its confidentiality level."

Concepts

Endpoints

Update document tag extractor (auto-creates new version)

Authorizations

Path Parameters

Body

Response