Create object alerts extractor

import requests

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

payload = {
    "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": []
}
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: '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: []
  })
};

fetch('https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/object-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}/object-alerts-extractors/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data @- <<EOF
{
  "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": []
}
EOF

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

POST

projects

{project_id}

object-alerts-extractors

Create object alerts extractor

import requests

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

payload = {
    "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": []
}
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: '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: []
  })
};

fetch('https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/object-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}/object-alerts-extractors/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data @- <<EOF
{
  "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": []
}
EOF

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

Authorizations

Authorization

string

header

required

Use Authorization: Bearer

Path Parameters

project_id

string<uuid>

required

UUID of the project

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

Response

Created

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

Create object alerts extractor

Authorizations

Path Parameters

Body

Response