Core Document ProcessingSplitting

Processor output types

Splitter outputs follow a standardized format that you’ll encounter when working with evaluation sets, webhooks, and API responses.

Splitter Output Type

Type Definition

type SplitterOutput = {
  splits: Split[];
};
type Split = {
  classificationId: string; // The id of the classification type (set in the processor config)
  type: string; // The type of the split document (set in the processor config), corresponds to the classificationId.
  startPage: number; // The start page of the split document
  endPage: number; // The end page of the split document
  // Fields included in outputs, but not required for creating an evaluation set item
  identifier?: string; // Identifier for the split document (e.g. invoice number)
  observation?: string; // Explanation of the results
};

Example

{
  "splits": [
    {
      "classificationId": "invoice",
      "type": "invoice",
      "startPage": 1,
      "endPage": 3
    },
    {
      "classificationId": "other",
      "type": "other",
      "startPage": 4,
      "endPage": 5
    }
  ]
}