diff --git a/mindee/v2/search/models/model_search_parameters.py b/mindee/v2/search/models/model_search_parameters.py index e5f02ad6..cd5fdded 100644 --- a/mindee/v2/search/models/model_search_parameters.py +++ b/mindee/v2/search/models/model_search_parameters.py @@ -7,13 +7,20 @@ @dataclass(kw_only=True) class ModelSearchParameters(BaseSearchParameters[ModelSearchResponse]): - """Search parameters 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. + """ name: str | None = None - """Case-insensitive search term for the model name.""" + """Filter models by partial name match, case-insensitive.""" model_type: str | None = None - """Case-insensitive search term for the model type.""" + """Filter by an exact model type.""" _slug: ClassVar[str] = "models" _response_class: type[ModelSearchResponse] = ModelSearchResponse diff --git a/tests/v2/search/test_model_search_integration.py b/tests/v2/search/test_model_search_integration.py index 4c2a7e4b..53b4dc31 100644 --- a/tests/v2/search/test_model_search_integration.py +++ b/tests/v2/search/test_model_search_integration.py @@ -16,6 +16,10 @@ def test_must_have_results(v2_client: Client): assert response is not None assert len(response.models) > 0 + for model in response.models: + assert model.id + assert model.name + assert model.model_type assert response.pagination is not None assert response.pagination.total_items >= 1 assert response.pagination.page == 1