mindee 5.8.0 → 5.10.0

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

@@ -1,7 +1,13 @@
 import { InferenceFields } from "./inferenceFields.js";
 import { BaseField } from "./baseField.js";
-/** Object-valued inference field. */
+/**
+ * Object-valued inference field.
+ */
 export class ObjectField extends BaseField {
+    constructor(serverResponse, indentLevel = 0) {
+        super(serverResponse, indentLevel);
+        this.fields = new InferenceFields(serverResponse["fields"], this._indentLevel + 1);
+    }
     /**
      * Retrieves the simple sub-fields in the object.
      *
@@ -48,59 +54,41 @@ export class ObjectField extends BaseField {
      * Retrieves a SimpleField by its name if it exists and is of the correct type.
      *
      * @param {string} fieldName - The name of the field to retrieve.
-     * @return {SimpleField} The SimpleField instance if it exists and is valid, or undefined if not.
-     * @throws {Error} If the field does not exist or is not of type SimpleField.
+     * @return {SimpleField} The field instance if it exists and is valid, or undefined if not.
+     * @throws {Error} If the field does not exist or is of wrong type.
      */
     getSimpleField(fieldName) {
-        if (!this.fields.has(fieldName) && !this.simpleFields.has(fieldName)) {
-            throw new Error(`The field '${fieldName}' was not found.`);
-        }
-        if (this.fields.get(fieldName)?.constructor.name !== "SimpleField") {
-            throw new Error(`The field '${fieldName}' is not a SimpleField.`);
-        }
-        return this.simpleFields.get(fieldName);
+        return this.fields.getSimpleField(fieldName);
     }
     /**
      * Retrieves a ListField by its name if it exists and is of the correct type.
      *
      * @param {string} fieldName - The name of the field to retrieve.
-     * @return {ListField} The ListField instance if it exists and is valid, or undefined if not.
-     * @throws {Error} If the field does not exist or is not of type ListField.
+     * @return {ListField} The field instance if it exists and is valid, or undefined if not.
+     * @throws {Error} If the field does not exist or is of wrong type.
      */
     getListField(fieldName) {
-        if (!this.fields.has(fieldName) || !this.listFields.has(fieldName)) {
-            throw new Error(`The field '${fieldName}' was not found.`);
-        }
-        if (this.fields.get(fieldName)?.constructor.name !== "ListField") {
-            throw new Error(`The field '${fieldName}' is not a ListField.`);
-        }
-        return this.listFields.get(fieldName);
+        return this.fields.getListField(fieldName);
     }
     /**
      * Retrieves an ObjectField by its name if it exists and is of the correct type.
      *
      * @param {string} fieldName - The name of the field to retrieve.
-     * @return {ObjectField} The ObjectField instance if it exists and is valid, or undefined if not.
-     * @throws {Error} If the field does not exist or is not of type ObjectField.
+     * @return {ObjectField} The field instance if it exists and is valid, or undefined if not.
+     * @throws {Error} If the field does not exist or is of wrong type.
      */
     getObjectField(fieldName) {
-        if (!this.fields.has(fieldName) && !this.objectFields.has(fieldName)) {
-            throw new Error(`The field '${fieldName}' was not found.`);
-        }
-        if (this.fields.get(fieldName)?.constructor.name !== "ObjectField") {
-            throw new Error(`The field '${fieldName}' is not an ObjectField.`);
-        }
-        return this.objectFields.get(fieldName);
-    }
-    constructor(serverResponse, indentLevel = 0) {
-        super(serverResponse, indentLevel);
-        this.fields = new InferenceFields(serverResponse["fields"], this._indentLevel + 1);
+        return this.fields.getObjectField(fieldName);
     }
-    /** Returns a readable representation of nested fields. */
+    /**
+     * Returns a readable representation of nested fields.
+     */
     toString() {
         return "\n" + (this.fields ? this.fields.toString(1) : "");
     }
-    /** Returns a compact representation suitable for list items. */
+    /**
+     * 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,5 +1,7 @@
 import { StringDict } from "../../../../parsing/stringDict.js";
-/** Metadata about the RAG operation. */
+/**
+ * Metadata about the RAG operation.
+ */
 export declare class RagMetadata {
     /**
      * The UUID of the matched document used during the RAG operation.

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

@@ -1,4 +1,6 @@
-/** Metadata about the RAG operation. */
+/**
+ * Metadata about the RAG operation.
+ */
 export class RagMetadata {
     constructor(serverResponse) {
         this.retrievedDocumentId = serverResponse["retrieved_document_id"] ?? undefined;

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

@@ -1,32 +1,32 @@
 import { StringDict } from "../../../parsing/index.js";
-import { ErrorResponse } from "../../../v2/index.js";
+import { ErrorResponse } from "../../index.js";
 import { JobWebhook } from "./jobWebhook.js";
 /**
  * Job information for a V2 polling attempt.
  */
 export declare class Job {
     /**
-     * Job ID.
+     * UUID of the Job.
      */
     id: string;
     /**
-     * Error response if any.
+     * If an error occurred during processing, contains the problem details.
      */
     error?: ErrorResponse;
     /**
      * Date and time of the Job creation.
      */
-    createdAt: Date | null;
+    createdAt: Date;
     /**
      * Date and time of the Job completion. Filled once processing is finished.
      */
     completedAt: Date | null | undefined;
     /**
-     * ID of the model.
+     * UUID of the model to be used for the inference.
      */
     modelId: string;
     /**
-     * Name for the file.
+     * Name of the file sent.
      */
     filename: string;
     /**
@@ -42,11 +42,11 @@ export declare class Job {
      */
     pollingUrl: string;
     /**
-     * URL to poll for the job result, redirects to the result if available.
+     * URL to retrieve the inference results. Will be filled once the inference is ready.
      */
     resultUrl?: string;
     /**
-     * ID of webhooks associated with the job.
+     * List of responses from webhooks called. Empty until processing is finished.
      */
     webhooks: Array<JobWebhook>;
     constructor(serverResponse: StringDict);

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

@@ -1,5 +1,5 @@
 import { parseDate } from "../../../parsing/index.js";
-import { ErrorResponse } from "../../../v2/index.js";
+import { ErrorResponse } from "../../index.js";
 import { JobWebhook } from "./jobWebhook.js";
 /**
  * Job information for a V2 polling attempt.

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

@@ -1,4 +1,4 @@
-import { BaseResponse } from "../../../v2/parsing/baseResponse.js";
+import { BaseResponse } from "../baseResponse.js";
 import { StringDict } from "../../../parsing/stringDict.js";
 import { Job } from "./job.js";
 /**

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

@@ -1,4 +1,4 @@
-import { BaseResponse } from "../../../v2/parsing/baseResponse.js";
+import { BaseResponse } from "../baseResponse.js";
 import { Job } from "./job.js";
 /**
  * Job response class.

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

@@ -1,4 +1,4 @@
-import { ErrorResponse } from "../../../v2/parsing/index.js";
+import { ErrorResponse } from "../index.js";
 import { StringDict } from "../../../parsing/index.js";
 /**
  * JobWebhook information.

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

@@ -1,4 +1,4 @@
-import { ErrorResponse } from "../../../v2/parsing/index.js";
+import { ErrorResponse } from "../index.js";
 import { parseDate } from "../../../parsing/index.js";
 /**
  * JobWebhook information.

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

@@ -1,5 +1,5 @@
 import { StringDict } from "../../../parsing/index.js";
-import { BaseResponse } from "../../../v2/parsing/baseResponse.js";
+import { BaseResponse } from "../baseResponse.js";
 import { PaginationMetadata } from "./paginationMetadata.js";
 /**
  * Base class for search responses.

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

@@ -1,4 +1,4 @@
-import { BaseResponse } from "../../../v2/parsing/baseResponse.js";
+import { BaseResponse } from "../baseResponse.js";
 import { PaginationMetadata } from "./paginationMetadata.js";
 /**
  * Base class for search responses.

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

@@ -1,4 +1,4 @@
-import { SearchModel } from "../../../v2/parsing/search/searchModel.js";
+import { SearchModel } from "./searchModel.js";
 import { StringDict } from "../../../parsing/index.js";
 /**
  * List of search models.

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

@@ -1,4 +1,4 @@
-import { SearchModel } from "../../../v2/parsing/search/searchModel.js";
+import { SearchModel } from "./searchModel.js";
 /**
  * List of search models.
  */

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

@@ -1,4 +1,4 @@
-import { SearchRagDocument } from "../../../v2/parsing/search/searchRagDocument.js";
+import { SearchRagDocument } from "./searchRagDocument.js";
 import { StringDict } from "../../../parsing/index.js";
 /**
  * List of RAG documents.

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

@@ -1,4 +1,4 @@
-import { SearchRagDocument } from "../../../v2/parsing/search/searchRagDocument.js";
+import { SearchRagDocument } from "./searchRagDocument.js";
 /**
  * List of RAG documents.
  */

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

@@ -1,5 +1,5 @@
 import { StringDict } from "../../../parsing/index.js";
-import { ModelSearchResponse } from "../../../v2/search/models/modelSearchResponse.js";
+import { ModelSearchResponse } from "../../search/models/modelSearchResponse.js";
 /**
  * Models search response.
  * @deprecated Use `ModelSearchResponse` instead.

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

@@ -1,4 +1,4 @@
-import { ModelSearchResponse } from "../../../v2/search/models/modelSearchResponse.js";
+import { ModelSearchResponse } from "../../search/models/modelSearchResponse.js";
 /**
  * Models search response.
  * @deprecated Use `ModelSearchResponse` instead.

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

@@ -1,15 +1,35 @@
-import { BaseProductParameters } from "../../v2/index.js";
-import { ResponseConstructor } from "../../v2/parsing/index.js";
+import { BaseProductParameters } from "../index.js";
+import { ResponseConstructor, AnnotationResponseConstructor } from "../parsing/index.js";
+import { BaseAnnotationParameters } from "../clientOptions/index.js";
+import { BaseRagDocumentUploadParameters } from "../clientOptions/index.js";
 /**
  * Base class for all V2 product definitions.
  *
  * Child classes are passed to the Client when making requests.
  */
 export declare abstract class BaseProduct {
-    /** Parameter class accepted by this product. */
+    /**
+     * API slug for this product.
+     */
+    static get slug(): string;
+    /**
+     * Parameter class accepted by this product.
+     */
     static get parametersClass(): new (...args: any[]) => BaseProductParameters;
-    /** Response class returned by this product. */
+    /**
+     * Response class returned by this product.
+     */
     static get responseClass(): ResponseConstructor<any>;
-    /** API slug for this product. */
-    static get slug(): string;
+    /**
+     * Annotation Response class returned by this product.
+     */
+    static get annotationResponseClass(): AnnotationResponseConstructor<any>;
+    /**
+     * Annotation Parameters class for this product.
+     */
+    static get annotationParametersClass(): new (...args: any[]) => BaseAnnotationParameters;
+    /**
+     * Document Upload class for this product.
+     */
+    static get ragDocumentUploadClass(): new (...args: any[]) => BaseRagDocumentUploadParameters;
 }

package/src/v2/product/baseProduct.js

@@ -4,16 +4,40 @@
  * Child classes are passed to the Client when making requests.
  */
 export class BaseProduct {
-    /** Parameter class accepted by this product. */
+    /**
+     * API slug for this product.
+     */
+    static get slug() {
+        throw new Error("Must define static slug property");
+    }
+    /**
+     * Parameter class accepted by this product.
+     */
     static get parametersClass() {
-        throw new Error("Must define static parameters property");
+        throw new Error("Must define static parametersClass property");
     }
-    /** Response class returned by this product. */
+    /**
+     * Response class returned by this product.
+     */
     static get responseClass() {
-        throw new Error("Must define static response property");
+        throw new Error("Must define static responseClass property");
     }
-    /** API slug for this product. */
-    static get slug() {
-        throw new Error("Must define static slug property");
+    /**
+     * Annotation Response class returned by this product.
+     */
+    static get annotationResponseClass() {
+        throw new Error("Must define static annotationResponseClass property");
+    }
+    /**
+     * Annotation Parameters class for this product.
+     */
+    static get annotationParametersClass() {
+        throw new Error("Must define static annotationParametersClass property");
+    }
+    /**
+     * Document Upload class for this product.
+     */
+    static get ragDocumentUploadClass() {
+        throw new Error("Must define static ragDocumentUploadClass property");
     }
 }

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

@@ -1,14 +1,20 @@
 import { ClassificationResponse } from "./classificationResponse.js";
 import { ClassificationParameters } from "./params/index.js";
-import { BaseProduct } from "../../../v2/product/baseProduct.js";
+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

@@ -1,19 +1,25 @@
 import { ClassificationResponse } from "./classificationResponse.js";
 import { ClassificationParameters } from "./params/index.js";
-import { BaseProduct } from "../../../v2/product/baseProduct.js";
+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

@@ -1,9 +1,11 @@
 import { StringDict } from "../../../parsing/index.js";
-import { ExtractionResponse } from "../../../v2/product/index.js";
+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

@@ -1,8 +1,10 @@
-import { ExtractionResponse } from "../../../v2/product/index.js";
+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 "../../../v2/parsing/inference/baseInference.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;
 }