mindee 5.4.0 → 5.6.0

package/src/v2/http/mindeeApiV2.js

@@ -3,7 +3,7 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
     if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
     return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
 };
-var _MindeeApiV2_instances, _MindeeApiV2_processResponse, _MindeeApiV2_reqPostProductEnqueue, _MindeeApiV2_reqGetJob, _MindeeApiV2_reqGetProductResult;
+var _MindeeApiV2_instances, _MindeeApiV2_processResponse;
 import { ApiSettings } from "./apiSettings.js";
 import { ErrorResponse, JobResponse, } from "../../v2/parsing/index.js";
 import { sendRequestAndReadResponse } from "../../http/apiCore.js";
@@ -11,6 +11,7 @@ import { LocalInputSource } from "../../input/index.js";
 import { MindeeDeserializationError, MindeeError } from "../../errors/index.js";
 import { MindeeHttpErrorV2 } from "./errors.js";
 import { logger } from "../../logger.js";
+import { SearchResponse } from "../../v2/parsing/search/index.js";
 /**
  * Mindee V2 API handler.
  */
@@ -20,29 +21,82 @@ export class MindeeApiV2 {
         this.settings = new ApiSettings({ dispatcher: dispatcher, apiKey: apiKey });
     }
     /**
-     * Sends a file to the product inference queue.
-     * @param product product to enqueue.
-     * @param inputSource Local file loaded as an input.
+     * Search for models available to the account.
+     * @param name Optional name filter.
+     * @param modelType Optional model type filter.
+     * @returns a `Promise` containing the search response.
+     */
+    async reqGetSearchModel(name, modelType) {
+        const queryParams = {};
+        if (name)
+            queryParams["name"] = name;
+        if (modelType)
+            queryParams["model_type"] = modelType;
+        const options = {
+            method: "GET",
+            headers: this.settings.baseHeaders,
+            hostname: this.settings.hostname,
+            path: "/v2/search/models",
+            queryParams: queryParams,
+            timeoutSecs: this.settings.timeoutSecs,
+        };
+        const response = await sendRequestAndReadResponse(this.settings.dispatcher, options);
+        return __classPrivateFieldGet(this, _MindeeApiV2_instances, "m", _MindeeApiV2_processResponse).call(this, response, SearchResponse);
+    }
+    /**
+     * Sends a document to the inference queue.
+     * @param product Product to enqueue.
+     * @param inputSource Local or remote file as an input.
      * @param params {ExtractionParameters} parameters relating to the enqueueing options.
-     * @throws Error if the server's response contains an error.
-     * @returns a `Promise` containing a job response.
      */
-    async enqueueProduct(product, inputSource, params) {
-        await inputSource.init();
-        const result = await __classPrivateFieldGet(this, _MindeeApiV2_instances, "m", _MindeeApiV2_reqPostProductEnqueue).call(this, product, inputSource, params);
+    async reqPostProductEnqueue(product, inputSource, params) {
+        const form = params.getFormData();
+        if (inputSource instanceof LocalInputSource) {
+            form.set("file", new Blob([inputSource.fileObject]), inputSource.filename);
+        }
+        else {
+            form.set("url", inputSource.url);
+        }
+        const path = `/v2/products/${product.slug}/enqueue`;
+        const options = {
+            method: "POST",
+            headers: this.settings.baseHeaders,
+            hostname: this.settings.hostname,
+            path: path,
+            body: form,
+            timeoutSecs: this.settings.timeoutSecs,
+        };
+        const result = await sendRequestAndReadResponse(this.settings.dispatcher, options);
         if (result.data.error !== undefined) {
             throw new MindeeHttpErrorV2(result.data.error);
         }
         return __classPrivateFieldGet(this, _MindeeApiV2_instances, "m", _MindeeApiV2_processResponse).call(this, result, JobResponse);
     }
     /**
-     * Get the specified Job.
+     * Get the specified Job by its ID.
      * Throws an error if the server's response contains an error.
      * @param jobId The Job ID as returned by the enqueue request.
      * @returns a `Promise` containing the job response.
      */
-    async getJob(jobId) {
-        const response = await __classPrivateFieldGet(this, _MindeeApiV2_instances, "m", _MindeeApiV2_reqGetJob).call(this, jobId);
+    async reqGetJobById(jobId) {
+        return this.reqGetJobByUrl(`https://${this.settings.hostname}/v2/jobs/${jobId}`);
+    }
+    /**
+     * Get the specified Job from a polling URL.
+     * Throws an error if the server's response contains an error.
+     * @param pollingUrl The polling URL as returned by a Job's pollingUrl property.
+     * @returns a `Promise` containing the job response.
+     */
+    async reqGetJobByUrl(pollingUrl) {
+        if (!pollingUrl.startsWith("https://")) {
+            throw new MindeeError(`Invalid URL: ${pollingUrl}`);
+        }
+        const options = {
+            method: "GET",
+            headers: this.settings.baseHeaders,
+            timeoutSecs: this.settings.timeoutSecs,
+        };
+        const response = await sendRequestAndReadResponse(this.settings.dispatcher, options, pollingUrl);
         return __classPrivateFieldGet(this, _MindeeApiV2_instances, "m", _MindeeApiV2_processResponse).call(this, response, JobResponse);
     }
     /**
@@ -52,9 +106,8 @@ export class MindeeApiV2 {
      * @param inferenceId The inference ID for the result.
      * @returns a `Promise` containing the parsed result.
      */
-    async getProductResultById(product, inferenceId) {
-        const queueResponse = await __classPrivateFieldGet(this, _MindeeApiV2_instances, "m", _MindeeApiV2_reqGetProductResult).call(this, `https://${this.settings.hostname}/v2/products/${product.slug}/results/${inferenceId}`);
-        return __classPrivateFieldGet(this, _MindeeApiV2_instances, "m", _MindeeApiV2_processResponse).call(this, queueResponse, product.responseClass);
+    async reqGetProductResultById(product, inferenceId) {
+        return this.reqGetProductResultByUrl(product, `https://${this.settings.hostname}/v2/products/${product.slug}/results/${inferenceId}`);
     }
     /**
      * Get the result of a queued document from the API.
@@ -63,9 +116,17 @@ export class MindeeApiV2 {
      * @param url The URL as returned by a Job's resultUrl property.
      * @returns a `Promise` containing the parsed result.
      */
-    async getProductResultByUrl(product, url) {
-        const queueResponse = await __classPrivateFieldGet(this, _MindeeApiV2_instances, "m", _MindeeApiV2_reqGetProductResult).call(this, url);
-        return __classPrivateFieldGet(this, _MindeeApiV2_instances, "m", _MindeeApiV2_processResponse).call(this, queueResponse, product.responseClass);
+    async reqGetProductResultByUrl(product, url) {
+        const options = {
+            method: "GET",
+            headers: this.settings.baseHeaders,
+            timeoutSecs: this.settings.timeoutSecs,
+        };
+        if (!url.startsWith("https://")) {
+            throw new MindeeError(`Invalid URL: ${url}`);
+        }
+        const response = await sendRequestAndReadResponse(this.settings.dispatcher, options, url);
+        return __classPrivateFieldGet(this, _MindeeApiV2_instances, "m", _MindeeApiV2_processResponse).call(this, response, product.responseClass);
     }
 }
 _MindeeApiV2_instances = new WeakSet(), _MindeeApiV2_processResponse = function _MindeeApiV2_processResponse(result, responseClass) {
@@ -88,54 +149,4 @@ _MindeeApiV2_instances = new WeakSet(), _MindeeApiV2_processResponse = function
         logger.error(`Raised '${e}' Couldn't deserialize response object:\n${JSON.stringify(result.data)}`);
         throw new MindeeDeserializationError("Couldn't deserialize response object.");
     }
-}, _MindeeApiV2_reqPostProductEnqueue = 
-/**
- * Sends a document to the inference queue.
- * @param product Product to enqueue.
- * @param inputSource Local or remote file as an input.
- * @param params {ExtractionParameters} parameters relating to the enqueueing options.
- */
-async function _MindeeApiV2_reqPostProductEnqueue(product, inputSource, params) {
-    const form = params.getFormData();
-    if (inputSource instanceof LocalInputSource) {
-        form.set("file", new Blob([inputSource.fileObject]), inputSource.filename);
-    }
-    else {
-        form.set("url", inputSource.url);
-    }
-    const path = `/v2/products/${product.slug}/enqueue`;
-    const options = {
-        method: "POST",
-        headers: this.settings.baseHeaders,
-        hostname: this.settings.hostname,
-        path: path,
-        body: form,
-        timeoutSecs: this.settings.timeoutSecs,
-    };
-    return await sendRequestAndReadResponse(this.settings.dispatcher, options);
-}, _MindeeApiV2_reqGetJob = async function _MindeeApiV2_reqGetJob(jobId) {
-    const options = {
-        method: "GET",
-        headers: this.settings.baseHeaders,
-        hostname: this.settings.hostname,
-        path: `/v2/jobs/${jobId}`,
-        timeoutSecs: this.settings.timeoutSecs,
-    };
-    return await sendRequestAndReadResponse(this.settings.dispatcher, options);
-}, _MindeeApiV2_reqGetProductResult = 
-/**
- * Make a request to GET the status of a document in the queue.
- * @param url URL path to the result.
- * @returns a `Promise` containing the parsed result.
- */
-async function _MindeeApiV2_reqGetProductResult(url) {
-    const options = {
-        method: "GET",
-        headers: this.settings.baseHeaders,
-        timeoutSecs: this.settings.timeoutSecs,
-    };
-    if (!url.startsWith("https://")) {
-        throw new MindeeError(`Invalid URL: ${url}`);
-    }
-    return await sendRequestAndReadResponse(this.settings.dispatcher, options, url);
 };

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

@@ -1,4 +1,5 @@
 import { StringDict } from "../../parsing/stringDict.js";
+/** Base response contract for v2 product responses. */
 export declare abstract class BaseResponse {
     /**
      * Raw text representation of the API's response.
@@ -14,4 +15,5 @@ export declare abstract class BaseResponse {
      */
     getRawHttp(): StringDict;
 }
+/** Constructor signature for typed v2 response classes. */
 export type ResponseConstructor<T extends BaseResponse> = new (serverResponse: StringDict) => T;

package/src/v2/parsing/baseResponse.js

@@ -1,4 +1,5 @@
 import { logger } from "../../logger.js";
+/** Base response contract for v2 product responses. */
 export class BaseResponse {
     /**
      * @param serverResponse JSON response from the server.

package/src/v2/parsing/error/errorDetails.d.ts

@@ -1,4 +1,5 @@
 import { ErrorItem } from "./errorItem.js";
+/** Structured error payload returned by v2 APIs. */
 export interface ErrorDetails {
     /**
      * The HTTP status code returned by the server.

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

@@ -1,6 +1,6 @@
 export { ErrorResponse, ErrorItem, } from "./error/index.js";
 export type { ErrorDetails } from "./error/index.js";
-export { Job, JobResponse, JobWebhook } from "./job/index.js";
+export { Job, JobResponse, JobWebhook, } from "./job/index.js";
 export { BaseInference, InferenceFile, InferenceModel, } from "./inference/index.js";
 export { LocalResponse } from "./localResponse.js";
 export { BaseResponse } from "./baseResponse.js";

package/src/v2/parsing/index.js

@@ -1,5 +1,5 @@
 export { ErrorResponse, ErrorItem, } from "./error/index.js";
-export { Job, JobResponse, JobWebhook } from "./job/index.js";
+export { Job, JobResponse, JobWebhook, } from "./job/index.js";
 export { BaseInference, InferenceFile, InferenceModel, } from "./inference/index.js";
 export { LocalResponse } from "./localResponse.js";
 export { BaseResponse } from "./baseResponse.js";

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

@@ -2,6 +2,7 @@ import { StringDict } from "../../../parsing/index.js";
 import { InferenceModel } from "./inferenceModel.js";
 import { InferenceFile } from "./inferenceFile.js";
 import { InferenceJob } from "./inferenceJob.js";
+/** Shared metadata container for v2 inference payloads. */
 export declare abstract class BaseInference {
     /**
      * Model info for the inference.
@@ -20,5 +21,6 @@ export declare abstract class BaseInference {
      */
     id: string;
     protected constructor(serverResponse: StringDict);
+    /** Returns a printable representation of inference metadata. */
     toString(): string;
 }

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

@@ -1,6 +1,7 @@
 import { InferenceModel } from "./inferenceModel.js";
 import { InferenceFile } from "./inferenceFile.js";
 import { InferenceJob } from "./inferenceJob.js";
+/** Shared metadata container for v2 inference payloads. */
 export class BaseInference {
     constructor(serverResponse) {
         this.id = serverResponse["id"];
@@ -8,6 +9,7 @@ export class BaseInference {
         this.model = new InferenceModel(serverResponse["model"]);
         this.file = new InferenceFile(serverResponse["file"]);
     }
+    /** Returns a printable representation of inference metadata. */
     toString() {
         return ("Inference\n" +
             "#########\n" +

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

@@ -0,0 +1,33 @@
+import { StringDict } from "../../../parsing/index.js";
+import { ErrorResponse } from "../../../v2/index.js";
+import { BaseResponse } from "../../../v2/parsing/baseResponse.js";
+/**
+ * Webhook payload returned when an inference fails before producing a result.
+ */
+export declare class FailedInferenceResponse extends BaseResponse {
+    /**
+     * UUID of the failed inference.
+     */
+    inferenceId: string;
+    /**
+     * UUID of the model used.
+     */
+    modelId: string;
+    /**
+     * Name of the input file.
+     */
+    fileName: string;
+    /**
+     * Alias sent for the file, if any.
+     */
+    fileAlias?: string;
+    /**
+     * Problem details for the failure, if available.
+     */
+    error: ErrorResponse;
+    /**
+     * Date and time when the inference was started.
+     */
+    createdAt: Date | null;
+    constructor(serverResponse: StringDict);
+}

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

@@ -0,0 +1,17 @@
+import { parseDate } from "../../../parsing/index.js";
+import { ErrorResponse } from "../../../v2/index.js";
+import { BaseResponse } from "../../../v2/parsing/baseResponse.js";
+/**
+ * Webhook payload returned when an inference fails before producing a result.
+ */
+export class FailedInferenceResponse extends BaseResponse {
+    constructor(serverResponse) {
+        super(serverResponse);
+        this.inferenceId = serverResponse["inference_id"];
+        this.modelId = serverResponse["model_id"];
+        this.fileName = serverResponse["file_name"];
+        this.fileAlias = serverResponse["file_alias"];
+        this.error = new ErrorResponse(serverResponse["error"]);
+        this.createdAt = parseDate(serverResponse["created_at"]);
+    }
+}

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

@@ -2,8 +2,11 @@ import { FieldConfidence } from "./fieldConfidence.js";
 import { StringDict } from "../../../../parsing/stringDict.js";
 import { FieldLocation } from "./fieldLocation.js";
 export declare abstract class BaseField {
+    /** Indentation level used when rendering field text output. */
     protected _indentLevel: number;
+    /** Confidence level associated with this field. */
     confidence: FieldConfidence | undefined;
+    /** Optional list of source locations for this field. */
     locations: Array<FieldLocation> | undefined;
     protected constructor(rawResponse: StringDict, indentLevel?: number);
 }

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

@@ -2,9 +2,13 @@
  * Confidence level of a field as returned by the V2 API.
  */
 export declare enum FieldConfidence {
+    /** Maximum confidence level. */
     Certain = "Certain",
+    /** High confidence level. */
     High = "High",
+    /** Medium confidence level. */
     Medium = "Medium",
+    /** Low confidence level. */
     Low = "Low"
 }
 export declare namespace FieldConfidence {

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

@@ -4,9 +4,13 @@
  */
 export var FieldConfidence;
 (function (FieldConfidence) {
+    /** Maximum confidence level. */
     FieldConfidence["Certain"] = "Certain";
+    /** High confidence level. */
     FieldConfidence["High"] = "High";
+    /** Medium confidence level. */
     FieldConfidence["Medium"] = "Medium";
+    /** Low confidence level. */
     FieldConfidence["Low"] = "Low";
 })(FieldConfidence || (FieldConfidence = {}));
 // eslint-disable-next-line @typescript-eslint/no-namespace

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

@@ -5,4 +5,9 @@ import { StringDict } from "../../../../parsing/stringDict.js";
 import { ListField } from "./listField.js";
 import { ObjectField } from "./objectField.js";
 import { SimpleField } from "./simpleField.js";
+/**
+ * Create a field from a server response.
+ * @param serverResponse Server response.
+ * @param indentLevel Indent level.
+ */
 export declare function createField(serverResponse: StringDict, indentLevel?: number): SimpleField | ObjectField | ListField;

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

@@ -2,6 +2,11 @@ import { MindeeDeserializationError } from "../../../../errors/index.js";
 import { ListField } from "./listField.js";
 import { ObjectField } from "./objectField.js";
 import { SimpleField } from "./simpleField.js";
+/**
+ * Create a field from a server response.
+ * @param serverResponse Server response.
+ * @param indentLevel Indent level.
+ */
 export function createField(serverResponse, indentLevel = 0) {
     if (typeof serverResponse !== "object" || serverResponse === null) {
         throw new MindeeDeserializationError(`Unrecognized field format ${JSON.stringify(serverResponse)}.`);

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

@@ -9,5 +9,6 @@ export declare class FieldLocation {
     /** 0-based page index of where the polygon is located. */
     readonly page: any;
     constructor(serverResponse: StringDict);
+    /** Returns a readable location string. */
     toString(): string;
 }

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

@@ -7,6 +7,7 @@ export class FieldLocation {
         this.polygon = new Polygon(...serverResponse["polygon"]);
         this.page = serverResponse["page"];
     }
+    /** Returns a readable location string. */
     toString() {
         return `${this.polygon} on page ${this.page}`;
     }

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

@@ -2,11 +2,16 @@ import { StringDict } from "../../../../parsing/stringDict.js";
 import type { ListField } from "./listField.js";
 import type { ObjectField } from "./objectField.js";
 import type { SimpleField } from "./simpleField.js";
+/** Typed map of extraction fields returned by the API. */
 export declare class InferenceFields extends Map<string, SimpleField | ObjectField | ListField> {
+    /** Indentation level used when rendering text output. */
     protected _indentLevel: number;
     constructor(serverResponse: StringDict, indentLevel?: number);
+    /** Returns a field as a `SimpleField`, or throws if the type mismatches. */
     getSimpleField(fieldName: string): SimpleField;
+    /** Returns a field as an `ObjectField`, or throws if the type mismatches. */
     getObjectField(fieldName: string): ObjectField;
+    /** Returns a field as a `ListField`, or throws if the type mismatches. */
     getListField(fieldName: string): ListField;
     toString(indent?: number): string;
 }

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" +