Update object alerts extractor (auto-creates new version)

import requests

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

payload = { "name": "Missing effective dates (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": "Missing effective dates",
  "brief": "Alert when an obligation lacks an effective date.",
  "instructions": "Flag any ContractClause missing an effective_date when clause_type is 'obligation'.",
  "llm_model": "gpt-4o",
  "document_ids": [],
  "document_ranges": {},
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "alerts_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 ContractClause missing an effective_date when clause_type is 'obligation'.",
      "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 ContractClause missing an effective_date when clause_type is 'obligation'.",
    "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 ContractClause missing an effective_date when clause_type is 'obligation'.",
    "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}

object-alerts-extractors

{extractor_id}

import requests

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

payload = { "name": "Missing effective dates (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": "Missing effective dates",
  "brief": "Alert when an obligation lacks an effective date.",
  "instructions": "Flag any ContractClause missing an effective_date when clause_type is 'obligation'.",
  "llm_model": "gpt-4o",
  "document_ids": [],
  "document_ranges": {},
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "alerts_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 ContractClause missing an effective_date when clause_type is 'obligation'.",
      "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 ContractClause missing an effective_date when clause_type is 'obligation'.",
    "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 ContractClause missing an effective_date when clause_type is 'obligation'.",
    "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 <token>. The token is either a user token / OAuth access token, or a service-account API key (cfk_...). A key is valid on every endpoint and acts as its service account, an organization member with per-store permissions. Refused keys answer 403 with Invalid API key., API key revoked., API key expired. or API key disabled..

Path Parameters

project_id

string<uuid>

required

UUID of the project

extractor_id

string<uuid>

required

UUID of the extractor

Body

application/json

Runs LLM-based alerts over already-extracted object rows.

name

string

Example:

"Missing effective dates"

brief

string

Example:

"Alert when an obligation lacks an effective date."

instructions

string

Example:

"Flag any ContractClause missing an effective_date when clause_type is 'obligation'."

llm_model

string

Example:

"gpt-4o"

document_ids

string<uuid>[]

Example:

[]

document_ranges

object | null

import_mode

boolean

default:false

write-only

set_latest_as_default

boolean

write-only

Response

Updated

Runs LLM-based alerts over already-extracted object rows.

string<uuid>

read-only

name

string

Example:

"Missing effective dates"

brief

string

Example:

"Alert when an obligation lacks an effective date."

instructions

string

Example:

"Flag any ContractClause missing an effective_date when clause_type is 'obligation'."

llm_model

string

Example:

"gpt-4o"

document_ids

string<uuid>[]

Example:

[]

document_ranges

object | null

created_at

string<date-time>

read-only

updated_at

string<date-time>

read-only

alerts_table

string<uuid> | null

read-only

versions

object[]

read-only

Show child attributes

default_version

object | null

Immutable snapshot of an ObjectAlertsExtractor's version-bearing configuration.

Show child attributes

latest_version

object | null

Immutable snapshot of an ObjectAlertsExtractor's version-bearing configuration.

Show child attributes

Concepts

Endpoints

Update object alerts extractor (auto-creates new version)

Authorizations

Path Parameters

Body

Response