ai_api_client_sdk.models.parameter module

class ai_api_client_sdk.models.parameter.Parameter(name: str, type: Type, description: str = None, default: str = None, **kwargs)

Bases: object

The Parameter object defines the parameter specified in the executable definition.

Parameters:
  • name (str) – name of the parameter

  • type (class:ai_api_client_sdk.models.parameter.Parameter.Type) – Type of the parameter

  • description (str) – description for parameter

  • default (str) – default value for parameter

  • **kwargs – The keyword arguments are there in case there are additional attributes returned from server

class Type(*values)

Bases: Enum

STRING = 'string'
__init__(name: str, type: Type, description: str = None, default: str = None, **kwargs)
static from_dict(parameter_dict: Dict[str, Any])

Returns a ai_api_client_sdk.models.parameter.Parameter object, created from the values in the dict provided as parameter

Parameters:

parameter_dict (Dict[str, Any]) – Dict which includes the necessary values to create the object

Returns:

An object, created from the values provided

Return type:

class:ai_api_client_sdk.models.parameter.Parameter