For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Book a demoLog in
GuidesAPI ReferenceChangelogModel Versioning
GuidesAPI ReferenceChangelogModel Versioning
    • Getting Started
        • Configuring a Splitter
        • Output Type
LogoLogo
Book a demoLog in
On this page
  • Splitter Processor Configuration
  • Example API Usecases
  • Webhooks
  • Configurable Fields
  • Splitter Configuration Example
Core Document ProcessingSplitting

Configuring a Splitter

Was this page helpful?
Previous

Processor output types

Next
Built with

Splitter Processor Configuration

“Splitters” break down multi-page documents into separate, organized sections. These can be configured via either the UI or the API.

Example API Usecases

  • Create a splitter with a given config - Set up a new splitter processor with your configuration
  • Update a splitter with a given config - Modify an existing splitter’s configuration
  • Run an existing splitter with a given config - Ephemerally execute an existing splitter with a custom configuration that overrides the splitter’s existing settings

Webhooks

You can consume splitter outputs via webhooks, track updates to your splitter, and more. See Webhook Events for details.

Configurable Fields

You can view full details of the SplitterConfig in our API reference.

When working with the SplitterConfig, you can configure several key aspects, such as:

  • Prompts - Custom instructions that guide how the splitter divides documents
  • Split classifications - Define the possible sub-documents inside the document you wish to split
  • Splitter version - Specify which version of the splitter model to use
  • Advanced options - Configure split methods, page ranges, Excel sheet splitting, and other specialized settings

Splitter Configuration Example

1const splitterConfig = {
2 type: "SPLITTER",
3 splitClassifications: [
4 {
5 id: "purchase_contract",
6 type: "PURCHASE_CONTRACT",
7 description: "Purchase contract section",
8 },
9 {
10 id: "addendum",
11 type: "ADDENDUM",
12 description: "Addendum section",
13 },
14 ],
15 splitRules: "- If ...", // Optional custom rules
16 advancedOptions: {
17 splitMethod: "high_precision",
18 },
19};