Get 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.retrieve("splitter_id_here", "splitter_version_id_here");
}
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"
}

Retrieve a specific version of a splitter in Extend

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"

versionIdstringRequired

The ID of the specific splitter version.

Example: "splv_QYk6jgHA_8CsO8rVWhyNC"

Response

Successfully retrieved 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"

Get Splitter Version

Authentication

Path parameters

Headers

Response

Errors