mindee 5.6.1 → 5.7.1

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

@@ -0,0 +1,25 @@
+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 class ModelSearch extends BaseSearch {
+    /** @inheritDoc */
+    static get parametersClass() {
+        return ModelSearchParameters;
+    }
+    /** @inheritDoc */
+    static get responseClass() {
+        return ModelSearchResponse;
+    }
+    /** @inheritDoc */
+    static get slug() {
+        return "models";
+    }
+}

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

@@ -0,0 +1,24 @@
+import { BaseSearchParameters, BaseSearchParametersConstructor } from "../../../v2/clientOptions/baseSearchParameters.js";
+/**
+ * Constructor parameters for ModelSearchParameters.
+ */
+export interface ModelSearchParametersConstructor extends BaseSearchParametersConstructor {
+    name?: string;
+    modelType?: string;
+}
+/**
+ * Search parameters for models.
+ */
+export declare class ModelSearchParameters extends BaseSearchParameters {
+    /**
+     * Filter models by partial name match, case-insensitive.
+     */
+    name?: string;
+    /**
+     * Filter by an exact model type.
+     */
+    modelType?: string;
+    constructor(params?: ModelSearchParametersConstructor);
+    /** @inheritdoc */
+    getRequestParameters(): Record<string, string>;
+}

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

@@ -0,0 +1,22 @@
+import { BaseSearchParameters } from "../../../v2/clientOptions/baseSearchParameters.js";
+/**
+ * Search parameters for models.
+ */
+export class ModelSearchParameters extends BaseSearchParameters {
+    constructor(params = {}) {
+        super(params);
+        this.name = params.name;
+        this.modelType = params.modelType;
+    }
+    /** @inheritdoc */
+    getRequestParameters() {
+        const parameters = super.getRequestParameters();
+        if (this.name) {
+            parameters["name"] = this.name;
+        }
+        if (this.modelType) {
+            parameters["model_type"] = this.modelType;
+        }
+        return parameters;
+    }
+}

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

@@ -0,0 +1,14 @@
+import { StringDict } from "../../../parsing/index.js";
+import { BaseSearchResponse } from "../../../v2/parsing/search/baseSearchResponse.js";
+import { SearchModels } from "../../../v2/parsing/search/searchModels.js";
+/**
+ * Models search response.
+ */
+export declare class ModelSearchResponse extends BaseSearchResponse {
+    /**
+     * Paginated list of matching models.
+     */
+    models: SearchModels;
+    constructor(serverResponse: StringDict);
+    protected bodyLines(): string[];
+}

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

@@ -0,0 +1,14 @@
+import { BaseSearchResponse } from "../../../v2/parsing/search/baseSearchResponse.js";
+import { SearchModels } from "../../../v2/parsing/search/searchModels.js";
+/**
+ * Models search response.
+ */
+export class ModelSearchResponse extends BaseSearchResponse {
+    constructor(serverResponse) {
+        super(serverResponse);
+        this.models = new SearchModels(serverResponse["models"] ?? []);
+    }
+    bodyLines() {
+        return ["Models", "#######", this.models.toString()];
+    }
+}

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

@@ -0,0 +1,3 @@
+export { RagDocumentSearchParameters } from "./ragDocumentSearchParameters.js";
+export { RagDocumentSearchResponse } from "./ragDocumentSearchResponse.js";
+export { RagDocumentSearch } from "./ragDocumentSearch.js";

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

@@ -0,0 +1,3 @@
+export { RagDocumentSearchParameters } from "./ragDocumentSearchParameters.js";
+export { RagDocumentSearchResponse } from "./ragDocumentSearchResponse.js";
+export { RagDocumentSearch } from "./ragDocumentSearch.js";

package/src/v2/search/ragDocuments/ragDocumentSearch.d.ts

@@ -0,0 +1,14 @@
+import { BaseSearch } from "../../../v2/search/baseSearch.js";
+import { RagDocumentSearchParameters } from "../../../v2/search/index.js";
+import { RagDocumentSearchResponse } from "../../../v2/search/ragDocuments/ragDocumentSearchResponse.js";
+/**
+ * Search for RAG Documents.
+ */
+export declare class RagDocumentSearch extends BaseSearch {
+    /** @inheritDoc */
+    static get parametersClass(): typeof RagDocumentSearchParameters;
+    /** @inheritDoc */
+    static get responseClass(): typeof RagDocumentSearchResponse;
+    /** @inheritDoc */
+    static get slug(): string;
+}

package/src/v2/search/ragDocuments/ragDocumentSearch.js

@@ -0,0 +1,20 @@
+import { BaseSearch } from "../../../v2/search/baseSearch.js";
+import { RagDocumentSearchParameters } from "../../../v2/search/index.js";
+import { RagDocumentSearchResponse } from "../../../v2/search/ragDocuments/ragDocumentSearchResponse.js";
+/**
+ * Search for RAG Documents.
+ */
+export class RagDocumentSearch extends BaseSearch {
+    /** @inheritDoc */
+    static get parametersClass() {
+        return RagDocumentSearchParameters;
+    }
+    /** @inheritDoc */
+    static get responseClass() {
+        return RagDocumentSearchResponse;
+    }
+    /** @inheritDoc */
+    static get slug() {
+        return "rag-documents";
+    }
+}

package/src/v2/search/ragDocuments/ragDocumentSearchParameters.d.ts

@@ -0,0 +1,24 @@
+import { BaseSearchParameters, BaseSearchParametersConstructor } from "../../../v2/clientOptions/baseSearchParameters.js";
+/**
+ * Constructor parameters for RagDocumentSearchParameters.
+ */
+export interface RagDocumentSearchParametersConstructor extends BaseSearchParametersConstructor {
+    modelId: string;
+    filename?: string;
+}
+/**
+ * Search parameters for RAG Documents.
+ */
+export declare class RagDocumentSearchParameters extends BaseSearchParameters {
+    /**
+     * Model identifier to search in.
+     */
+    modelId: string;
+    /**
+     * Case-insensitive substring search on filename.
+     */
+    filename?: string;
+    constructor(params: RagDocumentSearchParametersConstructor);
+    /** @inheritdoc */
+    getRequestParameters(): Record<string, string>;
+}

package/src/v2/search/ragDocuments/ragDocumentSearchParameters.js

@@ -0,0 +1,24 @@
+import { MindeeConfigurationError } from "../../../errors/index.js";
+import { BaseSearchParameters } from "../../../v2/clientOptions/baseSearchParameters.js";
+/**
+ * Search parameters for RAG Documents.
+ */
+export class RagDocumentSearchParameters extends BaseSearchParameters {
+    constructor(params) {
+        if (!params.modelId) {
+            throw new MindeeConfigurationError("ModelId is required in RagDocumentSearchParameters");
+        }
+        super(params);
+        this.modelId = params.modelId;
+        this.filename = params.filename;
+    }
+    /** @inheritdoc */
+    getRequestParameters() {
+        const parameters = super.getRequestParameters();
+        parameters["model_id"] = this.modelId;
+        if (this.filename) {
+            parameters["filename"] = this.filename;
+        }
+        return parameters;
+    }
+}

package/src/v2/search/ragDocuments/ragDocumentSearchResponse.d.ts

@@ -0,0 +1,14 @@
+import { StringDict } from "../../../parsing/index.js";
+import { BaseSearchResponse } from "../../../v2/parsing/search/index.js";
+import { SearchRagDocuments } from "../../../v2/parsing/search/searchRagDocuments.js";
+/**
+ * RAG Documents search response.
+ */
+export declare class RagDocumentSearchResponse extends BaseSearchResponse {
+    /**
+     * Paginated list of matching RAG documents.
+     */
+    ragDocuments: SearchRagDocuments;
+    constructor(serverResponse: StringDict);
+    protected bodyLines(): string[];
+}

package/src/v2/search/ragDocuments/ragDocumentSearchResponse.js

@@ -0,0 +1,14 @@
+import { BaseSearchResponse } from "../../../v2/parsing/search/index.js";
+import { SearchRagDocuments } from "../../../v2/parsing/search/searchRagDocuments.js";
+/**
+ * RAG Documents search response.
+ */
+export class RagDocumentSearchResponse extends BaseSearchResponse {
+    constructor(serverResponse) {
+        super(serverResponse);
+        this.ragDocuments = new SearchRagDocuments(serverResponse["rag_documents"] ?? []);
+    }
+    bodyLines() {
+        return ["RAG Documents", "################", this.ragDocuments.toString()];
+    }
+}

package/src/v2/clientOptions/baseParameters.js

@@ -1,42 +0,0 @@
-import { FormData } from "undici";
-import { MindeeConfigurationError } from "../../errors/index.js";
-/**
- * Parameters accepted by all v2 products.
- *
- * 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"],
- * };
- */
-export class BaseParameters {
-    constructor(params) {
-        if (params.modelId === undefined || params.modelId === null || params.modelId === "") {
-            throw new MindeeConfigurationError("Model ID must be provided");
-        }
-        this.modelId = params.modelId;
-        this.alias = params.alias;
-        this.webhookIds = params.webhookIds;
-        this.closeFile = params.closeFile;
-    }
-    /**
-     * Returns the form data to send to the API.
-     * @returns A `FormData` object.
-     */
-    getFormData() {
-        const form = new FormData();
-        form.set("model_id", this.modelId);
-        if (this.alias !== undefined && this.alias !== null) {
-            form.set("alias", this.alias);
-        }
-        if (this.webhookIds && this.webhookIds.length > 0) {
-            form.set("webhook_ids", this.webhookIds.join(","));
-        }
-        return form;
-    }
-}