Create Splitter Version

import { ExtendClient, ExtendEnvironment } from "extend-ai";
async function main() {
    const client = new ExtendClient({
        environment: ExtendEnvironment.Production,
        token: "YOUR_TOKEN_HERE",
    });
    await client.splitterVersions.create("splitter_id_here", {
        releaseType: "minor",
        description: "Improved split boundary detection",
    });
}
main();

{
  "object": "splitter_version",
  "id": "splv_xK9mLPqRtN3vS8wF5hB2cQ",
  "description": "Updated split rules for multi-invoice packets",
  "version": "draft",
  "config": {
    "splitClassifications": [
      {
        "id": "my_unique_id",
        "type": "invoice",
        "description": "An invoice is a document that lists the items purchased and the total amount due."
      }
    ],
    "baseProcessor": "splitting_performance",
    "baseVersion": "string",
    "splitRules": "string",
    "advancedOptions": {
      "splitIdentifierRules": "string",
      "splitMethod": "high_precision",
      "splitExcelDocumentsBySheetEnabled": false,
      "pageRanges": [
        {
          "start": 1,
          "end": 10
        },
        {
          "start": 20,
          "end": 30
        }
      ],
      "pageOverlapEnabled": false
    },
    "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
        }
      }
    }
  },
  "splitterId": "spl_Xj8mK2pL9nR4vT7qY5wZ",
  "createdAt": "2024-03-21T16:45:00Z"
}

This endpoint allows you to publish a new version of an existing splitter. Publishing a new version creates a snapshot of the splitter's current configuration and makes it available for use in workflows. Publishing a new version does not automatically update existing workflows using this splitter. You may need to manually update workflows to use the new version if desired.

Authentication

AuthorizationBearer

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

Path parameters

splitterIdstringRequired

The ID of the splitter.

Example: "spl_Xj8mK2pL9nR4vT7qY5wZ"

Request

This endpoint expects an object.

releaseTypeenumRequired

The type of release for this version. The two options are "major" and "minor", which will increment the version number accordingly.

Allowed values:

descriptionstringOptional

A description of the changes in this version. This helps track the evolution of the processor over time.

configobjectOptional

The configuration for this version of the splitter.

Response

Successfully published splitter version

objectenum

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

Allowed values:

idstring

The unique identifier for this version of the splitter.

Example: "splv_xK9mLPqRtN3vS8wF5hB2cQ"

descriptionstring or null

A description of this version of the splitter.

Example: "Updated split rules for multi-invoice packets"

versionstring

The version number or identifier for this specific version of the splitter. The draft version will have version=“draft”.

Examples: "1.0", "2.1", "draft"

configobject

The configuration settings for this version of the splitter.

splitterIdstring

The ID of the splitter that this version belongs to.

Example: "spl_Xj8mK2pL9nR4vT7qY5wZ"

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"

Create Splitter Version

Authentication

Path parameters

Headers

Request

Response

Errors