@retab/node 1.0.65 → 1.0.68

package/dist/api/client.d.ts

@@ -3,11 +3,13 @@ import APIModels from "./models/client";
 import APIDocuments from "./documents/client";
 import APISchemas from "./schemas/client";
 import APIProjects from "./projects/client";
+import APIExtractions from "./extractions/client";
 export default class APIV1 extends CompositionClient {
     constructor(client: AbstractClient);
     models: APIModels;
     documents: APIDocuments;
     schemas: APISchemas;
     projects: APIProjects;
+    extractions: APIExtractions;
 }
 //# 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;AAE5C,MAAM,CAAC,OAAO,OAAO,KAAM,SAAQ,iBAAiB;gBACpC,MAAM,EAAE,cAAc;IAGlC,MAAM,YAAuB;IAC7B,SAAS,eAA0B;IACnC,OAAO,aAAwB;IAC/B,QAAQ,cAAyB;CACpC"}
+{"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"}

package/dist/api/client.js

@@ -3,6 +3,7 @@ import APIModels from "./models/client";
 import APIDocuments from "./documents/client";
 import APISchemas from "./schemas/client";
 import APIProjects from "./projects/client";
+import APIExtractions from "./extractions/client";
 export default class APIV1 extends CompositionClient {
     constructor(client) {
         super(client);
@@ -10,5 +11,6 @@ export default class APIV1 extends CompositionClient {
         this.documents = new APIDocuments(this);
         this.schemas = new APISchemas(this);
         this.projects = new APIProjects(this);
+        this.extractions = new APIExtractions(this);
     }
 }

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

@@ -0,0 +1,73 @@
+import { CompositionClient, RequestOptions } from "../../client.js";
+import { PaginatedList } from "../../types.js";
+import * as z from "zod";
+type HumanReviewStatus = "success" | "review_required" | "reviewed";
+declare const ZDownloadResponse: z.ZodObject<{
+    download_url: z.ZodString;
+    filename: z.ZodString;
+    expires_at: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    filename: string;
+    expires_at: string;
+    download_url: string;
+}, {
+    filename: string;
+    expires_at: string;
+    download_url: string;
+}>;
+type DownloadResponse = z.infer<typeof ZDownloadResponse>;
+declare const ZExtraction: z.ZodRecord<z.ZodString, z.ZodAny>;
+type Extraction = z.infer<typeof ZExtraction>;
+export default class APIExtractions extends CompositionClient {
+    constructor(client: CompositionClient);
+    /**
+     * List extractions with pagination and filtering.
+     */
+    list({ before, after, limit, order, origin_dot_type, origin_dot_id, from_date, to_date, human_review_status, metadata, filename, }?: {
+        before?: string;
+        after?: string;
+        limit?: number;
+        order?: "asc" | "desc";
+        origin_dot_type?: string;
+        origin_dot_id?: string;
+        from_date?: Date;
+        to_date?: Date;
+        human_review_status?: HumanReviewStatus;
+        metadata?: Record<string, string>;
+        filename?: string;
+    }, options?: RequestOptions): Promise<PaginatedList>;
+    /**
+     * Download extractions in various formats. Returns download_url, filename, and expires_at.
+     */
+    download({ order, origin_dot_id, from_date, to_date, human_review_status, metadata, filename, format, }?: {
+        order?: "asc" | "desc";
+        origin_dot_id?: string;
+        from_date?: Date;
+        to_date?: Date;
+        human_review_status?: HumanReviewStatus;
+        metadata?: Record<string, string>;
+        filename?: string;
+        format?: "jsonl" | "csv" | "xlsx";
+    }, options?: RequestOptions): Promise<DownloadResponse>;
+    /**
+     * Update an extraction.
+     */
+    update(extraction_id: string, { predictions, predictions_draft, human_review_status, json_schema, inference_settings, metadata, }: {
+        predictions?: Record<string, any>;
+        predictions_draft?: Record<string, any>;
+        human_review_status?: HumanReviewStatus;
+        json_schema?: Record<string, any>;
+        inference_settings?: Record<string, any>;
+        metadata?: Record<string, string>;
+    }, options?: RequestOptions): Promise<Extraction>;
+    /**
+     * Get an extraction by ID.
+     */
+    get(extraction_id: string, options?: RequestOptions): Promise<Extraction>;
+    /**
+     * Delete an extraction by ID.
+     */
+    delete(extraction_id: string, options?: RequestOptions): Promise<void>;
+}
+export {};
+//# sourceMappingURL=client.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../../src/api/extractions/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AACpE,OAAO,EAAkB,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAC/D,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AAGzB,KAAK,iBAAiB,GAAG,SAAS,GAAG,iBAAiB,GAAG,UAAU,CAAC;AAIpE,QAAA,MAAM,iBAAiB;;;;;;;;;;;;EAIrB,CAAC;AACH,KAAK,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAG1D,QAAA,MAAM,WAAW,oCAAoB,CAAC;AACtC,KAAK,UAAU,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,WAAW,CAAC,CAAC;AAE9C,MAAM,CAAC,OAAO,OAAO,cAAe,SAAQ,iBAAiB;gBAC7C,MAAM,EAAE,iBAAiB;IAIrC;;OAEG;IACG,IAAI,CAAC,EACP,MAAM,EACN,KAAK,EACL,KAAU,EACV,KAAc,EACd,eAAe,EACf,aAAa,EACb,SAAS,EACT,OAAO,EACP,mBAAmB,EACnB,QAAQ,EACR,QAAQ,GACX,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,eAAe,CAAC,EAAE,MAAM,CAAC;QACzB,aAAa,CAAC,EAAE,MAAM,CAAC;QACvB,SAAS,CAAC,EAAE,IAAI,CAAC;QACjB,OAAO,CAAC,EAAE,IAAI,CAAC;QACf,mBAAmB,CAAC,EAAE,iBAAiB,CAAC;QACxC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QAClC,QAAQ,CAAC,EAAE,MAAM,CAAC;KAChB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,aAAa,CAAC;IA8BzD;;OAEG;IACG,QAAQ,CAAC,EACX,KAAc,EACd,aAAa,EACb,SAAS,EACT,OAAO,EACP,mBAAmB,EACnB,QAAQ,EACR,QAAQ,EACR,MAAgB,GACnB,GAAE;QACC,KAAK,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;QACvB,aAAa,CAAC,EAAE,MAAM,CAAC;QACvB,SAAS,CAAC,EAAE,IAAI,CAAC;QACjB,OAAO,CAAC,EAAE,IAAI,CAAC;QACf,mBAAmB,CAAC,EAAE,iBAAiB,CAAC;QACxC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QAClC,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,MAAM,CAAC,EAAE,OAAO,GAAG,KAAK,GAAG,MAAM,CAAC;KAChC,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,gBAAgB,CAAC;IA0B5D;;OAEG;IACG,MAAM,CACR,aAAa,EAAE,MAAM,EACrB,EACI,WAAW,EACX,iBAAiB,EACjB,mBAAmB,EACnB,WAAW,EACX,kBAAkB,EAClB,QAAQ,GACX,EAAE;QACC,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QAClC,iBAAiB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QACxC,mBAAmB,CAAC,EAAE,iBAAiB,CAAC;QACxC,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QAClC,kBAAkB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QACzC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;KACrC,EACD,OAAO,CAAC,EAAE,cAAc,GACzB,OAAO,CAAC,UAAU,CAAC;IAkBtB;;OAEG;IACG,GAAG,CAAC,aAAa,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,UAAU,CAAC;IAS/E;;OAEG;IACG,MAAM,CAAC,aAAa,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;CAQ/E"}

package/dist/api/extractions/client.js

@@ -0,0 +1,114 @@
+import { CompositionClient } from "../../client.js";
+import { ZPaginatedList } from "../../types.js";
+import * as z from "zod";
+// Response types for extractions API
+const ZDownloadResponse = z.object({
+    download_url: z.string(),
+    filename: z.string(),
+    expires_at: z.string(),
+});
+// Generic extraction object (flexible since schema varies)
+const ZExtraction = z.record(z.any());
+export default class APIExtractions extends CompositionClient {
+    constructor(client) {
+        super(client);
+    }
+    /**
+     * List extractions with pagination and filtering.
+     */
+    async list({ before, after, limit = 10, order = "desc", origin_dot_type, origin_dot_id, from_date, to_date, human_review_status, metadata, filename, } = {}, options) {
+        const params = {
+            before,
+            after,
+            limit,
+            order,
+            origin_dot_type,
+            origin_dot_id,
+            from_date: from_date?.toISOString(),
+            to_date: to_date?.toISOString(),
+            human_review_status,
+            filename,
+            // Note: metadata must be JSON-serialized as the backend expects a JSON string
+            metadata: metadata ? JSON.stringify(metadata) : undefined,
+        };
+        // Remove undefined values
+        const cleanParams = Object.fromEntries(Object.entries(params).filter(([_, v]) => v !== undefined));
+        return this._fetchJson(ZPaginatedList, {
+            url: "/v1/extractions",
+            method: "GET",
+            params: { ...cleanParams, ...(options?.params || {}) },
+            headers: options?.headers,
+        });
+    }
+    /**
+     * Download extractions in various formats. Returns download_url, filename, and expires_at.
+     */
+    async download({ order = "desc", origin_dot_id, from_date, to_date, human_review_status, metadata, filename, format = "jsonl", } = {}, options) {
+        const params = {
+            order,
+            origin_dot_id,
+            from_date: from_date?.toISOString(),
+            to_date: to_date?.toISOString(),
+            human_review_status,
+            filename,
+            format,
+            // Note: metadata must be JSON-serialized as the backend expects a JSON string
+            metadata: metadata ? JSON.stringify(metadata) : undefined,
+        };
+        // Remove undefined values
+        const cleanParams = Object.fromEntries(Object.entries(params).filter(([_, v]) => v !== undefined));
+        return this._fetchJson(ZDownloadResponse, {
+            url: "/v1/extractions/download",
+            method: "GET",
+            params: { ...cleanParams, ...(options?.params || {}) },
+            headers: options?.headers,
+        });
+    }
+    /**
+     * Update an extraction.
+     */
+    async update(extraction_id, { predictions, predictions_draft, human_review_status, json_schema, inference_settings, metadata, }, options) {
+        const body = {};
+        if (predictions !== undefined)
+            body.predictions = predictions;
+        if (predictions_draft !== undefined)
+            body.predictions_draft = predictions_draft;
+        if (human_review_status !== undefined)
+            body.human_review_status = human_review_status;
+        if (json_schema !== undefined)
+            body.json_schema = json_schema;
+        if (inference_settings !== undefined)
+            body.inference_settings = inference_settings;
+        if (metadata !== undefined)
+            body.metadata = metadata;
+        return this._fetchJson(ZExtraction, {
+            url: `/v1/extractions/${extraction_id}`,
+            method: "PATCH",
+            body: { ...body, ...(options?.body || {}) },
+            params: options?.params,
+            headers: options?.headers,
+        });
+    }
+    /**
+     * Get an extraction by ID.
+     */
+    async get(extraction_id, options) {
+        return this._fetchJson(ZExtraction, {
+            url: `/v1/extractions/${extraction_id}`,
+            method: "GET",
+            params: options?.params,
+            headers: options?.headers,
+        });
+    }
+    /**
+     * Delete an extraction by ID.
+     */
+    async delete(extraction_id, options) {
+        return this._fetchJson({
+            url: `/v1/extractions/${extraction_id}`,
+            method: "DELETE",
+            params: options?.params,
+            headers: options?.headers,
+        });
+    }
+}

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

@@ -7,17 +7,18 @@ export default class APIProjects extends CompositionClient {
     get(projectId: string, options?: RequestOptions): Promise<Project>;
     delete(projectId: string, options?: RequestOptions): Promise<void>;
     publish(projectId: string, body?: Record<string, unknown>, options?: RequestOptions): Promise<Project>;
-    extract({ project_id, iteration_id, document, documents, model, image_resolution_dpi, n_consensus, temperature, seed, store }: {
+    extract({ project_id, iteration_id, document, model, image_resolution_dpi, n_consensus, temperature, seed, store, metadata, extraction_id }: {
         project_id: string;
         iteration_id?: string;
-        document?: MIMEDataInput;
-        documents?: MIMEDataInput[];
+        document: MIMEDataInput;
         model?: string;
         image_resolution_dpi?: number;
         n_consensus?: number;
         temperature?: number;
         seed?: number;
         store?: boolean;
+        metadata?: Record<string, string>;
+        extraction_id?: string;
     }, options?: RequestOptions): Promise<RetabParsedChatCompletion>;
 }
 //# sourceMappingURL=client.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../../src/api/projects/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAEpE,OAAO,EAAa,OAAO,EAAmC,oBAAoB,EAAE,aAAa,EAAa,yBAAyB,EAA8B,MAAM,gBAAgB,CAAC;AAE5L,MAAM,CAAC,OAAO,OAAO,WAAY,SAAQ,iBAAiB;gBAC1C,MAAM,EAAE,iBAAiB;IAI/B,MAAM,CAAC,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,OAAO,CAAC;IAU9E,IAAI,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;IASlD,GAAG,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,OAAO,CAAC;IASlE,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;IASlE,OAAO,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,OAAO,CAAC;IAYtG,OAAO,CAAC,EACV,UAAU,EACV,YAAY,EACZ,QAAQ,EACR,SAAS,EACT,KAAK,EACL,oBAAoB,EACpB,WAAW,EACX,WAAW,EACX,IAAI,EACJ,KAAK,EACR,EAAE;QACC,UAAU,EAAE,MAAM,CAAC;QACnB,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB,QAAQ,CAAC,EAAE,aAAa,CAAC;QACzB,SAAS,CAAC,EAAE,aAAa,EAAE,CAAC;QAC5B,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,oBAAoB,CAAC,EAAE,MAAM,CAAC;QAC9B,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,KAAK,CAAC,EAAE,OAAO,CAAC;KACnB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,yBAAyB,CAAC;CA2BnE"}
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../../src/api/projects/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAEpE,OAAO,EAAa,OAAO,EAAmC,oBAAoB,EAAE,aAAa,EAAa,yBAAyB,EAA8B,MAAM,gBAAgB,CAAC;AAE5L,MAAM,CAAC,OAAO,OAAO,WAAY,SAAQ,iBAAiB;gBAC1C,MAAM,EAAE,iBAAiB;IAI/B,MAAM,CAAC,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,OAAO,CAAC;IAU9E,IAAI,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;IASlD,GAAG,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,OAAO,CAAC;IASlE,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;IASlE,OAAO,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,OAAO,CAAC;IAYtG,OAAO,CAAC,EACV,UAAU,EACV,YAAY,EACZ,QAAQ,EACR,KAAK,EACL,oBAAoB,EACpB,WAAW,EACX,WAAW,EACX,IAAI,EACJ,KAAK,EACL,QAAQ,EACR,aAAa,EAChB,EAAE;QACC,UAAU,EAAE,MAAM,CAAC;QACnB,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB,QAAQ,EAAE,aAAa,CAAC;QACxB,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,oBAAoB,CAAC,EAAE,MAAM,CAAC;QAC9B,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,KAAK,CAAC,EAAE,OAAO,CAAC;QAChB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QAClC,aAAa,CAAC,EAAE,MAAM,CAAC;KAC1B,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,yBAAyB,CAAC;CA8BnE"}

package/dist/api/projects/client.js

@@ -48,14 +48,13 @@ export default class APIProjects extends CompositionClient {
             headers: options?.headers,
         });
     }
-    async extract({ project_id, iteration_id, document, documents, model, image_resolution_dpi, n_consensus, temperature, seed, store }, options) {
-        if (!document && (!documents || documents.length === 0)) {
-            throw new Error("Either 'document' or 'documents' must be provided.");
-        }
+    async extract({ project_id, iteration_id, document, model, image_resolution_dpi, n_consensus, temperature, seed, store, metadata, extraction_id }, options) {
         const url = iteration_id ? `/v1/projects/extract/${project_id}/${iteration_id}` : `/v1/projects/extract/${project_id}`;
+        // Parse and convert document to blob for multipart form upload
+        const parsedDocument = await ZMIMEData.parseAsync(document);
         // Only include optional parameters if they are provided
         const bodyParams = {
-            documents: (await ZMIMEData.array().parseAsync([...document ? [document] : [], ...(documents || [])])).map(mimeToBlob)
+            document: mimeToBlob(parsedDocument)
         };
         if (model !== undefined)
             bodyParams.model = model;
@@ -69,6 +68,11 @@ export default class APIProjects extends CompositionClient {
             bodyParams.seed = seed;
         if (store !== undefined)
             bodyParams.store = store;
+        // Note: metadata must be JSON-serialized since multipart forms only accept primitive types
+        if (metadata !== undefined)
+            bodyParams.metadata = JSON.stringify(metadata);
+        if (extraction_id !== undefined)
+            bodyParams.extraction_id = extraction_id;
         return this._fetchJson(ZRetabParsedChatCompletion, {
             url,
             method: "POST",