mindee 5.4.0 → 5.6.0

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/parsing/search/index.d.ts

@@ -0,0 +1,4 @@
+export { PaginationMetadata } from "./paginationMetadata.js";
+export { SearchModel } from "./searchModel.js";
+export { SearchResponse } from "./searchResponse.js";
+export { ModelWebhook } from "./modelWebhook.js";

package/src/v2/parsing/search/index.js

@@ -0,0 +1,4 @@
+export { PaginationMetadata } from "./paginationMetadata.js";
+export { SearchModel } from "./searchModel.js";
+export { SearchResponse } from "./searchResponse.js";
+export { ModelWebhook } from "./modelWebhook.js";

package/src/v2/parsing/search/modelWebhook.d.ts

@@ -0,0 +1,19 @@
+import { StringDict } from "../../../parsing/index.js";
+/**
+ * Model webhook info.
+ */
+export declare class ModelWebhook {
+    /**
+     * ID of the webhook.
+     */
+    id: string;
+    /**
+     * Name of the webhook.
+     */
+    name: string;
+    /**
+     * URL of the webhook.
+     */
+    url: string;
+    constructor(serverResponse: StringDict);
+}

package/src/v2/parsing/search/modelWebhook.js

@@ -0,0 +1,10 @@
+/**
+ * Model webhook info.
+ */
+export class ModelWebhook {
+    constructor(serverResponse) {
+        this.id = serverResponse["id"];
+        this.name = serverResponse["name"];
+        this.url = serverResponse["url"];
+    }
+}

package/src/v2/parsing/search/paginationMetadata.d.ts

@@ -0,0 +1,24 @@
+import { StringDict } from "../../../parsing/index.js";
+/**
+ * PaginationMetadata data associated with model search.
+ */
+export declare class PaginationMetadata {
+    /**
+     * Number of items per page.
+     */
+    perPage: number;
+    /**
+     * 1-indexed page number.
+     */
+    page: number;
+    /**
+     * Total items.
+     */
+    totalItems: number;
+    /**
+     * Total number of pages.
+     */
+    totalPages: number;
+    constructor(serverResponse: StringDict);
+    toString(): string;
+}

package/src/v2/parsing/search/paginationMetadata.js

@@ -0,0 +1,19 @@
+/**
+ * PaginationMetadata data associated with model search.
+ */
+export class PaginationMetadata {
+    constructor(serverResponse) {
+        this.perPage = serverResponse["per_page"];
+        this.page = serverResponse["page"];
+        this.totalItems = serverResponse["total_items"];
+        this.totalPages = serverResponse["total_pages"];
+    }
+    toString() {
+        return [
+            `:Per Page: ${this.perPage}`,
+            `:Page: ${this.page}`,
+            `:Total Items: ${this.totalItems}`,
+            `:Total Pages: ${this.totalPages}`,
+        ].join("\n");
+    }
+}

package/src/v2/parsing/search/searchModel.d.ts

@@ -0,0 +1,25 @@
+import { StringDict } from "../../../parsing/index.js";
+import { ModelWebhook } from "./modelWebhook.js";
+/**
+ * Models search response.
+ */
+export declare class SearchModel {
+    /**
+     * ID of the model.
+     */
+    id: string;
+    /**
+     * Name of the model.
+     */
+    name: string;
+    /**
+     * Type of the model.
+     */
+    modelType: string;
+    /**
+     * Webhooks associated with the model.
+     */
+    webhooks: ModelWebhook[];
+    constructor(serverResponse: StringDict);
+    toString(): string;
+}

package/src/v2/parsing/search/searchModel.js

@@ -0,0 +1,19 @@
+import { ModelWebhook } from "./modelWebhook.js";
+/**
+ * Models search response.
+ */
+export class SearchModel {
+    constructor(serverResponse) {
+        this.id = serverResponse["id"];
+        this.name = serverResponse["name"];
+        this.modelType = serverResponse["model_type"];
+        this.webhooks = (serverResponse["webhooks"] ?? []).map((webhook) => new ModelWebhook(webhook));
+    }
+    toString() {
+        return [
+            `:Name: ${this.name}`,
+            `:ID: ${this.id}`,
+            `:Model Type: ${this.modelType}`,
+        ].join("\n");
+    }
+}

package/src/v2/parsing/search/searchResponse.d.ts

@@ -0,0 +1,19 @@
+import { StringDict } from "../../../parsing/index.js";
+import { BaseResponse } from "../../../v2/parsing/baseResponse.js";
+import { PaginationMetadata } from "./paginationMetadata.js";
+import { SearchModel } from "./searchModel.js";
+/**
+ * Models search response.
+ */
+export declare class SearchResponse extends BaseResponse {
+    /**
+     * List of models returned by the search.
+     */
+    models: SearchModel[];
+    /**
+     * Pagination metadata.
+     */
+    pagination: PaginationMetadata;
+    constructor(serverResponse: StringDict);
+    toString(): string;
+}

package/src/v2/parsing/search/searchResponse.js

@@ -0,0 +1,24 @@
+import { BaseResponse } from "../../../v2/parsing/baseResponse.js";
+import { PaginationMetadata } from "./paginationMetadata.js";
+import { SearchModel } from "./searchModel.js";
+/**
+ * Models search response.
+ */
+export class SearchResponse extends BaseResponse {
+    constructor(serverResponse) {
+        super(serverResponse);
+        this.models = (serverResponse["models"] ?? []).map((model) => new SearchModel(model));
+        this.pagination = new PaginationMetadata(serverResponse["pagination"]);
+    }
+    toString() {
+        const lines = ["Models", "#######"];
+        for (const model of this.models) {
+            lines.push(`* :Name: ${model.name}`);
+            lines.push(`  :ID: ${model.id}`);
+            lines.push(`  :Model Type: ${model.modelType}`);
+        }
+        lines.push("Pagination", "##########");
+        lines.push(this.pagination.toString());
+        return lines.join("\n");
+    }
+}

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;
 }

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

@@ -1,12 +1,14 @@
 import { ExtractionResult } from "./extractionResult.js";
 import { ExtractionActiveOptions } from "./extractionActiveOptions.js";
 import { BaseInference } from "../../../v2/parsing/inference/baseInference.js";
+/** Inference payload for extraction responses. */
 export class ExtractionInference extends BaseInference {
     constructor(serverResponse) {
         super(serverResponse);
         this.result = new ExtractionResult(serverResponse["result"]);
         this.activeOptions = new ExtractionActiveOptions(serverResponse["active_options"]);
     }
+    /** Returns a readable representation of the inference. */
     toString() {
         return (super.toString() +
             this.activeOptions.toString() + "\n" +

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

@@ -1,6 +1,7 @@
 import { ExtractionInference } from "./extractionInference.js";
 import { StringDict } from "../../../parsing/stringDict.js";
 import { BaseResponse } from "../../../v2/parsing/index.js";
+/** Response wrapper for extraction product calls. */
 export declare class ExtractionResponse extends BaseResponse {
     /**
      * The inference result for an extraction request.

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

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

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

@@ -2,6 +2,7 @@ import { InferenceFields } from "../../../v2/parsing/inference/field/index.js";
 import { StringDict } from "../../../parsing/stringDict.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 declare class ExtractionResult {
     /**
      * Fields contained in the inference.
@@ -16,5 +17,6 @@ export declare class ExtractionResult {
      */
     rag?: RagMetadata;
     constructor(serverResponse: StringDict);
+    /** Returns a readable representation of extracted fields. */
     toString(): string;
 }