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));

{
  "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."
}

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));

{
  "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

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

Response

Successful response

Applies hierarchical metadata tags to chunks (or documents) using an LLM.

string<uuid>

read-only

name

string

Example:

"Department classifier"

brief

string

Example:

"Classify each chunk into a department."

llm_model

string

Example:

"gpt-4o"

tagging_tree

object

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": []
    }
  ]
}

extraction_prompt

string

Example:

"Choose the department this chunk most likely belongs to."

tag_level

enum<string>

Granularity at which tags are applied.

Available options:

chunk,

document

Example:

"chunk"

document_ids

string<uuid>[]

Example:

[]

compute_alerts

boolean

default:false

enforce_single_tag

boolean

When true, only one leaf tag per chunk is allowed.

Example:

false

pre_execution_filter

object | null

alerts_additional_instructions

string | null

alerts_llm_model

string | null

created_at

string<date-time>

read-only

updated_at

string<date-time>

read-only

prompt_generation_status

string | null

read-only

deployed_tagging_tree

object | null

read-only

deployed_extraction_prompt

string | null

read-only

deployed_llm_model

string | null

read-only

extracted_tags_table

string<uuid> | null

read-only

alerts_tags_table

string<uuid> | null

read-only

chunks_table_version_info

object | null

read-only

filtering_options

object[]

read-only

table_version_updates

object | null

read-only

versions

object[]

read-only

Show child attributes

default_version

object | null

Immutable snapshot of a TagExtractor's version-bearing configuration.

Show child attributes

latest_version

object | null

Immutable snapshot of a TagExtractor's version-bearing configuration.

Show child attributes

Concepts

Endpoints

Retrieve tag extractor

Authorizations

Path Parameters

Response