@retab/node 1.0.96 → 1.0.99

package/README.md

@@ -1,86 +1,83 @@
 # Retab Node.js SDK
 
-Official Node.js SDK for the Retab API - extract structured data from documents using AI.
+Official Node.js SDK for the Retab API.
 
 ## Installation
 
-### From npm Registry
-
 ```bash
 npm install @retab/node
 ```
 
-### For Local Development
-
-To install and test the SDK locally using npm link:
+## Local Development
 
 ```bash
-# From the SDK directory
-cd open_source/sdk/clients/node
+cd open-source/sdk/clients/node
 bun install
 bun run build
-bun link
-
-# From your project directory
-bun link @retab/node
-
 bun test tests/
 ```
 
 ## Quick Start
 
 ```typescript
-import { Retab } from '@retab/node';
+import fs from "fs";
+import { Retab } from "@retab/node";
 
-// Initialize the client
 const retab = new Retab({
-  apiKey: 'your-api-key', // Or set RETAB_API_KEY environment variable
+  apiKey: "your-api-key",
 });
 
-// Extract data from a document
 const extraction = await retab.documents.extract({
-  document: 'path/to/invoice.pdf',
+  document: "path/to/invoice.pdf",
   schema: {
     json_schema: {
-      type: 'object',
+      type: "object",
       properties: {
-        invoice_number: { type: 'string' },
-        total_amount: { type: 'number' },
-        due_date: { type: 'string', format: 'date' }
-      }
-    }
-  }
+        invoice_number: { type: "string" },
+        total_amount: { type: "number" },
+        due_date: { type: "string", format: "date" },
+      },
+    },
+  },
 });
 
 console.log(extraction.extracted_data);
 
-// From file path
-const result = await retab.documents.extract({
-  document: 'path/to/document.pdf',
-  schema: mySchema
-});
-
-// From buffer
-const buffer = fs.readFileSync('document.pdf');
-const result = await retab.documents.extract({
+const buffer = fs.readFileSync("document.pdf");
+const parsed = await retab.documents.parse({
   document: buffer,
-  schema: mySchema
 });
 
-// With specific AI model
-const result = await retab.documents.extract({
-  document: 'document.pdf',
-  schema: mySchema,
-  model: 'gpt-5.4'
+console.log(parsed.pages[0]);
 ```
 
-## Key Features
+## Workflows
+
+```typescript
+import { Retab, raiseForStatus } from "@retab/node";
 
+const retab = new Retab({
+  apiKey: "your-api-key",
+});
 
+const run = await retab.workflows.runs.createAndWait({
+  workflowId: "wf_abc123",
+  documents: { "start-node-1": "invoice.pdf" },
+  onStatus: (currentRun) => console.log(currentRun.status),
+});
 
+raiseForStatus(run);
+
+const steps = await retab.workflows.runs.steps.list(run.id);
+const outputs = await retab.workflows.runs.steps.getMany(run.id, ["extract-1"]);
+
+console.log(run.final_outputs);
+console.log(steps.map((step) => `${step.node_id}: ${step.status}`));
+console.log(outputs.outputs["extract-1"]?.handle_outputs);
+```
 
 ## Support
 
 - Documentation: https://docs.retab.com
 - Issues: https://github.com/retab-inc/retab/issues
-- Discord: https://discord.gg/retab
+- Discord: https://discord.gg/retab

package/dist/api/client.d.ts

@@ -1,5 +1,4 @@
 import { AbstractClient, CompositionClient } from "../client.js";
-import APIModels from "./models/client";
 import APIDocuments from "./documents/client";
 import APISchemas from "./schemas/client";
 import APIProjects from "./projects/client";
@@ -8,16 +7,19 @@ import APIWorkflows from "./workflows/client";
 import APIEdit from "./edit/client";
 import APIFiles from "./files/client";
 import APIJobs from "./jobs/client";
+import APIEvals from "./evals/client";
+import APIModels from "./models/client";
 export default class APIV1 extends CompositionClient {
     constructor(client: AbstractClient);
     files: APIFiles;
-    models: APIModels;
     documents: APIDocuments;
     schemas: APISchemas;
     projects: APIProjects;
+    evals: APIEvals;
     extractions: APIExtractions;
     workflows: APIWorkflows;
     edit: APIEdit;
     jobs: APIJobs;
+    models: APIModels;
 }
 //# sourceMappingURL=client.d.ts.map

package/dist/api/client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../src/api/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AACjE,OAAO,SAAS,MAAM,iBAAiB,CAAC;AACxC,OAAO,YAAY,MAAM,oBAAoB,CAAC;AAC9C,OAAO,UAAU,MAAM,kBAAkB,CAAC;AAC1C,OAAO,WAAW,MAAM,mBAAmB,CAAC;AAC5C,OAAO,cAAc,MAAM,sBAAsB,CAAC;AAClD,OAAO,YAAY,MAAM,oBAAoB,CAAC;AAC9C,OAAO,OAAO,MAAM,eAAe,CAAC;AACpC,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AACtC,OAAO,OAAO,MAAM,eAAe,CAAC;AAEpC,MAAM,CAAC,OAAO,OAAO,KAAM,SAAQ,iBAAiB;gBACpC,MAAM,EAAE,cAAc;IAGlC,KAAK,WAAsB;IAC3B,MAAM,YAAuB;IAC7B,SAAS,eAA0B;IACnC,OAAO,aAAwB;IAC/B,QAAQ,cAAyB;IACjC,WAAW,iBAA4B;IACvC,SAAS,eAA0B;IACnC,IAAI,UAAqB;IACzB,IAAI,UAAqB;CAC5B"}
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../src/api/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AACjE,OAAO,YAAY,MAAM,oBAAoB,CAAC;AAC9C,OAAO,UAAU,MAAM,kBAAkB,CAAC;AAC1C,OAAO,WAAW,MAAM,mBAAmB,CAAC;AAC5C,OAAO,cAAc,MAAM,sBAAsB,CAAC;AAClD,OAAO,YAAY,MAAM,oBAAoB,CAAC;AAC9C,OAAO,OAAO,MAAM,eAAe,CAAC;AACpC,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AACtC,OAAO,OAAO,MAAM,eAAe,CAAC;AACpC,OAAO,QAAQ,MAAM,gBAAgB,CAAC;AACtC,OAAO,SAAS,MAAM,iBAAiB,CAAC;AAExC,MAAM,CAAC,OAAO,OAAO,KAAM,SAAQ,iBAAiB;gBACpC,MAAM,EAAE,cAAc;IAGlC,KAAK,WAAsB;IAC3B,SAAS,eAA0B;IACnC,OAAO,aAAwB;IAC/B,QAAQ,cAAyB;IACjC,KAAK,WAAsB;IAC3B,WAAW,iBAA4B;IACvC,SAAS,eAA0B;IACnC,IAAI,UAAqB;IACzB,IAAI,UAAqB;IACzB,MAAM,YAAuB;CAChC"}

package/dist/api/client.js

@@ -1,5 +1,4 @@
 import { CompositionClient } from "../client.js";
-import APIModels from "./models/client";
 import APIDocuments from "./documents/client";
 import APISchemas from "./schemas/client";
 import APIProjects from "./projects/client";
@@ -8,17 +7,20 @@ import APIWorkflows from "./workflows/client";
 import APIEdit from "./edit/client";
 import APIFiles from "./files/client";
 import APIJobs from "./jobs/client";
+import APIEvals from "./evals/client";
+import APIModels from "./models/client";
 export default class APIV1 extends CompositionClient {
     constructor(client) {
         super(client);
         this.files = new APIFiles(this);
-        this.models = new APIModels(this);
         this.documents = new APIDocuments(this);
         this.schemas = new APISchemas(this);
         this.projects = new APIProjects(this);
+        this.evals = new APIEvals(this);
         this.extractions = new APIExtractions(this);
         this.workflows = new APIWorkflows(this);
         this.edit = new APIEdit(this);
         this.jobs = new APIJobs(this);
+        this.models = new APIModels(this);
     }
 }

package/dist/api/documents/client.d.ts

@@ -1,13 +1,16 @@
 import { CompositionClient, RequestOptions } from "../../client.js";
-import { DocumentExtractRequest, RetabParsedChatCompletion, ParseRequest, ParseResult, DocumentCreateMessageRequest, DocumentMessage, DocumentCreateInputRequest, RetabParsedChatCompletionChunk, EditRequest, EditResponse, SplitRequest, ClassifyRequest, GenerateSplitConfigRequest } from "../../types.js";
-import type { SplitResponse, ClassifyResponse, GenerateSplitConfigResponse } from "../../generated_types.js";
+import { DocumentExtractRequest, RetabParsedChatCompletion, ParseRequest, ParseResponse, RetabParsedChatCompletionChunk, EditRequest, EditResponse, SplitRequest, ClassifyRequest, MIMEDataInput } from "../../types.js";
+import type { SplitResponse, ClassifyResponse } from "../../generated_types.js";
 export default class APIDocuments extends CompositionClient {
     constructor(client: CompositionClient);
     extract(params: DocumentExtractRequest, options?: RequestOptions): Promise<RetabParsedChatCompletion>;
+    sources(extraction_id: string, { file, file_id, fileId, }?: {
+        file?: MIMEDataInput;
+        file_id?: string;
+        fileId?: string;
+    }, options?: RequestOptions): Promise<Record<string, unknown>>;
     extract_stream(params: DocumentExtractRequest, options?: RequestOptions): Promise<AsyncGenerator<RetabParsedChatCompletionChunk>>;
-    parse(params: ParseRequest, options?: RequestOptions): Promise<ParseResult>;
-    create_messages(params: DocumentCreateMessageRequest, options?: RequestOptions): Promise<DocumentMessage>;
-    create_inputs(params: DocumentCreateInputRequest, options?: RequestOptions): Promise<DocumentMessage>;
+    parse(params: ParseRequest, options?: RequestOptions): Promise<ParseResponse>;
     /**
      * Edit a PDF document by automatically detecting and filling form fields.
      *
@@ -32,14 +35,17 @@ export default class APIDocuments extends CompositionClient {
      * Split a document into sections based on provided subdocuments.
      *
      * This method analyzes a multi-page document and classifies pages into
-     * user-defined subdocuments, returning the page ranges for each section.
+     * user-defined subdocuments, returning the assigned pages for each section.
      *
      * @param params - SplitRequest containing:
      *   - document: MIMEData object, file path, Buffer, or Readable stream
-     *   - subdocuments: Array of subdocuments with 'name' and 'description'
+     *   - subdocuments: Array of subdocuments with 'name', 'description', and optional 'partition_key'
      *   - model: LLM model for inference (e.g., "retab-small")
+     *   - context: Optional business context for the split
+     *   - n_consensus: Optional number of split runs to use for consensus scoring
      * @param options - Optional request options
-     * @returns SplitResponse containing splits array with name and pages for each section
+     * @returns SplitResponse containing splits with page lists, optional likelihood/votes,
+     * and partitions when partition_key is configured
      *
      * @example
      * ```typescript
@@ -50,10 +56,11 @@ export default class APIDocuments extends CompositionClient {
      *         { name: "invoice", description: "Invoice documents with billing information" },
      *         { name: "receipt", description: "Receipt documents for payments" },
      *         { name: "contract", description: "Legal contract documents" },
-     *     ]
+     *     ],
+     *     n_consensus: 3,
      * });
      * for (const split of response.splits) {
-     *     console.log(`${split.name}: pages ${split.pages.join(', ')}`);
+     *     console.log(`${split.name}: pages ${split.pages.join(', ')} likelihood=${split.likelihood}`);
      * }
      * ```
      */
@@ -90,6 +97,5 @@ export default class APIDocuments extends CompositionClient {
      * ```
      */
     classify(params: ClassifyRequest, options?: RequestOptions): Promise<ClassifyResponse>;
-    generate_split_config(params: GenerateSplitConfigRequest, options?: RequestOptions): Promise<GenerateSplitConfigResponse>;
 }
 //# sourceMappingURL=client.d.ts.map

package/dist/api/documents/client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../../src/api/documents/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AACpE,OAAO,EAA2B,sBAAsB,EAAE,yBAAyB,EAA8B,YAAY,EAAE,WAAW,EAA+B,4BAA4B,EAAE,eAAe,EAAmD,0BAA0B,EAA+B,8BAA8B,EAAmC,WAAW,EAAE,YAAY,EAA+B,YAAY,EAAiC,eAAe,EAAuC,0BAA0B,EAA+B,MAAM,gBAAgB,CAAC;AAC9mB,OAAO,KAAK,EAAE,aAAa,EAAE,gBAAgB,EAAE,2BAA2B,EAAE,MAAM,0BAA0B,CAAC;AAI7G,MAAM,CAAC,OAAO,OAAO,YAAa,SAAQ,iBAAiB;gBAC3C,MAAM,EAAE,iBAAiB;IAG/B,OAAO,CAAC,MAAM,EAAE,sBAAsB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,yBAAyB,CAAC;IAUrG,cAAc,CAAC,MAAM,EAAE,sBAAsB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,cAAc,CAAC,8BAA8B,CAAC,CAAC;IAUjI,KAAK,CAAC,MAAM,EAAE,YAAY,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,WAAW,CAAC;IAS3E,eAAe,CAAC,MAAM,EAAE,4BAA4B,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,eAAe,CAAC;IASzG,aAAa,CAAC,MAAM,EAAE,0BAA0B,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,eAAe,CAAC;IAS3G;;;;;;;;;;;;;;;;;;OAkBG;IACG,IAAI,CAAC,MAAM,EAAE,WAAW,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,YAAY,CAAC;IAShF;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACG,KAAK,CAAC,MAAM,EAAE,YAAY,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,aAAa,CAAC;IASnF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACG,QAAQ,CAAC,MAAM,EAAE,eAAe,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAStF,qBAAqB,CAAC,MAAM,EAAE,0BAA0B,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,2BAA2B,CAAC;CASlI"}
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../../src/api/documents/client.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,iBAAiB,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AACpE,OAAO,EAA2B,sBAAsB,EAAE,yBAAyB,EAA8B,YAAY,EAAE,aAAa,EAAiC,8BAA8B,EAAmC,WAAW,EAAE,YAAY,EAA+B,YAAY,EAAiC,eAAe,EAAkD,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAC1b,OAAO,KAAK,EAAE,aAAa,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAC;AAGhF,MAAM,CAAC,OAAO,OAAO,YAAa,SAAQ,iBAAiB;gBAC3C,MAAM,EAAE,iBAAiB;IAG/B,OAAO,CAAC,MAAM,EAAE,sBAAsB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,yBAAyB,CAAC;IAUrG,OAAO,CACT,aAAa,EAAE,MAAM,EACrB,EACI,IAAI,EACJ,OAAO,EACP,MAAM,GACT,GAAE;QACC,IAAI,CAAC,EAAE,aAAa,CAAC;QACrB,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,MAAM,CAAC,EAAE,MAAM,CAAC;KACd,EACN,OAAO,CAAC,EAAE,cAAc,GACzB,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAyE7B,cAAc,CAAC,MAAM,EAAE,sBAAsB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,cAAc,CAAC,8BAA8B,CAAC,CAAC;IAUjI,KAAK,CAAC,MAAM,EAAE,YAAY,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,aAAa,CAAC;IASnF;;;;;;;;;;;;;;;;;;OAkBG;IACG,IAAI,CAAC,MAAM,EAAE,WAAW,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,YAAY,CAAC;IAShF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACG,KAAK,CAAC,MAAM,EAAE,YAAY,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,aAAa,CAAC;IASnF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACG,QAAQ,CAAC,MAAM,EAAE,eAAe,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,gBAAgB,CAAC;CAS/F"}

package/dist/api/documents/client.js

@@ -1,6 +1,6 @@
+import * as z from "zod";
 import { CompositionClient } from "../../client.js";
-import { ZDocumentExtractRequest, ZRetabParsedChatCompletion, ZParseResult, ZParseRequest, ZDocumentMessage, ZDocumentCreateMessageRequest, ZDocumentCreateInputRequest, ZRetabParsedChatCompletionChunk, ZEditRequest, ZEditResponse, ZSplitRequest, ZSplitResponse, ZClassifyRequest, ZClassifyResponse, ZGenerateSplitConfigRequest } from "../../types.js";
-import { ZGenerateSplitConfigResponse } from "../../generated_types.js";
+import { ZDocumentExtractRequest, ZRetabParsedChatCompletion, ZParseResponse, ZParseRequest, ZRetabParsedChatCompletionChunk, ZEditRequest, ZEditResponse, ZSplitRequest, ZSplitResponse, ZClassifyRequest, ZClassifyResponse, ZMIMEData } from "../../types.js";
 export default class APIDocuments extends CompositionClient {
     constructor(client) {
         super(client);
@@ -8,46 +8,98 @@ export default class APIDocuments extends CompositionClient {
     async extract(params, options) {
         let request = await ZDocumentExtractRequest.parseAsync(params);
         return this._fetchJson(ZRetabParsedChatCompletion, {
-            url: "/v1/documents/extract",
+            url: "/documents/extract",
             method: "POST",
             body: { ...request, ...(options?.body || {}) },
             params: options?.params,
             headers: options?.headers,
         });
     }
-    async extract_stream(params, options) {
-        let request = await ZDocumentExtractRequest.parseAsync(params);
-        return this._fetchStream(ZRetabParsedChatCompletionChunk, {
-            url: "/v1/documents/extract",
+    async sources(extraction_id, { file, file_id, fileId, } = {}, options) {
+        const extraction = await this._fetchJson(z.any(), {
+            url: `/extractions/${extraction_id}`,
+            method: "GET",
+            params: options?.params,
+            headers: options?.headers,
+        });
+        let inferredFileId = file_id ?? fileId;
+        if (!inferredFileId && file) {
+            const parsedFile = await ZMIMEData.parseAsync(file);
+            const maybeId = parsedFile.id;
+            if (typeof maybeId === "string" && maybeId.length > 0) {
+                inferredFileId = maybeId;
+            }
+        }
+        if (!inferredFileId) {
+            const extractionFileIds = Array.isArray(extraction?.file_ids)
+                ? extraction.file_ids.filter((candidate) => typeof candidate === "string" && candidate.length > 0)
+                : [];
+            if (extractionFileIds.length === 1) {
+                inferredFileId = extractionFileIds[0];
+            }
+            else if (typeof extraction?.file_id === "string" && extraction.file_id.length > 0) {
+                inferredFileId = extraction.file_id;
+            }
+        }
+        if (!inferredFileId) {
+            throw new Error("Unable to infer file_id. Provide file_id explicitly, pass a MIMEData with an id, or use an extraction with a single file.");
+        }
+        let data = {};
+        const completion = extraction?.completion;
+        const message = completion?.choices?.[0]?.message;
+        if (message?.parsed && typeof message.parsed === "object") {
+            data = message.parsed;
+        }
+        else if (typeof message?.content === "string") {
+            try {
+                data = JSON.parse(message.content);
+            }
+            catch {
+                data = {};
+            }
+        }
+        const ocrResponse = await this._fetchJson(z.any(), {
+            url: "/documents/perform_ocr_only",
             method: "POST",
-            body: { ...request, stream: true, ...(options?.body || {}) },
+            body: {
+                file_id: inferredFileId,
+                ...(options?.body || {}),
+            },
             params: options?.params,
             headers: options?.headers,
         });
-    }
-    async parse(params, options) {
-        return this._fetchJson(ZParseResult, {
-            url: "/v1/documents/parse",
+        const ocrFileId = ocrResponse?.ocr_file_id;
+        if (typeof ocrFileId !== "string" || ocrFileId.length === 0) {
+            throw new Error("perform_ocr_only did not return a valid ocr_file_id");
+        }
+        return this._fetchJson(z.record(z.any()), {
+            url: "/documents/compute_field_locations",
             method: "POST",
-            body: { ...(await ZParseRequest.parseAsync(params)), ...(options?.body || {}) },
+            body: {
+                ocr_file_id: ocrFileId,
+                ocr_result: ocrResponse?.ocr_result,
+                data,
+                ...(options?.body || {}),
+            },
             params: options?.params,
             headers: options?.headers,
         });
     }
-    async create_messages(params, options) {
-        return this._fetchJson(ZDocumentMessage, {
-            url: "/v1/documents/create_messages",
+    async extract_stream(params, options) {
+        let request = await ZDocumentExtractRequest.parseAsync(params);
+        return this._fetchStream(ZRetabParsedChatCompletionChunk, {
+            url: "/documents/extractions",
             method: "POST",
-            body: { ...(await ZDocumentCreateMessageRequest.parseAsync(params)), ...(options?.body || {}) },
+            body: { ...request, stream: true, ...(options?.body || {}) },
             params: options?.params,
             headers: options?.headers,
         });
     }
-    async create_inputs(params, options) {
-        return this._fetchJson(ZDocumentMessage, {
-            url: "/v1/documents/create_inputs",
+    async parse(params, options) {
+        return this._fetchJson(ZParseResponse, {
+            url: "/documents/parse",
             method: "POST",
-            body: { ...(await ZDocumentCreateInputRequest.parseAsync(params)), ...(options?.body || {}) },
+            body: { ...(await ZParseRequest.parseAsync(params)), ...(options?.body || {}) },
             params: options?.params,
             headers: options?.headers,
         });
@@ -73,7 +125,7 @@ export default class APIDocuments extends CompositionClient {
      */
     async edit(params, options) {
         return this._fetchJson(ZEditResponse, {
-            url: "/v1/documents/edit",
+            url: "/documents/edit",
             method: "POST",
             body: { ...(await ZEditRequest.parseAsync(params)), ...(options?.body || {}) },
             params: options?.params,
@@ -84,14 +136,17 @@ export default class APIDocuments extends CompositionClient {
      * Split a document into sections based on provided subdocuments.
      *
      * This method analyzes a multi-page document and classifies pages into
-     * user-defined subdocuments, returning the page ranges for each section.
+     * user-defined subdocuments, returning the assigned pages for each section.
      *
      * @param params - SplitRequest containing:
      *   - document: MIMEData object, file path, Buffer, or Readable stream
-     *   - subdocuments: Array of subdocuments with 'name' and 'description'
+     *   - subdocuments: Array of subdocuments with 'name', 'description', and optional 'partition_key'
      *   - model: LLM model for inference (e.g., "retab-small")
+     *   - context: Optional business context for the split
+     *   - n_consensus: Optional number of split runs to use for consensus scoring
      * @param options - Optional request options
-     * @returns SplitResponse containing splits array with name and pages for each section
+     * @returns SplitResponse containing splits with page lists, optional likelihood/votes,
+     * and partitions when partition_key is configured
      *
      * @example
      * ```typescript
@@ -102,16 +157,17 @@ export default class APIDocuments extends CompositionClient {
      *         { name: "invoice", description: "Invoice documents with billing information" },
      *         { name: "receipt", description: "Receipt documents for payments" },
      *         { name: "contract", description: "Legal contract documents" },
-     *     ]
+     *     ],
+     *     n_consensus: 3,
      * });
      * for (const split of response.splits) {
-     *     console.log(`${split.name}: pages ${split.pages.join(', ')}`);
+     *     console.log(`${split.name}: pages ${split.pages.join(', ')} likelihood=${split.likelihood}`);
      * }
      * ```
      */
     async split(params, options) {
         return this._fetchJson(ZSplitResponse, {
-            url: "/v1/documents/split",
+            url: "/documents/split",
             method: "POST",
             body: { ...(await ZSplitRequest.parseAsync(params)), ...(options?.body || {}) },
             params: options?.params,
@@ -151,20 +207,11 @@ export default class APIDocuments extends CompositionClient {
      */
     async classify(params, options) {
         return this._fetchJson(ZClassifyResponse, {
-            url: "/v1/documents/classify",
+            url: "/documents/classify",
             method: "POST",
             body: { ...(await ZClassifyRequest.parseAsync(params)), ...(options?.body || {}) },
             params: options?.params,
             headers: options?.headers,
         });
     }
-    async generate_split_config(params, options) {
-        return this._fetchJson(ZGenerateSplitConfigResponse, {
-            url: "/v1/documents/split/generate_config",
-            method: "POST",
-            body: { ...(await ZGenerateSplitConfigRequest.parseAsync(params)), ...(options?.body || {}) },
-            params: options?.params,
-            headers: options?.headers,
-        });
-    }
 }

package/dist/api/edit/agent/client.js

@@ -28,7 +28,7 @@ export default class APIEditAgent extends CompositionClient {
      */
     async fill(params, options) {
         return this._fetchJson(ZEditResponse, {
-            url: "/v1/edit/agent/fill",
+            url: "/edit/agent/fill",
             method: "POST",
             body: { ...(await ZEditRequest.parseAsync(params)), ...(options?.body || {}) },
             params: options?.params,

package/dist/api/edit/client.d.ts

@@ -6,7 +6,7 @@ import APIEditAgent from "./agent/client.js";
  *
  * Sub-clients:
  * - agent: Agent-based document editing (fill any document with AI)
- * - templates: Template-based PDF form filling (for batch processing)
+ * - templates: Template generation and fill helpers for PDF workflows
  */
 export default class APIEdit extends CompositionClient {
     agent: APIEditAgent;

package/dist/api/edit/client.js

@@ -6,7 +6,7 @@ import APIEditAgent from "./agent/client.js";
  *
  * Sub-clients:
  * - agent: Agent-based document editing (fill any document with AI)
- * - templates: Template-based PDF form filling (for batch processing)
+ * - templates: Template generation and fill helpers for PDF workflows
  */
 export default class APIEdit extends CompositionClient {
     constructor(client) {

package/dist/api/edit/templates/client.d.ts

@@ -1,81 +1,7 @@
 import { CompositionClient, RequestOptions } from "../../../client.js";
-import { PaginatedList, InferFormSchemaRequest, InferFormSchemaResponse, MIMEDataInput, EditResponse } from "../../../types.js";
-import { EditTemplate, FormField } from "../../../generated_types.js";
+import { EditResponse, InferFormSchemaRequest, InferFormSchemaResponse } from "../../../types.js";
 export default class APIEditTemplates extends CompositionClient {
     constructor(client: CompositionClient);
-    /**
-     * List edit templates with pagination and optional filtering.
-     *
-     * @param params - Pagination and filter parameters
-     * @param options - Optional request options
-     * @returns PaginatedList of EditTemplate objects
-     */
-    list({ before, after, limit, order, filename, mime_type, include_embeddings, sort_by, }?: {
-        before?: string;
-        after?: string;
-        limit?: number;
-        order?: "asc" | "desc";
-        filename?: string;
-        mime_type?: string;
-        include_embeddings?: boolean;
-        sort_by?: string;
-    }, options?: RequestOptions): Promise<PaginatedList>;
-    /**
-     * Get an edit template by ID.
-     *
-     * @param template_id - The ID of the template to retrieve
-     * @param options - Optional request options
-     * @returns EditTemplate object
-     */
-    get(template_id: string, options?: RequestOptions): Promise<EditTemplate>;
-    /**
-     * Create a new edit template.
-     *
-     * @param params - CreateEditTemplateRequest containing:
-     *   - name: Name of the template
-     *   - document: The document to use as a template (MIMEData, file path, Buffer, or Readable)
-     *   - form_fields: Array of form field definitions
-     * @param options - Optional request options
-     * @returns EditTemplate object
-     */
-    create({ name, document, form_fields, }: {
-        name: string;
-        document: MIMEDataInput;
-        form_fields: FormField[];
-    }, options?: RequestOptions): Promise<EditTemplate>;
-    /**
-     * Update an existing edit template.
-     *
-     * @param template_id - The ID of the template to update
-     * @param params - UpdateEditTemplateRequest containing optional fields to update:
-     *   - name: New name for the template
-     *   - form_fields: Updated array of form field definitions
-     * @param options - Optional request options
-     * @returns EditTemplate object
-     */
-    update(template_id: string, { name, form_fields, }?: {
-        name?: string;
-        form_fields?: FormField[];
-    }, options?: RequestOptions): Promise<EditTemplate>;
-    /**
-     * Delete an edit template by ID.
-     *
-     * @param template_id - The ID of the template to delete
-     * @param options - Optional request options
-     */
-    delete(template_id: string, options?: RequestOptions): Promise<void>;
-    /**
-     * Duplicate an existing edit template.
-     *
-     * @param template_id - The ID of the template to duplicate
-     * @param params - DuplicateEditTemplateRequest containing optional:
-     *   - name: Name for the duplicated template (defaults to "{original_name} (copy)")
-     * @param options - Optional request options
-     * @returns EditTemplate object (the new duplicated template)
-     */
-    duplicate(template_id: string, { name }?: {
-        name?: string;
-    }, options?: RequestOptions): Promise<EditTemplate>;
     /**
      * Generate (infer) form schema from a PDF document.
      *

package/dist/api/edit/templates/client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../../../src/api/edit/templates/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AACvE,OAAO,EAEH,aAAa,EACb,sBAAsB,EACtB,uBAAuB,EAGvB,aAAa,EAEb,YAAY,EAEf,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EACH,YAAY,EAEZ,SAAS,EACZ,MAAM,6BAA6B,CAAC;AAErC,MAAM,CAAC,OAAO,OAAO,gBAAiB,SAAQ,iBAAiB;gBAC/C,MAAM,EAAE,iBAAiB;IAIrC;;;;;;OAMG;IACG,IAAI,CACN,EACI,MAAM,EACN,KAAK,EACL,KAAU,EACV,KAAc,EACd,QAAQ,EACR,SAAS,EACT,kBAA0B,EAC1B,OAAsB,GACzB,GAAE;QACC,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,KAAK,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;QACvB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,kBAAkB,CAAC,EAAE,OAAO,CAAC;QAC7B,OAAO,CAAC,EAAE,MAAM,CAAC;KACf,EACN,OAAO,CAAC,EAAE,cAAc,GACzB,OAAO,CAAC,aAAa,CAAC;IAyBzB;;;;;;OAMG;IACG,GAAG,CAAC,WAAW,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,YAAY,CAAC;IAS/E;;;;;;;;;OASG;IACG,MAAM,CACR,EACI,IAAI,EACJ,QAAQ,EACR,WAAW,GACd,EAAE;QACC,IAAI,EAAE,MAAM,CAAC;QACb,QAAQ,EAAE,aAAa,CAAC;QACxB,WAAW,EAAE,SAAS,EAAE,CAAC;KAC5B,EACD,OAAO,CAAC,EAAE,cAAc,GACzB,OAAO,CAAC,YAAY,CAAC;IAiBxB;;;;;;;;;OASG;IACG,MAAM,CACR,WAAW,EAAE,MAAM,EACnB,EACI,IAAI,EACJ,WAAW,GACd,GAAE;QACC,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,WAAW,CAAC,EAAE,SAAS,EAAE,CAAC;KACxB,EACN,OAAO,CAAC,EAAE,cAAc,GACzB,OAAO,CAAC,YAAY,CAAC;IAcxB;;;;;OAKG;IACG,MAAM,CAAC,WAAW,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;IAS1E;;;;;;;;OAQG;IACG,SAAS,CACX,WAAW,EAAE,MAAM,EACnB,EAAE,IAAI,EAAE,GAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAA;KAAO,EAChC,OAAO,CAAC,EAAE,cAAc,GACzB,OAAO,CAAC,YAAY,CAAC;IAaxB;;;;;;;;;;;;;;;;;;OAkBG;IACG,QAAQ,CACV,MAAM,EAAE,sBAAsB,EAC9B,OAAO,CAAC,EAAE,cAAc,GACzB,OAAO,CAAC,uBAAuB,CAAC;IAUnC;;;;;;;;;;;;;;;;;;;;OAoBG;IACG,IAAI,CACN,EACI,WAAW,EACX,YAAY,EACZ,KAAqB,EACrB,KAAK,GACR,EAAE;QACC,WAAW,EAAE,MAAM,CAAC;QACpB,YAAY,EAAE,MAAM,CAAC;QACrB,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,KAAK,CAAC,EAAE,MAAM,CAAC;KAClB,EACD,OAAO,CAAC,EAAE,cAAc,GACzB,OAAO,CAAC,YAAY,CAAC;CAqB3B"}
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../../../src/api/edit/templates/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AACvE,OAAO,EACH,YAAY,EACZ,sBAAsB,EACtB,uBAAuB,EAI1B,MAAM,mBAAmB,CAAC;AAE3B,MAAM,CAAC,OAAO,OAAO,gBAAiB,SAAQ,iBAAiB;gBAC/C,MAAM,EAAE,iBAAiB;IAIrC;;;;;;;;;;;;;;;;;;OAkBG;IACG,QAAQ,CACV,MAAM,EAAE,sBAAsB,EAC9B,OAAO,CAAC,EAAE,cAAc,GACzB,OAAO,CAAC,uBAAuB,CAAC;IAUnC;;;;;;;;;;;;;;;;;;;;OAoBG;IACG,IAAI,CACN,EACI,WAAW,EACX,YAAY,EACZ,KAAqB,EACrB,KAAK,GACR,EAAE;QACC,WAAW,EAAE,MAAM,CAAC;QACpB,YAAY,EAAE,MAAM,CAAC;QACrB,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,KAAK,CAAC,EAAE,MAAM,CAAC;KAClB,EACD,OAAO,CAAC,EAAE,cAAc,GACzB,OAAO,CAAC,YAAY,CAAC;CAqB3B"}