Create tag alerts extractor
import requests
url = "https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/tag-alerts-extractors/"
payload = {
"name": "Tag conflict alerts",
"brief": "Flag tag/department conflicts.",
"instructions": "Flag any chunk where the assigned tag conflicts with the document's department tag.",
"llm_model": "gpt-4o",
"document_ids": []
}
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: 'Tag conflict alerts',
brief: 'Flag tag/department conflicts.',
instructions: 'Flag any chunk where the assigned tag conflicts with the document\'s department tag.',
llm_model: 'gpt-4o',
document_ids: []
})
};
fetch('https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/tag-alerts-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}/tag-alerts-extractors/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data @- <<EOF
{
"name": "Tag conflict alerts",
"brief": "Flag tag/department conflicts.",
"instructions": "Flag any chunk where the assigned tag conflicts with the document's department tag.",
"llm_model": "gpt-4o",
"document_ids": []
}
EOF{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "Tag conflict alerts",
"brief": "Flag tag/department conflicts.",
"instructions": "Flag any chunk where the assigned tag conflicts with the document's department tag.",
"llm_model": "gpt-4o",
"document_ids": [],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"alerts_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,
"instructions": "Flag any chunk where the assigned tag conflicts with the document's department tag.",
"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,
"instructions": "Flag any chunk where the assigned tag conflicts with the document's department tag.",
"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,
"instructions": "Flag any chunk where the assigned tag conflicts with the document's department tag.",
"llm_model": "gpt-4o"
}
}{
"error": "User not found"
}{
"error": "Authentication credentials were not provided."
}{
"error": "You do not have permission to perform this action."
}Tag Alerts Extractors
Create tag alerts extractor
Create a TagAlertsExtractor — runs LLM-based alerts over already-extracted tag rows.
POST
/
projects
/
{project_id}
/
tag-alerts-extractors
/
Create tag alerts extractor
import requests
url = "https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/tag-alerts-extractors/"
payload = {
"name": "Tag conflict alerts",
"brief": "Flag tag/department conflicts.",
"instructions": "Flag any chunk where the assigned tag conflicts with the document's department tag.",
"llm_model": "gpt-4o",
"document_ids": []
}
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: 'Tag conflict alerts',
brief: 'Flag tag/department conflicts.',
instructions: 'Flag any chunk where the assigned tag conflicts with the document\'s department tag.',
llm_model: 'gpt-4o',
document_ids: []
})
};
fetch('https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/tag-alerts-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}/tag-alerts-extractors/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data @- <<EOF
{
"name": "Tag conflict alerts",
"brief": "Flag tag/department conflicts.",
"instructions": "Flag any chunk where the assigned tag conflicts with the document's department tag.",
"llm_model": "gpt-4o",
"document_ids": []
}
EOF{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "Tag conflict alerts",
"brief": "Flag tag/department conflicts.",
"instructions": "Flag any chunk where the assigned tag conflicts with the document's department tag.",
"llm_model": "gpt-4o",
"document_ids": [],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"alerts_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,
"instructions": "Flag any chunk where the assigned tag conflicts with the document's department tag.",
"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,
"instructions": "Flag any chunk where the assigned tag conflicts with the document's department tag.",
"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,
"instructions": "Flag any chunk where the assigned tag conflicts with the document's department tag.",
"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
BearerAuthTokenAuth
Use Authorization: Bearer
Path Parameters
UUID of the project
Body
application/json
Runs LLM-based alerts over already-extracted tag rows.
Example:
"Tag conflict alerts"
Example:
"Flag tag/department conflicts."
Example:
"Flag any chunk where the assigned tag conflicts with the document's department tag."
Example:
"gpt-4o"
Example:
[]
Response
Created
Runs LLM-based alerts over already-extracted tag rows.
Example:
"Tag conflict alerts"
Example:
"Flag tag/department conflicts."
Example:
"Flag any chunk where the assigned tag conflicts with the document's department tag."
Example:
"gpt-4o"
Example:
[]
Show child attributes
Show child attributes
Immutable snapshot of a TagAlertsExtractor's version-bearing configuration.
Show child attributes
Show child attributes
Immutable snapshot of a TagAlertsExtractor's version-bearing configuration.
Show child attributes
Show child attributes