mindee 5.6.1 → 5.7.1

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;
 }

package/src/v2/product/extraction/extraction.js

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

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

@@ -1,26 +1,10 @@
-import { FormData } from "undici";
 import { StringDict } from "../../../../parsing/stringDict.js";
 import { DataSchema } from "./dataSchema.js";
-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",
- *   rag: true,
- *   alias: "YOUR_ALIAS",
- *   webhookIds: ["YOUR_WEBHOOK_ID_1", "YOUR_WEBHOOK_ID_2"],
- *   pollingOptions: {
- *     initialDelaySec: 2,
- *     delaySec: 1.5,
- *   }
- * };
+ * Parameters for sending a file to an Extraction product.
  */
-export declare class ExtractionParameters extends BaseParameters {
+export declare class ExtractionParameters extends BaseProductParameters {
     /**
      * Use Retrieval-Augmented Generation during inference.
      */
@@ -48,7 +32,7 @@ export declare class ExtractionParameters extends BaseParameters {
      * Not recommended, for specific use only.
      */
     dataSchema?: DataSchema | StringDict | string;
-    constructor(params: BaseParametersConstructor & {
+    constructor(params: BaseProductParametersConstructor & {
         rag?: boolean;
         rawText?: boolean;
         polygon?: boolean;
@@ -56,5 +40,5 @@ export declare class ExtractionParameters extends BaseParameters {
         textContext?: string;
         dataSchema?: DataSchema | StringDict | string;
     });
-    getFormData(): FormData;
+    getRequestParameters(): Record<string, string>;
 }

package/src/v2/product/extraction/params/extractionParameters.js

@@ -1,26 +1,10 @@
-import { FormData } from "undici";
 import { DataSchema } from "./dataSchema.js";
-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",
- *   rag: true,
- *   alias: "YOUR_ALIAS",
- *   webhookIds: ["YOUR_WEBHOOK_ID_1", "YOUR_WEBHOOK_ID_2"],
- *   pollingOptions: {
- *     initialDelaySec: 2,
- *     delaySec: 1.5,
- *   }
- * };
+ * Parameters for sending a file to an Extraction product.
  */
-export class ExtractionParameters extends BaseParameters {
+export class ExtractionParameters extends BaseProductParameters {
     constructor(params) {
         super({ ...params });
         this.rag = params.rag;
@@ -38,30 +22,26 @@ export class ExtractionParameters extends BaseParameters {
         }
         logger.debug("Extraction parameters initialized.");
     }
-    getFormData() {
-        const form = new FormData();
-        form.set("model_id", this.modelId);
+    getRequestParameters() {
+        const parameters = super.getRequestParameters();
         if (this.rag !== undefined && this.rag !== null) {
-            form.set("rag", this.rag.toString());
+            parameters["rag"] = this.rag.toString();
         }
         if (this.polygon !== undefined && this.polygon !== null) {
-            form.set("polygon", this.polygon.toString().toLowerCase());
+            parameters["polygon"] = this.polygon.toString().toLowerCase();
         }
         if (this.confidence !== undefined && this.confidence !== null) {
-            form.set("confidence", this.confidence.toString().toLowerCase());
+            parameters["confidence"] = this.confidence.toString().toLowerCase();
         }
         if (this.rawText !== undefined && this.rawText !== null) {
-            form.set("raw_text", this.rawText.toString().toLowerCase());
+            parameters["raw_text"] = this.rawText.toString().toLowerCase();
         }
         if (this.textContext !== undefined && this.textContext !== null) {
-            form.set("text_context", this.textContext);
+            parameters["text_context"] = this.textContext;
         }
         if (this.dataSchema !== undefined && this.dataSchema !== null) {
-            form.set("data_schema", this.dataSchema.toString());
+            parameters["data_schema"] = this.dataSchema.toString();
         }
-        if (this.webhookIds && this.webhookIds.length > 0) {
-            form.set("webhook_ids", this.webhookIds.join(","));
-        }
-        return form;
+        return parameters;
     }
 }

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

@@ -5,10 +5,10 @@ import { BaseProduct } from "../../../v2/product/baseProduct.js";
  * Extract raw text (OCR) from any image or scanned document.
  */
 export declare class Ocr extends BaseProduct {
-    /** Parameter class accepted by this product. */
+    /** @inheritDoc */
     static get parametersClass(): typeof OcrParameters;
-    /** Response class returned by this product. */
+    /** @inheritDoc */
     static get responseClass(): typeof OcrResponse;
-    /** API slug for this product. */
+    /** @inheritDoc */
     static get slug(): string;
 }

package/src/v2/product/ocr/ocr.js

@@ -5,15 +5,15 @@ import { BaseProduct } from "../../../v2/product/baseProduct.js";
  * Extract raw text (OCR) from any image or scanned document.
  */
 export class Ocr extends BaseProduct {
-    /** Parameter class accepted by this product. */
+    /** @inheritDoc */
     static get parametersClass() {
         return OcrParameters;
     }
-    /** Response class returned by this product. */
+    /** @inheritDoc */
     static get responseClass() {
         return OcrResponse;
     }
-    /** API slug for this product. */
+    /** @inheritDoc */
     static get slug() {
         return "ocr";
     }

package/src/v2/product/ocr/params/ocrParameters.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 Raw Text (OCR) product.
  */
-export declare class OcrParameters extends BaseParameters {
-    constructor(params: BaseParametersConstructor & {});
+export declare class OcrParameters extends BaseProductParameters {
+    constructor(params: BaseProductParametersConstructor & {});
 }

package/src/v2/product/ocr/params/ocrParameters.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 Raw Text (OCR) product.
  */
-export class OcrParameters extends BaseParameters {
+export class OcrParameters extends BaseProductParameters {
     constructor(params) {
         super({ ...params });
         logger.debug("OCR parameters initialized.");

package/src/v2/product/split/params/splitParameters.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 Split product.
  */
-export declare class SplitParameters extends BaseParameters {
-    constructor(params: BaseParametersConstructor & {});
+export declare class SplitParameters extends BaseProductParameters {
+    constructor(params: BaseProductParametersConstructor & {});
 }

package/src/v2/product/split/params/splitParameters.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 Split product.
  */
-export class SplitParameters extends BaseParameters {
+export class SplitParameters extends BaseProductParameters {
     constructor(params) {
         super({ ...params });
         logger.debug("Split parameters initialized.");

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

@@ -5,10 +5,10 @@ import { BaseProduct } from "../../../v2/product/baseProduct.js";
  * Break a multipage source file into separate documents, associating a class for each one.
  */
 export declare class Split extends BaseProduct {
-    /** Parameter class accepted by this product. */
+    /** @inheritDoc */
     static get parametersClass(): typeof SplitParameters;
-    /** Response class returned by this product. */
+    /** @inheritDoc */
     static get responseClass(): typeof SplitResponse;
-    /** API slug for this product. */
+    /** @inheritDoc */
     static get slug(): string;
 }

package/src/v2/product/split/split.js

@@ -5,15 +5,15 @@ import { BaseProduct } from "../../../v2/product/baseProduct.js";
  * Break a multipage source file into separate documents, associating a class for each one.
  */
 export class Split extends BaseProduct {
-    /** Parameter class accepted by this product. */
+    /** @inheritDoc */
     static get parametersClass() {
         return SplitParameters;
     }
-    /** Response class returned by this product. */
+    /** @inheritDoc */
     static get responseClass() {
         return SplitResponse;
     }
-    /** API slug for this product. */
+    /** @inheritDoc */
     static get slug() {
         return "split";
     }

package/src/v2/search/baseSearch.d.ts

@@ -0,0 +1,15 @@
+import { ResponseConstructor } from "../../v2/parsing/index.js";
+import { BaseSearchParameters } from "../../v2/clientOptions/index.js";
+/**
+ * Base class for all V2 search definitions.
+ *
+ * Child classes are passed to the Client when making requests.
+ */
+export declare abstract class BaseSearch {
+    /** Parameter class used for the search query. */
+    static get parametersClass(): new (...args: any[]) => BaseSearchParameters;
+    /** Response class returned by the search. */
+    static get responseClass(): ResponseConstructor<any>;
+    /** API slug for the search. */
+    static get slug(): string;
+}

package/src/v2/search/baseSearch.js

@@ -0,0 +1,19 @@
+/**
+ * Base class for all V2 search definitions.
+ *
+ * Child classes are passed to the Client when making requests.
+ */
+export class BaseSearch {
+    /** Parameter class used for the search query. */
+    static get parametersClass() {
+        throw new Error("Must define static parametersClass property");
+    }
+    /** Response class returned by the search. */
+    static get responseClass() {
+        throw new Error("Must define static response property");
+    }
+    /** API slug for the search. */
+    static get slug() {
+        throw new Error("Must define static slug property");
+    }
+}

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

@@ -0,0 +1,6 @@
+export * as models from "./models/index.js";
+export * as ragDocuments from "./ragDocuments/index.js";
+export { ModelSearchParameters, ModelSearchResponse } from "./models/index.js";
+export { RagDocumentSearchParameters, RagDocumentSearchResponse } from "./ragDocuments/index.js";
+export { ModelSearch } from "./models/index.js";
+export { RagDocumentSearch } from "./ragDocuments/index.js";

package/src/v2/search/index.js

@@ -0,0 +1,6 @@
+export * as models from "./models/index.js";
+export * as ragDocuments from "./ragDocuments/index.js";
+export { ModelSearchParameters, ModelSearchResponse } from "./models/index.js";
+export { RagDocumentSearchParameters, RagDocumentSearchResponse } from "./ragDocuments/index.js";
+export { ModelSearch } from "./models/index.js";
+export { RagDocumentSearch } from "./ragDocuments/index.js";

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

@@ -0,0 +1,3 @@
+export { ModelSearchParameters } from "./modelSearchParameters.js";
+export { ModelSearchResponse } from "./modelSearchResponse.js";
+export { ModelSearch } from "./modelSearch.js";

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

@@ -0,0 +1,3 @@
+export { ModelSearchParameters } from "./modelSearchParameters.js";
+export { ModelSearchResponse } from "./modelSearchResponse.js";
+export { ModelSearch } from "./modelSearch.js";

package/src/v2/search/models/modelSearch.d.ts

@@ -0,0 +1,19 @@
+import { ModelSearchParameters } from "../../../v2/search/index.js";
+import { BaseSearch } from "../../../v2/search/baseSearch.js";
+import { ModelSearchResponse } from "../../../v2/search/models/modelSearchResponse.js";
+/**
+ * Search for models within the organization linked to the API key.
+ *
+ * All search filters are optional.
+ * If no search filters are given, all models belonging to the organization are returned.
+ *
+ * Results are paginated.
+ */
+export declare class ModelSearch extends BaseSearch {
+    /** @inheritDoc */
+    static get parametersClass(): typeof ModelSearchParameters;
+    /** @inheritDoc */
+    static get responseClass(): typeof ModelSearchResponse;
+    /** @inheritDoc */
+    static get slug(): string;
+}