client.models.get_models
Retrieve models
client.models.get_models(model_id=None, author=None, created_by_email=None, name=None, description=None, is_active=None, is_expired=None, is_recommended=None, last_active_date_time=None, expiration_date_time=None, sort_by=None, direction=None, page=None, per_page=1000)
Returns a list of models. The list includes each model’s model_id
, versions
, and latest_version
.
Parameters
Parameter | Type | Description | Example |
---|---|---|---|
|
| Filters models by identifier. Separate multiple values with |
|
|
| Filters models by the organization that created them. Separate multiple values with |
|
|
| Filters models by creator’s email. Separate multiple values with | |
|
| Filters models by name. Separate multiple values with |
|
|
| Filters models by description. |
|
|
| Filters models by status. |
|
|
| Filters models recommended by Modzy. |
|
|
| Filters models by the latest use date. It requires ISO8601 formated string ( |
|
|
| Filters models by the expiration date. It requires ISO8601 formated string ( |
|
|
| Models can be sorted by |
|
|
| Orders the records in ascending ( |
|
|
| The page number to be returned. Defaults to 0. |
|
|
| The number of records returned per page. Defaults to 10. |
|
Returns
A JSON object with a list of any models the meet the criteria specified by the parameters supplied.
[
{
"model_id": "string",
"latest_version": "string",
"versions": ["string"]
}
]
Examples
>>># Search by author:
>>>params = {'author': 'Open Source'}
>>>models = client.models.get_models(**params)
>>>len(models)
14
Search for active models:
>>>params = {'is_active': True}
>>>models = client.models.get_models(**params)
>>>len(models)
150
Search by name (and paginate the results):
>>>params = {'name': "Image", 'per_page':5}
>>>models = client.models.get_models(**params)
>>>len(models)
5
Combined search
>>>params = {'name': "Image", 'author': 'Open Source', 'is_active': True}
>>>models = client.models.get_models(**params)
>>>len(models)
2
Updated 9 months ago