mindee 5.8.0 → 5.10.0

package/src/v2/http/mindeeApiV2.js

@@ -4,9 +4,9 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
     return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
 };
 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 { ApiSettings } from "./apiSettings.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();

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

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

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.
  */

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.
  */

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

@@ -5,4 +5,6 @@ export { BaseInference, InferenceFile, InferenceModel, FailedInferenceResponse,
 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

@@ -3,4 +3,5 @@ export { Job, JobResponse, JobWebhook, } from "./job/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/baseInference.d.ts

@@ -2,7 +2,9 @@ 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. */
+/**
+ * Shared metadata container for v2 inference payloads.
+ */
 export declare abstract class BaseInference {
     /**
      * Model info for the inference.
@@ -21,6 +23,8 @@ export declare abstract class BaseInference {
      */
     id: string;
     protected constructor(serverResponse: StringDict);
-    /** Returns a printable representation of inference metadata. */
+    /**
+     * Returns a printable representation of inference metadata.
+     */
     toString(): string;
 }

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

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

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

@@ -2,11 +2,17 @@ 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. */
+    /**
+     * Indentation level used when rendering field text output.
+     */
     protected _indentLevel: number;
-    /** Confidence level associated with this field. */
+    /**
+     * Confidence level associated with this field.
+     */
     confidence: FieldConfidence | undefined;
-    /** Optional list of source locations for this field. */
+    /**
+     * 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,13 +2,21 @@
  * Confidence level of a field as returned by the V2 API.
  */
 export declare enum FieldConfidence {
-    /** Maximum confidence level. */
+    /**
+     * Maximum confidence level.
+     */
     Certain = "Certain",
-    /** High confidence level. */
+    /**
+     * High confidence level.
+     */
     High = "High",
-    /** Medium confidence level. */
+    /**
+     * Medium confidence level.
+     */
     Medium = "Medium",
-    /** Low confidence level. */
+    /**
+     * Low confidence level.
+     */
     Low = "Low"
 }
 export declare namespace FieldConfidence {

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

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

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

@@ -4,11 +4,17 @@ import { StringDict } from "../../../../parsing/stringDict.js";
  * A field's location on the document.
  */
 export declare class FieldLocation {
-    /** Position information as a list of points in clockwise order. */
+    /**
+     * Position information as a list of points in clockwise order.
+     */
     readonly polygon: Polygon;
-    /** 0-based page index of where the polygon is located. */
+    /**
+     * 0-based page index of where the polygon is located.
+     */
     readonly page: any;
     constructor(serverResponse: StringDict);
-    /** Returns a readable location string. */
+    /**
+     * Returns a readable location string.
+     */
     toString(): string;
 }

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

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

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

@@ -2,16 +2,26 @@ 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. */
+/**
+ * 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. */
+    /**
+     * 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

@@ -1,5 +1,7 @@
 import { createField } from "./fieldFactory.js";
-/** Typed map of extraction fields returned by the API. */
+/**
+ * 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]) => {
@@ -7,7 +9,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 +22,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 +35,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/listField.d.ts

@@ -2,7 +2,9 @@ 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. */
+/**
+ * List-valued inference field.
+ */
 export declare class ListField extends BaseField {
     /**
      * Items contained in the list.
@@ -17,6 +19,8 @@ export declare class ListField extends BaseField {
      * SimpleField items from the list.
      */
     get objectItems(): Array<ObjectField>;
-    /** Returns a readable representation of list items. */
+    /**
+     * Returns a readable representation of list items.
+     */
     toString(): string;
 }

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

@@ -3,7 +3,9 @@ import { BaseField } from "./baseField.js";
 import { ObjectField } from "./objectField.js";
 import { SimpleField } from "./simpleField.js";
 import { createField } from "./fieldFactory.js";
-/** List-valued inference field. */
+/**
+ * List-valued inference field.
+ */
 export class ListField extends BaseField {
     constructor(serverResponse, indentLevel = 0) {
         super(serverResponse, indentLevel);
@@ -44,7 +46,9 @@ export class ListField extends BaseField {
         }
         return result;
     }
-    /** Returns a readable representation of list items. */
+    /**
+     * 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,10 +3,15 @@ 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. */
+/**
+ * Object-valued inference field.
+ */
 export declare class ObjectField extends BaseField {
-    /** Nested fields carried by this object. */
+    /**
+     * Nested fields carried by this object.
+     */
     readonly fields: InferenceFields;
+    constructor(serverResponse: StringDict, indentLevel?: number);
     /**
      * Retrieves the simple sub-fields in the object.
      *
@@ -29,29 +34,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;
 }