ai_api_client_sdk.resource_clients package

Submodules

ai_api_client_sdk.resource_clients.artifact_client module

class ArtifactClient

Bases: BaseClient

ArtifactClient is a class implemented for interacting with the artifact related endpoints of the server. It implements the base class ai_api_client_sdk.resource_clients.base_client.BaseClient

count(scenario_id=None, execution_id=None, name=None, kind=None, artifact_label_selector=None, resource_group=None)

Counts the artifacts.

Parameters:

scenario_id (str, optional) -- ID of the scenario the artifacts should belong to, defaults to None
execution_id (str, optional) -- ID of the execution the artifact should be resulted from, defaults to None
name (str, optional) -- Name of the artifact(s) to be retrieved, defaults to None
kind (class:ai_api_client_sdk.models.artifact.Artifact.Kind, optional) -- Kind of the artifacts to be retrieved, defaults to None
artifact_label_selector (List[str], optional) -- list of the label selector strings in the form of "key=value" or "key!=value", to filter the artifacts with respect to their labels, defaults to None
resource_group (str) -- Resource Group which the request should be sent on behalf. Either this or a default resource group in the ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client should be specified, defaults to None

Raises:

class:ai_api_client_sdk.exception.AIAPIInvalidRequestException if a 400 response is received from the server

Raises:

class:ai_api_client_sdk.exception.AIAPIAuthorizationException if a 401 response is received from the server

Raises:

class:ai_api_client_sdk.exception.AIAPIServerException if a non-2XX response is received from the server

Returns:

An object representing the response from the server

Return type:

int

create(name, kind, url, scenario_id, description=None, labels=None, resource_group=None)

Creates an artifact.

Parameters:

name (str) -- Name of the artifact
kind (class:ai_api_client_sdk.models.artifact.Artifact.Kind) -- Kind of the artifact
url (str) -- URL of the artifact
scenario_id (str) -- ID of the scenario which the artifact should belong to
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
resource_group (str) -- Resource Group which the request should be sent on behalf. Either this or a default resource group in the ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client should be specified, defaults to None

Raises:

class:ai_api_client_sdk.exception.AIAPIInvalidRequestException if a 400 response is received from the server

Raises:

class:ai_api_client_sdk.exception.AIAPIAuthorizationException if a 401 response is received from the server

Raises:

class:ai_api_client_sdk.exception.AIAPIServerException if a non-2XX response is received from the server

Returns:

An object representing the response from the server

Return type:

class:ai_api_client_sdk.models.artifact_create_response.ArtifactCreateResponse

get(artifact_id, expand=None, resource_group=None)

Retrieves the artifact from the server.

Parameters:

artifact_id (str) -- ID of the artifact to be retrieved
expand (str, optional) -- Entity whose details to be displayed in the response, defaults to None
resource_group (str) -- Resource Group which the request should be sent on behalf. Either this or a default resource group in the ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client should be specified, defaults to None

Raises:

class:ai_api_client_sdk.exception.AIAPIInvalidRequestException if a 400 response is received from the server

Raises:

class:ai_api_client_sdk.exception.AIAPIAuthorizationException if a 401 response is received from the server

Raises:

class:ai_api_client_sdk.exception.AIAPINotFoundException if a 404 response is received from the server

Raises:

class:ai_api_client_sdk.exception.AIAPIServerException if a non-2XX response is received from the server

Returns:

The retrieved artifact

Return type:

class:ai_api_client_sdk.models.artifact.Artifact

query(scenario_id=None, execution_id=None, name=None, kind=None, artifact_label_selector=None, top=None, skip=None, search=None, search_case_insensitive=None, expand=None, resource_group=None)

Queries the artifacts.

Parameters:

scenario_id (str, optional) -- ID of the scenario the artifacts should belong to, defaults to None
execution_id (str, optional) -- ID of the execution the artifact should be resulted from, defaults to None
name (str, optional) -- Name of the artifact(s) to be retrieved, defaults to None
kind (class:ai_api_client_sdk.models.artifact.Artifact.Kind, optional) -- Kind of the artifacts to be retrieved, defaults to None
artifact_label_selector (list, optional) -- Query the artifacts based on their labels in the form of "key=value" or "key!=value" separated by commas, defaults to None
top (int, optional) -- Number of artifacts to be retrieved, defaults to None
skip (int, optional) -- Number of artifacts to be skipped, from the list of the queried artifacts, defaults to None
search (str, optional) -- Generic search term to be looked for in various attributes of artifacts, defaults to None
search_case_insensitive (bool, optional) -- Indicates whether the search should be case insensitive
expand (str, optional) -- Entity whose details to be displayed in the response, defaults to None
resource_group (str) -- Resource Group which the request should be sent on behalf. Either this or a default resource group in the ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client should be specified, defaults to None

Raises:

class:ai_api_client_sdk.exception.AIAPIInvalidRequestException if a 400 response is received from the server

Raises:

class:ai_api_client_sdk.exception.AIAPIAuthorizationException if a 401 response is received from the server

Raises:

class:ai_api_client_sdk.exception.AIAPIServerException if a non-2XX response is received from the server

Returns:

An object representing the response from the server

Return type:

class:ai_api_client_sdk.models.artifact_query_response.ArtifactQueryResponse

ai_api_client_sdk.resource_clients.base_client module

class BaseClient

Bases: object

BaseClient defines the interface for the resource clients.

Parameters:: rest_client (class:ai_api_client_sdk.helpers.rest_client.RestClient) -- the client used to make calls to the server

__init__(rest_client)

Parameters:: rest_client (RestClient)

bulk_modify(*args, **kwargs): Modifies multiple instances of the relevant resource. Will be implemented by the respective resource clients

count(*args, **kwargs): Counts the relevant resources. Will be implemented by the respective resource clients

create(*args, **kwargs): Creates the relevant resource. Will be implemented by the respective resource clients

delete(*args, **kwargs): Deletes the relevant resource. Will be implemented by the respective resource clients

get(*args, **kwargs): Retrieves the relevant resource. Will be implemented by the respective resource clients

modify(*args, **kwargs): Modifies the relevant resource. Will be implemented by the respective resource clients

query(*args, **kwargs): Queries the relevant resources. Will be implemented by the respective resource clients

query_logs(*args, **kwargs): Queries the relevant logs. Will be implemented by the respective resource clients

ai_api_client_sdk.resource_clients.configuration_client module

class ConfigurationClient

Bases: BaseClient

ConfigurationClient is a class implemented for interacting with the configuration related endpoints of the server. It implements the base class ai_api_client_sdk.resource_clients.base_client.BaseClient

count(scenario_id=None, executable_ids=None, search=None, resource_group=None)

Counts the configurations.

Parameters:

scenario_id (str, optional) -- ID of the scenario the configurations should belong to, defaults to None
executable_ids (List[str], optional) -- IDs of the executables the configurations should have configured, defaults to None
search (str, optional) -- Generic search term to be looked for in various attributes of configurations, defaults to None
resource_group (str) -- Resource Group which the request should be sent on behalf. Either this or a default resource group in the ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client should be specified, defaults to None

Raises:

class:ai_api_client_sdk.exception.AIAPIInvalidRequestException if a 400 response is received from the server

Raises:

class:ai_api_client_sdk.exception.AIAPIAuthorizationException if a 401 response is received from the server

Raises:

class:ai_api_client_sdk.exception.AIAPIServerException if a non-2XX response is received from the server

Returns:

An object representing the response from the server

Return type:

int

create(name, scenario_id, executable_id, parameter_bindings=None, input_artifact_bindings=None, resource_group=None)

Creates a configuration.

Parameters:

name (str) -- Name of the configuration
scenario_id (str) -- ID of the scenario which the configuration should belong to
executable_id (str) -- ID of the executable, which should be configured
parameter_bindings (List[class:ai_api_client_sdk.models.parameter_binding.ParameterBinding], optional) -- List of the input parameters, 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
resource_group (str) -- Resource Group which the request should be sent on behalf. Either this or a default resource group in the ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client should be specified, defaults to None

Raises:

class:ai_api_client_sdk.exception.AIAPIInvalidRequestException if a 400 response is received from the server

Raises:

class:ai_api_client_sdk.exception.AIAPIAuthorizationException if a 401 response is received from the server

Raises:

class:ai_api_client_sdk.exception.AIAPIServerException if a non-2XX response is received from the server

Returns:

An object representing the response from the server

Return type:

class:ai_api_client_sdk.models.configuration_create_response.ConfigurationCreateResponse

get(configuration_id, expand=None, resource_group=None)

Retrieves the configuration from the server.

Parameters:

configuration_id (str) -- ID of the configuration to be retrieved
expand (str, optional) -- Entity whose details to be displayed in the response, defaults to None
resource_group (str) -- Resource Group which the request should be sent on behalf. Either this or a default resource group in the ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client should be specified, defaults to None

Raises:

class:ai_api_client_sdk.exception.AIAPIInvalidRequestException if a 400 response is received from the server

Raises:

class:ai_api_client_sdk.exception.AIAPIAuthorizationException if a 401 response is received from the server

Raises:

class:ai_api_client_sdk.exception.AIAPINotFoundException if a 404 response is received from the server

Raises:

class:ai_api_client_sdk.exception.AIAPIServerException if a non-2XX response is received from the server

Returns:

The retrieved configuration

Return type:

class:ai_api_client_sdk.models.configuration.Configuration

query(scenario_id=None, executable_ids=None, top=None, skip=None, search=None, search_case_insensitive=None, expand=None, resource_group=None)

Queries the configurations.

Parameters:

scenario_id (str, optional) -- ID of the scenario the configurations should belong to, defaults to None
executable_ids (List[str], optional) -- IDs of the executables the configurations should have configured, defaults to None
top (int, optional) -- Number of configurations to be retrieved, defaults to None
skip (int, optional) -- Number of configurations to be skipped, from the list of the queried configurations, defaults to None
search (str, optional) -- Generic search term to be looked for in various attributes of configurations, defaults to None
search_case_insensitive (bool, optional) -- Indicates whether the search should be case insensitive
expand (str, optional) -- Entity whose details to be displayed in the response, defaults to None
resource_group (str) -- Resource Group which the request should be sent on behalf. Either this or a default resource group in the ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client should be specified, defaults to None

Raises:

class:ai_api_client_sdk.exception.AIAPIInvalidRequestException if a 400 response is received from the server

Raises:

class:ai_api_client_sdk.exception.AIAPIAuthorizationException if a 401 response is received from the server

Raises:

class:ai_api_client_sdk.exception.AIAPIServerException if a non-2XX response is received from the server

Returns:

An object representing the response from the server

Return type:

class:ai_api_client_sdk.models.configuration_query_response.ConfigurationQueryResponse

ai_api_client_sdk.resource_clients.deployment_client module

class DeploymentClient

Bases: BaseClient

DeploymentClient is a class implemented for interacting with the deployment related endpoints of the server. It implements the base class ai_api_client_sdk.resource_clients.base_client.BaseClient

bulk_modify(deployments, resource_group=None)

Modifies the deployments :param deployments: List of deployment modify requests :type deployments: List[DeploymentModifyRequest] :param resource_group: Resource Group which the request should be sent on behalf. Either this or a default

resource group in the ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client should be specified, defaults to None

Raises:

class:ai_api_client_sdk.exception.AIAPIInvalidRequestException if a 400 response is received from the server

Raises:

class:ai_api_client_sdk.exception.AIAPIAuthorizationException if a 401 response is received from the server

Raises:

class:ai_api_client_sdk.exception.AIAPINotFoundException if a 404 response is received from the server

Raises:

class:ai_api_client_sdk.exception.AIAPIPreconditionFailedException if a 412 response is received from the server

Returns:

An object representing the response from the server

Return type:

class:ai_api_client_sdk.models.deployment_bulk_modify_response.DeploymentBulkModifyResponse

Parameters:

deployments (List[BasicModifyRequest])
resource_group (str)

count(scenario_id=None, configuration_id=None, executable_ids=None, status=None, resource_group=None)

Counts the number of deployments.

Parameters:

scenario_id (str, optional) -- ID of the scenario, the deployments should belong to, defaults to None
configuration_id (str, optional) -- ID of the configuration, the deployments should be configured by, defaults to None
executable_ids (List[str], optional) -- IDs of the executables, the deployments should be created from, defaults to None
status (class:ai_api_client_sdk.models.status.Status, optional) -- Status which the deployments should currently have
resource_group (str) -- Resource group which the request should be sent on behalf. Either this or a default resource group in the ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client should be specified, defaults to None

Raises:

class:ai_api_client_sdk.exception.AIAPIInvalidRequestException if a 400 response is received from the server

Raises:

class:ai_api_client_sdk.exception.AIAPIAuthorizationException if a 401 response is received from the server

Raises:

class:ai_api_client_sdk.exception.AIAPIServerException if a non-2XX response is received from the server

Returns:

An object representing the response from the server

Return type:

int

create(configuration_id, ttl=None, resource_group=None)

Creates a deployment.

Parameters:

configuration_id (str) -- ID of the configuration, that should configure the deployment
ttl (str) -- Time to live for deployment and can be none or take a number followed by the unit
resource_group (str)

Return type:

DeploymentCreateResponse

(any of following values, minutes(m|M), hours(h|H) or days(d|D)) :type ttl: str, optional :param resource_group: Resource Group which the request should be sent on behalf. Either this or a default

resource group in the ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client should be specified, defaults to None

Raises:

class:ai_api_client_sdk.exception.AIAPIInvalidRequestException if a 400 response is received from the server

Raises:

class:ai_api_client_sdk.exception.AIAPIAuthorizationException if a 401 response is received from the server

Raises:

class:ai_api_client_sdk.exception.AIAPIServerException if a non-2XX response is received from the server

Returns:

An object representing the response from the server

Return type:

class:ai_api_client_sdk.models.deployment_create_response.DeploymentCreateResponse

Parameters:

configuration_id (str)
ttl (str)
resource_group (str)

delete(deployment_id, resource_group=None)

Deletes the deployment.

Parameters:

deployment_id (str) -- ID of the deployment to be deleted
resource_group (str) -- Resource Group which the request should be sent on behalf. Either this or a default resource group in the ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client should be specified, defaults to None

Raises:

class:ai_api_client_sdk.exception.AIAPIInvalidRequestException if a 400 response is received from the server

Raises:

class:ai_api_client_sdk.exception.AIAPIAuthorizationException if a 401 response is received from the server

Raises:

class:ai_api_client_sdk.exception.AIAPINotFoundException if a 404 response is received from the server

Raises:

class:ai_api_client_sdk.exception.AIAPIPreconditionFailedException if a 412 response is received from the server

Raises:

class:ai_api_client_sdk.exception.AIAPIServerException if a non-2XX response is received from the server

Returns:

An object representing the response from the server

Return type:

class:ai_api_client_sdk.models.base_models.BasicResponse

get(deployment_id, resource_group=None, select=None)

Retrieves the deployment from the server.

Parameters:

deployment_id (str) -- ID of the deployment to be retrieved
resource_group (str) -- Resource Group which the request should be sent on behalf. Either this or a default resource group in the ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client should be specified, defaults to None
select (str, optional) -- only status supported. Get deployment for a given deployment id and select status

Raises:

class:ai_api_client_sdk.exception.AIAPIInvalidRequestException if a 400 response is received from the server

Raises:

class:ai_api_client_sdk.exception.AIAPIAuthorizationException if a 401 response is received from the server

Raises:

class:ai_api_client_sdk.exception.AIAPINotFoundException if a 404 response is received from the server

Raises:

class:ai_api_client_sdk.exception.AIAPIServerException if a non-2XX response is received from the server

Returns:

The retrieved deployment

Return type:

class:Union[ai_api_client_sdk.models.deployment.Deployment, ai_api_client_sdk.models.deployment_get_status_response.DeploymentGetStatusResponse]

modify(deployment_id, target_status=None, configuration_id=None, resource_group=None)

Modifies the deployment, by changing either the target status, or the configuration ID.

Parameters:

deployment_id (str) -- ID of the deployment to be modified
target_status (class:ai_api_client_sdk.models.target_status.TargetStatus, optional) -- Desired target status of the deployment, defaults to None
configuration_id (str, optional) -- ID of the new configuration to be used by the deployment, defaults to None
resource_group (str) -- Resource Group which the request should be sent on behalf. Either this or a default resource group in the ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client should be specified, defaults to None

Raises:

class:ai_api_client_sdk.exception.AIAPIInvalidRequestException if a 400 response is received from the server

Raises:

class:ai_api_client_sdk.exception.AIAPIAuthorizationException if a 401 response is received from the server

Raises:

class:ai_api_client_sdk.exception.AIAPINotFoundException if a 404 response is received from the server

Raises:

class:ai_api_client_sdk.exception.AIAPIPreconditionFailedException if a 412 response is received from the server

Returns:

An object representing the response from the server

Return type:

class:ai_api_client_sdk.models.base_models.BasicResponse

query(scenario_id=None, configuration_id=None, executable_ids=None, status=None, top=None, skip=None, resource_group=None)

Queries the deployments.

Parameters:

scenario_id (str, optional) -- ID of the scenario the deployments should belong to, defaults to None
configuration_id (str, optional) -- ID of the configuration, the deployments should be configured by, defaults to None
executable_ids (List[str], optional) -- IDs of the executables the deployments should be created from, defaults to None
status (class:ai_api_client_sdk.models.status.Status, optional) -- Status which the deployments should currently have
top (int, optional) -- Number of deployments to be retrieved, defaults to None
skip (int, optional) -- Number of deployments to be skipped, from the list of the queried deployments, defaults to None
resource_group (str) -- Resource Group which the request should be sent on behalf. Either this or a default resource group in the ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client should be specified, defaults to None

Raises:

class:ai_api_client_sdk.exception.AIAPIInvalidRequestException if a 400 response is received from the server

Raises:

class:ai_api_client_sdk.exception.AIAPIAuthorizationException if a 401 response is received from the server

Raises:

class:ai_api_client_sdk.exception.AIAPIServerException if a non-2XX response is received from the server

Returns:

An object representing the response from the server

Return type:

class:ai_api_client_sdk.models.deployment_query_response.DeploymentQueryResponse

query_logs(deployment_id, top=None, start=None, end=None, order=None, resource_group=None)

Queries the logs of the deployment.

Parameters:

deployment_id (str) -- ID of the deployment
top (int) -- The max number of entries to return. Defaults to 1000. Limited to 5000 max.
start (datetime) -- The start time for the query. Defaults to one hour ago.
end (datetime) -- The end time for the query. Defaults to now.
order (class:ai_api_client_sdk.models.base_models.Order) -- Determines the sort order with respect to time. Defaults to asc.
resource_group (str) -- Resource Group which the request should be sent on behalf. Either this or a default resource group in the ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client should be specified, defaults to None

Raises:

class:ai_api_client_sdk.exception.AIAPIInvalidRequestException if a 400 response is received from the server

Raises:

class:ai_api_client_sdk.exception.AIAPIAuthorizationException if a 401 response is received from the server

Raises:

class:ai_api_client_sdk.exception.AIAPINotFoundException if a 404 response is received from the server

Raises:

class:ai_api_client_sdk.exception.AIAPIServerException if a non-2XX response is received from the server

Returns:

Logs from the execution

Return type:

class:ai_api_client_sdk.models.log_response.LogResponse

ai_api_client_sdk.resource_clients.executable_client module

class ExecutableClient

Bases: BaseClient

ExecutableClient is a class implemented for interacting with the executable related endpoints of the server. It implements the base class ai_api_client_sdk.resource_clients.base_client.BaseClient

get(scenario_id, executable_id, resource_group=None)

Retrieves the executable from the server.

Parameters:

scenario_id (str) -- ID of the scenario the executable belongs to
executable_id (str) -- ID of the executable to be retrieved
resource_group (str) -- Resource Group which the request should be sent on behalf. Either this or a default resource group in the ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client should be specified, defaults to None

Raises:

class:ai_api_client_sdk.exception.AIAPIInvalidRequestException if a 400 response is received from the server

Raises:

class:ai_api_client_sdk.exception.AIAPIAuthorizationException if a 401 response is received from the server

Raises:

class:ai_api_client_sdk.exception.AIAPINotFoundException if a 404 response is received from the server

Raises:

class:ai_api_client_sdk.exception.AIAPIServerException if a non-2XX response is received from the server

Returns:

The retrieved executable

Return type:

class:ai_api_client_sdk.models.executable.Executable

query(scenario_id, version_id=None, resource_group=None)

Queries the executables.

Parameters:

scenario_id (str, optional) -- ID of the scenario the executables should belong to, defaults to None
version_id (str, optional) -- ID of the version, the executions should have, defaults to None
resource_group (str) -- Resource Group which the request should be sent on behalf. Either this or a default resource group in the ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client should be specified, defaults to None

Raises:

class:ai_api_client_sdk.exception.AIAPIInvalidRequestException if a 400 response is received from the server

Raises:

class:ai_api_client_sdk.exception.AIAPIAuthorizationException if a 401 response is received from the server

Raises:

class:ai_api_client_sdk.exception.AIAPIServerException if a non-2XX response is received from the server

Returns:

An object representing the response from the server

Return type:

class:ai_api_client_sdk.models.executable_query_response.ExecutableQueryResponse

ai_api_client_sdk.resource_clients.execution_client module

class ExecutionClient

Bases: BaseClient

ExecutionClient is a class implemented for interacting with the execution related endpoints of the server. It implements the base class ai_api_client_sdk.resource_clients.base_client.BaseClient

bulk_modify(executions, resource_group=None)

Modifies the executions :param executions: List of execution modify requests :type executions: List[ExecutionModifyRequest] :param resource_group: Resource Group which the request should be sent on behalf. Either this or a default

resource group in the ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client should be specified, defaults to None

Raises:

class:ai_api_client_sdk.exception.AIAPIInvalidRequestException if a 400 response is received from the server

Raises:

class:ai_api_client_sdk.exception.AIAPIAuthorizationException if a 401 response is received from the server

Raises:

class:ai_api_client_sdk.exception.AIAPINotFoundException if a 404 response is received from the server

Raises:

class:ai_api_client_sdk.exception.AIAPIPreconditionFailedException if a 412 response is received from the server

Returns:

An object representing the response from the server

Return type:

class:ai_api_client_sdk.models.execution_bulk_modify_response.ExecutionBulkModifyResponse

Parameters:

executions (List[BasicModifyRequest])
resource_group (str, optional)

count(scenario_id=None, configuration_id=None, executable_ids=None, execution_schedule_id=None, status=None, resource_group=None)

Counts the number of executions.

Parameters:

scenario_id (str, optional) -- ID of the scenario, the executions should belong to, defaults to None
configuration_id (str, optional) -- ID of the configuration, the executions should be configured by, defaults to None
executable_ids (List[str], optional) -- IDs of the executables, the executions should be created from, defaults to None
execution_schedule_id (str, optional) -- ID of the execution schedule, defaults to None
status (class:ai_api_client_sdk.models.status.Status, optional) -- Status which the executions should currently have
resource_group (str) -- Resource group which the request should be sent on behalf. Either this or a default resource group in the ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client should be specified, defaults to None

Raises:

class:ai_api_client_sdk.exception.AIAPIInvalidRequestException if a 400 response is received from the server

Raises:

class:ai_api_client_sdk.exception.AIAPIAuthorizationException if a 401 response is received from the server

Raises:

class:ai_api_client_sdk.exception.AIAPIServerException if a non-2XX response is received from the server

Returns:

An object representing the response from the server

Return type:

int

create(configuration_id, resource_group=None)

Creates an execution.

Parameters:

configuration_id (str) -- ID of the configuration, that should configure the execution
resource_group (str) -- Resource Group which the request should be sent on behalf. Either this or a default resource group in the ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client should be specified, defaults to None

Raises:

class:ai_api_client_sdk.exception.AIAPIInvalidRequestException if a 400 response is received from the server

Raises:

class:ai_api_client_sdk.exception.AIAPIAuthorizationException if a 401 response is received from the server

Raises:

class:ai_api_client_sdk.exception.AIAPIServerException if a non-2XX response is received from the server

Returns:

An object representing the response from the server

Return type:

class:ai_api_client_sdk.models.execution_create_response.ExecutionCreateResponse

delete(execution_id, resource_group=None)

Deletes the execution.

Parameters:

execution_id (str) -- ID of the execution to be deleted
resource_group (str) -- Resource Group which the request should be sent on behalf. Either this or a default resource group in the ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client should be specified, defaults to None

Raises:

class:ai_api_client_sdk.exception.AIAPIInvalidRequestException if a 400 response is received from the server

Raises:

class:ai_api_client_sdk.exception.AIAPIAuthorizationException if a 401 response is received from the server

Raises:

class:ai_api_client_sdk.exception.AIAPINotFoundException if a 404 response is received from the server

Raises:

class:ai_api_client_sdk.exception.AIAPIPreconditionFailedException if a 412 response is received from the server

Raises:

class:ai_api_client_sdk.exception.AIAPIServerException if a non-2XX response is received from the server

Returns:

An object representing the response from the server

Return type:

class:ai_api_client_sdk.models.base_models.BasicResponse

get(execution_id, resource_group=None, select=None)

Retrieves the execution from the server.

Parameters:

execution_id (str) -- ID of the execution to be retrieved
resource_group (str) -- Resource Group which the request should be sent on behalf. Either this or a default resource group in the ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client should be specified, defaults to None
select (str, optional) -- only status supported. Get execution for a given execution id and select status

Raises:

class:ai_api_client_sdk.exception.AIAPIInvalidRequestException if a 400 response is received from the server

Raises:

class:ai_api_client_sdk.exception.AIAPIAuthorizationException if a 401 response is received from the server

Raises:

class:ai_api_client_sdk.exception.AIAPINotFoundException if a 404 response is received from the server

Raises:

class:ai_api_client_sdk.exception.AIAPIServerException if a non-2XX response is received from the server

Returns:

The retrieved execution

Return type:

class:Union[ai_api_client_sdk.models.execution.Execution, ai_api_client_sdk.models.execution_get_status_response.ExecutionGetStatusResponse]

modify(execution_id, target_status, resource_group=None)

Modifies the execution, by changing the target status.

Parameters:

execution_id (str) -- ID of the execution to be modified
target_status (class:ai_api_client_sdk.models.target_status.TargetStatus, optional) -- Desired target status of the execution, defaults to None
resource_group (str) -- Resource Group which the request should be sent on behalf. Either this or a default resource group in the ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client should be specified, defaults to None

Raises:

class:ai_api_client_sdk.exception.AIAPIInvalidRequestException if a 400 response is received from the server

Raises:

class:ai_api_client_sdk.exception.AIAPIAuthorizationException if a 401 response is received from the server

Raises:

class:ai_api_client_sdk.exception.AIAPINotFoundException if a 404 response is received from the server

Raises:

class:ai_api_client_sdk.exception.AIAPIPreconditionFailedException if a 412 response is received from the server

Raises:

class:ai_api_client_sdk.exception.AIAPIServerException if a non-2XX response is received from the server

Returns:

An object representing the response from the server

Return type:

class:ai_api_client_sdk.models.base_models.BasicResponse

query(scenario_id=None, configuration_id=None, executable_ids=None, execution_schedule_id=None, status=None, top=None, skip=None, resource_group=None)

Queries the executions.

Parameters:

scenario_id (str, optional) -- ID of the scenario the executions should belong to, defaults to None
configuration_id (str, optional) -- ID of the configuration, the executions should be configured by, defaults to None
executable_ids (List[str], optional) -- IDs of the executables the executions should be created from, defaults to None
execution_schedule_id (str, optional) -- ID of the execution schedule, defaults to None
status (class:ai_api_client_sdk.models.status.Status, optional) -- Status which the executions should currently have
top (int, optional) -- Number of executions to be retrieved, defaults to None
skip (int, optional) -- Number of executions to be skipped, from the list of the queried executions, defaults to None
resource_group (str) -- Resource Group which the request should be sent on behalf. Either this or a default resource group in the ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client should be specified, defaults to None

Raises:

class:ai_api_client_sdk.exception.AIAPIInvalidRequestException if a 400 response is received from the server

Raises:

class:ai_api_client_sdk.exception.AIAPIAuthorizationException if a 401 response is received from the server

Raises:

class:ai_api_client_sdk.exception.AIAPIServerException if a non-2XX response is received from the server

Returns:

An object representing the response from the server

Return type:

class:ai_api_client_sdk.models.execution_query_response.ExecutionQueryResponse

query_logs(execution_id, top=None, start=None, end=None, order=None, resource_group=None)

Queries the logs of the execution.

Parameters:

execution_id (str) -- ID of the execution
top (int) -- The max number of entries to return. Defaults to 1000. Limited to 5000 max.
start (datetime) -- The start time for the query. Defaults to one hour ago.
end (datetime) -- The end time for the query. Defaults to now.
order (class:ai_api_client_sdk.models.base_models.Order) -- Determines the sort order with respect to time. Defaults to asc.
resource_group (str) -- Resource Group which the request should be sent on behalf. Either this or a default resource group in the ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client should be specified, defaults to None

Raises:

class:ai_api_client_sdk.exception.AIAPIInvalidRequestException if a 400 response is received from the server

Raises:

class:ai_api_client_sdk.exception.AIAPIAuthorizationException if a 401 response is received from the server

Raises:

class:ai_api_client_sdk.exception.AIAPINotFoundException if a 404 response is received from the server

Raises:

class:ai_api_client_sdk.exception.AIAPIServerException if a non-2XX response is received from the server

Returns:

Logs from the execution

Return type:

class:ai_api_client_sdk.models.log_response.LogResponse

ai_api_client_sdk.resource_clients.execution_schedule_client module

class ExecutionScheduleClient

Bases: BaseClient

ExecutionScheduleClient is a class implemented for interacting with the execution schedules related endpoints of the server. It implements the base class ai_api_client_sdk.resource_clients.base_client.BaseClient

count(configuration_id=None, status=None, resource_group=None)

Counts the number of executions schedules.

Parameters:

configuration_id (str, optional) -- ID of the configuration, the executions should be configured by, defaults to None
status (class:ai_api_client_sdk.models.schedule_status.ScheduleStatus, optional) -- ScheduleStatus which the execution schedule should currently have, defaults to None
resource_group (str) -- Resource group which the request should be sent on behalf. Either this or a default resource group in the ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client should be specified, defaults to None

Raises:

class:ai_api_client_sdk.exception.AIAPIInvalidRequestException if a 400 response is received from the server

Raises:

class:ai_api_client_sdk.exception.AIAPIAuthorizationException if a 401 response is received from the server

Raises:

class:ai_api_client_sdk.exception.AIAPIServerException if a non-2XX response is received from the server

Returns:

An object representing the response from the server

Return type:

int

create(name, cron, configuration_id, start=None, end=None, resource_group=None)

Creates an execution schedule.

Parameters:

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
start (datetime, optional) -- Start time of the execution schedule in UTC, defaults to None
end (datetime, optional) -- End time of the execution schedule in UTC e.g., defaults to None
resource_group (str) -- Resource Group which the request should be sent on behalf. Either this or a default resource group in the ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client should be specified, defaults to None

Raises:

class:ai_api_client_sdk.exception.AIAPIInvalidRequestException if a 400 response is received from the server

Raises:

class:ai_api_client_sdk.exception.AIAPIAuthorizationException if a 401 response is received from the server

Raises:

class:ai_api_client_sdk.exception.AIAPIServerException if a non-2XX response is received from the server

Returns:

An object representing the response from the server

Return type:

class:ai_api_client_sdk.models.execution_schedule_create_response.ExecutionScheduleCreateResponse

delete(execution_schedule_id, resource_group=None)

Deletes the execution schedule.

Parameters:

execution_schedule_id (str) -- ID of the execution schedule to be deleted
resource_group (str) -- Resource Group which the request should be sent on behalf. Either this or a default resource group in the ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client should be specified, defaults to None

Raises:

class:ai_api_client_sdk.exception.AIAPIInvalidRequestException if a 400 response is received from the server

Raises:

class:ai_api_client_sdk.exception.AIAPIAuthorizationException if a 401 response is received from the server

Raises:

class:ai_api_client_sdk.exception.AIAPINotFoundException if a 404 response is received from the server

Raises:

class:ai_api_client_sdk.exception.AIAPIPreconditionFailedException if a 412 response is received from the server

Raises:

class:ai_api_client_sdk.exception.AIAPIServerException if a non-2XX response is received from the server

Returns:

An object representing the response from the server

Return type:

class:ai_api_client_sdk.models.base_models.BasicResponse

get(execution_schedule_id, resource_group=None)

Retrieves the execution schedule from the server.

Parameters:

execution_schedule_id (str) -- ID of the execution schedule to be retrieved
resource_group (str) -- Resource Group which the request should be sent on behalf. Either this or a default resource group in the ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client should be specified, defaults to None

Raises:

class:ai_api_client_sdk.exception.AIAPIInvalidRequestException if a 400 response is received from the server

Raises:

class:ai_api_client_sdk.exception.AIAPIAuthorizationException if a 401 response is received from the server

Raises:

class:ai_api_client_sdk.exception.AIAPINotFoundException if a 404 response is received from the server

Raises:

class:ai_api_client_sdk.exception.AIAPIServerException if a non-2XX response is received from the server

Returns:

The retrieved execution

Return type:

class:ai_api_client_sdk.models.execution.Execution

modify(execution_schedule_id, cron=None, start=None, end=None, configurationId=None, status=None, resource_group=None)

Modifies the execution schedule.

Parameters:

execution_schedule_id (str) -- ID of the execution to be modified
cron (str, optional) -- Cron defining the schedule to run the executions, defaults to None
configurationId (str, optional) -- ID of the configuration for the execution schedule, defaults to None
start (datetime, optional) -- Start time of the execution schedule in UTC, defaults to None
end (datetime, optional) -- End time of the execution schedule in UTC, defaults to None
status (class:ai_api_client_sdk.models.status.ScheduleStatus, optional) -- pause / resume Status of the execution schedule, defaults to None
resource_group (str) -- Resource Group which the request should be sent on behalf. Either this or a default resource group in the ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client should be specified, defaults to None

Raises:

class:ai_api_client_sdk.exception.AIAPIInvalidRequestException if a 400 response is received from the server

Raises:

class:ai_api_client_sdk.exception.AIAPIAuthorizationException if a 401 response is received from the server

Raises:

class:ai_api_client_sdk.exception.AIAPINotFoundException if a 404 response is received from the server

Raises:

class:ai_api_client_sdk.exception.AIAPIServerException if a non-2XX response is received from the server

Returns:

An object representing the response from the server

Return type:

class:ai_api_client_sdk.models.base_models.BasicResponse

query(configuration_id=None, status=None, top=None, skip=None, resource_group=None)

Queries the execution schedules.

Parameters:

configuration_id (str, optional) -- ID of the configuration, the executions should be configured by, defaults to None
status (class:ai_api_client_sdk.models.schedule_status.ScheduleStatus, optional) -- ScheduleStatus which the execution schedule should currently have
top (int, optional) -- Number of executions to be retrieved, defaults to None
skip (int, optional) -- Number of executions to be skipped, from the list of the queried executions, defaults to None
resource_group (str) -- Resource Group which the request should be sent on behalf. Either this or a default resource group in the ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client should be specified, defaults to None

Raises:

class:ai_api_client_sdk.exception.AIAPIInvalidRequestException if a 400 response is received from the server

Raises:

class:ai_api_client_sdk.exception.AIAPIAuthorizationException if a 401 response is received from the server

Raises:

class:ai_api_client_sdk.exception.AIAPIServerException if a non-2XX response is received from the server

Returns:

An object representing the response from the server

Return type:

class:ai_api_client_sdk.models.execution_query_response.ExecutionQueryResponse

ai_api_client_sdk.resource_clients.healthz_client module

class HealthzClient

Bases: BaseClient

HealthzClient is a class implemented for interacting with the healthz endpoint of the server. It implements the base class ai_api_client_sdk.resource_clients.base_client.BaseClient

get()

Retrieves the health status of the server.

Raises:: class:ai_api_client_sdk.exception.AIAPIServerException if a non-2XX response is received from the server
Returns:: The health status of the server
Return type:: class:ai_api_client_sdk.models.healthz_status.HealthzStatus

ai_api_client_sdk.resource_clients.meta_client module

class MetaClient

Bases: BaseClient

get()

Retrieves the relevant resource. Will be implemented by the respective resource clients

Return type:: Capabilities

get_versions()

Return type:: VersionList

ai_api_client_sdk.resource_clients.metrics_client module

class MetricsClient

Bases: BaseClient

MetricsClient is a class implemented for interacting with the metrics related endpoints of the server. It implements the base class ai_api_client_sdk.resource_clients.base_client.BaseClient

delete(execution_id, resource_group=None)

Deletes the metrics.

Parameters:

execution_id (str) -- ID of the execution, of which the metrics should be deleted.
resource_group (str) -- Resource Group which the request should be sent on behalf. Either this or a default resource group in the ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client should be specified, defaults to None

Raises:

class:ai_api_client_sdk.exception.AIAPIInvalidRequestException if a 400 response is received from the server

Raises:

class:ai_api_client_sdk.exception.AIAPIAuthorizationException if a 401 response is received from the server

Raises:

class:ai_api_client_sdk.exception.AIAPINotFoundException if a 404 response is received from the server

Raises:

class:ai_api_client_sdk.exception.AIAPIServerException if a non-2XX response is received from the server

Return type:

None

query(filter=None, execution_ids=None, select=None, resource_group=None)

Queries the metrics.

Parameters:

filter (str, optional) -- Deprecated. Use parameter execution_ids instead. A filter expression that filters the metric resources using execution IDs. User can only use in, eq operators in filter expression, defaults to None
execution_ids (List[str], optional) -- IDs of the executions, of which the metrics should be retrieved, defaults to None
select (List[str], optional) -- Values of select can be metrics,tags,customInfo or any of the combinations of these or *. Can be used to select(project) only the resources specified
resource_group (str) -- Resource Group which the request should be sent on behalf. Either this or a default resource group in the ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client should be specified, defaults to None

Raises:

class:ai_api_client_sdk.exception.AIAPIInvalidRequestException if a 400 response is received from the server

Raises:

class:ai_api_client_sdk.exception.AIAPIAuthorizationException if a 401 response is received from the server

Raises:

class:ai_api_client_sdk.exception.AIAPIServerException if a non-2XX response is received from the server

Returns:

An object representing the response from the server

Return type:

class:ai_api_client_sdk.models.metrics_query_response.MetricsQueryResponse

ai_api_client_sdk.resource_clients.model_client module

class ModelClient

Bases: BaseClient

ModelClient is a class implemented for interacting with model related endpoints of the server. It implements the base class ai_api_client_sdk.resource_clients.base_client.BaseClient

query(resource_group=None)

Queries the models.

Parameters:: resource_group (str) -- Resource Group which the request should be sent on behalf. Either this or a default resource group in the ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client should be specified, defaults to None
Raises:: class:ai_api_client_sdk.exception.AIAPIInvalidRequestException if a 400 response is received from the server
Raises:: class:ai_api_client_sdk.exception.AIAPIAuthorizationException if a 401 response is received from the server
Raises:: class:ai_api_client_sdk.exception.AIAPIServerException if a non-2XX response is received from the server
Returns:: An object representing the response from the server
Return type:: class:ai_api_client_sdk.models.executable_query_response.ModelQueryResponse

DEFAULT_SCENARIO_ID = 'foundation-models'

ai_api_client_sdk.resource_clients.resource_groups_client module

class ResourceGroupsClient

Bases: BaseClient

ResourceGroupsClient is a class implemented for interacting with the resource groups endpoints of the server. It implements the base class ai_api_client_sdk.resource_clients.base_client.BaseClient

create(resource_group_id, labels=None)

Creates resource group for a given tenant.

Parameters:

resource_group_id (str) -- the id of the resource group and the length must be between 3 and 10 characters.
labels (List[Label]) -- key-value pairs of the labels that will be added to the resource group.

Raises:

class:ai_api_client_sdk.exception.AIAPIInvalidRequestException if a 400 response is received from the server

Raises:

class:ai_api_client_sdk.exception.AIAPIAuthorizationException if a 401 response is received from the server

Raises:

class:ai_api_client_sdk.exception.AIAPIServerException if a non-2XX response is received from the server

Returns:

An object representing the response from the server

Return type:

class:ai_core_sdk.models.resource_group.ResourceGroup

delete(resource_group_id)

Deletes the resource group.

Parameters:: resource_group_id (str) -- the id of the resource group to be deleted
Raises:: class:ai_api_client_sdk.exception.AIAPIInvalidRequestException if a 400 response is received from the server
Raises:: class:ai_api_client_sdk.exception.AIAPIAuthorizationException if a 401 response is received from the server
Raises:: class:ai_api_client_sdk.exception.AIAPINotFoundException if a 404 response is received from the server
Raises:: class:ai_api_client_sdk.exception.AIAPIPreconditionFailedException if a 412 response is received from the server
Raises:: class:ai_api_client_sdk.exception.AIAPIServerException if a non-2XX response is received from the server
Returns:: An object representing the response from the server
Return type:: class:ai_api_client_sdk.models.base_models.BasicResponse

get(resource_group_id)

Gets a resource group of a given tenant.

Parameters:: resource_group_id (str) -- the id of the resource group to be retrieved
Raises:: class:ai_api_client_sdk.exception.AIAPIInvalidRequestException if a 400 response is received from the server
Raises:: class:ai_api_client_sdk.exception.AIAPIAuthorizationException if a 401 response is received from the server
Raises:: class:ai_api_client_sdk.exception.AIAPINotFoundException if a 404 response is received from the server
Raises:: class:ai_api_client_sdk.exception.AIAPIServerException if a non-2XX response is received from the server
Returns:: An object representing the resource group from the server
Return type:: class:ai_core_sdk.models.resource_group.ResourceGroup

modify(resource_group_id, labels)

Modifies a resource group.

Parameters:

resource_group_id (str) -- the id of the resource group
labels (List[Label]) -- key-value pairs of the labels that will be added to the resource group.

Raises:

class:ai_api_client_sdk.exception.AIAPIInvalidRequestException if a 400 response is received from the server

Raises:

class:ai_api_client_sdk.exception.AIAPIAuthorizationException if a 401 response is received from the server

Raises:

class:ai_api_client_sdk.exception.AIAPINotFoundException if a 404 response is received from the server

Raises:

class:ai_api_client_sdk.exception.AIAPIPreconditionFailedException if a 412 response is received from the server

Returns:

An object representing the response from the server

Return type:

None

query(search=None, search_case_insensitive=None)

Get all resource groups.

Parameters:

search (str, optional) -- Generic search term to be looked for in various attributes of resource groups, defaults to None
search_case_insensitive (bool, optional) -- Indicates whether the search should be case insensitive

Raises:

class:ai_api_client_sdk.exception.AIAPIInvalidRequestException if a 400 response is received from the server

Raises:

class:ai_api_client_sdk.exception.AIAPIAuthorizationException if a 401 response is received from the server

Raises:

class:ai_api_client_sdk.exception.AIAPIServerException if a non-2XX response is received from the server

Returns:

A list of resource groups for a given tenant.

Return type:

class:ai_core_sdk.models.resource_group_query_response.ResourceGroupQueryResponse

ai_api_client_sdk.resource_clients.scenario_client module

class ScenarioClient

Bases: BaseClient

ScenarioClient is a class implemented for interacting with the scenario related endpoints of the server. It implements the base class ai_api_client_sdk.resource_clients.base_client.BaseClient

get(scenario_id, resource_group=None)

Retrieves the scenario from the server.

Parameters:

scenario_id (str) -- ID of the scenario to be retrieved
resource_group (str) -- Resource Group which the request should be sent on behalf. Either this or a default resource group in the ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client should be specified, defaults to None

Raises:

class:ai_api_client_sdk.exception.AIAPIInvalidRequestException if a 400 response is received from the server

Raises:

class:ai_api_client_sdk.exception.AIAPIAuthorizationException if a 401 response is received from the server

Raises:

class:ai_api_client_sdk.exception.AIAPINotFoundException if a 404 response is received from the server

Raises:

class:ai_api_client_sdk.exception.AIAPIServerException if a non-2XX response is received from the server

Returns:

The retrieved scenario

Return type:

class:ai_api_client_sdk.models.scenario.Scenario

query(only_llm_scenarios=False, resource_group=None)

Queries the scenarios.

Parameters:

only_llm_scenarios (bool, optional) -- indicates whether to query for LLM scenarios only, defaults to False
resource_group (str) -- Resource Group which the request should be sent on behalf. Either this or a default resource group in the ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client should be specified, defaults to None

Raises:

class:ai_api_client_sdk.exception.AIAPIAuthorizationException if a 401 response is received from the server

Raises:

class:ai_api_client_sdk.exception.AIAPIServerException if a non-2XX response is received from the server

Returns:

An object representing the response from the server

Return type:

class:ai_api_client_sdk.models.scenario_query_response.ScenarioQueryResponse

query_llm_scenarios(resource_group=None)

Queries for the LLM scenarios.

Parameters:: resource_group (str) -- Resource Group which the request should be sent on behalf. Either this or a default resource group in the ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client should be specified, defaults to None
Raises:: class:ai_api_client_sdk.exception.AIAPIAuthorizationException if a 401 response is received from the server
Raises:: class:ai_api_client_sdk.exception.AIAPIServerException if a non-2XX response is received from the server
Raises:: class:ai_api_client_sdk.exception.AIAPIRequestException if an unexpected exception occurs while trying to send a request to the server
Returns:: An object representing the response from the server
Return type:: class:ai_api_client_sdk.models.scenario_query_response.ScenarioQueryResponse

query_versions(scenario_id, label_selector=None, resource_group=None)

Queries the versions.

Parameters:

scenario_id (str) -- ID of the scenario, the versions should belong to
label_selector (List[str], optional) -- list of the label selector strings in the form of "key=value" or "key!=value", to filter the scenarios with respect to their labels, defaults to None
resource_group (str) -- Resource Group which the request should be sent on behalf. Either this or a default resource group in the ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client should be specified, defaults to None

Raises:

class:ai_api_client_sdk.exception.AIAPIInvalidRequestException if a 400 response is received from the server

Raises:

class:ai_api_client_sdk.exception.AIAPIAuthorizationException if a 401 response is received from the server

Raises:

class:ai_api_client_sdk.exception.AIAPIServerException if a non-2XX response is received from the server

Returns:

An object representing the response from the server

Return type:

class:ai_api_client_sdk.models.scenario_query_response.ScenarioQueryResponse