mindee 5.5.0 → 5.6.1

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

@@ -1,4 +1,5 @@
 import { createField } from "./fieldFactory.js";
+/** Typed map of extraction fields returned by the API. */
 export class InferenceFields extends Map {
     constructor(serverResponse, indentLevel = 0) {
         super(Object.entries(serverResponse).map(([key, value]) => {
@@ -6,6 +7,7 @@ export class InferenceFields extends Map {
         }));
         this._indentLevel = indentLevel;
     }
+    /** Returns a field as a `SimpleField`, or throws if the type mismatches. */
     getSimpleField(fieldName) {
         const field = this.get(fieldName);
         if (field === undefined) {
@@ -16,6 +18,7 @@ export class InferenceFields extends Map {
         }
         return field;
     }
+    /** Returns a field as an `ObjectField`, or throws if the type mismatches. */
     getObjectField(fieldName) {
         const field = this.get(fieldName);
         if (field === undefined) {
@@ -26,6 +29,7 @@ export class InferenceFields extends Map {
         }
         return field;
     }
+    /** Returns a field as a `ListField`, or throws if the type mismatches. */
     getListField(fieldName) {
         const field = this.get(fieldName);
         if (field === undefined) {

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

@@ -2,6 +2,7 @@ import { StringDict } from "../../../../parsing/stringDict.js";
 import { BaseField } from "./baseField.js";
 import { ObjectField } from "./objectField.js";
 import { SimpleField } from "./simpleField.js";
+/** List-valued inference field. */
 export declare class ListField extends BaseField {
     /**
      * Items contained in the list.
@@ -16,5 +17,6 @@ export declare class ListField extends BaseField {
      */
     get objectItems(): Array<ObjectField>;
     constructor(serverResponse: StringDict, indentLevel?: number);
+    /** Returns a readable representation of list items. */
     toString(): string;
 }

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

@@ -3,6 +3,7 @@ import { BaseField } from "./baseField.js";
 import { ObjectField } from "./objectField.js";
 import { SimpleField } from "./simpleField.js";
 import { createField } from "./fieldFactory.js";
+/** List-valued inference field. */
 export class ListField extends BaseField {
     /**
      * SimpleField items from the list.
@@ -43,6 +44,7 @@ export class ListField extends BaseField {
             return createField(item, indentLevel + 1);
         });
     }
+    /** Returns a readable representation of list items. */
     toString() {
         if (!this.items || this.items.length === 0) {
             return "\n";

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

@@ -3,7 +3,9 @@ import { StringDict } from "../../../../parsing/stringDict.js";
 import { BaseField } from "./baseField.js";
 import type { SimpleField } from "./simpleField.js";
 import type { ListField } from "./listField.js";
+/** Object-valued inference field. */
 export declare class ObjectField extends BaseField {
+    /** Nested fields carried by this object. */
     readonly fields: InferenceFields;
     /**
      * Retrieves the simple sub-fields in the object.
@@ -48,6 +50,8 @@ export declare class ObjectField extends BaseField {
      */
     getObjectField(fieldName: string): ObjectField;
     constructor(serverResponse: StringDict, indentLevel?: number);
+    /** Returns a readable representation of nested fields. */
     toString(): string;
+    /** Returns a compact representation suitable for list items. */
     toStringFromList(): string;
 }

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

@@ -1,5 +1,6 @@
 import { InferenceFields } from "./inferenceFields.js";
 import { BaseField } from "./baseField.js";
+/** Object-valued inference field. */
 export class ObjectField extends BaseField {
     /**
      * Retrieves the simple sub-fields in the object.
@@ -95,9 +96,11 @@ export class ObjectField extends BaseField {
         super(serverResponse, indentLevel);
         this.fields = new InferenceFields(serverResponse["fields"], this._indentLevel + 1);
     }
+    /** Returns a readable representation of nested fields. */
     toString() {
         return "\n" + (this.fields ? this.fields.toString(1) : "");
     }
+    /** Returns a compact representation suitable for list items. */
     toStringFromList() {
         return this.fields ? this.fields.toString(2).substring(4) : "";
     }

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

@@ -1,4 +1,5 @@
 import { StringDict } from "../../../../parsing/stringDict.js";
+/** Metadata produced by RAG-enabled extraction. */
 export declare class RagMetadata {
     /**
      * The UUID of the matched document used during the RAG operation.

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

@@ -1,3 +1,4 @@
+/** Metadata produced by RAG-enabled extraction. */
 export class RagMetadata {
     constructor(serverResponse) {
         this.retrievedDocumentId = serverResponse["retrieved_document_id"] ?? undefined;

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

@@ -1,10 +1,12 @@
 import { StringDict } from "../../../../parsing/stringDict.js";
 import { RawTextPage } from "./rawTextPage.js";
+/** 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. */
     toString(): string;
 }

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

@@ -1,8 +1,10 @@
 import { RawTextPage } from "./rawTextPage.js";
+/** 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. */
     toString() {
         return this.pages.map(page => page.toString()).join("\n\n");
     }

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

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

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

@@ -1,4 +1,5 @@
 import { BaseField } from "./baseField.js";
+/** Scalar inference field. */
 export class SimpleField extends BaseField {
     constructor(serverResponse, indentLevel = 0) {
         super(serverResponse, indentLevel);
@@ -32,6 +33,7 @@ export class SimpleField extends BaseField {
         }
         return this.value;
     }
+    /** Returns a readable scalar representation. */
     toString() {
         if (this.value === null) {
             return "";

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

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

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

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

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

@@ -1,9 +1,11 @@
 import { StringDict } from "../../../parsing/stringDict.js";
+/** 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. */
     toString(): string;
 }

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

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

package/src/v2/parsing/job/job.d.ts

@@ -36,7 +36,7 @@ export declare class Job {
     /**
      * Status of the job.
      */
-    status?: string;
+    status: string;
     /**
      * URL to poll for the job status.
      */

package/src/v2/parsing/job/job.js

@@ -7,9 +7,7 @@ import { JobWebhook } from "./jobWebhook.js";
 export class Job {
     constructor(serverResponse) {
         this.id = serverResponse["id"];
-        if (serverResponse["status"] !== undefined) {
-            this.status = serverResponse["status"];
-        }
+        this.status = serverResponse["status"];
         if (serverResponse["error"]) {
             this.error = new ErrorResponse(serverResponse["error"]);
         }

package/src/v2/parsing/job/jobResponse.d.ts

@@ -1,6 +1,9 @@
 import { BaseResponse } from "../../../v2/parsing/baseResponse.js";
 import { StringDict } from "../../../parsing/stringDict.js";
 import { Job } from "./job.js";
+/**
+ * Job response class.
+ */
 export declare class JobResponse extends BaseResponse {
     /**
      * Job for the polling.

package/src/v2/parsing/job/jobResponse.js

@@ -1,5 +1,8 @@
 import { BaseResponse } from "../../../v2/parsing/baseResponse.js";
 import { Job } from "./job.js";
+/**
+ * Job response class.
+ */
 export class JobResponse extends BaseResponse {
     constructor(serverResponse) {
         super(serverResponse);

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

@@ -5,7 +5,10 @@ import { BaseProduct } from "../../../v2/product/baseProduct.js";
  * Automatically sort any image or scanned document into categories.
  */
 export declare class Classification extends BaseProduct {
+    /** Parameter class accepted by this product. */
     static get parametersClass(): typeof ClassificationParameters;
+    /** Response class returned by this product. */
     static get responseClass(): typeof ClassificationResponse;
+    /** API slug for this product. */
     static get slug(): string;
 }

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

@@ -5,12 +5,15 @@ import { BaseProduct } from "../../../v2/product/baseProduct.js";
  * Automatically sort any image or scanned document into categories.
  */
 export class Classification extends BaseProduct {
+    /** Parameter class accepted by this product. */
     static get parametersClass() {
         return ClassificationParameters;
     }
+    /** Response class returned by this product. */
     static get responseClass() {
         return ClassificationResponse;
     }
+    /** API slug for this product. */
     static get slug() {
         return "classification";
     }

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

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

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

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

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

@@ -1,11 +1,13 @@
 import { StringDict } from "../../../parsing/index.js";
 import { BaseInference } from "../../../v2/parsing/inference/baseInference.js";
 import { ClassificationResult } from "./classificationResult.js";
+/** 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. */
     toString(): string;
 }

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

@@ -1,10 +1,12 @@
 import { BaseInference } from "../../../v2/parsing/inference/baseInference.js";
 import { ClassificationResult } from "./classificationResult.js";
+/** 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. */
     toString() {
         return (super.toString() +
             this.result.toString() + "\n");

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

@@ -1,6 +1,7 @@
 import { StringDict } from "../../../parsing/stringDict.js";
 import { ClassificationInference } from "./classificationInference.js";
 import { BaseResponse } from "../../../v2/parsing/index.js";
+/** 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,5 +1,6 @@
 import { ClassificationInference } from "./classificationInference.js";
 import { BaseResponse } from "../../../v2/parsing/index.js";
+/** 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,10 +1,12 @@
 import { StringDict } from "../../../parsing/stringDict.js";
 import { ClassificationClassifier } from "./classificationClassifier.js";
+/** 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. */
     toString(): string;
 }

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

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

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

@@ -5,7 +5,10 @@ import { BaseProduct } from "../../../v2/product/baseProduct.js";
  * Identify the borders of documents on each page, matching each one to a category.
  */
 export declare class Crop extends BaseProduct {
+    /** Parameter class accepted by this product. */
     static get parametersClass(): typeof CropParameters;
+    /** Response class returned by this product. */
     static get responseClass(): typeof CropResponse;
+    /** API slug for this product. */
     static get slug(): string;
 }

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

@@ -5,12 +5,15 @@ import { BaseProduct } from "../../../v2/product/baseProduct.js";
  * Identify the borders of documents on each page, matching each one to a category.
  */
 export class Crop extends BaseProduct {
+    /** Parameter class accepted by this product. */
     static get parametersClass() {
         return CropParameters;
     }
+    /** Response class returned by this product. */
     static get responseClass() {
         return CropResponse;
     }
+    /** API slug for this product. */
     static get slug() {
         return "crop";
     }

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

@@ -1,11 +1,13 @@
 import { StringDict } from "../../../parsing/index.js";
 import { BaseInference } from "../../../v2/parsing/inference/baseInference.js";
 import { CropResult } from "../../../v2/product/crop/cropResult.js";
+/** 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. */
     toString(): string;
 }

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

@@ -1,10 +1,12 @@
 import { BaseInference } from "../../../v2/parsing/inference/baseInference.js";
 import { CropResult } from "../../../v2/product/crop/cropResult.js";
+/** 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. */
     toString() {
         return (super.toString() +
             this.result.toString() + "\n");

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

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

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

@@ -1,6 +1,7 @@
 import { FieldLocation } from "../../../v2/parsing/inference/field/index.js";
 import { extractSingleCrop } from "../../../v2/fileOperations/crop.js";
 import { ExtractionResponse } from "../../../v2/product/index.js";
+/** Single crop detection returned by the crop product. */
 export class CropItem {
     constructor(serverResponse) {
         this.objectType = serverResponse["object_type"];
@@ -9,6 +10,7 @@ export class CropItem {
             ? new ExtractionResponse(serverResponse["extraction_response"])
             : undefined;
     }
+    /** 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,6 +1,7 @@
 import { StringDict } from "../../../parsing/stringDict.js";
 import { BaseResponse } from "../../../v2/parsing/index.js";
 import { CropInference } from "./cropInference.js";
+/** 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,5 +1,6 @@
 import { BaseResponse } from "../../../v2/parsing/index.js";
 import { CropInference } from "./cropInference.js";
+/** 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,12 +2,14 @@ import { StringDict } from "../../../parsing/stringDict.js";
 import { CropItem } from "../../../v2/product/crop/cropItem.js";
 import { LocalInputSource } from "../../../input/index.js";
 import { ExtractedImages } from "../../../image/extractedImages.js";
+/** 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. */
     toString(): string;
     /**
      * Extracts a single crop from an input.

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

@@ -1,5 +1,6 @@
 import { CropItem } from "../../../v2/product/crop/cropItem.js";
 import { extractMultipleCrops } from "../../../v2/fileOperations/crop.js";
+/** Crop section of a crop inference result. */
 export class CropResult {
     constructor(serverResponse) {
         /**
@@ -8,6 +9,7 @@ export class CropResult {
         this.crops = [];
         this.crops = serverResponse["crops"].map((cropItem) => new CropItem(cropItem));
     }
+    /** 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,5 +8,6 @@ export declare class DataSchemaActiveOption {
      */
     replace: boolean;
     constructor(serverResponse: StringDict);
+    /** Returns a readable representation of active data schema options. */
     toString(): string;
 }

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

@@ -5,6 +5,7 @@ export class DataSchemaActiveOption {
     constructor(serverResponse) {
         this.replace = serverResponse["replace"];
     }
+    /** 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

@@ -5,7 +5,10 @@ import { BaseProduct } from "../../../v2/product/baseProduct.js";
  * Automatically extract structured data from any image or scanned document.
  */
 export declare class Extraction extends BaseProduct {
+    /** Parameter class accepted by this product. */
     static get parametersClass(): typeof ExtractionParameters;
+    /** Response class returned by this product. */
     static get responseClass(): typeof ExtractionResponse;
+    /** API slug for this product. */
     static get slug(): string;
 }

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

@@ -5,12 +5,15 @@ import { BaseProduct } from "../../../v2/product/baseProduct.js";
  * Automatically extract structured data from any image or scanned document.
  */
 export class Extraction extends BaseProduct {
+    /** Parameter class accepted by this product. */
     static get parametersClass() {
         return ExtractionParameters;
     }
+    /** Response class returned by this product. */
     static get responseClass() {
         return ExtractionResponse;
     }
+    /** API slug for this product. */
     static get slug() {
         return "extraction";
     }

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

@@ -1,5 +1,6 @@
 import { StringDict } from "../../../parsing/stringDict.js";
 import { DataSchemaActiveOption } from "./dataSchemaActiveOption.js";
+/** Active extraction options echoed by the API. */
 export declare class ExtractionActiveOptions {
     /**
      * Whether the RAG feature was activated.
@@ -26,5 +27,6 @@ export declare class ExtractionActiveOptions {
      */
     dataSchema: DataSchemaActiveOption;
     constructor(serverResponse: StringDict);
+    /** Returns a readable representation of active options. */
     toString(): string;
 }

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

@@ -1,4 +1,5 @@
 import { DataSchemaActiveOption } from "./dataSchemaActiveOption.js";
+/** Active extraction options echoed by the API. */
 export class ExtractionActiveOptions {
     constructor(serverResponse) {
         this.rag = serverResponse["rag"];
@@ -8,6 +9,7 @@ export class ExtractionActiveOptions {
         this.textContext = serverResponse["text_context"];
         this.dataSchema = new DataSchemaActiveOption(serverResponse["data_schema"]);
     }
+    /** Returns a readable representation of active options. */
     toString() {
         return "Active Options\n" +
             "==============\n" +

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

@@ -2,6 +2,7 @@ import { StringDict } from "../../../parsing/stringDict.js";
 import { ExtractionResult } from "./extractionResult.js";
 import { ExtractionActiveOptions } from "./extractionActiveOptions.js";
 import { BaseInference } from "../../../v2/parsing/inference/baseInference.js";
+/** Inference payload for extraction responses. */
 export declare class ExtractionInference extends BaseInference {
     /**
      * Result of the inference.
@@ -12,5 +13,6 @@ export declare class ExtractionInference extends BaseInference {
      */
     activeOptions: ExtractionActiveOptions;
     constructor(serverResponse: StringDict);
+    /** Returns a readable representation of the inference. */
     toString(): string;
 }