mindee 5.4.0 → 5.6.0

package/src/v2/product/extraction/extractionResult.js

@@ -1,6 +1,7 @@
 import { InferenceFields } from "../../../v2/parsing/inference/field/index.js";
 import { RawText } from "../../../v2/parsing/inference/field/rawText.js";
 import { RagMetadata } from "../../../v2/parsing/inference/field/ragMetadata.js";
+/** Extraction result payload containing fields and optional extras. */
 export class ExtractionResult {
     constructor(serverResponse) {
         this.fields = new InferenceFields(serverResponse["fields"]);
@@ -11,6 +12,7 @@ export class ExtractionResult {
             this.rag = new RagMetadata(serverResponse["rag"]);
         }
     }
+    /** Returns a readable representation of extracted fields. */
     toString() {
         return `Fields\n======\n${this.fields}`;
     }

package/src/v2/product/extraction/params/dataSchema.d.ts

@@ -1,5 +1,10 @@
 import { StringDict } from "../../../../parsing/stringDict.js";
-import { DataSchemaReplace } from "./dataSchemaReplace.js";
+import { DataSchemaReplace, DataSchemaReplaceJson } from "./dataSchemaReplace.js";
+/** JSON payload for top-level data schema options. */
+export interface DataSchemaJson {
+    /** Optional full replacement schema. */
+    replace?: DataSchemaReplaceJson;
+}
 /**
  * Modify the Data Schema.
  */
@@ -9,10 +14,8 @@ export declare class DataSchema {
      */
     replace?: DataSchemaReplace;
     constructor(dataSchema: StringDict | string);
-    toJSON(): {
-        replace: {
-            fields: Record<string, unknown>[];
-        } | undefined;
-    };
+    /** Serializes the data schema parameters to API format. */
+    toJSON(): DataSchemaJson;
+    /** Returns a JSON string representation of the data schema parameters. */
     toString(): string;
 }

package/src/v2/product/extraction/params/dataSchema.js

@@ -14,9 +14,11 @@ export class DataSchema {
             this.replace = new DataSchemaReplace(dataSchema["replace"]);
         }
     }
+    /** Serializes the data schema parameters to API format. */
     toJSON() {
         return { replace: this.replace?.toJSON() };
     }
+    /** Returns a JSON string representation of the data schema parameters. */
     toString() {
         return JSON.stringify(this.toJSON());
     }

package/src/v2/product/extraction/params/dataSchemaField.d.ts

@@ -1,4 +1,26 @@
 import { StringDict } from "../../../../parsing/index.js";
+/** JSON payload for a single data schema field definition. */
+export interface DataSchemaFieldJson {
+    /** Field key used in results. */
+    name: string;
+    /** Human-readable field title. */
+    title: string;
+    /** Whether the field accepts multiple values. */
+    is_array: boolean;
+    /** Field type name. */
+    type: string;
+    /** Optional allowed classes for classification fields. */
+    classification_values?: Array<string>;
+    /** Optional deduplication behavior for array fields. */
+    unique_values?: boolean;
+    /** Optional field description. */
+    description?: string;
+    /** Optional extraction guidelines. */
+    guidelines?: string;
+    /** Optional nested schema for object fields. */
+    nested_fields?: StringDict;
+}
+/** Data schema field definition used by extraction parameters. */
 export declare class DataSchemaField {
     /**
      * Display name for the field, also impacts inference results.
@@ -38,6 +60,8 @@ export declare class DataSchemaField {
      */
     nestedFields?: StringDict;
     constructor(fields: StringDict);
-    toJSON(): Record<string, unknown>;
+    /** Serializes the field definition to API format. */
+    toJSON(): DataSchemaFieldJson;
+    /** Returns a JSON string representation of the field definition. */
     toString(): string;
 }

package/src/v2/product/extraction/params/dataSchemaField.js

@@ -1,3 +1,4 @@
+/** Data schema field definition used by extraction parameters. */
 export class DataSchemaField {
     constructor(fields) {
         this.name = fields["name"];
@@ -10,6 +11,7 @@ export class DataSchemaField {
         this.guidelines = fields["guidelines"];
         this.nestedFields = fields["nested_fields"];
     }
+    /** Serializes the field definition to API format. */
     toJSON() {
         const out = {
             name: this.name,
@@ -33,6 +35,7 @@ export class DataSchemaField {
             out.nested_fields = this.nestedFields;
         return out;
     }
+    /** Returns a JSON string representation of the field definition. */
     toString() {
         return JSON.stringify(this.toJSON());
     }

package/src/v2/product/extraction/params/dataSchemaReplace.d.ts

@@ -1,5 +1,10 @@
 import { StringDict } from "../../../../parsing/index.js";
-import { DataSchemaField } from "./dataSchemaField.js";
+import { DataSchemaField, DataSchemaFieldJson } from "./dataSchemaField.js";
+/** JSON payload for replacement data schema options. */
+export interface DataSchemaReplaceJson {
+    /** Field definitions replacing the current schema. */
+    fields: Array<DataSchemaFieldJson>;
+}
 /**
  * The structure to completely replace the data schema of the model.
  */
@@ -9,8 +14,8 @@ export declare class DataSchemaReplace {
      */
     fields: Array<DataSchemaField>;
     constructor(dataSchemaReplace: StringDict);
-    toJSON(): {
-        fields: Record<string, unknown>[];
-    };
+    /** Serializes the replacement schema to API format. */
+    toJSON(): DataSchemaReplaceJson;
+    /** Returns a JSON string representation of the replacement schema. */
     toString(): string;
 }

package/src/v2/product/extraction/params/dataSchemaReplace.js

@@ -13,9 +13,11 @@ export class DataSchemaReplace {
         }
         this.fields = dataSchemaReplace["fields"].map((field) => (new DataSchemaField(field)));
     }
+    /** Serializes the replacement schema to API format. */
     toJSON() {
         return { fields: this.fields.map(e => e.toJSON()) };
     }
+    /** Returns a JSON string representation of the replacement schema. */
     toString() {
         return JSON.stringify(this.toJSON());
     }

package/src/v2/product/ocr/ocr.d.ts

@@ -5,7 +5,10 @@ import { BaseProduct } from "../../../v2/product/baseProduct.js";
  * Extract raw text (OCR) from any image or scanned document.
  */
 export declare class Ocr extends BaseProduct {
+    /** Parameter class accepted by this product. */
     static get parametersClass(): typeof OcrParameters;
+    /** Response class returned by this product. */
     static get responseClass(): typeof OcrResponse;
+    /** API slug for this product. */
     static get slug(): string;
 }

package/src/v2/product/ocr/ocr.js

@@ -5,12 +5,15 @@ import { BaseProduct } from "../../../v2/product/baseProduct.js";
  * Extract raw text (OCR) from any image or scanned document.
  */
 export class Ocr extends BaseProduct {
+    /** Parameter class accepted by this product. */
     static get parametersClass() {
         return OcrParameters;
     }
+    /** Response class returned by this product. */
     static get responseClass() {
         return OcrResponse;
     }
+    /** API slug for this product. */
     static get slug() {
         return "ocr";
     }

package/src/v2/product/ocr/ocrInference.d.ts

@@ -1,11 +1,13 @@
 import { StringDict } from "../../../parsing/index.js";
 import { BaseInference } from "../../../v2/parsing/inference/baseInference.js";
 import { OcrResult } from "../../../v2/product/ocr/ocrResult.js";
+/** Inference payload for OCR responses. */
 export declare class OcrInference extends BaseInference {
     /**
      * Result of an OCR inference.
      */
     result: OcrResult;
     constructor(serverResponse: StringDict);
+    /** Returns a readable representation of OCR inference output. */
     toString(): string;
 }

package/src/v2/product/ocr/ocrInference.js

@@ -1,10 +1,12 @@
 import { BaseInference } from "../../../v2/parsing/inference/baseInference.js";
 import { OcrResult } from "../../../v2/product/ocr/ocrResult.js";
+/** Inference payload for OCR responses. */
 export class OcrInference extends BaseInference {
     constructor(serverResponse) {
         super(serverResponse);
         this.result = new OcrResult(serverResponse["result"]);
     }
+    /** Returns a readable representation of OCR inference output. */
     toString() {
         return ("Inference\n" +
             "#########\n" +

package/src/v2/product/ocr/ocrPage.d.ts

@@ -1,5 +1,6 @@
 import { OcrWord } from "./ocrWord.js";
 import { StringDict } from "../../../parsing/index.js";
+/** OCR payload for a single page. */
 export declare class OcrPage {
     /**
      * List of words extracted from the document page.
@@ -10,5 +11,6 @@ export declare class OcrPage {
      */
     content: string;
     constructor(serverResponse: StringDict);
+    /** Returns a readable representation of page OCR content. */
     toString(): string;
 }

package/src/v2/product/ocr/ocrPage.js

@@ -1,9 +1,11 @@
 import { OcrWord } from "./ocrWord.js";
+/** OCR payload for a single page. */
 export class OcrPage {
     constructor(serverResponse) {
         this.words = serverResponse["words"].map(word => new OcrWord(word));
         this.content = serverResponse["content"];
     }
+    /** Returns a readable representation of page OCR content. */
     toString() {
         let ocrWords = "\n";
         if (this.words.length > 0) {

package/src/v2/product/ocr/ocrResponse.d.ts

@@ -1,6 +1,7 @@
 import { StringDict } from "../../../parsing/stringDict.js";
 import { OcrInference } from "./ocrInference.js";
 import { BaseResponse } from "../../../v2/parsing/index.js";
+/** Response wrapper for OCR product calls. */
 export declare class OcrResponse extends BaseResponse {
     /**
      * Response for an OCR utility inference.

package/src/v2/product/ocr/ocrResponse.js

@@ -1,5 +1,6 @@
 import { OcrInference } from "./ocrInference.js";
 import { BaseResponse } from "../../../v2/parsing/index.js";
+/** Response wrapper for OCR product calls. */
 export class OcrResponse extends BaseResponse {
     /**
      * @param serverResponse JSON response from the server.

package/src/v2/product/ocr/ocrResult.d.ts

@@ -9,5 +9,6 @@ export declare class OcrResult {
      */
     pages: OcrPage[];
     constructor(serverResponse: StringDict);
+    /** Returns a readable OCR summary for all pages. */
     toString(): string;
 }

package/src/v2/product/ocr/ocrResult.js

@@ -6,6 +6,7 @@ export class OcrResult {
     constructor(serverResponse) {
         this.pages = serverResponse.pages.map((ocr) => new OcrPage(ocr));
     }
+    /** Returns a readable OCR summary for all pages. */
     toString() {
         let pages = "\n";
         if (this.pages.length > 0) {

package/src/v2/product/ocr/ocrWord.d.ts

@@ -1,5 +1,6 @@
 import { Polygon } from "../../../geometry/index.js";
 import { StringDict } from "../../../parsing/index.js";
+/** OCR word token with geometry. */
 export declare class OcrWord {
     /**
      * Text content of the word.
@@ -10,5 +11,6 @@ export declare class OcrWord {
      */
     polygon: Polygon;
     constructor(serverResponse: StringDict);
+    /** Returns the OCR token text. */
     toString(): string;
 }

package/src/v2/product/ocr/ocrWord.js

@@ -1,9 +1,11 @@
 import { Polygon } from "../../../geometry/index.js";
+/** OCR word token with geometry. */
 export class OcrWord {
     constructor(serverResponse) {
         this.content = serverResponse["content"];
         this.polygon = new Polygon(...serverResponse["polygon"]);
     }
+    /** Returns the OCR token text. */
     toString() {
         return this.content;
     }

package/src/v2/product/split/split.d.ts

@@ -5,7 +5,10 @@ import { BaseProduct } from "../../../v2/product/baseProduct.js";
  * Break a multipage source file into separate documents, associating a class for each one.
  */
 export declare class Split extends BaseProduct {
+    /** Parameter class accepted by this product. */
     static get parametersClass(): typeof SplitParameters;
+    /** Response class returned by this product. */
     static get responseClass(): typeof SplitResponse;
+    /** API slug for this product. */
     static get slug(): string;
 }

package/src/v2/product/split/split.js

@@ -5,12 +5,15 @@ import { BaseProduct } from "../../../v2/product/baseProduct.js";
  * Break a multipage source file into separate documents, associating a class for each one.
  */
 export class Split extends BaseProduct {
+    /** Parameter class accepted by this product. */
     static get parametersClass() {
         return SplitParameters;
     }
+    /** Response class returned by this product. */
     static get responseClass() {
         return SplitResponse;
     }
+    /** API slug for this product. */
     static get slug() {
         return "split";
     }

package/src/v2/product/split/splitInference.d.ts

@@ -1,11 +1,13 @@
 import { StringDict } from "../../../parsing/index.js";
 import { BaseInference } from "../../../v2/parsing/inference/baseInference.js";
 import { SplitResult } from "./splitResult.js";
+/** Inference payload for split responses. */
 export declare class SplitInference extends BaseInference {
     /**
      * Result of a split inference.
      */
     result: SplitResult;
     constructor(serverResponse: StringDict);
+    /** Returns a readable representation of the split inference. */
     toString(): string;
 }

package/src/v2/product/split/splitInference.js

@@ -1,10 +1,12 @@
 import { BaseInference } from "../../../v2/parsing/inference/baseInference.js";
 import { SplitResult } from "./splitResult.js";
+/** Inference payload for split responses. */
 export class SplitInference extends BaseInference {
     constructor(serverResponse) {
         super(serverResponse);
         this.result = new SplitResult(serverResponse["result"]);
     }
+    /** Returns a readable representation of the split inference. */
     toString() {
         return (super.toString() +
             this.result.toString() + "\n");

package/src/v2/product/split/splitRange.d.ts

@@ -20,6 +20,7 @@ export declare class SplitRange {
      */
     extractionResponse?: ExtractionResponse;
     constructor(serverResponse: StringDict);
+    /** Returns a readable summary of the split range. */
     toString(): string;
     /**
      * Extracts a single split from the input file.

package/src/v2/product/split/splitRange.js

@@ -11,6 +11,7 @@ export class SplitRange {
             ? new ExtractionResponse(serverResponse["extraction_response"])
             : undefined;
     }
+    /** Returns a readable summary of the split range. */
     toString() {
         const pageRange = this.pageRange.join(",");
         return `* :Page Range: ${pageRange}\n  :Document Type: ${this.documentType}`;

package/src/v2/product/split/splitResponse.d.ts

@@ -1,6 +1,7 @@
 import { StringDict } from "../../../parsing/stringDict.js";
 import { SplitInference } from "./splitInference.js";
 import { BaseResponse } from "../../../v2/parsing/index.js";
+/** Response wrapper for split product calls. */
 export declare class SplitResponse extends BaseResponse {
     /**
      * Response for an OCR utility inference.

package/src/v2/product/split/splitResponse.js

@@ -1,5 +1,6 @@
 import { SplitInference } from "./splitInference.js";
 import { BaseResponse } from "../../../v2/parsing/index.js";
+/** Response wrapper for split product calls. */
 export class SplitResponse extends BaseResponse {
     /**
      * @param serverResponse JSON response from the server.

package/src/v2/product/split/splitResult.d.ts

@@ -16,5 +16,6 @@ export declare class SplitResult {
      * @param inputSource The input file to extract from.
      */
     extractFromInputSource(inputSource: LocalInputSource): Promise<ExtractedPdfs>;
+    /** Returns a readable list of split ranges. */
     toString(): string;
 }

package/src/v2/product/split/splitResult.js

@@ -18,6 +18,7 @@ export class SplitResult {
         }
         return await extractMultipleSplits(inputSource, splits);
     }
+    /** Returns a readable list of split ranges. */
     toString() {
         let splits = "\n";
         if (this.splits.length > 0) {