ai_api_client_sdk.models package

Submodules

ai_api_client_sdk.models.ai_api_capabilities module

class AIAPICapabilities

Bases: object

The AIAPICapabilities object represent the capabilities of the AI API

Parameters:

multitenant (bool, optional) -- indicates whether resource groups are supported, defaults to True
shareable (bool, optional) -- indicates whether clients can share an instance, defaults to True
static_deployments (bool, optional) -- indicates whether the static, always running deployments are supported, defaults to True
user_deployments (bool, optional) -- indicates whether deployment creation by users are supported, defaults to True
time_to_live_deployments (bool, optional) -- indicate whether ttl value of deployment are supported, defaults to False
user_executions (bool, optional) -- indicates whether execution creation by users are supported, defaults to True
bulk_updates (class:ai_api_client_sdk.models.ai_api_capabilities_bulk_updates.AIAPICapabilitiesBulkUpdates, optional) -- An object, defining the bulk updates capabilities, defaults to None
execution_schedules (bool, optional) -- indicates whether execution schedules are supported, defaults to False
logs (class:ai_api_client_sdk.models.ai_api_capabilities_logs.AIAPICapabilitiesLogs, optional) -- An object, defining the logs capabilities, defaults to None
**kwargs -- The keyword arguments are there in case there are additional attributes returned from server

static from_dict(ai_api_capabilities_dict)

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

Parameters:: ai_api_capabilities_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.ai_api_capabilities.AIAPICapabilities

__init__(multitenant=True, shareable=True, static_deployments=True, user_deployments=True, time_to_live_deployments=False, user_executions=True, bulk_updates=None, execution_schedules=False, logs=None, **kwargs)

Parameters:

multitenant (bool)
shareable (bool)
static_deployments (bool)
user_deployments (bool)
time_to_live_deployments (bool)
user_executions (bool)
bulk_updates (AIAPICapabilitiesBulkUpdates)
execution_schedules (bool)
logs (AIAPICapabilitiesLogs)

ai_api_client_sdk.models.ai_api_capabilities_bulk_updates module

class AIAPICapabilitiesBulkUpdates

Bases: object

The AIAPICapabilitiesBulkUpdates object represents the bulk updates capabilities

Parameters:

deployments (bool, optional) -- indicates whether bulk updates for executions are supported, defaults to False
executions (bool, optional) -- indicates whether bulk updates for executions are supported, defaults to False
**kwargs -- The keyword arguments are there in case there are additional attributes returned from server

static from_dict(ai_api_capabilities_bulk_updates_dict)

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

Parameters:: ai_api_capabilities_bulk_updates_dict (Dict[str, bool]) -- 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.ai_api_capabilities_bulk_updates.AIAPICapabilitiesBulkUpdates

__init__(executions=False, deployments=False, **kwargs)

Parameters:

executions (bool)
deployments (bool)

ai_api_client_sdk.models.ai_api_capabilities_logs module

class AIAPICapabilitiesLogs

Bases: object

The AIAPICapabilitiesLogs object represents the log capabilities

Parameters:

user_executions (bool, optional) -- indicates whether logs for executions are supported, defaults to True
user_deployments (bool, optional) -- indicates whether logs for deployments are supported, defaults to True
**kwargs -- The keyword arguments are there in case there are additional attributes returned from server

static from_dict(ai_api_capabilities_logs_dict)

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

Parameters:: ai_api_capabilities_logs_dict (Dict[str, bool]) -- 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.ai_api_capabilities_logs.AIAPICapabilitiesLogs

__init__(executions=True, deployments=True, **kwargs)

Parameters:

executions (bool)
deployments (bool)

ai_api_client_sdk.models.ai_api_limits module

class AIAPILimits

Bases: object

The AIAPILimits object represents the the limits for executions and deployments

Parameters:

executions (class:ai_api_client_sdk.models.ai_api_limits_executions.AIAPILimitsExecutions, optional) -- represents the limits for executions, defaults to None
deployments (class:ai_api_client_sdk.models.ai_api_limits_deployments.AIAPILimitsDeployments, optional) -- represents the limits for deployments, defaults to None
**kwargs -- The keyword arguments are there in case there are additional attributes returned from server

static from_dict(ai_api_limits_dict)

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

Parameters:: ai_api_limits_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.ai_api_limits.AIAPILimits

__init__(executions=None, deployments=None, **kwargs)

Parameters:

executions (AIAPILimitsExecutions)
deployments (AIAPILimitsDeployments)

ai_api_client_sdk.models.ai_api_limits_deployments module

class AIAPILimitsDeployments

Bases: AIAPILimitsEnactments

The AIAPILimitsDeployments object represents the the limits for deployments

Parameters:

max_running_count (int, optional) -- max number of deployments per resource group, <0 means unlimited, defaults to -1
**kwargs -- The keyword arguments are there in case there are additional attributes returned from server

static from_dict(ai_api_limits_deployments_dict)

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

Parameters:: ai_api_limits_deployments_dict (Dict[str, int]) -- 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.ai_api_limits_deployments.AIAPILimitsDeployments

__init__(max_running_count=-1, **kwargs)

Parameters:: max_running_count (int)

ai_api_client_sdk.models.ai_api_limits_enactments module

class AIAPILimitsEnactments

Bases: object

The AIAPILimitsEnactments object represents the the limits for enactments (common for both executions and deployments)

Parameters:

max_running_count (int, optional) -- max number of enactments per resource group, <0 means unlimited, defaults to -1
**kwargs -- The keyword arguments are there in case there are additional attributes returned from server

__init__(max_running_count=-1, **kwargs)

Parameters:: max_running_count (int)

ai_api_client_sdk.models.ai_api_limits_executions module

class AIAPILimitsExecutions

Bases: AIAPILimitsEnactments

The AIAPILimitsExecutions object represents the the limits for executions

Parameters:

max_running_count (int, optional) -- max number of executions per resource group, <0 means unlimited, defaults to -1
**kwargs -- The keyword arguments are there in case there are additional attributes returned from server

static from_dict(ai_api_limits_executions_dict)

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

Parameters:: ai_api_limits_executions_dict (Dict[str, int]) -- 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.ai_api_limits_executions.AIAPILimitsExecutions

__init__(max_running_count=-1, **kwargs)

Parameters:: max_running_count (int)

ai_api_client_sdk.models.ai_api_meta module

class AIAPIMeta

Bases: object

The AIAPIMeta object represents the metadata and capabilities of the AI API

Parameters:

version (str) -- version of the AI API
capabilities (class:ai_api_client_sdk.models.ai_api_capabilities.AIAPICapabilities) -- capabilities of AI API, defaults to None
limits (class:ai_api_client_sdk.models.ai_api_limits.AIAPILimits, optional) -- limits of AI API, defaults to None
**kwargs -- The keyword arguments are there in case there are additional attributes returned from server

static from_dict(ai_api_meta_dict)

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

Parameters:: ai_api_meta_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.ai_api_meta.AIAPIMeta

__init__(version, capabilities=None, limits=None, **kwargs)

Parameters:

version (str)
capabilities (AIAPICapabilities)
limits (AIAPILimits)

ai_api_client_sdk.models.api_version module

class APIVersion

Bases: object

The APIVersion object represents the description of an API version

Parameters:

version_id (str, optional) -- API version identifier, defaults to None
url (str, optional) -- URL of the API version, defaults to None
description (str, optional) -- API version description
**kwargs -- The keyword arguments are there in case there are additional attributes returned from server

static from_dict(api_version_dict)

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

Parameters:: api_version_dict (Dict[str, str]) -- 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.api_version.APIVersion

__init__(version_id=None, url=None, description=None, **kwargs)

Parameters:

version_id (str)
url (str)
description (str)

ai_api_client_sdk.models.artifact module

class Artifact

Bases: object

The Artifact object defines an artifact

Parameters:

name (str) -- Name of the artifact
id (str) -- ID of the artifact
url (str) -- URL of the artifact
kind (class:ai_api_client_sdk.models.artifact.Artifact.Kind) -- Kind of the artifact
scenario_id (str) -- ID of the scenario which the artifact belongs to
created_at (datetime) -- Time when the artifact was created
modified_at (datetime) -- Time when the artifact was last modified
execution_id (str, optional) -- ID of the execution which the artifact resulted from, defaults to None
configuration_id (str, optional) -- ID of the configuration which the artifact relates to, defaults to None
description (str, optional) -- Description of the artifact, defaults to None
labels (List[class:ai_api_client_sdk.models.label.Label]) -- List of the labels of the artifact, defaults to None
scenario (class:ai_api_client_sdk.models.scenario.Scenario, optional) -- A dict, which gives detailed information on scenario, defaults to None
**kwargs -- The keyword arguments are there in case there are additional attributes returned from server

class Kind

Bases: Enum

DATASET = 'dataset'

MODEL = 'model'

OTHER = 'other'

RESULTSET = 'resultset'

static from_dict(artifact_dict)

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

Parameters:: artifact_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.artifact.Artifact

__init__(name, id, url, kind, scenario_id, created_at, modified_at, execution_id=None, configuration_id=None, description=None, labels=None, scenario=None, **kwargs)

Parameters:

name (str)
id (str)
url (str)
kind (Kind)
scenario_id (str)
created_at (datetime)
modified_at (datetime)
execution_id (str)
configuration_id (str)
description (str)
labels (List[Label])
scenario (Scenario)

ai_api_client_sdk.models.artifact_create_response module

class ArtifactCreateResponse

Bases: BasicResponse

The ArtifactCreateResponse object defines the response of the artifact create request :param id: ID of the artifact :type id: str :param message: Response message from the server :type message: str :param url: URL of the artifact :type url: str :param **kwargs: The keyword arguments are there in case there are additional attributes returned from server

static from_dict(response_dict)

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

Parameters:: response_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.artifact_create_response.ArtifactCreateResponse

__init__(id, message, url, **kwargs)

Parameters:

id (str)
message (str)
url (str)

ai_api_client_sdk.models.artifact_query_response module

class ArtifactQueryResponse

Bases: QueryResponse

The ArtifactQueryResponse object defines the response of the artifact query request :param resources: List of the artifacts returned from the server :type resources: List[class:ai_api_client_sdk.models.artifact.Artifact] :param count: Total number of the queried artifacts :type count: int :param **kwargs: The keyword arguments are there in case there are additional attributes returned from server

static from_dict(response_dict)

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

Parameters:: response_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.artifact_query_response.ArtifactQueryResponse

__init__(resources, count, **kwargs)

Parameters:

resources (List[Artifact])
count (int)

ai_api_client_sdk.models.base_models module

class BasicErrorResponse

Bases: object

The BasicErrorResponse object defines the response from the server

Parameters:

error_code (str) -- Error code from the server
message (str) -- Error message from the server
request_id (str) -- Request ID
target (str, optional) -- target
details (Dict, optional) -- Error details
**kwargs -- The keyword arguments are there in case there are additional attributes returned from server

static from_dict(ber_dict)

Returns a ai_api_client_sdk.models.base_models.BasicErrorResponse object, created from the values provided as parameter

Parameters:: ber_dict (Dict[str, str]) -- 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.base_models.BasicErrorResponse

__init__(code, message, request_id, target, details=None, **kwargs)

Parameters:

code (str)
message (str)
request_id (str)
target (str)
details (Dict)

class BasicModifyRequest

Bases: object

The BasicModifyRequest object defines the request from client :param id: ID of the relevant resource :type id: str :param target_status: Target Status of the resource :type target_status: class:ai_api_client_sdk.models.target_status.TargetStatus :param **kwargs: The keyword arguments are there in case there are additional attributes returned from server

__init__(id, target_status, **kwargs)

Parameters:

id (str)
target_status (TargetStatus)

to_dict()

class BasicResponse

Bases: object

The BasicResponse object defines the response from the server

Parameters:

id (str) -- ID of the relevant resource
message (str) -- Response message from the server
**kwargs -- The keyword arguments are there in case there are additional attributes returned from server

static from_dict(br_dict)

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

Parameters:: br_dict (Dict[str, str]) -- 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.base_models.BasicResponse

__init__(id, message, **kwargs)

Parameters:

id (str)
message (str)

class BulkModifyErrorResponse

Bases: object

The BulkModifyErrorResponse object defines the error response from the server

static from_dict(error_dict)

Parameters:: error_dict (Dict[str, Union[str, Dict]]) -- Dict which includes the necessary values to create the object

Returns:: Returns a class:ai_api_client_sdk.models.base_models.BulkModifyErrorResponse object

__init__(id, error, **kwargs)

Creates an error object for a bulk modification call

Parameters:

id (str) -- ID of the relevant resource
error (BasicErrorResponse) -- Error object response from the server
**kwargs -- The keyword arguments are there in case there are additional attributes returned from server

class KeyValue

Bases: object

KeyValue object defines a key-value pair

Parameters:

key (str) -- key of the pair
value (str) -- value of the pair

__init__(key, value, **kwargs)

Parameters:

key (str)
value (str)

to_dict()

class Name

Bases: object

KeyValue object defines a name

Parameters:: name (str) -- name

__init__(name, **kwargs)

Parameters:: name (str)

class NameValue

Bases: object

KeyValue object defines a name-value pair

Parameters:

name (str) -- name of the pair
value (str) -- value of the pair

__init__(name, value, **kwargs)

Parameters:

name (str)
value (str)

class Operation

Bases: Enum

An enumeration.

static __new__(cls, value)

CASCADE_UPDATE = 'CASCADE-UPDATE'

CREATE = 'CREATE'

DELETE = 'DELETE'

UPDATE = 'UPDATE'

class Order

Bases: Enum

ASC = 'asc'

DESC = 'desc'

class QueryResponse

Bases: object

The QueryResponse object defines the response from the server to a query request

Parameters:

resources (list) -- List of the resources returned from the server
count (int) -- Total number of the queried resources
**kwargs -- The keyword arguments are there in case there are additional attributes returned from server

__init__(resources, count, **kwargs)

Parameters:

resources (list)
count (int)

ai_api_client_sdk.models.capabilities module

class Capabilities

Bases: object

The Capabilities object represents the metadata and capabilities of, and extensions to the AI API

Parameters:

ai_api (class:ai_api_client_sdk.models.ai_api_meta.AIAPIMeta) -- Metadata and capabilities of the AI API
runtime_identifier (str, optional) -- The name of runtime, defaults to None
runtime_api_version (str, optional) -- The version of the runtime, defaults to None
description (str, optional) -- description, defaults to None
extensions (class:ai_api_client_sdk.models.extensions.Extensions, optional) -- Extensions to the AI API, defaults to None
**kwargs -- The keyword arguments are there in case there are additional attributes returned from server

static from_dict(capabilities_dict)

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

Parameters:: capabilities_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.capabilities.Capabilities

__init__(ai_api, runtime_identifier=None, runtime_api_version=None, description=None, extensions=None, **kwargs)

Parameters:

ai_api (AIAPIMeta)
runtime_identifier (str)
runtime_api_version (str)
description (str)
extensions (Extensions)

ai_api_client_sdk.models.configuration module

class Configuration

Bases: object

The Configuration object defines a configuration

Parameters:

id (str) -- ID of the configuration
name (str) -- Name of the configuration
scenario_id (str) -- ID of the scenario which the configuration belongs to
executable_id (str) -- ID of the executable, which is configured
created_at (datetime) -- Time when the configuration was created
parameter_bindings (List[class:ai_api_client_sdk.models.parameter_binding.ParameterBinding], optional) -- List of the input parameters defined as key-value pairs, defaults to None
input_artifact_bindings (List[class:ai_api_client_sdk.models.input_artifact_binding.InputArtifactBinding], optional) -- List of the input artifacts which are to be used by the executable, defaults to None
scenario (class:ai_api_client_sdk.models.scenario.Scenario, optional) -- A dict, which gives detailed information on scenario, defaults to None
**kwargs -- The keyword arguments are there in case there are additional attributes returned from server

static from_dict(configuration_dict)

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

Parameters:: configuration_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.configuration.Configuration

__init__(id, name, scenario_id, executable_id, created_at, parameter_bindings=None, input_artifact_bindings=None, scenario=None, **kwargs)

Parameters:

id (str)
name (str)
scenario_id (str)
executable_id (str)
created_at (datetime)
parameter_bindings (List[ParameterBinding])
input_artifact_bindings (List[InputArtifactBinding])
scenario (Scenario)

ai_api_client_sdk.models.configuration_create_response module

class ConfigurationCreateResponse

Bases: BasicResponse

The ConfigurationCreateResponse object defines the response of the configuration create request. Refer to ai_api_client_sdk.models.base_models.BasicResponse, for the object definition

static from_dict(response_dict)

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

Parameters:: response_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.configuration_create_response.ConfigurationCreateResponse

ai_api_client_sdk.models.configuration_query_response module

class ConfigurationQueryResponse

Bases: QueryResponse

The ConfigurationQueryResponse object defines the response of the configuration query request :param resources: List of the configurations returned from the server :type resources: List[class:ai_api_client_sdk.models.configuration.Configuration] :param count: Total number of the queried configurations :type count: int :param **kwargs: The keyword arguments are there in case there are additional attributes returned from server

static from_dict(response_dict)

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

Parameters:: response_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.configuration_query_response.ConfigurationQueryResponse

__init__(resources, count, **kwargs)

Parameters:

resources (List[Configuration])
count (int)

ai_api_client_sdk.models.dataset_capabilities module

class DatasetCapabilities

Bases: object

The DatasetCapabilities object represents the capabilities of the Dataset API

Parameters:

upload (bool, optional) -- indicates whether uploading files is supported, defaults to True
download (bool, optional) -- indicates whether downloading files is supported, defaults to True
delete (bool, optional) -- indicates whether deleting files is supported, defaults to True
**kwargs -- The keyword arguments are there in case there are additional attributes returned from server

static from_dict(dataset_capabilities_dict)

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

Parameters:: dataset_capabilities_dict (Dict[str, bool]) -- 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.dataset_capabilities.DatasetCapabilities

__init__(upload=True, download=True, delete=True, **kwargs)

Parameters:

upload (bool)
download (bool)
delete (bool)

ai_api_client_sdk.models.dataset_limits module

class DatasetLimits

Bases: object

The DatasetLimits object represents the limits of the Dataset API

Parameters:

max_upload_file_size (int, optional) -- Max size (in bytes) of a single uploaded file, defaults to 104857600
max_files_per_dataset (int, optional) -- Max number of files per dataset. <0 means unlimited, defaults to -1
**kwargs -- The keyword arguments are there in case there are additional attributes returned from server

static from_dict(dataset_limits_dict)

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

Parameters:: dataset_limits_dict (Dict[str, int]) -- 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.dataset_limits.DatasetLimits

__init__(max_upload_file_size=104857600, max_files_per_dataset=-1, **kwargs)

Parameters:

max_upload_file_size (int)
max_files_per_dataset (int)

ai_api_client_sdk.models.deployment module

class Deployment

Bases: Enactment

The Deployment object defines a deployment :param id: ID of the deployment :type id: str :param deployment_url: URL of the running deployment :type deployment_url: str :param configuration_id: ID of the configuration which configured the deployment :type configuration_id: str :param configuration_name: Name of the configuration which configured the deployment :type configuration_name: str :param scenario_id: ID of the scenario which the deployment belongs to :type scenario_id: str :param status: Status of the deployment :type status: class:ai_api_client_sdk.models.status.Status :param target_status: Target status of the deployment :type target_status: class:ai_api_client_sdk.models.target_status.TargetStatus :param created_at: Time when the deployment was created :type created_at: datetime :param modified_at: Time when the deployment was last modified :type modified_at: datetime :param status_message: A string, which gives information about the status of the deployment, defaults to None :type status_message: str, optional :param status_details: A dict, which gives detailed information about the status of the deployment, defaults to None :type status_details: Dict[str, Any], optional :param details: A dict, which gives information about the scaling and resources details of the deployment, defaults

to None

Parameters:

submission_time (datetime, optional) -- Time when the deployment was submitted
start_time (datetime, optional) -- Time when the deployment status changed to RUNNING
completion_time (datetime, optional) -- Time when the deployment status changed to DEAD/STOPPED
last_operation (Operation, optional) -- Last operation applied to the deployment
latest_running_configuration_id (str, optional) -- The configuration ID that was running, before a PATCH operation has modified the configuration ID of the deployment.
ttl (str, optional) -- Time to live for a deployment
**kwargs -- The keyword arguments are there in case there are additional attributes returned from server

static from_dict(deployment_dict)

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

Parameters:: deployment_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.deployment.Deployment

__init__(id, deployment_url, configuration_id, configuration_name, scenario_id, status, target_status, created_at, modified_at, status_message=None, status_details=None, details=None, submission_time=None, start_time=None, completion_time=None, last_operation=None, latest_running_configuration_id=None, ttl=None, **kwargs)

Parameters:

id (str)
deployment_url (str)
configuration_id (str)
configuration_name (str)
scenario_id (str)
status (Status)
target_status (TargetStatus)
created_at (datetime)
modified_at (datetime)
status_message (str)
status_details (Dict[str, Any])
details (Dict[str, Any])
submission_time (datetime)
start_time (datetime)
completion_time (datetime)
last_operation (Operation)
latest_running_configuration_id (str)
ttl (str)

ai_api_client_sdk.models.deployment_bulk_modify_response module

class DeploymentBulkModifyResponse

Bases: object

The DeploymentBulkModifyResponse object defines the response to the deployments bulk modify request :param deployments: Response to the bulk modify request of deployments :type deployments: List[Union[BasicResponse, BulkModifyErrorResponse]]

static from_dict(response_dict)

Returns a ai_api_client_sdk.models.Deployment_Bulk_Modify_Response.DeploymentBulkModifyResponse object, created from the values provided as parameter

Parameters:: response_dict (Dict[str, List[Dict[str, Union[str, 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.Deployment_Bulk_Modify_Response.DeploymentBulkModifyResponse

__init__(deployments, **kwargs)

Parameters:: deployments (List[BasicResponse | BulkModifyErrorResponse])

ai_api_client_sdk.models.deployment_create_response module

class DeploymentCreateResponse

Bases: BasicResponse

The DeploymentCreateResponse object defines the response of the deployment create query :param id: ID of the deployment :type id: str :param message: Response message from the server :type message: str :param deployment_url: URL of the running deployment :type deployment_url: str :param status: Status of the deployment :type status: class:ai_api_client_sdk.models.status.Status :param ttl: Time to live for deployment :type ttl: str, optional :param **kwargs: The keyword arguments are there in case there are additional attributes returned from server

static from_dict(response_dict)

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

Parameters:: response_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.deployment_create_response.DeploymentCreateResponse

__init__(id, message, deployment_url, status, ttl=None, **kwargs)

Parameters:

id (str)
message (str)
deployment_url (str)
status (Status)
ttl (str)

ai_api_client_sdk.models.deployment_get_status_response module

class DeploymentGetStatusResponse

Bases: EnactmentGetStatusResponse

The DeploymentGetStatusResponse object defines the response of the deployment get status :param id: ID of the deployment :type id: str :param configuration_id: ID of the configuration which configured the deployment :type configuration_id: str :param status: Status of the deployment :type status: class:ai_api_client_sdk.models.status.Status :param created_at: Time when the deployment was created :type created_at: datetime :param modified_at: Time when the deployment was last modified :type modified_at: datetime :param status_details: A dict, which gives detailed information about the status of the deployment, defaults to None :type status_details: Dict[str, Any], optional

static from_dict(deployment_dict)

Returns a ai_api_client_sdk.models.deployment_get_status_response.DeploymentGetStatusResponse object, created from the values in the dict provided as parameter :param deployment_dict: Dict which includes the necessary values to create the object :type deployment_dict: Dict[str, Any] :return: An object, created from the values provided :rtype: class:ai_api_client_sdk.models.deployment_get_status_response.DeploymentGetStatusResponse

Parameters:: deployment_dict (Dict[str, Any])

__init__(id, configuration_id, status, created_at, modified_at, status_details=None, details=None)

Parameters:

id (str)
configuration_id (str)
status (Status)
created_at (datetime)
modified_at (datetime)
status_details (Dict[str, Any])
details (Dict[str, Any])

ai_api_client_sdk.models.deployment_query_response module

class DeploymentQueryResponse

Bases: QueryResponse

The DeploymentQueryResponse object defines the response of the deployment query request :param resources: List of the deployments returned from the server :type resources: List[class:ai_api_client_sdk.models.deployment.Deployment] :param count: Total number of the queried deployments :type count: int :param **kwargs: The keyword arguments are there in case there are additional attributes returned from server

static from_dict(response_dict)

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

Parameters:: response_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.deployment_query_response.DeploymentQueryResponse

__init__(resources, count, **kwargs)

Parameters:

resources (List[Deployment])
count (int)

ai_api_client_sdk.models.enactment module

class Enactment

Bases: object

Enactment object is base class for Execution/Deployment, defining their common attributes

Parameters:

id (str) -- ID of the enactment
configuration_id (str) -- ID of the configuration which configured the enactment
configuration_name (str) -- Name of the configuration which configured the enactment
scenario_id (str) -- ID of the scenario which the enactment belongs to
status (class:ai_api_client_sdk.models.status.Status) -- Status of the enactment
target_status (class:ai_api_client_sdk.models.target_status.TargetStatus) -- Target status of the enactment
created_at (datetime) -- Time when the enactment was created
modified_at (datetime) -- Time when the enactment was last modified
status_message (str, optional) -- A string, which gives information about the status of the enactment, defaults to None
status_details (Dict[str, Any], optional) -- A dict, which gives detailed information about the status of the enactment, defaults to None
submission_time (datetime, optional) -- Time when the enactment was submitted
start_time (datetime, optional) -- Time when the enactment status changed to RUNNING
completion_time (datetime, optional) -- Time when the enactment status changed to COMPLETED/DEAD/STOPPED
**kwargs -- The keyword arguments are there in case there are additional attributes returned from server

__init__(id, configuration_id, configuration_name, scenario_id, status, target_status, created_at, modified_at, status_message=None, status_details=None, submission_time=None, start_time=None, completion_time=None, **kwargs)

Parameters:

id (str)
configuration_id (str)
scenario_id (str)
status (Status)
target_status (TargetStatus)
created_at (datetime)
modified_at (datetime)
status_message (str)
status_details (Dict[str, Any])
submission_time (datetime)
start_time (datetime)
completion_time (datetime)

ai_api_client_sdk.models.enactment_get_status_response module

class EnactmentGetStatusResponse

Bases: object

EnactmentGetStatusResponse object defines the response from the server to get status of Execution/Deployment :param id: ID of the enactment :type id: str :param configuration_id: ID of the configuration which configured the enactment :type configuration_id: str :param status: Status of the enactment :type status: class:ai_api_client_sdk.models.status.Status :param created_at: Time when the enactment was created :type created_at: datetime :param modified_at: Time when the enactment was last modified :type modified_at: datetime :param status_details: A dict, which gives detailed information about the status of the enactment, defaults to None :type status_details: Dict[str, Any], optional

__init__(id, configuration_id, status, created_at, modified_at, status_details=None)

Parameters:

id (str)
configuration_id (str)
status (Status)
created_at (datetime)
modified_at (datetime)
status_details (Dict[str, Any])

ai_api_client_sdk.models.executable module

class Executable

Bases: object

The Executable object defines an executable :param id: ID of the Executable :type id: str :param scenario_id: ID of the scenario which the executable belongs to :type scenario_id: str :param version_id: ID of the version of the scenario, the executable belongs to :type version_id: str :param name: Name of the executable :type name: str :param deployable: Flag which defines if the executable is deployable :type deployable: bool :param created_at: Time when the executable was created :type created_at: datetime :param modified_at: Time when the executable was last modified :type modified_at: datetime :param description: Description of the executable, defaults to None :type description: str, optional :param parameters: List of the parameters of the executable, defaults to None :type parameters: List[class:ai_api_client_sdk.models.parameter.Parameter], optional :param input_artifacts: List of the input artifacts which are to be used by the executable, defaults to None :type input_artifacts: List[class:ai_api_client_sdk.models.input_artifact.InputArtifact], optional :param output_artifacts: List of the artifacts to be created by the executable, defaults to None :type output_artifacts: List[class:ai_api_client_sdk.models.output_artifact.OutputArtifact], optional :param labels: List of the labels of the executable, defaults to None :type labels: List[class:ai_api_client_sdk.models.label.Label] :param **kwargs: The keyword arguments are there in case there are additional attributes returned from server

static from_dict(executable_dict)

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

Parameters:: executable_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.executable.Executable

__init__(id, scenario_id, version_id, name, deployable, created_at, modified_at, description=None, parameters=None, input_artifacts=None, output_artifacts=None, labels=None, **kwargs)

Parameters:

id (str)
scenario_id (str)
version_id (str)
name (str)
deployable (bool)
created_at (datetime)
modified_at (datetime)
description (str)
parameters (List[Parameter])
input_artifacts (List[InputArtifact])
output_artifacts (List[OutputArtifact])
labels (List[Label])

ai_api_client_sdk.models.executable_query_response module

class ExecutableQueryResponse

Bases: QueryResponse

The ExecutableQueryResponse object defines the response of the executable query request :param resources: List of the executables returned from the server :type resources: List[class:ai_api_client_sdk.models.executable.Executable] :param count: Total number of the queried executables :type count: int :param **kwargs: The keyword arguments are there in case there are additional attributes returned from server

static from_dict(response_dict)

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

Parameters:: response_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.executable_query_response.ExecutableQueryResponse

__init__(resources, count, **kwargs)

Parameters:

resources (List[Executable])
count (int)

ai_api_client_sdk.models.execution module

class Execution

Bases: Enactment

The Execution object defines an execution

Parameters:

id (str) -- ID of the execution
configuration_id (str) -- ID of the configuration which configured the execution
configuration_name (str) -- Name of the configuration which configured the execution
scenario_id (str) -- ID of the scenario which the execution belongs to
status (class:ai_api_client_sdk.models.status.Status) -- Status of the execution
target_status (class:ai_api_client_sdk.models.target_status.TargetStatus) -- Target status of the execution
execution_schedule_id (str, optional) -- ID of the execution schedule, defaults to None
created_at (datetime) -- Time when the execution was created
modified_at (datetime) -- Time when the execution was last modified
output_artifacts (List[class:ai_api_client_sdk.models.artifact.Artifact], optional) -- List of the artifacts created by the execution, defaults to None
status_message (str, optional) -- Gives information about the status of the execution, defaults to None
status_details (Dict[str, Any], optional) -- A dict, which gives detailed information about the status of the execution, defaults to None
submission_time (datetime, optional) -- Time when the execution was submitted
start_time (datetime, optional) -- Time when the execution status changed to RUNNING
completion_time (datetime, optional) -- Time when the execution status changed to COMPLETED/DEAD/STOPPED
**kwargs -- The keyword arguments are there in case there are additional attributes returned from server

static from_dict(execution_dict)

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

Parameters:: execution_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.execution.Execution

__init__(id, configuration_id, configuration_name, scenario_id, status, target_status, created_at, modified_at, output_artifacts=None, status_message=None, status_details=None, submission_time=None, start_time=None, execution_schedule_id=None, completion_time=None, **kwargs)

Parameters:

id (str)
configuration_id (str)
configuration_name (str)
scenario_id (str)
status (Status)
target_status (TargetStatus)
created_at (datetime)
modified_at (datetime)
output_artifacts (List[Artifact])
status_message (str)
status_details (Dict[str, Any])
submission_time (datetime)
start_time (datetime)
execution_schedule_id (str)
completion_time (datetime)

ai_api_client_sdk.models.execution_bulk_modify_response module

class ExecutionBulkModifyResponse

Bases: object

The ExecutionBulkModifyResponse object defines the response to the executions bulk modify request :param exeuctions: Response to the bulk modify request of executions :type exeuctions: List[Union[BasicResponse, BulkModifyErrorResponse]]

static from_dict(response_dict)

Returns a ai_api_client_sdk.models.execution_bulk_modify_response.ExecutionBulkModifyResponse object, created from the values provided as parameter

Parameters:: response_dict (Dict[str, List[Dict[str, Union[str, 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.execution_bulk_modify_response.ExecutionBulkModifyResponse

__init__(executions, **kwargs)

Parameters:: executions (List[BasicResponse | BulkModifyErrorResponse])

ai_api_client_sdk.models.execution_create_response module

class ExecutionCreateResponse

Bases: BasicResponse

The ExecutionCreateResponse object defines the response of the execution create request :param id: ID of the execution :type id: str :param message: Response message from the server :type message: str :param status: Status of the execution :type status: class:ai_api_client_sdk.models.status.Status :param **kwargs: The keyword arguments are there in case there are additional attributes returned from server

static from_dict(response_dict)

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

Parameters:: response_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.execution_create_response.ExecutionCreateResponse

__init__(id, message, status, **kwargs)

Parameters:

id (str)
message (str)
status (Status)

ai_api_client_sdk.models.execution_get_status_response module

class ExecutionGetStatusResponse

Bases: EnactmentGetStatusResponse

The ExecutionGetStatusResponse object defines the response of the execution get status :param id: ID of the execution :type id: str :param configuration_id: ID of the configuration which configured the execution :type configuration_id: str :param status: Status of the execution :type status: class:ai_api_client_sdk.models.status.Status :param created_at: Time when the execution was created :type created_at: datetime :param modified_at: Time when the execution was last modified :type modified_at: datetime :param status_details: A dict, which gives detailed information about the status of the execution, defaults to None :type status_details: Dict[str, Any], optional

static from_dict(execution_dict)

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

Parameters:: execution_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.execution_get_status_response.ExecutionGetStatusResponse

__init__(id, configuration_id, status, created_at, modified_at, status_details=None)

Parameters:

id (str)
configuration_id (str)
status (Status)
created_at (datetime)
modified_at (datetime)
status_details (Dict[str, Any])

ai_api_client_sdk.models.execution_query_response module

class ExecutionQueryResponse

Bases: QueryResponse

The ExecutionQueryResponse object defines the response of the execution query request :param resources: List of the executions returned from the server :type resources: List[class:ai_api_client_sdk.models.execution.Execution] :param count: Total number of the queried executions :type count: int :param **kwargs: The keyword arguments are there in case there are additional attributes returned from server

static from_dict(response_dict)

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

Parameters:: response_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.execution_query_response.ExecutionQueryResponse

__init__(resources, count, **kwargs)

Parameters:

resources (List[Execution])
count (int)

ai_api_client_sdk.models.execution_schedule module

class ExecutionSchedule

Bases: object

An Execution Schedule allows to trigger executions periodically

Parameters:

id (str) -- ID of the execution schedule
name (str) -- Name of the execution schedule
cron (str) -- Cron defining the schedule to run the executions
configuration_id (str) -- ID of the configuration for the execution schedule
status (str) -- status of the execution schedule
created_at (datetime, optional) -- Time when the execution schedule was created
modified_at (datetime, optional) -- Time when the execution schedule was last modified
start (datetime, optional) -- Start time of the execution schedule
end (datetime, optional) -- End time of the execution schedule
**kwargs -- The keyword arguments are there in case there are additional attributes returned from server

static from_dict(execution_schedule_dict)

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

Parameters:: execution_schedule_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.execution_schedule.Schedule

__init__(id, name, cron, configuration_id, status, created_at, modified_at, start=None, end=None, **kwargs)

Parameters:

id (str)
name (str)
cron (str)
configuration_id (str)
status (ScheduleStatus)
created_at (datetime)
modified_at (datetime)
start (datetime)
end (datetime)

ai_api_client_sdk.models.execution_schedule_create_response module

class ExecutionScheduleCreateResponse

Bases: BasicResponse

The ExecutionScheduleCreateResponse object defines the response of the execution schedule create request. Refer to ai_api_client_sdk.models.base_models.BasicResponse, for the object definition

static from_dict(response_dict)

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

Parameters:: response_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.execution_schedule_create_response.ExecutionScheduleCreateResponse

ai_api_client_sdk.models.execution_schedule_query_response module

class ExecutionScheduleQueryResponse

Bases: QueryResponse

The ExecutionScheduleQueryResponse object defines the response of the execution schedule query request :param resources: List of the execution schedules returned from the server :type resources: List[class:ai_api_client_sdk.models.execution_schedule.ExecutionSchedule] :param count: Total number of the queried execution schedules :type count: int :param **kwargs: The keyword arguments are there in case there are additional attributes returned from server

static from_dict(response_dict)

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

Parameters:: response_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.execution_schedule_query_response.ExecutionScheduleQueryResponse

__init__(resources, count, **kwargs)

Parameters:

resources (List[ExecutionSchedule])
count (int)

ai_api_client_sdk.models.extensions module

class Extensions

Bases: object

The Extensions object represents the extensions to the AI API

Parameters:

analytics (class:ai_api_client_sdk.models.extensions_analytics.ExtensionsAnalytics, optional) -- Metadata and capabilities of the Analytics API, defaults to None
resource_groups (class:ai_api_client_sdk.models.extensions_resource_groups.ExtensionsResourceGroups, optional) -- Metadata and capabilities of the Resource Groups API, defaults to None
dataset (class:ai_api_client_sdk.models.extensions_dataset.ExtensionsDataset, optional) -- Metadata and capabilities of the Dataset API, defaults to None
**kwargs -- The keyword arguments are there in case there are additional attributes returned from server

static from_dict(extensions_dict)

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

Parameters:: extensions_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.extensions.Extensions

__init__(analytics=None, resource_groups=None, dataset=None, **kwargs)

Parameters:

analytics (ExtensionsAnalytics)
resource_groups (ExtensionsResourceGroups)
dataset (ExtensionsDataset)

ai_api_client_sdk.models.extensions_analytics module

class ExtensionsAnalytics

Bases: object

The ExtensionsAnalytics object represents the metadata and capabilities of the Analytics API

Parameters:

version (str) -- Version of the Analytics API
**kwargs -- The keyword arguments are there in case there are additional attributes returned from server

static from_dict(extensions_analytics_dict)

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

Parameters:: extensions_analytics_dict (Dict[str, str]) -- 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.extensions_analytics.ExtensionsAnalytics

__init__(version, **kwargs)

Parameters:: version (str)

ai_api_client_sdk.models.extensions_dataset module

class ExtensionsDataset

Bases: object

The ExtensionsDataset object represents the metadata and capabilities of the Dataset API

Parameters:

version (str) -- Version of the Dataset API
capabilities (class:ai_api_client_sdk.models.dataset_capabilities.DatasetCapabilities, optional) -- Capabilities of the Dataset API, defaults to None
limits (class:ai_api_client_sdk.models.dataset_limits.DatasetLimits, optional) -- Limits of the Dataset API, defaults to None
**kwargs -- The keyword arguments are there in case there are additional attributes returned from server

static from_dict(extensions_dataset_dict)

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

Parameters:: extensions_dataset_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.extensions_dataset.ExtensionsDataset

__init__(version, capabilities=None, limits=None, **kwargs)

Parameters:

version (str)
capabilities (DatasetCapabilities)
limits (DatasetLimits)

ai_api_client_sdk.models.extensions_resource_groups module

class ExtensionsResourceGroups

Bases: object

The ExtensionsResourceGroups object represents the metadata and capabilities of the Resource Groups API

Parameters:

version (str) -- Version of the Resource Groups API
**kwargs -- The keyword arguments are there in case there are additional attributes returned from server

static from_dict(extensions_resource_groups_dict)

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

Parameters:: extensions_resource_groups_dict (Dict[str, str]) -- 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.extensions_resource_groups.ExtensionsResourceGroups

__init__(version, **kwargs)

Parameters:: version (str)

ai_api_client_sdk.models.healthz_status module

class HealthStatus

Bases: Enum

NOT_READY = 'NOT READY'

READY = 'READY'

class HealthzStatus

Bases: object

The HealthzStatus object defines the response of the healthz endpoint :param status: Health status of the server :type status: class:ai_api_client_sdk.models.healthz_status.HealthStatus :param message: Response message from the server :type message: str :param **kwargs: The keyword arguments are there in case there are additional attributes returned from server

static from_dict(healthz_status_dict)

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

Parameters:: healthz_status_dict (Dict[str, str]) -- 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.healthz_status.HealthzStatus

__init__(status, message, **kwargs)

Parameters:

status (HealthStatus)
message (str)

ai_api_client_sdk.models.input_artifact module

class InputArtifact

Bases: object

The InputArtifact object defines the input artifact specified in the executable definition. :param name: name of artifact :type name: str :param kind: kind of artifact (Dataset, Model, ResultSet) :type kind: str :param description: description of artifact :type description: str :param labels: labels for artifact :type labels: List[class:ai_api_client_sdk.models.label.Label]

static from_dict(input_artifact_dict)

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

Parameters:: input_artifact_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.input_artifact.InputArtifact

__init__(name, kind=None, description=None, labels=None)

Parameters:

name (str)
kind (str)
description (str)
labels (List[Label])

ai_api_client_sdk.models.input_artifact_binding module

class InputArtifactBinding

Bases: object

The InputArtifactBinding object defines the input artifact specified in the configuration.

Parameters:

key (str) -- matches the input artifact name in the executable definition
id (str) -- ID of the artifact
**kwargs -- The keyword arguments are there in case there are additional attributes returned from server

static from_dict(input_artifact_binding_dict)

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

Parameters:: input_artifact_binding_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.input_artifact_binding.InputArtifactBinding

__init__(key, artifact_id, **kwargs)

Parameters:

key (str)
artifact_id (str)

to_dict()

Returns the attributes of the object as a dictionary

Returns:: A dict, including all the attributes of the object
Return type:: Dict[str, str]

ai_api_client_sdk.models.label module

class Label

Bases: KeyValue

The Label object defines a label as a key-value pair. Refer to ai_api_client_sdk.models.base_models.KeyValue, for the object definition

static from_dict(label_dict)

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

Parameters:: label_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.label.Label

ai_api_client_sdk.models.log_response module

class LogResponse

Bases: object

The LogResponse object defines the response of the log request :param data: log response data :type data: class:ai_api_client_sdk.models.log_response.LogResponseData :param **kwargs: The keyword arguments are there in case there are additional attributes returned from server

static from_dict(log_response_dict)

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

Parameters:: log_response_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.log_response.LogResponse

__init__(data, **kwargs)

Parameters:: data (LogResponseData)

class LogResponseData

Bases: object

The LogResponseData object defines the data of the log response :param result: result of the log query :type result: List[class:ai_api_client_sdk.models.log_response.LogResponseResultItem] :param **kwargs: The keyword arguments are there in case there are additional attributes returned from server

static from_dict(log_response_data_dict)

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

Parameters:: log_response_data_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.log_response.LogResponseData

__init__(result, **kwargs)

Parameters:: result (List[LogResultItem])

class LogResultItem

Bases: object

The LogResultItem object defines each item in the log response :param msg: log message :type msg: str :param timestamp: timestamp corresponding to the log message :type timestamp: datetime :param **kwargs: The keyword arguments are there in case there are additional attributes returned from server

static from_dict(log_result_item_dict)

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

Parameters:: log_result_item_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.log_response.LogResultItem

__init__(msg, timestamp, **kwargs)

Parameters:

msg (str)
timestamp (datetime)

ai_api_client_sdk.models.metric module

class Metric

Bases: object

The Metric object, defines a single metric.

Parameters:

name (str) -- Name of the metric
value (float) -- numeric value of the metric
timestamp (datetime) -- Time when the metric was created
step (int) -- any measurement of training progress (number of training iterations, number of epochs, etc.)
labels (List[class:ai_api_client_sdk.models.metric_label.MetricLabel]) -- List of the labels of the metric, defaults to None
**kwargs -- The keyword arguments are there in case there are additional attributes returned from server

static from_dict(metric_dict)

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

Parameters:: metric_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.metric.Metric

__init__(name, value, timestamp, step=None, labels=None, **kwargs)

Parameters:

name (str)
value (float)
timestamp (datetime)
step (int)
labels (List[MetricLabel])

to_dict()

Returns the attributes of the object as a dictionary

Returns:: A dict, including all the attributes of the object
Return type:: Dict[str, str]

ai_api_client_sdk.models.metric_custom_info module

class MetricCustomInfo

Bases: NameValue

The MetricCustomInfo object defines rendering/semantic information regarding certain metric for consuming application or complex metrics in JSON format, as a name-value pair. Refer to ai_api_client_sdk.models.base_models.NameValue, for the object definition

static from_dict(metric_custom_info_dict)

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

Parameters:: metric_custom_info_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.metric_custom_info.MetricCustomInfo

ai_api_client_sdk.models.metric_label module

class MetricLabel

Bases: NameValue

The MetricLabel object defines a metric label as a name-value pair. Refer to ai_api_client_sdk.models.base_models.NameValue, for the object definition

static from_dict(metric_label_dict)

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

Parameters:: metric_label_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.metric_label.MetricLabel

to_dict()

Returns the attributes of the object as a dictionary

Returns:: A dict, including all the attributes of the object
Return type:: Dict[str, str]

ai_api_client_sdk.models.metric_resource module

class MetricResource

Bases: object

The Metric object, defines collection of various metrics/tags/labels related to an execution.

Parameters:

execution_id (str) -- ID of the execution
metrics (List[class:ai_api_client_sdk.metric.Metric], optional) -- List of the metrics related to the execution, defaults to None
tags (List[class:'ai_api_client_sdk.models.metric_tag.MetricTag'], optional) -- List of the tags related to the execution, defaults to None
custom_info (List[class:ai_api_client_sdk.models.metric_custom_info.MetricCustomInfo], optional) -- List of custom info related to the execution, defaults to None
**kwargs -- The keyword arguments are there in case there are additional attributes returned from server

static from_dict(metric_resource_dict)

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

Parameters:: metric_resource_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.metric_resource.MetricResource

__init__(execution_id, metrics=None, tags=None, custom_info=None, **kwargs)

Parameters:

execution_id (str)
metrics (List[Metric])
tags (List[MetricTag])
custom_info (List[MetricCustomInfo])

ai_api_client_sdk.models.metric_tag module

class MetricTag

Bases: NameValue

The MetricTag object defines a tag as a name-value pair. Refer to ai_api_client_sdk.models.base_models.NameValue, for the object definition

static from_dict(metric_tag_dict)

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

Parameters:: metric_tag_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.metric_tag.MetricTag

ai_api_client_sdk.models.metrics_query_response module

class MetricsQueryResponse

Bases: QueryResponse

The MetricsQueryResponse object defines the response of the metrics query request :param resources: List of the metrics returned from the server :type resources: List[class:ai_api_client_sdk.models.metrics_resource.MetricResource] :param count: Total number of the queried metrics :type count: int :param **kwargs: The keyword arguments are there in case there are additional attributes returned from server

static from_dict(response_dict)

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

Parameters:: response_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.metrics_query_response.MetricsQueryResponse

__init__(resources, count, **kwargs)

Parameters:

resources (List[MetricResource])
count (int)

ai_api_client_sdk.models.model module

class Model

Bases: object

The Model object defines a model :param executable_id: ID of the executable :type executable_id: str :param model: Unique name of the model :type model: str :param description: Description of the model, defaults to None :type description: str, optional :param versions: List of available model versions, defaults to None :type versions: List[class:ai_api_client_sdk.models.model_version.ModelVersion], optional :param display_name: Display name of the model, defaults to None :type display_name: str, optional :param access_type: Access type of the model, defaults to None :type access_type: str, optional :param provider: Provider of the model, defaults to None :type provider: str, optional :param allowed_scenarios: List of allowed scenarios for the model, defaults to None :type allowed_scenarios:

List[ai_api_client_sdk.models.model_base_data_allowed_scenarios.ModelBaseDataAllowedScenarios], optional

Parameters:: **kwargs -- The keyword arguments are there in case there are additional attributes returned from server

static from_dict(model_dict)

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

Parameters:: model_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.model.Model

__init__(executable_id, model, description=None, versions=None, display_name=None, access_type=None, provider=None, allowed_scenarios=None, **kwargs)

Parameters:

executable_id (str)
model (str)
description (str)
versions (List[ModelVersion])
display_name (str)
access_type (str)
provider (str)
allowed_scenarios (List[ModelBaseDataAllowedScenarios])

ai_api_client_sdk.models.model_base_data_allowed_scenarios module

class ModelBaseDataAllowedScenarios

Bases: object

This class defines the allowed scenarios for the model base data.

static from_dict(allowed_scenarios_dict)

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

Parameters:: allowed_scenarios_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.model_base_data_allowed_scenarios.ModelBaseDataAllowedScenarios

__init__(scenario_id, executable_id)

Parameters:

scenario_id (str) -- ID of the scenario
executable_id (str) -- ID of the executable

ai_api_client_sdk.models.model_query_response module

class ModelQueryResponse

Bases: QueryResponse

The ModelQueryResponse object defines the response of the model query request :param resources: List of the models returned from the server :type resources: List[class:ai_api_client_sdk.models.executable.Model] :param count: Total number of the queried models :type count: int :param **kwargs: The keyword arguments are there in case there are additional attributes returned from server

static from_dict(response_dict)

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

Parameters:: response_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.executable_query_response.ModelQueryResponse

__init__(resources, count, **kwargs)

Parameters:

resources (List[Model])
count (int)

ai_api_client_sdk.models.model_version module

class ModelVersion

Bases: object

The ModelVersion object defines a version for a model :param name: Name of the model version :type name: str :param is_latest: True if model version is latest, otherwise false :type is_latest: bool :param deprecated: True if model version is deprecated, otherwise false :type deprecated: bool :param retirement_date: Retirement date of the model version, defaults to None :type retirement_date: datetime, optional :param context_length: Context length of the model version, defaults to None :type context_length: int, optional :param input_types: Input types supported by the model version, defaults to None :type input_types: List[str], optional :param capabilities: Capabilities of the model version, defaults to None :type capabilities: List[str], optional :param metadata: Metadata of the model version, defaults to None :type metadata: List[Dict[str, str]], optional :param cost: Cost of the model version, defaults to None :type cost: List[Dict[str, str]], optional :param suggested_replacements: Suggested replacements for the model version, defaults to None :type suggested_replacements: List[str], optional :param streaming_supported: True if streaming is supported, otherwise false :type streaming_supported: bool, optional :param orchestration_capabilities: Orchestration capabilities of the model version, defaults to None :type orchestration_capabilities: List[str], optional :param **kwargs: The keyword arguments are there in case there are additional attributes returned from server

static from_dict(model_version_dict)

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

Parameters:: model_version_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.model_version.ModelVersion

__init__(name, is_latest, deprecated, retirement_date=None, context_length=None, input_types=None, capabilities=None, metadata=None, cost=None, suggested_replacements=None, streaming_supported=None, orchestration_capabilities=None, **kwargs)

Parameters:

name (str)
is_latest (bool)
deprecated (bool)
retirement_date (datetime | None)
context_length (int | None)
input_types (List[str] | None)
capabilities (List[str] | None)
metadata (Dict[str, str] | None)
cost (Dict[str, str] | None)
suggested_replacements (List[str] | None)
streaming_supported (bool | None)
orchestration_capabilities (List[str] | None)

ai_api_client_sdk.models.output_artifact module

class OutputArtifact

Bases: object

The OutputArtifact object defines the output artifact specified in the executable definition. :param name: name of artifact :type name: str :param kind: kind of artifact (Dataset, Model, ResultSet) :type kind: str :param description: description of artifact :type description: str :param labels: labels for artifact :type labels: List[class:ai_api_client_sdk.models.label.Label]

static from_dict(output_artifact_dict)

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

Parameters:: output_artifact_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.output_artifact.OutputArtifact

__init__(name, kind=None, description=None, labels=None)

Parameters:

name (str)
kind (str)
description (str)
labels (List[Label])

ai_api_client_sdk.models.parameter module

class Parameter

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

Bases: Enum

STRING = 'string'

static from_dict(parameter_dict)

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

__init__(name, type, description=None, default=None, **kwargs)

Parameters:

name (str)
type (Type)
description (str)
default (str)

ai_api_client_sdk.models.parameter_binding module

class ParameterBinding

Bases: KeyValue

The ParameterBinding object defines the input artifact specified in the configuration, as a key-value pair. Refer to ai_api_client_sdk.models.base_models.KeyValue, for the object definition

static from_dict(parameter_binding_dict)

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

Parameters:: parameter_binding_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_binding.ParameterBinding

ai_api_client_sdk.models.resource_group module

class ResourceGroup

Bases: object

ResourceGroup represents the resource group.

Parameters:

resource_group_id (str) -- The resource_group_id of this ResourceGroup.
labels (ResourceGroupLabels) -- The labels of this ResourceGroup.
status (str) -- The status of this ResourceGroup.
created_at (datetime) -- Time when the resource group was created

static from_dict(resource_group_dict)

Returns a ai_core_sdk.models.resource_group.ResourceGroup object, created from the values in the dict provided as parameter

Parameters:: resource_group_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_core_sdk.models.resource_group.ResourceGroup

__init__(resource_group_id=None, labels=None, status=None, created_at=None, *args, **kwargs)

Parameters:

resource_group_id (str)
labels (List[Label])
status (ResourceGroupStatus)
created_at (datetime)

ai_api_client_sdk.models.resource_group_query_response module

class ResourceGroupQueryResponse

Bases: QueryResponse

The ResourceGroupQueryResponse object defines the response of the resourceGroups query request :param resources: List of the resource groups returned from the server :type resources: List[class:ai_core_sdk.models.resource_group.ResourceGroup] :param count: Total number of the queried docker registry secrets :type count: int :param **kwargs: The keyword arguments are there in case there are additional attributes returned from server

static from_dict(response_dict)

Returns a ai_core_sdk.models.docker_registry_secret_query_response.DockerRegistrySecretQueryResponse object, created from the values in the dict provided as parameter

Parameters:: response_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_core_sdk.models.docker_registry_secret_query_response.DockerRegistrySecretQueryResponse

__init__(resources, count, **kwargs)

Parameters:

resources (List[ResourceGroup])
count (int)

ai_api_client_sdk.models.resource_group_status module

class ResourceGroupStatus

Bases: Enum

ResourceGroupStatus is an Enum defining the valid values of the status of a resource group

ERROR = 'ERROR'

PROVISIONED = 'PROVISIONED'

PROVISIONING = 'PROVISIONING'

ai_api_client_sdk.models.scenario module

class Scenario

Bases: object

The Scenario object defines a scenario :param id: ID of the scenario :type id: str :param created_at: Time when the scenario was created :type created_at: datetime :param modified_at: Time when the scenario was last modified :type modified_at: datetime :param name: Name of the scenario :type name: str :param description: Description of the scenario, defaults to None :type description: str, optional :param labels: List of the labels of the scenario, defaults to None :type labels: List[class:ai_api_client_sdk.models.label.Label] :param **kwargs: The keyword arguments are there in case there are additional attributes returned from server

static from_dict(scenario_dict)

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

Parameters:: scenario_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.scenario.Scenario

__init__(id, created_at, modified_at, name, description=None, labels=None, **kwargs)

Parameters:

id (str)
created_at (datetime)
modified_at (datetime)
name (str)
description (str)
labels (List[Label])

is_llm_scenario()

Returns if the scenario is a LLM scenario or not

Returns:: True if scenario is llm scenario, False otherwise
Return type:: bool

ai_api_client_sdk.models.scenario_query_response module

class ScenarioQueryResponse

Bases: QueryResponse

The ScenarioQueryResponse object defines the response of the scenario query request :param resources: List of the scenarios returned from the server :type resources: List[class:ai_api_client_sdk.models.scenario.Scenario] :param count: Total number of the queried scenarios :type count: int :param **kwargs: The keyword arguments are there in case there are additional attributes returned from server

static from_dict(response_dict)

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

Parameters:: response_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.scenario_query_response.ScenarioQueryResponse

__init__(resources, count, **kwargs)

Parameters:

resources (List[Scenario])
count (int)

ai_api_client_sdk.models.status module

class ScheduleStatus

Bases: Enum

Enum defining the status values for execution schedules

ACTIVE = 'ACTIVE'

INACTIVE = 'INACTIVE'

class Status

Bases: Enum

Status is an Enum defining the valid values of the status of an execution/deployment

COMPLETED = 'COMPLETED'

DEAD = 'DEAD'

PENDING = 'PENDING'

RUNNING = 'RUNNING'

STOPPED = 'STOPPED'

STOPPING = 'STOPPING'

UNKNOWN = 'UNKNOWN'

ai_api_client_sdk.models.target_status module

class TargetStatus

Bases: Enum

TargetStatus is an Enum defining the valid values of the target status of an execution/deployment

COMPLETED = 'COMPLETED'

DELETED = 'DELETED'

RUNNING = 'RUNNING'

STOPPED = 'STOPPED'

ai_api_client_sdk.models.version module

class Version

Bases: object

The Version object defines a scenario :param id: ID of the version :type id: str :param scenario_id: ID of the scenario the version belongs to :type scenario_id: str :param created_at: Time when the scenario was created :type created_at: datetime :param modified_at: Time when the scenario was last modified :type modified_at: datetime :param description: Description of the scenario, defaults to None :type description: str, optional :param **kwargs: The keyword arguments are there in case there are additional attributes returned from server

static from_dict(version_dict)

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

Parameters:: version_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.version.Version

__init__(id, scenario_id, created_at, modified_at, description=None, **kwargs)

Parameters:

id (str)
scenario_id (str)
created_at (datetime)
modified_at (datetime)
description (str)

ai_api_client_sdk.models.version_list module

class VersionList

Bases: object

The VersionList object, is a list of API version descriptions

Parameters:

versions (class:ai_api_client_sdk.models.api_version.APIVersion, optional) -- A list of objects describing the API versions, defaults to None
**kwargs -- The keyword arguments are there in case there are additional attributes returned from server

static from_dict(version_list_dict)

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

Parameters:: version_list_dict (Dict[str, List[Dict[str, str]]) -- 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.version_list.VersionList

__init__(versions=None)

Parameters:: versions (List[APIVersion])

ai_api_client_sdk.models.version_query_response module

class VersionQueryResponse

Bases: QueryResponse

The VersionQueryResponse object defines the response of the version query request :param resources: List of the versions returned from the server :type resources: List[class:ai_api_client_sdk.models.version.Version] :param count: Total number of the queried versions :type count: int :param **kwargs: The keyword arguments are there in case there are additional attributes returned from server

static from_dict(response_dict)

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

Parameters:: response_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.version_query_response.VersionQueryResponse

__init__(resources, count, **kwargs)

Parameters:

resources (List[Version])
count (int)