GuidesRecipesAPI ReferenceChangelogDiscussions
Log In

client.models.get

Retrieve model details

client.models.get(model)

Returns model details. It includes the model_id, latest_version, author, name, versions, and tags.

Parameters

ParameterTypeDescriptionExample
modelModel
str
A model identifier assigned by Modzy or a preloaded model object.'ed542963de'

Returns

{
  "model_id": "string",
  "latest_version": "string",
  "latest_active_version": "string",
  "versions": ["string"],
  "author": "string",
  "name": "string",
  "description": "string",
  "permalink": "string",
  "is_active": "boolean",
  "is_recommended": "boolean",
  "is_commercial": "boolean",
  "features": [
    {
      "identifier": "string",
      "name": "string",
      "description": "string"
    }
  ],
  "tags": [
    {
      "identifier": "string",
      "name": "string",
      "data_type": "string",
      "is_categorical": "boolean"
    }
  ],
  "images": [
    {
      "url": "string",
      "caption": "string",
      "relation_type": "string"
    }
  ],
  "last_active_date_time": "date-time"
}

Examples

>>> model = client.models.get('ed542963de')
>>> model.model_id
'ed542963de'
>>> model.name
'Sentiment Analysis'
>>> model.author
'Open Source'

You can also refresh a preloaded model object

>>> model = client.models.get('ed542963de')
>>> model.model_id
'ed542963de'
>>> model = client.models.get(model)
>>> model.model_id
'ed542963de'