Create Classifier

import { ExtendClient, ExtendEnvironment } from "extend-ai";
async function main() {
    const client = new ExtendClient({
        environment: ExtendEnvironment.Production,
        token: "YOUR_TOKEN_HERE",
    });
    await client.classifiers.create({
        name: "Document Classifier",
        config: {
            classifications: [
                {
                    id: "invoice",
                    type: "invoice",
                    description: "An invoice or bill for goods or services",
                },
                {
                    id: "receipt",
                    type: "receipt",
                    description: "A receipt confirming payment",
                },
                {
                    id: "other",
                    type: "other",
                    description: "Any other document type",
                },
            ],
        },
    });
}
main();

{
  "object": "classifier",
  "id": "cl_Xj8mK2pL9nR4vT7qY5wZ",
  "name": "Document Type Classifier",
  "createdAt": "2024-03-21T16:45:00Z",
  "updatedAt": "2024-03-21T16:45:00Z",
  "draftVersion": {
    "object": "classifier_version",
    "id": "clv_xK9mLPqRtN3vS8wF5hB2cQ",
    "description": "Added new document types for Q4 processing",
    "version": "draft",
    "config": {
      "classifications": [
        {
          "id": "my_unique_id",
          "type": "invoice",
          "description": "An invoice is a document that lists the items purchased and the total amount due."
        }
      ],
      "baseProcessor": "classification_performance",
      "baseVersion": "3.2.0",
      "classificationRules": "Remember, when it comes to differentiating between invoices and purchase orders, the most important thing to look for is the date of the document.",
      "advancedOptions": {
        "context": "default",
        "advancedMultimodalEnabled": true,
        "pageRanges": [
          {
            "start": 1,
            "end": 10
          },
          {
            "start": 20,
            "end": 30
          }
        ]
      },
      "parseConfig": {
        "target": "markdown",
        "chunkingStrategy": {
          "type": "page",
          "options": {
            "minCharacters": 500,
            "maxCharacters": 10000
          }
        },
        "engine": "parse_performance",
        "engineVersion": "latest",
        "blockOptions": {
          "figures": {
            "enabled": true,
            "figureImageClippingEnabled": true
          },
          "tables": {
            "targetFormat": "html",
            "tableHeaderContinuationEnabled": false,
            "cellBlocksEnabled": false,
            "agentic": {
              "enabled": false,
              "customInstructions": "string"
            },
            "enabled": true
          },
          "text": {
            "signatureDetectionEnabled": false,
            "agentic": {
              "enabled": false,
              "customInstructions": "string"
            }
          }
        },
        "advancedOptions": {
          "pageRotationEnabled": true,
          "pageRanges": [
            {
              "start": 1,
              "end": 10
            },
            {
              "start": 20,
              "end": 30
            }
          ],
          "excelParsingMode": "basic",
          "excelSkipHiddenContent": false,
          "verticalGroupingThreshold": 1,
          "returnOcr": {
            "words": false
          }
        }
      }
    },
    "classifierId": "cl_Xj8mK2pL9nR4vT7qY5wZ",
    "createdAt": "2024-03-21T16:45:00Z"
  }
}

Create a new classifier.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.

namestringRequired

The name of the classifier.

cloneClassifierIdstringOptional

The ID of an existing classifier to clone. If provided, the new classifier will be created with the same config as the classifier with this ID. Cannot be provided together with config.

Example: "cl_BMdfq_yWM3sT-ZzvCnA3f"

configobjectOptional

The configuration for the classifier. Cannot be provided together with cloneClassifierId.

Response

Classifier created successfully

objectenum

The type of object. Will always be "classifier".

Allowed values:

idstring

The ID of the classifier.

Example: "cl_Xj8mK2pL9nR4vT7qY5wZ"

namestring

The name of the classifier.

Example: "Document Type Classifier"

createdAtstringformat: "date-time"

The time (in UTC) at which the object was created. Will follow the RFC 3339 format.

Example: "2024-03-21T16:45:00Z"

updatedAtstringformat: "date-time"

The time (in UTC) at which the object was last updated. Will follow the RFC 3339 format.

Example: "2024-03-21T16:45:00Z"

draftVersionobject

The draft version of the classifier. This is the editable version in the Extend dashboard.

Create Classifier

Authentication

Headers

Request

Response

Errors