mindee 5.7.2 → 5.9.0

package/src/v2/http/mindeeApiV2.d.ts

@@ -1,11 +1,11 @@
 import { ApiSettings } from "./apiSettings.js";
 import { Dispatcher } from "undici";
-import { BaseProductParameters } from "../../v2/index.js";
-import { BaseSearchParameters } from "../../v2/clientOptions/baseSearchParameters.js";
-import { JobResponse } from "../../v2/parsing/index.js";
-import { InputSource } from "../../input/index.js";
-import { BaseProduct } from "../../v2/product/baseProduct.js";
-import { BaseSearch } from "../../v2/search/baseSearch.js";
+import { BaseProductParameters } from "../index.js";
+import { BaseSearchParameters, BaseAnnotationParameters, BaseRagDocumentUploadParameters } from "../clientOptions/index.js";
+import { JobResponse } from "../parsing/index.js";
+import { InputSource, LocalInputSource } from "../../input/index.js";
+import { BaseProduct } from "../product/baseProduct.js";
+import { BaseSearch } from "../search/baseSearch.js";
 /**
  * Mindee V2 API handler.
  */
@@ -57,4 +57,33 @@ export declare class MindeeApiV2 {
      * @returns a `Promise` containing the search response.
      */
     reqGetSearch<S extends typeof BaseSearch>(search: S, parameters: BaseSearchParameters): Promise<InstanceType<S["responseClass"]>>;
+    /**
+     * Get a document's info and annotations from the RAG database.
+     * @param product the product definition to use.
+     * @param documentId the document id to get.
+     * @returns a `Promise` containing an annotation response.
+     */
+    reqGetRagAnnotation<P extends typeof BaseProduct>(product: P, documentId: string): Promise<InstanceType<P["annotationResponseClass"]>>;
+    /**
+     * Add a document to the RAG database.
+     * @param product the product definition to use.
+     * @param parameters the parameters to use.
+     * @param inputSource the file to upload.
+     * @returns a `Promise` containing an annotation response.
+     */
+    reqPostRagDocument<P extends typeof BaseProduct>(product: P, parameters: BaseRagDocumentUploadParameters, inputSource: LocalInputSource): Promise<InstanceType<P["annotationResponseClass"]>>;
+    /**
+     * Update a document's annotations in the RAG database.
+     * @param product the product definition to use.
+     * @param parameters the parameters to use.
+     * @returns a `Promise` containing an annotation response.
+     */
+    reqPatchRagAnnotation<P extends typeof BaseProduct>(product: P, parameters: BaseAnnotationParameters): Promise<InstanceType<P["annotationResponseClass"]>>;
+    /**
+     * Deletes a document from the RAG database.
+     * @param product the product definition to use.
+     * @param documentId the document's ID.
+     * @returns true if the document was deleted successfully, false otherwise.
+     */
+    reqDeleteRagDocument<P extends typeof BaseProduct>(product: P, documentId: string): Promise<boolean>;
 }

package/src/v2/http/mindeeApiV2.js

@@ -6,7 +6,7 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
 var _MindeeApiV2_instances, _MindeeApiV2_paramsToFormData, _MindeeApiV2_processResponse;
 import { ApiSettings } from "./apiSettings.js";
 import { FormData } from "undici";
-import { ErrorResponse, JobResponse, } from "../../v2/parsing/index.js";
+import { ErrorResponse, JobResponse, } from "../parsing/index.js";
 import { sendRequestAndReadResponse } from "../../http/apiCore.js";
 import { LocalInputSource } from "../../input/index.js";
 import { MindeeDeserializationError, MindeeError } from "../../errors/index.js";
@@ -34,12 +34,11 @@ export class MindeeApiV2 {
         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,
+            path: `/v2/products/${product.slug}/enqueue`,
             body: form,
             timeoutSecs: this.settings.timeoutSecs,
         };
@@ -123,6 +122,83 @@ export class MindeeApiV2 {
         const response = await sendRequestAndReadResponse(this.settings.dispatcher, options);
         return __classPrivateFieldGet(this, _MindeeApiV2_instances, "m", _MindeeApiV2_processResponse).call(this, response, search.responseClass);
     }
+    /**
+     * Get a document's info and annotations from the RAG database.
+     * @param product the product definition to use.
+     * @param documentId the document id to get.
+     * @returns a `Promise` containing an annotation response.
+     */
+    async reqGetRagAnnotation(product, documentId) {
+        const options = {
+            method: "GET",
+            headers: this.settings.baseHeaders,
+            hostname: this.settings.hostname,
+            path: `/v2/products/${product.slug}/rag-documents/${documentId}`,
+            timeoutSecs: this.settings.timeoutSecs,
+        };
+        const response = await sendRequestAndReadResponse(this.settings.dispatcher, options);
+        return __classPrivateFieldGet(this, _MindeeApiV2_instances, "m", _MindeeApiV2_processResponse).call(this, response, product.annotationResponseClass);
+    }
+    /**
+     * Add a document to the RAG database.
+     * @param product the product definition to use.
+     * @param parameters the parameters to use.
+     * @param inputSource the file to upload.
+     * @returns a `Promise` containing an annotation response.
+     */
+    async reqPostRagDocument(product, parameters, inputSource) {
+        const form = __classPrivateFieldGet(this, _MindeeApiV2_instances, "m", _MindeeApiV2_paramsToFormData).call(this, parameters.getRequestParameters());
+        form.set("file", new Blob([inputSource.fileObject]), inputSource.filename);
+        const options = {
+            method: "POST",
+            headers: this.settings.baseHeaders,
+            hostname: this.settings.hostname,
+            path: `/v2/products/${product.slug}/rag-documents`,
+            body: form,
+            timeoutSecs: this.settings.timeoutSecs,
+        };
+        const response = await sendRequestAndReadResponse(this.settings.dispatcher, options);
+        return __classPrivateFieldGet(this, _MindeeApiV2_instances, "m", _MindeeApiV2_processResponse).call(this, response, product.annotationResponseClass);
+    }
+    /**
+     * Update a document's annotations in the RAG database.
+     * @param product the product definition to use.
+     * @param parameters the parameters to use.
+     * @returns a `Promise` containing an annotation response.
+     */
+    async reqPatchRagAnnotation(product, parameters) {
+        const options = {
+            method: "PATCH",
+            headers: {
+                ...this.settings.baseHeaders,
+                // eslint-disable-next-line @typescript-eslint/naming-convention
+                "Content-Type": "application/json",
+            },
+            hostname: this.settings.hostname,
+            path: `/v2/products/${product.slug}/rag-documents/${parameters.documentId}`,
+            body: JSON.stringify(parameters.getRequestParameters()),
+            timeoutSecs: this.settings.timeoutSecs,
+        };
+        const response = await sendRequestAndReadResponse(this.settings.dispatcher, options);
+        return __classPrivateFieldGet(this, _MindeeApiV2_instances, "m", _MindeeApiV2_processResponse).call(this, response, product.annotationResponseClass);
+    }
+    /**
+     * Deletes a document from the RAG database.
+     * @param product the product definition to use.
+     * @param documentId the document's ID.
+     * @returns true if the document was deleted successfully, false otherwise.
+     */
+    async reqDeleteRagDocument(product, documentId) {
+        const options = {
+            method: "DELETE",
+            headers: this.settings.baseHeaders,
+            hostname: this.settings.hostname,
+            path: `/v2/products/${product.slug}/rag-documents/${documentId}`,
+            timeoutSecs: this.settings.timeoutSecs,
+        };
+        const response = await sendRequestAndReadResponse(this.settings.dispatcher, options);
+        return response.messageObj?.statusCode >= 200 && response.messageObj?.statusCode < 400;
+    }
 }
 _MindeeApiV2_instances = new WeakSet(), _MindeeApiV2_paramsToFormData = function _MindeeApiV2_paramsToFormData(params) {
     const form = new FormData();
@@ -133,15 +209,20 @@ _MindeeApiV2_instances = new WeakSet(), _MindeeApiV2_paramsToFormData = function
 }, _MindeeApiV2_processResponse = function _MindeeApiV2_processResponse(result, responseClass) {
     if (result.messageObj?.statusCode
         && (result.messageObj?.statusCode > 399 || result.messageObj?.statusCode < 200)) {
+        let errorResponse;
         if (result.data?.status !== null) {
-            throw new MindeeHttpErrorV2(new ErrorResponse(result.data));
+            errorResponse = new ErrorResponse(result.data);
+        }
+        else {
+            errorResponse = new ErrorResponse({
+                status: result.messageObj?.statusCode ?? -1,
+                title: "Unknown Error",
+                detail: result.data?.detail ?? "The server returned an Unknown error.",
+                code: `${result.messageObj?.statusCode ?? -1}-000`,
+            });
         }
-        throw new MindeeHttpErrorV2(new ErrorResponse({
-            status: result.messageObj?.statusCode ?? -1,
-            title: "Unknown Error",
-            detail: result.data?.detail ?? "The server returned an Unknown error.",
-            code: `${result.messageObj?.statusCode ?? -1}-000`,
-        }));
+        logger.error(errorResponse.toString());
+        throw new MindeeHttpErrorV2(errorResponse);
     }
     try {
         return new responseClass(result.data);

package/src/v2/index.d.ts

@@ -3,6 +3,6 @@ export * as parsing from "./parsing/index.js";
 export * as product from "./product/index.js";
 export * as search from "./search/index.js";
 export { Client } from "./client.js";
-export { JobResponse, ErrorResponse, LocalResponse, } from "./parsing/index.js";
+export { JobResponse, ErrorResponse, LocalResponse, FailedInferenceResponse, } from "./parsing/index.js";
 export type { BaseProductParameters, TimerOptions } from "./clientOptions/index.js";
 export { PollingOptions } from "./clientOptions/index.js";

package/src/v2/index.js

@@ -3,5 +3,5 @@ export * as parsing from "./parsing/index.js";
 export * as product from "./product/index.js";
 export * as search from "./search/index.js";
 export { Client } from "./client.js";
-export { JobResponse, ErrorResponse, LocalResponse, } from "./parsing/index.js";
+export { JobResponse, ErrorResponse, LocalResponse, FailedInferenceResponse, } from "./parsing/index.js";
 export { PollingOptions } from "./clientOptions/index.js";

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

@@ -0,0 +1,28 @@
+import { BaseResponse } from "./baseResponse.js";
+import { StringDict } from "../../parsing/index.js";
+/**
+ * Base class for all RAG document responses from the V2 API.
+ */
+export declare class BaseRagAnnotationResponse extends BaseResponse {
+    /**
+     * Unique identifier of the RAG document.
+     */
+    id: string;
+    /**
+     * Original filename of the uploaded document.
+     */
+    filename: string;
+    /**
+     * Date and time of the document creation.
+     */
+    createdAt: Date;
+    /**
+     * Current status of the RAG document.
+     */
+    status: string;
+    constructor(serverResponse: StringDict);
+}
+/**
+ * Constructor signature for typed v2 response classes.
+ */
+export type AnnotationResponseConstructor<T extends BaseRagAnnotationResponse> = new (serverResponse: StringDict) => T;

package/src/v2/parsing/baseRagAnnotationResponse.js

@@ -0,0 +1,14 @@
+import { BaseResponse } from "./baseResponse.js";
+import { parseDate } from "../../parsing/index.js";
+/**
+ * Base class for all RAG document responses from the V2 API.
+ */
+export class BaseRagAnnotationResponse extends BaseResponse {
+    constructor(serverResponse) {
+        super(serverResponse);
+        this.id = serverResponse["id"];
+        this.filename = serverResponse["filename"];
+        this.createdAt = parseDate(serverResponse["created_at"]);
+        this.status = serverResponse["status"];
+    }
+}

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

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

package/src/v2/parsing/baseResponse.js

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

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

@@ -6,7 +6,7 @@ export declare class ErrorItem {
     /**
      * A JSON Pointer to the location of the body property.
      */
-    pointer?: string;
+    pointer: string;
     /**
      * Explicit information on the issue.
      */

package/src/v2/parsing/error/errorItem.js

@@ -6,9 +6,7 @@ export class ErrorItem {
      * @param serverResponse JSON response from the server.
      */
     constructor(serverResponse) {
-        if (serverResponse["pointer"] !== undefined) {
-            this.pointer = serverResponse["pointer"];
-        }
+        this.pointer = serverResponse["pointer"];
         this.detail = serverResponse["detail"];
     }
 }

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

@@ -1,7 +1,7 @@
 import { StringDict } from "../../../parsing/stringDict.js";
 import { ErrorItem } from "./errorItem.js";
 import { ErrorDetails } from "./errorDetails.js";
-import { BaseResponse } from "../../../v2/parsing/baseResponse.js";
+import { BaseResponse } from "../baseResponse.js";
 /**
  * Error response detailing a problem. The format adheres to RFC 9457.
  */
@@ -15,4 +15,8 @@ export declare class ErrorResponse extends BaseResponse implements ErrorDetails
      * @param serverResponse JSON response from the server.
      */
     constructor(serverResponse: StringDict);
+    /**
+     * To make the error prettier to display.
+     */
+    toString(): string;
 }

package/src/v2/parsing/error/errorResponse.js

@@ -1,5 +1,5 @@
 import { ErrorItem } from "./errorItem.js";
-import { BaseResponse } from "../../../v2/parsing/baseResponse.js";
+import { BaseResponse } from "../baseResponse.js";
 /**
  * Error response detailing a problem. The format adheres to RFC 9457.
  */
@@ -20,4 +20,30 @@ export class ErrorResponse extends BaseResponse {
             this.errors = [];
         }
     }
+    /**
+     * To make the error prettier to display.
+     */
+    toString() {
+        const result = [];
+        result.push("Error Details");
+        result.push("=============");
+        result.push(`:HTTP Status: ${this.status}`);
+        result.push(`:Title: ${this.title}`);
+        result.push(`:Code: ${this.code}`);
+        result.push(`:Detail: ${this.detail}`);
+        if (this.errors && this.errors.length > 0) {
+            result.push("");
+            result.push("Error Items");
+            result.push("-----------");
+            this.errors.forEach((error, i) => {
+                result.push(`**Error ${i + 1}:**`);
+                result.push(`  :Pointer: ${error.pointer}`);
+                result.push(`  :Detail: ${error.detail}`);
+                if (i < this.errors.length - 1) {
+                    result.push("");
+                }
+            });
+        }
+        return result.join("\n") + "\n";
+    }
 }

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

@@ -1,8 +1,10 @@
 export { ErrorResponse, ErrorItem, } from "./error/index.js";
 export type { ErrorDetails } from "./error/index.js";
 export { Job, JobResponse, JobWebhook, } from "./job/index.js";
-export { BaseInference, InferenceFile, InferenceModel, } from "./inference/index.js";
+export { BaseInference, InferenceFile, InferenceModel, FailedInferenceResponse, } from "./inference/index.js";
 export { LocalResponse } from "./localResponse.js";
 export { BaseResponse } from "./baseResponse.js";
 export type { ResponseConstructor } from "./baseResponse.js";
+export { BaseRagAnnotationResponse } from "./baseRagAnnotationResponse.js";
+export type { AnnotationResponseConstructor } from "./baseRagAnnotationResponse.js";
 export * as field from "./inference/field/index.js";

package/src/v2/parsing/index.js

@@ -1,6 +1,7 @@
 export { ErrorResponse, ErrorItem, } from "./error/index.js";
 export { Job, JobResponse, JobWebhook, } from "./job/index.js";
-export { BaseInference, InferenceFile, InferenceModel, } from "./inference/index.js";
+export { BaseInference, InferenceFile, InferenceModel, FailedInferenceResponse, } from "./inference/index.js";
 export { LocalResponse } from "./localResponse.js";
 export { BaseResponse } from "./baseResponse.js";
+export { BaseRagAnnotationResponse } from "./baseRagAnnotationResponse.js";
 export * as field from "./inference/field/index.js";

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

@@ -1,6 +1,6 @@
 import { StringDict } from "../../../parsing/index.js";
-import { ErrorResponse } from "../../../v2/index.js";
-import { BaseResponse } from "../../../v2/parsing/baseResponse.js";
+import { ErrorResponse } from "../../index.js";
+import { BaseResponse } from "../baseResponse.js";
 /**
  * Webhook payload returned when an inference fails before producing a result.
  */

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

@@ -1,6 +1,6 @@
 import { parseDate } from "../../../parsing/index.js";
-import { ErrorResponse } from "../../../v2/index.js";
-import { BaseResponse } from "../../../v2/parsing/baseResponse.js";
+import { ErrorResponse } from "../../index.js";
+import { BaseResponse } from "../baseResponse.js";
 /**
  * Webhook payload returned when an inference fails before producing a result.
  */

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

@@ -7,11 +7,17 @@ export declare class InferenceFields extends Map<string, SimpleField | ObjectFie
     /** 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. */
+    /**
+     * 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. */
+    /**
+     * 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. */
+    /**
+     * 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

@@ -7,7 +7,9 @@ export class InferenceFields extends Map {
         }));
         this._indentLevel = indentLevel;
     }
-    /** Returns a field as a `SimpleField`, or throws if the type mismatches. */
+    /**
+     * Returns a field as a `SimpleField`, or throws if the type mismatches.
+     */
     getSimpleField(fieldName) {
         const field = this.get(fieldName);
         if (field === undefined) {
@@ -18,7 +20,9 @@ export class InferenceFields extends Map {
         }
         return field;
     }
-    /** Returns a field as an `ObjectField`, or throws if the type mismatches. */
+    /**
+     * Returns a field as an `ObjectField`, or throws if the type mismatches.
+     */
     getObjectField(fieldName) {
         const field = this.get(fieldName);
         if (field === undefined) {
@@ -29,7 +33,9 @@ export class InferenceFields extends Map {
         }
         return field;
     }
-    /** Returns a field as a `ListField`, or throws if the type mismatches. */
+    /**
+     * 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/objectField.d.ts

@@ -7,6 +7,7 @@ import type { ListField } from "./listField.js";
 export declare class ObjectField extends BaseField {
     /** Nested fields carried by this object. */
     readonly fields: InferenceFields;
+    constructor(serverResponse: StringDict, indentLevel?: number);
     /**
      * Retrieves the simple sub-fields in the object.
      *
@@ -29,29 +30,32 @@ export declare 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: string): SimpleField;
     /**
      * 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: string): ListField;
     /**
      * 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: string): ObjectField;
-    constructor(serverResponse: StringDict, indentLevel?: number);
-    /** Returns a readable representation of nested fields. */
+    /**
+     * Returns a readable representation of nested fields.
+     */
     toString(): string;
-    /** Returns a compact representation suitable for list items. */
+    /**
+     * Returns a compact representation suitable for list items.
+     */
     toStringFromList(): string;
 }

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

@@ -2,6 +2,10 @@ import { InferenceFields } from "./inferenceFields.js";
 import { BaseField } from "./baseField.js";
 /** 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 +52,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/index.d.ts

@@ -1,4 +1,5 @@
 export { BaseInference } from "./baseInference.js";
 export { InferenceFile } from "./inferenceFile.js";
 export { InferenceModel } from "./inferenceModel.js";
+export { FailedInferenceResponse } from "./failedInferenceResponse.js";
 export * as field from "./field/index.js";

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

@@ -1,4 +1,5 @@
 export { BaseInference } from "./baseInference.js";
 export { InferenceFile } from "./inferenceFile.js";
 export { InferenceModel } from "./inferenceModel.js";
+export { FailedInferenceResponse } from "./failedInferenceResponse.js";
 export * as field from "./field/index.js";