mindee 5.9.0 → 5.10.0

package/src/v2/parsing/inference/field/rawText.d.ts

@@ -1,12 +1,16 @@
 import { StringDict } from "../../../../parsing/stringDict.js";
 import { RawTextPage } from "./rawTextPage.js";
-/** Full raw OCR text grouped by page. */
+/**
+ * Full raw OCR text grouped by page.
+ */
 export declare class RawText {
     /**
      * List of pages with their extracted text content.
      */
     pages: Array<RawTextPage>;
     constructor(serverResponse: StringDict);
-    /** Returns concatenated raw text for all pages. */
+    /**
+     * Returns concatenated raw text for all pages.
+     */
     toString(): string;
 }

package/src/v2/parsing/inference/field/rawText.js

@@ -1,10 +1,14 @@
 import { RawTextPage } from "./rawTextPage.js";
-/** Full raw OCR text grouped by page. */
+/**
+ * Full raw OCR text grouped by page.
+ */
 export class RawText {
     constructor(serverResponse) {
         this.pages = serverResponse["pages"] ? serverResponse["pages"].map((rawTextPage) => new RawTextPage(rawTextPage)) : [];
     }
-    /** Returns concatenated raw text for all pages. */
+    /**
+     * Returns concatenated raw text for all pages.
+     */
     toString() {
         return this.pages.map(page => page.toString()).join("\n\n");
     }

package/src/v2/parsing/inference/field/simpleField.d.ts

@@ -1,6 +1,8 @@
 import { StringDict } from "../../../../parsing/stringDict.js";
 import { BaseField } from "./baseField.js";
-/** Scalar inference field. */
+/**
+ * Scalar inference field.
+ */
 export declare class SimpleField extends BaseField {
     /**
      * The untyped value of the field.
@@ -24,6 +26,8 @@ export declare class SimpleField extends BaseField {
      * Retrieves a boolean field value as a boolean.
      */
     get booleanValue(): boolean | null;
-    /** Returns a readable scalar representation. */
+    /**
+     * Returns a readable scalar representation.
+     */
     toString(): string;
 }

package/src/v2/parsing/inference/field/simpleField.js

@@ -1,10 +1,12 @@
 import { BaseField } from "./baseField.js";
-/** Scalar inference field. */
+/**
+ * Scalar inference field.
+ */
 export class SimpleField extends BaseField {
     constructor(serverResponse, indentLevel = 0) {
         super(serverResponse, indentLevel);
-        this.value =
-            serverResponse["value"] !== undefined ? serverResponse["value"] : null;
+        this.value = serverResponse["value"] === undefined
+            ? null : serverResponse["value"];
     }
     /**
      * Retrieves a string field value as a string.
@@ -33,7 +35,9 @@ export class SimpleField extends BaseField {
         }
         return this.value;
     }
-    /** Returns a readable scalar representation. */
+    /**
+     * Returns a readable scalar representation.
+     */
     toString() {
         if (this.value === null) {
             return "";

package/src/v2/parsing/inference/inferenceFile.d.ts

@@ -1,5 +1,7 @@
 import { StringDict } from "../../../parsing/stringDict.js";
-/** File metadata attached to a v2 inference. */
+/**
+ * File metadata attached to a v2 inference.
+ */
 export declare class InferenceFile {
     /**
      * Name of the file.
@@ -18,6 +20,8 @@ export declare class InferenceFile {
      */
     mimeType: string;
     constructor(serverResponse: StringDict);
-    /** Returns a printable representation of file metadata. */
+    /**
+     * Returns a printable representation of file metadata.
+     */
     toString(): string;
 }

package/src/v2/parsing/inference/inferenceFile.js

@@ -1,4 +1,6 @@
-/** File metadata attached to a v2 inference. */
+/**
+ * File metadata attached to a v2 inference.
+ */
 export class InferenceFile {
     constructor(serverResponse) {
         this.name = serverResponse["name"];
@@ -6,7 +8,9 @@ export class InferenceFile {
         this.pageCount = serverResponse["page_count"];
         this.mimeType = serverResponse["mime_type"];
     }
-    /** Returns a printable representation of file metadata. */
+    /**
+     * Returns a printable representation of file metadata.
+     */
     toString() {
         return ("File\n" +
             "====\n" +

package/src/v2/parsing/inference/inferenceModel.d.ts

@@ -1,11 +1,15 @@
 import { StringDict } from "../../../parsing/stringDict.js";
-/** Model metadata attached to a v2 inference. */
+/**
+ * Model metadata attached to a v2 inference.
+ */
 export declare class InferenceModel {
     /**
      * ID of the model.
      */
     id: string;
     constructor(serverResponse: StringDict);
-    /** Returns a printable representation of model metadata. */
+    /**
+     * Returns a printable representation of model metadata.
+     */
     toString(): string;
 }

package/src/v2/parsing/inference/inferenceModel.js

@@ -1,9 +1,13 @@
-/** Model metadata attached to a v2 inference. */
+/**
+ * Model metadata attached to a v2 inference.
+ */
 export class InferenceModel {
     constructor(serverResponse) {
         this.id = serverResponse["id"];
     }
-    /** Returns a printable representation of model metadata. */
+    /**
+     * Returns a printable representation of model metadata.
+     */
     toString() {
         return "Model\n" +
             "=====\n" +

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

@@ -5,10 +5,16 @@ import { BaseProduct } from "../baseProduct.js";
  * Automatically sort any image or scanned document into categories.
  */
 export declare class Classification extends BaseProduct {
-    /** @inheritDoc */
+    /**
+     * @inheritDoc
+     */
     static get parametersClass(): typeof ClassificationParameters;
-    /** @inheritDoc */
+    /**
+     * @inheritDoc
+     */
     static get responseClass(): typeof ClassificationResponse;
-    /** @inheritDoc */
+    /**
+     * @inheritDoc
+     */
     static get slug(): string;
 }

package/src/v2/product/classification/classification.js

@@ -5,15 +5,21 @@ import { BaseProduct } from "../baseProduct.js";
  * Automatically sort any image or scanned document into categories.
  */
 export class Classification extends BaseProduct {
-    /** @inheritDoc */
+    /**
+     * @inheritDoc
+     */
     static get parametersClass() {
         return ClassificationParameters;
     }
-    /** @inheritDoc */
+    /**
+     * @inheritDoc
+     */
     static get responseClass() {
         return ClassificationResponse;
     }
-    /** @inheritDoc */
+    /**
+     * @inheritDoc
+     */
     static get slug() {
         return "classification";
     }

package/src/v2/product/classification/classificationClassifier.d.ts

@@ -3,7 +3,9 @@ import { ExtractionResponse } from "../index.js";
 /**
  * Document level classification.
  */
-/** Classifier output for document-level classification. */
+/**
+ * Classifier output for document-level classification.
+ */
 export declare class ClassificationClassifier {
     /**
      * The document type, as identified on given classification values.
@@ -14,6 +16,8 @@ export declare class ClassificationClassifier {
      */
     extractionResponse?: ExtractionResponse;
     constructor(serverResponse: StringDict);
-    /** Returns a readable classifier summary. */
+    /**
+     * Returns a readable classifier summary.
+     */
     toString(): string;
 }

package/src/v2/product/classification/classificationClassifier.js

@@ -2,7 +2,9 @@ import { ExtractionResponse } from "../index.js";
 /**
  * Document level classification.
  */
-/** Classifier output for document-level classification. */
+/**
+ * Classifier output for document-level classification.
+ */
 export class ClassificationClassifier {
     constructor(serverResponse) {
         this.documentType = serverResponse["document_type"];
@@ -10,7 +12,9 @@ export class ClassificationClassifier {
             ? new ExtractionResponse(serverResponse["extraction_response"])
             : undefined;
     }
-    /** Returns a readable classifier summary. */
+    /**
+     * Returns a readable classifier summary.
+     */
     toString() {
         return `Document Type: ${this.documentType}`;
     }

package/src/v2/product/classification/classificationInference.d.ts

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

package/src/v2/product/classification/classificationInference.js

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

package/src/v2/product/classification/classificationResponse.d.ts

@@ -1,7 +1,9 @@
 import { StringDict } from "../../../parsing/stringDict.js";
 import { ClassificationInference } from "./classificationInference.js";
 import { BaseResponse } from "../../parsing/index.js";
-/** Response wrapper for classification product calls. */
+/**
+ * Response wrapper for classification product calls.
+ */
 export declare class ClassificationResponse extends BaseResponse {
     /**
      * The inference result for a classification utility request.

package/src/v2/product/classification/classificationResponse.js

@@ -1,6 +1,8 @@
 import { ClassificationInference } from "./classificationInference.js";
 import { BaseResponse } from "../../parsing/index.js";
-/** Response wrapper for classification product calls. */
+/**
+ * Response wrapper for classification product calls.
+ */
 export class ClassificationResponse extends BaseResponse {
     /**
      * @param serverResponse JSON response from the server.

package/src/v2/product/classification/classificationResult.d.ts

@@ -1,12 +1,16 @@
 import { StringDict } from "../../../parsing/stringDict.js";
 import { ClassificationClassifier } from "./classificationClassifier.js";
-/** Classification section of a classification inference result. */
+/**
+ * Classification section of a classification inference result.
+ */
 export declare class ClassificationResult {
     /**
      * Fields contained in the inference.
      */
     classification: ClassificationClassifier;
     constructor(serverResponse: StringDict);
-    /** Returns a readable classification summary. */
+    /**
+     * Returns a readable classification summary.
+     */
     toString(): string;
 }

package/src/v2/product/classification/classificationResult.js

@@ -1,10 +1,14 @@
 import { ClassificationClassifier } from "./classificationClassifier.js";
-/** Classification section of a classification inference result. */
+/**
+ * Classification section of a classification inference result.
+ */
 export class ClassificationResult {
     constructor(serverResponse) {
         this.classification = new ClassificationClassifier(serverResponse["classification"]);
     }
-    /** Returns a readable classification summary. */
+    /**
+     * Returns a readable classification summary.
+     */
     toString() {
         return `Classification\n==============\n${this.classification}`;
     }

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

@@ -5,10 +5,16 @@ import { BaseProduct } from "../baseProduct.js";
  * Identify the borders of documents on each page, matching each one to a category.
  */
 export declare class Crop extends BaseProduct {
-    /** @inheritDoc */
+    /**
+     * @inheritDoc
+     */
     static get parametersClass(): typeof CropParameters;
-    /** @inheritDoc */
+    /**
+     * @inheritDoc
+     */
     static get responseClass(): typeof CropResponse;
-    /** @inheritDoc */
+    /**
+     * @inheritDoc
+     */
     static get slug(): string;
 }

package/src/v2/product/crop/crop.js

@@ -5,15 +5,21 @@ import { BaseProduct } from "../baseProduct.js";
  * Identify the borders of documents on each page, matching each one to a category.
  */
 export class Crop extends BaseProduct {
-    /** @inheritDoc */
+    /**
+     * @inheritDoc
+     */
     static get parametersClass() {
         return CropParameters;
     }
-    /** @inheritDoc */
+    /**
+     * @inheritDoc
+     */
     static get responseClass() {
         return CropResponse;
     }
-    /** @inheritDoc */
+    /**
+     * @inheritDoc
+     */
     static get slug() {
         return "crop";
     }

package/src/v2/product/crop/cropInference.d.ts

@@ -1,13 +1,17 @@
 import { StringDict } from "../../../parsing/index.js";
 import { BaseInference } from "../../parsing/inference/baseInference.js";
 import { CropResult } from "./cropResult.js";
-/** Inference payload for crop responses. */
+/**
+ * Inference payload for crop responses.
+ */
 export declare class CropInference extends BaseInference {
     /**
      * Result of a crop utility inference.
      */
     result: CropResult;
     constructor(serverResponse: StringDict);
-    /** Returns a readable representation of the inference. */
+    /**
+     * Returns a readable representation of the inference.
+     */
     toString(): string;
 }

package/src/v2/product/crop/cropInference.js

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

package/src/v2/product/crop/cropItem.d.ts

@@ -3,7 +3,9 @@ import { StringDict } from "../../../parsing/index.js";
 import { LocalInputSource } from "../../../input/index.js";
 import { ExtractedImage } from "../../../image/index.js";
 import { ExtractionResponse } from "../index.js";
-/** Single crop detection returned by the crop product. */
+/**
+ * Single crop detection returned by the crop product.
+ */
 export declare class CropItem {
     /**
      * Type or classification of the detected object.
@@ -18,7 +20,9 @@ export declare class CropItem {
      */
     extractionResponse?: ExtractionResponse;
     constructor(serverResponse: StringDict);
-    /** Returns a readable crop item summary. */
+    /**
+     * Returns a readable crop item summary.
+     */
     toString(): string;
     /**
      * Extracts a single crop from an input.

package/src/v2/product/crop/cropItem.js

@@ -1,7 +1,9 @@
 import { FieldLocation } from "../../parsing/inference/field/index.js";
 import { extractSingleCrop } from "../../fileOperations/crop.js";
 import { ExtractionResponse } from "../index.js";
-/** Single crop detection returned by the crop product. */
+/**
+ * Single crop detection returned by the crop product.
+ */
 export class CropItem {
     constructor(serverResponse) {
         this.objectType = serverResponse["object_type"];
@@ -10,7 +12,9 @@ export class CropItem {
             ? new ExtractionResponse(serverResponse["extraction_response"])
             : undefined;
     }
-    /** Returns a readable crop item summary. */
+    /**
+     * Returns a readable crop item summary.
+     */
     toString() {
         return `* :Location: ${this.location}\n  :Object Type: ${this.objectType}`;
     }

package/src/v2/product/crop/cropResponse.d.ts

@@ -1,7 +1,9 @@
 import { StringDict } from "../../../parsing/stringDict.js";
 import { BaseResponse } from "../../parsing/index.js";
 import { CropInference } from "./cropInference.js";
-/** Response wrapper for crop product calls. */
+/**
+ * Response wrapper for crop product calls.
+ */
 export declare class CropResponse extends BaseResponse {
     /**
      * Response for a crop utility inference.

package/src/v2/product/crop/cropResponse.js

@@ -1,6 +1,8 @@
 import { BaseResponse } from "../../parsing/index.js";
 import { CropInference } from "./cropInference.js";
-/** Response wrapper for crop product calls. */
+/**
+ * Response wrapper for crop product calls.
+ */
 export class CropResponse extends BaseResponse {
     /**
      * @param serverResponse JSON response from the server.

package/src/v2/product/crop/cropResult.d.ts

@@ -2,14 +2,18 @@ import { StringDict } from "../../../parsing/stringDict.js";
 import { CropItem } from "./cropItem.js";
 import { LocalInputSource } from "../../../input/index.js";
 import { ExtractedImages } from "../../../image/extractedImages.js";
-/** Crop section of a crop inference result. */
+/**
+ * Crop section of a crop inference result.
+ */
 export declare class CropResult {
     /**
      * Fields contained in the inference.
      */
     crops: CropItem[];
     constructor(serverResponse: StringDict);
-    /** Returns a readable list of detected crops. */
+    /**
+     * Returns a readable list of detected crops.
+     */
     toString(): string;
     /**
      * Extracts a single crop from an input.

package/src/v2/product/crop/cropResult.js

@@ -1,6 +1,8 @@
 import { CropItem } from "./cropItem.js";
 import { extractMultipleCrops } from "../../fileOperations/crop.js";
-/** Crop section of a crop inference result. */
+/**
+ * Crop section of a crop inference result.
+ */
 export class CropResult {
     constructor(serverResponse) {
         /**
@@ -9,7 +11,9 @@ export class CropResult {
         this.crops = [];
         this.crops = serverResponse["crops"].map((cropItem) => new CropItem(cropItem));
     }
-    /** Returns a readable list of detected crops. */
+    /**
+     * Returns a readable list of detected crops.
+     */
     toString() {
         const crops = this.crops.map(item => item.toString()).join("\n");
         return `Crops\n=====\n${crops}`;

package/src/v2/product/extraction/dataSchemaActiveOption.d.ts

@@ -8,6 +8,8 @@ export declare class DataSchemaActiveOption {
      */
     replace: boolean;
     constructor(serverResponse: StringDict);
-    /** Returns a readable representation of active data schema options. */
+    /**
+     * Returns a readable representation of active data schema options.
+     */
     toString(): string;
 }

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

@@ -5,7 +5,9 @@ export class DataSchemaActiveOption {
     constructor(serverResponse) {
         this.replace = serverResponse["replace"];
     }
-    /** Returns a readable representation of active data schema options. */
+    /**
+     * Returns a readable representation of active data schema options.
+     */
     toString() {
         return `Data Schema\n-----------\n:Replace: ${this.replace ? "True" : "False"}`;
     }

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

@@ -7,16 +7,28 @@ import { RagDocumentAnnotationParameters, RagDocumentUploadParameters } from "./
  * Automatically extract structured data from any image or scanned document.
  */
 export declare class Extraction extends BaseProduct {
-    /** @inheritDoc */
+    /**
+     * @inheritDoc
+     */
     static get slug(): string;
-    /** @inheritDoc */
+    /**
+     * @inheritDoc
+     */
     static get parametersClass(): typeof ExtractionParameters;
-    /** @inheritDoc */
+    /**
+     * @inheritDoc
+     */
     static get responseClass(): typeof ExtractionResponse;
-    /** @inheritDoc */
+    /**
+     * @inheritDoc
+     */
     static get annotationResponseClass(): typeof ExtractionRagAnnotationResponse;
-    /** @inheritDoc */
+    /**
+     * @inheritDoc
+     */
     static get annotationParametersClass(): typeof RagDocumentAnnotationParameters;
-    /** @inheritDoc */
+    /**
+     * @inheritDoc
+     */
     static get ragDocumentUploadClass(): typeof RagDocumentUploadParameters;
 }

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

@@ -7,27 +7,39 @@ import { RagDocumentAnnotationParameters, RagDocumentUploadParameters } from "./
  * Automatically extract structured data from any image or scanned document.
  */
 export class Extraction extends BaseProduct {
-    /** @inheritDoc */
+    /**
+     * @inheritDoc
+     */
     static get slug() {
         return "extraction";
     }
-    /** @inheritDoc */
+    /**
+     * @inheritDoc
+     */
     static get parametersClass() {
         return ExtractionParameters;
     }
-    /** @inheritDoc */
+    /**
+     * @inheritDoc
+     */
     static get responseClass() {
         return ExtractionResponse;
     }
-    /** @inheritDoc */
+    /**
+     * @inheritDoc
+     */
     static get annotationResponseClass() {
         return ExtractionRagAnnotationResponse;
     }
-    /** @inheritDoc */
+    /**
+     * @inheritDoc
+     */
     static get annotationParametersClass() {
         return RagDocumentAnnotationParameters;
     }
-    /** @inheritDoc */
+    /**
+     * @inheritDoc
+     */
     static get ragDocumentUploadClass() {
         return RagDocumentUploadParameters;
     }