Create document filter extractor
import requests
url = "https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/document-filter-extractors/"
payload = {
"name": "Legal docs only",
"brief": "Filter to documents tagged as legal department.",
"filter": {
"tag_key": "department",
"values": ["legal"]
}
}
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: 'Legal docs only',
brief: 'Filter to documents tagged as legal department.',
filter: {tag_key: 'department', values: ['legal']}
})
};
fetch('https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/document-filter-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-filter-extractors/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Legal docs only",
"brief": "Filter to documents tagged as legal department.",
"filter": {
"tag_key": "department",
"values": [
"legal"
]
}
}
'{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "Legal docs only",
"brief": "Filter to documents tagged as legal department.",
"filter": {
"tag_key": "department",
"values": [
"legal"
]
},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"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,
"filter": {
"tag_key": "department",
"values": [
"legal"
]
}
}
],
"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,
"filter": {
"tag_key": "department",
"values": [
"legal"
]
}
},
"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,
"filter": {
"tag_key": "department",
"values": [
"legal"
]
}
}
}{
"error": "User not found"
}{
"error": "Authentication credentials were not provided."
}{
"error": "You do not have permission to perform this action."
}Document Filter Extractors
Create document filter extractor
Create a DocumentFilterExtractor — restricts a downstream pipeline
branch to documents matching the configured filter.
POST
/
projects
/
{project_id}
/
document-filter-extractors
/
Create document filter extractor
import requests
url = "https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/document-filter-extractors/"
payload = {
"name": "Legal docs only",
"brief": "Filter to documents tagged as legal department.",
"filter": {
"tag_key": "department",
"values": ["legal"]
}
}
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: 'Legal docs only',
brief: 'Filter to documents tagged as legal department.',
filter: {tag_key: 'department', values: ['legal']}
})
};
fetch('https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/document-filter-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-filter-extractors/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Legal docs only",
"brief": "Filter to documents tagged as legal department.",
"filter": {
"tag_key": "department",
"values": [
"legal"
]
}
}
'{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "Legal docs only",
"brief": "Filter to documents tagged as legal department.",
"filter": {
"tag_key": "department",
"values": [
"legal"
]
},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"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,
"filter": {
"tag_key": "department",
"values": [
"legal"
]
}
}
],
"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,
"filter": {
"tag_key": "department",
"values": [
"legal"
]
}
},
"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,
"filter": {
"tag_key": "department",
"values": [
"legal"
]
}
}
}{
"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
Response
Created
Restricts a downstream pipeline branch to a subset of documents matching a filter.
Example:
"Legal docs only"
Example:
"Filter to documents tagged as legal department."
Example:
{
"tag_key": "department",
"values": ["legal"]
}
Show child attributes
Show child attributes
Immutable snapshot of a DocumentFilterExtractor's version-bearing configuration.
Show child attributes
Show child attributes
Immutable snapshot of a DocumentFilterExtractor's version-bearing configuration.
Show child attributes
Show child attributes