mindee 5.6.0 → 5.7.0

package/src/v2/http/mindeeApiV2.js

@@ -3,15 +3,15 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
     if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
     return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
 };
-var _MindeeApiV2_instances, _MindeeApiV2_processResponse;
+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 { sendRequestAndReadResponse } from "../../http/apiCore.js";
 import { LocalInputSource } from "../../input/index.js";
 import { MindeeDeserializationError, MindeeError } from "../../errors/index.js";
 import { MindeeHttpErrorV2 } from "./errors.js";
 import { logger } from "../../logger.js";
-import { SearchResponse } from "../../v2/parsing/search/index.js";
 /**
  * Mindee V2 API handler.
  */
@@ -21,36 +21,13 @@ export class MindeeApiV2 {
         this.settings = new ApiSettings({ dispatcher: dispatcher, apiKey: apiKey });
     }
     /**
-     * Search for models available to the account.
-     * @param name Optional name filter.
-     * @param modelType Optional model type filter.
-     * @returns a `Promise` containing the search response.
-     */
-    async reqGetSearchModel(name, modelType) {
-        const queryParams = {};
-        if (name)
-            queryParams["name"] = name;
-        if (modelType)
-            queryParams["model_type"] = modelType;
-        const options = {
-            method: "GET",
-            headers: this.settings.baseHeaders,
-            hostname: this.settings.hostname,
-            path: "/v2/search/models",
-            queryParams: queryParams,
-            timeoutSecs: this.settings.timeoutSecs,
-        };
-        const response = await sendRequestAndReadResponse(this.settings.dispatcher, options);
-        return __classPrivateFieldGet(this, _MindeeApiV2_instances, "m", _MindeeApiV2_processResponse).call(this, response, SearchResponse);
-    }
-    /**
-     * Sends a document to the inference queue.
+     * Send a file to the asynchronous processing queue for inference processing.
      * @param product Product to enqueue.
      * @param inputSource Local or remote file as an input.
      * @param params {ExtractionParameters} parameters relating to the enqueueing options.
      */
     async reqPostProductEnqueue(product, inputSource, params) {
-        const form = params.getFormData();
+        const form = __classPrivateFieldGet(this, _MindeeApiV2_instances, "m", _MindeeApiV2_paramsToFormData).call(this, params.getRequestParameters());
         if (inputSource instanceof LocalInputSource) {
             form.set("file", new Blob([inputSource.fileObject]), inputSource.filename);
         }
@@ -73,7 +50,7 @@ export class MindeeApiV2 {
         return __classPrivateFieldGet(this, _MindeeApiV2_instances, "m", _MindeeApiV2_processResponse).call(this, result, JobResponse);
     }
     /**
-     * Get the specified Job by its ID.
+     * Get the status of an inference that was previously enqueued.
      * Throws an error if the server's response contains an error.
      * @param jobId The Job ID as returned by the enqueue request.
      * @returns a `Promise` containing the job response.
@@ -82,7 +59,7 @@ export class MindeeApiV2 {
         return this.reqGetJobByUrl(`https://${this.settings.hostname}/v2/jobs/${jobId}`);
     }
     /**
-     * Get the specified Job from a polling URL.
+     * Get the status of an inference that was previously enqueued.
      * Throws an error if the server's response contains an error.
      * @param pollingUrl The polling URL as returned by a Job's pollingUrl property.
      * @returns a `Promise` containing the job response.
@@ -100,7 +77,7 @@ export class MindeeApiV2 {
         return __classPrivateFieldGet(this, _MindeeApiV2_instances, "m", _MindeeApiV2_processResponse).call(this, response, JobResponse);
     }
     /**
-     * Get the result of a queued document from the API.
+     * Get the result of an inference that was previously enqueued.
      * Throws an error if the server's response contains an error.
      * @param product
      * @param inferenceId The inference ID for the result.
@@ -110,7 +87,7 @@ export class MindeeApiV2 {
         return this.reqGetProductResultByUrl(product, `https://${this.settings.hostname}/v2/products/${product.slug}/results/${inferenceId}`);
     }
     /**
-     * Get the result of a queued document from the API.
+     * Get the result of an inference that was previously enqueued.
      * Throws an error if the server's response contains an error.
      * @param product
      * @param url The URL as returned by a Job's resultUrl property.
@@ -128,8 +105,32 @@ export class MindeeApiV2 {
         const response = await sendRequestAndReadResponse(this.settings.dispatcher, options, url);
         return __classPrivateFieldGet(this, _MindeeApiV2_instances, "m", _MindeeApiV2_processResponse).call(this, response, product.responseClass);
     }
+    /**
+     * Searches for resources matching the given criteria.
+     * @param search
+     * @param parameters Search parameters.
+     * @returns a `Promise` containing the search response.
+     */
+    async reqGetSearch(search, parameters) {
+        const options = {
+            method: "GET",
+            headers: this.settings.baseHeaders,
+            hostname: this.settings.hostname,
+            path: `/v2/search/${search.slug}`,
+            queryParams: 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, search.responseClass);
+    }
 }
-_MindeeApiV2_instances = new WeakSet(), _MindeeApiV2_processResponse = function _MindeeApiV2_processResponse(result, responseClass) {
+_MindeeApiV2_instances = new WeakSet(), _MindeeApiV2_paramsToFormData = function _MindeeApiV2_paramsToFormData(params) {
+    const form = new FormData();
+    for (const [key, value] of Object.entries(params)) {
+        form.set(key, value);
+    }
+    return form;
+}, _MindeeApiV2_processResponse = function _MindeeApiV2_processResponse(result, responseClass) {
     if (result.messageObj?.statusCode
         && (result.messageObj?.statusCode > 399 || result.messageObj?.statusCode < 200)) {
         if (result.data?.status !== null) {

package/src/v2/index.d.ts

@@ -1,7 +1,8 @@
 export * as http from "./http/index.js";
 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 type { BaseParameters, TimerOptions } from "./clientOptions/index.js";
+export type { BaseProductParameters, TimerOptions } from "./clientOptions/index.js";
 export { PollingOptions } from "./clientOptions/index.js";

package/src/v2/index.js

@@ -1,6 +1,7 @@
 export * as http from "./http/index.js";
 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 { PollingOptions } from "./clientOptions/index.js";

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

@@ -8,6 +8,7 @@ export declare class ListField extends BaseField {
      * Items contained in the list.
      */
     items: Array<ListField | ObjectField | SimpleField>;
+    constructor(serverResponse: StringDict, indentLevel?: number);
     /**
      * SimpleField items from the list.
      */
@@ -16,7 +17,6 @@ export declare class ListField extends BaseField {
      * SimpleField items from the list.
      */
     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

@@ -5,6 +5,15 @@ import { SimpleField } from "./simpleField.js";
 import { createField } from "./fieldFactory.js";
 /** List-valued inference field. */
 export class ListField extends BaseField {
+    constructor(serverResponse, indentLevel = 0) {
+        super(serverResponse, indentLevel);
+        if (!Array.isArray(serverResponse["items"])) {
+            throw new MindeeDeserializationError(`Expected "items" to be an array in ${JSON.stringify(serverResponse)}.`);
+        }
+        this.items = serverResponse["items"].map((item) => {
+            return createField(item, indentLevel + 1);
+        });
+    }
     /**
      * SimpleField items from the list.
      */
@@ -35,15 +44,6 @@ export class ListField extends BaseField {
         }
         return result;
     }
-    constructor(serverResponse, indentLevel = 0) {
-        super(serverResponse, indentLevel);
-        if (!Array.isArray(serverResponse["items"])) {
-            throw new MindeeDeserializationError(`Expected "items" to be an array in ${JSON.stringify(serverResponse)}.`);
-        }
-        this.items = serverResponse["items"].map((item) => {
-            return createField(item, indentLevel + 1);
-        });
-    }
     /** Returns a readable representation of list items. */
     toString() {
         if (!this.items || this.items.length === 0) {

package/src/v2/parsing/search/baseSearchResponse.d.ts

@@ -0,0 +1,18 @@
+import { StringDict } from "../../../parsing/index.js";
+import { BaseResponse } from "../../../v2/parsing/baseResponse.js";
+import { PaginationMetadata } from "./paginationMetadata.js";
+/**
+ * Base class for search responses.
+ */
+export declare abstract class BaseSearchResponse extends BaseResponse {
+    /**
+     * Pagination metadata.
+     */
+    pagination: PaginationMetadata;
+    protected constructor(serverResponse: StringDict);
+    /**
+     * List of strings representing the search response.
+     */
+    protected abstract bodyLines(): string[];
+    toString(): string;
+}

package/src/v2/parsing/search/baseSearchResponse.js

@@ -0,0 +1,17 @@
+import { BaseResponse } from "../../../v2/parsing/baseResponse.js";
+import { PaginationMetadata } from "./paginationMetadata.js";
+/**
+ * Base class for search responses.
+ */
+export class BaseSearchResponse extends BaseResponse {
+    constructor(serverResponse) {
+        super(serverResponse);
+        this.pagination = new PaginationMetadata(serverResponse["pagination"]);
+    }
+    toString() {
+        const lines = this.bodyLines();
+        lines.push("Pagination Metadata", "###################");
+        lines.push(this.pagination.toString());
+        return lines.join("\n");
+    }
+}

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

@@ -2,3 +2,5 @@ export { PaginationMetadata } from "./paginationMetadata.js";
 export { SearchModel } from "./searchModel.js";
 export { SearchResponse } from "./searchResponse.js";
 export { ModelWebhook } from "./modelWebhook.js";
+export { BaseSearchResponse } from "./baseSearchResponse.js";
+export { SearchRagDocument } from "./searchRagDocument.js";

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

@@ -2,3 +2,5 @@ export { PaginationMetadata } from "./paginationMetadata.js";
 export { SearchModel } from "./searchModel.js";
 export { SearchResponse } from "./searchResponse.js";
 export { ModelWebhook } from "./modelWebhook.js";
+export { BaseSearchResponse } from "./baseSearchResponse.js";
+export { SearchRagDocument } from "./searchRagDocument.js";

package/src/v2/parsing/search/searchModels.d.ts

@@ -0,0 +1,6 @@
+import { SearchModel } from "../../../v2/parsing/search/searchModel.js";
+import { StringDict } from "../../../parsing/index.js";
+export declare class SearchModels extends Array<SearchModel> {
+    constructor(serverResponse?: StringDict[]);
+    toString(): string;
+}

package/src/v2/parsing/search/searchModels.js

@@ -0,0 +1,19 @@
+import { SearchModel } from "../../../v2/parsing/search/searchModel.js";
+export class SearchModels extends Array {
+    constructor(serverResponse = []) {
+        super();
+        this.push(...serverResponse.map((item) => new SearchModel(item)));
+    }
+    toString() {
+        if (this.length === 0) {
+            return "\n";
+        }
+        const lines = [];
+        for (const model of this) {
+            lines.push(`* :Name: ${model.name}`);
+            lines.push(`  :ID: ${model.id}`);
+            lines.push(`  :Model Type: ${model.modelType}`);
+        }
+        return lines.join("\n");
+    }
+}

package/src/v2/parsing/search/searchRagDocument.d.ts

@@ -0,0 +1,35 @@
+import { StringDict } from "../../../parsing/index.js";
+/**
+ * Individual RAG document information.
+ */
+export declare class SearchRagDocument {
+    /**
+     * Unique identifier of the RAG document.
+     */
+    id: string;
+    /**
+     * Model identifier linked to the RAG document.
+     */
+    modelId: string;
+    /**
+     * Original filename of the uploaded document.
+     */
+    filename: string;
+    /**
+     * Date and time of the document creation.
+     */
+    createdAt: Date;
+    /**
+     * Number of times this document was used in an inference.
+     */
+    totalMatches: number;
+    /**
+     * Date and time of the latest matching inference, if any.
+     */
+    lastMatchAt?: Date;
+    /**
+     * Current status of the RAG document.
+     */
+    status: string;
+    constructor(serverResponse: StringDict);
+}

package/src/v2/parsing/search/searchRagDocument.js

@@ -0,0 +1,16 @@
+/**
+ * Individual RAG document information.
+ */
+export class SearchRagDocument {
+    constructor(serverResponse) {
+        this.id = serverResponse["id"];
+        this.modelId = serverResponse["model_id"];
+        this.filename = serverResponse["filename"];
+        this.createdAt = new Date(serverResponse["created_at"]);
+        this.totalMatches = serverResponse["total_matches"];
+        this.lastMatchAt = serverResponse["last_match_at"]
+            ? new Date(serverResponse["last_match_at"])
+            : undefined;
+        this.status = serverResponse["status"];
+    }
+}

package/src/v2/parsing/search/searchRagDocuments.d.ts

@@ -0,0 +1,9 @@
+import { SearchRagDocument } from "../../../v2/parsing/search/searchRagDocument.js";
+import { StringDict } from "../../../parsing/index.js";
+/**
+ * List of RAG documents.
+ */
+export declare class SearchRagDocuments extends Array<SearchRagDocument> {
+    constructor(serverResponse?: StringDict[]);
+    toString(): string;
+}

package/src/v2/parsing/search/searchRagDocuments.js

@@ -0,0 +1,26 @@
+import { SearchRagDocument } from "../../../v2/parsing/search/searchRagDocument.js";
+/**
+ * List of RAG documents.
+ */
+export class SearchRagDocuments extends Array {
+    constructor(serverResponse = []) {
+        super();
+        this.push(...serverResponse.map((item) => new SearchRagDocument(item)));
+    }
+    toString() {
+        if (this.length === 0) {
+            return "\n";
+        }
+        const lines = [];
+        for (const ragDocument of this) {
+            lines.push(`* :ID: ${ragDocument.id}`);
+            lines.push(`  :Model ID: ${ragDocument.modelId}`);
+            lines.push(`  :Filename: ${ragDocument.filename}`);
+            lines.push(`  :Created At: ${ragDocument.createdAt}`);
+            lines.push(`  :Total Matches: ${ragDocument.totalMatches}`);
+            lines.push(`  :Last Match At: ${ragDocument.lastMatchAt}`);
+            lines.push(`  :Status: ${ragDocument.status}`);
+        }
+        return lines.join("\n");
+    }
+}

package/src/v2/parsing/search/searchResponse.d.ts

@@ -1,19 +1,9 @@
 import { StringDict } from "../../../parsing/index.js";
-import { BaseResponse } from "../../../v2/parsing/baseResponse.js";
-import { PaginationMetadata } from "./paginationMetadata.js";
-import { SearchModel } from "./searchModel.js";
+import { ModelSearchResponse } from "../../../v2/search/models/modelSearchResponse.js";
 /**
  * Models search response.
+ * @deprecated Use `ModelSearchResponse` instead.
  */
-export declare class SearchResponse extends BaseResponse {
-    /**
-     * List of models returned by the search.
-     */
-    models: SearchModel[];
-    /**
-     * Pagination metadata.
-     */
-    pagination: PaginationMetadata;
+export declare class SearchResponse extends ModelSearchResponse {
     constructor(serverResponse: StringDict);
-    toString(): string;
 }

package/src/v2/parsing/search/searchResponse.js

@@ -1,24 +1,10 @@
-import { BaseResponse } from "../../../v2/parsing/baseResponse.js";
-import { PaginationMetadata } from "./paginationMetadata.js";
-import { SearchModel } from "./searchModel.js";
+import { ModelSearchResponse } from "../../../v2/search/models/modelSearchResponse.js";
 /**
  * Models search response.
+ * @deprecated Use `ModelSearchResponse` instead.
  */
-export class SearchResponse extends BaseResponse {
+export class SearchResponse extends ModelSearchResponse {
     constructor(serverResponse) {
         super(serverResponse);
-        this.models = (serverResponse["models"] ?? []).map((model) => new SearchModel(model));
-        this.pagination = new PaginationMetadata(serverResponse["pagination"]);
-    }
-    toString() {
-        const lines = ["Models", "#######"];
-        for (const model of this.models) {
-            lines.push(`* :Name: ${model.name}`);
-            lines.push(`  :ID: ${model.id}`);
-            lines.push(`  :Model Type: ${model.modelType}`);
-        }
-        lines.push("Pagination", "##########");
-        lines.push(this.pagination.toString());
-        return lines.join("\n");
     }
 }

package/src/v2/product/baseProduct.d.ts

@@ -1,4 +1,4 @@
-import { BaseParameters } from "../../v2/index.js";
+import { BaseProductParameters } from "../../v2/index.js";
 import { ResponseConstructor } from "../../v2/parsing/index.js";
 /**
  * Base class for all V2 product definitions.
@@ -6,7 +6,10 @@ import { ResponseConstructor } from "../../v2/parsing/index.js";
  * Child classes are passed to the Client when making requests.
  */
 export declare abstract class BaseProduct {
-    static get parametersClass(): new (...args: any[]) => BaseParameters;
+    /** Parameter class accepted by this product. */
+    static get parametersClass(): new (...args: any[]) => BaseProductParameters;
+    /** Response class returned by this product. */
     static get responseClass(): ResponseConstructor<any>;
+    /** API slug for this product. */
     static get slug(): string;
 }

package/src/v2/product/baseProduct.js

@@ -4,12 +4,15 @@
  * Child classes are passed to the Client when making requests.
  */
 export class BaseProduct {
+    /** Parameter class accepted by this product. */
     static get parametersClass() {
         throw new Error("Must define static parameters property");
     }
+    /** Response class returned by this product. */
     static get responseClass() {
         throw new Error("Must define static response property");
     }
+    /** API slug for this product. */
     static get slug() {
         throw new Error("Must define static slug property");
     }

package/src/v2/product/classification/classification.d.ts

@@ -5,10 +5,10 @@ import { BaseProduct } from "../../../v2/product/baseProduct.js";
  * Automatically sort any image or scanned document into categories.
  */
 export declare class Classification extends BaseProduct {
-    /** Parameter class accepted by this product. */
+    /** @inheritDoc */
     static get parametersClass(): typeof ClassificationParameters;
-    /** Response class returned by this product. */
+    /** @inheritDoc */
     static get responseClass(): typeof ClassificationResponse;
-    /** API slug for this product. */
+    /** @inheritDoc */
     static get slug(): string;
 }

package/src/v2/product/classification/classification.js

@@ -5,15 +5,15 @@ import { BaseProduct } from "../../../v2/product/baseProduct.js";
  * Automatically sort any image or scanned document into categories.
  */
 export class Classification extends BaseProduct {
-    /** Parameter class accepted by this product. */
+    /** @inheritDoc */
     static get parametersClass() {
         return ClassificationParameters;
     }
-    /** Response class returned by this product. */
+    /** @inheritDoc */
     static get responseClass() {
         return ClassificationResponse;
     }
-    /** API slug for this product. */
+    /** @inheritDoc */
     static get slug() {
         return "classification";
     }

package/src/v2/product/classification/params/classificationParameters.d.ts

@@ -1,21 +1,7 @@
-import { BaseParameters, BaseParametersConstructor } from "../../../../v2/clientOptions/baseParameters.js";
+import { BaseProductParameters, BaseProductParametersConstructor } from "../../../../v2/clientOptions/baseProductParameters.js";
 /**
- * Parameters accepted by the asynchronous **inference** v2 endpoint.
- *
- * All fields are optional except `modelId`.
- *
- * @category ClientV2
- * @example
- * const params = {
- *   modelId: "YOUR_MODEL_ID",
- *   alias: "YOUR_ALIAS",
- *   webhookIds: ["YOUR_WEBHOOK_ID_1", "YOUR_WEBHOOK_ID_2"],
- *   pollingOptions: {
- *     initialDelaySec: 2,
- *     delaySec: 1.5,
- *   }
- * };
+ * Parameters for sending a file to a Classification product.
  */
-export declare class ClassificationParameters extends BaseParameters {
-    constructor(params: BaseParametersConstructor & {});
+export declare class ClassificationParameters extends BaseProductParameters {
+    constructor(params: BaseProductParametersConstructor & {});
 }

package/src/v2/product/classification/params/classificationParameters.js

@@ -1,23 +1,9 @@
-import { BaseParameters } from "../../../../v2/clientOptions/baseParameters.js";
+import { BaseProductParameters } from "../../../../v2/clientOptions/baseProductParameters.js";
 import { logger } from "../../../../logger.js";
 /**
- * Parameters accepted by the asynchronous **inference** v2 endpoint.
- *
- * All fields are optional except `modelId`.
- *
- * @category ClientV2
- * @example
- * const params = {
- *   modelId: "YOUR_MODEL_ID",
- *   alias: "YOUR_ALIAS",
- *   webhookIds: ["YOUR_WEBHOOK_ID_1", "YOUR_WEBHOOK_ID_2"],
- *   pollingOptions: {
- *     initialDelaySec: 2,
- *     delaySec: 1.5,
- *   }
- * };
+ * Parameters for sending a file to a Classification product.
  */
-export class ClassificationParameters extends BaseParameters {
+export class ClassificationParameters extends BaseProductParameters {
     constructor(params) {
         super({ ...params });
         logger.debug("Classification parameters initialized.");

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

@@ -5,10 +5,10 @@ import { BaseProduct } from "../../../v2/product/baseProduct.js";
  * Identify the borders of documents on each page, matching each one to a category.
  */
 export declare class Crop extends BaseProduct {
-    /** Parameter class accepted by this product. */
+    /** @inheritDoc */
     static get parametersClass(): typeof CropParameters;
-    /** Response class returned by this product. */
+    /** @inheritDoc */
     static get responseClass(): typeof CropResponse;
-    /** API slug for this product. */
+    /** @inheritDoc */
     static get slug(): string;
 }

package/src/v2/product/crop/crop.js

@@ -5,15 +5,15 @@ import { BaseProduct } from "../../../v2/product/baseProduct.js";
  * Identify the borders of documents on each page, matching each one to a category.
  */
 export class Crop extends BaseProduct {
-    /** Parameter class accepted by this product. */
+    /** @inheritDoc */
     static get parametersClass() {
         return CropParameters;
     }
-    /** Response class returned by this product. */
+    /** @inheritDoc */
     static get responseClass() {
         return CropResponse;
     }
-    /** API slug for this product. */
+    /** @inheritDoc */
     static get slug() {
         return "crop";
     }

package/src/v2/product/crop/params/cropParameters.d.ts

@@ -1,21 +1,7 @@
-import { BaseParameters, BaseParametersConstructor } from "../../../../v2/clientOptions/baseParameters.js";
+import { BaseProductParameters, BaseProductParametersConstructor } from "../../../../v2/clientOptions/baseProductParameters.js";
 /**
- * Parameters accepted by the asynchronous **inference** v2 endpoint.
- *
- * All fields are optional except `modelId`.
- *
- * @category ClientV2
- * @example
- * const params = {
- *   modelId: "YOUR_MODEL_ID",
- *   alias: "YOUR_ALIAS",
- *   webhookIds: ["YOUR_WEBHOOK_ID_1", "YOUR_WEBHOOK_ID_2"],
- *   pollingOptions: {
- *     initialDelaySec: 2,
- *     delaySec: 1.5,
- *   }
- * };
+ * Parameters for sending a file to a Crop product.
  */
-export declare class CropParameters extends BaseParameters {
-    constructor(params: BaseParametersConstructor & {});
+export declare class CropParameters extends BaseProductParameters {
+    constructor(params: BaseProductParametersConstructor & {});
 }

package/src/v2/product/crop/params/cropParameters.js

@@ -1,23 +1,9 @@
-import { BaseParameters } from "../../../../v2/clientOptions/baseParameters.js";
+import { BaseProductParameters } from "../../../../v2/clientOptions/baseProductParameters.js";
 import { logger } from "../../../../logger.js";
 /**
- * Parameters accepted by the asynchronous **inference** v2 endpoint.
- *
- * All fields are optional except `modelId`.
- *
- * @category ClientV2
- * @example
- * const params = {
- *   modelId: "YOUR_MODEL_ID",
- *   alias: "YOUR_ALIAS",
- *   webhookIds: ["YOUR_WEBHOOK_ID_1", "YOUR_WEBHOOK_ID_2"],
- *   pollingOptions: {
- *     initialDelaySec: 2,
- *     delaySec: 1.5,
- *   }
- * };
+ * Parameters for sending a file to a Crop product.
  */
-export class CropParameters extends BaseParameters {
+export class CropParameters extends BaseProductParameters {
     constructor(params) {
         super({ ...params });
         logger.debug("Crop parameters initialized.");

package/src/v2/product/extraction/extraction.d.ts

@@ -5,10 +5,10 @@ import { BaseProduct } from "../../../v2/product/baseProduct.js";
  * Automatically extract structured data from any image or scanned document.
  */
 export declare class Extraction extends BaseProduct {
-    /** Parameter class accepted by this product. */
+    /** @inheritDoc */
     static get parametersClass(): typeof ExtractionParameters;
-    /** Response class returned by this product. */
+    /** @inheritDoc */
     static get responseClass(): typeof ExtractionResponse;
-    /** API slug for this product. */
+    /** @inheritDoc */
     static get slug(): string;
 }