mindee 5.5.0 → 5.6.0

package/src/v1/product/resume/resumeV1ProfessionalExperience.js

@@ -4,7 +4,7 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
     return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
 };
 var _ResumeV1ProfessionalExperience_instances, _ResumeV1ProfessionalExperience_printableValues;
-import { cleanSpecialChars } from "../../../v1/parsing/common/index.js";
+import { cleanAndTruncate } from "../../../v1/parsing/common/index.js";
 import { Polygon } from "../../../geometry/index.js";
 /**
  * The list of the candidate's professional experiences.
@@ -86,50 +86,14 @@ export class ResumeV1ProfessionalExperience {
 }
 _ResumeV1ProfessionalExperience_instances = new WeakSet(), _ResumeV1ProfessionalExperience_printableValues = function _ResumeV1ProfessionalExperience_printableValues() {
     return {
-        contractType: this.contractType ?
-            this.contractType.length <= 15 ?
-                cleanSpecialChars(this.contractType) :
-                cleanSpecialChars(this.contractType).slice(0, 12) + "..." :
-            "",
-        department: this.department ?
-            this.department.length <= 10 ?
-                cleanSpecialChars(this.department) :
-                cleanSpecialChars(this.department).slice(0, 7) + "..." :
-            "",
-        description: this.description ?
-            this.description.length <= 36 ?
-                cleanSpecialChars(this.description) :
-                cleanSpecialChars(this.description).slice(0, 33) + "..." :
-            "",
-        employer: this.employer ?
-            this.employer.length <= 25 ?
-                cleanSpecialChars(this.employer) :
-                cleanSpecialChars(this.employer).slice(0, 22) + "..." :
-            "",
-        endMonth: this.endMonth ?
-            this.endMonth.length <= 9 ?
-                cleanSpecialChars(this.endMonth) :
-                cleanSpecialChars(this.endMonth).slice(0, 6) + "..." :
-            "",
-        endYear: this.endYear ?
-            this.endYear.length <= 8 ?
-                cleanSpecialChars(this.endYear) :
-                cleanSpecialChars(this.endYear).slice(0, 5) + "..." :
-            "",
-        role: this.role ?
-            this.role.length <= 20 ?
-                cleanSpecialChars(this.role) :
-                cleanSpecialChars(this.role).slice(0, 17) + "..." :
-            "",
-        startMonth: this.startMonth ?
-            this.startMonth.length <= 11 ?
-                cleanSpecialChars(this.startMonth) :
-                cleanSpecialChars(this.startMonth).slice(0, 8) + "..." :
-            "",
-        startYear: this.startYear ?
-            this.startYear.length <= 10 ?
-                cleanSpecialChars(this.startYear) :
-                cleanSpecialChars(this.startYear).slice(0, 7) + "..." :
-            "",
+        contractType: cleanAndTruncate(this.contractType, 15),
+        department: cleanAndTruncate(this.department, 10),
+        description: cleanAndTruncate(this.description, 36),
+        employer: cleanAndTruncate(this.employer, 25),
+        endMonth: cleanAndTruncate(this.endMonth, 9),
+        endYear: cleanAndTruncate(this.endYear, 8),
+        role: cleanAndTruncate(this.role, 20),
+        startMonth: cleanAndTruncate(this.startMonth, 11),
+        startYear: cleanAndTruncate(this.startYear, 10),
     };
 };

package/src/v1/product/resume/resumeV1SocialNetworksUrl.js

@@ -4,7 +4,7 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
     return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
 };
 var _ResumeV1SocialNetworksUrl_instances, _ResumeV1SocialNetworksUrl_printableValues;
-import { cleanSpecialChars } from "../../../v1/parsing/common/index.js";
+import { cleanAndTruncate } from "../../../v1/parsing/common/index.js";
 import { Polygon } from "../../../geometry/index.js";
 /**
  * The list of social network profiles of the candidate.
@@ -51,15 +51,7 @@ export class ResumeV1SocialNetworksUrl {
 }
 _ResumeV1SocialNetworksUrl_instances = new WeakSet(), _ResumeV1SocialNetworksUrl_printableValues = function _ResumeV1SocialNetworksUrl_printableValues() {
     return {
-        name: this.name ?
-            this.name.length <= 20 ?
-                cleanSpecialChars(this.name) :
-                cleanSpecialChars(this.name).slice(0, 17) + "..." :
-            "",
-        url: this.url ?
-            this.url.length <= 50 ?
-                cleanSpecialChars(this.url) :
-                cleanSpecialChars(this.url).slice(0, 47) + "..." :
-            "",
+        name: cleanAndTruncate(this.name, 20),
+        url: cleanAndTruncate(this.url, 50),
     };
 };

package/src/v2/cli.d.ts

@@ -1 +1,4 @@
+/**
+ * Build the CLI.
+ */
 export declare function cli(): void;

package/src/v2/cli.js

@@ -6,12 +6,22 @@ const program = new Command();
 //
 // EXECUTE THE COMMANDS
 //
+/**
+ * Initialize the client.
+ * @param options Options.
+ */
 function initClient(options) {
     return new Client({
         apiKey: options.apiKey,
         debug: options.debug,
     });
 }
+/**
+ * Enqueue and get inference.
+ * @param product Product.
+ * @param inputPath Input path.
+ * @param options Options.
+ */
 async function enqueueAndGetInference(product, inputPath, options) {
     const mindeeClient = initClient(options);
     let inputSource;
@@ -31,6 +41,10 @@ async function enqueueAndGetInference(product, inputPath, options) {
     }
     printResponse(response.inference);
 }
+/**
+ * Print response.
+ * @param document Document.
+ */
 function printResponse(document) {
     if (document) {
         console.log(`\n${document}`);
@@ -39,10 +53,17 @@ function printResponse(document) {
 //
 // BUILD THE COMMANDS
 //
+/**
+ * Add main options.
+ * @param prog Program.
+ */
 function addMainOptions(prog) {
     prog.requiredOption("-m, --model <model_id>", "Model ID (required)");
     prog.argument("<input_path>", "full path or URL to the file");
 }
+/**
+ * Build the CLI.
+ */
 export function cli() {
     program.name("mindee")
         .description("Command line interface for Mindee V2 products.")

package/src/v2/client.d.ts

@@ -39,6 +39,7 @@ export declare class Client {
      * @returns a `Promise` containing the search response.
      */
     searchModels(name?: string, modelType?: string): Promise<SearchResponse>;
+    /** Enqueues a product inference job without waiting for completion. */
     enqueue<P extends typeof BaseProduct>(product: P, inputSource: InputSource, params: InstanceType<P["parametersClass"]> | ConstructorParameters<P["parametersClass"]>[0]): Promise<JobResponse>;
     /**
      * Retrieves the result of a previously enqueued request.

package/src/v2/client.js

@@ -34,6 +34,7 @@ export class Client {
     async searchModels(name, modelType) {
         return await this.mindeeApi.reqGetSearchModel(name, modelType);
     }
+    /** Enqueues a product inference job without waiting for completion. */
     async enqueue(product, inputSource, params) {
         if (inputSource === undefined) {
             throw new MindeeError("An input document is required.");

package/src/v2/clientOptions/pollingOptions.d.ts

@@ -1,5 +1,8 @@
+/** Optional timer settings used by polling delays. */
 export interface TimerOptions {
+    /** Whether the timer should keep the event loop active. */
     ref?: boolean;
+    /** Optional signal used to abort timer waits. */
     signal?: AbortSignal;
 }
 export interface PollingOptionsConstructor {
@@ -51,6 +54,8 @@ export declare class PollingOptions {
     /** Options passed to every recurring `setTimeout()`. */
     recurringTimerOptions?: TimerOptions;
     constructor(params?: PollingOptionsConstructor);
+    /** Validates polling options against minimum accepted values. */
     validateSettings(): void;
+    /** Returns a compact string representation of the polling options. */
     toString(): string;
 }

package/src/v2/clientOptions/pollingOptions.js

@@ -65,6 +65,7 @@ export class PollingOptions {
         this.validateSettings();
         logger.debug(`Polling options initialized: ${this.toString()}`);
     }
+    /** Validates polling options against minimum accepted values. */
     validateSettings() {
         if (this.delaySec < minDelaySec) {
             throw new MindeeConfigurationError(`Cannot set auto-parsing delay to less than ${minDelaySec} second(s).`);
@@ -76,6 +77,7 @@ export class PollingOptions {
             throw new MindeeConfigurationError(`Cannot set retry to less than ${minRetries}.`);
         }
     }
+    /** Returns a compact string representation of the polling options. */
     toString() {
         return `{ initialDelaySec: ${this.initialDelaySec}, delaySec: ${this.delaySec}, maxRetries: ${this.maxRetries} }`;
     }

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