diff --git a/src/v2/search/models/modelSearch.ts b/src/v2/search/models/modelSearch.ts index 687b8de3..7991de37 100644 --- a/src/v2/search/models/modelSearch.ts +++ b/src/v2/search/models/modelSearch.ts @@ -3,7 +3,12 @@ import { BaseSearch } from "@/v2/search/baseSearch.js"; import { ModelSearchResponse } from "@/v2/search/models/modelSearchResponse.js"; /** - * Search for models. + * 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 */ diff --git a/src/v2/search/models/modelSearchParameters.ts b/src/v2/search/models/modelSearchParameters.ts index c01bb31d..78c78fc4 100644 --- a/src/v2/search/models/modelSearchParameters.ts +++ b/src/v2/search/models/modelSearchParameters.ts @@ -13,12 +13,12 @@ export interface ModelSearchParametersConstructor extends BaseSearchParametersCo */ export class ModelSearchParameters extends BaseSearchParameters { /** - * Case-insensitive search term for the model name + * Filter models by partial name match, case-insensitive. */ name?: string; /** - * Case-insensitive search term for the model type + * Filter by an exact model type. */ modelType?: string; diff --git a/tests/v2/search/modelSearch.integration.ts b/tests/v2/search/modelSearch.integration.ts index 6e493ef7..9ed89ea8 100644 --- a/tests/v2/search/modelSearch.integration.ts +++ b/tests/v2/search/modelSearch.integration.ts @@ -18,6 +18,11 @@ describe("MindeeV2 - Integration - Model Search", { timeout: 120000 }, () => { const response: ModelSearchResponse = await client.search(ModelSearch, {}); assert.ok(response); assert.ok(response.models.length > 0); + for (const model of response.models) { + assert.ok(model.id); + assert.ok(model.name); + assert.ok(model.modelType); + } assert.ok(response.pagination); assert.ok(response.pagination.totalItems >= 1); assert.equal(response.pagination.page, 1);