mindee 5.7.2 → 5.9.0

package/src/v1/product/resume/resumeV1Document.d.ts

@@ -1,10 +1,10 @@
-import { Prediction, StringDict } from "../../../v1/parsing/common/index.js";
+import { Prediction, StringDict } from "../../parsing/common/index.js";
 import { ResumeV1SocialNetworksUrl } from "./resumeV1SocialNetworksUrl.js";
 import { ResumeV1Language } from "./resumeV1Language.js";
 import { ResumeV1Education } from "./resumeV1Education.js";
 import { ResumeV1ProfessionalExperience } from "./resumeV1ProfessionalExperience.js";
 import { ResumeV1Certificate } from "./resumeV1Certificate.js";
-import { ClassificationField, StringField } from "../../../v1/parsing/standard/index.js";
+import { ClassificationField, StringField } from "../../parsing/standard/index.js";
 /**
  * Resume API version 1.2 document data.
  */

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

@@ -1,10 +1,10 @@
-import { cleanOutString, lineSeparator, } from "../../../v1/parsing/common/index.js";
+import { cleanOutString, lineSeparator, } from "../../parsing/common/index.js";
 import { ResumeV1SocialNetworksUrl } from "./resumeV1SocialNetworksUrl.js";
 import { ResumeV1Language } from "./resumeV1Language.js";
 import { ResumeV1Education } from "./resumeV1Education.js";
 import { ResumeV1ProfessionalExperience } from "./resumeV1ProfessionalExperience.js";
 import { ResumeV1Certificate } from "./resumeV1Certificate.js";
-import { ClassificationField, StringField } from "../../../v1/parsing/standard/index.js";
+import { ClassificationField, StringField } from "../../parsing/standard/index.js";
 /**
  * Resume API version 1.2 document data.
  */

package/src/v1/product/resume/resumeV1Education.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 _ResumeV1Education_instances, _ResumeV1Education_printableValues;
-import { cleanAndTruncate } from "../../../v1/parsing/common/index.js";
+import { cleanAndTruncate } from "../../parsing/common/index.js";
 import { Polygon } from "../../../geometry/index.js";
 /**
  * The list of the candidate's educational background.

package/src/v1/product/resume/resumeV1Language.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 _ResumeV1Language_instances, _ResumeV1Language_printableValues;
-import { cleanAndTruncate } from "../../../v1/parsing/common/index.js";
+import { cleanAndTruncate } from "../../parsing/common/index.js";
 import { Polygon } from "../../../geometry/index.js";
 /**
  * The list of languages that the candidate is proficient in.

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 { cleanAndTruncate } from "../../../v1/parsing/common/index.js";
+import { cleanAndTruncate } from "../../parsing/common/index.js";
 import { Polygon } from "../../../geometry/index.js";
 /**
  * The list of the candidate's professional experiences.

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 { cleanAndTruncate } from "../../../v1/parsing/common/index.js";
+import { cleanAndTruncate } from "../../parsing/common/index.js";
 import { Polygon } from "../../../geometry/index.js";
 /**
  * The list of social network profiles of the candidate.

package/src/v1/product/us/bankCheck/bankCheckV1.d.ts

@@ -1,4 +1,4 @@
-import { Inference, StringDict, Page } from "../../../../v1/parsing/common/index.js";
+import { Inference, StringDict, Page } from "../../../parsing/common/index.js";
 import { BankCheckV1Document } from "./bankCheckV1Document.js";
 import { BankCheckV1Page } from "./bankCheckV1Page.js";
 /**

package/src/v1/product/us/bankCheck/bankCheckV1.js

@@ -1,4 +1,4 @@
-import { Inference, Page } from "../../../../v1/parsing/common/index.js";
+import { Inference, Page } from "../../../parsing/common/index.js";
 import { BankCheckV1Document } from "./bankCheckV1Document.js";
 import { BankCheckV1Page } from "./bankCheckV1Page.js";
 /**

package/src/v1/product/us/bankCheck/bankCheckV1Document.d.ts

@@ -1,5 +1,5 @@
-import { Prediction, StringDict } from "../../../../v1/parsing/common/index.js";
-import { AmountField, DateField, StringField } from "../../../../v1/parsing/standard/index.js";
+import { Prediction, StringDict } from "../../../parsing/common/index.js";
+import { AmountField, DateField, StringField } from "../../../parsing/standard/index.js";
 /**
  * Bank Check API version 1.1 document data.
  */

package/src/v1/product/us/bankCheck/bankCheckV1Document.js

@@ -1,5 +1,5 @@
-import { cleanOutString, } from "../../../../v1/parsing/common/index.js";
-import { AmountField, DateField, StringField, } from "../../../../v1/parsing/standard/index.js";
+import { cleanOutString, } from "../../../parsing/common/index.js";
+import { AmountField, DateField, StringField, } from "../../../parsing/standard/index.js";
 /**
  * Bank Check API version 1.1 document data.
  */

package/src/v1/product/us/bankCheck/bankCheckV1Page.d.ts

@@ -1,5 +1,5 @@
-import { StringDict } from "../../../../v1/parsing/common/index.js";
-import { PositionField } from "../../../../v1/parsing/standard/index.js";
+import { StringDict } from "../../../parsing/common/index.js";
+import { PositionField } from "../../../parsing/standard/index.js";
 import { BankCheckV1Document } from "./bankCheckV1Document.js";
 /**
  * Bank Check API version 1.1 page data.

package/src/v1/product/us/bankCheck/bankCheckV1Page.js

@@ -1,5 +1,5 @@
-import { cleanOutString } from "../../../../v1/parsing/common/index.js";
-import { PositionField } from "../../../../v1/parsing/standard/index.js";
+import { cleanOutString } from "../../../parsing/common/index.js";
+import { PositionField } from "../../../parsing/standard/index.js";
 import { BankCheckV1Document } from "./bankCheckV1Document.js";
 /**
  * Bank Check API version 1.1 page data.

package/src/v2/cli.js

@@ -1,7 +1,7 @@
 import { Command } from "commander";
 import * as console from "console";
 import { Client, PathInput, UrlInput } from "../index.js";
-import { Classification, Crop, Extraction, Ocr, Split, } from "../v2/product/index.js";
+import { Classification, Crop, Extraction, Ocr, Split, } from "./product/index.js";
 const program = new Command();
 //
 // EXECUTE THE COMMANDS

package/src/v2/client.d.ts

@@ -4,8 +4,9 @@ import { JobResponse } from "./parsing/index.js";
 import { SearchResponse } from "./parsing/search/index.js";
 import { MindeeApiV2 } from "./http/mindeeApiV2.js";
 import { PollingOptions, PollingOptionsConstructor } from "./clientOptions/index.js";
-import { BaseProduct } from "../v2/product/baseProduct.js";
-import { BaseSearch } from "../v2/search/baseSearch.js";
+import { BaseProduct } from "./product/baseProduct.js";
+import { BaseSearch } from "./search/baseSearch.js";
+import { LocalInputSource } from "../input/index.js";
 /**
  * Options for the V2 Mindee Client.
  * @example
@@ -27,28 +28,17 @@ export interface ClientOptions {
  * Mindee Client V2 class that centralizes most basic operations.
  */
 export declare class Client {
-    /** Mindee V2 API handler. */
+    /**
+     * Mindee V2 API handler.
+     */
     protected mindeeApi: MindeeApiV2;
     /**
      * @param {ClientOptions} options options for the initialization of a client.
      */
     constructor({ apiKey, debug, dispatcher }?: ClientOptions);
     /**
-     * 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.
-     * @deprecated Use `search(ModelSearch, {})` instead.
+     * Enqueues a product inference job without waiting for completion.
      */
-    searchModels(name?: string, modelType?: string): Promise<SearchResponse>;
-    /**
-     * Search for resources matching the given criteria.
-     * @param search Search definition class to use.
-     * @param searchParameters Search parameters.
-     * @returns a `Promise` containing the search response with the matching resources.
-     */
-    search<S extends typeof BaseSearch>(search: S, searchParameters: InstanceType<S["parametersClass"]> | ConstructorParameters<S["parametersClass"]>[0]): Promise<InstanceType<S["responseClass"]>>;
-    /** 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.
@@ -91,11 +81,97 @@ export declare class Client {
      * @typeParam T an extension of an `Inference`. Can be omitted as it will be inferred from the `productClass`.
      * @returns a `Promise` containing parsing results.
      */
-    enqueueAndGetResult<P extends typeof BaseProduct>(product: P, inputSource: InputSource, params: InstanceType<P["parametersClass"]> | ConstructorParameters<P["parametersClass"]>[0], pollingOptions?: PollingOptionsConstructor): Promise<InstanceType<P["responseClass"]>>;
+    enqueueAndGetResult<P extends typeof BaseProduct>(product: P, inputSource: InputSource, params: InstanceType<P["parametersClass"]> | ConstructorParameters<P["parametersClass"]>[0], pollingOptions?: PollingOptions | PollingOptionsConstructor): Promise<InstanceType<P["responseClass"]>>;
     /**
      * Send a document to an endpoint and poll the server until the result is sent or
      * until the maximum number of tries is reached.
      * @protected
      */
     protected pollForResult<P extends typeof BaseProduct>(product: typeof BaseProduct, pollingOptions: PollingOptions, jobResponse: JobResponse): Promise<InstanceType<P["responseClass"]>>;
+    /**
+     * 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.
+     * @deprecated Use `search(ModelSearch, {})` instead.
+     */
+    searchModels(name?: string, modelType?: string): Promise<SearchResponse>;
+    /**
+     * Search for resources matching the given criteria.
+     * @param search Search definition class to use.
+     * @param searchParameters Search parameters.
+     * @returns a `Promise` containing the search response with the matching resources.
+     */
+    search<S extends typeof BaseSearch>(search: S, searchParameters: InstanceType<S["parametersClass"]> | ConstructorParameters<S["parametersClass"]>[0]): Promise<InstanceType<S["responseClass"]>>;
+    /**
+     * Not recommended for general use, prefer `getReadyRagDocumentPoll`.
+     * You will need to poll until the document is ready for use.
+     * Get a document's info and annotations from the RAG database.
+     *
+     * @param product the product the RAG database belongs to.
+     * @param documentId the document's ID.
+     */
+    getRagDocument<P extends typeof BaseProduct>(product: P, documentId: string): Promise<InstanceType<P["annotationResponseClass"]>>;
+    /**
+     * Get a document's info and annotations from the RAG database.
+     *
+     * @param product the product the RAG database belongs to.
+     * @param documentId the document's ID.
+     * @param pollingOptions options for the polling loop, see {@link PollingOptions}.
+     * @returns a `Promise` containing the RAG document annotation.
+     */
+    getReadyRagDocumentPoll<P extends typeof BaseProduct>(product: P, documentId: string, pollingOptions?: PollingOptions | PollingOptionsConstructor): Promise<InstanceType<P["annotationResponseClass"]>>;
+    /**
+     * Not recommended for general use, prefer `uploadAndGetRagDocumentPoll`.
+     * You will need to poll until the document is ready for use.
+     * Add a document to the RAG database.
+     *
+     * @param product The product the RAG database belongs to.
+     * @param inputSource The file to upload.
+     * @param parameters The parameters to use for the upload.
+     */
+    uploadRagDocument<P extends typeof BaseProduct>(product: P, inputSource: LocalInputSource, parameters: InstanceType<P["ragDocumentUploadClass"]> | ConstructorParameters<P["ragDocumentUploadClass"]>[0]): Promise<InstanceType<P["annotationResponseClass"]>>;
+    /**
+     * Add a document to the RAG database and return the initial annotation.
+     *
+     * @param product The product the RAG database belongs to.
+     * @param inputSource The file to upload.
+     * @param parameters The parameters to use for the upload.
+     * @param pollingOptions options for the polling loop, see {@link PollingOptions}.
+     */
+    uploadAndGetRagDocumentPoll<P extends typeof BaseProduct>(product: P, inputSource: LocalInputSource, parameters: InstanceType<P["ragDocumentUploadClass"]> | ConstructorParameters<P["ragDocumentUploadClass"]>[0], pollingOptions?: PollingOptions | PollingOptionsConstructor): Promise<InstanceType<P["annotationResponseClass"]>>;
+    /**
+     * Not recommended for general use, prefer `updateAndGetRagAnnotationPoll`.
+     * You will need to poll until the document is ready for use.
+     * Update a document's annotations in the RAG database.
+     *
+     * @param product The product the RAG database belongs to.
+     * @param parameters The parameters to use for the update.
+     */
+    updateRagAnnotation<P extends typeof BaseProduct>(product: P, parameters: InstanceType<P["annotationParametersClass"]> | ConstructorParameters<P["annotationParametersClass"]>[0]): Promise<InstanceType<P["annotationResponseClass"]>>;
+    /**
+     * Update a document's annotations in the RAG database and poll until ready.
+     *
+     * @param product The product the RAG database belongs to.
+     * @param parameters The parameters to use for the update.
+     * @param pollingOptions options for the polling loop, see {@link PollingOptions}.
+     * @returns a `Promise` containing the RAG document annotation.
+     */
+    updateAndGetRagAnnotationPoll<P extends typeof BaseProduct>(product: P, parameters: InstanceType<P["annotationParametersClass"]> | ConstructorParameters<P["annotationParametersClass"]>[0], pollingOptions?: PollingOptions | PollingOptionsConstructor): Promise<InstanceType<P["annotationResponseClass"]>>;
+    /**
+     * Deletes a document from the RAG database.
+     * @param product the product the RAG database belongs to.
+     * @param documentId the document's ID.
+     */
+    deleteRagDocument<P extends typeof BaseProduct>(product: P, documentId: string): Promise<boolean>;
+    /**
+     * Poll until the document is finished processing or the max number of attempts is reached.
+     *
+     * @param product The product the RAG database belongs to.
+     * @param initialResponse The initial response containing the document's ID.
+     * @param pollingOptions Options for the polling loop, see {@link PollingOptions}.
+     * @returns A `Promise` containing the RAG document annotation.
+     * @protected
+     */
+    protected pollForRagDocument<P extends typeof BaseProduct>(product: P, initialResponse: InstanceType<P["annotationResponseClass"]>, pollingOptions: PollingOptions): Promise<InstanceType<P["annotationResponseClass"]>>;
 }

package/src/v2/client.js

@@ -5,7 +5,7 @@ import { LOG_LEVELS, logger } from "../logger.js";
 import { MindeeApiV2 } from "./http/mindeeApiV2.js";
 import { MindeeHttpErrorV2 } from "./http/errors.js";
 import { PollingOptions } from "./clientOptions/index.js";
-import { ModelSearch } from "../v2/search/models/modelSearch.js";
+import { ModelSearch } from "./search/models/modelSearch.js";
 /**
  * Mindee Client V2 class that centralizes most basic operations.
  */
@@ -27,31 +27,8 @@ export class Client {
         logger.debug("Client V2 Initialized");
     }
     /**
-     * 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.
-     * @deprecated Use `search(ModelSearch, {})` instead.
-     */
-    async searchModels(name, modelType) {
-        return await this.search(ModelSearch, { name: name, modelType: modelType });
-    }
-    /**
-     * Search for resources matching the given criteria.
-     * @param search Search definition class to use.
-     * @param searchParameters Search parameters.
-     * @returns a `Promise` containing the search response with the matching resources.
+     * Enqueues a product inference job without waiting for completion.
      */
-    async search(search, searchParameters) {
-        if (!searchParameters) {
-            throw new MindeeError("Search parameters are required.");
-        }
-        const paramsInstance = searchParameters instanceof search.parametersClass
-            ? searchParameters
-            : new search.parametersClass(searchParameters);
-        return await this.mindeeApi.reqGetSearch(search, paramsInstance);
-    }
-    /** 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.");
@@ -118,9 +95,13 @@ export class Client {
      * @returns a `Promise` containing parsing results.
      */
     async enqueueAndGetResult(product, inputSource, params, pollingOptions) {
-        const paramsInstance = new product.parametersClass(params);
-        const pollingOptionsInstance = new PollingOptions(pollingOptions);
+        const paramsInstance = params instanceof product.parametersClass
+            ? params
+            : new product.parametersClass(params);
         const jobResponse = await this.enqueue(product, inputSource, paramsInstance);
+        const pollingOptionsInstance = pollingOptions instanceof PollingOptions
+            ? pollingOptions
+            : new PollingOptions(pollingOptions);
         return await this.pollForResult(product, pollingOptionsInstance, jobResponse);
     }
     /**
@@ -157,4 +138,167 @@ export class Client {
         throw new MindeeError(`Polling failed to retrieve a result after ${retryCounter} attempts. ` +
             "You can increase poll attempts by passing the pollingOptions argument to enqueueAndGetResult()");
     }
+    /**
+     * 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.
+     * @deprecated Use `search(ModelSearch, {})` instead.
+     */
+    async searchModels(name, modelType) {
+        return await this.search(ModelSearch, { name: name, modelType: modelType });
+    }
+    /**
+     * Search for resources matching the given criteria.
+     * @param search Search definition class to use.
+     * @param searchParameters Search parameters.
+     * @returns a `Promise` containing the search response with the matching resources.
+     */
+    async search(search, searchParameters) {
+        if (!searchParameters) {
+            throw new MindeeError("Search parameters are required.");
+        }
+        const paramsInstance = searchParameters instanceof search.parametersClass
+            ? searchParameters
+            : new search.parametersClass(searchParameters);
+        return await this.mindeeApi.reqGetSearch(search, paramsInstance);
+    }
+    /**
+     * Not recommended for general use, prefer `getReadyRagDocumentPoll`.
+     * You will need to poll until the document is ready for use.
+     * Get a document's info and annotations from the RAG database.
+     *
+     * @param product the product the RAG database belongs to.
+     * @param documentId the document's ID.
+     */
+    async getRagDocument(product, documentId) {
+        logger.debug(`Getting RAG document ID: ${documentId}`);
+        return await this.mindeeApi.reqGetRagAnnotation(product, documentId);
+    }
+    /**
+     * Get a document's info and annotations from the RAG database.
+     *
+     * @param product the product the RAG database belongs to.
+     * @param documentId the document's ID.
+     * @param pollingOptions options for the polling loop, see {@link PollingOptions}.
+     * @returns a `Promise` containing the RAG document annotation.
+     */
+    async getReadyRagDocumentPoll(product, documentId, pollingOptions) {
+        const initialResponse = await this.getRagDocument(product, documentId);
+        if (initialResponse.status !== "Processing") {
+            return initialResponse;
+        }
+        const pollingOptionsInstance = pollingOptions instanceof PollingOptions
+            ? pollingOptions
+            : new PollingOptions(pollingOptions);
+        return await this.pollForRagDocument(product, initialResponse, pollingOptionsInstance);
+    }
+    /**
+     * Not recommended for general use, prefer `uploadAndGetRagDocumentPoll`.
+     * You will need to poll until the document is ready for use.
+     * Add a document to the RAG database.
+     *
+     * @param product The product the RAG database belongs to.
+     * @param inputSource The file to upload.
+     * @param parameters The parameters to use for the upload.
+     */
+    async uploadRagDocument(product, inputSource, parameters) {
+        logger.debug("Adding a document to the RAG database");
+        const paramsInstance = parameters instanceof product.ragDocumentUploadClass
+            ? parameters
+            : new product.ragDocumentUploadClass(parameters);
+        await inputSource.init();
+        return await this.mindeeApi.reqPostRagDocument(product, paramsInstance, inputSource);
+    }
+    /**
+     * Add a document to the RAG database and return the initial annotation.
+     *
+     * @param product The product the RAG database belongs to.
+     * @param inputSource The file to upload.
+     * @param parameters The parameters to use for the upload.
+     * @param pollingOptions options for the polling loop, see {@link PollingOptions}.
+     */
+    async uploadAndGetRagDocumentPoll(product, inputSource, parameters, pollingOptions) {
+        const initialResponse = await this.uploadRagDocument(product, inputSource, parameters);
+        if (initialResponse.status !== "Processing") {
+            return initialResponse;
+        }
+        const pollingOptionsInstance = pollingOptions instanceof PollingOptions
+            ? pollingOptions
+            : new PollingOptions(pollingOptions);
+        return await this.pollForRagDocument(product, initialResponse, pollingOptionsInstance);
+    }
+    /**
+     * Not recommended for general use, prefer `updateAndGetRagAnnotationPoll`.
+     * You will need to poll until the document is ready for use.
+     * Update a document's annotations in the RAG database.
+     *
+     * @param product The product the RAG database belongs to.
+     * @param parameters The parameters to use for the update.
+     */
+    async updateRagAnnotation(product, parameters) {
+        const paramsInstance = parameters instanceof product.annotationParametersClass
+            ? parameters
+            : new product.annotationParametersClass(parameters);
+        logger.debug(`Updating RAG document ID: ${paramsInstance.documentId}`);
+        return await this.mindeeApi.reqPatchRagAnnotation(product, paramsInstance);
+    }
+    /**
+     * Update a document's annotations in the RAG database and poll until ready.
+     *
+     * @param product The product the RAG database belongs to.
+     * @param parameters The parameters to use for the update.
+     * @param pollingOptions options for the polling loop, see {@link PollingOptions}.
+     * @returns a `Promise` containing the RAG document annotation.
+     */
+    async updateAndGetRagAnnotationPoll(product, parameters, pollingOptions) {
+        const initialResponse = await this.updateRagAnnotation(product, parameters);
+        if (initialResponse.status !== "Processing") {
+            return initialResponse;
+        }
+        const pollingOptionsInstance = pollingOptions instanceof PollingOptions
+            ? pollingOptions
+            : new PollingOptions(pollingOptions);
+        return await this.pollForRagDocument(product, initialResponse, pollingOptionsInstance);
+    }
+    /**
+     * Deletes a document from the RAG database.
+     * @param product the product the RAG database belongs to.
+     * @param documentId the document's ID.
+     */
+    async deleteRagDocument(product, documentId) {
+        return await this.mindeeApi.reqDeleteRagDocument(product, documentId);
+    }
+    /**
+     * Poll until the document is finished processing or the max number of attempts is reached.
+     *
+     * @param product The product the RAG database belongs to.
+     * @param initialResponse The initial response containing the document's ID.
+     * @param pollingOptions Options for the polling loop, see {@link PollingOptions}.
+     * @returns A `Promise` containing the RAG document annotation.
+     * @protected
+     */
+    async pollForRagDocument(product, initialResponse, pollingOptions) {
+        logger.debug(`Polling for RAG document ID: ${initialResponse.id}`);
+        const maxRetries = pollingOptions.maxRetries + 1;
+        logger.debug(`Waiting ${pollingOptions.initialDelaySec} seconds before attempting to retrieve the result...`);
+        await setTimeout(pollingOptions.initialDelaySec * 1000, undefined, pollingOptions.initialTimerOptions);
+        const documentId = initialResponse.id;
+        let retryCount = 1;
+        while (retryCount < maxRetries) {
+            logger.debug(`Poll attempt ${retryCount} of ${pollingOptions.maxRetries}`);
+            const response = await this.getRagDocument(product, documentId);
+            retryCount++;
+            switch (response.status) {
+                case "Processing":
+                    await setTimeout(pollingOptions.delaySec * 1000, undefined, pollingOptions.recurringTimerOptions);
+                    continue;
+                case "Failed":
+                    throw new MindeeError("RAG document failed without an error payload.");
+                default:
+                    return response;
+            }
+        }
+        throw new MindeeError(`RAG polling not complete after ${retryCount} attempts.`);
+    }
 }

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

@@ -0,0 +1,23 @@
+/**
+ * Constructor parameters for BaseAnnotationParameters and its subclasses.
+ */
+export interface BaseAnnotationParametersConstructor {
+    documentId: string;
+}
+/**
+ * Base parameters for document annotations.
+ */
+export declare abstract class BaseAnnotationParameters {
+    /**
+     * UUID of the annotated document.
+     */
+    readonly documentId: string;
+    /**
+     * Default constructor.
+     */
+    protected constructor(params: BaseAnnotationParametersConstructor);
+    /**
+     * Gets the request parameters for the upload request.
+     */
+    abstract getRequestParameters(): Record<string, string>;
+}

package/src/v2/clientOptions/baseAnnotationParameters.js

@@ -0,0 +1,17 @@
+import { MindeeConfigurationError } from "../../errors/index.js";
+/**
+ * Base parameters for document annotations.
+ */
+export class BaseAnnotationParameters {
+    /**
+     * Default constructor.
+     */
+    constructor(params) {
+        const documentId = params.documentId?.trim();
+        if (!documentId) {
+            throw new MindeeConfigurationError("Document ID must be provided");
+        }
+        // Note: documentId is included in the request URL path, it is not a parameter.
+        this.documentId = documentId;
+    }
+}

package/src/v2/clientOptions/baseProductParameters.js

@@ -4,10 +4,11 @@ import { MindeeConfigurationError } from "../../errors/index.js";
  */
 export class BaseProductParameters {
     constructor(params) {
-        if (params.modelId === undefined || params.modelId === null || params.modelId === "") {
+        const modelId = params.modelId?.trim();
+        if (!modelId) {
             throw new MindeeConfigurationError("Model ID must be provided");
         }
-        this.modelId = params.modelId;
+        this.modelId = modelId;
         this.alias = params.alias;
         this.webhookIds = params.webhookIds;
         this.closeFile = params.closeFile;

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

@@ -0,0 +1,23 @@
+/**
+ * Constructor parameters for BaseRagDocumentUploadParameters and its subclasses.
+ */
+export interface BaseRagDocumentUploadParametersConstructor {
+    modelId: string;
+}
+/**
+ * Base parameters for document upload operations.
+ */
+export declare abstract class BaseRagDocumentUploadParameters {
+    /**
+     * UUID of the model that the uploaded RAG document is linked to.
+     */
+    readonly modelId: string;
+    /**
+     * Default constructor.
+     */
+    protected constructor(params: BaseRagDocumentUploadParametersConstructor);
+    /**
+     * Gets the request parameters for the upload request.
+     */
+    getRequestParameters(): Record<string, string>;
+}

package/src/v2/clientOptions/baseRagDocumentUploadParameters.js

@@ -0,0 +1,24 @@
+import { MindeeConfigurationError } from "../../errors/index.js";
+/**
+ * Base parameters for document upload operations.
+ */
+export class BaseRagDocumentUploadParameters {
+    /**
+     * Default constructor.
+     */
+    constructor(params) {
+        const modelId = params.modelId?.trim();
+        if (!modelId) {
+            throw new MindeeConfigurationError("Model ID must be provided");
+        }
+        this.modelId = modelId;
+    }
+    /**
+     * Gets the request parameters for the upload request.
+     */
+    getRequestParameters() {
+        const parameters = {};
+        parameters["model_id"] = this.modelId;
+        return parameters;
+    }
+}

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

@@ -2,3 +2,5 @@ export { PollingOptions } from "./pollingOptions.js";
 export type { PollingOptionsConstructor, TimerOptions, } from "./pollingOptions.js";
 export { BaseProductParameters } from "./baseProductParameters.js";
 export { BaseSearchParameters } from "./baseSearchParameters.js";
+export { BaseRagDocumentUploadParameters } from "./baseRagDocumentUploadParameters.js";
+export { BaseAnnotationParameters } from "./baseAnnotationParameters.js";

package/src/v2/clientOptions/index.js

@@ -1,3 +1,5 @@
 export { PollingOptions } from "./pollingOptions.js";
 export { BaseProductParameters } from "./baseProductParameters.js";
 export { BaseSearchParameters } from "./baseSearchParameters.js";
+export { BaseRagDocumentUploadParameters } from "./baseRagDocumentUploadParameters.js";
+export { BaseAnnotationParameters } from "./baseAnnotationParameters.js";

package/src/v2/fileOperations/crop.d.ts

@@ -1,5 +1,5 @@
 import { LocalInputSource } from "../../input/index.js";
-import { CropItem } from "../../v2/product/crop/index.js";
+import { CropItem } from "../product/crop/index.js";
 import { ExtractedImage, ExtractedImages } from "../../image/index.js";
 /**
  * Extracts a single specified crop from a given input source.

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

@@ -1,4 +1,4 @@
-import { ErrorDetails, ErrorItem, ErrorResponse } from "../../v2/parsing/index.js";
+import { ErrorDetails, ErrorItem, ErrorResponse } from "../parsing/index.js";
 import { MindeeError } from "../../errors/index.js";
 /**
  * HTTP error returned by the API.