@retab/node 1.0.75 → 1.0.77

package/dist/api/client.d.ts

@@ -4,6 +4,7 @@ import APIDocuments from "./documents/client";
 import APISchemas from "./schemas/client";
 import APIProjects from "./projects/client";
 import APIExtractions from "./extractions/client";
+import APIWorkflows from "./workflows/client";
 export default class APIV1 extends CompositionClient {
     constructor(client: AbstractClient);
     models: APIModels;
@@ -11,5 +12,6 @@ export default class APIV1 extends CompositionClient {
     schemas: APISchemas;
     projects: APIProjects;
     extractions: APIExtractions;
+    workflows: APIWorkflows;
 }
 //# 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;AAElD,MAAM,CAAC,OAAO,OAAO,KAAM,SAAQ,iBAAiB;gBACpC,MAAM,EAAE,cAAc;IAGlC,MAAM,YAAuB;IAC7B,SAAS,eAA0B;IACnC,OAAO,aAAwB;IAC/B,QAAQ,cAAyB;IACjC,WAAW,iBAA4B;CAC1C"}
+{"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;AAE9C,MAAM,CAAC,OAAO,OAAO,KAAM,SAAQ,iBAAiB;gBACpC,MAAM,EAAE,cAAc;IAGlC,MAAM,YAAuB;IAC7B,SAAS,eAA0B;IACnC,OAAO,aAAwB;IAC/B,QAAQ,cAAyB;IACjC,WAAW,iBAA4B;IACvC,SAAS,eAA0B;CACtC"}

package/dist/api/client.js

@@ -4,6 +4,7 @@ import APIDocuments from "./documents/client";
 import APISchemas from "./schemas/client";
 import APIProjects from "./projects/client";
 import APIExtractions from "./extractions/client";
+import APIWorkflows from "./workflows/client";
 export default class APIV1 extends CompositionClient {
     constructor(client) {
         super(client);
@@ -12,5 +13,6 @@ export default class APIV1 extends CompositionClient {
         this.schemas = new APISchemas(this);
         this.projects = new APIProjects(this);
         this.extractions = new APIExtractions(this);
+        this.workflows = new APIWorkflows(this);
     }
 }

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

@@ -1,6 +1,6 @@
 import { CompositionClient, RequestOptions } from "../../client.js";
-import { DocumentExtractRequest, RetabParsedChatCompletion, ParseRequest, ParseResult, DocumentCreateMessageRequest, DocumentMessage, DocumentCreateInputRequest, RetabParsedChatCompletionChunk, EditRequest, EditResponse, SplitRequest } from "../../types.js";
-import type { SplitResponse } from "../../generated_types.js";
+import { DocumentExtractRequest, RetabParsedChatCompletion, ParseRequest, ParseResult, DocumentCreateMessageRequest, DocumentMessage, DocumentCreateInputRequest, RetabParsedChatCompletionChunk, EditRequest, EditResponse, SplitRequest, ClassifyRequest } 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>;
@@ -58,5 +58,35 @@ export default class APIDocuments extends CompositionClient {
      * ```
      */
     split(params: SplitRequest, options?: RequestOptions): Promise<SplitResponse>;
+    /**
+     * Classify a document into one of the provided categories.
+     *
+     * This method analyzes a document and classifies it into exactly one
+     * of the user-defined categories, returning the classification with
+     * chain-of-thought reasoning explaining the decision.
+     *
+     * @param params - ClassifyRequest containing:
+     *   - document: MIMEData object, file path, Buffer, or Readable stream
+     *   - categories: Array of categories with 'name' and 'description'
+     *   - model: LLM model for inference (e.g., "retab-small")
+     * @param options - Optional request options
+     * @returns ClassifyResponse containing result with reasoning and classification
+     *
+     * @example
+     * ```typescript
+     * const response = await retab.documents.classify({
+     *     document: "invoice.pdf",
+     *     model: "retab-small",
+     *     categories: [
+     *         { name: "invoice", description: "Invoice documents with billing information" },
+     *         { name: "receipt", description: "Receipt documents for payments" },
+     *         { name: "contract", description: "Legal contract documents" },
+     *     ]
+     * });
+     * console.log(`Classification: ${response.result.classification}`);
+     * console.log(`Reasoning: ${response.result.reasoning}`);
+     * ```
+     */
+    classify(params: ClassifyRequest, options?: RequestOptions): Promise<ClassifyResponse>;
 }
 //# 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,MAAM,gBAAgB,CAAC;AAC/f,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AAG9D,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;CAStF"}
+{"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,MAAM,gBAAgB,CAAC;AACrjB,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,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;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;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,5 +1,5 @@
 import { CompositionClient } from "../../client.js";
-import { ZDocumentExtractRequest, ZRetabParsedChatCompletion, ZParseResult, ZParseRequest, ZDocumentMessage, ZDocumentCreateMessageRequest, ZDocumentCreateInputRequest, ZRetabParsedChatCompletionChunk, ZEditRequest, ZEditResponse, ZSplitRequest, ZSplitResponse } from "../../types.js";
+import { ZDocumentExtractRequest, ZRetabParsedChatCompletion, ZParseResult, ZParseRequest, ZDocumentMessage, ZDocumentCreateMessageRequest, ZDocumentCreateInputRequest, ZRetabParsedChatCompletionChunk, ZEditRequest, ZEditResponse, ZSplitRequest, ZSplitResponse, ZClassifyRequest, ZClassifyResponse } from "../../types.js";
 export default class APIDocuments extends CompositionClient {
     constructor(client) {
         super(client);
@@ -117,4 +117,42 @@ export default class APIDocuments extends CompositionClient {
             headers: options?.headers,
         });
     }
+    /**
+     * Classify a document into one of the provided categories.
+     *
+     * This method analyzes a document and classifies it into exactly one
+     * of the user-defined categories, returning the classification with
+     * chain-of-thought reasoning explaining the decision.
+     *
+     * @param params - ClassifyRequest containing:
+     *   - document: MIMEData object, file path, Buffer, or Readable stream
+     *   - categories: Array of categories with 'name' and 'description'
+     *   - model: LLM model for inference (e.g., "retab-small")
+     * @param options - Optional request options
+     * @returns ClassifyResponse containing result with reasoning and classification
+     *
+     * @example
+     * ```typescript
+     * const response = await retab.documents.classify({
+     *     document: "invoice.pdf",
+     *     model: "retab-small",
+     *     categories: [
+     *         { name: "invoice", description: "Invoice documents with billing information" },
+     *         { name: "receipt", description: "Receipt documents for payments" },
+     *         { name: "contract", description: "Legal contract documents" },
+     *     ]
+     * });
+     * console.log(`Classification: ${response.result.classification}`);
+     * console.log(`Reasoning: ${response.result.reasoning}`);
+     * ```
+     */
+    async classify(params, options) {
+        return this._fetchJson(ZClassifyResponse, {
+            url: "/v1/documents/classify",
+            method: "POST",
+            body: { ...(await ZClassifyRequest.parseAsync(params)), ...(options?.body || {}) },
+            params: options?.params,
+            headers: options?.headers,
+        });
+    }
 }

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

@@ -0,0 +1,48 @@
+import { CompositionClient, RequestOptions } from "../../client.js";
+import { MIMEDataInput, WorkflowRun } from "../../types.js";
+export default class APIWorkflows extends CompositionClient {
+    constructor(client: CompositionClient);
+    /**
+     * Run a workflow with the provided input documents.
+     *
+     * This creates a workflow run and starts execution in the background.
+     * The returned WorkflowRun will have status "running" - use getRun()
+     * to check for updates on the run status.
+     *
+     * @param workflowId - The ID of the workflow to run
+     * @param documents - Mapping of start node IDs to their input documents
+     * @param options - Optional request options
+     * @returns The created workflow run with status "running"
+     *
+     * @example
+     * ```typescript
+     * const run = await client.workflows.run({
+     *     workflowId: "wf_abc123",
+     *     documents: {
+     *         "start-node-1": "./invoice.pdf",
+     *         "start-node-2": Buffer.from(...)
+     *     }
+     * });
+     * console.log(`Run started: ${run.id}, status: ${run.status}`);
+     * ```
+     */
+    run({ workflowId, documents, }: {
+        workflowId: string;
+        documents: Record<string, MIMEDataInput>;
+    }, options?: RequestOptions): Promise<WorkflowRun>;
+    /**
+     * Get a workflow run by ID.
+     *
+     * @param runId - The ID of the workflow run to retrieve
+     * @param options - Optional request options
+     * @returns The workflow run
+     *
+     * @example
+     * ```typescript
+     * const run = await client.workflows.getRun("run_abc123");
+     * console.log(`Run status: ${run.status}`);
+     * ```
+     */
+    getRun(runId: string, options?: RequestOptions): Promise<WorkflowRun>;
+}
+//# sourceMappingURL=client.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../../src/api/workflows/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AACpE,OAAO,EAAE,aAAa,EAAa,WAAW,EAAgB,MAAM,gBAAgB,CAAC;AAErF,MAAM,CAAC,OAAO,OAAO,YAAa,SAAQ,iBAAiB;gBAC3C,MAAM,EAAE,iBAAiB;IAIrC;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACG,GAAG,CAAC,EACN,UAAU,EACV,SAAS,GACZ,EAAE;QACC,UAAU,EAAE,MAAM,CAAC;QACnB,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;KAC5C,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,WAAW,CAAC;IA0BlD;;;;;;;;;;;;OAYG;IACG,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,WAAW,CAAC;CAQ9E"}

package/dist/api/workflows/client.js

@@ -0,0 +1,74 @@
+import { CompositionClient } from "../../client.js";
+import { ZMIMEData, ZWorkflowRun } from "../../types.js";
+export default class APIWorkflows extends CompositionClient {
+    constructor(client) {
+        super(client);
+    }
+    /**
+     * Run a workflow with the provided input documents.
+     *
+     * This creates a workflow run and starts execution in the background.
+     * The returned WorkflowRun will have status "running" - use getRun()
+     * to check for updates on the run status.
+     *
+     * @param workflowId - The ID of the workflow to run
+     * @param documents - Mapping of start node IDs to their input documents
+     * @param options - Optional request options
+     * @returns The created workflow run with status "running"
+     *
+     * @example
+     * ```typescript
+     * const run = await client.workflows.run({
+     *     workflowId: "wf_abc123",
+     *     documents: {
+     *         "start-node-1": "./invoice.pdf",
+     *         "start-node-2": Buffer.from(...)
+     *     }
+     * });
+     * console.log(`Run started: ${run.id}, status: ${run.status}`);
+     * ```
+     */
+    async run({ workflowId, documents, }, options) {
+        // Convert each document to MIMEData format expected by backend
+        const documentsPayload = {};
+        for (const [nodeId, document] of Object.entries(documents)) {
+            const parsedDocument = await ZMIMEData.parseAsync(document);
+            // Extract base64 content from data URL
+            const content = parsedDocument.url.split(",")[1];
+            const mimeType = parsedDocument.url.split(";")[0].split(":")[1];
+            documentsPayload[nodeId] = {
+                filename: parsedDocument.filename,
+                content: content,
+                mime_type: mimeType,
+            };
+        }
+        return this._fetchJson(ZWorkflowRun, {
+            url: `/v1/workflows/${workflowId}/run`,
+            method: "POST",
+            body: { documents: documentsPayload, ...(options?.body || {}) },
+            params: options?.params,
+            headers: options?.headers,
+        });
+    }
+    /**
+     * Get a workflow run by ID.
+     *
+     * @param runId - The ID of the workflow run to retrieve
+     * @param options - Optional request options
+     * @returns The workflow run
+     *
+     * @example
+     * ```typescript
+     * const run = await client.workflows.getRun("run_abc123");
+     * console.log(`Run status: ${run.status}`);
+     * ```
+     */
+    async getRun(runId, options) {
+        return this._fetchJson(ZWorkflowRun, {
+            url: `/v1/workflows/runs/${runId}`,
+            method: "GET",
+            params: options?.params,
+            headers: options?.headers,
+        });
+    }
+}