Update document filter extractor (auto-creates new version)

import requests

url = "https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/document-filter-extractors/{extractor_id}/"

payload = { "name": "Legal docs filter (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": "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."
}

{
  "error": "Not found."
}

PATCH

projects

{project_id}

document-filter-extractors

{extractor_id}

import requests

url = "https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/document-filter-extractors/{extractor_id}/"

payload = { "name": "Legal docs filter (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": "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."
}

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

Restricts a downstream pipeline branch to a subset of documents matching a filter.

name

string

Example:

"Legal docs only"

brief

string

Example:

"Filter to documents tagged as legal department."

filter

object

Example:

{
  "tag_key": "department",
  "values": ["legal"]
}

import_mode

boolean

default:false

write-only

set_latest_as_default

boolean

write-only

Response

Updated

Restricts a downstream pipeline branch to a subset of documents matching a filter.

string<uuid>

read-only

name

string

Example:

"Legal docs only"

brief

string

Example:

"Filter to documents tagged as legal department."

filter

object

Example:

{
  "tag_key": "department",
  "values": ["legal"]
}

created_at

string<date-time>

read-only

updated_at

string<date-time>

read-only

versions

object[]

read-only

Show child attributes

default_version

object | null

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

Show child attributes

latest_version

object | null

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

Show child attributes

Concepts

Endpoints

Update document filter extractor (auto-creates new version)

Authorizations

Path Parameters

Body

Response