client.models.get_by_name

Retrieve model details by name

client.models.get_by_name(name)

Search for a model that matches a provided name. If the search finds multiple models, it will return the closest match. The output includes all model details (model_id, latest_version, author, name, versions, and tags).

Parameters

Parameter

Type

Description

Example

name

str

A model name or a part of it.

'Sentiment Analysis'

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_by_name("Dataset Joining")
>>>model.model_id
'mcmedzgiu3'
>>>model.author
'Modzy'
>>>model.is_active
True
>>>model.description
'This model performs a join on two datasets in JSON format.'

Did this page help you?