From 758f90c7355fd504585d6ceb4ddaa097a9f13d57 Mon Sep 17 00:00:00 2001 From: Marika Marszalkowski Date: Wed, 12 Aug 2026 11:32:46 +0200 Subject: [PATCH 1/3] delete old files --- .../ai_api_client_sdk.ai_api_v2_client.html | 131 -- .../docs/ai_api_client_sdk.exception.html | 1068 ----------------- ..._api_client_sdk.helpers.authenticator.html | 110 -- .../ai_api_client_sdk.helpers.constants.html | 95 -- ...pi_client_sdk.helpers.datetime_parser.html | 30 - .../base/docs/ai_api_client_sdk.helpers.html | 26 - .../ai_api_client_sdk.helpers.llm_helper.html | 32 - .../ai_api_client_sdk.helpers.logging.html | 39 - ...ai_api_client_sdk.helpers.rest_client.html | 247 ---- packages/base/docs/ai_api_client_sdk.html | 25 - ...client_sdk.models.ai_api_capabilities.html | 117 -- ...dels.ai_api_capabilities_bulk_updates.html | 83 -- ...t_sdk.models.ai_api_capabilities_logs.html | 83 -- ...i_api_client_sdk.models.ai_api_limits.html | 88 -- ..._sdk.models.ai_api_limits_deployments.html | 85 -- ...t_sdk.models.ai_api_limits_enactments.html | 62 - ...t_sdk.models.ai_api_limits_executions.html | 85 -- .../ai_api_client_sdk.models.ai_api_meta.html | 92 -- .../ai_api_client_sdk.models.api_version.html | 92 -- .../ai_api_client_sdk.models.artifact.html | 131 -- ...t_sdk.models.artifact_create_response.html | 82 -- ...nt_sdk.models.artifact_query_response.html | 90 -- .../ai_api_client_sdk.models.base_models.html | 488 -------- ...ai_api_client_sdk.models.capabilities.html | 94 -- ...i_api_client_sdk.models.configuration.html | 108 -- ....models.configuration_create_response.html | 74 -- ...k.models.configuration_query_response.html | 90 -- ...lient_sdk.models.dataset_capabilities.html | 92 -- ..._api_client_sdk.models.dataset_limits.html | 88 -- .../ai_api_client_sdk.models.deployment.html | 160 --- ...odels.deployment_bulk_modify_response.html | 78 -- ...sdk.models.deployment_create_response.html | 101 -- ...models.deployment_get_status_response.html | 101 -- ..._sdk.models.deployment_query_response.html | 90 -- .../ai_api_client_sdk.models.enactment.html | 116 -- ....models.enactment_get_status_response.html | 84 -- .../ai_api_client_sdk.models.executable.html | 128 -- ..._sdk.models.executable_query_response.html | 90 -- .../ai_api_client_sdk.models.execution.html | 141 --- ...models.execution_bulk_modify_response.html | 78 -- ..._sdk.models.execution_create_response.html | 93 -- ....models.execution_get_status_response.html | 99 -- ...t_sdk.models.execution_query_response.html | 90 -- ..._client_sdk.models.execution_schedule.html | 110 -- ...ls.execution_schedule_create_response.html | 74 -- ...els.execution_schedule_query_response.html | 90 -- .../ai_api_client_sdk.models.extensions.html | 93 -- ...lient_sdk.models.extensions_analytics.html | 77 -- ..._client_sdk.models.extensions_dataset.html | 92 -- ...sdk.models.extensions_resource_groups.html | 77 -- ..._api_client_sdk.models.healthz_status.html | 139 --- .../base/docs/ai_api_client_sdk.models.html | 88 -- ..._api_client_sdk.models.input_artifact.html | 93 -- ...ent_sdk.models.input_artifact_binding.html | 82 -- .../docs/ai_api_client_sdk.models.label.html | 84 -- ...ai_api_client_sdk.models.log_response.html | 157 --- .../docs/ai_api_client_sdk.models.metric.html | 107 -- ..._client_sdk.models.metric_custom_info.html | 81 -- ...ai_api_client_sdk.models.metric_label.html | 87 -- ...api_client_sdk.models.metric_resource.html | 91 -- .../ai_api_client_sdk.models.metric_tag.html | 82 -- ...ent_sdk.models.metrics_query_response.html | 90 -- .../docs/ai_api_client_sdk.models.model.html | 105 -- ...els.model_base_data_allowed_scenarios.html | 62 - ...lient_sdk.models.model_query_response.html | 90 -- ...i_api_client_sdk.models.model_version.html | 127 -- ...api_client_sdk.models.output_artifact.html | 93 -- .../ai_api_client_sdk.models.parameter.html | 98 -- ...i_client_sdk.models.parameter_binding.html | 84 -- ..._api_client_sdk.models.resource_group.html | 92 -- ....models.resource_group_query_response.html | 91 -- ...ient_sdk.models.resource_group_status.html | 82 -- .../ai_api_client_sdk.models.scenario.html | 109 -- ...nt_sdk.models.scenario_query_response.html | 90 -- .../docs/ai_api_client_sdk.models.status.html | 143 --- ...i_api_client_sdk.models.target_status.html | 84 -- .../ai_api_client_sdk.models.version.html | 93 -- ...ai_api_client_sdk.models.version_list.html | 77 -- ...ent_sdk.models.version_query_response.html | 90 -- ..._sdk.resource_clients.artifact_client.html | 212 ---- ...ient_sdk.resource_clients.base_client.html | 75 -- ...resource_clients.configuration_client.html | 197 --- ...dk.resource_clients.deployment_client.html | 280 ----- ...dk.resource_clients.executable_client.html | 115 -- ...sdk.resource_clients.execution_client.html | 282 ----- ...rce_clients.execution_schedule_client.html | 235 ---- ...t_sdk.resource_clients.healthz_client.html | 79 -- .../ai_api_client_sdk.resource_clients.html | 33 - ...ient_sdk.resource_clients.meta_client.html | 75 -- ...t_sdk.resource_clients.metrics_client.html | 129 -- ...ent_sdk.resource_clients.model_client.html | 91 -- ...source_clients.resource_groups_client.html | 159 --- ..._sdk.resource_clients.scenario_client.html | 150 --- .../docs/ai_core_sdk.ai_core_v2_client.html | 150 --- packages/core/docs/ai_core_sdk.cli.html | 64 - .../core/docs/ai_core_sdk.credentials.html | 262 ---- packages/core/docs/ai_core_sdk.exception.html | 156 --- .../docs/ai_core_sdk.helpers.constants.html | 101 -- packages/core/docs/ai_core_sdk.helpers.html | 49 - .../docs/ai_core_sdk.helpers.logging.html | 38 - packages/core/docs/ai_core_sdk.html | 28 - .../docs/ai_core_sdk.models.application.html | 89 -- ...sdk.models.application_query_response.html | 91 -- ...dels.application_resource_sync_status.html | 87 -- ...ai_core_sdk.models.application_source.html | 85 -- ...ai_core_sdk.models.application_status.html | 107 -- .../docs/ai_core_sdk.models.base_models.html | 116 -- ...ore_sdk.models.docker_registry_secret.html | 82 -- ...docker_registry_secret_query_response.html | 91 -- packages/core/docs/ai_core_sdk.models.html | 39 - .../core/docs/ai_core_sdk.models.kpi.html | 69 -- ...i_core_sdk.models.object_store_secret.html | 67 -- ...ls.object_store_secret_query_response.html | 91 -- .../docs/ai_core_sdk.models.repository.html | 85 -- ..._sdk.models.repository_query_response.html | 91 -- .../ai_core_sdk.models.repository_status.html | 82 -- .../ai_core_sdk.models.resource_group.html | 98 -- ....models.resource_group_query_response.html | 91 -- ...core_sdk.models.resource_group_status.html | 82 -- .../core/docs/ai_core_sdk.models.secret.html | 72 -- ...core_sdk.models.secret_query_response.html | 91 -- ....resource_clients.applications_client.html | 199 --- ...lients.docker_registry_secrets_client.html | 147 --- .../docs/ai_core_sdk.resource_clients.html | 28 - ...resource_clients.internal_rest_client.html | 220 ---- ..._core_sdk.resource_clients.kpi_client.html | 85 -- ...e_sdk.resource_clients.metrics_client.html | 215 ---- ...e_clients.object_store_secrets_client.html | 229 ---- ....resource_clients.repositories_client.html | 148 --- ...e_sdk.resource_clients.secrets_client.html | 181 --- packages/core/docs/ai_core_sdk.tracking.html | 21 - .../docs/ai_core_sdk.tracking.tracking.html | 272 ----- 132 files changed, 15191 deletions(-) delete mode 100644 packages/base/docs/ai_api_client_sdk.ai_api_v2_client.html delete mode 100644 packages/base/docs/ai_api_client_sdk.exception.html delete mode 100644 packages/base/docs/ai_api_client_sdk.helpers.authenticator.html delete mode 100644 packages/base/docs/ai_api_client_sdk.helpers.constants.html delete mode 100644 packages/base/docs/ai_api_client_sdk.helpers.datetime_parser.html delete mode 100644 packages/base/docs/ai_api_client_sdk.helpers.html delete mode 100644 packages/base/docs/ai_api_client_sdk.helpers.llm_helper.html delete mode 100644 packages/base/docs/ai_api_client_sdk.helpers.logging.html delete mode 100644 packages/base/docs/ai_api_client_sdk.helpers.rest_client.html delete mode 100644 packages/base/docs/ai_api_client_sdk.html delete mode 100644 packages/base/docs/ai_api_client_sdk.models.ai_api_capabilities.html delete mode 100644 packages/base/docs/ai_api_client_sdk.models.ai_api_capabilities_bulk_updates.html delete mode 100644 packages/base/docs/ai_api_client_sdk.models.ai_api_capabilities_logs.html delete mode 100644 packages/base/docs/ai_api_client_sdk.models.ai_api_limits.html delete mode 100644 packages/base/docs/ai_api_client_sdk.models.ai_api_limits_deployments.html delete mode 100644 packages/base/docs/ai_api_client_sdk.models.ai_api_limits_enactments.html delete mode 100644 packages/base/docs/ai_api_client_sdk.models.ai_api_limits_executions.html delete mode 100644 packages/base/docs/ai_api_client_sdk.models.ai_api_meta.html delete mode 100644 packages/base/docs/ai_api_client_sdk.models.api_version.html delete mode 100644 packages/base/docs/ai_api_client_sdk.models.artifact.html delete mode 100644 packages/base/docs/ai_api_client_sdk.models.artifact_create_response.html delete mode 100644 packages/base/docs/ai_api_client_sdk.models.artifact_query_response.html delete mode 100644 packages/base/docs/ai_api_client_sdk.models.base_models.html delete mode 100644 packages/base/docs/ai_api_client_sdk.models.capabilities.html delete mode 100644 packages/base/docs/ai_api_client_sdk.models.configuration.html delete mode 100644 packages/base/docs/ai_api_client_sdk.models.configuration_create_response.html delete mode 100644 packages/base/docs/ai_api_client_sdk.models.configuration_query_response.html delete mode 100644 packages/base/docs/ai_api_client_sdk.models.dataset_capabilities.html delete mode 100644 packages/base/docs/ai_api_client_sdk.models.dataset_limits.html delete mode 100644 packages/base/docs/ai_api_client_sdk.models.deployment.html delete mode 100644 packages/base/docs/ai_api_client_sdk.models.deployment_bulk_modify_response.html delete mode 100644 packages/base/docs/ai_api_client_sdk.models.deployment_create_response.html delete mode 100644 packages/base/docs/ai_api_client_sdk.models.deployment_get_status_response.html delete mode 100644 packages/base/docs/ai_api_client_sdk.models.deployment_query_response.html delete mode 100644 packages/base/docs/ai_api_client_sdk.models.enactment.html delete mode 100644 packages/base/docs/ai_api_client_sdk.models.enactment_get_status_response.html delete mode 100644 packages/base/docs/ai_api_client_sdk.models.executable.html delete mode 100644 packages/base/docs/ai_api_client_sdk.models.executable_query_response.html delete mode 100644 packages/base/docs/ai_api_client_sdk.models.execution.html delete mode 100644 packages/base/docs/ai_api_client_sdk.models.execution_bulk_modify_response.html delete mode 100644 packages/base/docs/ai_api_client_sdk.models.execution_create_response.html delete mode 100644 packages/base/docs/ai_api_client_sdk.models.execution_get_status_response.html delete mode 100644 packages/base/docs/ai_api_client_sdk.models.execution_query_response.html delete mode 100644 packages/base/docs/ai_api_client_sdk.models.execution_schedule.html delete mode 100644 packages/base/docs/ai_api_client_sdk.models.execution_schedule_create_response.html delete mode 100644 packages/base/docs/ai_api_client_sdk.models.execution_schedule_query_response.html delete mode 100644 packages/base/docs/ai_api_client_sdk.models.extensions.html delete mode 100644 packages/base/docs/ai_api_client_sdk.models.extensions_analytics.html delete mode 100644 packages/base/docs/ai_api_client_sdk.models.extensions_dataset.html delete mode 100644 packages/base/docs/ai_api_client_sdk.models.extensions_resource_groups.html delete mode 100644 packages/base/docs/ai_api_client_sdk.models.healthz_status.html delete mode 100644 packages/base/docs/ai_api_client_sdk.models.html delete mode 100644 packages/base/docs/ai_api_client_sdk.models.input_artifact.html delete mode 100644 packages/base/docs/ai_api_client_sdk.models.input_artifact_binding.html delete mode 100644 packages/base/docs/ai_api_client_sdk.models.label.html delete mode 100644 packages/base/docs/ai_api_client_sdk.models.log_response.html delete mode 100644 packages/base/docs/ai_api_client_sdk.models.metric.html delete mode 100644 packages/base/docs/ai_api_client_sdk.models.metric_custom_info.html delete mode 100644 packages/base/docs/ai_api_client_sdk.models.metric_label.html delete mode 100644 packages/base/docs/ai_api_client_sdk.models.metric_resource.html delete mode 100644 packages/base/docs/ai_api_client_sdk.models.metric_tag.html delete mode 100644 packages/base/docs/ai_api_client_sdk.models.metrics_query_response.html delete mode 100644 packages/base/docs/ai_api_client_sdk.models.model.html delete mode 100644 packages/base/docs/ai_api_client_sdk.models.model_base_data_allowed_scenarios.html delete mode 100644 packages/base/docs/ai_api_client_sdk.models.model_query_response.html delete mode 100644 packages/base/docs/ai_api_client_sdk.models.model_version.html delete mode 100644 packages/base/docs/ai_api_client_sdk.models.output_artifact.html delete mode 100644 packages/base/docs/ai_api_client_sdk.models.parameter.html delete mode 100644 packages/base/docs/ai_api_client_sdk.models.parameter_binding.html delete mode 100644 packages/base/docs/ai_api_client_sdk.models.resource_group.html delete mode 100644 packages/base/docs/ai_api_client_sdk.models.resource_group_query_response.html delete mode 100644 packages/base/docs/ai_api_client_sdk.models.resource_group_status.html delete mode 100644 packages/base/docs/ai_api_client_sdk.models.scenario.html delete mode 100644 packages/base/docs/ai_api_client_sdk.models.scenario_query_response.html delete mode 100644 packages/base/docs/ai_api_client_sdk.models.status.html delete mode 100644 packages/base/docs/ai_api_client_sdk.models.target_status.html delete mode 100644 packages/base/docs/ai_api_client_sdk.models.version.html delete mode 100644 packages/base/docs/ai_api_client_sdk.models.version_list.html delete mode 100644 packages/base/docs/ai_api_client_sdk.models.version_query_response.html delete mode 100644 packages/base/docs/ai_api_client_sdk.resource_clients.artifact_client.html delete mode 100644 packages/base/docs/ai_api_client_sdk.resource_clients.base_client.html delete mode 100644 packages/base/docs/ai_api_client_sdk.resource_clients.configuration_client.html delete mode 100644 packages/base/docs/ai_api_client_sdk.resource_clients.deployment_client.html delete mode 100644 packages/base/docs/ai_api_client_sdk.resource_clients.executable_client.html delete mode 100644 packages/base/docs/ai_api_client_sdk.resource_clients.execution_client.html delete mode 100644 packages/base/docs/ai_api_client_sdk.resource_clients.execution_schedule_client.html delete mode 100644 packages/base/docs/ai_api_client_sdk.resource_clients.healthz_client.html delete mode 100644 packages/base/docs/ai_api_client_sdk.resource_clients.html delete mode 100644 packages/base/docs/ai_api_client_sdk.resource_clients.meta_client.html delete mode 100644 packages/base/docs/ai_api_client_sdk.resource_clients.metrics_client.html delete mode 100644 packages/base/docs/ai_api_client_sdk.resource_clients.model_client.html delete mode 100644 packages/base/docs/ai_api_client_sdk.resource_clients.resource_groups_client.html delete mode 100644 packages/base/docs/ai_api_client_sdk.resource_clients.scenario_client.html delete mode 100644 packages/core/docs/ai_core_sdk.ai_core_v2_client.html delete mode 100644 packages/core/docs/ai_core_sdk.cli.html delete mode 100644 packages/core/docs/ai_core_sdk.credentials.html delete mode 100644 packages/core/docs/ai_core_sdk.exception.html delete mode 100644 packages/core/docs/ai_core_sdk.helpers.constants.html delete mode 100644 packages/core/docs/ai_core_sdk.helpers.html delete mode 100644 packages/core/docs/ai_core_sdk.helpers.logging.html delete mode 100644 packages/core/docs/ai_core_sdk.html delete mode 100644 packages/core/docs/ai_core_sdk.models.application.html delete mode 100644 packages/core/docs/ai_core_sdk.models.application_query_response.html delete mode 100644 packages/core/docs/ai_core_sdk.models.application_resource_sync_status.html delete mode 100644 packages/core/docs/ai_core_sdk.models.application_source.html delete mode 100644 packages/core/docs/ai_core_sdk.models.application_status.html delete mode 100644 packages/core/docs/ai_core_sdk.models.base_models.html delete mode 100644 packages/core/docs/ai_core_sdk.models.docker_registry_secret.html delete mode 100644 packages/core/docs/ai_core_sdk.models.docker_registry_secret_query_response.html delete mode 100644 packages/core/docs/ai_core_sdk.models.html delete mode 100644 packages/core/docs/ai_core_sdk.models.kpi.html delete mode 100644 packages/core/docs/ai_core_sdk.models.object_store_secret.html delete mode 100644 packages/core/docs/ai_core_sdk.models.object_store_secret_query_response.html delete mode 100644 packages/core/docs/ai_core_sdk.models.repository.html delete mode 100644 packages/core/docs/ai_core_sdk.models.repository_query_response.html delete mode 100644 packages/core/docs/ai_core_sdk.models.repository_status.html delete mode 100644 packages/core/docs/ai_core_sdk.models.resource_group.html delete mode 100644 packages/core/docs/ai_core_sdk.models.resource_group_query_response.html delete mode 100644 packages/core/docs/ai_core_sdk.models.resource_group_status.html delete mode 100644 packages/core/docs/ai_core_sdk.models.secret.html delete mode 100644 packages/core/docs/ai_core_sdk.models.secret_query_response.html delete mode 100644 packages/core/docs/ai_core_sdk.resource_clients.applications_client.html delete mode 100644 packages/core/docs/ai_core_sdk.resource_clients.docker_registry_secrets_client.html delete mode 100644 packages/core/docs/ai_core_sdk.resource_clients.html delete mode 100644 packages/core/docs/ai_core_sdk.resource_clients.internal_rest_client.html delete mode 100644 packages/core/docs/ai_core_sdk.resource_clients.kpi_client.html delete mode 100644 packages/core/docs/ai_core_sdk.resource_clients.metrics_client.html delete mode 100644 packages/core/docs/ai_core_sdk.resource_clients.object_store_secrets_client.html delete mode 100644 packages/core/docs/ai_core_sdk.resource_clients.repositories_client.html delete mode 100644 packages/core/docs/ai_core_sdk.resource_clients.secrets_client.html delete mode 100644 packages/core/docs/ai_core_sdk.tracking.html delete mode 100644 packages/core/docs/ai_core_sdk.tracking.tracking.html diff --git a/packages/base/docs/ai_api_client_sdk.ai_api_v2_client.html b/packages/base/docs/ai_api_client_sdk.ai_api_v2_client.html deleted file mode 100644 index f316ffd..0000000 --- a/packages/base/docs/ai_api_client_sdk.ai_api_v2_client.html +++ /dev/null @@ -1,131 +0,0 @@ - - - - -Python: module ai_api_client_sdk.ai_api_v2_client - - - - - -
 
ai_api_client_sdk.ai_api_v2_client		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/ai_api_v2_client.py
-

-

- - - - - -
 
Modules
       
os
-

- - - - - -
 
Classes
       
-
builtins.object -
-
-
AIAPIV2Client -
-
-
-

- - - - - - - -
 
class AIAPIV2Client(builtins.object)
   AIAPIV2Client(
-    base_url: str,
-    auth_url: str = None,
-    client_id: str = None,
-    client_secret: str = None,
-    cert_str: str = None,
-    key_str: str = None,
-    cert_file_path: str = None,
-    key_file_path: str = None,
-    token_creator: Callable[[], str] = None,
-    resource_group: str = None,
-    connect_timeout=60,
-    num_request_retries=3,
-    **kwargs
-)
- 
-The AIAPIV2Client is the class implemented to interact with the AI API server. The user can use its attributes
-corresponding to the resources, for interacting with endpoints related to that resource. (i.e.,
-aiapiv2client.scenario)
- 
-:param base_url: Base URL of the AI API server. Should include the base path as well. (i.e., "<base_url>/scenarios"
-    should work)
-:type base_url: str
-:param auth_url: URL of the authorization endpoint. Should be the full URL (including /oauth/token), defaults to
-    None
-:type auth_url: str, optional
-:param client_id: client id to be used for authorization, defaults to None
-:type client_id: str, optional
-:param client_secret: client secret to be used for authorization, defaults to None
-:type client_secret: str, optional
-:param cert_str: certificate file content, needs to be provided alongside the key_str parameter, defaults to None
-:type cert_str: str, optional
-:param key_str: key file content, needs to be provided alongside the cert_str parameter, defaults to None
-:type key_str: str, optional
-:param cert_file_path: path to the certificate file, needs to be provided alongside the key_file_path parameter,
-    defaults to None
-:type cert_file_path: str, optional
-:param key_file_path: path to the key file, needs to be provided alongside the cert_file_path parameter,
-    defaults to None
-:type key_file_path: str, optional
-:param token_creator: the function which returns the Bearer token, when called. Either this, or
-    auth_url & client_id & client_secret should be specified, defaults to None
-:type token_creator: Callable[[], str], optional
-:param resource_group: The default resource group which will be used while sending the requests to the server. If
-    not set, the resource_group should be specified with every request to the server, defaults to None
-:type resource_group: str, optional
-:param read_timeout: Read timeout for requests in seconds, defaults to 60s
-:type read_timeout: int
-:param connect_timeout: Connect timeout for requests in seconds, defaults to 60s
-:type connect_timeout: int
-:param num_request_retries: Number of retries for failing requests with http status code 429, 500, 502, 503 or 504,
-    defaults to 60s
-:type num_request_retries: int
-:param client_type: Client type header to be sent in the request, defaults to 'AI API Python SDK'
-:type client_type: str
 
 Methods defined here:
-
__init__( - self, - base_url: str, - auth_url: str = None, - client_id: str = None, - client_secret: str = None, - cert_str: str = None, - key_str: str = None, - cert_file_path: str = None, - key_file_path: str = None, - token_creator: Callable[[], str] = None, - resource_group: str = None, - connect_timeout=60, - num_request_retries=3, - **kwargs -)
Initialize self.  See help(type(self)) for accurate signature.
- -
-Data descriptors defined here:
-
__dict__
-
dictionary for instance variables
-
-
__weakref__
-
list of weak references to the object
-
-

- - - - - -
 
Data
       AUTH_PARAM_ERROR_MESSAGE = '\nFor authorization please provide either one of ... & key_str\n c. cert_file_path & key_file_path\n'
-Callable = typing.Callable
-SKIP_AUTH_ENV_VAR = 'SKIP_AUTHORIZATION'
- \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.exception.html b/packages/base/docs/ai_api_client_sdk.exception.html deleted file mode 100644 index 67d8d47..0000000 --- a/packages/base/docs/ai_api_client_sdk.exception.html +++ /dev/null @@ -1,1068 +0,0 @@ - - - - -Python: module ai_api_client_sdk.exception - - - - - -
 
ai_api_client_sdk.exception		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/exception.py
-

-

- - - - - -
 
Classes
       
-
builtins.Exception(builtins.BaseException) -
-
-
AIAPIClientSDKException -
-
-
AIAPIAuthenticatorException -
-
-
AIAPIAuthenticatorAuthorizationException -
AIAPIAuthenticatorForbiddenException -
AIAPIAuthenticatorInvalidRequestException -
AIAPIAuthenticatorMethodNotAllowedException -
AIAPIAuthenticatorServerException -
AIAPIAuthenticatorTimeoutException -
-
-
AIAPIInvalidInputException -
-
-
AIAPIServerException -
-
-
AIAPIAuthorizationException -
AIAPIInvalidRequestException -
AIAPINotFoundException -
AIAPIPreconditionFailedException -
-
-
-
-
-

- - - - - - - -
 
class AIAPIAuthenticatorAuthorizationException(AIAPIAuthenticatorException)
   AIAPIAuthenticatorAuthorizationException(error_message: str = None)
- 
-Exception type that is raised by the :class:`ai_api_client_sdk.helpers.authenticator.Authenticator` if
-the XSUAA server responded with unauthorized when trying to retrieve a token
 
 
Method resolution order:
-
AIAPIAuthenticatorAuthorizationException
-
AIAPIAuthenticatorException
-
AIAPIClientSDKException
-
builtins.Exception
-
builtins.BaseException
-
builtins.object
-
-
-Methods defined here:
-
__init__(self, error_message: str = None)
Initialize self.  See help(type(self)) for accurate signature.
- -
-Data descriptors inherited from AIAPIClientSDKException:
-
__weakref__
-
list of weak references to the object
-
-
-Static methods inherited from builtins.Exception:
-
__new__(*args, **kwargs) class method of builtins.Exception
Create and return a new object.  See help(type) for accurate signature.
- -
-Methods inherited from builtins.BaseException:
-
__getattribute__(self, name, /)
Return getattr(self, name).
- -
__reduce__(self, /)
Helper for pickle.
- -
__repr__(self, /)
Return repr(self).
- -
__setstate__(self, object, /)
- -
__str__(self, /)
Return str(self).
- -
add_note(self, object, /)
Exception.add_note(note) --
-add a note to the exception
- -
with_traceback(self, object, /)
Exception.with_traceback(tb) --
-set self.__traceback__ to tb and return self.
- -
-Data descriptors inherited from builtins.BaseException:
-
__cause__
-
exception cause
-
-
__context__
-
exception context
-
-
__dict__
-
-
__suppress_context__
-
-
__traceback__
-
-
args
-
-

- - - - - - - -
 
class AIAPIAuthenticatorException(AIAPIClientSDKException)
   AIAPIAuthenticatorException(status_code: int = None, error_message: str = None)
- 
-Exception type that is raised by the :class:`ai_api_client_sdk.helpers.authenticator.Authenticator`
 
 
Method resolution order:
-
AIAPIAuthenticatorException
-
AIAPIClientSDKException
-
builtins.Exception
-
builtins.BaseException
-
builtins.object
-
-
-Methods defined here:
-
__init__(self, status_code: int = None, error_message: str = None)
Initialize self.  See help(type(self)) for accurate signature.
- -
-Data descriptors inherited from AIAPIClientSDKException:
-
__weakref__
-
list of weak references to the object
-
-
-Static methods inherited from builtins.Exception:
-
__new__(*args, **kwargs) class method of builtins.Exception
Create and return a new object.  See help(type) for accurate signature.
- -
-Methods inherited from builtins.BaseException:
-
__getattribute__(self, name, /)
Return getattr(self, name).
- -
__reduce__(self, /)
Helper for pickle.
- -
__repr__(self, /)
Return repr(self).
- -
__setstate__(self, object, /)
- -
__str__(self, /)
Return str(self).
- -
add_note(self, object, /)
Exception.add_note(note) --
-add a note to the exception
- -
with_traceback(self, object, /)
Exception.with_traceback(tb) --
-set self.__traceback__ to tb and return self.
- -
-Data descriptors inherited from builtins.BaseException:
-
__cause__
-
exception cause
-
-
__context__
-
exception context
-
-
__dict__
-
-
__suppress_context__
-
-
__traceback__
-
-
args
-
-

- - - - - - - -
 
class AIAPIAuthenticatorForbiddenException(AIAPIAuthenticatorException)
   AIAPIAuthenticatorForbiddenException(error_message: str = None)
- 
-Exception type that is raised by the :class:`ai_api_client_sdk.helpers.authenticator.Authenticator` if
-the XSUAA server responded with forbidden when trying to retrieve a token
 
 
Method resolution order:
-
AIAPIAuthenticatorForbiddenException
-
AIAPIAuthenticatorException
-
AIAPIClientSDKException
-
builtins.Exception
-
builtins.BaseException
-
builtins.object
-
-
-Methods defined here:
-
__init__(self, error_message: str = None)
Initialize self.  See help(type(self)) for accurate signature.
- -
-Data descriptors inherited from AIAPIClientSDKException:
-
__weakref__
-
list of weak references to the object
-
-
-Static methods inherited from builtins.Exception:
-
__new__(*args, **kwargs) class method of builtins.Exception
Create and return a new object.  See help(type) for accurate signature.
- -
-Methods inherited from builtins.BaseException:
-
__getattribute__(self, name, /)
Return getattr(self, name).
- -
__reduce__(self, /)
Helper for pickle.
- -
__repr__(self, /)
Return repr(self).
- -
__setstate__(self, object, /)
- -
__str__(self, /)
Return str(self).
- -
add_note(self, object, /)
Exception.add_note(note) --
-add a note to the exception
- -
with_traceback(self, object, /)
Exception.with_traceback(tb) --
-set self.__traceback__ to tb and return self.
- -
-Data descriptors inherited from builtins.BaseException:
-
__cause__
-
exception cause
-
-
__context__
-
exception context
-
-
__dict__
-
-
__suppress_context__
-
-
__traceback__
-
-
args
-
-

- - - - - - - -
 
class AIAPIAuthenticatorInvalidRequestException(AIAPIAuthenticatorException)
   AIAPIAuthenticatorInvalidRequestException(error_message: str = None)
- 
-Exception type that is raised by the :class:`ai_api_client_sdk.helpers.authenticator.Authenticator` if
-the XSUAA server responded with bad request when trying to retrieve a token
 
 
Method resolution order:
-
AIAPIAuthenticatorInvalidRequestException
-
AIAPIAuthenticatorException
-
AIAPIClientSDKException
-
builtins.Exception
-
builtins.BaseException
-
builtins.object
-
-
-Methods defined here:
-
__init__(self, error_message: str = None)
Initialize self.  See help(type(self)) for accurate signature.
- -
-Data descriptors inherited from AIAPIClientSDKException:
-
__weakref__
-
list of weak references to the object
-
-
-Static methods inherited from builtins.Exception:
-
__new__(*args, **kwargs) class method of builtins.Exception
Create and return a new object.  See help(type) for accurate signature.
- -
-Methods inherited from builtins.BaseException:
-
__getattribute__(self, name, /)
Return getattr(self, name).
- -
__reduce__(self, /)
Helper for pickle.
- -
__repr__(self, /)
Return repr(self).
- -
__setstate__(self, object, /)
- -
__str__(self, /)
Return str(self).
- -
add_note(self, object, /)
Exception.add_note(note) --
-add a note to the exception
- -
with_traceback(self, object, /)
Exception.with_traceback(tb) --
-set self.__traceback__ to tb and return self.
- -
-Data descriptors inherited from builtins.BaseException:
-
__cause__
-
exception cause
-
-
__context__
-
exception context
-
-
__dict__
-
-
__suppress_context__
-
-
__traceback__
-
-
args
-
-

- - - - - - - -
 
class AIAPIAuthenticatorMethodNotAllowedException(AIAPIAuthenticatorException)
   AIAPIAuthenticatorMethodNotAllowedException(error_message: str = None)
- 
-Exception type that is raised by the :class:`ai_api_client_sdk.helpers.authenticator.Authenticator` if
-the XSUAA server responded with method not allowed when trying to retrieve a token
 
 
Method resolution order:
-
AIAPIAuthenticatorMethodNotAllowedException
-
AIAPIAuthenticatorException
-
AIAPIClientSDKException
-
builtins.Exception
-
builtins.BaseException
-
builtins.object
-
-
-Methods defined here:
-
__init__(self, error_message: str = None)
Initialize self.  See help(type(self)) for accurate signature.
- -
-Data descriptors inherited from AIAPIClientSDKException:
-
__weakref__
-
list of weak references to the object
-
-
-Static methods inherited from builtins.Exception:
-
__new__(*args, **kwargs) class method of builtins.Exception
Create and return a new object.  See help(type) for accurate signature.
- -
-Methods inherited from builtins.BaseException:
-
__getattribute__(self, name, /)
Return getattr(self, name).
- -
__reduce__(self, /)
Helper for pickle.
- -
__repr__(self, /)
Return repr(self).
- -
__setstate__(self, object, /)
- -
__str__(self, /)
Return str(self).
- -
add_note(self, object, /)
Exception.add_note(note) --
-add a note to the exception
- -
with_traceback(self, object, /)
Exception.with_traceback(tb) --
-set self.__traceback__ to tb and return self.
- -
-Data descriptors inherited from builtins.BaseException:
-
__cause__
-
exception cause
-
-
__context__
-
exception context
-
-
__dict__
-
-
__suppress_context__
-
-
__traceback__
-
-
args
-
-

- - - - - - - -
 
class AIAPIAuthenticatorServerException(AIAPIAuthenticatorException)
   AIAPIAuthenticatorServerException(
-    status_code: int = None,
-    error_message: str = None
-)
- 
-Exception type that is raised by the :class:`ai_api_client_sdk.helpers.authenticator.Authenticator` if
-the XSUAA server responded with server error when trying to retrieve a token
 
 
Method resolution order:
-
AIAPIAuthenticatorServerException
-
AIAPIAuthenticatorException
-
AIAPIClientSDKException
-
builtins.Exception
-
builtins.BaseException
-
builtins.object
-
-
-Methods defined here:
-
__init__(self, status_code: int = None, error_message: str = None)
Initialize self.  See help(type(self)) for accurate signature.
- -
-Data descriptors inherited from AIAPIClientSDKException:
-
__weakref__
-
list of weak references to the object
-
-
-Static methods inherited from builtins.Exception:
-
__new__(*args, **kwargs) class method of builtins.Exception
Create and return a new object.  See help(type) for accurate signature.
- -
-Methods inherited from builtins.BaseException:
-
__getattribute__(self, name, /)
Return getattr(self, name).
- -
__reduce__(self, /)
Helper for pickle.
- -
__repr__(self, /)
Return repr(self).
- -
__setstate__(self, object, /)
- -
__str__(self, /)
Return str(self).
- -
add_note(self, object, /)
Exception.add_note(note) --
-add a note to the exception
- -
with_traceback(self, object, /)
Exception.with_traceback(tb) --
-set self.__traceback__ to tb and return self.
- -
-Data descriptors inherited from builtins.BaseException:
-
__cause__
-
exception cause
-
-
__context__
-
exception context
-
-
__dict__
-
-
__suppress_context__
-
-
__traceback__
-
-
args
-
-

- - - - - - - -
 
class AIAPIAuthenticatorTimeoutException(AIAPIAuthenticatorException)
   AIAPIAuthenticatorTimeoutException(error_message: str = None)
- 
-Exception type that is raised by the :class:`ai_api_client_sdk.helpers.authenticator.Authenticator` if
-the XSUAA server responded with request timeout when trying to retrieve a token
 
 
Method resolution order:
-
AIAPIAuthenticatorTimeoutException
-
AIAPIAuthenticatorException
-
AIAPIClientSDKException
-
builtins.Exception
-
builtins.BaseException
-
builtins.object
-
-
-Methods defined here:
-
__init__(self, error_message: str = None)
Initialize self.  See help(type(self)) for accurate signature.
- -
-Data descriptors inherited from AIAPIClientSDKException:
-
__weakref__
-
list of weak references to the object
-
-
-Static methods inherited from builtins.Exception:
-
__new__(*args, **kwargs) class method of builtins.Exception
Create and return a new object.  See help(type) for accurate signature.
- -
-Methods inherited from builtins.BaseException:
-
__getattribute__(self, name, /)
Return getattr(self, name).
- -
__reduce__(self, /)
Helper for pickle.
- -
__repr__(self, /)
Return repr(self).
- -
__setstate__(self, object, /)
- -
__str__(self, /)
Return str(self).
- -
add_note(self, object, /)
Exception.add_note(note) --
-add a note to the exception
- -
with_traceback(self, object, /)
Exception.with_traceback(tb) --
-set self.__traceback__ to tb and return self.
- -
-Data descriptors inherited from builtins.BaseException:
-
__cause__
-
exception cause
-
-
__context__
-
exception context
-
-
__dict__
-
-
__suppress_context__
-
-
__traceback__
-
-
args
-
-

- - - - - - - -
 
class AIAPIAuthorizationException(AIAPIServerException)
   AIAPIAuthorizationException(
-    description: str,
-    error_message: str,
-    error_code: str = None,
-    request_id: str = None,
-    details: dict = None
-)
- 
-Exception type that is raised by the :class:`ai_api_client_sdk.helpers.rest_client.RestClient` if a 401 response
-is received from the server. This extends the :class:`ai_api_client_sdk.exception.AIAPIServerException`, refer there
-for object definition
 
 
Method resolution order:
-
AIAPIAuthorizationException
-
AIAPIServerException
-
builtins.Exception
-
builtins.BaseException
-
builtins.object
-
-
-Methods defined here:
-
__init__( - self, - description: str, - error_message: str, - error_code: str = None, - request_id: str = None, - details: dict = None -)
Initialize self.  See help(type(self)) for accurate signature.
- -
-Methods inherited from AIAPIServerException:
-
__str__(self)
Return str(self).
- -
-Data descriptors inherited from AIAPIServerException:
-
__weakref__
-
list of weak references to the object
-
-
-Static methods inherited from builtins.Exception:
-
__new__(*args, **kwargs) class method of builtins.Exception
Create and return a new object.  See help(type) for accurate signature.
- -
-Methods inherited from builtins.BaseException:
-
__getattribute__(self, name, /)
Return getattr(self, name).
- -
__reduce__(self, /)
Helper for pickle.
- -
__repr__(self, /)
Return repr(self).
- -
__setstate__(self, object, /)
- -
add_note(self, object, /)
Exception.add_note(note) --
-add a note to the exception
- -
with_traceback(self, object, /)
Exception.with_traceback(tb) --
-set self.__traceback__ to tb and return self.
- -
-Data descriptors inherited from builtins.BaseException:
-
__cause__
-
exception cause
-
-
__context__
-
exception context
-
-
__dict__
-
-
__suppress_context__
-
-
__traceback__
-
-
args
-
-

- - - - - - - -
 
class AIAPIClientSDKException(builtins.Exception)
   AIAPIClientSDKException(
-    description: str,
-    status_code: int = None,
-    error_message: str = None
-)
- 
-Base Exception class for AI API Client SDK exceptions
 
 
Method resolution order:
-
AIAPIClientSDKException
-
builtins.Exception
-
builtins.BaseException
-
builtins.object
-
-
-Methods defined here:
-
__init__( - self, - description: str, - status_code: int = None, - error_message: str = None -)
Initialize self.  See help(type(self)) for accurate signature.
- -
-Data descriptors defined here:
-
__weakref__
-
list of weak references to the object
-
-
-Static methods inherited from builtins.Exception:
-
__new__(*args, **kwargs) class method of builtins.Exception
Create and return a new object.  See help(type) for accurate signature.
- -
-Methods inherited from builtins.BaseException:
-
__getattribute__(self, name, /)
Return getattr(self, name).
- -
__reduce__(self, /)
Helper for pickle.
- -
__repr__(self, /)
Return repr(self).
- -
__setstate__(self, object, /)
- -
__str__(self, /)
Return str(self).
- -
add_note(self, object, /)
Exception.add_note(note) --
-add a note to the exception
- -
with_traceback(self, object, /)
Exception.with_traceback(tb) --
-set self.__traceback__ to tb and return self.
- -
-Data descriptors inherited from builtins.BaseException:
-
__cause__
-
exception cause
-
-
__context__
-
exception context
-
-
__dict__
-
-
__suppress_context__
-
-
__traceback__
-
-
args
-
-

- - - - - - - -
 
class AIAPIInvalidInputException(AIAPIClientSDKException)
   AIAPIInvalidInputException(description: str)
- 
-Exception type raised, when the provided input is invalid
 
 
Method resolution order:
-
AIAPIInvalidInputException
-
AIAPIClientSDKException
-
builtins.Exception
-
builtins.BaseException
-
builtins.object
-
-
-Methods defined here:
-
__init__(self, description: str)
Initialize self.  See help(type(self)) for accurate signature.
- -
-Data descriptors inherited from AIAPIClientSDKException:
-
__weakref__
-
list of weak references to the object
-
-
-Static methods inherited from builtins.Exception:
-
__new__(*args, **kwargs) class method of builtins.Exception
Create and return a new object.  See help(type) for accurate signature.
- -
-Methods inherited from builtins.BaseException:
-
__getattribute__(self, name, /)
Return getattr(self, name).
- -
__reduce__(self, /)
Helper for pickle.
- -
__repr__(self, /)
Return repr(self).
- -
__setstate__(self, object, /)
- -
__str__(self, /)
Return str(self).
- -
add_note(self, object, /)
Exception.add_note(note) --
-add a note to the exception
- -
with_traceback(self, object, /)
Exception.with_traceback(tb) --
-set self.__traceback__ to tb and return self.
- -
-Data descriptors inherited from builtins.BaseException:
-
__cause__
-
exception cause
-
-
__context__
-
exception context
-
-
__dict__
-
-
__suppress_context__
-
-
__traceback__
-
-
args
-
-

- - - - - - - -
 
class AIAPIInvalidRequestException(AIAPIServerException)
   AIAPIInvalidRequestException(
-    description: str,
-    error_code: str,
-    error_message: str,
-    request_id: str,
-    details: dict = None
-)
- 
-Exception type that is raised by the :class:`ai_api_client_sdk.helpers.rest_client.RestClient` if a 400 response
-is received from the server. This extends the :class:`ai_api_client_sdk.exception.AIAPIServerException`, refer there
-for object definition
 
 
Method resolution order:
-
AIAPIInvalidRequestException
-
AIAPIServerException
-
builtins.Exception
-
builtins.BaseException
-
builtins.object
-
-
-Methods defined here:
-
__init__( - self, - description: str, - error_code: str, - error_message: str, - request_id: str, - details: dict = None -)
Initialize self.  See help(type(self)) for accurate signature.
- -
-Methods inherited from AIAPIServerException:
-
__str__(self)
Return str(self).
- -
-Data descriptors inherited from AIAPIServerException:
-
__weakref__
-
list of weak references to the object
-
-
-Static methods inherited from builtins.Exception:
-
__new__(*args, **kwargs) class method of builtins.Exception
Create and return a new object.  See help(type) for accurate signature.
- -
-Methods inherited from builtins.BaseException:
-
__getattribute__(self, name, /)
Return getattr(self, name).
- -
__reduce__(self, /)
Helper for pickle.
- -
__repr__(self, /)
Return repr(self).
- -
__setstate__(self, object, /)
- -
add_note(self, object, /)
Exception.add_note(note) --
-add a note to the exception
- -
with_traceback(self, object, /)
Exception.with_traceback(tb) --
-set self.__traceback__ to tb and return self.
- -
-Data descriptors inherited from builtins.BaseException:
-
__cause__
-
exception cause
-
-
__context__
-
exception context
-
-
__dict__
-
-
__suppress_context__
-
-
__traceback__
-
-
args
-
-

- - - - - - - -
 
class AIAPINotFoundException(AIAPIServerException)
   AIAPINotFoundException(
-    description: str,
-    error_code: str,
-    error_message: str,
-    request_id: str,
-    details: dict = None
-)
- 
-Exception type that is raised by the :class:`ai_api_client_sdk.helpers.rest_client.RestClient` if a 404 response
-is received from the server. This extends the :class:`ai_api_client_sdk.exception.AIAPIServerException`, refer there
-for object definition
 
 
Method resolution order:
-
AIAPINotFoundException
-
AIAPIServerException
-
builtins.Exception
-
builtins.BaseException
-
builtins.object
-
-
-Methods defined here:
-
__init__( - self, - description: str, - error_code: str, - error_message: str, - request_id: str, - details: dict = None -)
Initialize self.  See help(type(self)) for accurate signature.
- -
-Methods inherited from AIAPIServerException:
-
__str__(self)
Return str(self).
- -
-Data descriptors inherited from AIAPIServerException:
-
__weakref__
-
list of weak references to the object
-
-
-Static methods inherited from builtins.Exception:
-
__new__(*args, **kwargs) class method of builtins.Exception
Create and return a new object.  See help(type) for accurate signature.
- -
-Methods inherited from builtins.BaseException:
-
__getattribute__(self, name, /)
Return getattr(self, name).
- -
__reduce__(self, /)
Helper for pickle.
- -
__repr__(self, /)
Return repr(self).
- -
__setstate__(self, object, /)
- -
add_note(self, object, /)
Exception.add_note(note) --
-add a note to the exception
- -
with_traceback(self, object, /)
Exception.with_traceback(tb) --
-set self.__traceback__ to tb and return self.
- -
-Data descriptors inherited from builtins.BaseException:
-
__cause__
-
exception cause
-
-
__context__
-
exception context
-
-
__dict__
-
-
__suppress_context__
-
-
__traceback__
-
-
args
-
-

- - - - - - - -
 
class AIAPIPreconditionFailedException(AIAPIServerException)
   AIAPIPreconditionFailedException(
-    description: str,
-    error_code: str,
-    error_message: str,
-    request_id: str,
-    details: dict = None
-)
- 
-Exception type that is raised by the :class:`ai_api_client_sdk.helpers.rest_client.RestClient` if a 412 response
-is received from the server. This extends the :class:`ai_api_client_sdk.exception.AIAPIServerException`, refer there
-for object definition
 
 
Method resolution order:
-
AIAPIPreconditionFailedException
-
AIAPIServerException
-
builtins.Exception
-
builtins.BaseException
-
builtins.object
-
-
-Methods defined here:
-
__init__( - self, - description: str, - error_code: str, - error_message: str, - request_id: str, - details: dict = None -)
Initialize self.  See help(type(self)) for accurate signature.
- -
-Methods inherited from AIAPIServerException:
-
__str__(self)
Return str(self).
- -
-Data descriptors inherited from AIAPIServerException:
-
__weakref__
-
list of weak references to the object
-
-
-Static methods inherited from builtins.Exception:
-
__new__(*args, **kwargs) class method of builtins.Exception
Create and return a new object.  See help(type) for accurate signature.
- -
-Methods inherited from builtins.BaseException:
-
__getattribute__(self, name, /)
Return getattr(self, name).
- -
__reduce__(self, /)
Helper for pickle.
- -
__repr__(self, /)
Return repr(self).
- -
__setstate__(self, object, /)
- -
add_note(self, object, /)
Exception.add_note(note) --
-add a note to the exception
- -
with_traceback(self, object, /)
Exception.with_traceback(tb) --
-set self.__traceback__ to tb and return self.
- -
-Data descriptors inherited from builtins.BaseException:
-
__cause__
-
exception cause
-
-
__context__
-
exception context
-
-
__dict__
-
-
__suppress_context__
-
-
__traceback__
-
-
args
-
-

- - - - - - - -
 
class AIAPIServerException(builtins.Exception)
   AIAPIServerException(
-    description: str,
-    status_code: int,
-    error_message: str,
-    error_code: str = None,
-    request_id: str = None,
-    details: dict = None
-)
- 
-Exception type that is raised by the :class:`ai_api_client_sdk.helpers.rest_client.RestClient`, if a non-2XX
-response is received from the server.
- 
-:param description: description of the exception
-:type description: str
-:param status_code: Status code of the response from the server
-:type status_code: int
-:param error_message: Error message received from the server
-:type error_message: str
-:param error_code: Error code received from the server, defaults to None
-:type error_code: str, optional
-:param request_id: ID of the request, the response belongs to, defaults to None
-:type request_id: str, optional
-:param details: Error details received from the server, defaults to None
-:type details: dict, optional
 
 
Method resolution order:
-
AIAPIServerException
-
builtins.Exception
-
builtins.BaseException
-
builtins.object
-
-
-Methods defined here:
-
__init__( - self, - description: str, - status_code: int, - error_message: str, - error_code: str = None, - request_id: str = None, - details: dict = None -)
Initialize self.  See help(type(self)) for accurate signature.
- -
__str__(self)
Return str(self).
- -
-Data descriptors defined here:
-
__weakref__
-
list of weak references to the object
-
-
-Static methods inherited from builtins.Exception:
-
__new__(*args, **kwargs) class method of builtins.Exception
Create and return a new object.  See help(type) for accurate signature.
- -
-Methods inherited from builtins.BaseException:
-
__getattribute__(self, name, /)
Return getattr(self, name).
- -
__reduce__(self, /)
Helper for pickle.
- -
__repr__(self, /)
Return repr(self).
- -
__setstate__(self, object, /)
- -
add_note(self, object, /)
Exception.add_note(note) --
-add a note to the exception
- -
with_traceback(self, object, /)
Exception.with_traceback(tb) --
-set self.__traceback__ to tb and return self.
- -
-Data descriptors inherited from builtins.BaseException:
-
__cause__
-
exception cause
-
-
__context__
-
exception context
-
-
__dict__
-
-
__suppress_context__
-
-
__traceback__
-
-
args
-
-

- \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.helpers.authenticator.html b/packages/base/docs/ai_api_client_sdk.helpers.authenticator.html deleted file mode 100644 index 1fbd98b..0000000 --- a/packages/base/docs/ai_api_client_sdk.helpers.authenticator.html +++ /dev/null @@ -1,110 +0,0 @@ - - - - -Python: module ai_api_client_sdk.helpers.authenticator - - - - - -
 
ai_api_client_sdk.helpers.authenticator		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/helpers/authenticator.py
-

-

- - - - - -
 
Modules
       
os
-		requests
-		tempfile
-		time
-

- - - - - -
 
Classes
       
-
builtins.object -
-
-
Authenticator -
-
-
-

- - - - - - - -
 
class Authenticator(builtins.object)
   Authenticator(
-    auth_url: str,
-    client_id: str,
-    client_secret: str = None,
-    cert_str: str = None,
-    key_str: str = None,
-    cert_file_path: str = None,
-    key_file_path: str = None
-)
- 
-Authenticator class is implemented to retrieve and cache the authorization token from the xsuaa server
- 
-:param auth_url: URL of the authorization endpoint. Should be the full URL (including /oauth/token)
-:type auth_url: str
-:param client_id: client id to be used for authorization
-:type client_id: str
-:param client_secret: client secret to be used for authorization, either client_secret or
-    (cert_file_path and key_file_path) need to be provided, defaults to None
-:type client_secret: str, optional
-:param cert_str: certificate file content, needs to be provided alongside the key_str parameter, defaults to None
-:type cert_str: str, optional
-:param key_str: key file content, needs to be provided alongside the cert_str parameter, defaults to None
-:type key_str: str, optional
-:param cert_file_path: path to the certificate file, needs to be provided alongside the key_file_path parameter,
-    defaults to None
-:type cert_file_path: str, optional
-:param key_file_path: path to the key file, needs to be provided alongside the cert_file_path parameter,
-    defaults to None
-:type key_file_path: str, optional
 
 Methods defined here:
-
__init__( - self, - auth_url: str, - client_id: str, - client_secret: str = None, - cert_str: str = None, - key_str: str = None, - cert_file_path: str = None, - key_file_path: str = None -)
Initialize self.  See help(type(self)) for accurate signature.
- -
get_token(self) -> str
Retrieves the token from the xsuaa server or from cache when expiration date not reached.
- 
-:raises: class:`ai_api_client_sdk.exception.AIAPIAuthenticatorException` if an unexpected exception occurs while
-    trying to retrieve the token
-:return: The Bearer token
-:rtype: str
- -
-Data descriptors defined here:
-
__dict__
-
dictionary for instance variables
-
-
__weakref__
-
list of weak references to the object
-
-

- - - - - -
 
Data
       BASE_DELAY_FOR_TOKEN_RETRY = 0.3
-MAX_RETRY_ATTEMPTS_FOR_TOKEN = 3
-Optional = typing.Optional
-PARAM_ERROR_MESSAGE = 'Either client_secret, or (cert_file_path, key_fi..., or (cert_str, key_str) pair need to be provided'
- \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.helpers.constants.html b/packages/base/docs/ai_api_client_sdk.helpers.constants.html deleted file mode 100644 index f9506f7..0000000 --- a/packages/base/docs/ai_api_client_sdk.helpers.constants.html +++ /dev/null @@ -1,95 +0,0 @@ - - - - -Python: module ai_api_client_sdk.helpers.constants - - - - - -
 
ai_api_client_sdk.helpers.constants		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/helpers/constants.py
-

-

- - - - - -
 
Modules
       
re
-

- - - - - -
 
Classes
       
-
enum.Enum(builtins.object) -
-
-
Timeouts -
-
-
-

- - - - - - - -
 
class Timeouts(enum.Enum)
   Timeouts(*values)
- 
-
 
 
Method resolution order:
-
Timeouts
-
enum.Enum
-
builtins.object
-
-
-Data and other attributes defined here:
-
NUM_REQUEST_RETRIES = <Timeouts.NUM_REQUEST_RETRIES: 3>
- -
READ_TIMEOUT = <Timeouts.READ_TIMEOUT: 60>
- -
-Data descriptors inherited from enum.Enum:
-
name
-
The name of the Enum member.
-
-
value
-
The value of the Enum member.
-
-
-Static methods inherited from enum.EnumType:
-
__contains__(value)
Return True if `value` is in `cls`.
- 
-`value` is in `cls` if:
-1) `value` is a member of `cls`, or
-2) `value` is the value of one of the `cls`'s members.
-3) `value` is a pseudo-member (flags)
- -
__getitem__(name)
Return the member matching `name`.
- -
__iter__()
Return members in definition order.
- -
__len__()
Return the number of members (no aliases)
- -
-Readonly properties inherited from enum.EnumType:
-
__members__
-
Returns a mapping of member name->value.
- 
-This mapping lists all enum members, including aliases.  Note that
-this is a read-only view of the internal mapping.
-
-

- - - - - -
 
Data
       DEBUG_ENV_VAR_NAME = 'DEBUG'
-SCENARIO_LABEL_NAME_PATTERN = re.compile('^scenarios\\.ai\\.sap\\.com/[\\w.-]+$')
-SKIP_AUTH_ENV_VAR = 'SKIP_AUTHORIZATION'
- \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.helpers.datetime_parser.html b/packages/base/docs/ai_api_client_sdk.helpers.datetime_parser.html deleted file mode 100644 index 8d1a273..0000000 --- a/packages/base/docs/ai_api_client_sdk.helpers.datetime_parser.html +++ /dev/null @@ -1,30 +0,0 @@ - - - - -Python: module ai_api_client_sdk.helpers.datetime_parser - - - - - -
 
ai_api_client_sdk.helpers.datetime_parser		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/helpers/datetime_parser.py
-

-

- - - - - -
 
Functions
       
parse_datetime(datetime_str: str) -> datetime.datetime
-

- - - - - -
 
Data
       DATETIME_FORMAT = '%Y-%m-%dT%H:%M:%SZ'
-DATETIME_FORMAT_36 = '%Y-%m-%dT%H:%M:%S+00:00'
-DATETIME_FORMAT_FLOAT = '%Y-%m-%dT%H:%M:%S.%fZ'
-DATETIME_FORMAT_FLOAT_TZ = '%Y-%m-%dT%H:%M:%S.%f+00:00'
- \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.helpers.html b/packages/base/docs/ai_api_client_sdk.helpers.html deleted file mode 100644 index bff6917..0000000 --- a/packages/base/docs/ai_api_client_sdk.helpers.html +++ /dev/null @@ -1,26 +0,0 @@ - - - - -Python: package ai_api_client_sdk.helpers - - - - - -
 
ai_api_client_sdk.helpers		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/helpers/__init__.py
-

-

- - - - - -
 
Package Contents
       
authenticator
-constants
-		datetime_parser
-llm_helper
-		logging
-rest_client
-
- \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.helpers.llm_helper.html b/packages/base/docs/ai_api_client_sdk.helpers.llm_helper.html deleted file mode 100644 index 452abea..0000000 --- a/packages/base/docs/ai_api_client_sdk.helpers.llm_helper.html +++ /dev/null @@ -1,32 +0,0 @@ - - - - -Python: module ai_api_client_sdk.helpers.llm_helper - - - - - -
 
ai_api_client_sdk.helpers.llm_helper		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/helpers/llm_helper.py
-

-

- - - - - -
 
Functions
       
check_if_llm_scenario(scenario)
-
filter_for_llm_scenarios(response_dict)
-
get_attr(obj, attr)
-

- - - - - -
 
Data
       SCENARIO_LABEL_NAME_PATTERN = re.compile('^scenarios\\.ai\\.sap\\.com/[\\w.-]+$')
-get_key = functools.partial(get_attr, attr='key')
-get_labels = functools.partial(get_attr, attr='labels')
-get_value = functools.partial(get_attr, attr='value')
- \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.helpers.logging.html b/packages/base/docs/ai_api_client_sdk.helpers.logging.html deleted file mode 100644 index a3e4032..0000000 --- a/packages/base/docs/ai_api_client_sdk.helpers.logging.html +++ /dev/null @@ -1,39 +0,0 @@ - - - - -Python: module ai_api_client_sdk.helpers.logging - - - - - -
 
ai_api_client_sdk.helpers.logging		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/helpers/logging.py
-

-

- - - - - -
 
Modules
       
logging
-		os
-

- - - - - -
 
Functions
       
get_logger()
-
get_logger_name()
-
set_log_level(logger: logging.Logger)
-

- - - - - -
 
Data
       DEBUG_ENV_VAR_NAME = 'DEBUG'
-DEFAULT_LOG_LEVEL = 20
-LOGGER_NAME = 'ai-api-client-sdk'
- \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.helpers.rest_client.html b/packages/base/docs/ai_api_client_sdk.helpers.rest_client.html deleted file mode 100644 index f78eac8..0000000 --- a/packages/base/docs/ai_api_client_sdk.helpers.rest_client.html +++ /dev/null @@ -1,247 +0,0 @@ - - - - -Python: module ai_api_client_sdk.helpers.rest_client - - - - - -
 
ai_api_client_sdk.helpers.rest_client		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/helpers/rest_client.py
-

-

- - - - - -
 
Modules
       
humps
-		json
-		os
-		requests
-

- - - - - -
 
Classes
       
-
builtins.object -
-
-
RestClient -
-
-
-

- - - - - - - -
 
class RestClient(builtins.object)
   RestClient(
-    base_url: str,
-    get_token: Callable[[], str],
-    resource_group: str = None,
-    client_type: str = None,
-    read_timeout=60,
-    connect_timeout=60,
-    num_request_retries=3
-)
- 
-RestClient is the class implemented for sending the requests to the server.
- 
-:param base_url: Base URL of the server. Should include the base path as well. (i.e., "<base_url>/scenarios" should
-    work)
-:type base_url: str
-:param get_token: the function which returns the Bearer token, when called
-:type get_token: Callable[[], str]
-:param resource_group: The default resource group which will be used while sending the requests to the server,
-    defaults to None
-:type resource_group: str
-:param client_type: Used for Metering to distinguish eg AI Launchpad python SDKs etc,
-    defaults to None
-:type client_type: str
-:param read_timeout: Read timeout for requests in seconds, defaults to 60s
-:type read_timeout: int
-:param connect_timeout: Connect timeout for requests in seconds, defaults to 60s
-:type connect_timeout: int
-:param num_request_retries: Number of retries for failing requests with http status code 429, 500, 502, 503 or 504,
-    defaults to 60s
-:type num_request_retries: int
 
 Methods defined here:
-
__init__( - self, - base_url: str, - get_token: Callable[[], str], - resource_group: str = None, - client_type: str = None, - read_timeout=60, - connect_timeout=60, - num_request_retries=3 -)
Initialize self.  See help(type(self)) for accurate signature.
- -
delete( - self, - path: str, - params: Dict[str, str] = None, - headers: Dict[str, str] = None, - resource_group: str = None, - **kwargs -) -> dict
Sends a DELETE request to the server.
- 
-:param path: path of the endpoint the request should be sent to
-:type path: str
-:param params: parameters of the request, defaults to None
-:type params: Dict[str, str], optional
-:param headers: headers of the request, defaults to None
-:type headers: Dict[str, str], optional
-:param resource_group: Resource Group which the request should be sent on behalf. Either this, or the
-    resource_group property of this class should be set.
-:type resource_group: str
-:param kwargs: additional keyword arguments to be passed to the request e.g. files, stream, etc.
-:type kwargs: dict
-: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
-:return: The JSON response from the server (The keys decamelized)
-:rtype: dict
- -
get( - self, - path: str, - params: Dict[str, str] = None, - headers: Dict[str, str] = None, - resource_group: str = None, - return_bytes_content: bool = False, - **kwargs -) -> Union[dict, int]
Sends a GET request to the server.
- 
-:param path: path of the endpoint the request should be sent to
-:type path: str
-:param params: parameters of the request, defaults to None
-:type params: Dict[str, str], optional
-:param headers: headers of the request, defaults to None
-:type headers: Dict[str, str], optional
-:param resource_group: Resource Group which the request should be sent on behalf. Either this, or the
-    resource_group property of this class should be set.
-:type resource_group: str
-:param return_bytes_content: expected response.content is bytes
-:type return_bytes_content: bool
-:param kwargs: additional keyword arguments to be passed to the request e.g. files, stream, etc.
-:type kwargs: dict
-: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
-:return: The JSON response from the server (The keys decamelized)
-:rtype: Union[dict, int]
- -
patch( - self, - path: str, - body: Dict[str, Union[str, dict, list]], - headers: Dict[str, str] = None, - resource_group: str = None, - **kwargs -) -> dict
Sends a PATCH request to the server.
- 
-:param path: path of the endpoint the request should be sent to
-:type path: str
-:param body: body of the request
-:type body: Dict[str, Union[str, dict, list]]
-:param headers: headers of the request, defaults to None
-:type headers: Dict[str, str], optional
-:param resource_group: Resource Group which the request should be sent on behalf. Either this, or the
-    resource_group property of this class should be set.
-:type resource_group: str
-:param kwargs: additional keyword arguments to be passed to the request e.g. files, stream, etc.
-:type kwargs: dict
-: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
-:return: The JSON response from the server (The keys decamelized)
-:rtype: dict
- -
post( - self, - path: str, - body: Dict[str, Union[str, dict]] = None, - headers: Dict[str, str] = None, - resource_group: str = None, - **kwargs -) -> dict
Sends a POST request to the server.
- 
-:param path: path of the endpoint the request should be sent to
-:type path: str
-:param body: body of the request, defaults to None
-:type body: Dict[str, str], optional
-:param headers: headers of the request, defaults to None
-:type headers: Dict[str, str], optional
-:param resource_group: Resource Group which the request should be sent on behalf. Either this, or the
-    resource_group property of this class should be set.
-:type resource_group: str
-:param kwargs: additional keyword arguments to be passed to the request e.g. files, stream, etc.
-:type kwargs: dict
-: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
-:return: The JSON response from the server (The keys decamelized)
-:rtype: dict
- -
-Static methods defined here:
-
raise_ai_api_exception(error_description, response, response_json)
- -
-Data descriptors defined here:
-
__dict__
-
dictionary for instance variables
-
-
__weakref__
-
list of weak references to the object
-
-
-Data and other attributes defined here:
-
logger = <Logger ai-api-client-sdk (WARNING)>
- -

- - - - - -
 
Data
       Callable = typing.Callable
-Dict = typing.Dict
-SKIP_AUTH_ENV_VAR = 'SKIP_AUTHORIZATION'
-Union = typing.Union
- \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.html b/packages/base/docs/ai_api_client_sdk.html deleted file mode 100644 index 374a56f..0000000 --- a/packages/base/docs/ai_api_client_sdk.html +++ /dev/null @@ -1,25 +0,0 @@ - - - - -Python: package ai_api_client_sdk - - - - - -
 
ai_api_client_sdk		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/__init__.py
-

-

- - - - - -
 
Package Contents
       
ai_api_v2_client
-exception
-		helpers (package)
-models (package)
-		resource_clients (package)
-
- \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.ai_api_capabilities.html b/packages/base/docs/ai_api_client_sdk.models.ai_api_capabilities.html deleted file mode 100644 index 1cdccd4..0000000 --- a/packages/base/docs/ai_api_client_sdk.models.ai_api_capabilities.html +++ /dev/null @@ -1,117 +0,0 @@ - - - - -Python: module ai_api_client_sdk.models.ai_api_capabilities - - - - - -
 
ai_api_client_sdk.models.ai_api_capabilities		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/ai_api_capabilities.py
-

-

- - - - - -
 
Classes
       
-
builtins.object -
-
-
AIAPICapabilities -
-
-
-

- - - - - - - -
 
class AIAPICapabilities(builtins.object)
   AIAPICapabilities(
-    multitenant: bool = True,
-    shareable: bool = True,
-    static_deployments: bool = True,
-    user_deployments: bool = True,
-    time_to_live_deployments: bool = False,
-    user_executions: bool = True,
-    bulk_updates: ai_api_client_sdk.models.ai_api_capabilities_bulk_updates.AIAPICapabilitiesBulkUpdates = None,
-    execution_schedules: bool = False,
-    logs: ai_api_client_sdk.models.ai_api_capabilities_logs.AIAPICapabilitiesLogs = None,
-    **kwargs
-)
- 
-The AIAPICapabilities object represent the capabilities of the AI API
- 
-:param multitenant: indicates whether resource groups are supported, defaults to True
-:type multitenant: bool, optional
-:param shareable: indicates whether clients can share an instance, defaults to True
-:type shareable: bool, optional
-:param static_deployments: indicates whether the static, always running deployments are supported, defaults to True
-:type static_deployments: bool, optional
-:param user_deployments: indicates whether deployment creation by users are supported, defaults to True
-:type user_deployments: bool, optional
-:param time_to_live_deployments: indicate whether ttl value of deployment are supported, defaults to False
-:type time_to_live_deployments: bool, optional
-:param user_executions: indicates whether execution creation by users are supported, defaults to True
-:type user_executions: bool, optional
-:param bulk_updates: An object, defining the bulk updates capabilities, defaults to None
-:type bulk_updates: class:`ai_api_client_sdk.models.ai_api_capabilities_bulk_updates.AIAPICapabilitiesBulkUpdates`,
- optional
-:param execution_schedules: indicates whether execution schedules are supported, defaults to False
-:type execution_schedules: bool, optional
-:param logs: An object, defining the logs capabilities, defaults to None
-:type logs: class:`ai_api_client_sdk.models.ai_api_capabilities_logs.AIAPICapabilitiesLogs`, optional
-:param `**kwargs`: The keyword arguments are there in case there are additional attributes returned from server
 
 Methods defined here:
-
__eq__(self, other)
Return self==value.
- -
__init__( - self, - multitenant: bool = True, - shareable: bool = True, - static_deployments: bool = True, - user_deployments: bool = True, - time_to_live_deployments: bool = False, - user_executions: bool = True, - bulk_updates: ai_api_client_sdk.models.ai_api_capabilities_bulk_updates.AIAPICapabilitiesBulkUpdates = None, - execution_schedules: bool = False, - logs: ai_api_client_sdk.models.ai_api_capabilities_logs.AIAPICapabilitiesLogs = None, - **kwargs -)
Initialize self.  See help(type(self)) for accurate signature.
- -
__str__(self)
Return str(self).
- -
-Static methods defined here:
-
from_dict(ai_api_capabilities_dict: Dict[str, Any])
Returns a :class:`ai_api_client_sdk.models.ai_api_capabilities.AIAPICapabilities` object, created from the
-values in the dict provided as parameter
- 
-:param ai_api_capabilities_dict: Dict which includes the necessary values to create the object
-:type ai_api_capabilities_dict: Dict[str, Any]
-:return: An object, created from the values provided
-:rtype: class:`ai_api_client_sdk.models.ai_api_capabilities.AIAPICapabilities`
- -
-Data descriptors defined here:
-
__dict__
-
dictionary for instance variables
-
-
__weakref__
-
list of weak references to the object
-
-
-Data and other attributes defined here:
-
__hash__ = None
- -

- - - - - -
 
Data
       Dict = typing.Dict
- \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.ai_api_capabilities_bulk_updates.html b/packages/base/docs/ai_api_client_sdk.models.ai_api_capabilities_bulk_updates.html deleted file mode 100644 index a66d2fb..0000000 --- a/packages/base/docs/ai_api_client_sdk.models.ai_api_capabilities_bulk_updates.html +++ /dev/null @@ -1,83 +0,0 @@ - - - - -Python: module ai_api_client_sdk.models.ai_api_capabilities_bulk_updates - - - - - -
 
ai_api_client_sdk.models.ai_api_capabilities_bulk_updates		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/ai_api_capabilities_bulk_updates.py
-

-

- - - - - -
 
Classes
       
-
builtins.object -
-
-
AIAPICapabilitiesBulkUpdates -
-
-
-

- - - - - - - -
 
class AIAPICapabilitiesBulkUpdates(builtins.object)
   AIAPICapabilitiesBulkUpdates(
-    executions: bool = False,
-    deployments: bool = False,
-    **kwargs
-)
- 
-The AIAPICapabilitiesBulkUpdates object represents the bulk updates capabilities
- 
-:param deployments: indicates whether bulk updates for executions are supported, defaults to False
-:type deployments: bool, optional
-:param executions: indicates whether bulk updates for executions are supported, defaults to False
-:type executions: bool, optional
-:param `**kwargs`: The keyword arguments are there in case there are additional attributes returned from server
 
 Methods defined here:
-
__eq__(self, other)
Return self==value.
- -
__init__(self, executions: bool = False, deployments: bool = False, **kwargs)
Initialize self.  See help(type(self)) for accurate signature.
- -
__str__(self)
Return str(self).
- -
-Static methods defined here:
-
from_dict(ai_api_capabilities_bulk_updates_dict: Dict[str, bool])
Returns a :class:`ai_api_client_sdk.models.ai_api_capabilities_bulk_updates.AIAPICapabilitiesBulkUpdates` object, created
-from the values in the dict provided as parameter
- 
-:param ai_api_capabilities_bulk_updates_dict: Dict which includes the necessary values to create the object
-:type ai_api_capabilities_bulk_updates_dict: Dict[str, bool]
-:return: An object, created from the values provided
-:rtype: class:`ai_api_client_sdk.models.ai_api_capabilities_bulk_updates.AIAPICapabilitiesBulkUpdates`
- -
-Data descriptors defined here:
-
__dict__
-
dictionary for instance variables
-
-
__weakref__
-
list of weak references to the object
-
-
-Data and other attributes defined here:
-
__hash__ = None
- -

- - - - - -
 
Data
       Dict = typing.Dict
- \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.ai_api_capabilities_logs.html b/packages/base/docs/ai_api_client_sdk.models.ai_api_capabilities_logs.html deleted file mode 100644 index cb6f4d8..0000000 --- a/packages/base/docs/ai_api_client_sdk.models.ai_api_capabilities_logs.html +++ /dev/null @@ -1,83 +0,0 @@ - - - - -Python: module ai_api_client_sdk.models.ai_api_capabilities_logs - - - - - -
 
ai_api_client_sdk.models.ai_api_capabilities_logs		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/ai_api_capabilities_logs.py
-

-

- - - - - -
 
Classes
       
-
builtins.object -
-
-
AIAPICapabilitiesLogs -
-
-
-

- - - - - - - -
 
class AIAPICapabilitiesLogs(builtins.object)
   AIAPICapabilitiesLogs(
-    executions: bool = True,
-    deployments: bool = True,
-    **kwargs
-)
- 
-The AIAPICapabilitiesLogs object represents the log capabilities
- 
-:param user_executions: indicates whether logs for executions are supported, defaults to True
-:type user_executions: bool, optional
-:param user_deployments: indicates whether logs for deployments are supported, defaults to True
-:type user_deployments: bool, optional
-:param `**kwargs`: The keyword arguments are there in case there are additional attributes returned from server
 
 Methods defined here:
-
__eq__(self, other)
Return self==value.
- -
__init__(self, executions: bool = True, deployments: bool = True, **kwargs)
Initialize self.  See help(type(self)) for accurate signature.
- -
__str__(self)
Return str(self).
- -
-Static methods defined here:
-
from_dict(ai_api_capabilities_logs_dict: Dict[str, bool])
Returns a :class:`ai_api_client_sdk.models.ai_api_capabilities_logs.AIAPICapabilitiesLogs` object, created
-from the values in the dict provided as parameter
- 
-:param ai_api_capabilities_logs_dict: Dict which includes the necessary values to create the object
-:type ai_api_capabilities_logs_dict: Dict[str, bool]
-:return: An object, created from the values provided
-:rtype: class:`ai_api_client_sdk.models.ai_api_capabilities_logs.AIAPICapabilitiesLogs`
- -
-Data descriptors defined here:
-
__dict__
-
dictionary for instance variables
-
-
__weakref__
-
list of weak references to the object
-
-
-Data and other attributes defined here:
-
__hash__ = None
- -

- - - - - -
 
Data
       Dict = typing.Dict
- \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.ai_api_limits.html b/packages/base/docs/ai_api_client_sdk.models.ai_api_limits.html deleted file mode 100644 index 457eed7..0000000 --- a/packages/base/docs/ai_api_client_sdk.models.ai_api_limits.html +++ /dev/null @@ -1,88 +0,0 @@ - - - - -Python: module ai_api_client_sdk.models.ai_api_limits - - - - - -
 
ai_api_client_sdk.models.ai_api_limits		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/ai_api_limits.py
-

-

- - - - - -
 
Classes
       
-
builtins.object -
-
-
AIAPILimits -
-
-
-

- - - - - - - -
 
class AIAPILimits(builtins.object)
   AIAPILimits(
-    executions: ai_api_client_sdk.models.ai_api_limits_executions.AIAPILimitsExecutions = None,
-    deployments: ai_api_client_sdk.models.ai_api_limits_deployments.AIAPILimitsDeployments = None,
-    **kwargs
-)
- 
-The AIAPILimits object represents the the limits for executions and deployments
- 
-:param executions: represents the limits for executions, defaults to None
-:type executions: class:`ai_api_client_sdk.models.ai_api_limits_executions.AIAPILimitsExecutions`, optional
-:param deployments: represents the limits for deployments, defaults to None
-:type deployments: class:`ai_api_client_sdk.models.ai_api_limits_deployments.AIAPILimitsDeployments`, optional
-:param `**kwargs`: The keyword arguments are there in case there are additional attributes returned from server
 
 Methods defined here:
-
__eq__(self, other)
Return self==value.
- -
__init__( - self, - executions: ai_api_client_sdk.models.ai_api_limits_executions.AIAPILimitsExecutions = None, - deployments: ai_api_client_sdk.models.ai_api_limits_deployments.AIAPILimitsDeployments = None, - **kwargs -)
Initialize self.  See help(type(self)) for accurate signature.
- -
__str__(self)
Return str(self).
- -
-Static methods defined here:
-
from_dict(ai_api_limits_dict: Dict[str, Any])
Returns a :class:`ai_api_client_sdk.models.ai_api_limits.AIAPILimits` object, created from the values in the
-dict provided as parameter
- 
-:param ai_api_limits_dict: Dict which includes the necessary values to create the object
-:type ai_api_limits_dict: Dict[str, Any]
-:return: An object, created from the values provided
-:rtype: class:`ai_api_client_sdk.models.ai_api_limits.AIAPILimits`
- -
-Data descriptors defined here:
-
__dict__
-
dictionary for instance variables
-
-
__weakref__
-
list of weak references to the object
-
-
-Data and other attributes defined here:
-
__hash__ = None
- -

- - - - - -
 
Data
       Dict = typing.Dict
- \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.ai_api_limits_deployments.html b/packages/base/docs/ai_api_client_sdk.models.ai_api_limits_deployments.html deleted file mode 100644 index 4a4b356..0000000 --- a/packages/base/docs/ai_api_client_sdk.models.ai_api_limits_deployments.html +++ /dev/null @@ -1,85 +0,0 @@ - - - - -Python: module ai_api_client_sdk.models.ai_api_limits_deployments - - - - - -
 
ai_api_client_sdk.models.ai_api_limits_deployments		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/ai_api_limits_deployments.py
-

-

- - - - - -
 
Classes
       
-
ai_api_client_sdk.models.ai_api_limits_enactments.AIAPILimitsEnactments(builtins.object) -
-
-
AIAPILimitsDeployments -
-
-
-

- - - - - - - -
 
class AIAPILimitsDeployments(ai_api_client_sdk.models.ai_api_limits_enactments.AIAPILimitsEnactments)
   AIAPILimitsDeployments(max_running_count: int = -1, **kwargs)
- 
-The AIAPILimitsDeployments object represents the the limits for deployments
- 
-:param max_running_count: max number of deployments per resource group, <0 means unlimited, defaults to -1
-:type max_running_count: int, optional
-:param `**kwargs`: The keyword arguments are there in case there are additional attributes returned from server
 
 
Method resolution order:
-
AIAPILimitsDeployments
-
ai_api_client_sdk.models.ai_api_limits_enactments.AIAPILimitsEnactments
-
builtins.object
-
-
-Methods defined here:
-
__init__(self, max_running_count: int = -1, **kwargs)
Initialize self.  See help(type(self)) for accurate signature.
- -
__str__(self)
Return str(self).
- -
-Static methods defined here:
-
from_dict(ai_api_limits_deployments_dict: Dict[str, int])
Returns a :class:`ai_api_client_sdk.models.ai_api_limits_deployments.AIAPILimitsDeployments` object, created
-from the values in the dict provided as parameter
- 
-:param ai_api_limits_deployments_dict: Dict which includes the necessary values to create the object
-:type ai_api_limits_deployments_dict: Dict[str, int]
-:return: An object, created from the values provided
-:rtype: class:`ai_api_client_sdk.models.ai_api_limits_deployments.AIAPILimitsDeployments`
- -
-Methods inherited from ai_api_client_sdk.models.ai_api_limits_enactments.AIAPILimitsEnactments:
-
__eq__(self, other)
Return self==value.
- -
-Data descriptors inherited from ai_api_client_sdk.models.ai_api_limits_enactments.AIAPILimitsEnactments:
-
__dict__
-
dictionary for instance variables
-
-
__weakref__
-
list of weak references to the object
-
-
-Data and other attributes inherited from ai_api_client_sdk.models.ai_api_limits_enactments.AIAPILimitsEnactments:
-
__hash__ = None
- -

- - - - - -
 
Data
       Dict = typing.Dict
- \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.ai_api_limits_enactments.html b/packages/base/docs/ai_api_client_sdk.models.ai_api_limits_enactments.html deleted file mode 100644 index 5afce7d..0000000 --- a/packages/base/docs/ai_api_client_sdk.models.ai_api_limits_enactments.html +++ /dev/null @@ -1,62 +0,0 @@ - - - - -Python: module ai_api_client_sdk.models.ai_api_limits_enactments - - - - - -
 
ai_api_client_sdk.models.ai_api_limits_enactments		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/ai_api_limits_enactments.py
-

-

- - - - - -
 
Classes
       
-
builtins.object -
-
-
AIAPILimitsEnactments -
-
-
-

- - - - - - - -
 
class AIAPILimitsEnactments(builtins.object)
   AIAPILimitsEnactments(max_running_count: int = -1, **kwargs)
- 
-The AIAPILimitsEnactments object represents the the limits for enactments (common for both executions
-and deployments)
- 
-:param max_running_count: max number of enactments per resource group, <0 means unlimited, defaults to -1
-:type max_running_count: int, optional
-:param `**kwargs`: The keyword arguments are there in case there are additional attributes returned from server
 
 Methods defined here:
-
__eq__(self, other)
Return self==value.
- -
__init__(self, max_running_count: int = -1, **kwargs)
Initialize self.  See help(type(self)) for accurate signature.
- -
__str__(self)
Return str(self).
- -
-Data descriptors defined here:
-
__dict__
-
dictionary for instance variables
-
-
__weakref__
-
list of weak references to the object
-
-
-Data and other attributes defined here:
-
__hash__ = None
- -

- \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.ai_api_limits_executions.html b/packages/base/docs/ai_api_client_sdk.models.ai_api_limits_executions.html deleted file mode 100644 index 2662a10..0000000 --- a/packages/base/docs/ai_api_client_sdk.models.ai_api_limits_executions.html +++ /dev/null @@ -1,85 +0,0 @@ - - - - -Python: module ai_api_client_sdk.models.ai_api_limits_executions - - - - - -
 
ai_api_client_sdk.models.ai_api_limits_executions		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/ai_api_limits_executions.py
-

-

- - - - - -
 
Classes
       
-
ai_api_client_sdk.models.ai_api_limits_enactments.AIAPILimitsEnactments(builtins.object) -
-
-
AIAPILimitsExecutions -
-
-
-

- - - - - - - -
 
class AIAPILimitsExecutions(ai_api_client_sdk.models.ai_api_limits_enactments.AIAPILimitsEnactments)
   AIAPILimitsExecutions(max_running_count: int = -1, **kwargs)
- 
-The AIAPILimitsExecutions object represents the the limits for executions
- 
-:param max_running_count: max number of executions per resource group, <0 means unlimited, defaults to -1
-:type max_running_count: int, optional
-:param `**kwargs`: The keyword arguments are there in case there are additional attributes returned from server
 
 
Method resolution order:
-
AIAPILimitsExecutions
-
ai_api_client_sdk.models.ai_api_limits_enactments.AIAPILimitsEnactments
-
builtins.object
-
-
-Methods defined here:
-
__init__(self, max_running_count: int = -1, **kwargs)
Initialize self.  See help(type(self)) for accurate signature.
- -
__str__(self)
Return str(self).
- -
-Static methods defined here:
-
from_dict(ai_api_limits_executions_dict: Dict[str, int])
Returns a :class:`ai_api_client_sdk.models.ai_api_limits_executions.AIAPILimitsExecutions` object, created
-from the values in the dict provided as parameter
- 
-:param ai_api_limits_executions_dict: Dict which includes the necessary values to create the object
-:type ai_api_limits_executions_dict: Dict[str, int]
-:return: An object, created from the values provided
-:rtype: class:`ai_api_client_sdk.models.ai_api_limits_executions.AIAPILimitsExecutions`
- -
-Methods inherited from ai_api_client_sdk.models.ai_api_limits_enactments.AIAPILimitsEnactments:
-
__eq__(self, other)
Return self==value.
- -
-Data descriptors inherited from ai_api_client_sdk.models.ai_api_limits_enactments.AIAPILimitsEnactments:
-
__dict__
-
dictionary for instance variables
-
-
__weakref__
-
list of weak references to the object
-
-
-Data and other attributes inherited from ai_api_client_sdk.models.ai_api_limits_enactments.AIAPILimitsEnactments:
-
__hash__ = None
- -

- - - - - -
 
Data
       Dict = typing.Dict
- \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.ai_api_meta.html b/packages/base/docs/ai_api_client_sdk.models.ai_api_meta.html deleted file mode 100644 index 277b382..0000000 --- a/packages/base/docs/ai_api_client_sdk.models.ai_api_meta.html +++ /dev/null @@ -1,92 +0,0 @@ - - - - -Python: module ai_api_client_sdk.models.ai_api_meta - - - - - -
 
ai_api_client_sdk.models.ai_api_meta		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/ai_api_meta.py
-

-

- - - - - -
 
Classes
       
-
builtins.object -
-
-
AIAPIMeta -
-
-
-

- - - - - - - -
 
class AIAPIMeta(builtins.object)
   AIAPIMeta(
-    version: str,
-    capabilities: ai_api_client_sdk.models.ai_api_capabilities.AIAPICapabilities = None,
-    limits: ai_api_client_sdk.models.ai_api_limits.AIAPILimits = None,
-    **kwargs
-)
- 
-The AIAPIMeta object represents the metadata and capabilities of the AI API
- 
-:param version: version of the AI API
-:type version: str
-:param capabilities: capabilities of AI API, defaults to None
-:type capabilities: class:`ai_api_client_sdk.models.ai_api_capabilities.AIAPICapabilities`
-:param limits: limits of AI API, defaults to None
-:type limits: class:`ai_api_client_sdk.models.ai_api_limits.AIAPILimits`, optional
-:param `**kwargs`: The keyword arguments are there in case there are additional attributes returned from server
 
 Methods defined here:
-
__eq__(self, other)
Return self==value.
- -
__init__( - self, - version: str, - capabilities: ai_api_client_sdk.models.ai_api_capabilities.AIAPICapabilities = None, - limits: ai_api_client_sdk.models.ai_api_limits.AIAPILimits = None, - **kwargs -)
Initialize self.  See help(type(self)) for accurate signature.
- -
__str__(self)
Return str(self).
- -
-Static methods defined here:
-
from_dict(ai_api_meta_dict: Dict[str, Any])
Returns a :class:`ai_api_client_sdk.models.ai_api_meta.AIAPIMeta` object, created
-from the values in the dict provided as parameter
- 
-:param ai_api_meta_dict: Dict which includes the necessary values to create the object
-:type ai_api_meta_dict: Dict[str, Any]
-:return: An object, created from the values provided
-:rtype: class:`ai_api_client_sdk.models.ai_api_meta.AIAPIMeta`
- -
-Data descriptors defined here:
-
__dict__
-
dictionary for instance variables
-
-
__weakref__
-
list of weak references to the object
-
-
-Data and other attributes defined here:
-
__hash__ = None
- -

- - - - - -
 
Data
       Dict = typing.Dict
- \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.api_version.html b/packages/base/docs/ai_api_client_sdk.models.api_version.html deleted file mode 100644 index 5cb237d..0000000 --- a/packages/base/docs/ai_api_client_sdk.models.api_version.html +++ /dev/null @@ -1,92 +0,0 @@ - - - - -Python: module ai_api_client_sdk.models.api_version - - - - - -
 
ai_api_client_sdk.models.api_version		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/api_version.py
-

-

- - - - - -
 
Classes
       
-
builtins.object -
-
-
APIVersion -
-
-
-

- - - - - - - -
 
class APIVersion(builtins.object)
   APIVersion(
-    version_id: str = None,
-    url: str = None,
-    description: str = None,
-    **kwargs
-)
- 
-The APIVersion object represents the description of an API version
- 
-:param version_id: API version identifier, defaults to None
-:type version_id: str, optional
-:param url: URL of the API version, defaults to None
-:type url: str, optional
-:param description: API version description
-:type description: str, optional
-:param `**kwargs`: The keyword arguments are there in case there are additional attributes returned from server
 
 Methods defined here:
-
__eq__(self, other)
Return self==value.
- -
__init__( - self, - version_id: str = None, - url: str = None, - description: str = None, - **kwargs -)
Initialize self.  See help(type(self)) for accurate signature.
- -
__str__(self)
Return str(self).
- -
-Static methods defined here:
-
from_dict(api_version_dict: Dict[str, str])
Returns a :class:`ai_api_client_sdk.models.api_version.APIVersion` object, created from the
-values in the dict provided as parameter
- 
-:param api_version_dict: Dict which includes the necessary values to create the object
-:type api_version_dict: Dict[str, str]
-:return: An object, created from the values provided
-:rtype: class:`ai_api_client_sdk.models.api_version.APIVersion`
- -
-Data descriptors defined here:
-
__dict__
-
dictionary for instance variables
-
-
__weakref__
-
list of weak references to the object
-
-
-Data and other attributes defined here:
-
__hash__ = None
- -

- - - - - -
 
Data
       Dict = typing.Dict
- \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.artifact.html b/packages/base/docs/ai_api_client_sdk.models.artifact.html deleted file mode 100644 index 3d205c3..0000000 --- a/packages/base/docs/ai_api_client_sdk.models.artifact.html +++ /dev/null @@ -1,131 +0,0 @@ - - - - -Python: module ai_api_client_sdk.models.artifact - - - - - -
 
ai_api_client_sdk.models.artifact		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/artifact.py
-

-

- - - - - -
 
Classes
       
-
builtins.object -
-
-
Artifact -
-
-
-

- - - - - - - -
 
class Artifact(builtins.object)
   Artifact(
-    name: str,
-    id: str,
-    url: str,
-    kind: ai_api_client_sdk.models.artifact.Artifact.Kind,
-    scenario_id: str,
-    created_at: datetime.datetime,
-    modified_at: datetime.datetime,
-    execution_id: str = None,
-    configuration_id: str = None,
-    description: str = None,
-    labels: List[ai_api_client_sdk.models.label.Label] = None,
-    scenario: ai_api_client_sdk.models.scenario.Scenario = None,
-    **kwargs
-)
- 
-The Artifact object defines an artifact
- 
-:param name: Name of the artifact
-:type name: str
-:param id: ID of the artifact
-:type id: str
-:param url: URL of the artifact
-:type url: str
-:param kind: Kind of the artifact
-:type kind: class:`ai_api_client_sdk.models.artifact.Artifact.Kind`
-:param scenario_id: ID of the scenario which the artifact belongs to
-:type scenario_id: str
-:param created_at: Time when the artifact was created
-:type created_at: datetime
-:param modified_at: Time when the artifact was last modified
-:type modified_at: datetime
-:param execution_id: ID of the execution which the artifact resulted from, defaults to None
-:type execution_id: str, optional
-:param configuration_id: ID of the configuration which the artifact relates to, defaults to None
-:type configuration_id: str, optional
-:param description: Description of the artifact, defaults to None
-:type description: str, optional
-:param labels: List of the labels of the artifact, defaults to None
-:type labels: List[class:`ai_api_client_sdk.models.label.Label`]
-:param scenario: A dict, which gives detailed information on scenario, defaults to None
-:type scenario: class:`ai_api_client_sdk.models.scenario.Scenario`, optional
-:param `**kwargs`: The keyword arguments are there in case there are additional attributes returned from server
 
 Methods defined here:
-
__eq__(self, other)
Return self==value.
- -
__init__( - self, - name: str, - id: str, - url: str, - kind: ai_api_client_sdk.models.artifact.Artifact.Kind, - scenario_id: str, - created_at: datetime.datetime, - modified_at: datetime.datetime, - execution_id: str = None, - configuration_id: str = None, - description: str = None, - labels: List[ai_api_client_sdk.models.label.Label] = None, - scenario: ai_api_client_sdk.models.scenario.Scenario = None, - **kwargs -)
Initialize self.  See help(type(self)) for accurate signature.
- -
__str__(self)
Return str(self).
- -
-Static methods defined here:
-
from_dict(artifact_dict: Dict[str, Any])
Returns a :class:`ai_api_client_sdk.models.artifact.Artifact` object, created from the values in the dict
-provided as parameter
- 
-:param artifact_dict: Dict which includes the necessary values to create the object
-:type artifact_dict: Dict[str, Any]
-:return: An object, created from the values provided
-:rtype: class:`ai_api_client_sdk.models.artifact.Artifact`
- -
-Data descriptors defined here:
-
__dict__
-
dictionary for instance variables
-
-
__weakref__
-
list of weak references to the object
-
-
-Data and other attributes defined here:
-
Kind = <enum 'Kind'>
- -
__hash__ = None
- -

- - - - - -
 
Data
       Dict = typing.Dict
-List = typing.List
- \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.artifact_create_response.html b/packages/base/docs/ai_api_client_sdk.models.artifact_create_response.html deleted file mode 100644 index be8b014..0000000 --- a/packages/base/docs/ai_api_client_sdk.models.artifact_create_response.html +++ /dev/null @@ -1,82 +0,0 @@ - - - - -Python: module ai_api_client_sdk.models.artifact_create_response - - - - - -
 
ai_api_client_sdk.models.artifact_create_response		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/artifact_create_response.py
-

-

- - - - - -
 
Classes
       
-
ai_api_client_sdk.models.base_models.BasicResponse(builtins.object) -
-
-
ArtifactCreateResponse -
-
-
-

- - - - - - - -
 
class ArtifactCreateResponse(ai_api_client_sdk.models.base_models.BasicResponse)
   ArtifactCreateResponse(id: str, message: str, url: str, **kwargs)
- 
-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
 
 
Method resolution order:
-
ArtifactCreateResponse
-
ai_api_client_sdk.models.base_models.BasicResponse
-
builtins.object
-
-
-Methods defined here:
-
__init__(self, id: str, message: str, url: str, **kwargs)
Initialize self.  See help(type(self)) for accurate signature.
- -
-Static methods defined here:
-
from_dict(response_dict: Dict[str, Any])
Returns a :class:`ai_api_client_sdk.models.artifact_create_response.ArtifactCreateResponse` object, created
-from the values in the dict provided as parameter
- 
-:param response_dict: Dict which includes the necessary values to create the object
-:type response_dict: Dict[str, Any]
-:return: An object, created from the values provided
-:rtype: class:`ai_api_client_sdk.models.artifact_create_response.ArtifactCreateResponse`
- -
-Methods inherited from ai_api_client_sdk.models.base_models.BasicResponse:
-
__str__(self)
Return str(self).
- -
-Data descriptors inherited from ai_api_client_sdk.models.base_models.BasicResponse:
-
__dict__
-
dictionary for instance variables
-
-
__weakref__
-
list of weak references to the object
-
-

- - - - - -
 
Data
       Dict = typing.Dict
- \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.artifact_query_response.html b/packages/base/docs/ai_api_client_sdk.models.artifact_query_response.html deleted file mode 100644 index 57bec6d..0000000 --- a/packages/base/docs/ai_api_client_sdk.models.artifact_query_response.html +++ /dev/null @@ -1,90 +0,0 @@ - - - - -Python: module ai_api_client_sdk.models.artifact_query_response - - - - - -
 
ai_api_client_sdk.models.artifact_query_response		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/artifact_query_response.py
-

-

- - - - - -
 
Classes
       
-
ai_api_client_sdk.models.base_models.QueryResponse(builtins.object) -
-
-
ArtifactQueryResponse -
-
-
-

- - - - - - - -
 
class ArtifactQueryResponse(ai_api_client_sdk.models.base_models.QueryResponse)
   ArtifactQueryResponse(
-    resources: List[ai_api_client_sdk.models.artifact.Artifact],
-    count: int,
-    **kwargs
-)
- 
-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
 
 
Method resolution order:
-
ArtifactQueryResponse
-
ai_api_client_sdk.models.base_models.QueryResponse
-
builtins.object
-
-
-Methods defined here:
-
__init__( - self, - resources: List[ai_api_client_sdk.models.artifact.Artifact], - count: int, - **kwargs -)
Initialize self.  See help(type(self)) for accurate signature.
- -
-Static methods defined here:
-
from_dict(response_dict: Dict[str, Any])
Returns a :class:`ai_api_client_sdk.models.artifact_query_response.ArtifactQueryResponse` object, created
-from the values in the dict provided as parameter
- 
-:param response_dict: Dict which includes the necessary values to create the object
-:type response_dict: Dict[str, Any]
-:return: An object, created from the values provided
-:rtype: class:`ai_api_client_sdk.models.artifact_query_response.ArtifactQueryResponse`
- -
-Methods inherited from ai_api_client_sdk.models.base_models.QueryResponse:
-
__str__(self)
Return str(self).
- -
-Data descriptors inherited from ai_api_client_sdk.models.base_models.QueryResponse:
-
__dict__
-
dictionary for instance variables
-
-
__weakref__
-
list of weak references to the object
-
-

- - - - - -
 
Data
       Dict = typing.Dict
-List = typing.List
- \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.base_models.html b/packages/base/docs/ai_api_client_sdk.models.base_models.html deleted file mode 100644 index a069ebf..0000000 --- a/packages/base/docs/ai_api_client_sdk.models.base_models.html +++ /dev/null @@ -1,488 +0,0 @@ - - - - -Python: module ai_api_client_sdk.models.base_models - - - - - -
 
ai_api_client_sdk.models.base_models		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/base_models.py
-

-

- - - - - -
 
Classes
       
-
aenum._enum.Enum(enum.Enum) -
-
-
Operation -
-
-
builtins.object -
-
-
BasicErrorResponse -
BasicModifyRequest -
BasicResponse -
BulkModifyErrorResponse -
KeyValue -
Name -
NameValue -
QueryResponse -
-
-
enum.Enum(builtins.object) -
-
-
Order -
-
-
-

- - - - - - - -
 
class BasicErrorResponse(builtins.object)
   BasicErrorResponse(
-    code: str,
-    message: str,
-    request_id: str,
-    target: str,
-    details: Dict = None,
-    **kwargs
-)
- 
-The BasicErrorResponse object defines the response from the server
- 
-:param error_code: Error code from the server
-:type error_code: str
-:param message: Error message from the server
-:type message: str
-:param request_id: Request ID
-:type request_id: str  
-:param target: target
-:type target: str, optional
-:param details: Error details
-:type details: Dict, optional   
-:param `**kwargs`: The keyword arguments are there in case there are additional attributes returned from server
 
 Methods defined here:
-
__init__( - self, - code: str, - message: str, - request_id: str, - target: str, - details: Dict = None, - **kwargs -)
Initialize self.  See help(type(self)) for accurate signature.
- -
__str__(self)
Return str(self).
- -
-Static methods defined here:
-
from_dict(ber_dict: Dict[str, str])
Returns a :class:`ai_api_client_sdk.models.base_models.BasicErrorResponse` object, created from the values 
-provided as parameter
- 
-:param ber_dict: Dict which includes the necessary values to create the object
-:type ber_dict: Dict[str, str]
-:return: An object, created from the values provided
-:rtype: class:`ai_api_client_sdk.models.base_models.BasicErrorResponse`
- -
-Data descriptors defined here:
-
__dict__
-
dictionary for instance variables
-
-
__weakref__
-
list of weak references to the object
-
-

- - - - - - - -
 
class BasicModifyRequest(builtins.object)
   BasicModifyRequest(
-    id: str,
-    target_status: ai_api_client_sdk.models.target_status.TargetStatus,
-    **kwargs
-)
- 
-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
 
 Methods defined here:
-
__init__( - self, - id: str, - target_status: ai_api_client_sdk.models.target_status.TargetStatus, - **kwargs -)
Initialize self.  See help(type(self)) for accurate signature.
- -
__str__(self)
Return str(self).
- -
to_dict(self)
- -
-Data descriptors defined here:
-
__dict__
-
dictionary for instance variables
-
-
__weakref__
-
list of weak references to the object
-
-

- - - - - - - -
 
class BasicResponse(builtins.object)
   BasicResponse(id: str, message: str, **kwargs)
- 
-The BasicResponse object defines the response from the server
- 
-:param id: ID of the relevant resource
-:type id: str
-: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
 
 Methods defined here:
-
__init__(self, id: str, message: str, **kwargs)
Initialize self.  See help(type(self)) for accurate signature.
- -
__str__(self)
Return str(self).
- -
-Static methods defined here:
-
from_dict(br_dict: Dict[str, str])
Returns a :class:`ai_api_client_sdk.models.base_models.BasicResponse` object, created from the values in the
-dict provided as parameter
- 
-:param br_dict: Dict which includes the necessary values to create the object
-:type br_dict: Dict[str, str]
-:return: An object, created from the values provided
-:rtype: class:`ai_api_client_sdk.models.base_models.BasicResponse`
- -
-Data descriptors defined here:
-
__dict__
-
dictionary for instance variables
-
-
__weakref__
-
list of weak references to the object
-
-

- - - - - - - -
 
class BulkModifyErrorResponse(builtins.object)
   BulkModifyErrorResponse(
-    id: str,
-    error: ai_api_client_sdk.models.base_models.BasicErrorResponse,
-    **kwargs
-)
- 
-The BulkModifyErrorResponse object defines the error response from the server
 
 Methods defined here:
-
__init__( - self, - id: str, - error: ai_api_client_sdk.models.base_models.BasicErrorResponse, - **kwargs -)
Creates an error object for a bulk modification call
- 
-:param id: ID of the relevant resource
-:type id: str
-:param error: Error object response from the server
-:type error: BasicErrorResponse
-:param `**kwargs`: The keyword arguments are there in case there are additional attributes returned from server
- -
__str__(self)
Return str(self).
- -
-Static methods defined here:
-
from_dict(error_dict: Dict[str, Union[str, Dict]])
:param error_dict: Dict which includes the necessary values to create the object
-:type error_dict: Dict[str, Union[str, Dict]]
- 
-Returns:
-    Returns a class:`ai_api_client_sdk.models.base_models.BulkModifyErrorResponse` object
- -
-Data descriptors defined here:
-
__dict__
-
dictionary for instance variables
-
-
__weakref__
-
list of weak references to the object
-
-

- - - - - - - -
 
class KeyValue(builtins.object)
   KeyValue(key: str, value: str, **kwargs)
- 
-KeyValue object defines a key-value pair
- 
-:param key: key of the pair
-:type key: str
-:param value: value of the pair
-:type value: str
 
 Methods defined here:
-
__eq__(self, other)
Return self==value.
- -
__init__(self, key: str, value: str, **kwargs)
Initialize self.  See help(type(self)) for accurate signature.
- -
__str__(self)
Return str(self).
- -
to_dict(self)
- -
-Data descriptors defined here:
-
__dict__
-
dictionary for instance variables
-
-
__weakref__
-
list of weak references to the object
-
-
-Data and other attributes defined here:
-
__hash__ = None
- -

- - - - - - - -
 
class Name(builtins.object)
   Name(name: str, **kwargs)
- 
-KeyValue object defines a name
- 
-:param name: name
-:type name: str
 
 Methods defined here:
-
__eq__(self, other)
Return self==value.
- -
__init__(self, name: str, **kwargs)
Initialize self.  See help(type(self)) for accurate signature.
- -
__str__(self)
Return str(self).
- -
-Data descriptors defined here:
-
__dict__
-
dictionary for instance variables
-
-
__weakref__
-
list of weak references to the object
-
-
-Data and other attributes defined here:
-
__hash__ = None
- -

- - - - - - - -
 
class NameValue(builtins.object)
   NameValue(name: str, value: str, **kwargs)
- 
-KeyValue object defines a name-value pair
- 
-:param name: name of the pair
-:type name: str
-:param value: value of the pair
-:type value: str
 
 Methods defined here:
-
__eq__(self, other)
Return self==value.
- -
__init__(self, name: str, value: str, **kwargs)
Initialize self.  See help(type(self)) for accurate signature.
- -
__str__(self)
Return str(self).
- -
-Data descriptors defined here:
-
__dict__
-
dictionary for instance variables
-
-
__weakref__
-
list of weak references to the object
-
-
-Data and other attributes defined here:
-
__hash__ = None
- -

- - - - - - - -
 
class Operation(aenum._enum.Enum)
   Operation(*values)
- 
-An enumeration.
 
 
Method resolution order:
-
Operation
-
aenum._enum.Enum
-
enum.Enum
-
builtins.object
-
-
-Data and other attributes defined here:
-
CASCADE_UPDATE = <Operation.CASCADE_UPDATE: 'CASCADE-UPDATE'>
- -
CREATE = <Operation.CREATE: 'CREATE'>
- -
DELETE = <Operation.DELETE: 'DELETE'>
- -
UPDATE = <Operation.UPDATE: 'UPDATE'>
- -
-Class methods inherited from aenum._enum.Enum:
-
__init_subclass__(**kwds) from aenum._enum
This method is called when a class is subclassed.
- 
-The default implementation does nothing. It may be
-overridden to extend subclasses.
- -
-Data descriptors inherited from aenum._enum.Enum:
-
name
-
-
name
-
-
value
-
-
value
-
-
values
-
-
-Static methods inherited from aenum._enum.EnumType:
-
__contains__(value)
Return True if `value` is in `cls`.
- 
-`value` is in `cls` if:
-1) `value` is a member of `cls`, or
-2) `value` is the value of one of the `cls`'s members.
- -
__getitem__(name)
Return the member matching `name`.
- -
__iter__()
Return members in definition order.
- -
__len__()
Return the number of members (no aliases)
- -
-Readonly properties inherited from aenum._enum.EnumType:
-
__members__
-
Returns a mapping of member name->value.
- 
-This mapping lists all enum members, including aliases. Note that this
-is a copy of the internal mapping.
-
-

- - - - - - - -
 
class Order(enum.Enum)
   Order(*values)
- 
-
 
 
Method resolution order:
-
Order
-
enum.Enum
-
builtins.object
-
-
-Data and other attributes defined here:
-
ASC = <Order.ASC: 'asc'>
- -
DESC = <Order.DESC: 'desc'>
- -
-Data descriptors inherited from enum.Enum:
-
name
-
The name of the Enum member.
-
-
value
-
The value of the Enum member.
-
-
-Static methods inherited from enum.EnumType:
-
__contains__(value)
Return True if `value` is in `cls`.
- 
-`value` is in `cls` if:
-1) `value` is a member of `cls`, or
-2) `value` is the value of one of the `cls`'s members.
-3) `value` is a pseudo-member (flags)
- -
__getitem__(name)
Return the member matching `name`.
- -
__iter__()
Return members in definition order.
- -
__len__()
Return the number of members (no aliases)
- -
-Readonly properties inherited from enum.EnumType:
-
__members__
-
Returns a mapping of member name->value.
- 
-This mapping lists all enum members, including aliases.  Note that
-this is a read-only view of the internal mapping.
-
-

- - - - - - - -
 
class QueryResponse(builtins.object)
   QueryResponse(resources: list, count: int, **kwargs)
- 
-The QueryResponse object defines the response from the server to a query request
- 
-:param resources: List of the resources returned from the server
-:type resources: list
-:param count: Total number of the queried resources
-:type count: int
-:param `**kwargs`: The keyword arguments are there in case there are additional attributes returned from server
 
 Methods defined here:
-
__init__(self, resources: list, count: int, **kwargs)
Initialize self.  See help(type(self)) for accurate signature.
- -
__str__(self)
Return str(self).
- -
-Data descriptors defined here:
-
__dict__
-
dictionary for instance variables
-
-
__weakref__
-
list of weak references to the object
-
-

- - - - - -
 
Data
       Dict = typing.Dict
-Union = typing.Union
- \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.capabilities.html b/packages/base/docs/ai_api_client_sdk.models.capabilities.html deleted file mode 100644 index f318d79..0000000 --- a/packages/base/docs/ai_api_client_sdk.models.capabilities.html +++ /dev/null @@ -1,94 +0,0 @@ - - - - -Python: module ai_api_client_sdk.models.capabilities - - - - - -
 
ai_api_client_sdk.models.capabilities		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/capabilities.py
-

-

- - - - - -
 
Classes
       
-
builtins.object -
-
-
Capabilities -
-
-
-

- - - - - - - -
 
class Capabilities(builtins.object)
   Capabilities(
-    ai_api: ai_api_client_sdk.models.ai_api_meta.AIAPIMeta,
-    runtime_identifier: str = None,
-    runtime_api_version: str = None,
-    description: str = None,
-    extensions: ai_api_client_sdk.models.extensions.Extensions = None,
-    **kwargs
-)
- 
-The Capabilities object represents the metadata and capabilities of, and extensions to the AI API
- 
-:param ai_api: Metadata and capabilities of the AI API
-:type ai_api: class:`ai_api_client_sdk.models.ai_api_meta.AIAPIMeta`
-:param runtime_identifier: The name of runtime, defaults to None
-:type runtime_identifier: str, optional
-:param runtime_api_version: The version of the runtime, defaults to None
-:type runtime_api_version: str, optional
-:param description: description, defaults to None
-:type description: str, optional
-:param extensions: Extensions to the AI API, defaults to None
-:type extensions: class:`ai_api_client_sdk.models.extensions.Extensions`, optional
-:param `**kwargs`: The keyword arguments are there in case there are additional attributes returned from server
 
 Methods defined here:
-
__init__( - self, - ai_api: ai_api_client_sdk.models.ai_api_meta.AIAPIMeta, - runtime_identifier: str = None, - runtime_api_version: str = None, - description: str = None, - extensions: ai_api_client_sdk.models.extensions.Extensions = None, - **kwargs -)
Initialize self.  See help(type(self)) for accurate signature.
- -
__str__(self)
Return str(self).
- -
-Static methods defined here:
-
from_dict(capabilities_dict: Dict[str, Any])
Returns a :class:`ai_api_client_sdk.models.capabilities.Capabilities` object, created
-from the values in the dict provided as parameter
- 
-:param capabilities_dict: Dict which includes the necessary values to create the object
-:type capabilities_dict: Dict[str, Any]
-:return: An object, created from the values provided
-:rtype: class:`ai_api_client_sdk.models.capabilities.Capabilities`
- -
-Data descriptors defined here:
-
__dict__
-
dictionary for instance variables
-
-
__weakref__
-
list of weak references to the object
-
-

- - - - - -
 
Data
       Dict = typing.Dict
- \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.configuration.html b/packages/base/docs/ai_api_client_sdk.models.configuration.html deleted file mode 100644 index 089765b..0000000 --- a/packages/base/docs/ai_api_client_sdk.models.configuration.html +++ /dev/null @@ -1,108 +0,0 @@ - - - - -Python: module ai_api_client_sdk.models.configuration - - - - - -
 
ai_api_client_sdk.models.configuration		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/configuration.py
-

-

- - - - - -
 
Classes
       
-
builtins.object -
-
-
Configuration -
-
-
-

- - - - - - - -
 
class Configuration(builtins.object)
   Configuration(
-    id: str,
-    name: str,
-    scenario_id: str,
-    executable_id: str,
-    created_at: datetime.datetime,
-    parameter_bindings: List[ai_api_client_sdk.models.parameter_binding.ParameterBinding] = None,
-    input_artifact_bindings: List[ai_api_client_sdk.models.input_artifact_binding.InputArtifactBinding] = None,
-    scenario: ai_api_client_sdk.models.scenario.Scenario = None,
-    **kwargs
-)
- 
-The Configuration object defines a configuration
- 
-:param id: ID of the configuration
-:type id: str
-:param name: Name of the configuration
-:type name: str
-:param scenario_id: ID of the scenario which the configuration belongs to
-:type scenario_id: str
-:param executable_id: ID of the executable, which is configured
-:type executable_id: str
-:param created_at: Time when the configuration was created
-:type created_at: datetime
-:param parameter_bindings: List of the input parameters defined as key-value pairs, defaults to None
-:type parameter_bindings: List[class:`ai_api_client_sdk.models.parameter_binding.ParameterBinding`], optional
-:param input_artifact_bindings: List of the input artifacts which are to be used by the executable, defaults to None
-:type input_artifact_bindings: List[class:`ai_api_client_sdk.models.input_artifact_binding.InputArtifactBinding`],
-    optional
-:param scenario: A dict, which gives detailed information on scenario, defaults to None
-:type scenario: class:`ai_api_client_sdk.models.scenario.Scenario`, optional
-:param `**kwargs`: The keyword arguments are there in case there are additional attributes returned from server
 
 Methods defined here:
-
__init__( - self, - id: str, - name: str, - scenario_id: str, - executable_id: str, - created_at: datetime.datetime, - parameter_bindings: List[ai_api_client_sdk.models.parameter_binding.ParameterBinding] = None, - input_artifact_bindings: List[ai_api_client_sdk.models.input_artifact_binding.InputArtifactBinding] = None, - scenario: ai_api_client_sdk.models.scenario.Scenario = None, - **kwargs -)
Initialize self.  See help(type(self)) for accurate signature.
- -
__str__(self)
Return str(self).
- -
-Static methods defined here:
-
from_dict(configuration_dict: Dict[str, Any])
Returns a :class:`ai_api_client_sdk.models.configuration.Configuration` object, created from the values in the
-dict provided as parameter
- 
-:param configuration_dict: Dict which includes the necessary values to create the object
-:type configuration_dict: Dict[str, Any]
-:return: An object, created from the values provided
-:rtype: class:`ai_api_client_sdk.models.configuration.Configuration`
- -
-Data descriptors defined here:
-
__dict__
-
dictionary for instance variables
-
-
__weakref__
-
list of weak references to the object
-
-

- - - - - -
 
Data
       Dict = typing.Dict
-List = typing.List
- \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.configuration_create_response.html b/packages/base/docs/ai_api_client_sdk.models.configuration_create_response.html deleted file mode 100644 index 40d0605..0000000 --- a/packages/base/docs/ai_api_client_sdk.models.configuration_create_response.html +++ /dev/null @@ -1,74 +0,0 @@ - - - - -Python: module ai_api_client_sdk.models.configuration_create_response - - - - - -
 
ai_api_client_sdk.models.configuration_create_response		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/configuration_create_response.py
-

-

- - - - - -
 
Classes
       
-
ai_api_client_sdk.models.base_models.BasicResponse(builtins.object) -
-
-
ConfigurationCreateResponse -
-
-
-

- - - - - - - -
 
class ConfigurationCreateResponse(ai_api_client_sdk.models.base_models.BasicResponse)
   ConfigurationCreateResponse(id: str, message: str, **kwargs)
- 
-The ConfigurationCreateResponse object defines the response of the configuration create request. Refer to
-:class:`ai_api_client_sdk.models.base_models.BasicResponse`, for the object definition
 
 
Method resolution order:
-
ConfigurationCreateResponse
-
ai_api_client_sdk.models.base_models.BasicResponse
-
builtins.object
-
-
-Static methods defined here:
-
from_dict(response_dict: Dict[str, Any])
Returns a :class:`ai_api_client_sdk.models.configuration_create_response.ConfigurationCreateResponse` object,
-created from the values in the dict provided as parameter
- 
-:param response_dict: Dict which includes the necessary values to create the object
-:type response_dict: Dict[str, Any]
-:return: An object, created from the values provided
-:rtype: class:`ai_api_client_sdk.models.configuration_create_response.ConfigurationCreateResponse`
- -
-Methods inherited from ai_api_client_sdk.models.base_models.BasicResponse:
-
__init__(self, id: str, message: str, **kwargs)
Initialize self.  See help(type(self)) for accurate signature.
- -
__str__(self)
Return str(self).
- -
-Data descriptors inherited from ai_api_client_sdk.models.base_models.BasicResponse:
-
__dict__
-
dictionary for instance variables
-
-
__weakref__
-
list of weak references to the object
-
-

- - - - - -
 
Data
       Dict = typing.Dict
- \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.configuration_query_response.html b/packages/base/docs/ai_api_client_sdk.models.configuration_query_response.html deleted file mode 100644 index 3b8b254..0000000 --- a/packages/base/docs/ai_api_client_sdk.models.configuration_query_response.html +++ /dev/null @@ -1,90 +0,0 @@ - - - - -Python: module ai_api_client_sdk.models.configuration_query_response - - - - - -
 
ai_api_client_sdk.models.configuration_query_response		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/configuration_query_response.py
-

-

- - - - - -
 
Classes
       
-
ai_api_client_sdk.models.base_models.QueryResponse(builtins.object) -
-
-
ConfigurationQueryResponse -
-
-
-

- - - - - - - -
 
class ConfigurationQueryResponse(ai_api_client_sdk.models.base_models.QueryResponse)
   ConfigurationQueryResponse(
-    resources: List[ai_api_client_sdk.models.configuration.Configuration],
-    count: int,
-    **kwargs
-)
- 
-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
 
 
Method resolution order:
-
ConfigurationQueryResponse
-
ai_api_client_sdk.models.base_models.QueryResponse
-
builtins.object
-
-
-Methods defined here:
-
__init__( - self, - resources: List[ai_api_client_sdk.models.configuration.Configuration], - count: int, - **kwargs -)
Initialize self.  See help(type(self)) for accurate signature.
- -
-Static methods defined here:
-
from_dict(response_dict: Dict[str, Any])
Returns a :class:`ai_api_client_sdk.models.configuration_query_response.ConfigurationQueryResponse` object,
-created from the values in the dict provided as parameter
- 
-:param response_dict: Dict which includes the necessary values to create the object
-:type response_dict: Dict[str, Any]
-:return: An object, created from the values provided
-:rtype: class:`ai_api_client_sdk.models.configuration_query_response.ConfigurationQueryResponse`
- -
-Methods inherited from ai_api_client_sdk.models.base_models.QueryResponse:
-
__str__(self)
Return str(self).
- -
-Data descriptors inherited from ai_api_client_sdk.models.base_models.QueryResponse:
-
__dict__
-
dictionary for instance variables
-
-
__weakref__
-
list of weak references to the object
-
-

- - - - - -
 
Data
       Dict = typing.Dict
-List = typing.List
- \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.dataset_capabilities.html b/packages/base/docs/ai_api_client_sdk.models.dataset_capabilities.html deleted file mode 100644 index 65e16df..0000000 --- a/packages/base/docs/ai_api_client_sdk.models.dataset_capabilities.html +++ /dev/null @@ -1,92 +0,0 @@ - - - - -Python: module ai_api_client_sdk.models.dataset_capabilities - - - - - -
 
ai_api_client_sdk.models.dataset_capabilities		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/dataset_capabilities.py
-

-

- - - - - -
 
Classes
       
-
builtins.object -
-
-
DatasetCapabilities -
-
-
-

- - - - - - - -
 
class DatasetCapabilities(builtins.object)
   DatasetCapabilities(
-    upload: bool = True,
-    download: bool = True,
-    delete: bool = True,
-    **kwargs
-)
- 
-The DatasetCapabilities object represents the capabilities of the Dataset API
- 
-:param upload: indicates whether uploading files is supported, defaults to True
-:type upload: bool, optional
-:param download: indicates whether downloading files is supported, defaults to True
-:type download: bool, optional
-:param delete: indicates whether deleting files is supported, defaults to True
-:type delete: bool, optional
-:param `**kwargs`: The keyword arguments are there in case there are additional attributes returned from server
 
 Methods defined here:
-
__eq__(self, other)
Return self==value.
- -
__init__( - self, - upload: bool = True, - download: bool = True, - delete: bool = True, - **kwargs -)
Initialize self.  See help(type(self)) for accurate signature.
- -
__str__(self)
Return str(self).
- -
-Static methods defined here:
-
from_dict(dataset_capabilities_dict: Dict[str, bool])
Returns a :class:`ai_api_client_sdk.models.dataset_capabilities.DatasetCapabilities` object, created from
-the values in the dict provided as parameter
- 
-:param dataset_capabilities_dict: Dict which includes the necessary values to create the object
-:type dataset_capabilities_dict: Dict[str, bool]
-:return: An object, created from the values provided
-:rtype: class:`ai_api_client_sdk.models.dataset_capabilities.DatasetCapabilities`
- -
-Data descriptors defined here:
-
__dict__
-
dictionary for instance variables
-
-
__weakref__
-
list of weak references to the object
-
-
-Data and other attributes defined here:
-
__hash__ = None
- -

- - - - - -
 
Data
       Dict = typing.Dict
- \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.dataset_limits.html b/packages/base/docs/ai_api_client_sdk.models.dataset_limits.html deleted file mode 100644 index 84c9ee9..0000000 --- a/packages/base/docs/ai_api_client_sdk.models.dataset_limits.html +++ /dev/null @@ -1,88 +0,0 @@ - - - - -Python: module ai_api_client_sdk.models.dataset_limits - - - - - -
 
ai_api_client_sdk.models.dataset_limits		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/dataset_limits.py
-

-

- - - - - -
 
Classes
       
-
builtins.object -
-
-
DatasetLimits -
-
-
-

- - - - - - - -
 
class DatasetLimits(builtins.object)
   DatasetLimits(
-    max_upload_file_size: int = 104857600,
-    max_files_per_dataset: int = -1,
-    **kwargs
-)
- 
-The DatasetLimits object represents the limits of the Dataset API
- 
-:param max_upload_file_size: Max size (in bytes) of a single uploaded file, defaults to 104857600
-:type max_upload_file_size: int, optional
-:param max_files_per_dataset: Max number of files per dataset. <0 means unlimited, defaults to -1
-:type max_files_per_dataset: int, optional
-:param `**kwargs`: The keyword arguments are there in case there are additional attributes returned from server
 
 Methods defined here:
-
__eq__(self, other)
Return self==value.
- -
__init__( - self, - max_upload_file_size: int = 104857600, - max_files_per_dataset: int = -1, - **kwargs -)
Initialize self.  See help(type(self)) for accurate signature.
- -
__str__(self)
Return str(self).
- -
-Static methods defined here:
-
from_dict(dataset_limits_dict: Dict[str, int])
Returns a :class:`ai_api_client_sdk.models.dataset_limits.DatasetLimits` object, created from the values in
-the dict provided as parameter
- 
-:param dataset_limits_dict: Dict which includes the necessary values to create the object
-:type dataset_limits_dict: Dict[str, int]
-:return: An object, created from the values provided
-:rtype: class:`ai_api_client_sdk.models.dataset_limits.DatasetLimits`
- -
-Data descriptors defined here:
-
__dict__
-
dictionary for instance variables
-
-
__weakref__
-
list of weak references to the object
-
-
-Data and other attributes defined here:
-
__hash__ = None
- -

- - - - - -
 
Data
       Dict = typing.Dict
- \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.deployment.html b/packages/base/docs/ai_api_client_sdk.models.deployment.html deleted file mode 100644 index 0e2b167..0000000 --- a/packages/base/docs/ai_api_client_sdk.models.deployment.html +++ /dev/null @@ -1,160 +0,0 @@ - - - - -Python: module ai_api_client_sdk.models.deployment - - - - - -
 
ai_api_client_sdk.models.deployment		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/deployment.py
-

-

- - - - - -
 
Modules
       
humps
-

- - - - - -
 
Classes
       
-
ai_api_client_sdk.models.enactment.Enactment(builtins.object) -
-
-
Deployment -
-
-
-

- - - - - - - -
 
class Deployment(ai_api_client_sdk.models.enactment.Enactment)
   Deployment(
-    id: str,
-    deployment_url: str,
-    configuration_id: str,
-    configuration_name: str,
-    scenario_id: str,
-    status: ai_api_client_sdk.models.status.Status,
-    target_status: ai_api_client_sdk.models.target_status.TargetStatus,
-    created_at: datetime.datetime,
-    modified_at: datetime.datetime,
-    status_message: str = None,
-    status_details: Dict[str, Any] = None,
-    details: Dict[str, Any] = None,
-    submission_time: datetime.datetime = None,
-    start_time: datetime.datetime = None,
-    completion_time: datetime.datetime = None,
-    last_operation: ai_api_client_sdk.models.base_models.Operation = None,
-    latest_running_configuration_id: str = None,
-    ttl: str = None,
-    **kwargs
-)
- 
-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
-:type details: Dict[str, Any], optional
-:param submission_time: Time when the deployment was submitted
-:type submission_time: datetime, optional
-:param start_time: Time when the deployment status changed to RUNNING
-:type start_time: datetime, optional
-:param completion_time: Time when the deployment status changed to DEAD/STOPPED
-:type completion_time: datetime, optional
-:param last_operation: Last operation applied to the deployment
-:type last_operation: Operation, optional
-:param latest_running_configuration_id: The configuration ID that was running, before a PATCH operation has modified
-    the configuration ID of the deployment.
-:type latest_running_configuration_id: str, optional
-:param ttl: Time to live for a deployment
-:type ttl: str, optional
-:param `**kwargs`: The keyword arguments are there in case there are additional attributes returned from server
 
 
Method resolution order:
-
Deployment
-
ai_api_client_sdk.models.enactment.Enactment
-
builtins.object
-
-
-Methods defined here:
-
__init__( - self, - id: str, - deployment_url: str, - configuration_id: str, - configuration_name: str, - scenario_id: str, - status: ai_api_client_sdk.models.status.Status, - target_status: ai_api_client_sdk.models.target_status.TargetStatus, - created_at: datetime.datetime, - modified_at: datetime.datetime, - status_message: str = None, - status_details: Dict[str, Any] = None, - details: Dict[str, Any] = None, - submission_time: datetime.datetime = None, - start_time: datetime.datetime = None, - completion_time: datetime.datetime = None, - last_operation: ai_api_client_sdk.models.base_models.Operation = None, - latest_running_configuration_id: str = None, - ttl: str = None, - **kwargs -)
Initialize self.  See help(type(self)) for accurate signature.
- -
__str__(self)
Return str(self).
- -
-Static methods defined here:
-
from_dict(deployment_dict: Dict[str, Any])
Returns a :class:`ai_api_client_sdk.models.deployment.Deployment` 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.Deployment`
- -
-Data descriptors inherited from ai_api_client_sdk.models.enactment.Enactment:
-
__dict__
-
dictionary for instance variables
-
-
__weakref__
-
list of weak references to the object
-
-

- - - - - -
 
Data
       Dict = typing.Dict
- \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.deployment_bulk_modify_response.html b/packages/base/docs/ai_api_client_sdk.models.deployment_bulk_modify_response.html deleted file mode 100644 index 00d5478..0000000 --- a/packages/base/docs/ai_api_client_sdk.models.deployment_bulk_modify_response.html +++ /dev/null @@ -1,78 +0,0 @@ - - - - -Python: module ai_api_client_sdk.models.deployment_bulk_modify_response - - - - - -
 
ai_api_client_sdk.models.deployment_bulk_modify_response		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/deployment_bulk_modify_response.py
-

-

- - - - - -
 
Classes
       
-
builtins.object -
-
-
DeploymentBulkModifyResponse -
-
-
-

- - - - - - - -
 
class DeploymentBulkModifyResponse(builtins.object)
   DeploymentBulkModifyResponse(
-    deployments: List[Union[ai_api_client_sdk.models.base_models.BasicResponse, ai_api_client_sdk.models.base_models.BulkModifyErrorResponse]],
-    **kwargs
-)
- 
-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]]
 
 Methods defined here:
-
__init__( - self, - deployments: List[Union[ai_api_client_sdk.models.base_models.BasicResponse, ai_api_client_sdk.models.base_models.BulkModifyErrorResponse]], - **kwargs -)
Initialize self.  See help(type(self)) for accurate signature.
- -
__str__(self)
Return str(self).
- -
-Static methods defined here:
-
from_dict(response_dict: Dict[str, List[Dict[str, Union[str, Dict]]]])
Returns a :class:`ai_api_client_sdk.models.Deployment_Bulk_Modify_Response.DeploymentBulkModifyResponse`
-object, created from the values provided as parameter
- 
-:param response_dict: Which includes the necessary values to create the object
-:type response_dict: Dict[str, List[Dict[str, Union[str, Dict]]]]
-:return: An object, created from the values provided
-:rtype: class:`ai_api_client_sdk.models.Deployment_Bulk_Modify_Response.DeploymentBulkModifyResponse`
- -
-Data descriptors defined here:
-
__dict__
-
dictionary for instance variables
-
-
__weakref__
-
list of weak references to the object
-
-

- - - - - -
 
Data
       Dict = typing.Dict
-List = typing.List
-Union = typing.Union
- \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.deployment_create_response.html b/packages/base/docs/ai_api_client_sdk.models.deployment_create_response.html deleted file mode 100644 index c719b0b..0000000 --- a/packages/base/docs/ai_api_client_sdk.models.deployment_create_response.html +++ /dev/null @@ -1,101 +0,0 @@ - - - - -Python: module ai_api_client_sdk.models.deployment_create_response - - - - - -
 
ai_api_client_sdk.models.deployment_create_response		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/deployment_create_response.py
-

-

- - - - - -
 
Classes
       
-
ai_api_client_sdk.models.base_models.BasicResponse(builtins.object) -
-
-
DeploymentCreateResponse -
-
-
-

- - - - - - - -
 
class DeploymentCreateResponse(ai_api_client_sdk.models.base_models.BasicResponse)
   DeploymentCreateResponse(
-    id: str,
-    message: str,
-    deployment_url: str,
-    status: ai_api_client_sdk.models.status.Status,
-    ttl: str = None,
-    **kwargs
-)
- 
-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
 
 
Method resolution order:
-
DeploymentCreateResponse
-
ai_api_client_sdk.models.base_models.BasicResponse
-
builtins.object
-
-
-Methods defined here:
-
__init__( - self, - id: str, - message: str, - deployment_url: str, - status: ai_api_client_sdk.models.status.Status, - ttl: str = None, - **kwargs -)
Initialize self.  See help(type(self)) for accurate signature.
- -
-Static methods defined here:
-
from_dict(response_dict: Dict[str, Any])
Returns a :class:`ai_api_client_sdk.models.deployment_create_response.DeploymentCreateResponse` object,
-created from the values in the dict provided as parameter
- 
-:param response_dict: Dict which includes the necessary values to create the object
-:type response_dict: Dict[str, Any]
-:return: An object, created from the values provided
-:rtype: class:`ai_api_client_sdk.models.deployment_create_response.DeploymentCreateResponse`
- -
-Methods inherited from ai_api_client_sdk.models.base_models.BasicResponse:
-
__str__(self)
Return str(self).
- -
-Data descriptors inherited from ai_api_client_sdk.models.base_models.BasicResponse:
-
__dict__
-
dictionary for instance variables
-
-
__weakref__
-
list of weak references to the object
-
-

- - - - - -
 
Data
       Dict = typing.Dict
- \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.deployment_get_status_response.html b/packages/base/docs/ai_api_client_sdk.models.deployment_get_status_response.html deleted file mode 100644 index c4ef313..0000000 --- a/packages/base/docs/ai_api_client_sdk.models.deployment_get_status_response.html +++ /dev/null @@ -1,101 +0,0 @@ - - - - -Python: module ai_api_client_sdk.models.deployment_get_status_response - - - - - -
 
ai_api_client_sdk.models.deployment_get_status_response		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/deployment_get_status_response.py
-

-

- - - - - -
 
Classes
       
-
ai_api_client_sdk.models.enactment_get_status_response.EnactmentGetStatusResponse(builtins.object) -
-
-
DeploymentGetStatusResponse -
-
-
-

- - - - - - - -
 
class DeploymentGetStatusResponse(ai_api_client_sdk.models.enactment_get_status_response.EnactmentGetStatusResponse)
   DeploymentGetStatusResponse(
-    id: str,
-    configuration_id: str,
-    status: ai_api_client_sdk.models.status.Status,
-    created_at: datetime.datetime,
-    modified_at: datetime.datetime,
-    status_details: Dict[str, Any] = None,
-    details: Dict[str, Any] = None
-)
- 
-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
 
 
Method resolution order:
-
DeploymentGetStatusResponse
-
ai_api_client_sdk.models.enactment_get_status_response.EnactmentGetStatusResponse
-
builtins.object
-
-
-Methods defined here:
-
__init__( - self, - id: str, - configuration_id: str, - status: ai_api_client_sdk.models.status.Status, - created_at: datetime.datetime, - modified_at: datetime.datetime, - status_details: Dict[str, Any] = None, - details: Dict[str, Any] = None -)
Initialize self.  See help(type(self)) for accurate signature.
- -
__str__(self)
Return str(self).
- -
-Static methods defined here:
-
from_dict(deployment_dict: Dict[str, Any])
Returns a :class:`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`
- -
-Data descriptors inherited from ai_api_client_sdk.models.enactment_get_status_response.EnactmentGetStatusResponse:
-
__dict__
-
dictionary for instance variables
-
-
__weakref__
-
list of weak references to the object
-
-

- - - - - -
 
Data
       Dict = typing.Dict
- \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.deployment_query_response.html b/packages/base/docs/ai_api_client_sdk.models.deployment_query_response.html deleted file mode 100644 index 4c24576..0000000 --- a/packages/base/docs/ai_api_client_sdk.models.deployment_query_response.html +++ /dev/null @@ -1,90 +0,0 @@ - - - - -Python: module ai_api_client_sdk.models.deployment_query_response - - - - - -
 
ai_api_client_sdk.models.deployment_query_response		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/deployment_query_response.py
-

-

- - - - - -
 
Classes
       
-
ai_api_client_sdk.models.base_models.QueryResponse(builtins.object) -
-
-
DeploymentQueryResponse -
-
-
-

- - - - - - - -
 
class DeploymentQueryResponse(ai_api_client_sdk.models.base_models.QueryResponse)
   DeploymentQueryResponse(
-    resources: List[ai_api_client_sdk.models.deployment.Deployment],
-    count: int,
-    **kwargs
-)
- 
-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
 
 
Method resolution order:
-
DeploymentQueryResponse
-
ai_api_client_sdk.models.base_models.QueryResponse
-
builtins.object
-
-
-Methods defined here:
-
__init__( - self, - resources: List[ai_api_client_sdk.models.deployment.Deployment], - count: int, - **kwargs -)
Initialize self.  See help(type(self)) for accurate signature.
- -
-Static methods defined here:
-
from_dict(response_dict: Dict[str, Any])
Returns a :class:`ai_api_client_sdk.models.deployment_query_response.DeploymentQueryResponse` object, created 
-from the values in the dict provided as parameter
- 
-:param response_dict: Dict which includes the necessary values to create the object
-:type response_dict: Dict[str, Any]
-:return: An object, created from the values provided
-:rtype: class:`ai_api_client_sdk.models.deployment_query_response.DeploymentQueryResponse`
- -
-Methods inherited from ai_api_client_sdk.models.base_models.QueryResponse:
-
__str__(self)
Return str(self).
- -
-Data descriptors inherited from ai_api_client_sdk.models.base_models.QueryResponse:
-
__dict__
-
dictionary for instance variables
-
-
__weakref__
-
list of weak references to the object
-
-

- - - - - -
 
Data
       Dict = typing.Dict
-List = typing.List
- \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.enactment.html b/packages/base/docs/ai_api_client_sdk.models.enactment.html deleted file mode 100644 index 106d478..0000000 --- a/packages/base/docs/ai_api_client_sdk.models.enactment.html +++ /dev/null @@ -1,116 +0,0 @@ - - - - -Python: module ai_api_client_sdk.models.enactment - - - - - -
 
ai_api_client_sdk.models.enactment		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/enactment.py
-

-

- - - - - -
 
Classes
       
-
builtins.object -
-
-
Enactment -
-
-
-

- - - - - - - -
 
class Enactment(builtins.object)
   Enactment(
-    id: str,
-    configuration_id: str,
-    configuration_name,
-    scenario_id: str,
-    status: ai_api_client_sdk.models.status.Status,
-    target_status: ai_api_client_sdk.models.target_status.TargetStatus,
-    created_at: datetime.datetime,
-    modified_at: datetime.datetime,
-    status_message: str = None,
-    status_details: Dict[str, Any] = None,
-    submission_time: datetime.datetime = None,
-    start_time: datetime.datetime = None,
-    completion_time: datetime.datetime = None,
-    **kwargs
-)
- 
-Enactment object is base class for Execution/Deployment, defining their common attributes
- 
-: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 configuration_name: Name of the configuration which configured the enactment
-:type configuration_name: str
-:param scenario_id: ID of the scenario which the enactment belongs to
-:type scenario_id: str
-:param status: Status of the enactment
-:type status: class:`ai_api_client_sdk.models.status.Status`
-:param target_status: Target status of the enactment
-:type target_status: class:`ai_api_client_sdk.models.target_status.TargetStatus`
-: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_message: A string, which gives information about the status of the enactment, defaults to None
-:type status_message: str, optional
-: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
-:param submission_time: Time when the enactment was submitted
-:type submission_time: datetime, optional
-:param start_time: Time when the enactment status changed to RUNNING
-:type start_time: datetime, optional
-:param completion_time: Time when the enactment status changed to COMPLETED/DEAD/STOPPED
-:type completion_time: datetime, optional
-:param `**kwargs`: The keyword arguments are there in case there are additional attributes returned from server
 
 Methods defined here:
-
__init__( - self, - id: str, - configuration_id: str, - configuration_name, - scenario_id: str, - status: ai_api_client_sdk.models.status.Status, - target_status: ai_api_client_sdk.models.target_status.TargetStatus, - created_at: datetime.datetime, - modified_at: datetime.datetime, - status_message: str = None, - status_details: Dict[str, Any] = None, - submission_time: datetime.datetime = None, - start_time: datetime.datetime = None, - completion_time: datetime.datetime = None, - **kwargs -)
Initialize self.  See help(type(self)) for accurate signature.
- -
__str__(self)
Return str(self).
- -
-Data descriptors defined here:
-
__dict__
-
dictionary for instance variables
-
-
__weakref__
-
list of weak references to the object
-
-

- - - - - -
 
Data
       Dict = typing.Dict
- \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.enactment_get_status_response.html b/packages/base/docs/ai_api_client_sdk.models.enactment_get_status_response.html deleted file mode 100644 index 6be4fb6..0000000 --- a/packages/base/docs/ai_api_client_sdk.models.enactment_get_status_response.html +++ /dev/null @@ -1,84 +0,0 @@ - - - - -Python: module ai_api_client_sdk.models.enactment_get_status_response - - - - - -
 
ai_api_client_sdk.models.enactment_get_status_response		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/enactment_get_status_response.py
-

-

- - - - - -
 
Classes
       
-
builtins.object -
-
-
EnactmentGetStatusResponse -
-
-
-

- - - - - - - -
 
class EnactmentGetStatusResponse(builtins.object)
   EnactmentGetStatusResponse(
-    id: str,
-    configuration_id: str,
-    status: ai_api_client_sdk.models.status.Status,
-    created_at: datetime.datetime,
-    modified_at: datetime.datetime,
-    status_details: Dict[str, Any] = None
-)
- 
-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
 
 Methods defined here:
-
__init__( - self, - id: str, - configuration_id: str, - status: ai_api_client_sdk.models.status.Status, - created_at: datetime.datetime, - modified_at: datetime.datetime, - status_details: Dict[str, Any] = None -)
Initialize self.  See help(type(self)) for accurate signature.
- -
__str__(self)
Return str(self).
- -
-Data descriptors defined here:
-
__dict__
-
dictionary for instance variables
-
-
__weakref__
-
list of weak references to the object
-
-

- - - - - -
 
Data
       Dict = typing.Dict
- \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.executable.html b/packages/base/docs/ai_api_client_sdk.models.executable.html deleted file mode 100644 index 2e2ff5a..0000000 --- a/packages/base/docs/ai_api_client_sdk.models.executable.html +++ /dev/null @@ -1,128 +0,0 @@ - - - - -Python: module ai_api_client_sdk.models.executable - - - - - -
 
ai_api_client_sdk.models.executable		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/executable.py
-

-

- - - - - -
 
Classes
       
-
builtins.object -
-
-
Executable -
-
-
-

- - - - - - - -
 
class Executable(builtins.object)
   Executable(
-    id: str,
-    scenario_id: str,
-    version_id: str,
-    name: str,
-    deployable: bool,
-    created_at: datetime.datetime,
-    modified_at: datetime.datetime,
-    description: str = None,
-    parameters: List[ai_api_client_sdk.models.parameter.Parameter] = None,
-    input_artifacts: List[ai_api_client_sdk.models.input_artifact.InputArtifact] = None,
-    output_artifacts: List[ai_api_client_sdk.models.output_artifact.OutputArtifact] = None,
-    labels: List[ai_api_client_sdk.models.label.Label] = None,
-    **kwargs
-)
- 
-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
 
 Methods defined here:
-
__eq__(self, other)
Return self==value.
- -
__init__( - self, - id: str, - scenario_id: str, - version_id: str, - name: str, - deployable: bool, - created_at: datetime.datetime, - modified_at: datetime.datetime, - description: str = None, - parameters: List[ai_api_client_sdk.models.parameter.Parameter] = None, - input_artifacts: List[ai_api_client_sdk.models.input_artifact.InputArtifact] = None, - output_artifacts: List[ai_api_client_sdk.models.output_artifact.OutputArtifact] = None, - labels: List[ai_api_client_sdk.models.label.Label] = None, - **kwargs -)
Initialize self.  See help(type(self)) for accurate signature.
- -
__str__(self)
Return str(self).
- -
-Static methods defined here:
-
from_dict(executable_dict: Dict[str, Any])
Returns a :class:`ai_api_client_sdk.models.executable.Executable` object, created from the values in the dict
-provided as parameter
- 
-:param executable_dict: Dict which includes the necessary values to create the object
-:type executable_dict: Dict[str, Any]
-:return: An object, created from the values provided
-:rtype: class:`ai_api_client_sdk.models.executable.Executable`
- -
-Data descriptors defined here:
-
__dict__
-
dictionary for instance variables
-
-
__weakref__
-
list of weak references to the object
-
-
-Data and other attributes defined here:
-
__hash__ = None
- -

- - - - - -
 
Data
       Dict = typing.Dict
-List = typing.List
- \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.executable_query_response.html b/packages/base/docs/ai_api_client_sdk.models.executable_query_response.html deleted file mode 100644 index 0f55a60..0000000 --- a/packages/base/docs/ai_api_client_sdk.models.executable_query_response.html +++ /dev/null @@ -1,90 +0,0 @@ - - - - -Python: module ai_api_client_sdk.models.executable_query_response - - - - - -
 
ai_api_client_sdk.models.executable_query_response		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/executable_query_response.py
-

-

- - - - - -
 
Classes
       
-
ai_api_client_sdk.models.base_models.QueryResponse(builtins.object) -
-
-
ExecutableQueryResponse -
-
-
-

- - - - - - - -
 
class ExecutableQueryResponse(ai_api_client_sdk.models.base_models.QueryResponse)
   ExecutableQueryResponse(
-    resources: List[ai_api_client_sdk.models.executable.Executable],
-    count: int,
-    **kwargs
-)
- 
-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
 
 
Method resolution order:
-
ExecutableQueryResponse
-
ai_api_client_sdk.models.base_models.QueryResponse
-
builtins.object
-
-
-Methods defined here:
-
__init__( - self, - resources: List[ai_api_client_sdk.models.executable.Executable], - count: int, - **kwargs -)
Initialize self.  See help(type(self)) for accurate signature.
- -
-Static methods defined here:
-
from_dict(response_dict: Dict[str, Any])
Returns a :class:`ai_api_client_sdk.models.executable_query_response.ExecutableQueryResponse` object, created 
-from the values in the dict provided as parameter
- 
-:param response_dict: Dict which includes the necessary values to create the object
-:type response_dict: Dict[str, Any]
-:return: An object, created from the values provided
-:rtype: class:`ai_api_client_sdk.models.executable_query_response.ExecutableQueryResponse`
- -
-Methods inherited from ai_api_client_sdk.models.base_models.QueryResponse:
-
__str__(self)
Return str(self).
- -
-Data descriptors inherited from ai_api_client_sdk.models.base_models.QueryResponse:
-
__dict__
-
dictionary for instance variables
-
-
__weakref__
-
list of weak references to the object
-
-

- - - - - -
 
Data
       Dict = typing.Dict
-List = typing.List
- \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.execution.html b/packages/base/docs/ai_api_client_sdk.models.execution.html deleted file mode 100644 index 8d89af2..0000000 --- a/packages/base/docs/ai_api_client_sdk.models.execution.html +++ /dev/null @@ -1,141 +0,0 @@ - - - - -Python: module ai_api_client_sdk.models.execution - - - - - -
 
ai_api_client_sdk.models.execution		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/execution.py
-

-

- - - - - -
 
Classes
       
-
ai_api_client_sdk.models.enactment.Enactment(builtins.object) -
-
-
Execution -
-
-
-

- - - - - - - -
 
class Execution(ai_api_client_sdk.models.enactment.Enactment)
   Execution(
-    id: str,
-    configuration_id: str,
-    configuration_name: str,
-    scenario_id: str,
-    status: ai_api_client_sdk.models.status.Status,
-    target_status: ai_api_client_sdk.models.target_status.TargetStatus,
-    created_at: datetime.datetime,
-    modified_at: datetime.datetime,
-    output_artifacts: List[ai_api_client_sdk.models.artifact.Artifact] = None,
-    status_message: str = None,
-    status_details: Dict[str, Any] = None,
-    submission_time: datetime.datetime = None,
-    start_time: datetime.datetime = None,
-    execution_schedule_id: str = None,
-    completion_time: datetime.datetime = None,
-    **kwargs
-)
- 
-The Execution object defines an execution
- 
-: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 configuration_name: Name of the configuration which configured the execution
-:type configuration_name: str
-:param scenario_id: ID of the scenario which the execution belongs to
-:type scenario_id: str
-:param status: Status of the execution
-:type status: class:`ai_api_client_sdk.models.status.Status`
-:param target_status: Target status of the execution
-:type target_status: class:`ai_api_client_sdk.models.target_status.TargetStatus`
-:param execution_schedule_id: ID of the execution schedule, defaults to None
-:type execution_schedule_id: str, optional
-: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 output_artifacts: List of the artifacts created by the execution, defaults to None
-:type output_artifacts: List[class:`ai_api_client_sdk.models.artifact.Artifact`], optional
-:param status_message: Gives information about the status of the execution, defaults to None
-:type status_message: str, optional
-: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
-:param submission_time: Time when the execution was submitted
-:type submission_time: datetime, optional
-:param start_time: Time when the execution status changed to RUNNING
-:type start_time: datetime, optional
-:param completion_time: Time when the execution status changed to COMPLETED/DEAD/STOPPED
-:type completion_time: datetime, optional
-:param `**kwargs`: The keyword arguments are there in case there are additional attributes returned from server
 
 
Method resolution order:
-
Execution
-
ai_api_client_sdk.models.enactment.Enactment
-
builtins.object
-
-
-Methods defined here:
-
__init__( - self, - id: str, - configuration_id: str, - configuration_name: str, - scenario_id: str, - status: ai_api_client_sdk.models.status.Status, - target_status: ai_api_client_sdk.models.target_status.TargetStatus, - created_at: datetime.datetime, - modified_at: datetime.datetime, - output_artifacts: List[ai_api_client_sdk.models.artifact.Artifact] = None, - status_message: str = None, - status_details: Dict[str, Any] = None, - submission_time: datetime.datetime = None, - start_time: datetime.datetime = None, - execution_schedule_id: str = None, - completion_time: datetime.datetime = None, - **kwargs -)
Initialize self.  See help(type(self)) for accurate signature.
- -
__str__(self)
Return str(self).
- -
-Static methods defined here:
-
from_dict(execution_dict: Dict[str, Any])
Returns a :class:`ai_api_client_sdk.models.execution.Execution` object, created from the values in the dict
-provided as parameter
- 
-:param execution_dict: Dict which includes the necessary values to create the object
-:type execution_dict: Dict[str, Any]
-:return: An object, created from the values provided
-:rtype: class:`ai_api_client_sdk.models.execution.Execution`
- -
-Data descriptors inherited from ai_api_client_sdk.models.enactment.Enactment:
-
__dict__
-
dictionary for instance variables
-
-
__weakref__
-
list of weak references to the object
-
-

- - - - - -
 
Data
       Dict = typing.Dict
-List = typing.List
- \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.execution_bulk_modify_response.html b/packages/base/docs/ai_api_client_sdk.models.execution_bulk_modify_response.html deleted file mode 100644 index 7d9a938..0000000 --- a/packages/base/docs/ai_api_client_sdk.models.execution_bulk_modify_response.html +++ /dev/null @@ -1,78 +0,0 @@ - - - - -Python: module ai_api_client_sdk.models.execution_bulk_modify_response - - - - - -
 
ai_api_client_sdk.models.execution_bulk_modify_response		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/execution_bulk_modify_response.py
-

-

- - - - - -
 
Classes
       
-
builtins.object -
-
-
ExecutionBulkModifyResponse -
-
-
-

- - - - - - - -
 
class ExecutionBulkModifyResponse(builtins.object)
   ExecutionBulkModifyResponse(
-    executions: List[Union[ai_api_client_sdk.models.base_models.BasicResponse, ai_api_client_sdk.models.base_models.BulkModifyErrorResponse]],
-    **kwargs
-)
- 
-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]]
 
 Methods defined here:
-
__init__( - self, - executions: List[Union[ai_api_client_sdk.models.base_models.BasicResponse, ai_api_client_sdk.models.base_models.BulkModifyErrorResponse]], - **kwargs -)
Initialize self.  See help(type(self)) for accurate signature.
- -
__str__(self)
Return str(self).
- -
-Static methods defined here:
-
from_dict(response_dict: Dict[str, List[Dict[str, Union[str, Dict]]]])
Returns a :class:`ai_api_client_sdk.models.execution_bulk_modify_response.ExecutionBulkModifyResponse` object,
-created from the values provided as parameter
- 
-:param response_dict: Which includes the necessary values to create the object
-:type response_dict: Dict[str, List[Dict[str, Union[str, Dict]]]]
-:return: An object, created from the values provided
-:rtype: class:`ai_api_client_sdk.models.execution_bulk_modify_response.ExecutionBulkModifyResponse`
- -
-Data descriptors defined here:
-
__dict__
-
dictionary for instance variables
-
-
__weakref__
-
list of weak references to the object
-
-

- - - - - -
 
Data
       Dict = typing.Dict
-List = typing.List
-Union = typing.Union
- \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.execution_create_response.html b/packages/base/docs/ai_api_client_sdk.models.execution_create_response.html deleted file mode 100644 index 43e66a2..0000000 --- a/packages/base/docs/ai_api_client_sdk.models.execution_create_response.html +++ /dev/null @@ -1,93 +0,0 @@ - - - - -Python: module ai_api_client_sdk.models.execution_create_response - - - - - -
 
ai_api_client_sdk.models.execution_create_response		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/execution_create_response.py
-

-

- - - - - -
 
Classes
       
-
ai_api_client_sdk.models.base_models.BasicResponse(builtins.object) -
-
-
ExecutionCreateResponse -
-
-
-

- - - - - - - -
 
class ExecutionCreateResponse(ai_api_client_sdk.models.base_models.BasicResponse)
   ExecutionCreateResponse(
-    id: str,
-    message: str,
-    status: ai_api_client_sdk.models.status.Status,
-    **kwargs
-)
- 
-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
 
 
Method resolution order:
-
ExecutionCreateResponse
-
ai_api_client_sdk.models.base_models.BasicResponse
-
builtins.object
-
-
-Methods defined here:
-
__init__( - self, - id: str, - message: str, - status: ai_api_client_sdk.models.status.Status, - **kwargs -)
Initialize self.  See help(type(self)) for accurate signature.
- -
-Static methods defined here:
-
from_dict(response_dict: Dict[str, Any])
Returns a :class:`ai_api_client_sdk.models.execution_create_response.ExecutionCreateResponse` object,
-created from the values in the dict provided as parameter
- 
-:param response_dict: Dict which includes the necessary values to create the object
-:type response_dict: Dict[str, Any]
-:return: An object, created from the values provided
-:rtype: class:`ai_api_client_sdk.models.execution_create_response.ExecutionCreateResponse`
- -
-Methods inherited from ai_api_client_sdk.models.base_models.BasicResponse:
-
__str__(self)
Return str(self).
- -
-Data descriptors inherited from ai_api_client_sdk.models.base_models.BasicResponse:
-
__dict__
-
dictionary for instance variables
-
-
__weakref__
-
list of weak references to the object
-
-

- - - - - -
 
Data
       Dict = typing.Dict
- \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.execution_get_status_response.html b/packages/base/docs/ai_api_client_sdk.models.execution_get_status_response.html deleted file mode 100644 index 6fb2a67..0000000 --- a/packages/base/docs/ai_api_client_sdk.models.execution_get_status_response.html +++ /dev/null @@ -1,99 +0,0 @@ - - - - -Python: module ai_api_client_sdk.models.execution_get_status_response - - - - - -
 
ai_api_client_sdk.models.execution_get_status_response		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/execution_get_status_response.py
-

-

- - - - - -
 
Classes
       
-
ai_api_client_sdk.models.enactment_get_status_response.EnactmentGetStatusResponse(builtins.object) -
-
-
ExecutionGetStatusResponse -
-
-
-

- - - - - - - -
 
class ExecutionGetStatusResponse(ai_api_client_sdk.models.enactment_get_status_response.EnactmentGetStatusResponse)
   ExecutionGetStatusResponse(
-    id: str,
-    configuration_id: str,
-    status: ai_api_client_sdk.models.status.Status,
-    created_at: datetime.datetime,
-    modified_at: datetime.datetime,
-    status_details: Dict[str, Any] = None
-)
- 
-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
 
 
Method resolution order:
-
ExecutionGetStatusResponse
-
ai_api_client_sdk.models.enactment_get_status_response.EnactmentGetStatusResponse
-
builtins.object
-
-
-Methods defined here:
-
__init__( - self, - id: str, - configuration_id: str, - status: ai_api_client_sdk.models.status.Status, - created_at: datetime.datetime, - modified_at: datetime.datetime, - status_details: Dict[str, Any] = None -)
Initialize self.  See help(type(self)) for accurate signature.
- -
__str__(self)
Return str(self).
- -
-Static methods defined here:
-
from_dict(execution_dict: Dict[str, Any])
Returns a :class:`ai_api_client_sdk.models.execution_get_status_response.ExecutionGetStatusResponse` object,
- created from the values in the dict provided as parameter
-:param execution_dict: Dict which includes the necessary values to create the object
-:type execution_dict: Dict[str, Any]
-:return: An object, created from the values provided
-:rtype: class:`ai_api_client_sdk.models.execution_get_status_response.ExecutionGetStatusResponse`
- -
-Data descriptors inherited from ai_api_client_sdk.models.enactment_get_status_response.EnactmentGetStatusResponse:
-
__dict__
-
dictionary for instance variables
-
-
__weakref__
-
list of weak references to the object
-
-

- - - - - -
 
Data
       Dict = typing.Dict
- \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.execution_query_response.html b/packages/base/docs/ai_api_client_sdk.models.execution_query_response.html deleted file mode 100644 index 7c54721..0000000 --- a/packages/base/docs/ai_api_client_sdk.models.execution_query_response.html +++ /dev/null @@ -1,90 +0,0 @@ - - - - -Python: module ai_api_client_sdk.models.execution_query_response - - - - - -
 
ai_api_client_sdk.models.execution_query_response		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/execution_query_response.py
-

-

- - - - - -
 
Classes
       
-
ai_api_client_sdk.models.base_models.QueryResponse(builtins.object) -
-
-
ExecutionQueryResponse -
-
-
-

- - - - - - - -
 
class ExecutionQueryResponse(ai_api_client_sdk.models.base_models.QueryResponse)
   ExecutionQueryResponse(
-    resources: List[ai_api_client_sdk.models.execution.Execution],
-    count: int,
-    **kwargs
-)
- 
-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
 
 
Method resolution order:
-
ExecutionQueryResponse
-
ai_api_client_sdk.models.base_models.QueryResponse
-
builtins.object
-
-
-Methods defined here:
-
__init__( - self, - resources: List[ai_api_client_sdk.models.execution.Execution], - count: int, - **kwargs -)
Initialize self.  See help(type(self)) for accurate signature.
- -
-Static methods defined here:
-
from_dict(response_dict: Dict[str, Any])
Returns a :class:`ai_api_client_sdk.models.execution_query_response.ExecutionQueryResponse` object, created 
-from the values in the dict provided as parameter
- 
-:param response_dict: Dict which includes the necessary values to create the object
-:type response_dict: Dict[str, Any]
-:return: An object, created from the values provided
-:rtype: class:`ai_api_client_sdk.models.execution_query_response.ExecutionQueryResponse`
- -
-Methods inherited from ai_api_client_sdk.models.base_models.QueryResponse:
-
__str__(self)
Return str(self).
- -
-Data descriptors inherited from ai_api_client_sdk.models.base_models.QueryResponse:
-
__dict__
-
dictionary for instance variables
-
-
__weakref__
-
list of weak references to the object
-
-

- - - - - -
 
Data
       Dict = typing.Dict
-List = typing.List
- \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.execution_schedule.html b/packages/base/docs/ai_api_client_sdk.models.execution_schedule.html deleted file mode 100644 index f6180a1..0000000 --- a/packages/base/docs/ai_api_client_sdk.models.execution_schedule.html +++ /dev/null @@ -1,110 +0,0 @@ - - - - -Python: module ai_api_client_sdk.models.execution_schedule - - - - - -
 
ai_api_client_sdk.models.execution_schedule		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/execution_schedule.py
-

-

- - - - - -
 
Classes
       
-
builtins.object -
-
-
ExecutionSchedule -
-
-
-

- - - - - - - -
 
class ExecutionSchedule(builtins.object)
   ExecutionSchedule(
-    id: str,
-    name: str,
-    cron: str,
-    configuration_id: str,
-    status: ai_api_client_sdk.models.status.ScheduleStatus,
-    created_at: datetime.datetime,
-    modified_at: datetime.datetime,
-    start: datetime.datetime = None,
-    end: datetime.datetime = None,
-    **kwargs
-)
- 
-An Execution Schedule allows to trigger executions periodically
- 
-:param id: ID of the execution schedule
-:type id: str
-:param name: Name of the execution schedule
-:type name: str
-:param cron: Cron defining the schedule to run the executions
-:type cron: str
-:param configuration_id: ID of the configuration for the execution schedule
-:type configuration_id: str
-:param status: status of the execution schedule
-:type status: str
-:param created_at: Time when the execution schedule was created
-:type created_at: datetime, optional
-:param modified_at: Time when the execution schedule was last modified
-:type modified_at: datetime, optional
-:param start: Start time of the execution schedule
-:type start: datetime, optional
-:param end: End time of the execution schedule
-:type end: datetime, optional
-:param `**kwargs`: The keyword arguments are there in case there are additional attributes returned from server
 
 Methods defined here:
-
__init__( - self, - id: str, - name: str, - cron: str, - configuration_id: str, - status: ai_api_client_sdk.models.status.ScheduleStatus, - created_at: datetime.datetime, - modified_at: datetime.datetime, - start: datetime.datetime = None, - end: datetime.datetime = None, - **kwargs -)
Initialize self.  See help(type(self)) for accurate signature.
- -
__str__(self)
Return str(self).
- -
-Static methods defined here:
-
from_dict(execution_schedule_dict: Dict[str, Any])
Returns a :class:`ai_api_client_sdk.models.execution_schedule.Schedule` object, created from the values in
-the dict provided as parameter
- 
-:param execution_schedule_dict: Dict which includes the necessary values to create the object
-:type execution_schedule_dict: Dict[str, Any]
-:return: An object, created from the values provided
-:rtype: class:`ai_api_client_sdk.models.execution_schedule.Schedule`
- -
-Data descriptors defined here:
-
__dict__
-
dictionary for instance variables
-
-
__weakref__
-
list of weak references to the object
-
-

- - - - - -
 
Data
       Dict = typing.Dict
- \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.execution_schedule_create_response.html b/packages/base/docs/ai_api_client_sdk.models.execution_schedule_create_response.html deleted file mode 100644 index 3aea875..0000000 --- a/packages/base/docs/ai_api_client_sdk.models.execution_schedule_create_response.html +++ /dev/null @@ -1,74 +0,0 @@ - - - - -Python: module ai_api_client_sdk.models.execution_schedule_create_response - - - - - -
 
ai_api_client_sdk.models.execution_schedule_create_response		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/execution_schedule_create_response.py
-

-

- - - - - -
 
Classes
       
-
ai_api_client_sdk.models.base_models.BasicResponse(builtins.object) -
-
-
ExecutionScheduleCreateResponse -
-
-
-

- - - - - - - -
 
class ExecutionScheduleCreateResponse(ai_api_client_sdk.models.base_models.BasicResponse)
   ExecutionScheduleCreateResponse(id: str, message: str, **kwargs)
- 
-The ExecutionScheduleCreateResponse object defines the response of the execution schedule create request.
-Refer to :class:`ai_api_client_sdk.models.base_models.BasicResponse`, for the object definition
 
 
Method resolution order:
-
ExecutionScheduleCreateResponse
-
ai_api_client_sdk.models.base_models.BasicResponse
-
builtins.object
-
-
-Static methods defined here:
-
from_dict(response_dict: Dict[str, Any])
Returns a :class:`ai_api_client_sdk.models.execution_schedule_create_response.ExecutionScheduleCreateResponse`
-object, created from the values in the dict provided as parameter
- 
-:param response_dict: Dict which includes the necessary values to create the object
-:type response_dict: Dict[str, Any]
-:return: An object, created from the values provided
-:rtype: class:`ai_api_client_sdk.models.execution_schedule_create_response.ExecutionScheduleCreateResponse`
- -
-Methods inherited from ai_api_client_sdk.models.base_models.BasicResponse:
-
__init__(self, id: str, message: str, **kwargs)
Initialize self.  See help(type(self)) for accurate signature.
- -
__str__(self)
Return str(self).
- -
-Data descriptors inherited from ai_api_client_sdk.models.base_models.BasicResponse:
-
__dict__
-
dictionary for instance variables
-
-
__weakref__
-
list of weak references to the object
-
-

- - - - - -
 
Data
       Dict = typing.Dict
- \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.execution_schedule_query_response.html b/packages/base/docs/ai_api_client_sdk.models.execution_schedule_query_response.html deleted file mode 100644 index 3d80313..0000000 --- a/packages/base/docs/ai_api_client_sdk.models.execution_schedule_query_response.html +++ /dev/null @@ -1,90 +0,0 @@ - - - - -Python: module ai_api_client_sdk.models.execution_schedule_query_response - - - - - -
 
ai_api_client_sdk.models.execution_schedule_query_response		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/execution_schedule_query_response.py
-

-

- - - - - -
 
Classes
       
-
ai_api_client_sdk.models.base_models.QueryResponse(builtins.object) -
-
-
ExecutionScheduleQueryResponse -
-
-
-

- - - - - - - -
 
class ExecutionScheduleQueryResponse(ai_api_client_sdk.models.base_models.QueryResponse)
   ExecutionScheduleQueryResponse(
-    resources: List[ai_api_client_sdk.models.execution_schedule.ExecutionSchedule],
-    count: int,
-    **kwargs
-)
- 
-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
 
 
Method resolution order:
-
ExecutionScheduleQueryResponse
-
ai_api_client_sdk.models.base_models.QueryResponse
-
builtins.object
-
-
-Methods defined here:
-
__init__( - self, - resources: List[ai_api_client_sdk.models.execution_schedule.ExecutionSchedule], - count: int, - **kwargs -)
Initialize self.  See help(type(self)) for accurate signature.
- -
-Static methods defined here:
-
from_dict(response_dict: Dict[str, Any])
Returns a :class:`ai_api_client_sdk.models.execution_schedule_query_response.ExecutionScheduleQueryResponse`
-object, created from the values in the dict provided as parameter
- 
-:param response_dict: Dict which includes the necessary values to create the object
-:type response_dict: Dict[str, Any]
-:return: An object, created from the values provided
-:rtype: class:`ai_api_client_sdk.models.execution_schedule_query_response.ExecutionScheduleQueryResponse`
- -
-Methods inherited from ai_api_client_sdk.models.base_models.QueryResponse:
-
__str__(self)
Return str(self).
- -
-Data descriptors inherited from ai_api_client_sdk.models.base_models.QueryResponse:
-
__dict__
-
dictionary for instance variables
-
-
__weakref__
-
list of weak references to the object
-
-

- - - - - -
 
Data
       Dict = typing.Dict
-List = typing.List
- \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.extensions.html b/packages/base/docs/ai_api_client_sdk.models.extensions.html deleted file mode 100644 index e12ea47..0000000 --- a/packages/base/docs/ai_api_client_sdk.models.extensions.html +++ /dev/null @@ -1,93 +0,0 @@ - - - - -Python: module ai_api_client_sdk.models.extensions - - - - - -
 
ai_api_client_sdk.models.extensions		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/extensions.py
-

-

- - - - - -
 
Classes
       
-
builtins.object -
-
-
Extensions -
-
-
-

- - - - - - - -
 
class Extensions(builtins.object)
   Extensions(
-    analytics: ai_api_client_sdk.models.extensions_analytics.ExtensionsAnalytics = None,
-    resource_groups: ai_api_client_sdk.models.extensions_resource_groups.ExtensionsResourceGroups = None,
-    dataset: ai_api_client_sdk.models.extensions_dataset.ExtensionsDataset = None,
-    **kwargs
-)
- 
-The Extensions object represents the extensions to the AI API
- 
-:param analytics: Metadata and capabilities of the Analytics API, defaults to None
-:type analytics: class:`ai_api_client_sdk.models.extensions_analytics.ExtensionsAnalytics`, optional
-:param resource_groups: Metadata and capabilities of the Resource Groups API, defaults to None
-:type resource_groups: class:`ai_api_client_sdk.models.extensions_resource_groups.ExtensionsResourceGroups`,
-    optional
-:param dataset: Metadata and capabilities of the Dataset API, defaults to None
-:type dataset: class:`ai_api_client_sdk.models.extensions_dataset.ExtensionsDataset`, optional
-:param `**kwargs`: The keyword arguments are there in case there are additional attributes returned from server
 
 Methods defined here:
-
__eq__(self, other)
Return self==value.
- -
__init__( - self, - analytics: ai_api_client_sdk.models.extensions_analytics.ExtensionsAnalytics = None, - resource_groups: ai_api_client_sdk.models.extensions_resource_groups.ExtensionsResourceGroups = None, - dataset: ai_api_client_sdk.models.extensions_dataset.ExtensionsDataset = None, - **kwargs -)
Initialize self.  See help(type(self)) for accurate signature.
- -
__str__(self)
Return str(self).
- -
-Static methods defined here:
-
from_dict(extensions_dict: Dict[str, Any])
Returns a :class:`ai_api_client_sdk.models.extensions.Extensions` object, created from the values in the
-dict provided as parameter
- 
-:param extensions_dict: Dict which includes the necessary values to create the object
-:type extensions_dict: Dict[str, Any]
-:return: An object, created from the values provided
-:rtype: class:`ai_api_client_sdk.models.extensions.Extensions`
- -
-Data descriptors defined here:
-
__dict__
-
dictionary for instance variables
-
-
__weakref__
-
list of weak references to the object
-
-
-Data and other attributes defined here:
-
__hash__ = None
- -

- - - - - -
 
Data
       Dict = typing.Dict
- \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.extensions_analytics.html b/packages/base/docs/ai_api_client_sdk.models.extensions_analytics.html deleted file mode 100644 index 37c549a..0000000 --- a/packages/base/docs/ai_api_client_sdk.models.extensions_analytics.html +++ /dev/null @@ -1,77 +0,0 @@ - - - - -Python: module ai_api_client_sdk.models.extensions_analytics - - - - - -
 
ai_api_client_sdk.models.extensions_analytics		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/extensions_analytics.py
-

-

- - - - - -
 
Classes
       
-
builtins.object -
-
-
ExtensionsAnalytics -
-
-
-

- - - - - - - -
 
class ExtensionsAnalytics(builtins.object)
   ExtensionsAnalytics(version: str, **kwargs)
- 
-The ExtensionsAnalytics object represents the metadata and capabilities of the Analytics API
- 
-:param version: Version of the Analytics API
-:type version: str
-:param `**kwargs`: The keyword arguments are there in case there are additional attributes returned from server
 
 Methods defined here:
-
__eq__(self, other)
Return self==value.
- -
__init__(self, version: str, **kwargs)
Initialize self.  See help(type(self)) for accurate signature.
- -
__str__(self)
Return str(self).
- -
-Static methods defined here:
-
from_dict(extensions_analytics_dict: Dict[str, str])
Returns a :class:`ai_api_client_sdk.models.extensions_analytics.ExtensionsAnalytics` object, created from
-the values in the dict provided as parameter
- 
-:param extensions_analytics_dict: Dict which includes the necessary values to create the object
-:type extensions_analytics_dict: Dict[str, str]
-:return: An object, created from the values provided
-:rtype: class:`ai_api_client_sdk.models.extensions_analytics.ExtensionsAnalytics`
- -
-Data descriptors defined here:
-
__dict__
-
dictionary for instance variables
-
-
__weakref__
-
list of weak references to the object
-
-
-Data and other attributes defined here:
-
__hash__ = None
- -

- - - - - -
 
Data
       Dict = typing.Dict
- \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.extensions_dataset.html b/packages/base/docs/ai_api_client_sdk.models.extensions_dataset.html deleted file mode 100644 index 15d0b75..0000000 --- a/packages/base/docs/ai_api_client_sdk.models.extensions_dataset.html +++ /dev/null @@ -1,92 +0,0 @@ - - - - -Python: module ai_api_client_sdk.models.extensions_dataset - - - - - -
 
ai_api_client_sdk.models.extensions_dataset		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/extensions_dataset.py
-

-

- - - - - -
 
Classes
       
-
builtins.object -
-
-
ExtensionsDataset -
-
-
-

- - - - - - - -
 
class ExtensionsDataset(builtins.object)
   ExtensionsDataset(
-    version: str,
-    capabilities: ai_api_client_sdk.models.dataset_capabilities.DatasetCapabilities = None,
-    limits: ai_api_client_sdk.models.dataset_limits.DatasetLimits = None,
-    **kwargs
-)
- 
-The ExtensionsDataset object represents the metadata and capabilities of the Dataset API
- 
-:param version: Version of the Dataset API
-:type version: str
-:param capabilities: Capabilities of the Dataset API, defaults to None
-:type capabilities: class:`ai_api_client_sdk.models.dataset_capabilities.DatasetCapabilities`, optional
-:param limits: Limits of the Dataset API, defaults to None
-:type limits: class:`ai_api_client_sdk.models.dataset_limits.DatasetLimits`, optional
-:param `**kwargs`: The keyword arguments are there in case there are additional attributes returned from server
 
 Methods defined here:
-
__eq__(self, other)
Return self==value.
- -
__init__( - self, - version: str, - capabilities: ai_api_client_sdk.models.dataset_capabilities.DatasetCapabilities = None, - limits: ai_api_client_sdk.models.dataset_limits.DatasetLimits = None, - **kwargs -)
Initialize self.  See help(type(self)) for accurate signature.
- -
__str__(self)
Return str(self).
- -
-Static methods defined here:
-
from_dict(extensions_dataset_dict: Dict[str, Any])
Returns a :class:`ai_api_client_sdk.models.extensions_dataset.ExtensionsDataset` object, created from the
-values in the dict provided as parameter
- 
-:param extensions_dataset_dict: Dict which includes the necessary values to create the object
-:type extensions_dataset_dict: Dict[str, Any]
-:return: An object, created from the values provided
-:rtype: class:`ai_api_client_sdk.models.extensions_dataset.ExtensionsDataset`
- -
-Data descriptors defined here:
-
__dict__
-
dictionary for instance variables
-
-
__weakref__
-
list of weak references to the object
-
-
-Data and other attributes defined here:
-
__hash__ = None
- -

- - - - - -
 
Data
       Dict = typing.Dict
- \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.extensions_resource_groups.html b/packages/base/docs/ai_api_client_sdk.models.extensions_resource_groups.html deleted file mode 100644 index 5be017e..0000000 --- a/packages/base/docs/ai_api_client_sdk.models.extensions_resource_groups.html +++ /dev/null @@ -1,77 +0,0 @@ - - - - -Python: module ai_api_client_sdk.models.extensions_resource_groups - - - - - -
 
ai_api_client_sdk.models.extensions_resource_groups		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/extensions_resource_groups.py
-

-

- - - - - -
 
Classes
       
-
builtins.object -
-
-
ExtensionsResourceGroups -
-
-
-

- - - - - - - -
 
class ExtensionsResourceGroups(builtins.object)
   ExtensionsResourceGroups(version: str, **kwargs)
- 
-The ExtensionsResourceGroups object represents the metadata and capabilities of the Resource Groups API
- 
-:param version: Version of the Resource Groups API
-:type version: str
-:param `**kwargs`: The keyword arguments are there in case there are additional attributes returned from server
 
 Methods defined here:
-
__eq__(self, other)
Return self==value.
- -
__init__(self, version: str, **kwargs)
Initialize self.  See help(type(self)) for accurate signature.
- -
__str__(self)
Return str(self).
- -
-Static methods defined here:
-
from_dict(extensions_resource_groups_dict: Dict[str, str])
Returns a :class:`ai_api_client_sdk.models.extensions_resource_groups.ExtensionsResourceGroups` object,
-created from the values in the dict provided as parameter
- 
-:param extensions_resource_groups_dict: Dict which includes the necessary values to create the object
-:type extensions_resource_groups_dict: Dict[str, str]
-:return: An object, created from the values provided
-:rtype: class:`ai_api_client_sdk.models.extensions_resource_groups.ExtensionsResourceGroups`
- -
-Data descriptors defined here:
-
__dict__
-
dictionary for instance variables
-
-
__weakref__
-
list of weak references to the object
-
-
-Data and other attributes defined here:
-
__hash__ = None
- -

- - - - - -
 
Data
       Dict = typing.Dict
- \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.healthz_status.html b/packages/base/docs/ai_api_client_sdk.models.healthz_status.html deleted file mode 100644 index fcccd7e..0000000 --- a/packages/base/docs/ai_api_client_sdk.models.healthz_status.html +++ /dev/null @@ -1,139 +0,0 @@ - - - - -Python: module ai_api_client_sdk.models.healthz_status - - - - - -
 
ai_api_client_sdk.models.healthz_status		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/healthz_status.py
-

-

- - - - - -
 
Classes
       
-
builtins.object -
-
-
HealthzStatus -
-
-
enum.Enum(builtins.object) -
-
-
HealthStatus -
-
-
-

- - - - - - - -
 
class HealthStatus(enum.Enum)
   HealthStatus(*values)
- 
-
 
 
Method resolution order:
-
HealthStatus
-
enum.Enum
-
builtins.object
-
-
-Data and other attributes defined here:
-
NOT_READY = <HealthStatus.NOT_READY: 'NOT READY'>
- -
READY = <HealthStatus.READY: 'READY'>
- -
-Data descriptors inherited from enum.Enum:
-
name
-
The name of the Enum member.
-
-
value
-
The value of the Enum member.
-
-
-Static methods inherited from enum.EnumType:
-
__contains__(value)
Return True if `value` is in `cls`.
- 
-`value` is in `cls` if:
-1) `value` is a member of `cls`, or
-2) `value` is the value of one of the `cls`'s members.
-3) `value` is a pseudo-member (flags)
- -
__getitem__(name)
Return the member matching `name`.
- -
__iter__()
Return members in definition order.
- -
__len__()
Return the number of members (no aliases)
- -
-Readonly properties inherited from enum.EnumType:
-
__members__
-
Returns a mapping of member name->value.
- 
-This mapping lists all enum members, including aliases.  Note that
-this is a read-only view of the internal mapping.
-
-

- - - - - - - -
 
class HealthzStatus(builtins.object)
   HealthzStatus(
-    status: ai_api_client_sdk.models.healthz_status.HealthStatus,
-    message: str,
-    **kwargs
-)
- 
-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
 
 Methods defined here:
-
__init__( - self, - status: ai_api_client_sdk.models.healthz_status.HealthStatus, - message: str, - **kwargs -)
Initialize self.  See help(type(self)) for accurate signature.
- -
__str__(self)
Return str(self).
- -
-Static methods defined here:
-
from_dict(healthz_status_dict: Dict[str, Any])
Returns a :class:`ai_api_client_sdk.models.healthz_status.HealthzStatus` object, created from the values in
-the dict provided as parameter
- 
-:param healthz_status_dict: Dict which includes the necessary values to create the object
-:type healthz_status_dict: Dict[str, str]
-:return: An object, created from the values provided
-:rtype: class:`ai_api_client_sdk.models.healthz_status.HealthzStatus`
- -
-Data descriptors defined here:
-
__dict__
-
dictionary for instance variables
-
-
__weakref__
-
list of weak references to the object
-
-

- - - - - -
 
Data
       Dict = typing.Dict
- \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.html b/packages/base/docs/ai_api_client_sdk.models.html deleted file mode 100644 index e9cf1ce..0000000 --- a/packages/base/docs/ai_api_client_sdk.models.html +++ /dev/null @@ -1,88 +0,0 @@ - - - - -Python: package ai_api_client_sdk.models - - - - - -
 
ai_api_client_sdk.models		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/__init__.py
-

-

- - - - - -
 
Package Contents
       
ai_api_capabilities
-ai_api_capabilities_bulk_updates
-ai_api_capabilities_logs
-ai_api_limits
-ai_api_limits_deployments
-ai_api_limits_enactments
-ai_api_limits_executions
-ai_api_meta
-api_version
-artifact
-artifact_create_response
-artifact_query_response
-base_models
-capabilities
-configuration
-configuration_create_response
-configuration_query_response
-		dataset_capabilities
-dataset_limits
-deployment
-deployment_bulk_modify_response
-deployment_create_response
-deployment_get_status_response
-deployment_query_response
-enactment
-enactment_get_status_response
-executable
-executable_query_response
-execution
-execution_bulk_modify_response
-execution_create_response
-execution_get_status_response
-execution_query_response
-execution_schedule
-		execution_schedule_create_response
-execution_schedule_query_response
-extensions
-extensions_analytics
-extensions_dataset
-extensions_resource_groups
-healthz_status
-input_artifact
-input_artifact_binding
-label
-log_response
-metric
-metric_custom_info
-metric_label
-metric_resource
-metric_tag
-metrics_query_response
-		model
-model_base_data_allowed_scenarios
-model_query_response
-model_version
-output_artifact
-parameter
-parameter_binding
-resource_group
-resource_group_query_response
-resource_group_status
-scenario
-scenario_query_response
-status
-target_status
-version
-version_list
-version_query_response
-
- \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.input_artifact.html b/packages/base/docs/ai_api_client_sdk.models.input_artifact.html deleted file mode 100644 index 0305cbe..0000000 --- a/packages/base/docs/ai_api_client_sdk.models.input_artifact.html +++ /dev/null @@ -1,93 +0,0 @@ - - - - -Python: module ai_api_client_sdk.models.input_artifact - - - - - -
 
ai_api_client_sdk.models.input_artifact		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/input_artifact.py
-

-

- - - - - -
 
Classes
       
-
builtins.object -
-
-
InputArtifact -
-
-
-

- - - - - - - -
 
class InputArtifact(builtins.object)
   InputArtifact(
-    name: str,
-    kind: str = None,
-    description: str = None,
-    labels: List[ai_api_client_sdk.models.label.Label] = None
-)
- 
-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`]
 
 Methods defined here:
-
__eq__(self, other)
Return self==value.
- -
__init__( - self, - name: str, - kind: str = None, - description: str = None, - labels: List[ai_api_client_sdk.models.label.Label] = None -)
Initialize self.  See help(type(self)) for accurate signature.
- -
__str__(self)
Return str(self).
- -
-Static methods defined here:
-
from_dict(input_artifact_dict: Dict[str, Any])
Returns a :class:`ai_api_client_sdk.models.input_artifact.InputArtifact` object, created from the values
-in the dict provided as parameter
- 
-:param input_artifact_dict: Dict which includes the necessary values to create the object
-:type input_artifact_dict: Dict[str, Any]
-:return: An object, created from the values provided
-:rtype: class:`ai_api_client_sdk.models.input_artifact.InputArtifact`
- -
-Data descriptors defined here:
-
__dict__
-
dictionary for instance variables
-
-
__weakref__
-
list of weak references to the object
-
-
-Data and other attributes defined here:
-
__hash__ = None
- -

- - - - - -
 
Data
       Dict = typing.Dict
-List = typing.List
- \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.input_artifact_binding.html b/packages/base/docs/ai_api_client_sdk.models.input_artifact_binding.html deleted file mode 100644 index eeeb524..0000000 --- a/packages/base/docs/ai_api_client_sdk.models.input_artifact_binding.html +++ /dev/null @@ -1,82 +0,0 @@ - - - - -Python: module ai_api_client_sdk.models.input_artifact_binding - - - - - -
 
ai_api_client_sdk.models.input_artifact_binding		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/input_artifact_binding.py
-

-

- - - - - -
 
Classes
       
-
builtins.object -
-
-
InputArtifactBinding -
-
-
-

- - - - - - - -
 
class InputArtifactBinding(builtins.object)
   InputArtifactBinding(key: str, artifact_id: str, **kwargs)
- 
-The InputArtifactBinding object defines the input artifact specified in the configuration.
- 
-:param key: matches the input artifact name in the executable definition
-:type key: str
-:param id: ID of the artifact
-:type id: str
-:param `**kwargs`: The keyword arguments are there in case there are additional attributes returned from server
 
 Methods defined here:
-
__eq__(self, other)
Return self==value.
- -
__init__(self, key: str, artifact_id: str, **kwargs)
Initialize self.  See help(type(self)) for accurate signature.
- -
to_dict(self) -> Dict[str, str]
Returns the attributes of the object as a dictionary
- 
-:return: A dict, including all the attributes of the object
-:rtype: Dict[str, str]
- -
-Static methods defined here:
-
from_dict(input_artifact_binding_dict: Dict[str, str])
Returns a :class:`ai_api_client_sdk.models.input_artifact_binding.InputArtifactBinding` object, created from
-the values in the dict provided as parameter
- 
-:param input_artifact_binding_dict: Dict which includes the necessary values to create the object
-:type input_artifact_binding_dict: Dict[str, Any]
-:return: An object, created from the values provided
-:rtype: class:`ai_api_client_sdk.models.input_artifact_binding.InputArtifactBinding`
- -
-Data descriptors defined here:
-
__dict__
-
dictionary for instance variables
-
-
__weakref__
-
list of weak references to the object
-
-
-Data and other attributes defined here:
-
__hash__ = None
- -

- - - - - -
 
Data
       Dict = typing.Dict
- \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.label.html b/packages/base/docs/ai_api_client_sdk.models.label.html deleted file mode 100644 index 305f950..0000000 --- a/packages/base/docs/ai_api_client_sdk.models.label.html +++ /dev/null @@ -1,84 +0,0 @@ - - - - -Python: module ai_api_client_sdk.models.label - - - - - -
 
ai_api_client_sdk.models.label		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/label.py
-

-

- - - - - -
 
Classes
       
-
ai_api_client_sdk.models.base_models.KeyValue(builtins.object) -
-
-
Label -
-
-
-

- - - - - - - -
 
class Label(ai_api_client_sdk.models.base_models.KeyValue)
   Label(key: str, value: str, **kwargs)
- 
-The Label object defines a label as a key-value pair. Refer to
-:class:`ai_api_client_sdk.models.base_models.KeyValue`, for the object definition
 
 
Method resolution order:
-
Label
-
ai_api_client_sdk.models.base_models.KeyValue
-
builtins.object
-
-
-Methods defined here:
-
__str__(self)
Return str(self).
- -
-Static methods defined here:
-
from_dict(label_dict: Dict[str, str])
Returns a :class:`ai_api_client_sdk.models.label.Label` object, created from the values in the dict provided
-as parameter
- 
-:param label_dict: Dict which includes the necessary values to create the object
-:type label_dict: Dict[str, Any]
-:return: An object, created from the values provided
-:rtype: class:`ai_api_client_sdk.models.label.Label`
- -
-Methods inherited from ai_api_client_sdk.models.base_models.KeyValue:
-
__eq__(self, other)
Return self==value.
- -
__init__(self, key: str, value: str, **kwargs)
Initialize self.  See help(type(self)) for accurate signature.
- -
to_dict(self)
- -
-Data descriptors inherited from ai_api_client_sdk.models.base_models.KeyValue:
-
__dict__
-
dictionary for instance variables
-
-
__weakref__
-
list of weak references to the object
-
-
-Data and other attributes inherited from ai_api_client_sdk.models.base_models.KeyValue:
-
__hash__ = None
- -

- - - - - -
 
Data
       Dict = typing.Dict
- \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.log_response.html b/packages/base/docs/ai_api_client_sdk.models.log_response.html deleted file mode 100644 index f60d310..0000000 --- a/packages/base/docs/ai_api_client_sdk.models.log_response.html +++ /dev/null @@ -1,157 +0,0 @@ - - - - -Python: module ai_api_client_sdk.models.log_response - - - - - -
 
ai_api_client_sdk.models.log_response		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/log_response.py
-

-

- - - - - -
 
Classes
       
-
builtins.object -
-
-
LogResponse -
LogResponseData -
LogResultItem -
-
-
-

- - - - - - - -
 
class LogResponse(builtins.object)
   LogResponse(
-    data: ai_api_client_sdk.models.log_response.LogResponseData,
-    **kwargs
-)
- 
-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
 
 Methods defined here:
-
__init__( - self, - data: ai_api_client_sdk.models.log_response.LogResponseData, - **kwargs -)
Initialize self.  See help(type(self)) for accurate signature.
- -
__str__(self)
Return str(self).
- -
-Static methods defined here:
-
from_dict(log_response_dict: Dict[str, Any])
Returns a :class:`ai_api_client_sdk.models.log_response.LogResponse` object, created from the values
-in the dict provided as parameter
- 
-:param log_response_dict: Dict which includes the necessary values to create the object
-:type log_response_dict: Dict[str, Any]
-:return: An object, created from the values provided
-:rtype: class:`ai_api_client_sdk.models.log_response.LogResponse`
- -
-Data descriptors defined here:
-
__dict__
-
dictionary for instance variables
-
-
__weakref__
-
list of weak references to the object
-
-

- - - - - - - -
 
class LogResponseData(builtins.object)
   LogResponseData(
-    result: List[ai_api_client_sdk.models.log_response.LogResultItem],
-    **kwargs
-)
- 
-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
 
 Methods defined here:
-
__init__( - self, - result: List[ai_api_client_sdk.models.log_response.LogResultItem], - **kwargs -)
Initialize self.  See help(type(self)) for accurate signature.
- -
-Static methods defined here:
-
from_dict(log_response_data_dict: Dict[str, Any])
Returns a :class:`ai_api_client_sdk.models.log_response.LogResponseData` object, created from the values
-in the dict provided as parameter
- 
-:param log_response_data_dict: Dict which includes the necessary values to create the object
-:type log_response_data_dict: Dict[str, Any]
-:return: An object, created from the values provided
-:rtype: class:`ai_api_client_sdk.models.log_response.LogResponseData`
- -
-Data descriptors defined here:
-
__dict__
-
dictionary for instance variables
-
-
__weakref__
-
list of weak references to the object
-
-

- - - - - - - -
 
class LogResultItem(builtins.object)
   LogResultItem(msg: str, timestamp: datetime.datetime, **kwargs)
- 
-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
 
 Methods defined here:
-
__init__(self, msg: str, timestamp: datetime.datetime, **kwargs)
Initialize self.  See help(type(self)) for accurate signature.
- -
-Static methods defined here:
-
from_dict(log_result_item_dict: Dict[str, str])
Returns a :class:`ai_api_client_sdk.models.log_response.LogResultItem` object, created from the values
-in the dict provided as parameter
- 
-:param log_result_item_dict: Dict which includes the necessary values to create the object
-:type log_result_item_dict: Dict[str, Any]
-:return: An object, created from the values provided
-:rtype: class:`ai_api_client_sdk.models.log_response.LogResultItem`
- -
-Data descriptors defined here:
-
__dict__
-
dictionary for instance variables
-
-
__weakref__
-
list of weak references to the object
-
-

- - - - - -
 
Data
       Dict = typing.Dict
-List = typing.List
- \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.metric.html b/packages/base/docs/ai_api_client_sdk.models.metric.html deleted file mode 100644 index 3a93157..0000000 --- a/packages/base/docs/ai_api_client_sdk.models.metric.html +++ /dev/null @@ -1,107 +0,0 @@ - - - - -Python: module ai_api_client_sdk.models.metric - - - - - -
 
ai_api_client_sdk.models.metric		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/metric.py
-

-

- - - - - -
 
Classes
       
-
builtins.object -
-
-
Metric -
-
-
-

- - - - - - - -
 
class Metric(builtins.object)
   Metric(
-    name: str,
-    value: float,
-    timestamp: datetime.datetime,
-    step: int = None,
-    labels: List[ai_api_client_sdk.models.metric_label.MetricLabel] = None,
-    **kwargs
-)
- 
-The Metric object, defines a single metric.
- 
-:param name: Name of the metric
-:type name: str
-:param value: numeric value of the metric
-:type value: float
-:param timestamp: Time when the metric was created
-:type timestamp: datetime
-:param step: any measurement of training progress (number of training iterations, number of epochs, etc.)
-:type step: int
-:param labels: List of the labels of the metric, defaults to None
-:type labels: List[class:`ai_api_client_sdk.models.metric_label.MetricLabel`]
-:param `**kwargs`: The keyword arguments are there in case there are additional attributes returned from server
 
 Methods defined here:
-
__eq__(self, other)
Return self==value.
- -
__init__( - self, - name: str, - value: float, - timestamp: datetime.datetime, - step: int = None, - labels: List[ai_api_client_sdk.models.metric_label.MetricLabel] = None, - **kwargs -)
Initialize self.  See help(type(self)) for accurate signature.
- -
__str__(self)
Return str(self).
- -
to_dict(self)
Returns the attributes of the object as a dictionary
- 
-:return: A dict, including all the attributes of the object
-:rtype: Dict[str, str]
- -
-Static methods defined here:
-
from_dict(metric_dict: Dict[str, Any])
Returns a :class:`ai_api_client_sdk.models.metric.Metric` object, created from the values in the dict
-provided as parameter
- 
-:param metric_dict: Dict which includes the necessary values to create the object
-:type metric_dict: Dict[str, Any]
-:return: An object, created from the values provided
-:rtype: class:`ai_api_client_sdk.models.metric.Metric`
- -
-Data descriptors defined here:
-
__dict__
-
dictionary for instance variables
-
-
__weakref__
-
list of weak references to the object
-
-
-Data and other attributes defined here:
-
__hash__ = None
- -

- - - - - -
 
Data
       DATETIME_FORMAT = '%Y-%m-%dT%H:%M:%SZ'
-Dict = typing.Dict
-List = typing.List
- \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.metric_custom_info.html b/packages/base/docs/ai_api_client_sdk.models.metric_custom_info.html deleted file mode 100644 index 33c1f07..0000000 --- a/packages/base/docs/ai_api_client_sdk.models.metric_custom_info.html +++ /dev/null @@ -1,81 +0,0 @@ - - - - -Python: module ai_api_client_sdk.models.metric_custom_info - - - - - -
 
ai_api_client_sdk.models.metric_custom_info		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/metric_custom_info.py
-

-

- - - - - -
 
Classes
       
-
ai_api_client_sdk.models.base_models.NameValue(builtins.object) -
-
-
MetricCustomInfo -
-
-
-

- - - - - - - -
 
class MetricCustomInfo(ai_api_client_sdk.models.base_models.NameValue)
   MetricCustomInfo(name: str, value: str, **kwargs)
- 
-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
-:class:`ai_api_client_sdk.models.base_models.NameValue`, for the object definition
 
 
Method resolution order:
-
MetricCustomInfo
-
ai_api_client_sdk.models.base_models.NameValue
-
builtins.object
-
-
-Static methods defined here:
-
from_dict(metric_custom_info_dict: Dict[str, str])
Returns a :class:`ai_api_client_sdk.models.metric_custom_info.MetricCustomInfo` object, created from the
-values in the dict provided as parameter
- 
-:param metric_custom_info_dict: Dict which includes the necessary values to create the object
-:type metric_custom_info_dict: Dict[str, Any]
-:return: An object, created from the values provided
-:rtype: class:`ai_api_client_sdk.models.metric_custom_info.MetricCustomInfo`
- -
-Methods inherited from ai_api_client_sdk.models.base_models.NameValue:
-
__eq__(self, other)
Return self==value.
- -
__init__(self, name: str, value: str, **kwargs)
Initialize self.  See help(type(self)) for accurate signature.
- -
__str__(self)
Return str(self).
- -
-Data descriptors inherited from ai_api_client_sdk.models.base_models.NameValue:
-
__dict__
-
dictionary for instance variables
-
-
__weakref__
-
list of weak references to the object
-
-
-Data and other attributes inherited from ai_api_client_sdk.models.base_models.NameValue:
-
__hash__ = None
- -

- - - - - -
 
Data
       Dict = typing.Dict
- \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.metric_label.html b/packages/base/docs/ai_api_client_sdk.models.metric_label.html deleted file mode 100644 index 34d5ddd..0000000 --- a/packages/base/docs/ai_api_client_sdk.models.metric_label.html +++ /dev/null @@ -1,87 +0,0 @@ - - - - -Python: module ai_api_client_sdk.models.metric_label - - - - - -
 
ai_api_client_sdk.models.metric_label		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/metric_label.py
-

-

- - - - - -
 
Classes
       
-
ai_api_client_sdk.models.base_models.NameValue(builtins.object) -
-
-
MetricLabel -
-
-
-

- - - - - - - -
 
class MetricLabel(ai_api_client_sdk.models.base_models.NameValue)
   MetricLabel(name: str, value: str, **kwargs)
- 
-The MetricLabel object defines a metric label as a name-value pair. Refer to
-:class:`ai_api_client_sdk.models.base_models.NameValue`, for the object definition
 
 
Method resolution order:
-
MetricLabel
-
ai_api_client_sdk.models.base_models.NameValue
-
builtins.object
-
-
-Methods defined here:
-
to_dict(self)
Returns the attributes of the object as a dictionary
- 
-:return: A dict, including all the attributes of the object
-:rtype: Dict[str, str]
- -
-Static methods defined here:
-
from_dict(metric_label_dict: Dict[str, str])
Returns a :class:`ai_api_client_sdk.models.metric_label.MetricLabel` object, created from the values in the
-dict provided as parameter
- 
-:param metric_label_dict: Dict which includes the necessary values to create the object
-:type metric_label_dict: Dict[str, Any]
-:return: An object, created from the values provided
-:rtype: class:`ai_api_client_sdk.models.metric_label.MetricLabel`
- -
-Methods inherited from ai_api_client_sdk.models.base_models.NameValue:
-
__eq__(self, other)
Return self==value.
- -
__init__(self, name: str, value: str, **kwargs)
Initialize self.  See help(type(self)) for accurate signature.
- -
__str__(self)
Return str(self).
- -
-Data descriptors inherited from ai_api_client_sdk.models.base_models.NameValue:
-
__dict__
-
dictionary for instance variables
-
-
__weakref__
-
list of weak references to the object
-
-
-Data and other attributes inherited from ai_api_client_sdk.models.base_models.NameValue:
-
__hash__ = None
- -

- - - - - -
 
Data
       Dict = typing.Dict
- \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.metric_resource.html b/packages/base/docs/ai_api_client_sdk.models.metric_resource.html deleted file mode 100644 index 0096b87..0000000 --- a/packages/base/docs/ai_api_client_sdk.models.metric_resource.html +++ /dev/null @@ -1,91 +0,0 @@ - - - - -Python: module ai_api_client_sdk.models.metric_resource - - - - - -
 
ai_api_client_sdk.models.metric_resource		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/metric_resource.py
-

-

- - - - - -
 
Classes
       
-
builtins.object -
-
-
MetricResource -
-
-
-

- - - - - - - -
 
class MetricResource(builtins.object)
   MetricResource(
-    execution_id: str,
-    metrics: List[ai_api_client_sdk.models.metric.Metric] = None,
-    tags: List[ai_api_client_sdk.models.metric_tag.MetricTag] = None,
-    custom_info: List[ai_api_client_sdk.models.metric_custom_info.MetricCustomInfo] = None,
-    **kwargs
-)
- 
-The Metric object, defines collection of various metrics/tags/labels related to an execution.
- 
-:param execution_id: ID of the execution
-:type execution_id: str
-:param metrics: List of the metrics related to the execution, defaults to None
-:type metrics: List[class:`ai_api_client_sdk.metric.Metric`], optional
-:param tags: List of the tags related to the execution, defaults to None
-:type tags: List[class:'ai_api_client_sdk.models.metric_tag.MetricTag'], optional
-:param custom_info: List of custom info related to the execution, defaults to None
-:type custom_info: List[class:`ai_api_client_sdk.models.metric_custom_info.MetricCustomInfo`], optional
-:param `**kwargs`: The keyword arguments are there in case there are additional attributes returned from server
 
 Methods defined here:
-
__init__( - self, - execution_id: str, - metrics: List[ai_api_client_sdk.models.metric.Metric] = None, - tags: List[ai_api_client_sdk.models.metric_tag.MetricTag] = None, - custom_info: List[ai_api_client_sdk.models.metric_custom_info.MetricCustomInfo] = None, - **kwargs -)
Initialize self.  See help(type(self)) for accurate signature.
- -
__str__(self)
Return str(self).
- -
-Static methods defined here:
-
from_dict(metric_resource_dict: Dict[str, Any])
Returns a :class:`ai_api_client_sdk.models.metric_resource.MetricResource` object, created from the values
-in the dict provided as parameter
- 
-:param metric_resource_dict: Dict which includes the necessary values to create the object
-:type metric_resource_dict: Dict[str, Any]
-:return: An object, created from the values provided
-:rtype: class:`ai_api_client_sdk.models.metric_resource.MetricResource`
- -
-Data descriptors defined here:
-
__dict__
-
dictionary for instance variables
-
-
__weakref__
-
list of weak references to the object
-
-

- - - - - -
 
Data
       Dict = typing.Dict
-List = typing.List
- \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.metric_tag.html b/packages/base/docs/ai_api_client_sdk.models.metric_tag.html deleted file mode 100644 index 1f27572..0000000 --- a/packages/base/docs/ai_api_client_sdk.models.metric_tag.html +++ /dev/null @@ -1,82 +0,0 @@ - - - - -Python: module ai_api_client_sdk.models.metric_tag - - - - - -
 
ai_api_client_sdk.models.metric_tag		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/metric_tag.py
-

-

- - - - - -
 
Classes
       
-
ai_api_client_sdk.models.base_models.NameValue(builtins.object) -
-
-
MetricTag -
-
-
-

- - - - - - - -
 
class MetricTag(ai_api_client_sdk.models.base_models.NameValue)
   MetricTag(name: str, value: str, **kwargs)
- 
-The MetricTag object defines a tag as a name-value pair. Refer to
-:class:`ai_api_client_sdk.models.base_models.NameValue`, for the object definition
 
 
Method resolution order:
-
MetricTag
-
ai_api_client_sdk.models.base_models.NameValue
-
builtins.object
-
-
-Methods defined here:
-
__str__(self)
Return str(self).
- -
-Static methods defined here:
-
from_dict(metric_tag_dict: Dict[str, str])
Returns a :class:`ai_api_client_sdk.models.metric_tag.MetricTag` object, created from the values in the dict
-provided as parameter
- 
-:param metric_tag_dict: Dict which includes the necessary values to create the object
-:type metric_tag_dict: Dict[str, Any]
-:return: An object, created from the values provided
-:rtype: class:`ai_api_client_sdk.models.metric_tag.MetricTag`
- -
-Methods inherited from ai_api_client_sdk.models.base_models.NameValue:
-
__eq__(self, other)
Return self==value.
- -
__init__(self, name: str, value: str, **kwargs)
Initialize self.  See help(type(self)) for accurate signature.
- -
-Data descriptors inherited from ai_api_client_sdk.models.base_models.NameValue:
-
__dict__
-
dictionary for instance variables
-
-
__weakref__
-
list of weak references to the object
-
-
-Data and other attributes inherited from ai_api_client_sdk.models.base_models.NameValue:
-
__hash__ = None
- -

- - - - - -
 
Data
       Dict = typing.Dict
- \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.metrics_query_response.html b/packages/base/docs/ai_api_client_sdk.models.metrics_query_response.html deleted file mode 100644 index 49cc05c..0000000 --- a/packages/base/docs/ai_api_client_sdk.models.metrics_query_response.html +++ /dev/null @@ -1,90 +0,0 @@ - - - - -Python: module ai_api_client_sdk.models.metrics_query_response - - - - - -
 
ai_api_client_sdk.models.metrics_query_response		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/metrics_query_response.py
-

-

- - - - - -
 
Classes
       
-
ai_api_client_sdk.models.base_models.QueryResponse(builtins.object) -
-
-
MetricsQueryResponse -
-
-
-

- - - - - - - -
 
class MetricsQueryResponse(ai_api_client_sdk.models.base_models.QueryResponse)
   MetricsQueryResponse(
-    resources: List[ai_api_client_sdk.models.metric_resource.MetricResource],
-    count: int,
-    **kwargs
-)
- 
-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
 
 
Method resolution order:
-
MetricsQueryResponse
-
ai_api_client_sdk.models.base_models.QueryResponse
-
builtins.object
-
-
-Methods defined here:
-
__init__( - self, - resources: List[ai_api_client_sdk.models.metric_resource.MetricResource], - count: int, - **kwargs -)
Initialize self.  See help(type(self)) for accurate signature.
- -
-Static methods defined here:
-
from_dict(response_dict: Dict[str, Any])
Returns a :class:`ai_api_client_sdk.models.metrics_query_response.MetricsQueryResponse` object, created
-from the values in the dict provided as parameter
- 
-:param response_dict: Dict which includes the necessary values to create the object
-:type response_dict: Dict[str, Any]
-:return: An object, created from the values provided
-:rtype: class:`ai_api_client_sdk.models.metrics_query_response.MetricsQueryResponse`
- -
-Methods inherited from ai_api_client_sdk.models.base_models.QueryResponse:
-
__str__(self)
Return str(self).
- -
-Data descriptors inherited from ai_api_client_sdk.models.base_models.QueryResponse:
-
__dict__
-
dictionary for instance variables
-
-
__weakref__
-
list of weak references to the object
-
-

- - - - - -
 
Data
       Dict = typing.Dict
-List = typing.List
- \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.model.html b/packages/base/docs/ai_api_client_sdk.models.model.html deleted file mode 100644 index 3bb89b9..0000000 --- a/packages/base/docs/ai_api_client_sdk.models.model.html +++ /dev/null @@ -1,105 +0,0 @@ - - - - -Python: module ai_api_client_sdk.models.model - - - - - -
 
ai_api_client_sdk.models.model		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/model.py
-

-

- - - - - -
 
Classes
       
-
builtins.object -
-
-
Model -
-
-
-

- - - - - - - -
 
class Model(builtins.object)
   Model(
-    executable_id: str,
-    model: str,
-    description: str = None,
-    versions: List[ai_api_client_sdk.models.model_version.ModelVersion] = None,
-    display_name: str = None,
-    access_type: str = None,
-    provider: str = None,
-    allowed_scenarios: List[ai_api_client_sdk.models.model_base_data_allowed_scenarios.ModelBaseDataAllowedScenarios] = None,
-    **kwargs
-)
- 
-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
-:param `**kwargs`: The keyword arguments are there in case there are additional attributes returned from server
 
 Methods defined here:
-
__init__( - self, - executable_id: str, - model: str, - description: str = None, - versions: List[ai_api_client_sdk.models.model_version.ModelVersion] = None, - display_name: str = None, - access_type: str = None, - provider: str = None, - allowed_scenarios: List[ai_api_client_sdk.models.model_base_data_allowed_scenarios.ModelBaseDataAllowedScenarios] = None, - **kwargs -)
Initialize self.  See help(type(self)) for accurate signature.
- -
-Static methods defined here:
-
from_dict(model_dict: Dict[str, Any])
Returns a :class:`ai_api_client_sdk.models.model.Model` object, created from the values in the dict
-provided as parameter
- 
-:param model_dict: Dict which includes the necessary values to create the object
-:type model_dict: Dict[str, Any]
-:return: An object, created from the values provided
-:rtype: class:`ai_api_client_sdk.models.model.Model`
- -
-Data descriptors defined here:
-
__dict__
-
dictionary for instance variables
-
-
__weakref__
-
list of weak references to the object
-
-

- - - - - -
 
Data
       Dict = typing.Dict
-List = typing.List
- \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.model_base_data_allowed_scenarios.html b/packages/base/docs/ai_api_client_sdk.models.model_base_data_allowed_scenarios.html deleted file mode 100644 index b6e3f44..0000000 --- a/packages/base/docs/ai_api_client_sdk.models.model_base_data_allowed_scenarios.html +++ /dev/null @@ -1,62 +0,0 @@ - - - - -Python: module ai_api_client_sdk.models.model_base_data_allowed_scenarios - - - - - -
 
ai_api_client_sdk.models.model_base_data_allowed_scenarios		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/model_base_data_allowed_scenarios.py
-

-

- - - - - -
 
Classes
       
-
builtins.object -
-
-
ModelBaseDataAllowedScenarios -
-
-
-

- - - - - - - -
 
class ModelBaseDataAllowedScenarios(builtins.object)
   ModelBaseDataAllowedScenarios(scenario_id: str, executable_id: str)
- 
-This class defines the allowed scenarios for the model base data.
 
 Methods defined here:
-
__init__(self, scenario_id: str, executable_id: str)
:param scenario_id: ID of the scenario
-:type scenario_id: str
-:param executable_id: ID of the executable
-:type executable_id: str
- -
-Static methods defined here:
-
from_dict(allowed_scenarios_dict: dict[str, any])
Returns a :class:`ai_api_client_sdk.models.model_base_data_allowed_scenarios.ModelBaseDataAllowedScenarios`
-object, created from the values in the dict provided as parameter
- 
-:param allowed_scenarios_dict: Dict which includes the necessary values to create the object
-:type allowed_scenarios_dict: Dict[str, Any]
-:return: An object, created from the values provided
-:rtype: class:`ai_api_client_sdk.models.model_base_data_allowed_scenarios.ModelBaseDataAllowedScenarios`
- -
-Data descriptors defined here:
-
__dict__
-
dictionary for instance variables
-
-
__weakref__
-
list of weak references to the object
-
-

- \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.model_query_response.html b/packages/base/docs/ai_api_client_sdk.models.model_query_response.html deleted file mode 100644 index da7be2c..0000000 --- a/packages/base/docs/ai_api_client_sdk.models.model_query_response.html +++ /dev/null @@ -1,90 +0,0 @@ - - - - -Python: module ai_api_client_sdk.models.model_query_response - - - - - -
 
ai_api_client_sdk.models.model_query_response		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/model_query_response.py
-

-

- - - - - -
 
Classes
       
-
ai_api_client_sdk.models.base_models.QueryResponse(builtins.object) -
-
-
ModelQueryResponse -
-
-
-

- - - - - - - -
 
class ModelQueryResponse(ai_api_client_sdk.models.base_models.QueryResponse)
   ModelQueryResponse(
-    resources: List[ai_api_client_sdk.models.model.Model],
-    count: int,
-    **kwargs
-)
- 
-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
 
 
Method resolution order:
-
ModelQueryResponse
-
ai_api_client_sdk.models.base_models.QueryResponse
-
builtins.object
-
-
-Methods defined here:
-
__init__( - self, - resources: List[ai_api_client_sdk.models.model.Model], - count: int, - **kwargs -)
Initialize self.  See help(type(self)) for accurate signature.
- -
-Static methods defined here:
-
from_dict(response_dict: Dict[str, Any])
Returns a :class:`ai_api_client_sdk.models.executable_query_response.ModelQueryResponse` object, created
-from the values in the dict provided as parameter
- 
-:param response_dict: Dict which includes the necessary values to create the object
-:type response_dict: Dict[str, Any]
-:return: An object, created from the values provided
-:rtype: class:`ai_api_client_sdk.models.executable_query_response.ModelQueryResponse`
- -
-Methods inherited from ai_api_client_sdk.models.base_models.QueryResponse:
-
__str__(self)
Return str(self).
- -
-Data descriptors inherited from ai_api_client_sdk.models.base_models.QueryResponse:
-
__dict__
-
dictionary for instance variables
-
-
__weakref__
-
list of weak references to the object
-
-

- - - - - -
 
Data
       Dict = typing.Dict
-List = typing.List
- \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.model_version.html b/packages/base/docs/ai_api_client_sdk.models.model_version.html deleted file mode 100644 index bbf3cdc..0000000 --- a/packages/base/docs/ai_api_client_sdk.models.model_version.html +++ /dev/null @@ -1,127 +0,0 @@ - - - - -Python: module ai_api_client_sdk.models.model_version - - - - - -
 
ai_api_client_sdk.models.model_version		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/model_version.py
-

-

- - - - - -
 
Classes
       
-
builtins.object -
-
-
ModelVersion -
-
-
-

- - - - - - - -
 
class ModelVersion(builtins.object)
   ModelVersion(
-    name: str,
-    is_latest: bool,
-    deprecated: bool,
-    retirement_date: Optional[datetime.datetime] = None,
-    context_length: Optional[int] = None,
-    input_types: Optional[List[str]] = None,
-    capabilities: Optional[List[str]] = None,
-    metadata: Optional[Dict[str, str]] = None,
-    cost: Optional[Dict[str, str]] = None,
-    suggested_replacements: Optional[List[str]] = None,
-    streaming_supported: Optional[bool] = None,
-    orchestration_capabilities: Optional[List[str]] = None,
-    **kwargs
-)
- 
-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
 
 Methods defined here:
-
__eq__(self, other)
Return self==value.
- -
__init__( - self, - name: str, - is_latest: bool, - deprecated: bool, - retirement_date: Optional[datetime.datetime] = None, - context_length: Optional[int] = None, - input_types: Optional[List[str]] = None, - capabilities: Optional[List[str]] = None, - metadata: Optional[Dict[str, str]] = None, - cost: Optional[Dict[str, str]] = None, - suggested_replacements: Optional[List[str]] = None, - streaming_supported: Optional[bool] = None, - orchestration_capabilities: Optional[List[str]] = None, - **kwargs -)
Initialize self.  See help(type(self)) for accurate signature.
- -
-Static methods defined here:
-
from_dict(model_version_dict: Dict[str, Any])
Returns a :class:`ai_api_client_sdk.models.model_version.ModelVersion` object, created from the values in the dict
-provided as parameter
- 
-:param model_version_dict: Dict which includes the necessary values to create the object
-:type model_version_dict: Dict[str, Any]
-:return: An object, created from the values provided
-:rtype: class:`ai_api_client_sdk.models.model_version.ModelVersion`
- -
-Data descriptors defined here:
-
__dict__
-
dictionary for instance variables
-
-
__weakref__
-
list of weak references to the object
-
-
-Data and other attributes defined here:
-
__hash__ = None
- -

- - - - - -
 
Data
       Dict = typing.Dict
-List = typing.List
-Optional = typing.Optional
- \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.output_artifact.html b/packages/base/docs/ai_api_client_sdk.models.output_artifact.html deleted file mode 100644 index 1c2b58d..0000000 --- a/packages/base/docs/ai_api_client_sdk.models.output_artifact.html +++ /dev/null @@ -1,93 +0,0 @@ - - - - -Python: module ai_api_client_sdk.models.output_artifact - - - - - -
 
ai_api_client_sdk.models.output_artifact		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/output_artifact.py
-

-

- - - - - -
 
Classes
       
-
builtins.object -
-
-
OutputArtifact -
-
-
-

- - - - - - - -
 
class OutputArtifact(builtins.object)
   OutputArtifact(
-    name: str,
-    kind: str = None,
-    description: str = None,
-    labels: List[ai_api_client_sdk.models.label.Label] = None
-)
- 
-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`]
 
 Methods defined here:
-
__eq__(self, other)
Return self==value.
- -
__init__( - self, - name: str, - kind: str = None, - description: str = None, - labels: List[ai_api_client_sdk.models.label.Label] = None -)
Initialize self.  See help(type(self)) for accurate signature.
- -
__str__(self)
Return str(self).
- -
-Static methods defined here:
-
from_dict(output_artifact_dict: Dict[str, Any])
Returns a :class:`ai_api_client_sdk.models.output_artifact.OutputArtifact` object, created from the values
-in the dict provided as parameter
- 
-:param output_artifact_dict: Dict which includes the necessary values to create the object
-:type output_artifact_dict: Dict[str, Any]
-:return: An object, created from the values provided
-:rtype: class:`ai_api_client_sdk.models.output_artifact.OutputArtifact`
- -
-Data descriptors defined here:
-
__dict__
-
dictionary for instance variables
-
-
__weakref__
-
list of weak references to the object
-
-
-Data and other attributes defined here:
-
__hash__ = None
- -

- - - - - -
 
Data
       Dict = typing.Dict
-List = typing.List
- \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.parameter.html b/packages/base/docs/ai_api_client_sdk.models.parameter.html deleted file mode 100644 index 2c23ff3..0000000 --- a/packages/base/docs/ai_api_client_sdk.models.parameter.html +++ /dev/null @@ -1,98 +0,0 @@ - - - - -Python: module ai_api_client_sdk.models.parameter - - - - - -
 
ai_api_client_sdk.models.parameter		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/parameter.py
-

-

- - - - - -
 
Classes
       
-
builtins.object -
-
-
Parameter -
-
-
-

- - - - - - - -
 
class Parameter(builtins.object)
   Parameter(
-    name: str,
-    type: ai_api_client_sdk.models.parameter.Parameter.Type,
-    description: str = None,
-    default: str = None,
-    **kwargs
-)
- 
-The Parameter object defines the parameter specified in the executable definition.
- 
-:param name: name of the parameter
-:type name: str
-:param type: Type of the parameter
-:type type: class:`ai_api_client_sdk.models.parameter.Parameter.Type`
-:param description: description for parameter
-:type description: str
-:param default: default value for parameter
-:type default: str
-:param `**kwargs`: The keyword arguments are there in case there are additional attributes returned from server
 
 Methods defined here:
-
__eq__(self, other)
Return self==value.
- -
__init__( - self, - name: str, - type: ai_api_client_sdk.models.parameter.Parameter.Type, - description: str = None, - default: str = None, - **kwargs -)
Initialize self.  See help(type(self)) for accurate signature.
- -
__str__(self)
Return str(self).
- -
-Static methods defined here:
-
from_dict(parameter_dict: Dict[str, Any])
Returns a :class:`ai_api_client_sdk.models.parameter.Parameter` object, created from the values in the dict
-provided as parameter
- 
-:param parameter_dict: Dict which includes the necessary values to create the object
-:type parameter_dict: Dict[str, Any]
-:return: An object, created from the values provided
-:rtype: class:`ai_api_client_sdk.models.parameter.Parameter`
- -
-Data descriptors defined here:
-
__dict__
-
dictionary for instance variables
-
-
__weakref__
-
list of weak references to the object
-
-
-Data and other attributes defined here:
-
Type = <enum 'Type'>
- -
__hash__ = None
- -

- - - - - -
 
Data
       Dict = typing.Dict
- \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.parameter_binding.html b/packages/base/docs/ai_api_client_sdk.models.parameter_binding.html deleted file mode 100644 index e9ac637..0000000 --- a/packages/base/docs/ai_api_client_sdk.models.parameter_binding.html +++ /dev/null @@ -1,84 +0,0 @@ - - - - -Python: module ai_api_client_sdk.models.parameter_binding - - - - - -
 
ai_api_client_sdk.models.parameter_binding		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/parameter_binding.py
-

-

- - - - - -
 
Classes
       
-
ai_api_client_sdk.models.base_models.KeyValue(builtins.object) -
-
-
ParameterBinding -
-
-
-

- - - - - - - -
 
class ParameterBinding(ai_api_client_sdk.models.base_models.KeyValue)
   ParameterBinding(key: str, value: str, **kwargs)
- 
-The ParameterBinding object defines the input artifact specified in the configuration, as a key-value pair. Refer
-to :class:`ai_api_client_sdk.models.base_models.KeyValue`, for the object definition
 
 
Method resolution order:
-
ParameterBinding
-
ai_api_client_sdk.models.base_models.KeyValue
-
builtins.object
-
-
-Methods defined here:
-
__str__(self)
Return str(self).
- -
-Static methods defined here:
-
from_dict(parameter_binding_dict: Dict[str, str])
Returns a :class:`ai_api_client_sdk.models.parameter_binding.ParameterBinding` object, created from
-the values in the dict provided as parameter
- 
-:param parameter_binding_dict: Dict which includes the necessary values to create the object
-:type parameter_binding_dict: Dict[str, Any]
-:return: An object, created from the values provided
-:rtype: class:`ai_api_client_sdk.models.parameter_binding.ParameterBinding`
- -
-Methods inherited from ai_api_client_sdk.models.base_models.KeyValue:
-
__eq__(self, other)
Return self==value.
- -
__init__(self, key: str, value: str, **kwargs)
Initialize self.  See help(type(self)) for accurate signature.
- -
to_dict(self)
- -
-Data descriptors inherited from ai_api_client_sdk.models.base_models.KeyValue:
-
__dict__
-
dictionary for instance variables
-
-
__weakref__
-
list of weak references to the object
-
-
-Data and other attributes inherited from ai_api_client_sdk.models.base_models.KeyValue:
-
__hash__ = None
- -

- - - - - -
 
Data
       Dict = typing.Dict
- \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.resource_group.html b/packages/base/docs/ai_api_client_sdk.models.resource_group.html deleted file mode 100644 index 6f38a0d..0000000 --- a/packages/base/docs/ai_api_client_sdk.models.resource_group.html +++ /dev/null @@ -1,92 +0,0 @@ - - - - -Python: module ai_api_client_sdk.models.resource_group - - - - - -
 
ai_api_client_sdk.models.resource_group		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/resource_group.py
-

-

- - - - - -
 
Classes
       
-
builtins.object -
-
-
ResourceGroup -
-
-
-

- - - - - - - -
 
class ResourceGroup(builtins.object)
   ResourceGroup(
-    resource_group_id: str = None,
-    labels: List[ai_api_client_sdk.models.label.Label] = None,
-    status: ai_api_client_sdk.models.resource_group_status.ResourceGroupStatus = None,
-    created_at: datetime.datetime = None,
-    *args,
-    **kwargs
-)
- 
-ResourceGroup represents the resource group.
- 
-:param resource_group_id: The resource_group_id of this ResourceGroup.
-:type resource_group_id: str
-:param labels: The labels of this ResourceGroup.
-:type labels: ResourceGroupLabels
-:param status: The status of this ResourceGroup.
-:type status: str
-:param created_at: Time when the resource group was created
-:type created_at: datetime
 
 Methods defined here:
-
__init__( - self, - resource_group_id: str = None, - labels: List[ai_api_client_sdk.models.label.Label] = None, - status: ai_api_client_sdk.models.resource_group_status.ResourceGroupStatus = None, - created_at: datetime.datetime = None, - *args, - **kwargs -)
Initialize self.  See help(type(self)) for accurate signature.
- -
__str__(self)
Return str(self).
- -
-Static methods defined here:
-
from_dict(resource_group_dict: Dict[str, Any])
Returns a :class:`ai_core_sdk.models.resource_group.ResourceGroup` object, created
-from the values in the dict provided as parameter
- 
-:param resource_group_dict: Dict which includes the necessary values to create the object
-:type resource_group_dict: Dict[str, Any]
-:return: An object, created from the values provided
-:rtype: class:`ai_core_sdk.models.resource_group.ResourceGroup`
- -
-Data descriptors defined here:
-
__dict__
-
dictionary for instance variables
-
-
__weakref__
-
list of weak references to the object
-
-

- - - - - -
 
Data
       Dict = typing.Dict
-List = typing.List
- \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.resource_group_query_response.html b/packages/base/docs/ai_api_client_sdk.models.resource_group_query_response.html deleted file mode 100644 index 9f1a4fd..0000000 --- a/packages/base/docs/ai_api_client_sdk.models.resource_group_query_response.html +++ /dev/null @@ -1,91 +0,0 @@ - - - - -Python: module ai_api_client_sdk.models.resource_group_query_response - - - - - -
 
ai_api_client_sdk.models.resource_group_query_response		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/resource_group_query_response.py
-

-

- - - - - -
 
Classes
       
-
ai_api_client_sdk.models.base_models.QueryResponse(builtins.object) -
-
-
ResourceGroupQueryResponse -
-
-
-

- - - - - - - -
 
class ResourceGroupQueryResponse(ai_api_client_sdk.models.base_models.QueryResponse)
   ResourceGroupQueryResponse(
-    resources: List[ai_api_client_sdk.models.resource_group.ResourceGroup],
-    count: int,
-    **kwargs
-)
- 
-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
 
 
Method resolution order:
-
ResourceGroupQueryResponse
-
ai_api_client_sdk.models.base_models.QueryResponse
-
builtins.object
-
-
-Methods defined here:
-
__init__( - self, - resources: List[ai_api_client_sdk.models.resource_group.ResourceGroup], - count: int, - **kwargs -)
Initialize self.  See help(type(self)) for accurate signature.
- -
-Static methods defined here:
-
from_dict(response_dict: Dict[str, Any])
Returns a
-:class:`ai_core_sdk.models.docker_registry_secret_query_response.DockerRegistrySecretQueryResponse`
-object, created from the values in the dict provided as parameter
- 
-:param response_dict: Dict which includes the necessary values to create the object
-:type response_dict: Dict[str, Any]
-:return: An object, created from the values provided
-:rtype: class:`ai_core_sdk.models.docker_registry_secret_query_response.DockerRegistrySecretQueryResponse`
- -
-Methods inherited from ai_api_client_sdk.models.base_models.QueryResponse:
-
__str__(self)
Return str(self).
- -
-Data descriptors inherited from ai_api_client_sdk.models.base_models.QueryResponse:
-
__dict__
-
dictionary for instance variables
-
-
__weakref__
-
list of weak references to the object
-
-

- - - - - -
 
Data
       Dict = typing.Dict
-List = typing.List
- \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.resource_group_status.html b/packages/base/docs/ai_api_client_sdk.models.resource_group_status.html deleted file mode 100644 index 0918241..0000000 --- a/packages/base/docs/ai_api_client_sdk.models.resource_group_status.html +++ /dev/null @@ -1,82 +0,0 @@ - - - - -Python: module ai_api_client_sdk.models.resource_group_status - - - - - -
 
ai_api_client_sdk.models.resource_group_status		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/resource_group_status.py
-

-

- - - - - -
 
Classes
       
-
enum.Enum(builtins.object) -
-
-
ResourceGroupStatus -
-
-
-

- - - - - - - -
 
class ResourceGroupStatus(enum.Enum)
   ResourceGroupStatus(*values)
- 
-ResourceGroupStatus is an Enum defining the valid values of the status of a resource group
 
 
Method resolution order:
-
ResourceGroupStatus
-
enum.Enum
-
builtins.object
-
-
-Data and other attributes defined here:
-
ERROR = <ResourceGroupStatus.ERROR: 'ERROR'>
- -
PROVISIONED = <ResourceGroupStatus.PROVISIONED: 'PROVISIONED'>
- -
PROVISIONING = <ResourceGroupStatus.PROVISIONING: 'PROVISIONING'>
- -
-Data descriptors inherited from enum.Enum:
-
name
-
The name of the Enum member.
-
-
value
-
The value of the Enum member.
-
-
-Static methods inherited from enum.EnumType:
-
__contains__(value)
Return True if `value` is in `cls`.
- 
-`value` is in `cls` if:
-1) `value` is a member of `cls`, or
-2) `value` is the value of one of the `cls`'s members.
-3) `value` is a pseudo-member (flags)
- -
__getitem__(name)
Return the member matching `name`.
- -
__iter__()
Return members in definition order.
- -
__len__()
Return the number of members (no aliases)
- -
-Readonly properties inherited from enum.EnumType:
-
__members__
-
Returns a mapping of member name->value.
- 
-This mapping lists all enum members, including aliases.  Note that
-this is a read-only view of the internal mapping.
-
-

- \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.scenario.html b/packages/base/docs/ai_api_client_sdk.models.scenario.html deleted file mode 100644 index db28c48..0000000 --- a/packages/base/docs/ai_api_client_sdk.models.scenario.html +++ /dev/null @@ -1,109 +0,0 @@ - - - - -Python: module ai_api_client_sdk.models.scenario - - - - - -
 
ai_api_client_sdk.models.scenario		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/scenario.py
-

-

- - - - - -
 
Classes
       
-
builtins.object -
-
-
Scenario -
-
-
-

- - - - - - - -
 
class Scenario(builtins.object)
   Scenario(
-    id: str,
-    created_at: datetime.datetime,
-    modified_at: datetime.datetime,
-    name: str,
-    description: str = None,
-    labels: List[ai_api_client_sdk.models.label.Label] = None,
-    **kwargs
-)
- 
-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
 
 Methods defined here:
-
__eq__(self, other)
Return self==value.
- -
__init__( - self, - id: str, - created_at: datetime.datetime, - modified_at: datetime.datetime, - name: str, - description: str = None, - labels: List[ai_api_client_sdk.models.label.Label] = None, - **kwargs -)
Initialize self.  See help(type(self)) for accurate signature.
- -
__str__(self)
Return str(self).
- -
is_llm_scenario(self)
Returns if the scenario is a LLM scenario or not
- 
-:return: True if scenario is llm scenario, False otherwise
-:rtype: bool
- -
-Static methods defined here:
-
from_dict(scenario_dict: Dict[str, Any])
Returns a :class:`ai_api_client_sdk.models.scenario.Scenario` object, created from the values in the dict
-provided as parameter
- 
-:param scenario_dict: Dict which includes the necessary values to create the object
-:type scenario_dict: Dict[str, Any]
-:return: An object, created from the values provided
-:rtype: class:`ai_api_client_sdk.models.scenario.Scenario`
- -
-Data descriptors defined here:
-
__dict__
-
dictionary for instance variables
-
-
__weakref__
-
list of weak references to the object
-
-
-Data and other attributes defined here:
-
__hash__ = None
- -

- - - - - -
 
Data
       Dict = typing.Dict
-List = typing.List
- \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.scenario_query_response.html b/packages/base/docs/ai_api_client_sdk.models.scenario_query_response.html deleted file mode 100644 index 9519075..0000000 --- a/packages/base/docs/ai_api_client_sdk.models.scenario_query_response.html +++ /dev/null @@ -1,90 +0,0 @@ - - - - -Python: module ai_api_client_sdk.models.scenario_query_response - - - - - -
 
ai_api_client_sdk.models.scenario_query_response		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/scenario_query_response.py
-

-

- - - - - -
 
Classes
       
-
ai_api_client_sdk.models.base_models.QueryResponse(builtins.object) -
-
-
ScenarioQueryResponse -
-
-
-

- - - - - - - -
 
class ScenarioQueryResponse(ai_api_client_sdk.models.base_models.QueryResponse)
   ScenarioQueryResponse(
-    resources: List[ai_api_client_sdk.models.scenario.Scenario],
-    count: int,
-    **kwargs
-)
- 
-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
 
 
Method resolution order:
-
ScenarioQueryResponse
-
ai_api_client_sdk.models.base_models.QueryResponse
-
builtins.object
-
-
-Methods defined here:
-
__init__( - self, - resources: List[ai_api_client_sdk.models.scenario.Scenario], - count: int, - **kwargs -)
Initialize self.  See help(type(self)) for accurate signature.
- -
-Static methods defined here:
-
from_dict(response_dict: Dict[str, Any])
Returns a :class:`ai_api_client_sdk.models.scenario_query_response.ScenarioQueryResponse` object, created
-from the values in the dict provided as parameter
- 
-:param response_dict: Dict which includes the necessary values to create the object
-:type response_dict: Dict[str, Any]
-:return: An object, created from the values provided
-:rtype: class:`ai_api_client_sdk.models.scenario_query_response.ScenarioQueryResponse`
- -
-Methods inherited from ai_api_client_sdk.models.base_models.QueryResponse:
-
__str__(self)
Return str(self).
- -
-Data descriptors inherited from ai_api_client_sdk.models.base_models.QueryResponse:
-
__dict__
-
dictionary for instance variables
-
-
__weakref__
-
list of weak references to the object
-
-

- - - - - -
 
Data
       Dict = typing.Dict
-List = typing.List
- \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.status.html b/packages/base/docs/ai_api_client_sdk.models.status.html deleted file mode 100644 index 190080c..0000000 --- a/packages/base/docs/ai_api_client_sdk.models.status.html +++ /dev/null @@ -1,143 +0,0 @@ - - - - -Python: module ai_api_client_sdk.models.status - - - - - -
 
ai_api_client_sdk.models.status		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/status.py
-

-

- - - - - -
 
Classes
       
-
enum.Enum(builtins.object) -
-
-
ScheduleStatus -
Status -
-
-
-

- - - - - - - -
 
class ScheduleStatus(enum.Enum)
   ScheduleStatus(*values)
- 
-Enum defining the status values for execution schedules
 
 
Method resolution order:
-
ScheduleStatus
-
enum.Enum
-
builtins.object
-
-
-Data and other attributes defined here:
-
ACTIVE = <ScheduleStatus.ACTIVE: 'ACTIVE'>
- -
INACTIVE = <ScheduleStatus.INACTIVE: 'INACTIVE'>
- -
-Data descriptors inherited from enum.Enum:
-
name
-
The name of the Enum member.
-
-
value
-
The value of the Enum member.
-
-
-Static methods inherited from enum.EnumType:
-
__contains__(value)
Return True if `value` is in `cls`.
- 
-`value` is in `cls` if:
-1) `value` is a member of `cls`, or
-2) `value` is the value of one of the `cls`'s members.
-3) `value` is a pseudo-member (flags)
- -
__getitem__(name)
Return the member matching `name`.
- -
__iter__()
Return members in definition order.
- -
__len__()
Return the number of members (no aliases)
- -
-Readonly properties inherited from enum.EnumType:
-
__members__
-
Returns a mapping of member name->value.
- 
-This mapping lists all enum members, including aliases.  Note that
-this is a read-only view of the internal mapping.
-
-

- - - - - - - -
 
class Status(enum.Enum)
   Status(*values)
- 
-Status is an Enum defining the valid values of the status of an execution/deployment
 
 
Method resolution order:
-
Status
-
enum.Enum
-
builtins.object
-
-
-Data and other attributes defined here:
-
COMPLETED = <Status.COMPLETED: 'COMPLETED'>
- -
DEAD = <Status.DEAD: 'DEAD'>
- -
PENDING = <Status.PENDING: 'PENDING'>
- -
RUNNING = <Status.RUNNING: 'RUNNING'>
- -
STOPPED = <Status.STOPPED: 'STOPPED'>
- -
STOPPING = <Status.STOPPING: 'STOPPING'>
- -
UNKNOWN = <Status.UNKNOWN: 'UNKNOWN'>
- -
-Data descriptors inherited from enum.Enum:
-
name
-
The name of the Enum member.
-
-
value
-
The value of the Enum member.
-
-
-Static methods inherited from enum.EnumType:
-
__contains__(value)
Return True if `value` is in `cls`.
- 
-`value` is in `cls` if:
-1) `value` is a member of `cls`, or
-2) `value` is the value of one of the `cls`'s members.
-3) `value` is a pseudo-member (flags)
- -
__getitem__(name)
Return the member matching `name`.
- -
__iter__()
Return members in definition order.
- -
__len__()
Return the number of members (no aliases)
- -
-Readonly properties inherited from enum.EnumType:
-
__members__
-
Returns a mapping of member name->value.
- 
-This mapping lists all enum members, including aliases.  Note that
-this is a read-only view of the internal mapping.
-
-

- \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.target_status.html b/packages/base/docs/ai_api_client_sdk.models.target_status.html deleted file mode 100644 index 52ed398..0000000 --- a/packages/base/docs/ai_api_client_sdk.models.target_status.html +++ /dev/null @@ -1,84 +0,0 @@ - - - - -Python: module ai_api_client_sdk.models.target_status - - - - - -
 
ai_api_client_sdk.models.target_status		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/target_status.py
-

-

- - - - - -
 
Classes
       
-
enum.Enum(builtins.object) -
-
-
TargetStatus -
-
-
-

- - - - - - - -
 
class TargetStatus(enum.Enum)
   TargetStatus(*values)
- 
-TargetStatus is an Enum defining the valid values of the target status of an execution/deployment
 
 
Method resolution order:
-
TargetStatus
-
enum.Enum
-
builtins.object
-
-
-Data and other attributes defined here:
-
COMPLETED = <TargetStatus.COMPLETED: 'COMPLETED'>
- -
DELETED = <TargetStatus.DELETED: 'DELETED'>
- -
RUNNING = <TargetStatus.RUNNING: 'RUNNING'>
- -
STOPPED = <TargetStatus.STOPPED: 'STOPPED'>
- -
-Data descriptors inherited from enum.Enum:
-
name
-
The name of the Enum member.
-
-
value
-
The value of the Enum member.
-
-
-Static methods inherited from enum.EnumType:
-
__contains__(value)
Return True if `value` is in `cls`.
- 
-`value` is in `cls` if:
-1) `value` is a member of `cls`, or
-2) `value` is the value of one of the `cls`'s members.
-3) `value` is a pseudo-member (flags)
- -
__getitem__(name)
Return the member matching `name`.
- -
__iter__()
Return members in definition order.
- -
__len__()
Return the number of members (no aliases)
- -
-Readonly properties inherited from enum.EnumType:
-
__members__
-
Returns a mapping of member name->value.
- 
-This mapping lists all enum members, including aliases.  Note that
-this is a read-only view of the internal mapping.
-
-

- \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.version.html b/packages/base/docs/ai_api_client_sdk.models.version.html deleted file mode 100644 index 01c5c0c..0000000 --- a/packages/base/docs/ai_api_client_sdk.models.version.html +++ /dev/null @@ -1,93 +0,0 @@ - - - - -Python: module ai_api_client_sdk.models.version - - - - - -
 
ai_api_client_sdk.models.version		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/version.py
-

-

- - - - - -
 
Classes
       
-
builtins.object -
-
-
Version -
-
-
-

- - - - - - - -
 
class Version(builtins.object)
   Version(
-    id: str,
-    scenario_id: str,
-    created_at: datetime.datetime,
-    modified_at: datetime.datetime,
-    description: str = None,
-    **kwargs
-)
- 
-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
 
 Methods defined here:
-
__init__( - self, - id: str, - scenario_id: str, - created_at: datetime.datetime, - modified_at: datetime.datetime, - description: str = None, - **kwargs -)
Initialize self.  See help(type(self)) for accurate signature.
- -
__str__(self)
Return str(self).
- -
-Static methods defined here:
-
from_dict(version_dict: Dict[str, Any])
Returns a :class:`ai_api_client_sdk.models.version.Version` object, created from the values in the dict
-provided as parameter
- 
-:param version_dict: Dict which includes the necessary values to create the object
-:type version_dict: Dict[str, Any]
-:return: An object, created from the values provided
-:rtype: class:`ai_api_client_sdk.models.version.Version`
- -
-Data descriptors defined here:
-
__dict__
-
dictionary for instance variables
-
-
__weakref__
-
list of weak references to the object
-
-

- - - - - -
 
Data
       Dict = typing.Dict
- \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.version_list.html b/packages/base/docs/ai_api_client_sdk.models.version_list.html deleted file mode 100644 index d3a6baa..0000000 --- a/packages/base/docs/ai_api_client_sdk.models.version_list.html +++ /dev/null @@ -1,77 +0,0 @@ - - - - -Python: module ai_api_client_sdk.models.version_list - - - - - -
 
ai_api_client_sdk.models.version_list		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/version_list.py
-

-

- - - - - -
 
Classes
       
-
builtins.object -
-
-
VersionList -
-
-
-

- - - - - - - -
 
class VersionList(builtins.object)
   VersionList(
-    versions: List[ai_api_client_sdk.models.api_version.APIVersion] = None
-)
- 
-The VersionList object, is a list of API version descriptions
- 
-:param versions: A list of objects describing the API versions, defaults to None
-:type versions: class:`ai_api_client_sdk.models.api_version.APIVersion`, optional
-:param `**kwargs`: The keyword arguments are there in case there are additional attributes returned from server
 
 Methods defined here:
-
__init__( - self, - versions: List[ai_api_client_sdk.models.api_version.APIVersion] = None -)
Initialize self.  See help(type(self)) for accurate signature.
- -
__str__(self)
Return str(self).
- -
-Static methods defined here:
-
from_dict(version_list_dict: Dict[str, List[Dict[str, str]]])
Returns a :class:`ai_api_client_sdk.models.version_list.VersionList` object, created from the
-values in the dict provided as parameter
- 
-:param version_list_dict: Dict which includes the necessary values to create the object
-:type version_list_dict: Dict[str, List[Dict[str, str]]
-:return: An object, created from the values provided
-:rtype: class:`ai_api_client_sdk.models.version_list.VersionList`
- -
-Data descriptors defined here:
-
__dict__
-
dictionary for instance variables
-
-
__weakref__
-
list of weak references to the object
-
-

- - - - - -
 
Data
       Dict = typing.Dict
-List = typing.List
- \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.version_query_response.html b/packages/base/docs/ai_api_client_sdk.models.version_query_response.html deleted file mode 100644 index c8cca65..0000000 --- a/packages/base/docs/ai_api_client_sdk.models.version_query_response.html +++ /dev/null @@ -1,90 +0,0 @@ - - - - -Python: module ai_api_client_sdk.models.version_query_response - - - - - -
 
ai_api_client_sdk.models.version_query_response		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/version_query_response.py
-

-

- - - - - -
 
Classes
       
-
ai_api_client_sdk.models.base_models.QueryResponse(builtins.object) -
-
-
VersionQueryResponse -
-
-
-

- - - - - - - -
 
class VersionQueryResponse(ai_api_client_sdk.models.base_models.QueryResponse)
   VersionQueryResponse(
-    resources: List[ai_api_client_sdk.models.version.Version],
-    count: int,
-    **kwargs
-)
- 
-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
 
 
Method resolution order:
-
VersionQueryResponse
-
ai_api_client_sdk.models.base_models.QueryResponse
-
builtins.object
-
-
-Methods defined here:
-
__init__( - self, - resources: List[ai_api_client_sdk.models.version.Version], - count: int, - **kwargs -)
Initialize self.  See help(type(self)) for accurate signature.
- -
-Static methods defined here:
-
from_dict(response_dict: Dict[str, Any])
Returns a :class:`ai_api_client_sdk.models.version_query_response.VersionQueryResponse` object, created
-from the values in the dict provided as parameter
- 
-:param response_dict: Dict which includes the necessary values to create the object
-:type response_dict: Dict[str, Any]
-:return: An object, created from the values provided
-:rtype: class:`ai_api_client_sdk.models.version_query_response.VersionQueryResponse`
- -
-Methods inherited from ai_api_client_sdk.models.base_models.QueryResponse:
-
__str__(self)
Return str(self).
- -
-Data descriptors inherited from ai_api_client_sdk.models.base_models.QueryResponse:
-
__dict__
-
dictionary for instance variables
-
-
__weakref__
-
list of weak references to the object
-
-

- - - - - -
 
Data
       Dict = typing.Dict
-List = typing.List
- \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.resource_clients.artifact_client.html b/packages/base/docs/ai_api_client_sdk.resource_clients.artifact_client.html deleted file mode 100644 index 20ac44b..0000000 --- a/packages/base/docs/ai_api_client_sdk.resource_clients.artifact_client.html +++ /dev/null @@ -1,212 +0,0 @@ - - - - -Python: module ai_api_client_sdk.resource_clients.artifact_client - - - - - -
 
ai_api_client_sdk.resource_clients.artifact_client		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/resource_clients/artifact_client.py
-

-

- - - - - -
 
Classes
       
-
ai_api_client_sdk.resource_clients.base_client.BaseClient(builtins.object) -
-
-
ArtifactClient -
-
-
-

- - - - - - - -
 
class ArtifactClient(ai_api_client_sdk.resource_clients.base_client.BaseClient)
   ArtifactClient(rest_client: ai_api_client_sdk.helpers.rest_client.RestClient)
- 
-ArtifactClient is a class implemented for interacting with the artifact related endpoints of the server. It
-implements the base class :class:`ai_api_client_sdk.resource_clients.base_client.BaseClient`
 
 
Method resolution order:
-
ArtifactClient
-
ai_api_client_sdk.resource_clients.base_client.BaseClient
-
builtins.object
-
-
-Methods defined here:
-
count( - self, - scenario_id: str = None, - execution_id: str = None, - name: str = None, - kind: ai_api_client_sdk.models.artifact.Artifact.Kind = None, - artifact_label_selector: List[str] = None, - resource_group: str = None -) -> int
Counts the artifacts.
- 
-:param scenario_id: ID of the scenario the artifacts should belong to, defaults to None
-:type scenario_id: str, optional
-:param execution_id: ID of the execution the artifact should be resulted from, defaults to None
-:type execution_id: str, optional
-:param name: Name of the artifact(s) to be retrieved, defaults to None
-:type name: str, optional
-:param kind: Kind of the artifacts to be retrieved, defaults to None
-:type kind: class:`ai_api_client_sdk.models.artifact.Artifact.Kind`, optional
-:param artifact_label_selector: 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
-:type artifact_label_selector: List[str], optional
-:param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
-    resource group in the :class:`ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client` should be specified,
-    defaults to None
-:type resource_group: str
-: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
-:return: An object representing the response from the server
-:rtype: int
- -
create( - self, - name: str, - kind: ai_api_client_sdk.models.artifact.Artifact.Kind, - url: str, - scenario_id: str, - description: str = None, - labels: List[ai_api_client_sdk.models.label.Label] = None, - resource_group: str = None -) -> ai_api_client_sdk.models.artifact_create_response.ArtifactCreateResponse
Creates an artifact.
- 
-:param name: Name of the artifact
-:type name: str
-:param kind: Kind of the artifact
-:type kind: class:`ai_api_client_sdk.models.artifact.Artifact.Kind`
-:param url: URL of the artifact
-:type url: str
-:param scenario_id: ID of the scenario which the artifact should belong to
-:type scenario_id: str
-:param description: Description of the artifact, defaults to None
-:type description: str, optional
-:param labels: List of the labels of the artifact, defaults to None
-:type labels: List[class:`ai_api_client_sdk.models.label.Label`]
-:param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
-    resource group in the :class:`ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client` should be specified,
-    defaults to None
-:type resource_group: str
-: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
-:return: An object representing the response from the server
-:rtype: class:`ai_api_client_sdk.models.artifact_create_response.ArtifactCreateResponse`
- -
get(self, artifact_id: str, expand: str = None, resource_group: str = None) -> ai_api_client_sdk.models.artifact.Artifact
Retrieves the artifact from the server.
- 
-:param artifact_id: ID of the artifact to be retrieved
-:type artifact_id: str
-:param expand: Entity whose details to be displayed in the response, defaults to None
-:type expand: str, optional
-:param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
-    resource group in the :class:`ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client` should be specified,
-    defaults to None
-:type resource_group: str
-: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: The retrieved artifact
-:rtype: class:`ai_api_client_sdk.models.artifact.Artifact`
- -
query( - self, - scenario_id: str = None, - execution_id: str = None, - name: str = None, - kind: ai_api_client_sdk.models.artifact.Artifact.Kind = None, - artifact_label_selector: List[str] = None, - top: int = None, - skip: int = None, - search: str = None, - search_case_insensitive: bool = None, - expand: str = None, - resource_group: str = None -) -> ai_api_client_sdk.models.artifact_query_response.ArtifactQueryResponse
Queries the artifacts.
- 
-:param scenario_id: ID of the scenario the artifacts should belong to, defaults to None
-:type scenario_id: str, optional
-:param execution_id: ID of the execution the artifact should be resulted from, defaults to None
-:type execution_id: str, optional
-:param name: Name of the artifact(s) to be retrieved, defaults to None
-:type name: str, optional
-:param kind: Kind of the artifacts to be retrieved, defaults to None
-:type kind: class:`ai_api_client_sdk.models.artifact.Artifact.Kind`, optional
-:param artifact_label_selector: Query the artifacts based on their labels in the form of "key=value" or
-    "key!=value" separated by commas, defaults to None
-:type artifact_label_selector: list, optional
-:param top: Number of artifacts to be retrieved, defaults to None
-:type top: int, optional
-:param skip: Number of artifacts to be skipped, from the list of the queried artifacts, defaults to None
-:type skip: int, optional
-:param search: Generic search term to be looked for in various attributes of artifacts, defaults to None
-:type search: str, optional
-:param search_case_insensitive: Indicates whether the search should be case insensitive
-:type search_case_insensitive: bool, optional
-:param expand: Entity whose details to be displayed in the response, defaults to None
-:type expand: str, optional
-:param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
-    resource group in the :class:`ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client` should be specified,
-    defaults to None
-:type resource_group: str
-: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
-:return: An object representing the response from the server
-:rtype: class:`ai_api_client_sdk.models.artifact_query_response.ArtifactQueryResponse`
- -
-Methods inherited from ai_api_client_sdk.resource_clients.base_client.BaseClient:
-
__init__(self, rest_client: ai_api_client_sdk.helpers.rest_client.RestClient)
Initialize self.  See help(type(self)) for accurate signature.
- -
bulk_modify(self, *args, **kwargs)
Modifies multiple instances of the relevant resource. Will be implemented by the respective resource clients
- -
delete(self, *args, **kwargs)
Deletes the relevant resource. Will be implemented by the respective resource clients
- -
modify(self, *args, **kwargs)
Modifies the relevant resource. Will be implemented by the respective resource clients
- -
query_logs(self, *args, **kwargs)
Queries the relevant logs. Will be implemented by the respective resource clients
- -
-Data descriptors inherited from ai_api_client_sdk.resource_clients.base_client.BaseClient:
-
__dict__
-
dictionary for instance variables
-
-
__weakref__
-
list of weak references to the object
-
-

- - - - - -
 
Data
       List = typing.List
- \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.resource_clients.base_client.html b/packages/base/docs/ai_api_client_sdk.resource_clients.base_client.html deleted file mode 100644 index c1400f0..0000000 --- a/packages/base/docs/ai_api_client_sdk.resource_clients.base_client.html +++ /dev/null @@ -1,75 +0,0 @@ - - - - -Python: module ai_api_client_sdk.resource_clients.base_client - - - - - -
 
ai_api_client_sdk.resource_clients.base_client		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/resource_clients/base_client.py
-

-

- - - - - -
 
Classes
       
-
builtins.object -
-
-
BaseClient -
-
-
-

- - - - - - - -
 
class BaseClient(builtins.object)
   BaseClient(rest_client: ai_api_client_sdk.helpers.rest_client.RestClient)
- 
-BaseClient defines the interface for the resource clients.
- 
-:param rest_client: the client used to make calls to the server
-:type rest_client: class:`ai_api_client_sdk.helpers.rest_client.RestClient`
 
 Methods defined here:
-
__init__(self, rest_client: ai_api_client_sdk.helpers.rest_client.RestClient)
Initialize self.  See help(type(self)) for accurate signature.
- -
bulk_modify(self, *args, **kwargs)
Modifies multiple instances of the relevant resource. Will be implemented by the respective resource clients
- -
count(self, *args, **kwargs)
Counts the relevant resources. Will be implemented by the respective resource clients
- -
create(self, *args, **kwargs)
Creates the relevant resource. Will be implemented by the respective resource clients
- -
delete(self, *args, **kwargs)
Deletes the relevant resource. Will be implemented by the respective resource clients
- -
get(self, *args, **kwargs)
Retrieves the relevant resource. Will be implemented by the respective resource clients
- -
modify(self, *args, **kwargs)
Modifies the relevant resource. Will be implemented by the respective resource clients
- -
query(self, *args, **kwargs)
Queries the relevant resources. Will be implemented by the respective resource clients
- -
query_logs(self, *args, **kwargs)
Queries the relevant logs. Will be implemented by the respective resource clients
- -
-Data descriptors defined here:
-
__dict__
-
dictionary for instance variables
-
-
__weakref__
-
list of weak references to the object
-
-

- - - - - -
 
Data
       DATETIME_FORMAT = '%Y-%m-%dT%H:%M:%SZ'
-Dict = typing.Dict
- \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.resource_clients.configuration_client.html b/packages/base/docs/ai_api_client_sdk.resource_clients.configuration_client.html deleted file mode 100644 index c5f5fe1..0000000 --- a/packages/base/docs/ai_api_client_sdk.resource_clients.configuration_client.html +++ /dev/null @@ -1,197 +0,0 @@ - - - - -Python: module ai_api_client_sdk.resource_clients.configuration_client - - - - - -
 
ai_api_client_sdk.resource_clients.configuration_client		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/resource_clients/configuration_client.py
-

-

- - - - - -
 
Classes
       
-
ai_api_client_sdk.resource_clients.base_client.BaseClient(builtins.object) -
-
-
ConfigurationClient -
-
-
-

- - - - - - - -
 
class ConfigurationClient(ai_api_client_sdk.resource_clients.base_client.BaseClient)
   ConfigurationClient(
-    rest_client: ai_api_client_sdk.helpers.rest_client.RestClient
-)
- 
-ConfigurationClient is a class implemented for interacting with the configuration related endpoints of the
-server. It implements the base class :class:`ai_api_client_sdk.resource_clients.base_client.BaseClient`
 
 
Method resolution order:
-
ConfigurationClient
-
ai_api_client_sdk.resource_clients.base_client.BaseClient
-
builtins.object
-
-
-Methods defined here:
-
count( - self, - scenario_id: str = None, - executable_ids: List[str] = None, - search: str = None, - resource_group: str = None -) -> int
Counts the configurations.
- 
-:param scenario_id: ID of the scenario the configurations should belong to, defaults to None
-:type scenario_id: str, optional
-:param executable_ids: IDs of the executables the configurations should have configured, defaults to None
-:type executable_ids: List[str], optional
-:param search: Generic search term to be looked for in various attributes of configurations, defaults to None
-:type search: str, optional
-:param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
-    resource group in the :class:`ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client` should be specified,
-    defaults to None
-:type resource_group: str
-: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
-:return: An object representing the response from the server
-:rtype: int
- -
create( - self, - name: str, - scenario_id: str, - executable_id: str, - parameter_bindings: List[ai_api_client_sdk.models.parameter_binding.ParameterBinding] = None, - input_artifact_bindings: List[ai_api_client_sdk.models.input_artifact_binding.InputArtifactBinding] = None, - resource_group: str = None -) -> ai_api_client_sdk.models.configuration_create_response.ConfigurationCreateResponse
Creates a configuration.
- 
-:param name: Name of the configuration
-:type name: str
-:param scenario_id: ID of the scenario which the configuration should belong to
-:type scenario_id: str
-:param executable_id: ID of the executable, which should be configured
-:type executable_id: str
-:param parameter_bindings: List of the input parameters, defaults to None
-:type parameter_bindings: List[class:`ai_api_client_sdk.models.parameter_binding.ParameterBinding`], optional
-:param input_artifact_bindings: List of the input artifacts which are to be used by the executable,
-    defaults to None
-:type input_artifact_bindings:
-    List[class:`ai_api_client_sdk.models.input_artifact_binding.InputArtifactBinding`], optional
-:param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
-    resource group in the :class:`ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client` should be specified,
-    defaults to None
-:type resource_group: str
-: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
-:return: An object representing the response from the server
-:rtype: class:`ai_api_client_sdk.models.configuration_create_response.ConfigurationCreateResponse`
- -
get(self, configuration_id: str, expand: str = None, resource_group: str = None) -> ai_api_client_sdk.models.configuration.Configuration
Retrieves the configuration from the server.
- 
-:param configuration_id: ID of the configuration to be retrieved
-:type configuration_id: str
-:param expand: Entity whose details to be displayed in the response, defaults to None
-:type expand: str, optional
-:param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
-    resource group in the :class:`ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client` should be specified,
-    defaults to None
-:type resource_group: str
-: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: The retrieved configuration
-:rtype: class:`ai_api_client_sdk.models.configuration.Configuration`
- -
query( - self, - scenario_id: str = None, - executable_ids: List[str] = None, - top: int = None, - skip: int = None, - search: str = None, - search_case_insensitive: bool = None, - expand: str = None, - resource_group: str = None -) -> ai_api_client_sdk.models.configuration_query_response.ConfigurationQueryResponse
Queries the configurations.
- 
-:param scenario_id: ID of the scenario the configurations should belong to, defaults to None
-:type scenario_id: str, optional
-:param executable_ids: IDs of the executables the configurations should have configured, defaults to None
-:type executable_ids: List[str], optional
-:param top: Number of configurations to be retrieved, defaults to None
-:type top: int, optional
-:param skip: Number of configurations to be skipped, from the list of the queried configurations, defaults to
-    None
-:type skip: int, optional
-:param search: Generic search term to be looked for in various attributes of configurations, defaults to None
-:type search: str, optional
-:param search_case_insensitive: Indicates whether the search should be case insensitive
-:type search_case_insensitive: bool, optional
-:param expand: Entity whose details to be displayed in the response, defaults to None
-:type expand: str, optional
-:param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
-    resource group in the :class:`ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client` should be specified,
-    defaults to None
-:type resource_group: str
-: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
-:return: An object representing the response from the server
-:rtype: class:`ai_api_client_sdk.models.configuration_query_response.ConfigurationQueryResponse`
- -
-Methods inherited from ai_api_client_sdk.resource_clients.base_client.BaseClient:
-
__init__(self, rest_client: ai_api_client_sdk.helpers.rest_client.RestClient)
Initialize self.  See help(type(self)) for accurate signature.
- -
bulk_modify(self, *args, **kwargs)
Modifies multiple instances of the relevant resource. Will be implemented by the respective resource clients
- -
delete(self, *args, **kwargs)
Deletes the relevant resource. Will be implemented by the respective resource clients
- -
modify(self, *args, **kwargs)
Modifies the relevant resource. Will be implemented by the respective resource clients
- -
query_logs(self, *args, **kwargs)
Queries the relevant logs. Will be implemented by the respective resource clients
- -
-Data descriptors inherited from ai_api_client_sdk.resource_clients.base_client.BaseClient:
-
__dict__
-
dictionary for instance variables
-
-
__weakref__
-
list of weak references to the object
-
-

- - - - - -
 
Data
       List = typing.List
- \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.resource_clients.deployment_client.html b/packages/base/docs/ai_api_client_sdk.resource_clients.deployment_client.html deleted file mode 100644 index 92277d8..0000000 --- a/packages/base/docs/ai_api_client_sdk.resource_clients.deployment_client.html +++ /dev/null @@ -1,280 +0,0 @@ - - - - -Python: module ai_api_client_sdk.resource_clients.deployment_client - - - - - -
 
ai_api_client_sdk.resource_clients.deployment_client		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/resource_clients/deployment_client.py
-

-

- - - - - -
 
Classes
       
-
ai_api_client_sdk.resource_clients.base_client.BaseClient(builtins.object) -
-
-
DeploymentClient -
-
-
-

- - - - - - - -
 
class DeploymentClient(ai_api_client_sdk.resource_clients.base_client.BaseClient)
   DeploymentClient(rest_client: ai_api_client_sdk.helpers.rest_client.RestClient)
- 
-DeploymentClient is a class implemented for interacting with the deployment related endpoints of the server. It
-implements the base class :class:`ai_api_client_sdk.resource_clients.base_client.BaseClient`
 
 
Method resolution order:
-
DeploymentClient
-
ai_api_client_sdk.resource_clients.base_client.BaseClient
-
builtins.object
-
-
-Methods defined here:
-
bulk_modify( - self, - deployments: List[ai_api_client_sdk.models.base_models.BasicModifyRequest], - resource_group: str = None -) -> ai_api_client_sdk.models.deployment_bulk_modify_response.DeploymentBulkModifyResponse
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 :class:`ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client` should be specified,
-    defaults to None
-:type resource_group: str
-: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
-:return: An object representing the response from the server
-:rtype: class:`ai_api_client_sdk.models.deployment_bulk_modify_response.DeploymentBulkModifyResponse`
- -
count( - self, - scenario_id: str = None, - configuration_id: str = None, - executable_ids: List[str] = None, - status: ai_api_client_sdk.models.status.Status = None, - resource_group: str = None -) -> int
Counts the number of deployments.
- 
-:param scenario_id: ID of the scenario, the deployments should belong to, defaults to None
-:type scenario_id: str, optional
-:param configuration_id: ID of the configuration, the deployments should be configured by, defaults to None
-:type configuration_id: str, optional
-:param executable_ids: IDs of the executables, the deployments should be created from, defaults to None
-:type executable_ids: List[str], optional
-:param status: Status which the deployments should currently have
-:type status: class:`ai_api_client_sdk.models.status.Status`, optional
-:param resource_group: Resource group which the request should be sent on behalf. Either this or a default
-    resource group in the :class:`ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client` should be specified,
-    defaults to None
-:type resource_group: str
-: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
-:return: An object representing the response from the server
-:rtype: int
- -
create(self, configuration_id: str, ttl: str = None, resource_group: str = None) -> ai_api_client_sdk.models.deployment_create_response.DeploymentCreateResponse
Creates a deployment.
- 
-:param configuration_id: ID of the configuration, that should configure the deployment
-:type configuration_id: str
-:param ttl: Time to live for deployment and can be none or take  a number followed by the unit
-(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 :class:`ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client` should be specified,
-    defaults to None
-:type resource_group: str
-: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
-:return: An object representing the response from the server
-:rtype: class:`ai_api_client_sdk.models.deployment_create_response.DeploymentCreateResponse`
- -
delete(self, deployment_id: str, resource_group: str = None) -> ai_api_client_sdk.models.base_models.BasicResponse
Deletes the deployment.
- 
-:param deployment_id: ID of the deployment to be deleted
-:type deployment_id: str
-:param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
-    resource group in the :class:`ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client` should be specified,
-    defaults to None
-:type resource_group: str
-: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
-:return: An object representing the response from the server
-:rtype: class:`ai_api_client_sdk.models.base_models.BasicResponse`
- -
get(self, deployment_id: str, resource_group: str = None, select: str = None) -> Union[ai_api_client_sdk.models.deployment.Deployment, ai_api_client_sdk.models.deployment_get_status_response.DeploymentGetStatusResponse]
Retrieves the deployment from the server.
- 
-:param deployment_id: ID of the deployment to be retrieved
-:type deployment_id: str
-:param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
-    resource group in the :class:`ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client` should be specified,
-    defaults to None
-:type resource_group: str
-:param select: only status supported. Get deployment for a given deployment id and select status
-:type select: str, optional
-: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: The retrieved deployment
-:rtype: class:Union[`ai_api_client_sdk.models.deployment.Deployment`,
-    `ai_api_client_sdk.models.deployment_get_status_response.DeploymentGetStatusResponse`]
- -
modify( - self, - deployment_id: str, - target_status: ai_api_client_sdk.models.target_status.TargetStatus = None, - configuration_id: str = None, - resource_group: str = None -) -> ai_api_client_sdk.models.base_models.BasicResponse
Modifies the deployment, by changing either the target status, or the configuration ID.
- 
-:param deployment_id: ID of the deployment to be modified
-:type deployment_id: str
-:param target_status: Desired target status of the deployment, defaults to None
-:type target_status: class:`ai_api_client_sdk.models.target_status.TargetStatus`, optional
-:param configuration_id: ID of the new configuration to be used by the deployment, defaults to None
-:type configuration_id: str, optional
-:param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
-    resource group in the :class:`ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client` should be specified,
-    defaults to None
-:type resource_group: str
-: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
-:return: An object representing the response from the server
-:rtype: class:`ai_api_client_sdk.models.base_models.BasicResponse`
- -
query( - self, - scenario_id: str = None, - configuration_id: str = None, - executable_ids: List[str] = None, - status: ai_api_client_sdk.models.status.Status = None, - top: int = None, - skip: int = None, - resource_group: str = None -) -> ai_api_client_sdk.models.deployment_query_response.DeploymentQueryResponse
Queries the deployments.
- 
-:param scenario_id: ID of the scenario the deployments should belong to, defaults to None
-:type scenario_id: str, optional
-:param configuration_id: ID of the configuration, the deployments should be configured by, defaults to None
-:type configuration_id: str, optional
-:param executable_ids: IDs of the executables the deployments should be created from, defaults to None
-:type executable_ids: List[str], optional
-:param status: Status which the deployments should currently have
-:type status: class:`ai_api_client_sdk.models.status.Status`, optional
-:param top: Number of deployments to be retrieved, defaults to None
-:type top: int, optional
-:param skip: Number of deployments to be skipped, from the list of the queried deployments, defaults to None
-:type skip: int, optional
-:param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
-    resource group in the :class:`ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client` should be specified,
-    defaults to None
-:type resource_group: str
-: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
-:return: An object representing the response from the server
-:rtype: class:`ai_api_client_sdk.models.deployment_query_response.DeploymentQueryResponse`
- -
query_logs( - self, - deployment_id: str, - top: int = None, - start: datetime.datetime = None, - end: datetime.datetime = None, - order: ai_api_client_sdk.models.base_models.Order = None, - resource_group: str = None -) -> ai_api_client_sdk.models.log_response.LogResponse
Queries the logs of the deployment.
- 
-:param deployment_id: ID of the deployment
-:type deployment_id: str
-:param top: The max number of entries to return. Defaults to 1000. Limited to 5000 max.
-:type top: int
-:param start: The start time for the query. Defaults to one hour ago.
-:type start: datetime
-:param end: The end time for the query. Defaults to now.
-:type end: datetime
-:param order: Determines the sort order with respect to time. Defaults to asc.
-:type order: class:`ai_api_client_sdk.models.base_models.Order`
-:param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
-    resource group in the :class:`ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client` should be specified,
-    defaults to None
-:type resource_group: str
-: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: Logs from the execution
-:rtype: class:`ai_api_client_sdk.models.log_response.LogResponse`
- -
-Methods inherited from ai_api_client_sdk.resource_clients.base_client.BaseClient:
-
__init__(self, rest_client: ai_api_client_sdk.helpers.rest_client.RestClient)
Initialize self.  See help(type(self)) for accurate signature.
- -
-Data descriptors inherited from ai_api_client_sdk.resource_clients.base_client.BaseClient:
-
__dict__
-
dictionary for instance variables
-
-
__weakref__
-
list of weak references to the object
-
-

- - - - - -
 
Data
       List = typing.List
-Union = typing.Union
- \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.resource_clients.executable_client.html b/packages/base/docs/ai_api_client_sdk.resource_clients.executable_client.html deleted file mode 100644 index 2f6e1fb..0000000 --- a/packages/base/docs/ai_api_client_sdk.resource_clients.executable_client.html +++ /dev/null @@ -1,115 +0,0 @@ - - - - -Python: module ai_api_client_sdk.resource_clients.executable_client - - - - - -
 
ai_api_client_sdk.resource_clients.executable_client		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/resource_clients/executable_client.py
-

-

- - - - - -
 
Classes
       
-
ai_api_client_sdk.resource_clients.base_client.BaseClient(builtins.object) -
-
-
ExecutableClient -
-
-
-

- - - - - - - -
 
class ExecutableClient(ai_api_client_sdk.resource_clients.base_client.BaseClient)
   ExecutableClient(rest_client: ai_api_client_sdk.helpers.rest_client.RestClient)
- 
-ExecutableClient is a class implemented for interacting with the executable related endpoints of the server. It
-implements the base class :class:`ai_api_client_sdk.resource_clients.base_client.BaseClient`
 
 
Method resolution order:
-
ExecutableClient
-
ai_api_client_sdk.resource_clients.base_client.BaseClient
-
builtins.object
-
-
-Methods defined here:
-
get(self, scenario_id: str, executable_id: str, resource_group: str = None) -> ai_api_client_sdk.models.executable.Executable
Retrieves the executable from the server.
- 
-:param scenario_id: ID of the scenario the executable belongs to
-:type scenario_id: str
-:param executable_id: ID of the executable to be retrieved
-:type executable_id: str
-:param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
-    resource group in the :class:`ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client` should be specified,
-    defaults to None
-:type resource_group: str
-: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: The retrieved executable
-:rtype: class:`ai_api_client_sdk.models.executable.Executable`
- -
query( - self, - scenario_id: str, - version_id: str = None, - resource_group: str = None -) -> ai_api_client_sdk.models.executable_query_response.ExecutableQueryResponse
Queries the executables.
- 
-:param scenario_id: ID of the scenario the executables should belong to, defaults to None
-:type scenario_id: str, optional
-:param version_id: ID of the version, the executions should have, defaults to None
-:type version_id: str, optional
-:param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
-    resource group in the :class:`ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client` should be specified,
-    defaults to None
-:type resource_group: str
-: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
-:return: An object representing the response from the server
-:rtype: class:`ai_api_client_sdk.models.executable_query_response.ExecutableQueryResponse`
- -
-Methods inherited from ai_api_client_sdk.resource_clients.base_client.BaseClient:
-
__init__(self, rest_client: ai_api_client_sdk.helpers.rest_client.RestClient)
Initialize self.  See help(type(self)) for accurate signature.
- -
bulk_modify(self, *args, **kwargs)
Modifies multiple instances of the relevant resource. Will be implemented by the respective resource clients
- -
count(self, *args, **kwargs)
Counts the relevant resources. Will be implemented by the respective resource clients
- -
create(self, *args, **kwargs)
Creates the relevant resource. Will be implemented by the respective resource clients
- -
delete(self, *args, **kwargs)
Deletes the relevant resource. Will be implemented by the respective resource clients
- -
modify(self, *args, **kwargs)
Modifies the relevant resource. Will be implemented by the respective resource clients
- -
query_logs(self, *args, **kwargs)
Queries the relevant logs. Will be implemented by the respective resource clients
- -
-Data descriptors inherited from ai_api_client_sdk.resource_clients.base_client.BaseClient:
-
__dict__
-
dictionary for instance variables
-
-
__weakref__
-
list of weak references to the object
-
-

- \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.resource_clients.execution_client.html b/packages/base/docs/ai_api_client_sdk.resource_clients.execution_client.html deleted file mode 100644 index d208296..0000000 --- a/packages/base/docs/ai_api_client_sdk.resource_clients.execution_client.html +++ /dev/null @@ -1,282 +0,0 @@ - - - - -Python: module ai_api_client_sdk.resource_clients.execution_client - - - - - -
 
ai_api_client_sdk.resource_clients.execution_client		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/resource_clients/execution_client.py
-

-

- - - - - -
 
Classes
       
-
ai_api_client_sdk.resource_clients.base_client.BaseClient(builtins.object) -
-
-
ExecutionClient -
-
-
-

- - - - - - - -
 
class ExecutionClient(ai_api_client_sdk.resource_clients.base_client.BaseClient)
   ExecutionClient(rest_client: ai_api_client_sdk.helpers.rest_client.RestClient)
- 
-ExecutionClient is a class implemented for interacting with the execution related endpoints of the server. It
-implements the base class :class:`ai_api_client_sdk.resource_clients.base_client.BaseClient`
 
 
Method resolution order:
-
ExecutionClient
-
ai_api_client_sdk.resource_clients.base_client.BaseClient
-
builtins.object
-
-
-Methods defined here:
-
bulk_modify( - self, - executions: List[ai_api_client_sdk.models.base_models.BasicModifyRequest], - resource_group: str = None -) -> ai_api_client_sdk.models.execution_bulk_modify_response.ExecutionBulkModifyResponse
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 :class:`ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client` should be specified,
-    defaults to None
-:type resource_group: str, optional
-: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
-:return: An object representing the response from the server
-:rtype: class:`ai_api_client_sdk.models.execution_bulk_modify_response.ExecutionBulkModifyResponse`
- -
count( - self, - scenario_id: str = None, - configuration_id: str = None, - executable_ids: List[str] = None, - execution_schedule_id: str = None, - status: ai_api_client_sdk.models.status.Status = None, - resource_group: str = None -) -> int
Counts the number of executions.
- 
-:param scenario_id: ID of the scenario, the executions should belong to, defaults to None
-:type scenario_id: str, optional
-:param configuration_id: ID of the configuration, the executions should be configured by, defaults to None
-:type configuration_id: str, optional
-:param executable_ids: IDs of the executables, the executions should be created from, defaults to None
-:type executable_ids: List[str], optional
-:param execution_schedule_id: ID of the execution schedule, defaults to None
-:type execution_schedule_id: str, optional
-:param status: Status which the executions should currently have
-:type status: class:`ai_api_client_sdk.models.status.Status`, optional
-:param resource_group: Resource group which the request should be sent on behalf. Either this or a default
-    resource group in the :class:`ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client` should be specified,
-    defaults to None
-:type resource_group: str
-: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
-:return: An object representing the response from the server
-:rtype: int
- -
create(self, configuration_id: str, resource_group: str = None) -> ai_api_client_sdk.models.execution_create_response.ExecutionCreateResponse
Creates an execution.
- 
-:param configuration_id: ID of the configuration, that should configure the execution
-:type configuration_id: str
-:param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
-    resource group in the :class:`ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client` should be specified,
-    defaults to None
-:type resource_group: str
-: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
-:return: An object representing the response from the server
-:rtype: class:`ai_api_client_sdk.models.execution_create_response.ExecutionCreateResponse`
- -
delete(self, execution_id: str, resource_group: str = None) -> ai_api_client_sdk.models.base_models.BasicResponse
Deletes the execution.
- 
-:param execution_id: ID of the execution to be deleted
-:type execution_id: str
-:param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
-    resource group in the :class:`ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client` should be specified,
-    defaults to None
-:type resource_group: str
-: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
-:return: An object representing the response from the server
-:rtype: class:`ai_api_client_sdk.models.base_models.BasicResponse`
- -
get(self, execution_id: str, resource_group: str = None, select: str = None) -> Union[ai_api_client_sdk.models.execution.Execution, ai_api_client_sdk.models.execution_get_status_response.ExecutionGetStatusResponse]
Retrieves the execution from the server.
- 
-:param execution_id: ID of the execution to be retrieved
-:type execution_id: str
-:param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
-    resource group in the :class:`ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client` should be specified,
-    defaults to None
-:type resource_group: str
-:param select: only status supported. Get execution for a given execution id and select status
-:type select: str, optional
-: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: The retrieved execution
-:rtype: class:Union[`ai_api_client_sdk.models.execution.Execution`,
-    `ai_api_client_sdk.models.execution_get_status_response.ExecutionGetStatusResponse`]
- -
modify( - self, - execution_id: str, - target_status: ai_api_client_sdk.models.target_status.TargetStatus, - resource_group: str = None -) -> ai_api_client_sdk.models.base_models.BasicResponse
Modifies the execution, by changing the target status.
- 
-:param execution_id: ID of the execution to be modified
-:type execution_id: str
-:param target_status: Desired target status of the execution, defaults to None
-:type target_status: class:`ai_api_client_sdk.models.target_status.TargetStatus`, optional
-:param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
-    resource group in the :class:`ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client` should be specified,
-    defaults to None
-:type resource_group: str
-: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
-:return: An object representing the response from the server
-:rtype: class:`ai_api_client_sdk.models.base_models.BasicResponse`
- -
query( - self, - scenario_id: str = None, - configuration_id: str = None, - executable_ids: List[str] = None, - execution_schedule_id: str = None, - status: ai_api_client_sdk.models.status.Status = None, - top: int = None, - skip: int = None, - resource_group: str = None -) -> ai_api_client_sdk.models.execution_query_response.ExecutionQueryResponse
Queries the executions.
- 
-:param scenario_id: ID of the scenario the executions should belong to, defaults to None
-:type scenario_id: str, optional
-:param configuration_id: ID of the configuration, the executions should be configured by, defaults to None
-:type configuration_id: str, optional
-:param executable_ids: IDs of the executables the executions should be created from, defaults to None
-:type executable_ids: List[str], optional
-:param execution_schedule_id: ID of the execution schedule, defaults to None
-:type execution_schedule_id: str, optional
-:param status: Status which the executions should currently have
-:type status: class:`ai_api_client_sdk.models.status.Status`, optional
-:param top: Number of executions to be retrieved, defaults to None
-:type top: int, optional
-:param skip: Number of executions to be skipped, from the list of the queried executions, defaults to None
-:type skip: int, optional
-:param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
-    resource group in the :class:`ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client` should be specified,
-    defaults to None
-:type resource_group: str
-: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
-:return: An object representing the response from the server
-:rtype: class:`ai_api_client_sdk.models.execution_query_response.ExecutionQueryResponse`
- -
query_logs( - self, - execution_id: str, - top: int = None, - start: datetime.datetime = None, - end: datetime.datetime = None, - order: ai_api_client_sdk.models.base_models.Order = None, - resource_group: str = None -) -> ai_api_client_sdk.models.log_response.LogResponse
Queries the logs of the execution.
- 
-:param execution_id: ID of the execution
-:type execution_id: str
-:param top: The max number of entries to return. Defaults to 1000. Limited to 5000 max.
-:type top: int
-:param start: The start time for the query. Defaults to one hour ago.
-:type start: datetime
-:param end: The end time for the query. Defaults to now.
-:type end: datetime
-:param order: Determines the sort order with respect to time. Defaults to asc.
-:type order: class:`ai_api_client_sdk.models.base_models.Order`
-:param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
-    resource group in the :class:`ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client` should be specified,
-    defaults to None
-:type resource_group: str
-: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: Logs from the execution
-:rtype: class:`ai_api_client_sdk.models.log_response.LogResponse`
- -
-Methods inherited from ai_api_client_sdk.resource_clients.base_client.BaseClient:
-
__init__(self, rest_client: ai_api_client_sdk.helpers.rest_client.RestClient)
Initialize self.  See help(type(self)) for accurate signature.
- -
-Data descriptors inherited from ai_api_client_sdk.resource_clients.base_client.BaseClient:
-
__dict__
-
dictionary for instance variables
-
-
__weakref__
-
list of weak references to the object
-
-

- - - - - -
 
Data
       List = typing.List
-Union = typing.Union
- \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.resource_clients.execution_schedule_client.html b/packages/base/docs/ai_api_client_sdk.resource_clients.execution_schedule_client.html deleted file mode 100644 index 54c1b49..0000000 --- a/packages/base/docs/ai_api_client_sdk.resource_clients.execution_schedule_client.html +++ /dev/null @@ -1,235 +0,0 @@ - - - - -Python: module ai_api_client_sdk.resource_clients.execution_schedule_client - - - - - -
 
ai_api_client_sdk.resource_clients.execution_schedule_client		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/resource_clients/execution_schedule_client.py
-

-

- - - - - -
 
Classes
       
-
ai_api_client_sdk.resource_clients.base_client.BaseClient(builtins.object) -
-
-
ExecutionScheduleClient -
-
-
-

- - - - - - - -
 
class ExecutionScheduleClient(ai_api_client_sdk.resource_clients.base_client.BaseClient)
   ExecutionScheduleClient(
-    rest_client: ai_api_client_sdk.helpers.rest_client.RestClient
-)
- 
-ExecutionScheduleClient is a class implemented for interacting with the execution schedules related endpoints of
-the server. It implements the base class :class:`ai_api_client_sdk.resource_clients.base_client.BaseClient`
 
 
Method resolution order:
-
ExecutionScheduleClient
-
ai_api_client_sdk.resource_clients.base_client.BaseClient
-
builtins.object
-
-
-Methods defined here:
-
count( - self, - configuration_id: str = None, - status: ai_api_client_sdk.models.status.ScheduleStatus = None, - resource_group: str = None -) -> int
Counts the number of executions schedules.
- 
-:param configuration_id: ID of the configuration, the executions should be configured by, defaults to None
-:type configuration_id: str, optional
-:param status: ScheduleStatus which the execution schedule should currently have, defaults to None
-:type status: class:`ai_api_client_sdk.models.schedule_status.ScheduleStatus`, optional
-:param resource_group: Resource group which the request should be sent on behalf. Either this or a default
-    resource group in the :class:`ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client` should be specified,
-    defaults to None
-:type resource_group: str
-: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
-:return: An object representing the response from the server
-:rtype: int
- -
create( - self, - name: str, - cron: str, - configuration_id: str, - start: datetime.datetime = None, - end: datetime.datetime = None, - resource_group: str = None -) -> ai_api_client_sdk.models.execution_schedule_create_response.ExecutionScheduleCreateResponse
Creates an execution schedule.
- 
-:param name: Name of the execution schedule
-:type name: str
-:param cron: Cron defining the schedule to run the executions
-:type name: str
-:param configuration_id: ID of the configuration for the execution schedule
-:type configuration_id: str
-:param start: Start time of the execution schedule in UTC, defaults to None
-:type start: datetime, optional
-:param end: End time of the execution schedule in UTC e.g., defaults to None
-:type end: datetime, optional
-:param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
-    resource group in the :class:`ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client` should be specified,
-    defaults to None
-:type resource_group: str
-: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
-:return: An object representing the response from the server
-:rtype: class:`ai_api_client_sdk.models.execution_schedule_create_response.ExecutionScheduleCreateResponse`
- -
delete(self, execution_schedule_id: str, resource_group: str = None) -> ai_api_client_sdk.models.base_models.BasicResponse
Deletes the execution schedule.
- 
-:param execution_schedule_id: ID of the execution schedule to be deleted
-:type execution_schedule_id: str
-:param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
-    resource group in the :class:`ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client` should be specified,
-    defaults to None
-:type resource_group: str
-: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
-:return: An object representing the response from the server
-:rtype: class:`ai_api_client_sdk.models.base_models.BasicResponse`
- -
get(self, execution_schedule_id: str, resource_group: str = None) -> ai_api_client_sdk.models.execution_schedule.ExecutionSchedule
Retrieves the execution schedule from the server.
- 
-:param execution_schedule_id: ID of the execution schedule to be retrieved
-:type execution_schedule_id: str
-:param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
-    resource group in the :class:`ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client` should be specified,
-    defaults to None
-:type resource_group: str
-: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: The retrieved execution
-:rtype: class:`ai_api_client_sdk.models.execution.Execution`
- -
modify( - self, - execution_schedule_id: str, - cron: str = None, - start: datetime.datetime = None, - end: datetime.datetime = None, - configurationId: str = None, - status: ai_api_client_sdk.models.status.ScheduleStatus = None, - resource_group: str = None -) -> ai_api_client_sdk.models.base_models.BasicResponse
Modifies the execution schedule.
- 
-:param execution_schedule_id: ID of the execution to be modified
-:type execution_schedule_id: str
-:param cron: Cron defining the schedule to run the executions, defaults to None
-:type cron: str, optional
-:param configurationId: ID of the configuration for the execution schedule, defaults to None
-:type configurationId: str, optional
-:param start: Start time of the execution schedule in UTC, defaults to None
-:type start: datetime, optional
-:param end: End time of the execution schedule in UTC, defaults to None
-:type end: datetime, optional
-:param status: pause / resume Status of the execution schedule, defaults to None
-:type status: class:`ai_api_client_sdk.models.status.ScheduleStatus`, optional
-:param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
-    resource group in the :class:`ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client` should be specified,
-    defaults to None
-:type resource_group: str
-: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: An object representing the response from the server
-:rtype: class:`ai_api_client_sdk.models.base_models.BasicResponse`
- -
query( - self, - configuration_id: str = None, - status: ai_api_client_sdk.models.status.ScheduleStatus = None, - top: int = None, - skip: int = None, - resource_group: str = None -) -> ai_api_client_sdk.models.execution_schedule_query_response.ExecutionScheduleQueryResponse
Queries the execution schedules.
- 
-:param configuration_id: ID of the configuration, the executions should be configured by, defaults to None
-:type configuration_id: str, optional
-:param status:  ScheduleStatus which the execution schedule should currently have
-:type status: class:`ai_api_client_sdk.models.schedule_status.ScheduleStatus`, optional
-:param top: Number of executions to be retrieved, defaults to None
-:type top: int, optional
-:param skip: Number of executions to be skipped, from the list of the queried executions, defaults to None
-:type skip: int, optional
-:param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
-    resource group in the :class:`ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client` should be specified,
-    defaults to None
-:type resource_group: str
-: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
-:return: An object representing the response from the server
-:rtype: class:`ai_api_client_sdk.models.execution_query_response.ExecutionQueryResponse`
- -
-Methods inherited from ai_api_client_sdk.resource_clients.base_client.BaseClient:
-
__init__(self, rest_client: ai_api_client_sdk.helpers.rest_client.RestClient)
Initialize self.  See help(type(self)) for accurate signature.
- -
bulk_modify(self, *args, **kwargs)
Modifies multiple instances of the relevant resource. Will be implemented by the respective resource clients
- -
query_logs(self, *args, **kwargs)
Queries the relevant logs. Will be implemented by the respective resource clients
- -
-Data descriptors inherited from ai_api_client_sdk.resource_clients.base_client.BaseClient:
-
__dict__
-
dictionary for instance variables
-
-
__weakref__
-
list of weak references to the object
-
-

- - - - - -
 
Data
       DATETIME_FORMAT = '%Y-%m-%dT%H:%M:%SZ'
- \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.resource_clients.healthz_client.html b/packages/base/docs/ai_api_client_sdk.resource_clients.healthz_client.html deleted file mode 100644 index 613facd..0000000 --- a/packages/base/docs/ai_api_client_sdk.resource_clients.healthz_client.html +++ /dev/null @@ -1,79 +0,0 @@ - - - - -Python: module ai_api_client_sdk.resource_clients.healthz_client - - - - - -
 
ai_api_client_sdk.resource_clients.healthz_client		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/resource_clients/healthz_client.py
-

-

- - - - - -
 
Classes
       
-
ai_api_client_sdk.resource_clients.base_client.BaseClient(builtins.object) -
-
-
HealthzClient -
-
-
-

- - - - - - - -
 
class HealthzClient(ai_api_client_sdk.resource_clients.base_client.BaseClient)
   HealthzClient(rest_client: ai_api_client_sdk.helpers.rest_client.RestClient)
- 
-HealthzClient is a class implemented for interacting with the healthz endpoint of the server. It implements the
-base class :class:`ai_api_client_sdk.resource_clients.base_client.BaseClient`
 
 
Method resolution order:
-
HealthzClient
-
ai_api_client_sdk.resource_clients.base_client.BaseClient
-
builtins.object
-
-
-Methods defined here:
-
get(self) -> ai_api_client_sdk.models.healthz_status.HealthzStatus
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
-:return: The health status of the server
-:rtype: class:`ai_api_client_sdk.models.healthz_status.HealthzStatus`
- -
-Methods inherited from ai_api_client_sdk.resource_clients.base_client.BaseClient:
-
__init__(self, rest_client: ai_api_client_sdk.helpers.rest_client.RestClient)
Initialize self.  See help(type(self)) for accurate signature.
- -
bulk_modify(self, *args, **kwargs)
Modifies multiple instances of the relevant resource. Will be implemented by the respective resource clients
- -
count(self, *args, **kwargs)
Counts the relevant resources. Will be implemented by the respective resource clients
- -
create(self, *args, **kwargs)
Creates the relevant resource. Will be implemented by the respective resource clients
- -
delete(self, *args, **kwargs)
Deletes the relevant resource. Will be implemented by the respective resource clients
- -
modify(self, *args, **kwargs)
Modifies the relevant resource. Will be implemented by the respective resource clients
- -
query(self, *args, **kwargs)
Queries the relevant resources. Will be implemented by the respective resource clients
- -
query_logs(self, *args, **kwargs)
Queries the relevant logs. Will be implemented by the respective resource clients
- -
-Data descriptors inherited from ai_api_client_sdk.resource_clients.base_client.BaseClient:
-
__dict__
-
dictionary for instance variables
-
-
__weakref__
-
list of weak references to the object
-
-

- \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.resource_clients.html b/packages/base/docs/ai_api_client_sdk.resource_clients.html deleted file mode 100644 index 8790b97..0000000 --- a/packages/base/docs/ai_api_client_sdk.resource_clients.html +++ /dev/null @@ -1,33 +0,0 @@ - - - - -Python: package ai_api_client_sdk.resource_clients - - - - - -
 
ai_api_client_sdk.resource_clients		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/resource_clients/__init__.py
-

-

- - - - - -
 
Package Contents
       
artifact_client
-base_client
-configuration_client
-deployment_client
-		executable_client
-execution_client
-execution_schedule_client
-healthz_client
-		meta_client
-metrics_client
-model_client
-resource_groups_client
-		scenario_client
-
- \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.resource_clients.meta_client.html b/packages/base/docs/ai_api_client_sdk.resource_clients.meta_client.html deleted file mode 100644 index 40eb4a2..0000000 --- a/packages/base/docs/ai_api_client_sdk.resource_clients.meta_client.html +++ /dev/null @@ -1,75 +0,0 @@ - - - - -Python: module ai_api_client_sdk.resource_clients.meta_client - - - - - -
 
ai_api_client_sdk.resource_clients.meta_client		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/resource_clients/meta_client.py
-

-

- - - - - -
 
Classes
       
-
ai_api_client_sdk.resource_clients.base_client.BaseClient(builtins.object) -
-
-
MetaClient -
-
-
-

- - - - - - - -
 
class MetaClient(ai_api_client_sdk.resource_clients.base_client.BaseClient)
   MetaClient(rest_client: ai_api_client_sdk.helpers.rest_client.RestClient)
- 
-
 
 
Method resolution order:
-
MetaClient
-
ai_api_client_sdk.resource_clients.base_client.BaseClient
-
builtins.object
-
-
-Methods defined here:
-
get(self) -> ai_api_client_sdk.models.capabilities.Capabilities
Retrieves the relevant resource. Will be implemented by the respective resource clients
- -
get_versions(self) -> ai_api_client_sdk.models.version_list.VersionList
- -
-Methods inherited from ai_api_client_sdk.resource_clients.base_client.BaseClient:
-
__init__(self, rest_client: ai_api_client_sdk.helpers.rest_client.RestClient)
Initialize self.  See help(type(self)) for accurate signature.
- -
bulk_modify(self, *args, **kwargs)
Modifies multiple instances of the relevant resource. Will be implemented by the respective resource clients
- -
count(self, *args, **kwargs)
Counts the relevant resources. Will be implemented by the respective resource clients
- -
create(self, *args, **kwargs)
Creates the relevant resource. Will be implemented by the respective resource clients
- -
delete(self, *args, **kwargs)
Deletes the relevant resource. Will be implemented by the respective resource clients
- -
modify(self, *args, **kwargs)
Modifies the relevant resource. Will be implemented by the respective resource clients
- -
query(self, *args, **kwargs)
Queries the relevant resources. Will be implemented by the respective resource clients
- -
query_logs(self, *args, **kwargs)
Queries the relevant logs. Will be implemented by the respective resource clients
- -
-Data descriptors inherited from ai_api_client_sdk.resource_clients.base_client.BaseClient:
-
__dict__
-
dictionary for instance variables
-
-
__weakref__
-
list of weak references to the object
-
-

- \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.resource_clients.metrics_client.html b/packages/base/docs/ai_api_client_sdk.resource_clients.metrics_client.html deleted file mode 100644 index 19f916f..0000000 --- a/packages/base/docs/ai_api_client_sdk.resource_clients.metrics_client.html +++ /dev/null @@ -1,129 +0,0 @@ - - - - -Python: module ai_api_client_sdk.resource_clients.metrics_client - - - - - -
 
ai_api_client_sdk.resource_clients.metrics_client		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/resource_clients/metrics_client.py
-

-

- - - - - -
 
Modules
       
warnings
-

- - - - - -
 
Classes
       
-
ai_api_client_sdk.resource_clients.base_client.BaseClient(builtins.object) -
-
-
MetricsClient -
-
-
-

- - - - - - - -
 
class MetricsClient(ai_api_client_sdk.resource_clients.base_client.BaseClient)
   MetricsClient(rest_client: ai_api_client_sdk.helpers.rest_client.RestClient)
- 
-MetricsClient is a class implemented for interacting with the metrics related endpoints of the server. It
-implements the base class :class:`ai_api_client_sdk.resource_clients.base_client.BaseClient`
 
 
Method resolution order:
-
MetricsClient
-
ai_api_client_sdk.resource_clients.base_client.BaseClient
-
builtins.object
-
-
-Methods defined here:
-
delete(self, execution_id: str, resource_group: str = None) -> None
Deletes the metrics.
- 
-:param execution_id: ID of the execution, of which the metrics should be deleted.
-:type execution_id: str
-:param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
-    resource group in the :class:`ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client` should be specified,
-    defaults to None
-:type resource_group: str
-: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
- -
query( - self, - filter: str = None, - execution_ids: List[str] = None, - select: List[str] = None, - resource_group: str = None -) -> ai_api_client_sdk.models.metrics_query_response.MetricsQueryResponse
Queries the metrics.
- 
-:param filter: 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
-:type filter: str, optional
-:param execution_ids: IDs of the executions, of which the metrics should be retrieved, defaults to None
-:type execution_ids: List[str], optional
-:param select: 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
-:type select: List[str], optional
-:param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
-    resource group in the :class:`ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client` should be specified,
-    defaults to None
-:type resource_group: str
-: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
-:return: An object representing the response from the server
-:rtype: class:`ai_api_client_sdk.models.metrics_query_response.MetricsQueryResponse`
- -
-Methods inherited from ai_api_client_sdk.resource_clients.base_client.BaseClient:
-
__init__(self, rest_client: ai_api_client_sdk.helpers.rest_client.RestClient)
Initialize self.  See help(type(self)) for accurate signature.
- -
bulk_modify(self, *args, **kwargs)
Modifies multiple instances of the relevant resource. Will be implemented by the respective resource clients
- -
count(self, *args, **kwargs)
Counts the relevant resources. Will be implemented by the respective resource clients
- -
create(self, *args, **kwargs)
Creates the relevant resource. Will be implemented by the respective resource clients
- -
get(self, *args, **kwargs)
Retrieves the relevant resource. Will be implemented by the respective resource clients
- -
modify(self, *args, **kwargs)
Modifies the relevant resource. Will be implemented by the respective resource clients
- -
query_logs(self, *args, **kwargs)
Queries the relevant logs. Will be implemented by the respective resource clients
- -
-Data descriptors inherited from ai_api_client_sdk.resource_clients.base_client.BaseClient:
-
__dict__
-
dictionary for instance variables
-
-
__weakref__
-
list of weak references to the object
-
-

- - - - - -
 
Data
       List = typing.List
- \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.resource_clients.model_client.html b/packages/base/docs/ai_api_client_sdk.resource_clients.model_client.html deleted file mode 100644 index dbec6b4..0000000 --- a/packages/base/docs/ai_api_client_sdk.resource_clients.model_client.html +++ /dev/null @@ -1,91 +0,0 @@ - - - - -Python: module ai_api_client_sdk.resource_clients.model_client - - - - - -
 
ai_api_client_sdk.resource_clients.model_client		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/resource_clients/model_client.py
-

-

- - - - - -
 
Classes
       
-
ai_api_client_sdk.resource_clients.base_client.BaseClient(builtins.object) -
-
-
ModelClient -
-
-
-

- - - - - - - -
 
class ModelClient(ai_api_client_sdk.resource_clients.base_client.BaseClient)
   ModelClient(rest_client: ai_api_client_sdk.helpers.rest_client.RestClient)
- 
-ModelClient is a class implemented for interacting with model related endpoints of the server. It
-implements the base class :class:`ai_api_client_sdk.resource_clients.base_client.BaseClient`
 
 
Method resolution order:
-
ModelClient
-
ai_api_client_sdk.resource_clients.base_client.BaseClient
-
builtins.object
-
-
-Methods defined here:
-
query(self, resource_group: str = None) -> ai_api_client_sdk.models.model_query_response.ModelQueryResponse
Queries the models.
- 
-:param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
-    resource group in the :class:`ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client` should be specified,
-    defaults to None
-:type resource_group: str
-: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
-:return: An object representing the response from the server
-:rtype: class:`ai_api_client_sdk.models.executable_query_response.ModelQueryResponse`
- -
-Data and other attributes defined here:
-
DEFAULT_SCENARIO_ID = 'foundation-models'
- -
-Methods inherited from ai_api_client_sdk.resource_clients.base_client.BaseClient:
-
__init__(self, rest_client: ai_api_client_sdk.helpers.rest_client.RestClient)
Initialize self.  See help(type(self)) for accurate signature.
- -
bulk_modify(self, *args, **kwargs)
Modifies multiple instances of the relevant resource. Will be implemented by the respective resource clients
- -
count(self, *args, **kwargs)
Counts the relevant resources. Will be implemented by the respective resource clients
- -
create(self, *args, **kwargs)
Creates the relevant resource. Will be implemented by the respective resource clients
- -
delete(self, *args, **kwargs)
Deletes the relevant resource. Will be implemented by the respective resource clients
- -
get(self, *args, **kwargs)
Retrieves the relevant resource. Will be implemented by the respective resource clients
- -
modify(self, *args, **kwargs)
Modifies the relevant resource. Will be implemented by the respective resource clients
- -
query_logs(self, *args, **kwargs)
Queries the relevant logs. Will be implemented by the respective resource clients
- -
-Data descriptors inherited from ai_api_client_sdk.resource_clients.base_client.BaseClient:
-
__dict__
-
dictionary for instance variables
-
-
__weakref__
-
list of weak references to the object
-
-

- \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.resource_clients.resource_groups_client.html b/packages/base/docs/ai_api_client_sdk.resource_clients.resource_groups_client.html deleted file mode 100644 index f56cdd2..0000000 --- a/packages/base/docs/ai_api_client_sdk.resource_clients.resource_groups_client.html +++ /dev/null @@ -1,159 +0,0 @@ - - - - -Python: module ai_api_client_sdk.resource_clients.resource_groups_client - - - - - -
 
ai_api_client_sdk.resource_clients.resource_groups_client		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/resource_clients/resource_groups_client.py
-

-

- - - - - -
 
Classes
       
-
ai_api_client_sdk.resource_clients.base_client.BaseClient(builtins.object) -
-
-
ResourceGroupsClient -
-
-
-

- - - - - - - -
 
class ResourceGroupsClient(ai_api_client_sdk.resource_clients.base_client.BaseClient)
   ResourceGroupsClient(
-    rest_client: ai_api_client_sdk.helpers.rest_client.RestClient
-)
- 
-ResourceGroupsClient is a class implemented for interacting with the resource groups endpoints of the server.
-It implements the base class
-:class:`ai_api_client_sdk.resource_clients.base_client.BaseClient`
 
 
Method resolution order:
-
ResourceGroupsClient
-
ai_api_client_sdk.resource_clients.base_client.BaseClient
-
builtins.object
-
-
-Methods defined here:
-
create( - self, - resource_group_id: str, - labels: List[ai_api_client_sdk.models.label.Label] = None -) -> ai_api_client_sdk.models.resource_group.ResourceGroup
Creates resource group for a given tenant.
- 
-:param resource_group_id: the id of the resource group and the length must be between 3 and 10 characters.
-:type resource_group_id: str
-:param labels: key-value pairs of the labels that will be added to the resource group.
-:type labels: List[Label]
-: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
-:return: An object representing the response from the server
-:rtype: class:`ai_core_sdk.models.resource_group.ResourceGroup`
- -
delete(self, resource_group_id: str) -> ai_api_client_sdk.models.base_models.BasicResponse
Deletes the resource group.
- 
-:param resource_group_id: the id of the resource group to be deleted
-:type resource_group_id: str
-: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
-:return: An object representing the response from the server
-:rtype: class:`ai_api_client_sdk.models.base_models.BasicResponse`
- -
get(self, resource_group_id: str) -> ai_api_client_sdk.models.resource_group.ResourceGroup
Gets a resource group of a given tenant.
- 
-:param resource_group_id: the id of the resource group to be retrieved
-:type resource_group_id: str
-: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: An object representing the resource group from the server
-:rtype: class:`ai_core_sdk.models.resource_group.ResourceGroup`
- -
modify( - self, - resource_group_id: str, - labels: List[ai_api_client_sdk.models.label.Label] -) -> None
Modifies a resource group.
- 
-:param resource_group_id: the id of the resource group
-:type resource_group_id: str
-:param labels: key-value pairs of the labels that will be added to the resource group.
-:type labels: List[Label]
-: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
-:return: An object representing the response from the server
- -
query(self, search: str = None, search_case_insensitive: bool = None) -> ai_api_client_sdk.models.resource_group_query_response.ResourceGroupQueryResponse
Get all resource groups.
- 
-:param search: Generic search term to be looked for in various attributes of resource groups, defaults to None
-:type search: str, optional
-:param search_case_insensitive: Indicates whether the search should be case insensitive
-:type search_case_insensitive: bool, optional
-: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
-:return: A list of resource groups for a given tenant.
-:rtype: class:`ai_core_sdk.models.resource_group_query_response.ResourceGroupQueryResponse`
- -
-Methods inherited from ai_api_client_sdk.resource_clients.base_client.BaseClient:
-
__init__(self, rest_client: ai_api_client_sdk.helpers.rest_client.RestClient)
Initialize self.  See help(type(self)) for accurate signature.
- -
bulk_modify(self, *args, **kwargs)
Modifies multiple instances of the relevant resource. Will be implemented by the respective resource clients
- -
count(self, *args, **kwargs)
Counts the relevant resources. Will be implemented by the respective resource clients
- -
query_logs(self, *args, **kwargs)
Queries the relevant logs. Will be implemented by the respective resource clients
- -
-Data descriptors inherited from ai_api_client_sdk.resource_clients.base_client.BaseClient:
-
__dict__
-
dictionary for instance variables
-
-
__weakref__
-
list of weak references to the object
-
-

- - - - - -
 
Data
       List = typing.List
- \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.resource_clients.scenario_client.html b/packages/base/docs/ai_api_client_sdk.resource_clients.scenario_client.html deleted file mode 100644 index e33cb1a..0000000 --- a/packages/base/docs/ai_api_client_sdk.resource_clients.scenario_client.html +++ /dev/null @@ -1,150 +0,0 @@ - - - - -Python: module ai_api_client_sdk.resource_clients.scenario_client - - - - - -
 
ai_api_client_sdk.resource_clients.scenario_client		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/resource_clients/scenario_client.py
-

-

- - - - - -
 
Classes
       
-
ai_api_client_sdk.resource_clients.base_client.BaseClient(builtins.object) -
-
-
ScenarioClient -
-
-
-

- - - - - - - -
 
class ScenarioClient(ai_api_client_sdk.resource_clients.base_client.BaseClient)
   ScenarioClient(rest_client: ai_api_client_sdk.helpers.rest_client.RestClient)
- 
-ScenarioClient is a class implemented for interacting with the scenario related endpoints of the server. It
-implements the base class :class:`ai_api_client_sdk.resource_clients.base_client.BaseClient`
 
 
Method resolution order:
-
ScenarioClient
-
ai_api_client_sdk.resource_clients.base_client.BaseClient
-
builtins.object
-
-
-Methods defined here:
-
get(self, scenario_id: str, resource_group: str = None) -> ai_api_client_sdk.models.scenario.Scenario
Retrieves the scenario from the server.
- 
-:param scenario_id: ID of the scenario to be retrieved
-:type scenario_id: str
-:param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
-    resource group in the :class:`ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client` should be specified,
-    defaults to None
-:type resource_group: str
-: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: The retrieved scenario
-:rtype: class:`ai_api_client_sdk.models.scenario.Scenario`
- -
query(self, only_llm_scenarios: bool = False, resource_group: str = None) -> ai_api_client_sdk.models.scenario_query_response.ScenarioQueryResponse
Queries the scenarios.
- 
-:param only_llm_scenarios: indicates whether to query for LLM scenarios only, defaults to False
-:type only_llm_scenarios:  bool, optional
-:param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
-    resource group in the :class:`ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client` should be specified,
-    defaults to None
-:type resource_group: str
-: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
-:return: An object representing the response from the server
-:rtype: class:`ai_api_client_sdk.models.scenario_query_response.ScenarioQueryResponse`
- -
query_llm_scenarios(self, resource_group: str = None) -> ai_api_client_sdk.models.scenario_query_response.ScenarioQueryResponse
Queries for the LLM scenarios.
- 
-:param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
-    resource group in the :class:`ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client` should be specified,
-    defaults to None
-:type resource_group: str
-: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
-:return: An object representing the response from the server
-:rtype: class:`ai_api_client_sdk.models.scenario_query_response.ScenarioQueryResponse`
- -
query_versions( - self, - scenario_id: str, - label_selector: List[str] = None, - resource_group: str = None -) -> ai_api_client_sdk.models.version_query_response.VersionQueryResponse
Queries the versions.
- 
-:param scenario_id: ID of the scenario, the versions should belong to
-:type scenario_id: str
-:param label_selector: 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
-:type label_selector: List[str], optional
-:param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
-    resource group in the :class:`ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client` should be specified,
-    defaults to None
-:type resource_group: str
-: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
-:return: An object representing the response from the server
-:rtype: class:`ai_api_client_sdk.models.scenario_query_response.ScenarioQueryResponse`
- -
-Methods inherited from ai_api_client_sdk.resource_clients.base_client.BaseClient:
-
__init__(self, rest_client: ai_api_client_sdk.helpers.rest_client.RestClient)
Initialize self.  See help(type(self)) for accurate signature.
- -
bulk_modify(self, *args, **kwargs)
Modifies multiple instances of the relevant resource. Will be implemented by the respective resource clients
- -
count(self, *args, **kwargs)
Counts the relevant resources. Will be implemented by the respective resource clients
- -
create(self, *args, **kwargs)
Creates the relevant resource. Will be implemented by the respective resource clients
- -
delete(self, *args, **kwargs)
Deletes the relevant resource. Will be implemented by the respective resource clients
- -
modify(self, *args, **kwargs)
Modifies the relevant resource. Will be implemented by the respective resource clients
- -
query_logs(self, *args, **kwargs)
Queries the relevant logs. Will be implemented by the respective resource clients
- -
-Data descriptors inherited from ai_api_client_sdk.resource_clients.base_client.BaseClient:
-
__dict__
-
dictionary for instance variables
-
-
__weakref__
-
list of weak references to the object
-
-

- - - - - -
 
Data
       List = typing.List
- \ No newline at end of file diff --git a/packages/core/docs/ai_core_sdk.ai_core_v2_client.html b/packages/core/docs/ai_core_sdk.ai_core_v2_client.html deleted file mode 100644 index c67c3de..0000000 --- a/packages/core/docs/ai_core_sdk.ai_core_v2_client.html +++ /dev/null @@ -1,150 +0,0 @@ - - - - -Python: module ai_core_sdk.ai_core_v2_client - - - - - -
 
ai_core_sdk.ai_core_v2_client		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/core/ai_core_sdk/ai_core_v2_client.py
-

-

- - - - - -
 
Modules
       
os
-

- - - - - -
 
Classes
       
-
builtins.object -
-
-
AICoreV2Client -
-
-
-

- - - - - - - -
 
class AICoreV2Client(builtins.object)
   AICoreV2Client(
-    base_url: str,
-    auth_url: str = None,
-    client_id: str = None,
-    client_secret: str = None,
-    cert_str: str = None,
-    key_str: str = None,
-    cert_file_path: str = None,
-    key_file_path: str = None,
-    token_creator: Callable[[], str] = None,
-    resource_group: str = None,
-    client_type: str = 'AI Core Python SDK',
-    **kwargs
-)
- 
-The AICoreV2Client is the class implemented to interact with the AI Core endpoints. The user can use its
-attributes corresponding to the resources, for interacting with endpoints related to that resource. (i.e.,
-aicoreclient.scenario)
- 
-:param base_url: Base URL of the AI Core. Should include the base path as well. (i.e., "<base_url>/lm/scenarios"
-    should work)
-:type base_url: str
-:param auth_url: URL of the authorization endpoint. Should be the full URL (including /oauth/token), defaults to
-    None
-:type auth_url: str, optional
-:param client_id: client id to be used for authorization, defaults to None
-:type client_id: str, optional
-:param client_secret: client secret to be used for authorization, defaults to None
-:type client_secret: str, optional
-:param cert_str: certificate file content, needs to be provided alongside the key_str parameter, defaults to None
-:type cert_str: str, optional
-:param key_str: key file content, needs to be provided alongside the cert_str parameter, defaults to None
-:type key_str: str, optional
-:param cert_file_path: path to the certificate file, needs to be provided alongside the key_file_path parameter,
-    defaults to None
-:type cert_file_path: str, optional
-:param key_file_path: path to the key file, needs to be provided alongside the cert_file_path parameter,
-    defaults to None
-:type key_file_path: str, optional
-:param token_creator: the function which returns the Bearer token, when called. Either this, or
-    auth_url & client_id & client_secret should be specified, defaults to None
-:type token_creator: Callable[[], str], optional
-:param resource_group: The default resource group which will be used while sending the requests to the server. If
-    not set, the resource_group should be specified with every request to the server, defaults to None
-:type resource_group: str, optional
-:param client_type: The client type which will be sent in the User-Agent header of the requests, defaults to
-    "AI Core Python SDK"
-:type client_type: str, optional
-:param \**kwargs:
-    * *read_timeout* (int): Read timeout for requests in seconds, defaults to 60s
-    * *connect_timeout* (int): Connect timeout for requests in seconds, defaults to 60s
-    * *num_request_retries* (int): Number of retries for failing requests with http status code 429, 500, 502, 503 or 504, defaults to 10
 
 Methods defined here:
-
__init__( - self, - base_url: str, - auth_url: str = None, - client_id: str = None, - client_secret: str = None, - cert_str: str = None, - key_str: str = None, - cert_file_path: str = None, - key_file_path: str = None, - token_creator: Callable[[], str] = None, - resource_group: str = None, - client_type: str = 'AI Core Python SDK', - **kwargs -)
Initialize self.  See help(type(self)) for accurate signature.
- -
-Static methods defined here:
-
from_env(profile_name: str = None, **kwargs)
Alternative way to create an AICoreV2Client object.
-Parameters for base_url, auth_url, client_id, client_secret, x.509 credentials (either as file path or string)
-and resource_group can be passed as keyword or are pulled from environment variables.
-It is also possible to use a profile, which is a json file in the config directory. The profile name can be
-passed as keyword or is pulled from the environment variable AICORE_PROFILE. If no profile is specified,
-the default profile is used.
-A specific path to a config, that should be used, can be set via the environment variable AICORE_CONFIG.
-The hierarchy of precedence is:
-1. keyword argument
-2. environment variable
-3. configuration file
-4. value from VCAP_SERVICES environment variable, if exists
- 
-:param profile_name: name of the profile to use, defaults to None. If None is passed, the profile is read from
-    the environment variable AICORE_PROFILE. If this is not set, the default profile is used.
-    The default profile is read from $AICORE_HOME/config.json.
-:type profile_name: optional, str
-**kwargs: check the parameters of the class constructor
- -
-Data descriptors defined here:
-
__dict__
-
dictionary for instance variables
-
-
__weakref__
-
list of weak references to the object
-
-
-Data and other attributes defined here:
-
logger = <Logger ai_core_sdk (INFO)>
- -

- - - - - -
 
Data
       Callable = typing.Callable
- \ No newline at end of file diff --git a/packages/core/docs/ai_core_sdk.cli.html b/packages/core/docs/ai_core_sdk.cli.html deleted file mode 100644 index d4fdfe0..0000000 --- a/packages/core/docs/ai_core_sdk.cli.html +++ /dev/null @@ -1,64 +0,0 @@ - - - - -Python: module ai_core_sdk.cli - - - - - -
 
ai_core_sdk.cli		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/core/ai_core_sdk/cli.py
-

-

- - - - - -
 
Modules
       
click
-		json
-		pathlib
-

- - - - - -
 
Functions
       
confirm_resource_group(resource_group: 'Optional[str]' = None)
-
create_config(**kwargs)
# Utility Functions
-
create_config_file( - config_path: 'pathlib.Path', - auth_url: 'str', - client_id: 'str', - client_secret: 'str', - cert_file_path: 'pathlib.Path', - key_file_path: 'pathlib.Path', - base_url: 'str', - resource_group: 'str' -)
-
get_auth_url(auth_url: 'Optional[str]' = None)
-
get_base_url(base_url: 'Optional[str]' = None)
-
get_profile_config_path(profile: 'str')
-
get_str_value(msg: 'str', value: 'Optional[str]' = None)
-
is_valid_url(url, path_forbidden=True)
-
load_service_key(service_key_json: 'str')
-
prompt_for_input(prompt_text, is_url=False, path_forbidden=True)
-

- - - - - -
 
Data
       AI_CORE_PREFIX = 'AICORE'
-API_V2_SUFFIX = '/v2'
-CORE_CREDENTIAL_VALUES = [CredentialsValue(name='client_id', vcap_key=('credentials', 'clientid'), transform_fn=None), CredentialsValue(name='client_secret', vcap_key=('credentials', 'clientsecret'), transform_fn=None), CredentialsValue(name='auth_url', vcap_key=('credentials', 'url'), transform_fn=<lambda>), CredentialsValue(name='base_url', vcap_key=('cre...rviceurls', 'AI_API_URL'), transform_fn=<lambda>), CredentialsValue(name='resource_group', vcap_key=None, transform_fn=None), CredentialsValue(name='cert_url', vcap_key=('credentials', 'certurl'), transform_fn=<lambda>), CredentialsValue(name='cert_file_path', vcap_key=None, transform_fn=None), CredentialsValue(name='key_file_path', vcap_key=None, transform_fn=None), CredentialsValue(name='cert_str', vcap_key=('credentials', 'certificate'), transform_fn=<lambda>), CredentialsValue(name='key_str', vcap_key=('credentials', 'key'), transform_fn=<lambda>)]
-DEFAULT_CONFIG = 'config.json'
-DEFAULT_PROFILE = 'default'
-DEFAULT_RESOURCE_GROUP = 'default'
-MAX_TRIES = 5
-OAUTH_TOKEN_SUFFIX = '/oauth/token'
-Optional = typing.Optional
-cli = <Group cli>
-configure = <Command configure>
- \ No newline at end of file diff --git a/packages/core/docs/ai_core_sdk.credentials.html b/packages/core/docs/ai_core_sdk.credentials.html deleted file mode 100644 index 3621959..0000000 --- a/packages/core/docs/ai_core_sdk.credentials.html +++ /dev/null @@ -1,262 +0,0 @@ - - - - -Python: module ai_core_sdk.credentials - - - - - -
 
ai_core_sdk.credentials		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/core/ai_core_sdk/credentials.py
-

-

- - - - - -
 
Modules
       
json
-		os
-		pathlib
-

- - - - - -
 
Classes
       
-
builtins.object -
-
-
CredentialsValue -
Service -
Source -
VCAPEnvironment -
-
-
-

- - - - - - - -
 
class CredentialsValue(builtins.object)
   CredentialsValue(
-    name: 'str',
-    vcap_key: 'Optional[Tuple[str, ...]]' = None,
-    transform_fn: 'Optional[Callable]' = None
-) -&gt; None
- 
-CredentialsValue(name: 'str', vcap_key: 'Optional[Tuple[str, ...]]' = None, transform_fn: 'Optional[Callable]' = None)
 
 Methods defined here:
-
__eq__(self, other)
Return self==value.
- -
__init__( - self, - name: 'str', - vcap_key: 'Optional[Tuple[str, ...]]' = None, - transform_fn: 'Optional[Callable]' = None -) -> None
Initialize self.  See help(type(self)) for accurate signature.
- -
__replace__ = _replace(self, /, **changes) from dataclasses
- -
__repr__(self)
Return repr(self).
- -
-Data descriptors defined here:
-
__dict__
-
dictionary for instance variables
-
-
__weakref__
-
list of weak references to the object
-
-
-Data and other attributes defined here:
-
__annotations__ = {'name': 'str', 'transform_fn': 'Optional[Callable]', 'vcap_key': 'Optional[Tuple[str, ...]]'}
- -
__dataclass_fields__ = {'name': Field(name='name',type='str',default=<dataclasse...appingproxy({}),kw_only=False,_field_type=_FIELD), 'transform_fn': Field(name='transform_fn',type='Optional[Callabl...appingproxy({}),kw_only=False,_field_type=_FIELD), 'vcap_key': Field(name='vcap_key',type='Optional[Tuple[str, ...appingproxy({}),kw_only=False,_field_type=_FIELD)}
- -
__dataclass_params__ = _DataclassParams(init=True,repr=True,eq=True,ord...rue,kw_only=False,slots=False,weakref_slot=False)
- -
__hash__ = None
- -
__match_args__ = ('name', 'vcap_key', 'transform_fn')
- -
transform_fn = None
- -
vcap_key = None
- -

- - - - - - - -
 
class Service(builtins.object)
   Service(env: 'Dict[str, Any]')
- 
-
 
 Methods defined here:
-
__getitem__(self, key)
- -
__init__(self, env: 'Dict[str, Any]')
Initialize self.  See help(type(self)) for accurate signature.
- -
get(self, key, default=NoDefault)
- -
-Readonly properties defined here:
-
label
-
-
name
-
-
-Data descriptors defined here:
-
__dict__
-
dictionary for instance variables
-
-
__weakref__
-
list of weak references to the object
-
-

- - - - - - - -
 
class Source(builtins.object)
   Source(name: 'str', get: 'Callable[[CredentialsValue], Optional[str]]') -&gt; None
- 
-Source(name: 'str', get: 'Callable[[CredentialsValue], Optional[str]]')
 
 Methods defined here:
-
__eq__(self, other)
Return self==value.
- -
__init__(self, name: 'str', get: 'Callable[[CredentialsValue], Optional[str]]') -> None
Initialize self.  See help(type(self)) for accurate signature.
- -
__replace__ = _replace(self, /, **changes) from dataclasses
- -
__repr__(self)
Return repr(self).
- -
-Data descriptors defined here:
-
__dict__
-
dictionary for instance variables
-
-
__weakref__
-
list of weak references to the object
-
-
-Data and other attributes defined here:
-
__annotations__ = {'get': 'Callable[[CredentialsValue], Optional[str]]', 'name': 'str'}
- -
__dataclass_fields__ = {'get': Field(name='get',type='Callable[[CredentialsValu...appingproxy({}),kw_only=False,_field_type=_FIELD), 'name': Field(name='name',type='str',default=<dataclasse...appingproxy({}),kw_only=False,_field_type=_FIELD)}
- -
__dataclass_params__ = _DataclassParams(init=True,repr=True,eq=True,ord...rue,kw_only=False,slots=False,weakref_slot=False)
- -
__hash__ = None
- -
__match_args__ = ('name', 'get')
- -

- - - - - - - -
 
class VCAPEnvironment(builtins.object)
   VCAPEnvironment(services: 'List[Service]') -&gt; None
- 
-VCAPEnvironment(services: 'List[Service]')
 
 Methods defined here:
-
__eq__(self, other)
Return self==value.
- -
__getitem__(self, name) -> 'Service'
- -
__init__(self, services: 'List[Service]') -> None
Initialize self.  See help(type(self)) for accurate signature.
- -
__replace__ = _replace(self, /, **changes) from dataclasses
- -
__repr__(self)
Return repr(self).
- -
get_service(self, label, exactly_one: 'bool' = True) -> 'Service'
- -
get_service_by_name(self, name, exactly_one: 'bool' = True) -> 'Service'
- -
-Class methods defined here:
-
from_dict(env: 'Dict[str, Any]')
- -
from_env(env_var: 'Optional[str]' = None)
- -
-Data descriptors defined here:
-
__dict__
-
dictionary for instance variables
-
-
__weakref__
-
list of weak references to the object
-
-
-Data and other attributes defined here:
-
__annotations__ = {'services': 'List[Service]'}
- -
__dataclass_fields__ = {'services': Field(name='services',type='List[Service]',defau...appingproxy({}),kw_only=False,_field_type=_FIELD)}
- -
__dataclass_params__ = _DataclassParams(init=True,repr=True,eq=True,ord...rue,kw_only=False,slots=False,weakref_slot=False)
- -
__hash__ = None
- -
__match_args__ = ('services',)
- -

- - - - - -
 
Functions
       
fetch_credentials( - profile: 'str' = None, - credential_values: 'List[CredentialsValue]' = [CredentialsValue(name='client_id', vcap_key=('credentials', 'clientid'), transform_fn=None), CredentialsValue(name='client_secret', vcap_key=('credentials', 'clientsecret'), transform_fn=None), CredentialsValue(name='auth_url', vcap_key=('credentials', 'url'), transform_fn=<lambda>), CredentialsValue(name='base_url', vcap_key=('credentials', 'serviceurls', 'AI_API_URL'), transform_fn=<lambda>), CredentialsValue(name='resource_group', vcap_key=None, transform_fn=None), CredentialsValue(name='cert_url', vcap_key=('credentials', 'certurl'), transform_fn=<lambda>), CredentialsValue(name='cert_file_path', vcap_key=None, transform_fn=None), CredentialsValue(name='key_file_path', vcap_key=None, transform_fn=None), CredentialsValue(name='cert_str', vcap_key=('credentials', 'certificate'), transform_fn=<lambda>), CredentialsValue(name='key_str', vcap_key=('credentials', 'key'), transform_fn=<lambda>)], - validate: 'bool' = True, - **kwargs -) -> 'Dict[str, str]'
Fetch credentials from a single source based on precedence.
- 
-Precedence order: kwargs > environment variables > config file > VCAP service
- 
-Once a source is selected (first one with any credential), all credentials
-come from that source only. Resource group is an exception and follows
-precedence independently.
- 
-If credential_values is provided and it's not extended from the CORE_CREDENTIAL_VALUES, set validate to False
-
get_nested_value(data_dict, keys: 'List[str]')
Retrieve a nested value from a dictionary using a list of strings.
- 
-:param data_dict: The dictionary to search.
-:param keys: A list of strings representing nested keys.
-:return: The value associated with the nested keys, or None if not found.
-
init_conf(profile: 'str' = None)
-
resolve_resource_group(sources: 'List[Source]') -> 'Optional[str]'
Find resource_group from the first source that defines it.
-
validate_credentials(credentials: 'Dict[str, str]') -> 'None'
Validate that we have a complete authentication method.
-

- - - - - -
 
Data
       AI_CORE_PREFIX = 'AICORE'
-AUTH_ENDPOINT_SUFFIX = '/oauth/token'
-CONFIG_FILE_ENV_VAR = 'AICORE_CONFIG'
-CORE_CREDENTIAL_VALUES = [CredentialsValue(name='client_id', vcap_key=('credentials', 'clientid'), transform_fn=None), CredentialsValue(name='client_secret', vcap_key=('credentials', 'clientsecret'), transform_fn=None), CredentialsValue(name='auth_url', vcap_key=('credentials', 'url'), transform_fn=<lambda>), CredentialsValue(name='base_url', vcap_key=('cre...rviceurls', 'AI_API_URL'), transform_fn=<lambda>), CredentialsValue(name='resource_group', vcap_key=None, transform_fn=None), CredentialsValue(name='cert_url', vcap_key=('credentials', 'certurl'), transform_fn=<lambda>), CredentialsValue(name='cert_file_path', vcap_key=None, transform_fn=None), CredentialsValue(name='key_file_path', vcap_key=None, transform_fn=None), CredentialsValue(name='cert_str', vcap_key=('credentials', 'certificate'), transform_fn=<lambda>), CredentialsValue(name='key_str', vcap_key=('credentials', 'key'), transform_fn=<lambda>)]
-Callable = typing.Callable
-Dict = typing.Dict
-Final = typing.Final
-List = typing.List
-NoDefault = NoDefault
-Optional = typing.Optional
-PROFILE_ENV_VAR = 'AICORE_PROFILE'
-Tuple = typing.Tuple
-VCAP_AICORE_SERVICE_NAME = 'aicore'
-VCAP_SERVICES_ENV_VAR = 'VCAP_SERVICES'
-__annotations__ = {'CORE_CREDENTIAL_VALUES': 'Final[List[CredentialsValue]]'}
-logger = <Logger ai_core_sdk (INFO)>
- \ No newline at end of file diff --git a/packages/core/docs/ai_core_sdk.exception.html b/packages/core/docs/ai_core_sdk.exception.html deleted file mode 100644 index 8005afe..0000000 --- a/packages/core/docs/ai_core_sdk.exception.html +++ /dev/null @@ -1,156 +0,0 @@ - - - - -Python: module ai_core_sdk.exception - - - - - -
 
ai_core_sdk.exception		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/core/ai_core_sdk/exception.py
-

-

- - - - - -
 
Classes
       
-
builtins.Exception(builtins.BaseException) -
-
-
AICoreSDKException -
-
-
AICoreInvalidInputException -
-
-
-
-
-

- - - - - - - -
 
class AICoreInvalidInputException(AICoreSDKException)
   Exception thrown in case of invalid input
 
 
Method resolution order:
-
AICoreInvalidInputException
-
AICoreSDKException
-
builtins.Exception
-
builtins.BaseException
-
builtins.object
-
-
-Data descriptors inherited from AICoreSDKException:
-
__weakref__
-
list of weak references to the object
-
-
-Methods inherited from builtins.Exception:
-
__init__(self, /, *args, **kwargs)
Initialize self.  See help(type(self)) for accurate signature.
- -
-Static methods inherited from builtins.Exception:
-
__new__(*args, **kwargs) class method of builtins.Exception
Create and return a new object.  See help(type) for accurate signature.
- -
-Methods inherited from builtins.BaseException:
-
__getattribute__(self, name, /)
Return getattr(self, name).
- -
__reduce__(self, /)
Helper for pickle.
- -
__repr__(self, /)
Return repr(self).
- -
__setstate__(self, object, /)
- -
__str__(self, /)
Return str(self).
- -
add_note(self, object, /)
Exception.add_note(note) --
-add a note to the exception
- -
with_traceback(self, object, /)
Exception.with_traceback(tb) --
-set self.__traceback__ to tb and return self.
- -
-Data descriptors inherited from builtins.BaseException:
-
__cause__
-
exception cause
-
-
__context__
-
exception context
-
-
__dict__
-
-
__suppress_context__
-
-
__traceback__
-
-
args
-
-

- - - - - - - -
 
class AICoreSDKException(builtins.Exception)
   Base Exception class for AI Core SDK exceptions
 
 
Method resolution order:
-
AICoreSDKException
-
builtins.Exception
-
builtins.BaseException
-
builtins.object
-
-
-Data descriptors defined here:
-
__weakref__
-
list of weak references to the object
-
-
-Methods inherited from builtins.Exception:
-
__init__(self, /, *args, **kwargs)
Initialize self.  See help(type(self)) for accurate signature.
- -
-Static methods inherited from builtins.Exception:
-
__new__(*args, **kwargs) class method of builtins.Exception
Create and return a new object.  See help(type) for accurate signature.
- -
-Methods inherited from builtins.BaseException:
-
__getattribute__(self, name, /)
Return getattr(self, name).
- -
__reduce__(self, /)
Helper for pickle.
- -
__repr__(self, /)
Return repr(self).
- -
__setstate__(self, object, /)
- -
__str__(self, /)
Return str(self).
- -
add_note(self, object, /)
Exception.add_note(note) --
-add a note to the exception
- -
with_traceback(self, object, /)
Exception.with_traceback(tb) --
-set self.__traceback__ to tb and return self.
- -
-Data descriptors inherited from builtins.BaseException:
-
__cause__
-
exception cause
-
-
__context__
-
exception context
-
-
__dict__
-
-
__suppress_context__
-
-
__traceback__
-
-
args
-
-

- \ No newline at end of file diff --git a/packages/core/docs/ai_core_sdk.helpers.constants.html b/packages/core/docs/ai_core_sdk.helpers.constants.html deleted file mode 100644 index ed3acc2..0000000 --- a/packages/core/docs/ai_core_sdk.helpers.constants.html +++ /dev/null @@ -1,101 +0,0 @@ - - - - -Python: module ai_core_sdk.helpers.constants - - - - - -
 
ai_core_sdk.helpers.constants		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/core/ai_core_sdk/helpers/constants.py
-

-

- - - - - -
 
Modules
       
os
-

- - - - - -
 
Classes
       
-
enum.Enum(builtins.object) -
-
-
Timeouts -
-
-
-

- - - - - - - -
 
class Timeouts(enum.Enum)
   Timeouts(*values)
- 
-
 
 
Method resolution order:
-
Timeouts
-
enum.Enum
-
builtins.object
-
-
-Data and other attributes defined here:
-
NUM_REQUEST_RETRIES = <Timeouts.NUM_REQUEST_RETRIES: 3>
- -
READ_TIMEOUT = <Timeouts.READ_TIMEOUT: 60>
- -
-Data descriptors inherited from enum.Enum:
-
name
-
The name of the Enum member.
-
-
value
-
The value of the Enum member.
-
-
-Static methods inherited from enum.EnumType:
-
__contains__(value)
Return True if `value` is in `cls`.
- 
-`value` is in `cls` if:
-1) `value` is a member of `cls`, or
-2) `value` is the value of one of the `cls`'s members.
-3) `value` is a pseudo-member (flags)
- -
__getitem__(name)
Return the member matching `name`.
- -
__iter__()
Return members in definition order.
- -
__len__()
Return the number of members (no aliases)
- -
-Readonly properties inherited from enum.EnumType:
-
__members__
-
Returns a mapping of member name->value.
- 
-This mapping lists all enum members, including aliases.  Note that
-this is a read-only view of the internal mapping.
-
-

- - - - - -
 
Data
       AI_CORE_PREFIX = 'AICORE'
-AUTH_ENDPOINT_SUFFIX = '/oauth/token'
-CONFIG_FILE_ENV_VAR = 'AICORE_CONFIG'
-DEBUG_ENV_VAR_NAME = 'DEBUG'
-DEFAULT_HOME_PATH = '/home/runner/.aicore'
-HOME_PATH_ENV_VAR = 'AICORE_HOME'
-PROFILE_ENV_VAR = 'AICORE_PROFILE'
-VCAP_AICORE_SERVICE_NAME = 'aicore'
-VCAP_SERVICES_ENV_VAR = 'VCAP_SERVICES'
- \ No newline at end of file diff --git a/packages/core/docs/ai_core_sdk.helpers.html b/packages/core/docs/ai_core_sdk.helpers.html deleted file mode 100644 index 861db41..0000000 --- a/packages/core/docs/ai_core_sdk.helpers.html +++ /dev/null @@ -1,49 +0,0 @@ - - - - -Python: package ai_core_sdk.helpers - - - - - -
 
ai_core_sdk.helpers		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/core/ai_core_sdk/helpers/__init__.py
-

-

- - - - - -
 
Package Contents
       
constants
-		logging
-

- - - - - -
 
Functions
       
form_top_skip_params(top: int = None, skip: int = None) -> Dict[str, int]
Frame query param
- 
-:param top: Number of objects to be retrieved, defaults to None
-:type top: int, optional
-:param skip: Number of objects to be skipped, from the list of the queried objects,
-    defaults to None
-:type skip: int, optional
-
get_home() -> str
-
is_within_aicore() -> bool
[summary]
-Function to check whether the sdk is used within or out of aicore cluster
-Returns:
-    bool: True if the ai-core-sdk is used within aicore cluster
-          False if the ai-core-sdk is used outside aicore cluster
-

- - - - - -
 
Data
       DEFAULT_HOME_PATH = '/home/runner/.aicore'
-Dict = typing.Dict
-HOME_PATH_ENV_VAR = 'AICORE_HOME'
- \ No newline at end of file diff --git a/packages/core/docs/ai_core_sdk.helpers.logging.html b/packages/core/docs/ai_core_sdk.helpers.logging.html deleted file mode 100644 index aad6177..0000000 --- a/packages/core/docs/ai_core_sdk.helpers.logging.html +++ /dev/null @@ -1,38 +0,0 @@ - - - - -Python: module ai_core_sdk.helpers.logging - - - - - -
 
ai_core_sdk.helpers.logging		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/core/ai_core_sdk/helpers/logging.py
-

-

- - - - - -
 
Modules
       
logging
-		os
-

- - - - - -
 
Functions
       
get_logger(name: str = None)
-
set_log_level(logger: logging.Logger, default_level=20)
-

- - - - - -
 
Data
       BASE_LOGGER_NAME = 'ai_core_sdk'
-DEBUG_ENV_VAR_NAME = 'DEBUG'
-DEFAULT_LOG_LEVEL = 20
- \ No newline at end of file diff --git a/packages/core/docs/ai_core_sdk.html b/packages/core/docs/ai_core_sdk.html deleted file mode 100644 index 94f1d13..0000000 --- a/packages/core/docs/ai_core_sdk.html +++ /dev/null @@ -1,28 +0,0 @@ - - - - -Python: package ai_core_sdk - - - - - -
 
ai_core_sdk		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/core/ai_core_sdk/__init__.py
-

-

- - - - - -
 
Package Contents
       
ai_core_v2_client
-cli
-		credentials
-exception
-		helpers (package)
-models (package)
-		resource_clients (package)
-tracking (package)
-
- \ No newline at end of file diff --git a/packages/core/docs/ai_core_sdk.models.application.html b/packages/core/docs/ai_core_sdk.models.application.html deleted file mode 100644 index 14dc2be..0000000 --- a/packages/core/docs/ai_core_sdk.models.application.html +++ /dev/null @@ -1,89 +0,0 @@ - - - - -Python: module ai_core_sdk.models.application - - - - - -
 
ai_core_sdk.models.application		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/core/ai_core_sdk/models/application.py
-

-

- - - - - -
 
Classes
       
-
builtins.object -
-
-
Application -
-
-
-

- - - - - - - -
 
class Application(builtins.object)
   Application(
-    path: str,
-    revision: str,
-    repository_url: str,
-    application_name: str,
-    **kwargs
-)
- 
-The Application object defines the application.
- 
-:param path: path within the repository
-:type path: str
-:param revision: revision
-:type revision: str
-:param repository_url: URL of the repository
-:type repository_url: str
-:param application_name: name of the application
-:type application_name: str
 
 Methods defined here:
-
__init__( - self, - path: str, - revision: str, - repository_url: str, - application_name: str, - **kwargs -)
Initialize self.  See help(type(self)) for accurate signature.
- -
__str__(self)
Return str(self).
- -
-Static methods defined here:
-
from_dict(application_dict: Dict[str, str])
Returns a :class:`ai_core_sdk.models.application.Application` object, created from the values in
-the dict provided as parameter
- 
-:param application_dict: Dict which includes the necessary values to create the object
-:type application_dict: Dict[str, Any]
-:return: An object, created from the values provided
-:rtype: class:`ai_core_sdk.models.application.Application`
- -
-Data descriptors defined here:
-
__dict__
-
dictionary for instance variables
-
-
__weakref__
-
list of weak references to the object
-
-

- - - - - -
 
Data
       Dict = typing.Dict
- \ No newline at end of file diff --git a/packages/core/docs/ai_core_sdk.models.application_query_response.html b/packages/core/docs/ai_core_sdk.models.application_query_response.html deleted file mode 100644 index d51cc5e..0000000 --- a/packages/core/docs/ai_core_sdk.models.application_query_response.html +++ /dev/null @@ -1,91 +0,0 @@ - - - - -Python: module ai_core_sdk.models.application_query_response - - - - - -
 
ai_core_sdk.models.application_query_response		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/core/ai_core_sdk/models/application_query_response.py
-

-

- - - - - -
 
Classes
       
-
ai_api_client_sdk.models.base_models.QueryResponse(builtins.object) -
-
-
ApplicationQueryResponse -
-
-
-

- - - - - - - -
 
class ApplicationQueryResponse(ai_api_client_sdk.models.base_models.QueryResponse)
   ApplicationQueryResponse(
-    resources: List[ai_core_sdk.models.application.Application],
-    count: int,
-    **kwargs
-)
- 
-The ApplicationQueryResponse object defines the response of the applications query request
-:param resources: List of the applications returned from the server
-:type resources: List[class:`ai_core_sdk.models.application.Application`]
-:param count: Total number of the queried applications
-:type count: int
-:param `**kwargs`: The keyword arguments are there in case there are additional attributes returned from server
 
 
Method resolution order:
-
ApplicationQueryResponse
-
ai_api_client_sdk.models.base_models.QueryResponse
-
builtins.object
-
-
-Methods defined here:
-
__init__( - self, - resources: List[ai_core_sdk.models.application.Application], - count: int, - **kwargs -)
Initialize self.  See help(type(self)) for accurate signature.
- -
-Static methods defined here:
-
from_dict(response_dict: Dict[str, Any])
Returns a
-:class:`ai_core_sdk.models.application_query_response.ApplicationQueryResponse`
-object, created from the values in the dict provided as parameter
- 
-:param response_dict: Dict which includes the necessary values to create the object
-:type response_dict: Dict[str, Any]
-:return: An object, created from the values provided
-:rtype: class:`ai_core_sdk.models.application_query_response.ApplicationQueryResponse`
- -
-Methods inherited from ai_api_client_sdk.models.base_models.QueryResponse:
-
__str__(self)
Return str(self).
- -
-Data descriptors inherited from ai_api_client_sdk.models.base_models.QueryResponse:
-
__dict__
-
dictionary for instance variables
-
-
__weakref__
-
list of weak references to the object
-
-

- - - - - -
 
Data
       Dict = typing.Dict
-List = typing.List
- \ No newline at end of file diff --git a/packages/core/docs/ai_core_sdk.models.application_resource_sync_status.html b/packages/core/docs/ai_core_sdk.models.application_resource_sync_status.html deleted file mode 100644 index df97119..0000000 --- a/packages/core/docs/ai_core_sdk.models.application_resource_sync_status.html +++ /dev/null @@ -1,87 +0,0 @@ - - - - -Python: module ai_core_sdk.models.application_resource_sync_status - - - - - -
 
ai_core_sdk.models.application_resource_sync_status		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/core/ai_core_sdk/models/application_resource_sync_status.py
-

-

- - - - - -
 
Classes
       
-
builtins.object -
-
-
ApplicationResourceSyncStatus -
-
-
-

- - - - - - - -
 
class ApplicationResourceSyncStatus(builtins.object)
   ApplicationResourceSyncStatus(
-    name: str = None,
-    kind: str = None,
-    status: str = None,
-    message: str = None,
-    **kwargs
-)
- 
-The ApplicationSyncResourcesStatus object defines the status of sync of application resource.
- 
-:param name: Name of the application resource, defaults to None
-:type name: str, optional
-:param kind: kind of the application resource
-:type kind: str, optional
-:param status: status of the sync of the application resource
-:type status: str, optional
-:param message: application resource message
-:type message: str, optional
 
 Methods defined here:
-
__init__( - self, - name: str = None, - kind: str = None, - status: str = None, - message: str = None, - **kwargs -)
Initialize self.  See help(type(self)) for accurate signature.
- -
-Static methods defined here:
-
from_dict(app_res_sync_status_dict: Dict[str, str])
Returns a :class:`ai_core_sdk.models.application_resource_sync_status.ApplicationResourceSyncStatus`
-object, created from the values in the dict provided as parameter
- 
-:param app_res_sync_status_dict: Dict which includes the necessary values to create the object
-:type app_res_sync_status_dict: Dict[str, str]
-:return: An object, created from the values provided
-:rtype: class:`ai_core_sdk.models.application_resource_sync_status.ApplicationResourceSyncStatus`
- -
-Data descriptors defined here:
-
__dict__
-
dictionary for instance variables
-
-
__weakref__
-
list of weak references to the object
-
-

- - - - - -
 
Data
       Dict = typing.Dict
- \ No newline at end of file diff --git a/packages/core/docs/ai_core_sdk.models.application_source.html b/packages/core/docs/ai_core_sdk.models.application_source.html deleted file mode 100644 index 43be580..0000000 --- a/packages/core/docs/ai_core_sdk.models.application_source.html +++ /dev/null @@ -1,85 +0,0 @@ - - - - -Python: module ai_core_sdk.models.application_source - - - - - -
 
ai_core_sdk.models.application_source		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/core/ai_core_sdk/models/application_source.py
-

-

- - - - - -
 
Classes
       
-
builtins.object -
-
-
ApplicationSource -
-
-
-

- - - - - - - -
 
class ApplicationSource(builtins.object)
   ApplicationSource(
-    repo_url: str = None,
-    path: str = None,
-    revision: str = None,
-    **kwargs
-)
- 
-The ApplicationSource object defines the application source.
- 
-:param repo_url: URL of the repository, defaults to None
-:type repo_url: str, optional
-:param path: path within the repository, defaults to None
-:type path: str, optional
-:param revision: revision number of the application, defaults to None
-:type revision: str, optional
 
 Methods defined here:
-
__init__( - self, - repo_url: str = None, - path: str = None, - revision: str = None, - **kwargs -)
Initialize self.  See help(type(self)) for accurate signature.
- -
__str__(self)
Return str(self).
- -
-Static methods defined here:
-
from_dict(application_source_dict: Dict[str, str])
Returns a :class:`ai_core_sdk.models.application_source.ApplicationSource` object, created from the values in
-the dict provided as parameter
- 
-:param application_source_dict: Dict which includes the necessary values to create the object
-:type application_source_dict: Dict[str, Any]
-:return: An object, created from the values provided
-:rtype: class:`ai_core_sdk.models.application_source.ApplicationSource`
- -
-Data descriptors defined here:
-
__dict__
-
dictionary for instance variables
-
-
__weakref__
-
list of weak references to the object
-
-

- - - - - -
 
Data
       Dict = typing.Dict
- \ No newline at end of file diff --git a/packages/core/docs/ai_core_sdk.models.application_status.html b/packages/core/docs/ai_core_sdk.models.application_status.html deleted file mode 100644 index c5ab56a..0000000 --- a/packages/core/docs/ai_core_sdk.models.application_status.html +++ /dev/null @@ -1,107 +0,0 @@ - - - - -Python: module ai_core_sdk.models.application_status - - - - - -
 
ai_core_sdk.models.application_status		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/core/ai_core_sdk/models/application_status.py
-

-

- - - - - -
 
Classes
       
-
builtins.object -
-
-
ApplicationStatus -
-
-
-

- - - - - - - -
 
class ApplicationStatus(builtins.object)
   ApplicationStatus(
-    health_status: str = None,
-    sync_status: str = None,
-    message: str = None,
-    source: ai_core_sdk.models.application_source.ApplicationSource = None,
-    sync_finished_at: str = None,
-    sync_started_at: str = None,
-    reconciled_at: str = None,
-    sync_resources_status: List[ai_core_sdk.models.application_resource_sync_status.ApplicationResourceSyncStatus] = None,
-    **kwargs
-)
- 
-The Application object defines the application.
- 
-:param health_status: Application health status, defaults to None
-:type health_status: str, optional
-:param sync_status: Application sync status, defaults to None
-:type sync_status: str, optional
-:param message: Application health status message, defaults to None
-:type message: str, optional
-:param source: Application source, defaults to None
-:type source: class:`ai_core_sdk.models.application_status.ApplicationStatus`, optional
-:param sync_finished_at: Application sync finish time, defaults to None
-:type sync_finished_at: str, optional
-:param sync_started_at: Application sync start time, defaults to None
-:type sync_started_at: str, optional
-:param reconciled_at: Application reconciliation time, defaults to None
-:type reconciled_at: str, optional
-:param sync_resources_status: Status of the synchronization of the application resources, defaults to None
-:type sync_resources_status:
-    List[class:`ai_core_sdk.models.application_resource_sync_status.ApplicationResourceSyncStatus`], optional
 
 Methods defined here:
-
__init__( - self, - health_status: str = None, - sync_status: str = None, - message: str = None, - source: ai_core_sdk.models.application_source.ApplicationSource = None, - sync_finished_at: str = None, - sync_started_at: str = None, - reconciled_at: str = None, - sync_resources_status: List[ai_core_sdk.models.application_resource_sync_status.ApplicationResourceSyncStatus] = None, - **kwargs -)
Initialize self.  See help(type(self)) for accurate signature.
- -
__str__(self)
Return str(self).
- -
-Static methods defined here:
-
from_dict(application_status_dict: Dict[str, Any])
Returns a :class:`ai_core_sdk.models.application_status.ApplicationStatus` object, created from the values in
-the dict provided as parameter
- 
-:param application_status_dict: Dict which includes the necessary values to create the object
-:type application_status_dict: Dict[str, Any]
-:return: An object, created from the values provided
-:rtype: class:`ai_core_sdk.models.application_status.ApplicationStatus`
- -
-Data descriptors defined here:
-
__dict__
-
dictionary for instance variables
-
-
__weakref__
-
list of weak references to the object
-
-

- - - - - -
 
Data
       Dict = typing.Dict
-List = typing.List
- \ No newline at end of file diff --git a/packages/core/docs/ai_core_sdk.models.base_models.html b/packages/core/docs/ai_core_sdk.models.base_models.html deleted file mode 100644 index 7c108f3..0000000 --- a/packages/core/docs/ai_core_sdk.models.base_models.html +++ /dev/null @@ -1,116 +0,0 @@ - - - - -Python: module ai_core_sdk.models.base_models - - - - - -
 
ai_core_sdk.models.base_models		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/core/ai_core_sdk/models/base_models.py
-

-

- - - - - -
 
Classes
       
-
builtins.object -
-
-
BasicNameResponse -
Message -
-
-
-

- - - - - - - -
 
class BasicNameResponse(builtins.object)
   BasicNameResponse(name: str, message: str, **kwargs)
- 
-The BasicNameResponse object defines the response with name from the server
- 
-:param name: Name of the relevant resource
-:type id: str
-: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
 
 Methods defined here:
-
__init__(self, name: str, message: str, **kwargs)
Initialize self.  See help(type(self)) for accurate signature.
- -
__str__(self)
Return str(self).
- -
-Static methods defined here:
-
from_dict(bnr_dict: Dict[str, str])
Returns a :class:`ai_core_sdk.models.base_models.BasicNameResponse` object, created from the values in the
-dict provided as parameter
- 
-:param bnr_dict: Dict which includes the necessary values to create the object
-:type bnr_dict: Dict[str, str]
-:return: An object, created from the values provided
-:rtype: class:`ai_core_sdk.models.base_models.BasicNameResponse`
- -
-Data descriptors defined here:
-
__dict__
-
dictionary for instance variables
-
-
__weakref__
-
list of weak references to the object
-
-

- - - - - - - -
 
class Message(builtins.object)
   Message(message: str, **kwargs)
- 
-Message object defines a message
- 
-:param message: message
-:type message: str
 
 Methods defined here:
-
__eq__(self, other)
Return self==value.
- -
__init__(self, message: str, **kwargs)
Initialize self.  See help(type(self)) for accurate signature.
- -
__str__(self)
Return str(self).
- -
-Static methods defined here:
-
from_dict(message_dict: Dict[str, str])
Returns a :class:`ai_core_sdk.models.base_models.Message` object, created from the values in the
-dict provided as parameter
- 
-:param message_dict: Dict which includes the necessary values to create the object
-:type message_dict: Dict[str, str]
-:return: An object, created from the values provided
-:rtype: class:`ai_core_sdk.models.base_models.Message`
- -
-Data descriptors defined here:
-
__dict__
-
dictionary for instance variables
-
-
__weakref__
-
list of weak references to the object
-
-
-Data and other attributes defined here:
-
__hash__ = None
- -

- - - - - -
 
Data
       Dict = typing.Dict
- \ No newline at end of file diff --git a/packages/core/docs/ai_core_sdk.models.docker_registry_secret.html b/packages/core/docs/ai_core_sdk.models.docker_registry_secret.html deleted file mode 100644 index 3d48ab5..0000000 --- a/packages/core/docs/ai_core_sdk.models.docker_registry_secret.html +++ /dev/null @@ -1,82 +0,0 @@ - - - - -Python: module ai_core_sdk.models.docker_registry_secret - - - - - -
 
ai_core_sdk.models.docker_registry_secret		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/core/ai_core_sdk/models/docker_registry_secret.py
-

-

- - - - - -
 
Classes
       
-
ai_api_client_sdk.models.base_models.Name(builtins.object) -
-
-
DockerRegistrySecret -
-
-
-

- - - - - - - -
 
class DockerRegistrySecret(ai_api_client_sdk.models.base_models.Name)
   DockerRegistrySecret(name: str, **kwargs)
- 
-The DockerRegistrySecret object defines the docker registry secret. Refer to
-:class:`ai_api_client_sdk.models.base_models.Name`, for the object definition
 
 
Method resolution order:
-
DockerRegistrySecret
-
ai_api_client_sdk.models.base_models.Name
-
builtins.object
-
-
-Methods defined here:
-
__str__(self)
Return str(self).
- -
-Static methods defined here:
-
from_dict(docker_registry_secret_dict: Dict[str, str])
Returns a :class:`ai_core_sdk.models.docker_registry_secret.DockerRegistrySecret` object, created
-from the values in the dict provided as parameter
- 
-:param docker_registry_secret_dict: Dict which includes the necessary values to create the object
-:type docker_registry_secret_dict: Dict[str, str]
-:return: An object, created from the values provided
-:rtype: class:`ai_core_sdk.models.docker_registry_secret.DockerRegistrySecret`
- -
-Methods inherited from ai_api_client_sdk.models.base_models.Name:
-
__eq__(self, other)
Return self==value.
- -
__init__(self, name: str, **kwargs)
Initialize self.  See help(type(self)) for accurate signature.
- -
-Data descriptors inherited from ai_api_client_sdk.models.base_models.Name:
-
__dict__
-
dictionary for instance variables
-
-
__weakref__
-
list of weak references to the object
-
-
-Data and other attributes inherited from ai_api_client_sdk.models.base_models.Name:
-
__hash__ = None
- -

- - - - - -
 
Data
       Dict = typing.Dict
- \ No newline at end of file diff --git a/packages/core/docs/ai_core_sdk.models.docker_registry_secret_query_response.html b/packages/core/docs/ai_core_sdk.models.docker_registry_secret_query_response.html deleted file mode 100644 index 59b001f..0000000 --- a/packages/core/docs/ai_core_sdk.models.docker_registry_secret_query_response.html +++ /dev/null @@ -1,91 +0,0 @@ - - - - -Python: module ai_core_sdk.models.docker_registry_secret_query_response - - - - - -
 
ai_core_sdk.models.docker_registry_secret_query_response		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/core/ai_core_sdk/models/docker_registry_secret_query_response.py
-

-

- - - - - -
 
Classes
       
-
ai_api_client_sdk.models.base_models.QueryResponse(builtins.object) -
-
-
DockerRegistrySecretQueryResponse -
-
-
-

- - - - - - - -
 
class DockerRegistrySecretQueryResponse(ai_api_client_sdk.models.base_models.QueryResponse)
   DockerRegistrySecretQueryResponse(
-    resources: List[ai_core_sdk.models.docker_registry_secret.DockerRegistrySecret],
-    count: int,
-    **kwargs
-)
- 
-The DockerRegistrySecretQueryResponse object defines the response of the dockerRegistrySecrets query request
-:param resources: List of the docker registry secrets returned from the server
-:type resources: List[class:`ai_core_sdk.models.docker_registry_secret.DockerRegistrySecret`]
-: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
 
 
Method resolution order:
-
DockerRegistrySecretQueryResponse
-
ai_api_client_sdk.models.base_models.QueryResponse
-
builtins.object
-
-
-Methods defined here:
-
__init__( - self, - resources: List[ai_core_sdk.models.docker_registry_secret.DockerRegistrySecret], - count: int, - **kwargs -)
Initialize self.  See help(type(self)) for accurate signature.
- -
-Static methods defined here:
-
from_dict(response_dict: Dict[str, Any])
Returns a
-:class:`ai_core_sdk.models.docker_registry_secret_query_response.DockerRegistrySecretQueryResponse`
-object, created from the values in the dict provided as parameter
- 
-:param response_dict: Dict which includes the necessary values to create the object
-:type response_dict: Dict[str, Any]
-:return: An object, created from the values provided
-:rtype: class:`ai_core_sdk.models.docker_registry_secret_query_response.DockerRegistrySecretQueryResponse`
- -
-Methods inherited from ai_api_client_sdk.models.base_models.QueryResponse:
-
__str__(self)
Return str(self).
- -
-Data descriptors inherited from ai_api_client_sdk.models.base_models.QueryResponse:
-
__dict__
-
dictionary for instance variables
-
-
__weakref__
-
list of weak references to the object
-
-

- - - - - -
 
Data
       Dict = typing.Dict
-List = typing.List
- \ No newline at end of file diff --git a/packages/core/docs/ai_core_sdk.models.html b/packages/core/docs/ai_core_sdk.models.html deleted file mode 100644 index 5d3dc2d..0000000 --- a/packages/core/docs/ai_core_sdk.models.html +++ /dev/null @@ -1,39 +0,0 @@ - - - - -Python: package ai_core_sdk.models - - - - - -
 
ai_core_sdk.models		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/core/ai_core_sdk/models/__init__.py
-

-

- - - - - -
 
Package Contents
       
application
-application_query_response
-application_resource_sync_status
-application_source
-application_status
-		base_models
-docker_registry_secret
-docker_registry_secret_query_response
-kpi
-object_store_secret
-		object_store_secret_query_response
-repository
-repository_query_response
-repository_status
-resource_group
-		resource_group_query_response
-resource_group_status
-secret
-secret_query_response
-
- \ No newline at end of file diff --git a/packages/core/docs/ai_core_sdk.models.kpi.html b/packages/core/docs/ai_core_sdk.models.kpi.html deleted file mode 100644 index 3391963..0000000 --- a/packages/core/docs/ai_core_sdk.models.kpi.html +++ /dev/null @@ -1,69 +0,0 @@ - - - - -Python: module ai_core_sdk.models.kpi - - - - - -
 
ai_core_sdk.models.kpi		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/core/ai_core_sdk/models/kpi.py
-

-

- - - - - -
 
Classes
       
-
builtins.object -
-
-
Kpi -
-
-
-

- - - - - - - -
 
class Kpi(builtins.object)
   Kpi(header: List[str], rows: List[Union[str, int]], **kwargs)
- 
-The Kpi object defines the Kpi data.
 
 Methods defined here:
-
__init__(self, header: List[str], rows: List[Union[str, int]], **kwargs)
Initialize self.  See help(type(self)) for accurate signature.
- -
__str__(self)
Return str(self).
- -
-Static methods defined here:
-
from_dict(kpi_dict: Dict[str, Any])
Returns a :class:`ai_core_sdk.models.kpi.Kpi` object, created
-from the values in the dict provided as parameter
- 
-:param kpi_dict: Dict which includes the necessary values to create the object
-:type kpi_dict: Dict[str, Any]
-:return: An object, created from the values provided
-:rtype: class:`ai_core_sdk.models.kpi.Kpi`
- -
-Data descriptors defined here:
-
__dict__
-
dictionary for instance variables
-
-
__weakref__
-
list of weak references to the object
-
-

- - - - - -
 
Data
       Dict = typing.Dict
-List = typing.List
-Union = typing.Union
- \ No newline at end of file diff --git a/packages/core/docs/ai_core_sdk.models.object_store_secret.html b/packages/core/docs/ai_core_sdk.models.object_store_secret.html deleted file mode 100644 index 28d2cb4..0000000 --- a/packages/core/docs/ai_core_sdk.models.object_store_secret.html +++ /dev/null @@ -1,67 +0,0 @@ - - - - -Python: module ai_core_sdk.models.object_store_secret - - - - - -
 
ai_core_sdk.models.object_store_secret		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/core/ai_core_sdk/models/object_store_secret.py
-

-

- - - - - -
 
Classes
       
-
builtins.object -
-
-
ObjectStoreSecret -
-
-
-

- - - - - - - -
 
class ObjectStoreSecret(builtins.object)
   ObjectStoreSecret(name: str, metadata: Dict[str, str], **kwargs)
- 
-The ObjectStoreSecret object defines the object store secret response.
 
 Methods defined here:
-
__init__(self, name: str, metadata: Dict[str, str], **kwargs)
Initialize self.  See help(type(self)) for accurate signature.
- -
__str__(self)
Return str(self).
- -
-Static methods defined here:
-
from_dict(object_store_secret_dict: Dict[str, Any])
Returns a :class:`ai_core_sdk.models.object_store_secret.ObjectStoreSecret` object, created
-from the values in the dict provided as parameter
- 
-:param object_store_secret_dict: Dict which includes the necessary values to create the object
-:type object_store_secret_dict: Dict[str, Any]
-:return: An object, created from the values provided
-:rtype: class:`ai_core_sdk.models.object_store_secret.ObjectStoreSecret`
- -
-Data descriptors defined here:
-
__dict__
-
dictionary for instance variables
-
-
__weakref__
-
list of weak references to the object
-
-

- - - - - -
 
Data
       Dict = typing.Dict
- \ No newline at end of file diff --git a/packages/core/docs/ai_core_sdk.models.object_store_secret_query_response.html b/packages/core/docs/ai_core_sdk.models.object_store_secret_query_response.html deleted file mode 100644 index 0eda720..0000000 --- a/packages/core/docs/ai_core_sdk.models.object_store_secret_query_response.html +++ /dev/null @@ -1,91 +0,0 @@ - - - - -Python: module ai_core_sdk.models.object_store_secret_query_response - - - - - -
 
ai_core_sdk.models.object_store_secret_query_response		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/core/ai_core_sdk/models/object_store_secret_query_response.py
-

-

- - - - - -
 
Classes
       
-
ai_api_client_sdk.models.base_models.QueryResponse(builtins.object) -
-
-
ObjectStoreSecretQueryResponse -
-
-
-

- - - - - - - -
 
class ObjectStoreSecretQueryResponse(ai_api_client_sdk.models.base_models.QueryResponse)
   ObjectStoreSecretQueryResponse(
-    resources: List[ai_core_sdk.models.object_store_secret.ObjectStoreSecret],
-    count: int,
-    **kwargs
-)
- 
-The ObjectStoreSecretQueryResponse object defines the response of the object store secret query request
-:param resources: List of the object store secrets returned from the server
-:type resources: List[class:`ai_core_sdk.models.object_store_secret.ObjectStoreSecret`]
-:param count: Total number of the queried object store secrets
-:type count: int
-:param `**kwargs`: The keyword arguments are there in case there are additional attributes returned from server
 
 
Method resolution order:
-
ObjectStoreSecretQueryResponse
-
ai_api_client_sdk.models.base_models.QueryResponse
-
builtins.object
-
-
-Methods defined here:
-
__init__( - self, - resources: List[ai_core_sdk.models.object_store_secret.ObjectStoreSecret], - count: int, - **kwargs -)
Initialize self.  See help(type(self)) for accurate signature.
- -
-Static methods defined here:
-
from_dict(response_dict: Dict[str, Any])
Returns a
-:class:`ai_core_sdk.models.object_store_secret_query_response.ObjectStoreSecretQueryResponse`
-object, created from the values in the dict provided as parameter
- 
-:param response_dict: Dict which includes the necessary values to create the object
-:type response_dict: Dict[str, Any]
-:return: An object, created from the values provided
-:rtype: class:`ai_core_sdk.models.object_store_secret_query_response.ObjectStoreSecretQueryResponse`
- -
-Methods inherited from ai_api_client_sdk.models.base_models.QueryResponse:
-
__str__(self)
Return str(self).
- -
-Data descriptors inherited from ai_api_client_sdk.models.base_models.QueryResponse:
-
__dict__
-
dictionary for instance variables
-
-
__weakref__
-
list of weak references to the object
-
-

- - - - - -
 
Data
       Dict = typing.Dict
-List = typing.List
- \ No newline at end of file diff --git a/packages/core/docs/ai_core_sdk.models.repository.html b/packages/core/docs/ai_core_sdk.models.repository.html deleted file mode 100644 index 826135a..0000000 --- a/packages/core/docs/ai_core_sdk.models.repository.html +++ /dev/null @@ -1,85 +0,0 @@ - - - - -Python: module ai_core_sdk.models.repository - - - - - -
 
ai_core_sdk.models.repository		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/core/ai_core_sdk/models/repository.py
-

-

- - - - - -
 
Classes
       
-
builtins.object -
-
-
Repository -
-
-
-

- - - - - - - -
 
class Repository(builtins.object)
   Repository(
-    name: str,
-    url: str,
-    status: ai_core_sdk.models.repository_status.RepositoryStatus = None,
-    **kwargs
-)
- 
-The Repository object defines the repository
- 
-:param name: name of the repository
-:type name: str
-:param url: URL of the repository
-:type url: str
-:param status: status of the repository, defaults to None
-:type status: class:`ai_core_sdk.models.repository_status.RepositoryStatus`, optional
 
 Methods defined here:
-
__init__( - self, - name: str, - url: str, - status: ai_core_sdk.models.repository_status.RepositoryStatus = None, - **kwargs -)
Initialize self.  See help(type(self)) for accurate signature.
- -
__str__(self)
Return str(self).
- -
-Static methods defined here:
-
from_dict(repository_dict: Dict[str, str])
Returns a :class:`ai_core_sdk.models.repository.Repository` object, created
-from the values in the dict provided as parameter
- 
-:param repository_dict: Dict which includes the necessary values to create the object
-:type repository_dict: Dict[str, Any]
-:return: An object, created from the values provided
-:rtype: class:`ai_core_sdk.models.repository.Repository`
- -
-Data descriptors defined here:
-
__dict__
-
dictionary for instance variables
-
-
__weakref__
-
list of weak references to the object
-
-

- - - - - -
 
Data
       Dict = typing.Dict
- \ No newline at end of file diff --git a/packages/core/docs/ai_core_sdk.models.repository_query_response.html b/packages/core/docs/ai_core_sdk.models.repository_query_response.html deleted file mode 100644 index 3c356ed..0000000 --- a/packages/core/docs/ai_core_sdk.models.repository_query_response.html +++ /dev/null @@ -1,91 +0,0 @@ - - - - -Python: module ai_core_sdk.models.repository_query_response - - - - - -
 
ai_core_sdk.models.repository_query_response		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/core/ai_core_sdk/models/repository_query_response.py
-

-

- - - - - -
 
Classes
       
-
ai_api_client_sdk.models.base_models.QueryResponse(builtins.object) -
-
-
RepositoryQueryResponse -
-
-
-

- - - - - - - -
 
class RepositoryQueryResponse(ai_api_client_sdk.models.base_models.QueryResponse)
   RepositoryQueryResponse(
-    resources: List[ai_core_sdk.models.repository.Repository],
-    count: int,
-    **kwargs
-)
- 
-The RepositoryQueryResponse object defines the response of the repository query request
-:param resources: List of the repositories returned from the server
-:type resources: List[class:`ai_core_sdk.models.repository.Repository`]
-:param count: Total number of the queried repositories
-:type count: int
-:param `**kwargs`: The keyword arguments are there in case there are additional attributes returned from server
 
 
Method resolution order:
-
RepositoryQueryResponse
-
ai_api_client_sdk.models.base_models.QueryResponse
-
builtins.object
-
-
-Methods defined here:
-
__init__( - self, - resources: List[ai_core_sdk.models.repository.Repository], - count: int, - **kwargs -)
Initialize self.  See help(type(self)) for accurate signature.
- -
-Static methods defined here:
-
from_dict(response_dict: Dict[str, Any])
Returns a
-:class:`ai_core_client_sdk.models.repository_query_response.RepositoryQueryResponse`
-object, created from the values in the dict provided as parameter
- 
-:param response_dict: Dict which includes the necessary values to create the object
-:type response_dict: Dict[str, Any]
-:return: An object, created from the values provided
-:rtype: class:`ai_core_sdk.models.repository_query_response.RepositoryQueryResponse`
- -
-Methods inherited from ai_api_client_sdk.models.base_models.QueryResponse:
-
__str__(self)
Return str(self).
- -
-Data descriptors inherited from ai_api_client_sdk.models.base_models.QueryResponse:
-
__dict__
-
dictionary for instance variables
-
-
__weakref__
-
list of weak references to the object
-
-

- - - - - -
 
Data
       Dict = typing.Dict
-List = typing.List
- \ No newline at end of file diff --git a/packages/core/docs/ai_core_sdk.models.repository_status.html b/packages/core/docs/ai_core_sdk.models.repository_status.html deleted file mode 100644 index b3e73cc..0000000 --- a/packages/core/docs/ai_core_sdk.models.repository_status.html +++ /dev/null @@ -1,82 +0,0 @@ - - - - -Python: module ai_core_sdk.models.repository_status - - - - - -
 
ai_core_sdk.models.repository_status		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/core/ai_core_sdk/models/repository_status.py
-

-

- - - - - -
 
Classes
       
-
enum.Enum(builtins.object) -
-
-
RepositoryStatus -
-
-
-

- - - - - - - -
 
class RepositoryStatus(enum.Enum)
   RepositoryStatus(*values)
- 
-RepositoryStatus is an Enum defining the valid values of the status of a repository
 
 
Method resolution order:
-
RepositoryStatus
-
enum.Enum
-
builtins.object
-
-
-Data and other attributes defined here:
-
COMPLETED = <RepositoryStatus.COMPLETED: 'COMPLETED'>
- -
ERROR = <RepositoryStatus.ERROR: 'ERROR'>
- -
IN_PROGRESS = <RepositoryStatus.IN_PROGRESS: 'IN-PROGRESS'>
- -
-Data descriptors inherited from enum.Enum:
-
name
-
The name of the Enum member.
-
-
value
-
The value of the Enum member.
-
-
-Static methods inherited from enum.EnumType:
-
__contains__(value)
Return True if `value` is in `cls`.
- 
-`value` is in `cls` if:
-1) `value` is a member of `cls`, or
-2) `value` is the value of one of the `cls`'s members.
-3) `value` is a pseudo-member (flags)
- -
__getitem__(name)
Return the member matching `name`.
- -
__iter__()
Return members in definition order.
- -
__len__()
Return the number of members (no aliases)
- -
-Readonly properties inherited from enum.EnumType:
-
__members__
-
Returns a mapping of member name->value.
- 
-This mapping lists all enum members, including aliases.  Note that
-this is a read-only view of the internal mapping.
-
-

- \ No newline at end of file diff --git a/packages/core/docs/ai_core_sdk.models.resource_group.html b/packages/core/docs/ai_core_sdk.models.resource_group.html deleted file mode 100644 index b50ed3c..0000000 --- a/packages/core/docs/ai_core_sdk.models.resource_group.html +++ /dev/null @@ -1,98 +0,0 @@ - - - - -Python: module ai_core_sdk.models.resource_group - - - - - -
 
ai_core_sdk.models.resource_group		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/core/ai_core_sdk/models/resource_group.py
-

-

- - - - - -
 
Classes
       
-
builtins.object -
-
-
ResourceGroup -
-
-
-

- - - - - - - -
 
class ResourceGroup(builtins.object)
   ResourceGroup(
-    resource_group_id: str = None,
-    tenant_id: str = None,
-    zone_id: str = None,
-    labels: List[ai_api_client_sdk.models.label.Label] = None,
-    status: ai_core_sdk.models.resource_group_status.ResourceGroupStatus = None,
-    status_message: str = None,
-    **kwargs
-)
- 
-ResourceGroup represents the resource group.
- 
-:param resource_group_id: The resource_group_id of this ResourceGroup.
-:type resource_group_id: str
-:param tenant_id: The tenant_id of this ResourceGroup.
-:type tenant_id: str
-:param zone_id: The zone_id of this ResourceGroup.
-:type zone_id: str
-:param labels: The labels of this ResourceGroup.
-:type labels: ResourceGroupLabels
-:param status: The status of this ResourceGroup.
-:type status: str
-:param status_message: The status_message of this ResourceGroup.
-:type status_message: str
 
 Methods defined here:
-
__init__( - self, - resource_group_id: str = None, - tenant_id: str = None, - zone_id: str = None, - labels: List[ai_api_client_sdk.models.label.Label] = None, - status: ai_core_sdk.models.resource_group_status.ResourceGroupStatus = None, - status_message: str = None, - **kwargs -)
Initialize self.  See help(type(self)) for accurate signature.
- -
__str__(self)
Return str(self).
- -
-Static methods defined here:
-
from_dict(resource_group_dict: Dict[str, Any])
Returns a :class:`ai_core_sdk.models.resource_group.ResourceGroup` object, created
-from the values in the dict provided as parameter
- 
-:param resource_group_dict: Dict which includes the necessary values to create the object
-:type resource_group_dict: Dict[str, Any]
-:return: An object, created from the values provided
-:rtype: class:`ai_core_sdk.models.resource_group.ResourceGroup`
- -
-Data descriptors defined here:
-
__dict__
-
dictionary for instance variables
-
-
__weakref__
-
list of weak references to the object
-
-

- - - - - -
 
Data
       Dict = typing.Dict
-List = typing.List
- \ No newline at end of file diff --git a/packages/core/docs/ai_core_sdk.models.resource_group_query_response.html b/packages/core/docs/ai_core_sdk.models.resource_group_query_response.html deleted file mode 100644 index d56334f..0000000 --- a/packages/core/docs/ai_core_sdk.models.resource_group_query_response.html +++ /dev/null @@ -1,91 +0,0 @@ - - - - -Python: module ai_core_sdk.models.resource_group_query_response - - - - - -
 
ai_core_sdk.models.resource_group_query_response		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/core/ai_core_sdk/models/resource_group_query_response.py
-

-

- - - - - -
 
Classes
       
-
ai_api_client_sdk.models.base_models.QueryResponse(builtins.object) -
-
-
ResourceGroupQueryResponse -
-
-
-

- - - - - - - -
 
class ResourceGroupQueryResponse(ai_api_client_sdk.models.base_models.QueryResponse)
   ResourceGroupQueryResponse(
-    resources: List[ai_core_sdk.models.resource_group.ResourceGroup],
-    count: int,
-    **kwargs
-)
- 
-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
 
 
Method resolution order:
-
ResourceGroupQueryResponse
-
ai_api_client_sdk.models.base_models.QueryResponse
-
builtins.object
-
-
-Methods defined here:
-
__init__( - self, - resources: List[ai_core_sdk.models.resource_group.ResourceGroup], - count: int, - **kwargs -)
Initialize self.  See help(type(self)) for accurate signature.
- -
-Static methods defined here:
-
from_dict(response_dict: Dict[str, Any])
Returns a
-:class:`ai_core_sdk.models.docker_registry_secret_query_response.DockerRegistrySecretQueryResponse`
-object, created from the values in the dict provided as parameter
- 
-:param response_dict: Dict which includes the necessary values to create the object
-:type response_dict: Dict[str, Any]
-:return: An object, created from the values provided
-:rtype: class:`ai_core_sdk.models.docker_registry_secret_query_response.DockerRegistrySecretQueryResponse`
- -
-Methods inherited from ai_api_client_sdk.models.base_models.QueryResponse:
-
__str__(self)
Return str(self).
- -
-Data descriptors inherited from ai_api_client_sdk.models.base_models.QueryResponse:
-
__dict__
-
dictionary for instance variables
-
-
__weakref__
-
list of weak references to the object
-
-

- - - - - -
 
Data
       Dict = typing.Dict
-List = typing.List
- \ No newline at end of file diff --git a/packages/core/docs/ai_core_sdk.models.resource_group_status.html b/packages/core/docs/ai_core_sdk.models.resource_group_status.html deleted file mode 100644 index 976e79e..0000000 --- a/packages/core/docs/ai_core_sdk.models.resource_group_status.html +++ /dev/null @@ -1,82 +0,0 @@ - - - - -Python: module ai_core_sdk.models.resource_group_status - - - - - -
 
ai_core_sdk.models.resource_group_status		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/core/ai_core_sdk/models/resource_group_status.py
-

-

- - - - - -
 
Classes
       
-
enum.Enum(builtins.object) -
-
-
ResourceGroupStatus -
-
-
-

- - - - - - - -
 
class ResourceGroupStatus(enum.Enum)
   ResourceGroupStatus(*values)
- 
-ResourceGroupStatus is an Enum defining the valid values of the status of a resource group
 
 
Method resolution order:
-
ResourceGroupStatus
-
enum.Enum
-
builtins.object
-
-
-Data and other attributes defined here:
-
ERROR = <ResourceGroupStatus.ERROR: 'ERROR'>
- -
PROVISIONED = <ResourceGroupStatus.PROVISIONED: 'PROVISIONED'>
- -
PROVISIONING = <ResourceGroupStatus.PROVISIONING: 'PROVISIONING'>
- -
-Data descriptors inherited from enum.Enum:
-
name
-
The name of the Enum member.
-
-
value
-
The value of the Enum member.
-
-
-Static methods inherited from enum.EnumType:
-
__contains__(value)
Return True if `value` is in `cls`.
- 
-`value` is in `cls` if:
-1) `value` is a member of `cls`, or
-2) `value` is the value of one of the `cls`'s members.
-3) `value` is a pseudo-member (flags)
- -
__getitem__(name)
Return the member matching `name`.
- -
__iter__()
Return members in definition order.
- -
__len__()
Return the number of members (no aliases)
- -
-Readonly properties inherited from enum.EnumType:
-
__members__
-
Returns a mapping of member name->value.
- 
-This mapping lists all enum members, including aliases.  Note that
-this is a read-only view of the internal mapping.
-
-

- \ No newline at end of file diff --git a/packages/core/docs/ai_core_sdk.models.secret.html b/packages/core/docs/ai_core_sdk.models.secret.html deleted file mode 100644 index 8b8ba95..0000000 --- a/packages/core/docs/ai_core_sdk.models.secret.html +++ /dev/null @@ -1,72 +0,0 @@ - - - - -Python: module ai_core_sdk.models.secret - - - - - -
 
ai_core_sdk.models.secret		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/core/ai_core_sdk/models/secret.py
-

-

- - - - - -
 
Classes
       
-
builtins.object -
-
-
Secret -
-
-
-

- - - - - - - -
 
class Secret(builtins.object)
   Secret(name: str, data: Dict[str, str] = None, **kwargs)
- 
-The Secret object defines the secret response.
- 
-:param name: Secret name
-:type name: str
-:param data: Secret data dictionary, defaults to None
-:type data: dict, optional
 
 Methods defined here:
-
__init__(self, name: str, data: Dict[str, str] = None, **kwargs)
Initialize self.  See help(type(self)) for accurate signature.
- -
__str__(self)
Return str(self).
- -
-Static methods defined here:
-
from_dict(secret_dict: Dict[str, Any])
Returns a :class:`ai_core_sdk.models.secret.Secret` object, created
-from the values in the dict provided as parameter
- 
-:param secret_dict: Dict which includes the necessary values to create the object
-:type secret_dict: Dict[str, Any]
-:return: An object, created from the values provided
-:rtype: class:`ai_core_sdk.models.secret.Secret`
- -
-Data descriptors defined here:
-
__dict__
-
dictionary for instance variables
-
-
__weakref__
-
list of weak references to the object
-
-

- - - - - -
 
Data
       Dict = typing.Dict
- \ No newline at end of file diff --git a/packages/core/docs/ai_core_sdk.models.secret_query_response.html b/packages/core/docs/ai_core_sdk.models.secret_query_response.html deleted file mode 100644 index 8efe149..0000000 --- a/packages/core/docs/ai_core_sdk.models.secret_query_response.html +++ /dev/null @@ -1,91 +0,0 @@ - - - - -Python: module ai_core_sdk.models.secret_query_response - - - - - -
 
ai_core_sdk.models.secret_query_response		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/core/ai_core_sdk/models/secret_query_response.py
-

-

- - - - - -
 
Classes
       
-
ai_api_client_sdk.models.base_models.QueryResponse(builtins.object) -
-
-
SecretQueryResponse -
-
-
-

- - - - - - - -
 
class SecretQueryResponse(ai_api_client_sdk.models.base_models.QueryResponse)
   SecretQueryResponse(
-    resources: List[ai_core_sdk.models.secret.Secret],
-    count: int,
-    **kwargs
-)
- 
-The SecretQueryResponse object defines the response of the secret query request
-:param resources: List of the secrets returned from the server
-:type resources: List[class:`ai_core_sdk.models.secret.Secret`]
-:param count: Total number of the queried secrets
-:type count: int
-:param `**kwargs`: The keyword arguments are there in case there are additional attributes returned from server
 
 
Method resolution order:
-
SecretQueryResponse
-
ai_api_client_sdk.models.base_models.QueryResponse
-
builtins.object
-
-
-Methods defined here:
-
__init__( - self, - resources: List[ai_core_sdk.models.secret.Secret], - count: int, - **kwargs -)
Initialize self.  See help(type(self)) for accurate signature.
- -
-Static methods defined here:
-
from_dict(response_dict: Dict[str, Any])
Returns a
-:class:`ai_core_sdk.models.secret_query_response.SecretQueryResponse`
-object, created from the values in the dict provided as parameter
- 
-:param response_dict: Dict which includes the necessary values to create the object
-:type response_dict: Dict[str, Any]
-:return: An object, created from the values provided
-:rtype: class:`ai_core_sdk.models.secret_query_response.SecretQueryResponse`
- -
-Methods inherited from ai_api_client_sdk.models.base_models.QueryResponse:
-
__str__(self)
Return str(self).
- -
-Data descriptors inherited from ai_api_client_sdk.models.base_models.QueryResponse:
-
__dict__
-
dictionary for instance variables
-
-
__weakref__
-
list of weak references to the object
-
-

- - - - - -
 
Data
       Dict = typing.Dict
-List = typing.List
- \ No newline at end of file diff --git a/packages/core/docs/ai_core_sdk.resource_clients.applications_client.html b/packages/core/docs/ai_core_sdk.resource_clients.applications_client.html deleted file mode 100644 index c5ce356..0000000 --- a/packages/core/docs/ai_core_sdk.resource_clients.applications_client.html +++ /dev/null @@ -1,199 +0,0 @@ - - - - -Python: module ai_core_sdk.resource_clients.applications_client - - - - - -
 
ai_core_sdk.resource_clients.applications_client		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/core/ai_core_sdk/resource_clients/applications_client.py
-

-

- - - - - -
 
Classes
       
-
ai_api_client_sdk.resource_clients.base_client.BaseClient(builtins.object) -
-
-
ApplicationsClient -
-
-
-

- - - - - - - -
 
class ApplicationsClient(ai_api_client_sdk.resource_clients.base_client.BaseClient)
   ApplicationsClient(
-    rest_client: ai_api_client_sdk.helpers.rest_client.RestClient
-)
- 
-ApplicationsClient is a class implemented for interacting with the applications related
-endpoints of the server. It implements the base class
-:class:`ai_api_client_sdk.resource_clients.base_client.BaseClient`
 
 
Method resolution order:
-
ApplicationsClient
-
ai_api_client_sdk.resource_clients.base_client.BaseClient
-
builtins.object
-
-
-Methods defined here:
-
create( - self, - revision: str, - path: str, - application_name: str = None, - repository_name: str = None, - repository_url: str = None -) -> ai_api_client_sdk.models.base_models.BasicResponse
Creates an application.
- 
-:param revision: revision to synchronize
-:type revision: str
-:param path: within the repository to synchronize
-:type path: str
-:param application_name: Name of the application
-:type application_name: str, optional
-:param repository_name: Name of the repository to synchronize. Either this or the repository_url needs to be
-    provided
-:type repository_name: str, optional
-:param repository_url: URL of the repository to synchronize. Either this or the repository_name needs to be
-    provided
-:type repository_url: str, optional
-: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
-:return: An object representing the response from the server
-:rtype: class:`ai_api_client_sdk.models.base_models.BasicResponse`
- -
delete(self, application_name: str) -> ai_api_client_sdk.models.base_models.BasicResponse
Deletes the application.
- 
-:param application_name: name of the application to be deleted
-:type application_name: str
-: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
-:return: An object representing the response from the server
-:rtype: class:`ai_api_client_sdk.models.base_models.BasicResponse`
- -
get(self, application_name: str) -> ai_core_sdk.models.application.Application
Retrieves the application from the server.
- 
-:param application_name: name of the application to be retrieved
-:type application_name: str
-: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: The retrieved application
-:rtype: class:`ai_core_sdk.models.application.Application`
- -
get_status(self, application_name: str) -> ai_core_sdk.models.application_status.ApplicationStatus
Retrieves the application status from the server.
- 
-:param application_name: name of the application
-:type application_name: str
-: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: The retrieved application status
-:rtype: class:`ai_core_sdk.models.application_status.ApplicationStatus`
- -
modify( - self, - application_name: str, - repository_url: str, - path: str, - revision: str -) -> ai_api_client_sdk.models.base_models.BasicResponse
Modifies the application
- 
-:param application_name: name of the application to be modified
-:type name: str
-:param repository_url:
-:type repository_url: str
-:param revision:
-:type revision: str
-:param path:
-:type path: str
-: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
-:return: An object representing the response from the server
-:rtype: class:`ai_api_client_sdk.models.base_models.BasicResponse`
- -
query(self) -> ai_core_sdk.models.application_query_response.ApplicationQueryResponse
Returns the applications.
- 
-: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
-:return: The retrieved applications
-:rtype: class:`ai_core_sdk.models.application_query_response.ApplicationQueryResponse`
- -
refresh(self, application_name: str) -> ai_api_client_sdk.models.base_models.BasicResponse
Triggers synchronisation of the application.
- 
-:param application_name: name of the application to be refreshed
-:type application_name: str
-: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
-:return: An object representing the response from the server
-:rtype: class:`ai_api_client_sdk.models.base_models.BasicResponse`
- -
-Methods inherited from ai_api_client_sdk.resource_clients.base_client.BaseClient:
-
__init__(self, rest_client: ai_api_client_sdk.helpers.rest_client.RestClient)
Initialize self.  See help(type(self)) for accurate signature.
- -
bulk_modify(self, *args, **kwargs)
Modifies multiple instances of the relevant resource. Will be implemented by the respective resource clients
- -
count(self, *args, **kwargs)
Counts the relevant resources. Will be implemented by the respective resource clients
- -
query_logs(self, *args, **kwargs)
Queries the relevant logs. Will be implemented by the respective resource clients
- -
-Data descriptors inherited from ai_api_client_sdk.resource_clients.base_client.BaseClient:
-
__dict__
-
dictionary for instance variables
-
-
__weakref__
-
list of weak references to the object
-
-

- \ No newline at end of file diff --git a/packages/core/docs/ai_core_sdk.resource_clients.docker_registry_secrets_client.html b/packages/core/docs/ai_core_sdk.resource_clients.docker_registry_secrets_client.html deleted file mode 100644 index cb72541..0000000 --- a/packages/core/docs/ai_core_sdk.resource_clients.docker_registry_secrets_client.html +++ /dev/null @@ -1,147 +0,0 @@ - - - - -Python: module ai_core_sdk.resource_clients.docker_registry_secrets_client - - - - - -
 
ai_core_sdk.resource_clients.docker_registry_secrets_client		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/core/ai_core_sdk/resource_clients/docker_registry_secrets_client.py
-

-

- - - - - -
 
Classes
       
-
ai_api_client_sdk.resource_clients.base_client.BaseClient(builtins.object) -
-
-
DockerRegistrySecretsClient -
-
-
-

- - - - - - - -
 
class DockerRegistrySecretsClient(ai_api_client_sdk.resource_clients.base_client.BaseClient)
   DockerRegistrySecretsClient(
-    rest_client: ai_api_client_sdk.helpers.rest_client.RestClient
-)
- 
-DockerRegistrySecretsClient is a class implemented for interacting with the docker registry secret related
-endpoints of the server. It implements the base class
-:class:`ai_api_client_sdk.resource_clients.base_client.BaseClient`
 
 
Method resolution order:
-
DockerRegistrySecretsClient
-
ai_api_client_sdk.resource_clients.base_client.BaseClient
-
builtins.object
-
-
-Methods defined here:
-
create(self, name: str, data: dict) -> ai_core_sdk.models.base_models.Message
Creates a docker secret based on the configuration in the request body.
- 
-:param name: name of the docker registry secret
-:type name: str
-:param data: json dict, defining the docker registry secret
-:type data: dict
-: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
-:return: An object representing the response from the server
-:rtype: class:`ai_core_sdk.models.base_models.Message`
- -
delete(self, name: str) -> ai_api_client_sdk.models.base_models.BasicResponse
Deletes the docker registry secret with the given name if it exists.
- 
-:param name: name of the docker registry secret to be deleted
-:type name: str
-: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
-:return: An object representing the response from the server
-:rtype: class:`ai_api_client_sdk.models.base_models.BasicResponse`
- -
get(self, name: str) -> ai_core_sdk.models.docker_registry_secret.DockerRegistrySecret
Returns the metadata of the docker registry secrets which matches the given name.
- 
-:param name: name of the docker registry secret to be retrieved
-:type name: str
-: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: The retrieved metadata of the docker registry secret
-:rtype: class:`ai_core_sdk.models.docker_registry_secret.DockerRegistrySecret`
- -
modify(self, name: str, data: dict) -> ai_api_client_sdk.models.base_models.BasicResponse
Updates the docker registry secret
- 
-:param name: name of the docker registry secret to be modified
-:type name: str
-:param data: json dict, defining the docker registry secret
-:type data: dict
-: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
-:return: An object representing the response from the server
-:rtype: class:`ai_api_client_sdk.models.base_models.BasicResponse`
- -
query(self, top: int = None, skip: int = None) -> ai_core_sdk.models.docker_registry_secret_query_response.DockerRegistrySecretQueryResponse
Gets a list of metadata of docker registry secrets.
- 
-:param top: Number of docker registry secrets to be retrieved, defaults to None
-:type top: int, optional
-:param skip: Number of docker registry secrets to be skipped, from the list of the queried docker registry
-    secrets, defaults to None
-:type skip: int, optional
-: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
-:return: A list of metadata of secrets
-:rtype: class:`ai_core_sdk.models.docker_registry_secret_query_response.DockerRegistrySecretQueryResponse`
- -
-Methods inherited from ai_api_client_sdk.resource_clients.base_client.BaseClient:
-
__init__(self, rest_client: ai_api_client_sdk.helpers.rest_client.RestClient)
Initialize self.  See help(type(self)) for accurate signature.
- -
bulk_modify(self, *args, **kwargs)
Modifies multiple instances of the relevant resource. Will be implemented by the respective resource clients
- -
count(self, *args, **kwargs)
Counts the relevant resources. Will be implemented by the respective resource clients
- -
query_logs(self, *args, **kwargs)
Queries the relevant logs. Will be implemented by the respective resource clients
- -
-Data descriptors inherited from ai_api_client_sdk.resource_clients.base_client.BaseClient:
-
__dict__
-
dictionary for instance variables
-
-
__weakref__
-
list of weak references to the object
-
-

- \ No newline at end of file diff --git a/packages/core/docs/ai_core_sdk.resource_clients.html b/packages/core/docs/ai_core_sdk.resource_clients.html deleted file mode 100644 index 58d294e..0000000 --- a/packages/core/docs/ai_core_sdk.resource_clients.html +++ /dev/null @@ -1,28 +0,0 @@ - - - - -Python: package ai_core_sdk.resource_clients - - - - - -
 
ai_core_sdk.resource_clients		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/core/ai_core_sdk/resource_clients/__init__.py
-

-

- - - - - -
 
Package Contents
       
applications_client
-docker_registry_secrets_client
-		internal_rest_client
-kpi_client
-		metrics_client
-object_store_secrets_client
-		repositories_client
-secrets_client
-
- \ No newline at end of file diff --git a/packages/core/docs/ai_core_sdk.resource_clients.internal_rest_client.html b/packages/core/docs/ai_core_sdk.resource_clients.internal_rest_client.html deleted file mode 100644 index a318136..0000000 --- a/packages/core/docs/ai_core_sdk.resource_clients.internal_rest_client.html +++ /dev/null @@ -1,220 +0,0 @@ - - - - -Python: module ai_core_sdk.resource_clients.internal_rest_client - - - - - -
 
ai_core_sdk.resource_clients.internal_rest_client		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/core/ai_core_sdk/resource_clients/internal_rest_client.py
-

-

- - - - - -
 
Modules
       
os
-

- - - - - -
 
Classes
       
-
ai_api_client_sdk.helpers.rest_client.RestClient(builtins.object) -
-
-
InternalRestClient -
-
-
-

- - - - - - - -
 
class InternalRestClient(ai_api_client_sdk.helpers.rest_client.RestClient)
   InternalRestClient(
-    base_url=None,
-    get_token=None,
-    resource_group=None,
-    *args,
-    **kwargs
-)
- 
-InternalRestClient is a class implemented for sending requests to services within aicore. The InternalRestClient should only be used for services that do not require authentication when called within aicore.
 
 
Method resolution order:
-
InternalRestClient
-
ai_api_client_sdk.helpers.rest_client.RestClient
-
builtins.object
-
-
-Methods defined here:
-
__init__( - self, - base_url=None, - get_token=None, - resource_group=None, - *args, - **kwargs -)
Initialize self.  See help(type(self)) for accurate signature.
- -
-Methods inherited from ai_api_client_sdk.helpers.rest_client.RestClient:
-
delete( - self, - path: str, - params: Dict[str, str] = None, - headers: Dict[str, str] = None, - resource_group: str = None, - **kwargs -) -> dict
Sends a DELETE request to the server.
- 
-:param path: path of the endpoint the request should be sent to
-:type path: str
-:param params: parameters of the request, defaults to None
-:type params: Dict[str, str], optional
-:param headers: headers of the request, defaults to None
-:type headers: Dict[str, str], optional
-:param resource_group: Resource Group which the request should be sent on behalf. Either this, or the
-    resource_group property of this class should be set.
-:type resource_group: str
-:param kwargs: additional keyword arguments to be passed to the request e.g. files, stream, etc.
-:type kwargs: dict
-: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
-:return: The JSON response from the server (The keys decamelized)
-:rtype: dict
- -
get( - self, - path: str, - params: Dict[str, str] = None, - headers: Dict[str, str] = None, - resource_group: str = None, - return_bytes_content: bool = False, - **kwargs -) -> Union[dict, int]
Sends a GET request to the server.
- 
-:param path: path of the endpoint the request should be sent to
-:type path: str
-:param params: parameters of the request, defaults to None
-:type params: Dict[str, str], optional
-:param headers: headers of the request, defaults to None
-:type headers: Dict[str, str], optional
-:param resource_group: Resource Group which the request should be sent on behalf. Either this, or the
-    resource_group property of this class should be set.
-:type resource_group: str
-:param return_bytes_content: expected response.content is bytes
-:type return_bytes_content: bool
-:param kwargs: additional keyword arguments to be passed to the request e.g. files, stream, etc.
-:type kwargs: dict
-: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
-:return: The JSON response from the server (The keys decamelized)
-:rtype: Union[dict, int]
- -
patch( - self, - path: str, - body: Dict[str, Union[str, dict, list]], - headers: Dict[str, str] = None, - resource_group: str = None, - **kwargs -) -> dict
Sends a PATCH request to the server.
- 
-:param path: path of the endpoint the request should be sent to
-:type path: str
-:param body: body of the request
-:type body: Dict[str, Union[str, dict, list]]
-:param headers: headers of the request, defaults to None
-:type headers: Dict[str, str], optional
-:param resource_group: Resource Group which the request should be sent on behalf. Either this, or the
-    resource_group property of this class should be set.
-:type resource_group: str
-:param kwargs: additional keyword arguments to be passed to the request e.g. files, stream, etc.
-:type kwargs: dict
-: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
-:return: The JSON response from the server (The keys decamelized)
-:rtype: dict
- -
post( - self, - path: str, - body: Dict[str, Union[str, dict]] = None, - headers: Dict[str, str] = None, - resource_group: str = None, - **kwargs -) -> dict
Sends a POST request to the server.
- 
-:param path: path of the endpoint the request should be sent to
-:type path: str
-:param body: body of the request, defaults to None
-:type body: Dict[str, str], optional
-:param headers: headers of the request, defaults to None
-:type headers: Dict[str, str], optional
-:param resource_group: Resource Group which the request should be sent on behalf. Either this, or the
-    resource_group property of this class should be set.
-:type resource_group: str
-:param kwargs: additional keyword arguments to be passed to the request e.g. files, stream, etc.
-:type kwargs: dict
-: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
-:return: The JSON response from the server (The keys decamelized)
-:rtype: dict
- -
-Static methods inherited from ai_api_client_sdk.helpers.rest_client.RestClient:
-
raise_ai_api_exception(error_description, response, response_json)
- -
-Data descriptors inherited from ai_api_client_sdk.helpers.rest_client.RestClient:
-
__dict__
-
dictionary for instance variables
-
-
__weakref__
-
list of weak references to the object
-
-
-Data and other attributes inherited from ai_api_client_sdk.helpers.rest_client.RestClient:
-
logger = <Logger ai-api-client-sdk (WARNING)>
- -

- \ No newline at end of file diff --git a/packages/core/docs/ai_core_sdk.resource_clients.kpi_client.html b/packages/core/docs/ai_core_sdk.resource_clients.kpi_client.html deleted file mode 100644 index c1c380c..0000000 --- a/packages/core/docs/ai_core_sdk.resource_clients.kpi_client.html +++ /dev/null @@ -1,85 +0,0 @@ - - - - -Python: module ai_core_sdk.resource_clients.kpi_client - - - - - -
 
ai_core_sdk.resource_clients.kpi_client		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/core/ai_core_sdk/resource_clients/kpi_client.py
-

-

- - - - - -
 
Classes
       
-
ai_api_client_sdk.resource_clients.base_client.BaseClient(builtins.object) -
-
-
KpiClient -
-
-
-

- - - - - - - -
 
class KpiClient(ai_api_client_sdk.resource_clients.base_client.BaseClient)
   KpiClient(rest_client: ai_api_client_sdk.helpers.rest_client.RestClient)
- 
-KpiClient is a class implemented for interacting with the analytics kpi
-endpoint of the server. It implements the base class
-:class:`ai_api_client_sdk.resource_clients.base_client.BaseClient`
 
 
Method resolution order:
-
KpiClient
-
ai_api_client_sdk.resource_clients.base_client.BaseClient
-
builtins.object
-
-
-Methods defined here:
-
query(self) -> ai_core_sdk.models.kpi.Kpi
Retrieves the number of executions, artifacts, and deployments
-for each resource group, scenario, and executable.
- 
-: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: The retrieved KPI data
-:rtype: class:`ai_core_sdk.models.kpi.Kpi`
- -
-Methods inherited from ai_api_client_sdk.resource_clients.base_client.BaseClient:
-
__init__(self, rest_client: ai_api_client_sdk.helpers.rest_client.RestClient)
Initialize self.  See help(type(self)) for accurate signature.
- -
bulk_modify(self, *args, **kwargs)
Modifies multiple instances of the relevant resource. Will be implemented by the respective resource clients
- -
count(self, *args, **kwargs)
Counts the relevant resources. Will be implemented by the respective resource clients
- -
create(self, *args, **kwargs)
Creates the relevant resource. Will be implemented by the respective resource clients
- -
delete(self, *args, **kwargs)
Deletes the relevant resource. Will be implemented by the respective resource clients
- -
get(self, *args, **kwargs)
Retrieves the relevant resource. Will be implemented by the respective resource clients
- -
modify(self, *args, **kwargs)
Modifies the relevant resource. Will be implemented by the respective resource clients
- -
query_logs(self, *args, **kwargs)
Queries the relevant logs. Will be implemented by the respective resource clients
- -
-Data descriptors inherited from ai_api_client_sdk.resource_clients.base_client.BaseClient:
-
__dict__
-
dictionary for instance variables
-
-
__weakref__
-
list of weak references to the object
-
-

- \ No newline at end of file diff --git a/packages/core/docs/ai_core_sdk.resource_clients.metrics_client.html b/packages/core/docs/ai_core_sdk.resource_clients.metrics_client.html deleted file mode 100644 index 68deb4b..0000000 --- a/packages/core/docs/ai_core_sdk.resource_clients.metrics_client.html +++ /dev/null @@ -1,215 +0,0 @@ - - - - -Python: module ai_core_sdk.resource_clients.metrics_client - - - - - -
 
ai_core_sdk.resource_clients.metrics_client		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/core/ai_core_sdk/resource_clients/metrics_client.py
-

-

- - - - - -
 
Classes
       
-
ai_api_client_sdk.resource_clients.metrics_client.MetricsClient(ai_api_client_sdk.resource_clients.base_client.BaseClient) -
-
-
MetricsCoreClient -
-
-
-

- - - - - - - -
 
class MetricsCoreClient(ai_api_client_sdk.resource_clients.metrics_client.MetricsClient)
   MetricsCoreClient(rest_client, execution_id: str = None) -&gt; None
- 
-MetricsCoreClient is a class implemented for interacting with the metrics related
-endpoints of the server. It is inherited from the base class
-:class:`ai_api_client_sdk.resource_clients.metrics_client.MetricsClient`
 
 
Method resolution order:
-
MetricsCoreClient
-
ai_api_client_sdk.resource_clients.metrics_client.MetricsClient
-
ai_api_client_sdk.resource_clients.base_client.BaseClient
-
builtins.object
-
-
-Methods defined here:
-
__init__(self, rest_client, execution_id: str = None) -> None
Initialize self.  See help(type(self)) for accurate signature.
- -
log_metrics( - self, - metrics: List[ai_api_client_sdk.models.metric.Metric], - execution_id: str = '', - artifact_name: str = None, - resource_group: str = None -) -> None
Creates or updates the metrics for an execution.
- 
-    :param metrics: List of the metrics related to the execution,
-    :type metrics: List[class:`ai_api_client_sdk.metric.Metric`]
-    :param execution_id: ID of the execution, of which the metrics should be modified.
-    :type execution_id: str
-    :param artifact_name: Name of the artifact to associate with a metric, defaults to None
-    :type artifact_name: str
-    :param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
-        resource group in the :class:`ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client` should be specified,
-        defaults to None
-    :type resource_group: str
-    :raises: class:`ai_api_client_sdk.exception.AIAPIInvalidRequestException` if a 400 response is received from the
-server
-    :raises: class:`ai_api_client_sdk.exception.AIAPIServerException` if a non-2XX response is received from the
-        server
- -
modify( - self, - execution_id: str = '', - metrics: List[ai_api_client_sdk.models.metric.Metric] = None, - tags: List[ai_api_client_sdk.models.metric_tag.MetricTag] = None, - custom_info: List[ai_api_client_sdk.models.metric_custom_info.MetricCustomInfo] = None, - resource_group: str = None -) -> None
Creates or updates the metrics for an execution.
- 
-    :param execution_id: ID of the execution, of which the metrics should be modified.
-    :type execution_id: str
-    :param metrics: List of the metrics related to the execution, defaults to None
-    :type metrics: List[class:`ai_api_client_sdk.metric.Metric`], optional
-    :param tags: List of the tags related to the execution, defaults to None
-    :type tags: List[class:'ai_api_client_sdk.models.metric_tag.MetricTag'], optional
-    :param custom_info: List of custom info related to the execution, defaults to None
-    :type custom_info: List[class:`ai_api_client_sdk.models.metric_custom_info.MetricCustomInfo`], optional
-    :param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
-        resource group in the :class:`ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client` should be specified,
-        defaults to None
-    :type resource_group: str
-    :raises: class:`ai_api_client_sdk.exception.AIAPIInvalidRequestException` if a 400 response is received from the
-server
-    :raises: class:`ai_api_client_sdk.exception.AIAPIServerException` if a non-2XX response is received from the
-        server
- -
set_custom_info( - self, - custom_info: List[ai_api_client_sdk.models.metric_custom_info.MetricCustomInfo], - execution_id: str = '', - resource_group: str = None -) -> None
log custom info against the given execution
-    captures consumption semantics for the metrics or complex metric in JSON format.
- 
- 
-    :param custom_info: List of custom info related to the execution
-    :type custom_info: List[class:`ai_api_client_sdk.models.metric_custom_info.MetricCustomInfo`], optional
-    :param execution_id: ID of the execution, of which the metrics should be modified.
-    :type execution_id: str
-    :param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
-        resource group in the :class:`ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client` should be specified,
-        defaults to None
-    :type resource_group: str
-    :raises: class:`ai_api_client_sdk.exception.AIAPIInvalidRequestException` if a 400 response is received from the
-server
-    :raises: class:`ai_api_client_sdk.exception.AIAPIServerException` if a non-2XX response is received from the
-        server
- -
set_tags( - self, - tags: List[ai_api_client_sdk.models.metric_tag.MetricTag], - execution_id: str = '', - resource_group: str = None -) -> None
log tags against the given execution
- 
-    :param tags: List of the tags related to the execution, defaults to None
-    :type tags: List[class:'ai_api_client_sdk.models.metric_tag.MetricTag']
-    :param execution_id: ID of the execution, of which the metrics should be modified.
-    :type execution_id: str
-    :param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
-        resource group in the :class:`ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client` should be specified,
-        defaults to None
-    :type resource_group: str
-    :raises: class:`ai_api_client_sdk.exception.AIAPIInvalidRequestException` if a 400 response is received from the
-server
-    :raises: class:`ai_api_client_sdk.exception.AIAPIServerException` if a non-2XX response is received from the
-        server
- -
-Methods inherited from ai_api_client_sdk.resource_clients.metrics_client.MetricsClient:
-
delete(self, execution_id: str, resource_group: str = None) -> None
Deletes the metrics.
- 
-:param execution_id: ID of the execution, of which the metrics should be deleted.
-:type execution_id: str
-:param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
-    resource group in the :class:`ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client` should be specified,
-    defaults to None
-:type resource_group: str
-: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
- -
query( - self, - filter: str = None, - execution_ids: List[str] = None, - select: List[str] = None, - resource_group: str = None -) -> ai_api_client_sdk.models.metrics_query_response.MetricsQueryResponse
Queries the metrics.
- 
-:param filter: 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
-:type filter: str, optional
-:param execution_ids: IDs of the executions, of which the metrics should be retrieved, defaults to None
-:type execution_ids: List[str], optional
-:param select: 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
-:type select: List[str], optional
-:param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
-    resource group in the :class:`ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client` should be specified,
-    defaults to None
-:type resource_group: str
-: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
-:return: An object representing the response from the server
-:rtype: class:`ai_api_client_sdk.models.metrics_query_response.MetricsQueryResponse`
- -
-Methods inherited from ai_api_client_sdk.resource_clients.base_client.BaseClient:
-
bulk_modify(self, *args, **kwargs)
Modifies multiple instances of the relevant resource. Will be implemented by the respective resource clients
- -
count(self, *args, **kwargs)
Counts the relevant resources. Will be implemented by the respective resource clients
- -
create(self, *args, **kwargs)
Creates the relevant resource. Will be implemented by the respective resource clients
- -
get(self, *args, **kwargs)
Retrieves the relevant resource. Will be implemented by the respective resource clients
- -
query_logs(self, *args, **kwargs)
Queries the relevant logs. Will be implemented by the respective resource clients
- -
-Data descriptors inherited from ai_api_client_sdk.resource_clients.base_client.BaseClient:
-
__dict__
-
dictionary for instance variables
-
-
__weakref__
-
list of weak references to the object
-
-

- - - - - -
 
Data
       List = typing.List
- \ No newline at end of file diff --git a/packages/core/docs/ai_core_sdk.resource_clients.object_store_secrets_client.html b/packages/core/docs/ai_core_sdk.resource_clients.object_store_secrets_client.html deleted file mode 100644 index 659124f..0000000 --- a/packages/core/docs/ai_core_sdk.resource_clients.object_store_secrets_client.html +++ /dev/null @@ -1,229 +0,0 @@ - - - - -Python: module ai_core_sdk.resource_clients.object_store_secrets_client - - - - - -
 
ai_core_sdk.resource_clients.object_store_secrets_client		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/core/ai_core_sdk/resource_clients/object_store_secrets_client.py
-

-

- - - - - -
 
Classes
       
-
ai_api_client_sdk.resource_clients.base_client.BaseClient(builtins.object) -
-
-
ObjectStoreSecretsClient -
-
-
-

- - - - - - - -
 
class ObjectStoreSecretsClient(ai_api_client_sdk.resource_clients.base_client.BaseClient)
   ObjectStoreSecretsClient(
-    rest_client: ai_api_client_sdk.helpers.rest_client.RestClient
-)
- 
-ObjectStoreSecretsClient is a class implemented for interacting with the object store secret related
-endpoints of the server. It implements the base class
-:class:`ai_api_client_sdk.resource_clients.base_client.BaseClient`
 
 
Method resolution order:
-
ObjectStoreSecretsClient
-
ai_api_client_sdk.resource_clients.base_client.BaseClient
-
builtins.object
-
-
-Methods defined here:
-
create( - self, - name: str, - type: str, - data: dict, - bucket: str = None, - endpoint: str = None, - region: str = None, - path_prefix: str = None, - verifyssl: str = None, - usehttps: str = None, - resource_group: str = None -) -> ai_core_sdk.models.base_models.Message
Creates an object store secret.
- 
-:param name: name of the object store secret
-:type name: str
-:param type: type of object storage
-:type type: str
-:param data: data to be posted
-:type data: str
-:param bucket: name of the bucket
-:type bucket: str
-:param endpoint: endpoint of object storage
-:type endpoint: str
-:param region: region of object storage
-:type region: str
-:param path_prefix: path prefix
-:type path_prefix: str
-:param verifyssl: verify ssl
-:type verifyssl: str
-:param usehttps: use https
-:type usehttps: str
-:param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
-    resource group in the :class:`ai_core_sdk.ai_core_v2_client.AICoreV2Client` should be specified,
-    defaults to None
-:type resource_group: str
-: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.AIAPIForbiddenException` if a 403 response is received from the
-    server
-:raises: class:`ai_api_client_sdk.exception.AIAPIConflictException` if a 409 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: A list of metadata of available secrets
-:rtype: class:`ai_core_sdk.models.base_models.BasicNameResponse`
- -
delete(self, name: str, resource_group: str = None) -> ai_api_client_sdk.models.base_models.BasicResponse
Deletes the object store secret.
- 
-:param name: name of the object store secret to be deleted
-:type name: str
-:param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
-    resource group in the :class:`ai_core_sdk.ai_core_v2_client.AICoreV2Client` should be specified,
-    defaults to None
-:type resource_group: str
-: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.AIAPIForbiddenException` if a 403 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: An object representing the response from the server
-:rtype: class:`ai_api_client_sdk.models.base_models.BasicResponse`
- -
get(self, name: str, resource_group: str = None) -> ai_core_sdk.models.object_store_secret.ObjectStoreSecret
Retrieves the object store secret from the server.
- 
-:param name: name of the object store secret to be retrieved
-:type name: str
-:param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
-    resource group in the :class:`ai_core_sdk.ai_core_v2_client.AICoreV2Client` should be specified,
-    defaults to None
-:type resource_group: str
-: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.AIAPIForbiddenException` if a 403 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: The retrieved object store secret
-:rtype: class:`ai_core_sdk.models.object_store_secret.ObjectStoreSecret`
- -
modify( - self, - name: str, - type: str, - data: dict, - bucket: str = None, - endpoint: str = None, - region: str = None, - path_prefix: str = None, - verifyssl: str = None, - usehttps: str = None, - resource_group: str = None -) -> ai_api_client_sdk.models.base_models.BasicResponse
Modifies the object store secret
- 
-:param name: name of the object store secret to be modified
-:type name: str
-:param type: type of object storage
-:type type: str
-:param data: data to be posted
-:type data: str
-:param bucket: name of the bucket
-:type bucket: str
-:param endpoint: endpoint of object storage
-:type endpoint: str
-:param region: region of object storage
-:type region: str
-:param path_prefix: path prefix
-:type path_prefix: str
-:param verifyssl: verify ssl
-:type verifyssl: str
-:param usehttps: use https
-:type usehttps: str
-:param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
-    resource group in the :class:`ai_core_sdk.ai_core_v2_client.AICoreV2Client` should be specified,
-    defaults to None
-:type resource_group: str
-: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.AIAPIForbiddenException` if a 403 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
-:return: An object representing the response from the server
-:rtype: class:`ai_api_client_sdk.models.base_models.BasicResponse`
- -
query(self, top: int = None, skip: int = None, resource_group: str = None) -> ai_core_sdk.models.object_store_secret_query_response.ObjectStoreSecretQueryResponse
Returns the object store secrets.
- 
-:param top: Number of object store secrets to be retrieved, defaults to None
-:type top: int, optional
-:param skip: Number of object store secrets to be skipped, from the list of the queried object store
-    secrets, defaults to None
-:type skip: int, optional
-:param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
-    resource group in the :class:`ai_core_sdk.ai_core_v2_client.AICoreV2Client` should be specified,
-    defaults to None
-:type resource_group: str
-: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.AIAPIForbiddenException` if a 403 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: A list of object store secrets
-:rtype: class:`ai_core_sdk.models.object_store_secret_query_response.ObjectStoreSecretQueryResponse`
- -
-Methods inherited from ai_api_client_sdk.resource_clients.base_client.BaseClient:
-
__init__(self, rest_client: ai_api_client_sdk.helpers.rest_client.RestClient)
Initialize self.  See help(type(self)) for accurate signature.
- -
bulk_modify(self, *args, **kwargs)
Modifies multiple instances of the relevant resource. Will be implemented by the respective resource clients
- -
count(self, *args, **kwargs)
Counts the relevant resources. Will be implemented by the respective resource clients
- -
query_logs(self, *args, **kwargs)
Queries the relevant logs. Will be implemented by the respective resource clients
- -
-Data descriptors inherited from ai_api_client_sdk.resource_clients.base_client.BaseClient:
-
__dict__
-
dictionary for instance variables
-
-
__weakref__
-
list of weak references to the object
-
-

- \ No newline at end of file diff --git a/packages/core/docs/ai_core_sdk.resource_clients.repositories_client.html b/packages/core/docs/ai_core_sdk.resource_clients.repositories_client.html deleted file mode 100644 index 1798ac8..0000000 --- a/packages/core/docs/ai_core_sdk.resource_clients.repositories_client.html +++ /dev/null @@ -1,148 +0,0 @@ - - - - -Python: module ai_core_sdk.resource_clients.repositories_client - - - - - -
 
ai_core_sdk.resource_clients.repositories_client		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/core/ai_core_sdk/resource_clients/repositories_client.py
-

-

- - - - - -
 
Classes
       
-
ai_api_client_sdk.resource_clients.base_client.BaseClient(builtins.object) -
-
-
RepositoriesClient -
-
-
-

- - - - - - - -
 
class RepositoriesClient(ai_api_client_sdk.resource_clients.base_client.BaseClient)
   RepositoriesClient(
-    rest_client: ai_api_client_sdk.helpers.rest_client.RestClient
-)
- 
-RepositoriesClient is a class implemented for interacting with the repositories related
-endpoints of the server. It implements the base class
-:class:`ai_api_client_sdk.resource_clients.base_client.BaseClient`
 
 
Method resolution order:
-
RepositoriesClient
-
ai_api_client_sdk.resource_clients.base_client.BaseClient
-
builtins.object
-
-
-Methods defined here:
-
create(self, name: str, url: str, username: str, password: str) -> ai_core_sdk.models.base_models.Message
On-boards a new GitOps repository
- 
-:param name: name of the GitOps repository
-:type name: str
-:param url: url of the GitOps repository
-:type url: str
-:param username: username to the GitOps repository
-:type username: str
-:param password: password to the GitOps repository
-:type password: str
-: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
-:return: An object representing the response from the server
-:rtype: class:`ai_core_sdk.models.base_models.BasicNameResponse`
- -
delete(self, name: str) -> ai_api_client_sdk.models.base_models.BasicResponse
Off-boards a GitOps repository.
- 
-:param name: name of the repository to be deleted
-:type name: str
-: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
-:return: An object representing the response from the server
-:rtype: class:`ai_api_client_sdk.models.base_models.BasicResponse`
- -
get(self, name: str) -> ai_core_sdk.models.repository.Repository
Retrieves the access details for a repository if it exists.
- 
-:param name: name of the repository to be retrieved
-:type name: str
-: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: The access details for a repository
-:rtype: class:`ai_core_client_sdk.models.docker_registry_secret.DockerRegistrySecret`
- -
modify(self, name: str, username: str, password: str) -> ai_api_client_sdk.models.base_models.BasicResponse
Updates the referenced repository credentials to synchronize repository.
- 
-:param name: name of the repository to be modified
-:type name: str
-:param username: username to the repository
-:type username: str
-:param password: password to the repository
-:type password: str
-: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
-:return: An object representing the response from the server
-:rtype: class:`ai_api_client_sdk.models.base_models.BasicResponse`
- -
query(self) -> ai_core_sdk.models.repository_query_response.RepositoryQueryResponse
Retrieves a list of all GitOps repositories for a tenant.
- 
-: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
-:return: A list all GitOps repositories for a tenant
-:rtype: class:`ai_core_client_sdk.models.repository_query_response.RepositoryQueryResponse`
- -
-Methods inherited from ai_api_client_sdk.resource_clients.base_client.BaseClient:
-
__init__(self, rest_client: ai_api_client_sdk.helpers.rest_client.RestClient)
Initialize self.  See help(type(self)) for accurate signature.
- -
bulk_modify(self, *args, **kwargs)
Modifies multiple instances of the relevant resource. Will be implemented by the respective resource clients
- -
count(self, *args, **kwargs)
Counts the relevant resources. Will be implemented by the respective resource clients
- -
query_logs(self, *args, **kwargs)
Queries the relevant logs. Will be implemented by the respective resource clients
- -
-Data descriptors inherited from ai_api_client_sdk.resource_clients.base_client.BaseClient:
-
__dict__
-
dictionary for instance variables
-
-
__weakref__
-
list of weak references to the object
-
-

- \ No newline at end of file diff --git a/packages/core/docs/ai_core_sdk.resource_clients.secrets_client.html b/packages/core/docs/ai_core_sdk.resource_clients.secrets_client.html deleted file mode 100644 index 5a8415c..0000000 --- a/packages/core/docs/ai_core_sdk.resource_clients.secrets_client.html +++ /dev/null @@ -1,181 +0,0 @@ - - - - -Python: module ai_core_sdk.resource_clients.secrets_client - - - - - -
 
ai_core_sdk.resource_clients.secrets_client		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/core/ai_core_sdk/resource_clients/secrets_client.py
-

-

- - - - - -
 
Classes
       
-
ai_api_client_sdk.resource_clients.base_client.BaseClient(builtins.object) -
-
-
SecretsClient -
-
-
-

- - - - - - - -
 
class SecretsClient(ai_api_client_sdk.resource_clients.base_client.BaseClient)
   SecretsClient(rest_client: ai_api_client_sdk.helpers.rest_client.RestClient)
- 
-SecretsClient is a class implemented for interacting with the secret related
-endpoints of the server. It implements the base class
-:class:`ai_api_client_sdk.resource_clients.base_client.BaseClient`
 
 
Method resolution order:
-
SecretsClient
-
ai_api_client_sdk.resource_clients.base_client.BaseClient
-
builtins.object
-
-
-Methods defined here:
-
create( - self, - name: str, - data: dict, - resource_group: str = None, - ai_tenant_scope=True -) -> ai_core_sdk.models.base_models.Message
Creates a secret.
- 
-:param name: name of the secret
-:type name: str
-:param data: data of secret
-:type data: dict
-:param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
-    resource group in the :class:`ai_core_sdk.ai_core_v2_client.AICoreV2Client` should be specified,
-    defaults to None
-:type resource_group: str
-:param ai_tenant_scope: Specify whether the main tenant scope is to be used
-:type ai_tenant_scope: bool
-: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.AIAPIForbiddenException` if a 403 response is received from the
-    server
-:raises: class:`ai_api_client_sdk.exception.AIAPIConflictException` if a 409 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: A list of metadata of available secrets
-:rtype: class:`ai_core_sdk.models.base_models.Message`
- -
delete(self, name: str, resource_group: str = None, ai_tenant_scope=True) -> ai_core_sdk.models.base_models.Message
Deletes the secret.
- 
-:param name: name of the secret to be deleted
-:type name: str
-:param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
-    resource group in the :class:`ai_core_sdk.ai_core_v2_client.AICoreV2Client` should be specified,
-    defaults to None
-:type resource_group: str
-:param ai_tenant_scope: Specify whether the main tenant scope is to be used
-:type ai_tenant_scope: bool
-: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.AIAPIForbiddenException` if a 403 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: An object representing the response from the server
-:rtype: class:`ai_api_client_sdk.models.base_models.Message`
- -
modify( - self, - name: str, - data: dict, - resource_group: str = None, - ai_tenant_scope=True -) -> ai_core_sdk.models.base_models.Message
Modifies the secret.
- 
-:param name: name of the secret to be modified
-:type name: str
-:param data: data of secret
-:type data: dict
-:param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
-    resource group in the :class:`ai_core_sdk.ai_core_v2_client.AICoreV2Client` should be specified,
-    defaults to None
-:type resource_group: str
-:param ai_tenant_scope: Specify whether the main tenant scope is to be used
-:type ai_tenant_scope: bool
-: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.AIAPIForbiddenException` if a 403 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
-:return: An object representing the response from the server
-:rtype: class:`ai_api_client_sdk.models.base_models.Message`
- -
query( - self, - top: int = None, - skip: int = None, - resource_group: str = None, - ai_tenant_scope: bool = True -) -> ai_core_sdk.models.secret_query_response.SecretQueryResponse
Returns the secrets.
- 
-:param top: Number of secrets to be retrieved, defaults to None
-:type top: int, optional
-:param skip: Number of secrets to be skipped, from the list of the queried secrets, defaults to None
-:type skip: int, optional
-:param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
-    resource group in the :class:`ai_core_sdk.ai_core_v2_client.AICoreV2Client` should be specified,
-    defaults to None
-:type resource_group: str
-:param ai_tenant_scope: Specify whether the main tenant scope is to be used
-:type ai_tenant_scope: bool
-: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.AIAPIForbiddenException` if a 403 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: A list of secrets
-:rtype: class:`ai_core_sdk.models.secret_query_response.SecretQueryResponse`
- -
-Methods inherited from ai_api_client_sdk.resource_clients.base_client.BaseClient:
-
__init__(self, rest_client: ai_api_client_sdk.helpers.rest_client.RestClient)
Initialize self.  See help(type(self)) for accurate signature.
- -
bulk_modify(self, *args, **kwargs)
Modifies multiple instances of the relevant resource. Will be implemented by the respective resource clients
- -
count(self, *args, **kwargs)
Counts the relevant resources. Will be implemented by the respective resource clients
- -
get(self, *args, **kwargs)
Retrieves the relevant resource. Will be implemented by the respective resource clients
- -
query_logs(self, *args, **kwargs)
Queries the relevant logs. Will be implemented by the respective resource clients
- -
-Data descriptors inherited from ai_api_client_sdk.resource_clients.base_client.BaseClient:
-
__dict__
-
dictionary for instance variables
-
-
__weakref__
-
list of weak references to the object
-
-

- \ No newline at end of file diff --git a/packages/core/docs/ai_core_sdk.tracking.html b/packages/core/docs/ai_core_sdk.tracking.html deleted file mode 100644 index 3f6932d..0000000 --- a/packages/core/docs/ai_core_sdk.tracking.html +++ /dev/null @@ -1,21 +0,0 @@ - - - - -Python: package ai_core_sdk.tracking - - - - - -
 
ai_core_sdk.tracking		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/core/ai_core_sdk/tracking/__init__.py
-

# pylint: disable=C0114

-

- - - - - -
 
Package Contents
       
tracking
-
- \ No newline at end of file diff --git a/packages/core/docs/ai_core_sdk.tracking.tracking.html b/packages/core/docs/ai_core_sdk.tracking.tracking.html deleted file mode 100644 index 3bab3a2..0000000 --- a/packages/core/docs/ai_core_sdk.tracking.tracking.html +++ /dev/null @@ -1,272 +0,0 @@ - - - - -Python: module ai_core_sdk.tracking.tracking - - - - - -
 
ai_core_sdk.tracking.tracking		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/core/ai_core_sdk/tracking/tracking.py
-

# pylint: disable=C0114

-

- - - - - -
 
Modules
       
os
-

- - - - - -
 
Classes
       
-
ai_core_sdk.resource_clients.metrics_client.MetricsCoreClient(ai_api_client_sdk.resource_clients.metrics_client.MetricsClient) -
-
-
Tracking -
-
-
-

- - - - - - - -
 
class Tracking(ai_core_sdk.resource_clients.metrics_client.MetricsCoreClient)
   Tracking(
-    base_url: str = None,
-    auth_url: str = None,
-    client_id: str = None,
-    client_secret: str = None,
-    cert_str: str = None,
-    key_str: str = None,
-    cert_file_path: str = None,
-    key_file_path: str = None,
-    token_creator: Callable[[], str] = None,
-    resource_group: str = None
-)
- 
-Tracking is a class implemented for interacting with the metrics related
-endpoints of the server. It is a wrapper around the base class
-:class:`ai_core_sdk.resource_clients.metrics_client.MetricsCoreClient`
- 
-:param base_url: Base URL of the AI Core. Should include the base path as well. (i.e., "<base_url>/lm/scenarios"
-should work)
-:type base_url: str
-:param auth_url: URL of the authorization endpoint. Should be the full URL (including /oauth/token), defaults to
-    None
-:type auth_url: str, optional
-:param client_id: client id to be used for authorization, defaults to None
-:type client_id: str, optional
-:param client_secret: client secret to be used for authorization, defaults to None
-:type client_secret: str, optional
-:param cert_str: certificate file content, needs to be provided alongside the key_str parameter, defaults to None
-:type cert_str: str, optional
-:param key_str: key file content, needs to be provided alongside the cert_str parameter, defaults to None
-:type key_str: str, optional
-:param cert_file_path: path to the certificate file, needs to be provided alongside the key_file_path parameter,
-    defaults to None
-:type cert_file_path: str, optional
-:param key_file_path: path to the key file, needs to be provided alongside the cert_file_path parameter,
-    defaults to None
-:type key_file_path: str, optional
-:param token_creator: the function which returns the Bearer token, when called. Either this, or
-    auth_url & client_id & client_secret should be specified, defaults to None
-:type token_creator: Callable[[], str], optional
-:param resource_group: The default resource group which will be used while sending the requests to the server. If
-    not set, the resource_group should be specified with every request to the server, defaults to None
-:type resource_group: str, optional
 
 
Method resolution order:
-
Tracking
-
ai_core_sdk.resource_clients.metrics_client.MetricsCoreClient
-
ai_api_client_sdk.resource_clients.metrics_client.MetricsClient
-
ai_api_client_sdk.resource_clients.base_client.BaseClient
-
builtins.object
-
-
-Methods defined here:
-
__init__( - self, - base_url: str = None, - auth_url: str = None, - client_id: str = None, - client_secret: str = None, - cert_str: str = None, - key_str: str = None, - cert_file_path: str = None, - key_file_path: str = None, - token_creator: Callable[[], str] = None, - resource_group: str = None -)
Initialize self.  See help(type(self)) for accurate signature.
- -
delete(self, execution_id: str, resource_group: str = None) -> None
Deletes the metrics.
- 
-:param execution_id: ID of the execution, of which the metrics should be deleted.
-:type execution_id: str
-:param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
-    resource group in the :class:`ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client` should be specified,
-    defaults to None
-:type resource_group: str
-: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
- -
log_metrics( - self, - metrics: List[ai_api_client_sdk.models.metric.Metric], - execution_id: str = '', - artifact_name: str = None, - resource_group: str = None -) -> None
Creates or updates the metrics for an execution.
- 
-    :param metrics: List of the metrics related to the execution,
-    :type metrics: List[class:`ai_api_client_sdk.metric.Metric`]
-    :param execution_id: ID of the execution, of which the metrics should be modified.
-    :type execution_id: str
-    :param artifact_name: Name of the artifact to associate with a metric, defaults to None
-    :type artifact_name: str
-    :param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
-        resource group in the :class:`ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client` should be specified,
-        defaults to None
-    :type resource_group: str
-    :raises: class:`ai_api_client_sdk.exception.AIAPIInvalidRequestException` if a 400 response is received from the
-server
-    :raises: class:`ai_api_client_sdk.exception.AIAPIServerException` if a non-2XX response is received from the
-        server
- -
modify( - self, - execution_id: str = '', - metrics: List[ai_api_client_sdk.models.metric.Metric] = None, - tags: List[ai_api_client_sdk.models.metric_tag.MetricTag] = None, - custom_info: List[ai_api_client_sdk.models.metric_custom_info.MetricCustomInfo] = None, - resource_group: str = None -) -> None
Creates or updates the metrics for an execution.
- 
-    :param execution_id: ID of the execution, of which the metrics should be modified.
-    :type execution_id: str
-    :param metrics: List of the metrics related to the execution, defaults to None
-    :type metrics: List[class:`ai_api_client_sdk.metric.Metric`], optional
-    :param tags: List of the tags related to the execution, defaults to None
-    :type tags: List[class:'ai_api_client_sdk.models.metric_tag.MetricTag'], optional
-    :param custom_info: List of custom info related to the execution, defaults to None
-    :type custom_info: List[class:`ai_api_client_sdk.models.metric_custom_info.MetricCustomInfo`], optional
-    :param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
-        resource group in the :class:`ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client` should be specified,
-        defaults to None
-    :type resource_group: str
-    :raises: class:`ai_api_client_sdk.exception.AIAPIInvalidRequestException` if a 400 response is received from the
-server
-    :raises: class:`ai_api_client_sdk.exception.AIAPIServerException` if a non-2XX response is received from the
-        server
- -
query( - self, - filter: str = None, - execution_ids: List[str] = None, - select: List[str] = None, - resource_group: str = None -) -> ai_api_client_sdk.models.metrics_query_response.MetricsQueryResponse
Creates or updates the metrics for an execution.
- 
-:param filter: 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
-:type filter: str, optional
-:param execution_ids: IDs of the executions, of which the metrics should be retrieved, defaults to None
-:type execution_ids: List[str], optional
-:param select: 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
-:type select: List[str], optional
-:param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
-    resource group in the :class:`ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client` should be specified,
-    defaults to None
-:type resource_group: str
-: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
-:return: An object representing the response from the server
-:rtype: class:`ai_api_client_sdk.models.metrics_query_response.MetricsQueryResponse`
- -
set_custom_info( - self, - custom_info: List[ai_api_client_sdk.models.metric_custom_info.MetricCustomInfo], - execution_id: str = '', - resource_group: str = None -) -> None
log custom info against the given execution
-    captures consumption semantics for the metrics or complex metric in JSON format.
- 
- 
-    :param custom_info: List of custom info related to the execution
-    :type custom_info: List[class:`ai_api_client_sdk.models.metric_custom_info.MetricCustomInfo`], optional
-    :param execution_id: ID of the execution, of which the metrics should be modified.
-    :type execution_id: str
-    :param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
-        resource group in the :class:`ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client` should be specified,
-        defaults to None
-    :type resource_group: str
-    :raises: class:`ai_api_client_sdk.exception.AIAPIInvalidRequestException` if a 400 response is received from the
-server
-    :raises: class:`ai_api_client_sdk.exception.AIAPIServerException` if a non-2XX response is received from the
-        server
- -
set_tags( - self, - tags: List[ai_api_client_sdk.models.metric_tag.MetricTag], - execution_id: str = '', - resource_group: str = None -) -> None
log tags against the given execution
- 
-    :param tags: List of the tags related to the execution, defaults to None
-    :type tags: List[class:'ai_api_client_sdk.models.metric_tag.MetricTag']
-    :param execution_id: ID of the execution, of which the metrics should be modified.
-    :type execution_id: str
-    :param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
-        resource group in the :class:`ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client` should be specified,
-        defaults to None
-    :type resource_group: str
-    :raises: class:`ai_api_client_sdk.exception.AIAPIInvalidRequestException` if a 400 response is received from the
-server
-    :raises: class:`ai_api_client_sdk.exception.AIAPIServerException` if a non-2XX response is received from the
-        server
- -
-Methods inherited from ai_api_client_sdk.resource_clients.base_client.BaseClient:
-
bulk_modify(self, *args, **kwargs)
Modifies multiple instances of the relevant resource. Will be implemented by the respective resource clients
- -
count(self, *args, **kwargs)
Counts the relevant resources. Will be implemented by the respective resource clients
- -
create(self, *args, **kwargs)
Creates the relevant resource. Will be implemented by the respective resource clients
- -
get(self, *args, **kwargs)
Retrieves the relevant resource. Will be implemented by the respective resource clients
- -
query_logs(self, *args, **kwargs)
Queries the relevant logs. Will be implemented by the respective resource clients
- -
-Data descriptors inherited from ai_api_client_sdk.resource_clients.base_client.BaseClient:
-
__dict__
-
dictionary for instance variables
-
-
__weakref__
-
list of weak references to the object
-
-

- - - - - -
 
Data
       Callable = typing.Callable
-List = typing.List
- \ No newline at end of file From 5289d1c7f33f3e3afee7ae1df485035dc80123da Mon Sep 17 00:00:00 2001 From: Marika Marszalkowski Date: Wed, 12 Aug 2026 20:43:13 +0200 Subject: [PATCH 2/3] use sphinx --- .gitignore | 4 ++++ Makefile | 18 +++++++++++++++++ docs/sphinx/conf.py | 15 ++++++++++++++ docs/sphinx/index.rst | 17 ++++++++++++++++ pyproject.toml | 2 +- uv.lock | 47 +++++++++++++++++++++++++++++++++++++++++++ 6 files changed, 102 insertions(+), 1 deletion(-) create mode 100644 docs/sphinx/conf.py create mode 100644 docs/sphinx/index.rst diff --git a/.gitignore b/.gitignore index 624a1f6..e17a658 100644 --- a/.gitignore +++ b/.gitignore @@ -68,8 +68,12 @@ instance/ # Scrapy stuff: .scrapy +# Generated API docs +api-docs/ + # Sphinx documentation **/docs/_build/ +docs/sphinx/_autogen/ **/docs/source/_reference **/docs/source/_api_doc diff --git a/Makefile b/Makefile index a70f8c7..b615858 100644 --- a/Makefile +++ b/Makefile @@ -1,6 +1,24 @@ +.PHONY: install docs lint license-check test test-integration test-pkg test-pkg-integration + install: uv sync --all-packages --all-extras +docs: + uv run sphinx-apidoc -e -M -f -T \ + -o docs/sphinx/_autogen \ + packages/base/ai_api_client_sdk \ + packages/base/ai_api_client_sdk/helpers + uv run sphinx-apidoc -e -M -f -T \ + -o docs/sphinx/_autogen \ + packages/core/ai_core_sdk \ + packages/core/ai_core_sdk/helpers \ + packages/core/ai_core_sdk/cli.py + uv run sphinx-apidoc -e -M -f -T \ + -o docs/sphinx/_autogen \ + packages/gen/gen_ai_hub \ + packages/gen/gen_ai_hub/evaluations/_internal + uv run sphinx-build -b html docs/sphinx api-docs/ + lint: uv run pylint ai_api_client_sdk ai_core_sdk gen_ai_hub --errors-only --output-format=colorized diff --git a/docs/sphinx/conf.py b/docs/sphinx/conf.py new file mode 100644 index 0000000..b214925 --- /dev/null +++ b/docs/sphinx/conf.py @@ -0,0 +1,15 @@ +project = "SAP AI SDK Python" +extensions = [ + "sphinx.ext.autodoc", + "sphinx.ext.napoleon", +] +html_theme = "furo" +exclude_patterns = ["_autogen/modules.rst"] +autodoc_default_options = { + "members": True, + "undoc-members": True, + "private-members": False, + "show-inheritance": True, + "special-members": "__init__", +} +autodoc_member_order = "bysource" diff --git a/docs/sphinx/index.rst b/docs/sphinx/index.rst new file mode 100644 index 0000000..3bfecc4 --- /dev/null +++ b/docs/sphinx/index.rst @@ -0,0 +1,17 @@ +SAP AI SDK Python +================= + +.. toctree:: + :maxdepth: 1 + :caption: Packages + + _autogen/ai_api_client_sdk + _autogen/ai_core_sdk + _autogen/gen_ai_hub + +Indices +------- + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/pyproject.toml b/pyproject.toml index 55a508d..f085bb3 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -5,7 +5,7 @@ requires-python = ">=3.10" license = "Apache-2.0" [dependency-groups] -dev = ["pip-licenses>=5.5.5", "commitizen>=4"] +dev = ["pip-licenses>=5.5.5", "commitizen>=4", "sphinx>=7.0.0", "furo"] [tool.uv.sources] sap-ai-sdk-base = { workspace = true } diff --git a/uv.lock b/uv.lock index 461ae24..9a90fbc 100644 --- a/uv.lock +++ b/uv.lock @@ -25,6 +25,18 @@ members = [ "sap-ai-sdk-gen", ] +[[package]] +name = "accessible-pygments" +version = "0.0.5" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "pygments" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/bc/c1/bbac6a50d02774f91572938964c582fff4270eee73ab822a4aeea4d8b11b/accessible_pygments-0.0.5.tar.gz", hash = "sha256:40918d3e6a2b619ad424cb91e556bd3bd8865443d9f22f1dcdf79e33c8046872", size = 1377899, upload-time = "2024-05-10T11:23:10.216Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/8d/3f/95338030883d8c8b91223b4e21744b04d11b161a3ef117295d8241f50ab4/accessible_pygments-0.0.5-py3-none-any.whl", hash = "sha256:88ae3211e68a1d0b011504b2ffc1691feafce124b845bd072ab6f9f66f34d4b7", size = 1395903, upload-time = "2024-05-10T11:23:08.421Z" }, +] + [[package]] name = "aenum" version = "3.1.17" @@ -42,7 +54,10 @@ source = { virtual = "." } [package.dev-dependencies] dev = [ { name = "commitizen" }, + { name = "furo" }, { name = "pip-licenses" }, + { name = "sphinx", version = "8.1.3", source = { registry = "https://pypi.org/simple" }, marker = "python_full_version < '3.11'" }, + { name = "sphinx", version = "8.2.3", source = { registry = "https://pypi.org/simple" }, marker = "python_full_version >= '3.11'" }, ] [package.metadata] @@ -50,7 +65,9 @@ dev = [ [package.metadata.requires-dev] dev = [ { name = "commitizen", specifier = ">=4" }, + { name = "furo" }, { name = "pip-licenses", specifier = ">=5.5.5" }, + { name = "sphinx", specifier = ">=7.0.0" }, ] [[package]] @@ -1063,6 +1080,23 @@ wheels = [ { url = "https://files.pythonhosted.org/packages/9a/9a/e35b4a917281c0b8419d4207f4334c8e8c5dbf4f3f5f9ada73958d937dcc/frozenlist-1.8.0-py3-none-any.whl", hash = "sha256:0c18a16eab41e82c295618a77502e17b195883241c563b00f0aa5106fc4eaa0d", size = 13409, upload-time = "2025-10-06T05:38:16.721Z" }, ] +[[package]] +name = "furo" +version = "2025.12.19" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "accessible-pygments" }, + { name = "beautifulsoup4" }, + { name = "pygments" }, + { name = "sphinx", version = "8.1.3", source = { registry = "https://pypi.org/simple" }, marker = "python_full_version < '3.11'" }, + { name = "sphinx", version = "8.2.3", source = { registry = "https://pypi.org/simple" }, marker = "python_full_version >= '3.11'" }, + { name = "sphinx-basic-ng" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/ec/20/5f5ad4da6a5a27c80f2ed2ee9aee3f9e36c66e56e21c00fde467b2f8f88f/furo-2025.12.19.tar.gz", hash = "sha256:188d1f942037d8b37cd3985b955839fea62baa1730087dc29d157677c857e2a7", size = 1661473, upload-time = "2025-12-19T17:34:40.889Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/f4/b2/50e9b292b5cac13e9e81272c7171301abc753a60460d21505b606e15cf21/furo-2025.12.19-py3-none-any.whl", hash = "sha256:bb0ead5309f9500130665a26bee87693c41ce4dbdff864dbfb6b0dae4673d24f", size = 339262, upload-time = "2025-12-19T17:34:38.905Z" }, +] + [[package]] name = "google-auth" version = "2.56.2" @@ -4343,6 +4377,19 @@ wheels = [ { url = "https://files.pythonhosted.org/packages/31/53/136e9eca6e0b9dc0e1962e2c908fbea2e5ac000c2a2fbd9a35797958c48b/sphinx-8.2.3-py3-none-any.whl", hash = "sha256:4405915165f13521d875a8c29c8970800a0141c14cc5416a38feca4ea5d9b9c3", size = 3589741, upload-time = "2025-03-02T22:31:56.836Z" }, ] +[[package]] +name = "sphinx-basic-ng" +version = "1.0.0b2" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "sphinx", version = "8.1.3", source = { registry = "https://pypi.org/simple" }, marker = "python_full_version < '3.11'" }, + { name = "sphinx", version = "8.2.3", source = { registry = "https://pypi.org/simple" }, marker = "python_full_version >= '3.11'" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/98/0b/a866924ded68efec7a1759587a4e478aec7559d8165fac8b2ad1c0e774d6/sphinx_basic_ng-1.0.0b2.tar.gz", hash = "sha256:9ec55a47c90c8c002b5960c57492ec3021f5193cb26cebc2dc4ea226848651c9", size = 20736, upload-time = "2023-07-08T18:40:54.166Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/3c/dd/018ce05c532a22007ac58d4f45232514cd9d6dd0ee1dc374e309db830983/sphinx_basic_ng-1.0.0b2-py3-none-any.whl", hash = "sha256:eb09aedbabfb650607e9b4b68c9d240b90b1e1be221d6ad71d61c52e29f7932b", size = 22496, upload-time = "2023-07-08T18:40:52.659Z" }, +] + [[package]] name = "sphinxawesome-theme" version = "6.0.5" From 8174d6c79951126e2147d3d9bc8d8bcfc2248ffa Mon Sep 17 00:00:00 2001 From: "sap-ai-sdk-bot[bot]" <272306433+sap-ai-sdk-bot[bot]@users.noreply.github.com> Date: Wed, 12 Aug 2026 18:45:08 +0000 Subject: [PATCH 3/3] docs: update pydoc3 documentation [skip ci] --- .../ai_api_client_sdk.ai_api_v2_client.html | 131 ++ .../docs/ai_api_client_sdk.exception.html | 1068 +++++++++++++++++ ..._api_client_sdk.helpers.authenticator.html | 110 ++ .../ai_api_client_sdk.helpers.constants.html | 95 ++ ...pi_client_sdk.helpers.datetime_parser.html | 30 + .../base/docs/ai_api_client_sdk.helpers.html | 26 + .../ai_api_client_sdk.helpers.llm_helper.html | 32 + .../ai_api_client_sdk.helpers.logging.html | 39 + ...ai_api_client_sdk.helpers.rest_client.html | 247 ++++ packages/base/docs/ai_api_client_sdk.html | 25 + ...client_sdk.models.ai_api_capabilities.html | 117 ++ ...dels.ai_api_capabilities_bulk_updates.html | 83 ++ ...t_sdk.models.ai_api_capabilities_logs.html | 83 ++ ...i_api_client_sdk.models.ai_api_limits.html | 88 ++ ..._sdk.models.ai_api_limits_deployments.html | 85 ++ ...t_sdk.models.ai_api_limits_enactments.html | 62 + ...t_sdk.models.ai_api_limits_executions.html | 85 ++ .../ai_api_client_sdk.models.ai_api_meta.html | 92 ++ .../ai_api_client_sdk.models.api_version.html | 92 ++ .../ai_api_client_sdk.models.artifact.html | 131 ++ ...t_sdk.models.artifact_create_response.html | 82 ++ ...nt_sdk.models.artifact_query_response.html | 90 ++ .../ai_api_client_sdk.models.base_models.html | 488 ++++++++ ...ai_api_client_sdk.models.capabilities.html | 94 ++ ...i_api_client_sdk.models.configuration.html | 108 ++ ....models.configuration_create_response.html | 74 ++ ...k.models.configuration_query_response.html | 90 ++ ...lient_sdk.models.dataset_capabilities.html | 92 ++ ..._api_client_sdk.models.dataset_limits.html | 88 ++ .../ai_api_client_sdk.models.deployment.html | 160 +++ ...odels.deployment_bulk_modify_response.html | 78 ++ ...sdk.models.deployment_create_response.html | 101 ++ ...models.deployment_get_status_response.html | 101 ++ ..._sdk.models.deployment_query_response.html | 90 ++ .../ai_api_client_sdk.models.enactment.html | 116 ++ ....models.enactment_get_status_response.html | 84 ++ .../ai_api_client_sdk.models.executable.html | 128 ++ ..._sdk.models.executable_query_response.html | 90 ++ .../ai_api_client_sdk.models.execution.html | 141 +++ ...models.execution_bulk_modify_response.html | 78 ++ ..._sdk.models.execution_create_response.html | 93 ++ ....models.execution_get_status_response.html | 99 ++ ...t_sdk.models.execution_query_response.html | 90 ++ ..._client_sdk.models.execution_schedule.html | 110 ++ ...ls.execution_schedule_create_response.html | 74 ++ ...els.execution_schedule_query_response.html | 90 ++ .../ai_api_client_sdk.models.extensions.html | 93 ++ ...lient_sdk.models.extensions_analytics.html | 77 ++ ..._client_sdk.models.extensions_dataset.html | 92 ++ ...sdk.models.extensions_resource_groups.html | 77 ++ ..._api_client_sdk.models.healthz_status.html | 139 +++ .../base/docs/ai_api_client_sdk.models.html | 88 ++ ..._api_client_sdk.models.input_artifact.html | 93 ++ ...ent_sdk.models.input_artifact_binding.html | 82 ++ .../docs/ai_api_client_sdk.models.label.html | 84 ++ ...ai_api_client_sdk.models.log_response.html | 157 +++ .../docs/ai_api_client_sdk.models.metric.html | 107 ++ ..._client_sdk.models.metric_custom_info.html | 81 ++ ...ai_api_client_sdk.models.metric_label.html | 87 ++ ...api_client_sdk.models.metric_resource.html | 91 ++ .../ai_api_client_sdk.models.metric_tag.html | 82 ++ ...ent_sdk.models.metrics_query_response.html | 90 ++ .../docs/ai_api_client_sdk.models.model.html | 105 ++ ...els.model_base_data_allowed_scenarios.html | 62 + ...lient_sdk.models.model_query_response.html | 90 ++ ...i_api_client_sdk.models.model_version.html | 127 ++ ...api_client_sdk.models.output_artifact.html | 93 ++ .../ai_api_client_sdk.models.parameter.html | 98 ++ ...i_client_sdk.models.parameter_binding.html | 84 ++ ..._api_client_sdk.models.resource_group.html | 92 ++ ....models.resource_group_query_response.html | 91 ++ ...ient_sdk.models.resource_group_status.html | 82 ++ .../ai_api_client_sdk.models.scenario.html | 109 ++ ...nt_sdk.models.scenario_query_response.html | 90 ++ .../docs/ai_api_client_sdk.models.status.html | 143 +++ ...i_api_client_sdk.models.target_status.html | 84 ++ .../ai_api_client_sdk.models.version.html | 93 ++ ...ai_api_client_sdk.models.version_list.html | 77 ++ ...ent_sdk.models.version_query_response.html | 90 ++ ..._sdk.resource_clients.artifact_client.html | 212 ++++ ...ient_sdk.resource_clients.base_client.html | 75 ++ ...resource_clients.configuration_client.html | 197 +++ ...dk.resource_clients.deployment_client.html | 280 +++++ ...dk.resource_clients.executable_client.html | 115 ++ ...sdk.resource_clients.execution_client.html | 282 +++++ ...rce_clients.execution_schedule_client.html | 235 ++++ ...t_sdk.resource_clients.healthz_client.html | 79 ++ .../ai_api_client_sdk.resource_clients.html | 33 + ...ient_sdk.resource_clients.meta_client.html | 75 ++ ...t_sdk.resource_clients.metrics_client.html | 129 ++ ...ent_sdk.resource_clients.model_client.html | 91 ++ ...source_clients.resource_groups_client.html | 159 +++ ..._sdk.resource_clients.scenario_client.html | 150 +++ .../docs/ai_core_sdk.ai_core_v2_client.html | 150 +++ packages/core/docs/ai_core_sdk.cli.html | 64 + .../core/docs/ai_core_sdk.credentials.html | 262 ++++ packages/core/docs/ai_core_sdk.exception.html | 156 +++ .../docs/ai_core_sdk.helpers.constants.html | 101 ++ packages/core/docs/ai_core_sdk.helpers.html | 49 + .../docs/ai_core_sdk.helpers.logging.html | 38 + packages/core/docs/ai_core_sdk.html | 28 + .../docs/ai_core_sdk.models.application.html | 89 ++ ...sdk.models.application_query_response.html | 91 ++ ...dels.application_resource_sync_status.html | 87 ++ ...ai_core_sdk.models.application_source.html | 85 ++ ...ai_core_sdk.models.application_status.html | 107 ++ .../docs/ai_core_sdk.models.base_models.html | 116 ++ ...ore_sdk.models.docker_registry_secret.html | 82 ++ ...docker_registry_secret_query_response.html | 91 ++ packages/core/docs/ai_core_sdk.models.html | 39 + .../core/docs/ai_core_sdk.models.kpi.html | 69 ++ ...i_core_sdk.models.object_store_secret.html | 67 ++ ...ls.object_store_secret_query_response.html | 91 ++ .../docs/ai_core_sdk.models.repository.html | 85 ++ ..._sdk.models.repository_query_response.html | 91 ++ .../ai_core_sdk.models.repository_status.html | 82 ++ .../ai_core_sdk.models.resource_group.html | 98 ++ ....models.resource_group_query_response.html | 91 ++ ...core_sdk.models.resource_group_status.html | 82 ++ .../core/docs/ai_core_sdk.models.secret.html | 72 ++ ...core_sdk.models.secret_query_response.html | 91 ++ ....resource_clients.applications_client.html | 199 +++ ...lients.docker_registry_secrets_client.html | 147 +++ .../docs/ai_core_sdk.resource_clients.html | 28 + ...resource_clients.internal_rest_client.html | 220 ++++ ..._core_sdk.resource_clients.kpi_client.html | 85 ++ ...e_sdk.resource_clients.metrics_client.html | 215 ++++ ...e_clients.object_store_secrets_client.html | 229 ++++ ....resource_clients.repositories_client.html | 148 +++ ...e_sdk.resource_clients.secrets_client.html | 181 +++ packages/core/docs/ai_core_sdk.tracking.html | 21 + .../docs/ai_core_sdk.tracking.tracking.html | 272 +++++ 132 files changed, 15191 insertions(+) create mode 100644 packages/base/docs/ai_api_client_sdk.ai_api_v2_client.html create mode 100644 packages/base/docs/ai_api_client_sdk.exception.html create mode 100644 packages/base/docs/ai_api_client_sdk.helpers.authenticator.html create mode 100644 packages/base/docs/ai_api_client_sdk.helpers.constants.html create mode 100644 packages/base/docs/ai_api_client_sdk.helpers.datetime_parser.html create mode 100644 packages/base/docs/ai_api_client_sdk.helpers.html create mode 100644 packages/base/docs/ai_api_client_sdk.helpers.llm_helper.html create mode 100644 packages/base/docs/ai_api_client_sdk.helpers.logging.html create mode 100644 packages/base/docs/ai_api_client_sdk.helpers.rest_client.html create mode 100644 packages/base/docs/ai_api_client_sdk.html create mode 100644 packages/base/docs/ai_api_client_sdk.models.ai_api_capabilities.html create mode 100644 packages/base/docs/ai_api_client_sdk.models.ai_api_capabilities_bulk_updates.html create mode 100644 packages/base/docs/ai_api_client_sdk.models.ai_api_capabilities_logs.html create mode 100644 packages/base/docs/ai_api_client_sdk.models.ai_api_limits.html create mode 100644 packages/base/docs/ai_api_client_sdk.models.ai_api_limits_deployments.html create mode 100644 packages/base/docs/ai_api_client_sdk.models.ai_api_limits_enactments.html create mode 100644 packages/base/docs/ai_api_client_sdk.models.ai_api_limits_executions.html create mode 100644 packages/base/docs/ai_api_client_sdk.models.ai_api_meta.html create mode 100644 packages/base/docs/ai_api_client_sdk.models.api_version.html create mode 100644 packages/base/docs/ai_api_client_sdk.models.artifact.html create mode 100644 packages/base/docs/ai_api_client_sdk.models.artifact_create_response.html create mode 100644 packages/base/docs/ai_api_client_sdk.models.artifact_query_response.html create mode 100644 packages/base/docs/ai_api_client_sdk.models.base_models.html create mode 100644 packages/base/docs/ai_api_client_sdk.models.capabilities.html create mode 100644 packages/base/docs/ai_api_client_sdk.models.configuration.html create mode 100644 packages/base/docs/ai_api_client_sdk.models.configuration_create_response.html create mode 100644 packages/base/docs/ai_api_client_sdk.models.configuration_query_response.html create mode 100644 packages/base/docs/ai_api_client_sdk.models.dataset_capabilities.html create mode 100644 packages/base/docs/ai_api_client_sdk.models.dataset_limits.html create mode 100644 packages/base/docs/ai_api_client_sdk.models.deployment.html create mode 100644 packages/base/docs/ai_api_client_sdk.models.deployment_bulk_modify_response.html create mode 100644 packages/base/docs/ai_api_client_sdk.models.deployment_create_response.html create mode 100644 packages/base/docs/ai_api_client_sdk.models.deployment_get_status_response.html create mode 100644 packages/base/docs/ai_api_client_sdk.models.deployment_query_response.html create mode 100644 packages/base/docs/ai_api_client_sdk.models.enactment.html create mode 100644 packages/base/docs/ai_api_client_sdk.models.enactment_get_status_response.html create mode 100644 packages/base/docs/ai_api_client_sdk.models.executable.html create mode 100644 packages/base/docs/ai_api_client_sdk.models.executable_query_response.html create mode 100644 packages/base/docs/ai_api_client_sdk.models.execution.html create mode 100644 packages/base/docs/ai_api_client_sdk.models.execution_bulk_modify_response.html create mode 100644 packages/base/docs/ai_api_client_sdk.models.execution_create_response.html create mode 100644 packages/base/docs/ai_api_client_sdk.models.execution_get_status_response.html create mode 100644 packages/base/docs/ai_api_client_sdk.models.execution_query_response.html create mode 100644 packages/base/docs/ai_api_client_sdk.models.execution_schedule.html create mode 100644 packages/base/docs/ai_api_client_sdk.models.execution_schedule_create_response.html create mode 100644 packages/base/docs/ai_api_client_sdk.models.execution_schedule_query_response.html create mode 100644 packages/base/docs/ai_api_client_sdk.models.extensions.html create mode 100644 packages/base/docs/ai_api_client_sdk.models.extensions_analytics.html create mode 100644 packages/base/docs/ai_api_client_sdk.models.extensions_dataset.html create mode 100644 packages/base/docs/ai_api_client_sdk.models.extensions_resource_groups.html create mode 100644 packages/base/docs/ai_api_client_sdk.models.healthz_status.html create mode 100644 packages/base/docs/ai_api_client_sdk.models.html create mode 100644 packages/base/docs/ai_api_client_sdk.models.input_artifact.html create mode 100644 packages/base/docs/ai_api_client_sdk.models.input_artifact_binding.html create mode 100644 packages/base/docs/ai_api_client_sdk.models.label.html create mode 100644 packages/base/docs/ai_api_client_sdk.models.log_response.html create mode 100644 packages/base/docs/ai_api_client_sdk.models.metric.html create mode 100644 packages/base/docs/ai_api_client_sdk.models.metric_custom_info.html create mode 100644 packages/base/docs/ai_api_client_sdk.models.metric_label.html create mode 100644 packages/base/docs/ai_api_client_sdk.models.metric_resource.html create mode 100644 packages/base/docs/ai_api_client_sdk.models.metric_tag.html create mode 100644 packages/base/docs/ai_api_client_sdk.models.metrics_query_response.html create mode 100644 packages/base/docs/ai_api_client_sdk.models.model.html create mode 100644 packages/base/docs/ai_api_client_sdk.models.model_base_data_allowed_scenarios.html create mode 100644 packages/base/docs/ai_api_client_sdk.models.model_query_response.html create mode 100644 packages/base/docs/ai_api_client_sdk.models.model_version.html create mode 100644 packages/base/docs/ai_api_client_sdk.models.output_artifact.html create mode 100644 packages/base/docs/ai_api_client_sdk.models.parameter.html create mode 100644 packages/base/docs/ai_api_client_sdk.models.parameter_binding.html create mode 100644 packages/base/docs/ai_api_client_sdk.models.resource_group.html create mode 100644 packages/base/docs/ai_api_client_sdk.models.resource_group_query_response.html create mode 100644 packages/base/docs/ai_api_client_sdk.models.resource_group_status.html create mode 100644 packages/base/docs/ai_api_client_sdk.models.scenario.html create mode 100644 packages/base/docs/ai_api_client_sdk.models.scenario_query_response.html create mode 100644 packages/base/docs/ai_api_client_sdk.models.status.html create mode 100644 packages/base/docs/ai_api_client_sdk.models.target_status.html create mode 100644 packages/base/docs/ai_api_client_sdk.models.version.html create mode 100644 packages/base/docs/ai_api_client_sdk.models.version_list.html create mode 100644 packages/base/docs/ai_api_client_sdk.models.version_query_response.html create mode 100644 packages/base/docs/ai_api_client_sdk.resource_clients.artifact_client.html create mode 100644 packages/base/docs/ai_api_client_sdk.resource_clients.base_client.html create mode 100644 packages/base/docs/ai_api_client_sdk.resource_clients.configuration_client.html create mode 100644 packages/base/docs/ai_api_client_sdk.resource_clients.deployment_client.html create mode 100644 packages/base/docs/ai_api_client_sdk.resource_clients.executable_client.html create mode 100644 packages/base/docs/ai_api_client_sdk.resource_clients.execution_client.html create mode 100644 packages/base/docs/ai_api_client_sdk.resource_clients.execution_schedule_client.html create mode 100644 packages/base/docs/ai_api_client_sdk.resource_clients.healthz_client.html create mode 100644 packages/base/docs/ai_api_client_sdk.resource_clients.html create mode 100644 packages/base/docs/ai_api_client_sdk.resource_clients.meta_client.html create mode 100644 packages/base/docs/ai_api_client_sdk.resource_clients.metrics_client.html create mode 100644 packages/base/docs/ai_api_client_sdk.resource_clients.model_client.html create mode 100644 packages/base/docs/ai_api_client_sdk.resource_clients.resource_groups_client.html create mode 100644 packages/base/docs/ai_api_client_sdk.resource_clients.scenario_client.html create mode 100644 packages/core/docs/ai_core_sdk.ai_core_v2_client.html create mode 100644 packages/core/docs/ai_core_sdk.cli.html create mode 100644 packages/core/docs/ai_core_sdk.credentials.html create mode 100644 packages/core/docs/ai_core_sdk.exception.html create mode 100644 packages/core/docs/ai_core_sdk.helpers.constants.html create mode 100644 packages/core/docs/ai_core_sdk.helpers.html create mode 100644 packages/core/docs/ai_core_sdk.helpers.logging.html create mode 100644 packages/core/docs/ai_core_sdk.html create mode 100644 packages/core/docs/ai_core_sdk.models.application.html create mode 100644 packages/core/docs/ai_core_sdk.models.application_query_response.html create mode 100644 packages/core/docs/ai_core_sdk.models.application_resource_sync_status.html create mode 100644 packages/core/docs/ai_core_sdk.models.application_source.html create mode 100644 packages/core/docs/ai_core_sdk.models.application_status.html create mode 100644 packages/core/docs/ai_core_sdk.models.base_models.html create mode 100644 packages/core/docs/ai_core_sdk.models.docker_registry_secret.html create mode 100644 packages/core/docs/ai_core_sdk.models.docker_registry_secret_query_response.html create mode 100644 packages/core/docs/ai_core_sdk.models.html create mode 100644 packages/core/docs/ai_core_sdk.models.kpi.html create mode 100644 packages/core/docs/ai_core_sdk.models.object_store_secret.html create mode 100644 packages/core/docs/ai_core_sdk.models.object_store_secret_query_response.html create mode 100644 packages/core/docs/ai_core_sdk.models.repository.html create mode 100644 packages/core/docs/ai_core_sdk.models.repository_query_response.html create mode 100644 packages/core/docs/ai_core_sdk.models.repository_status.html create mode 100644 packages/core/docs/ai_core_sdk.models.resource_group.html create mode 100644 packages/core/docs/ai_core_sdk.models.resource_group_query_response.html create mode 100644 packages/core/docs/ai_core_sdk.models.resource_group_status.html create mode 100644 packages/core/docs/ai_core_sdk.models.secret.html create mode 100644 packages/core/docs/ai_core_sdk.models.secret_query_response.html create mode 100644 packages/core/docs/ai_core_sdk.resource_clients.applications_client.html create mode 100644 packages/core/docs/ai_core_sdk.resource_clients.docker_registry_secrets_client.html create mode 100644 packages/core/docs/ai_core_sdk.resource_clients.html create mode 100644 packages/core/docs/ai_core_sdk.resource_clients.internal_rest_client.html create mode 100644 packages/core/docs/ai_core_sdk.resource_clients.kpi_client.html create mode 100644 packages/core/docs/ai_core_sdk.resource_clients.metrics_client.html create mode 100644 packages/core/docs/ai_core_sdk.resource_clients.object_store_secrets_client.html create mode 100644 packages/core/docs/ai_core_sdk.resource_clients.repositories_client.html create mode 100644 packages/core/docs/ai_core_sdk.resource_clients.secrets_client.html create mode 100644 packages/core/docs/ai_core_sdk.tracking.html create mode 100644 packages/core/docs/ai_core_sdk.tracking.tracking.html diff --git a/packages/base/docs/ai_api_client_sdk.ai_api_v2_client.html b/packages/base/docs/ai_api_client_sdk.ai_api_v2_client.html new file mode 100644 index 0000000..f316ffd --- /dev/null +++ b/packages/base/docs/ai_api_client_sdk.ai_api_v2_client.html @@ -0,0 +1,131 @@ + + + + +Python: module ai_api_client_sdk.ai_api_v2_client + + + + + +
 
ai_api_client_sdk.ai_api_v2_client		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/ai_api_v2_client.py
+

+

+ + + + + +
 
Modules
       
os
+

+ + + + + +
 
Classes
       
+
builtins.object +
+
+
AIAPIV2Client +
+
+
+

+ + + + + + + +
 
class AIAPIV2Client(builtins.object)
   AIAPIV2Client(
+    base_url: str,
+    auth_url: str = None,
+    client_id: str = None,
+    client_secret: str = None,
+    cert_str: str = None,
+    key_str: str = None,
+    cert_file_path: str = None,
+    key_file_path: str = None,
+    token_creator: Callable[[], str] = None,
+    resource_group: str = None,
+    connect_timeout=60,
+    num_request_retries=3,
+    **kwargs
+)
+ 
+The AIAPIV2Client is the class implemented to interact with the AI API server. The user can use its attributes
+corresponding to the resources, for interacting with endpoints related to that resource. (i.e.,
+aiapiv2client.scenario)
+ 
+:param base_url: Base URL of the AI API server. Should include the base path as well. (i.e., "<base_url>/scenarios"
+    should work)
+:type base_url: str
+:param auth_url: URL of the authorization endpoint. Should be the full URL (including /oauth/token), defaults to
+    None
+:type auth_url: str, optional
+:param client_id: client id to be used for authorization, defaults to None
+:type client_id: str, optional
+:param client_secret: client secret to be used for authorization, defaults to None
+:type client_secret: str, optional
+:param cert_str: certificate file content, needs to be provided alongside the key_str parameter, defaults to None
+:type cert_str: str, optional
+:param key_str: key file content, needs to be provided alongside the cert_str parameter, defaults to None
+:type key_str: str, optional
+:param cert_file_path: path to the certificate file, needs to be provided alongside the key_file_path parameter,
+    defaults to None
+:type cert_file_path: str, optional
+:param key_file_path: path to the key file, needs to be provided alongside the cert_file_path parameter,
+    defaults to None
+:type key_file_path: str, optional
+:param token_creator: the function which returns the Bearer token, when called. Either this, or
+    auth_url & client_id & client_secret should be specified, defaults to None
+:type token_creator: Callable[[], str], optional
+:param resource_group: The default resource group which will be used while sending the requests to the server. If
+    not set, the resource_group should be specified with every request to the server, defaults to None
+:type resource_group: str, optional
+:param read_timeout: Read timeout for requests in seconds, defaults to 60s
+:type read_timeout: int
+:param connect_timeout: Connect timeout for requests in seconds, defaults to 60s
+:type connect_timeout: int
+:param num_request_retries: Number of retries for failing requests with http status code 429, 500, 502, 503 or 504,
+    defaults to 60s
+:type num_request_retries: int
+:param client_type: Client type header to be sent in the request, defaults to 'AI API Python SDK'
+:type client_type: str
 
 Methods defined here:
+
__init__( + self, + base_url: str, + auth_url: str = None, + client_id: str = None, + client_secret: str = None, + cert_str: str = None, + key_str: str = None, + cert_file_path: str = None, + key_file_path: str = None, + token_creator: Callable[[], str] = None, + resource_group: str = None, + connect_timeout=60, + num_request_retries=3, + **kwargs +)
Initialize self.  See help(type(self)) for accurate signature.
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables
+
+
__weakref__
+
list of weak references to the object
+
+

+ + + + + +
 
Data
       AUTH_PARAM_ERROR_MESSAGE = '\nFor authorization please provide either one of ... & key_str\n c. cert_file_path & key_file_path\n'
+Callable = typing.Callable
+SKIP_AUTH_ENV_VAR = 'SKIP_AUTHORIZATION'
+ \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.exception.html b/packages/base/docs/ai_api_client_sdk.exception.html new file mode 100644 index 0000000..67d8d47 --- /dev/null +++ b/packages/base/docs/ai_api_client_sdk.exception.html @@ -0,0 +1,1068 @@ + + + + +Python: module ai_api_client_sdk.exception + + + + + +
 
ai_api_client_sdk.exception		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/exception.py
+

+

+ + + + + +
 
Classes
       
+
builtins.Exception(builtins.BaseException) +
+
+
AIAPIClientSDKException +
+
+
AIAPIAuthenticatorException +
+
+
AIAPIAuthenticatorAuthorizationException +
AIAPIAuthenticatorForbiddenException +
AIAPIAuthenticatorInvalidRequestException +
AIAPIAuthenticatorMethodNotAllowedException +
AIAPIAuthenticatorServerException +
AIAPIAuthenticatorTimeoutException +
+
+
AIAPIInvalidInputException +
+
+
AIAPIServerException +
+
+
AIAPIAuthorizationException +
AIAPIInvalidRequestException +
AIAPINotFoundException +
AIAPIPreconditionFailedException +
+
+
+
+
+

+ + + + + + + +
 
class AIAPIAuthenticatorAuthorizationException(AIAPIAuthenticatorException)
   AIAPIAuthenticatorAuthorizationException(error_message: str = None)
+ 
+Exception type that is raised by the :class:`ai_api_client_sdk.helpers.authenticator.Authenticator` if
+the XSUAA server responded with unauthorized when trying to retrieve a token
 
 
Method resolution order:
+
AIAPIAuthenticatorAuthorizationException
+
AIAPIAuthenticatorException
+
AIAPIClientSDKException
+
builtins.Exception
+
builtins.BaseException
+
builtins.object
+
+
+Methods defined here:
+
__init__(self, error_message: str = None)
Initialize self.  See help(type(self)) for accurate signature.
+ +
+Data descriptors inherited from AIAPIClientSDKException:
+
__weakref__
+
list of weak references to the object
+
+
+Static methods inherited from builtins.Exception:
+
__new__(*args, **kwargs) class method of builtins.Exception
Create and return a new object.  See help(type) for accurate signature.
+ +
+Methods inherited from builtins.BaseException:
+
__getattribute__(self, name, /)
Return getattr(self, name).
+ +
__reduce__(self, /)
Helper for pickle.
+ +
__repr__(self, /)
Return repr(self).
+ +
__setstate__(self, object, /)
+ +
__str__(self, /)
Return str(self).
+ +
add_note(self, object, /)
Exception.add_note(note) --
+add a note to the exception
+ +
with_traceback(self, object, /)
Exception.with_traceback(tb) --
+set self.__traceback__ to tb and return self.
+ +
+Data descriptors inherited from builtins.BaseException:
+
__cause__
+
exception cause
+
+
__context__
+
exception context
+
+
__dict__
+
+
__suppress_context__
+
+
__traceback__
+
+
args
+
+

+ + + + + + + +
 
class AIAPIAuthenticatorException(AIAPIClientSDKException)
   AIAPIAuthenticatorException(status_code: int = None, error_message: str = None)
+ 
+Exception type that is raised by the :class:`ai_api_client_sdk.helpers.authenticator.Authenticator`
 
 
Method resolution order:
+
AIAPIAuthenticatorException
+
AIAPIClientSDKException
+
builtins.Exception
+
builtins.BaseException
+
builtins.object
+
+
+Methods defined here:
+
__init__(self, status_code: int = None, error_message: str = None)
Initialize self.  See help(type(self)) for accurate signature.
+ +
+Data descriptors inherited from AIAPIClientSDKException:
+
__weakref__
+
list of weak references to the object
+
+
+Static methods inherited from builtins.Exception:
+
__new__(*args, **kwargs) class method of builtins.Exception
Create and return a new object.  See help(type) for accurate signature.
+ +
+Methods inherited from builtins.BaseException:
+
__getattribute__(self, name, /)
Return getattr(self, name).
+ +
__reduce__(self, /)
Helper for pickle.
+ +
__repr__(self, /)
Return repr(self).
+ +
__setstate__(self, object, /)
+ +
__str__(self, /)
Return str(self).
+ +
add_note(self, object, /)
Exception.add_note(note) --
+add a note to the exception
+ +
with_traceback(self, object, /)
Exception.with_traceback(tb) --
+set self.__traceback__ to tb and return self.
+ +
+Data descriptors inherited from builtins.BaseException:
+
__cause__
+
exception cause
+
+
__context__
+
exception context
+
+
__dict__
+
+
__suppress_context__
+
+
__traceback__
+
+
args
+
+

+ + + + + + + +
 
class AIAPIAuthenticatorForbiddenException(AIAPIAuthenticatorException)
   AIAPIAuthenticatorForbiddenException(error_message: str = None)
+ 
+Exception type that is raised by the :class:`ai_api_client_sdk.helpers.authenticator.Authenticator` if
+the XSUAA server responded with forbidden when trying to retrieve a token
 
 
Method resolution order:
+
AIAPIAuthenticatorForbiddenException
+
AIAPIAuthenticatorException
+
AIAPIClientSDKException
+
builtins.Exception
+
builtins.BaseException
+
builtins.object
+
+
+Methods defined here:
+
__init__(self, error_message: str = None)
Initialize self.  See help(type(self)) for accurate signature.
+ +
+Data descriptors inherited from AIAPIClientSDKException:
+
__weakref__
+
list of weak references to the object
+
+
+Static methods inherited from builtins.Exception:
+
__new__(*args, **kwargs) class method of builtins.Exception
Create and return a new object.  See help(type) for accurate signature.
+ +
+Methods inherited from builtins.BaseException:
+
__getattribute__(self, name, /)
Return getattr(self, name).
+ +
__reduce__(self, /)
Helper for pickle.
+ +
__repr__(self, /)
Return repr(self).
+ +
__setstate__(self, object, /)
+ +
__str__(self, /)
Return str(self).
+ +
add_note(self, object, /)
Exception.add_note(note) --
+add a note to the exception
+ +
with_traceback(self, object, /)
Exception.with_traceback(tb) --
+set self.__traceback__ to tb and return self.
+ +
+Data descriptors inherited from builtins.BaseException:
+
__cause__
+
exception cause
+
+
__context__
+
exception context
+
+
__dict__
+
+
__suppress_context__
+
+
__traceback__
+
+
args
+
+

+ + + + + + + +
 
class AIAPIAuthenticatorInvalidRequestException(AIAPIAuthenticatorException)
   AIAPIAuthenticatorInvalidRequestException(error_message: str = None)
+ 
+Exception type that is raised by the :class:`ai_api_client_sdk.helpers.authenticator.Authenticator` if
+the XSUAA server responded with bad request when trying to retrieve a token
 
 
Method resolution order:
+
AIAPIAuthenticatorInvalidRequestException
+
AIAPIAuthenticatorException
+
AIAPIClientSDKException
+
builtins.Exception
+
builtins.BaseException
+
builtins.object
+
+
+Methods defined here:
+
__init__(self, error_message: str = None)
Initialize self.  See help(type(self)) for accurate signature.
+ +
+Data descriptors inherited from AIAPIClientSDKException:
+
__weakref__
+
list of weak references to the object
+
+
+Static methods inherited from builtins.Exception:
+
__new__(*args, **kwargs) class method of builtins.Exception
Create and return a new object.  See help(type) for accurate signature.
+ +
+Methods inherited from builtins.BaseException:
+
__getattribute__(self, name, /)
Return getattr(self, name).
+ +
__reduce__(self, /)
Helper for pickle.
+ +
__repr__(self, /)
Return repr(self).
+ +
__setstate__(self, object, /)
+ +
__str__(self, /)
Return str(self).
+ +
add_note(self, object, /)
Exception.add_note(note) --
+add a note to the exception
+ +
with_traceback(self, object, /)
Exception.with_traceback(tb) --
+set self.__traceback__ to tb and return self.
+ +
+Data descriptors inherited from builtins.BaseException:
+
__cause__
+
exception cause
+
+
__context__
+
exception context
+
+
__dict__
+
+
__suppress_context__
+
+
__traceback__
+
+
args
+
+

+ + + + + + + +
 
class AIAPIAuthenticatorMethodNotAllowedException(AIAPIAuthenticatorException)
   AIAPIAuthenticatorMethodNotAllowedException(error_message: str = None)
+ 
+Exception type that is raised by the :class:`ai_api_client_sdk.helpers.authenticator.Authenticator` if
+the XSUAA server responded with method not allowed when trying to retrieve a token
 
 
Method resolution order:
+
AIAPIAuthenticatorMethodNotAllowedException
+
AIAPIAuthenticatorException
+
AIAPIClientSDKException
+
builtins.Exception
+
builtins.BaseException
+
builtins.object
+
+
+Methods defined here:
+
__init__(self, error_message: str = None)
Initialize self.  See help(type(self)) for accurate signature.
+ +
+Data descriptors inherited from AIAPIClientSDKException:
+
__weakref__
+
list of weak references to the object
+
+
+Static methods inherited from builtins.Exception:
+
__new__(*args, **kwargs) class method of builtins.Exception
Create and return a new object.  See help(type) for accurate signature.
+ +
+Methods inherited from builtins.BaseException:
+
__getattribute__(self, name, /)
Return getattr(self, name).
+ +
__reduce__(self, /)
Helper for pickle.
+ +
__repr__(self, /)
Return repr(self).
+ +
__setstate__(self, object, /)
+ +
__str__(self, /)
Return str(self).
+ +
add_note(self, object, /)
Exception.add_note(note) --
+add a note to the exception
+ +
with_traceback(self, object, /)
Exception.with_traceback(tb) --
+set self.__traceback__ to tb and return self.
+ +
+Data descriptors inherited from builtins.BaseException:
+
__cause__
+
exception cause
+
+
__context__
+
exception context
+
+
__dict__
+
+
__suppress_context__
+
+
__traceback__
+
+
args
+
+

+ + + + + + + +
 
class AIAPIAuthenticatorServerException(AIAPIAuthenticatorException)
   AIAPIAuthenticatorServerException(
+    status_code: int = None,
+    error_message: str = None
+)
+ 
+Exception type that is raised by the :class:`ai_api_client_sdk.helpers.authenticator.Authenticator` if
+the XSUAA server responded with server error when trying to retrieve a token
 
 
Method resolution order:
+
AIAPIAuthenticatorServerException
+
AIAPIAuthenticatorException
+
AIAPIClientSDKException
+
builtins.Exception
+
builtins.BaseException
+
builtins.object
+
+
+Methods defined here:
+
__init__(self, status_code: int = None, error_message: str = None)
Initialize self.  See help(type(self)) for accurate signature.
+ +
+Data descriptors inherited from AIAPIClientSDKException:
+
__weakref__
+
list of weak references to the object
+
+
+Static methods inherited from builtins.Exception:
+
__new__(*args, **kwargs) class method of builtins.Exception
Create and return a new object.  See help(type) for accurate signature.
+ +
+Methods inherited from builtins.BaseException:
+
__getattribute__(self, name, /)
Return getattr(self, name).
+ +
__reduce__(self, /)
Helper for pickle.
+ +
__repr__(self, /)
Return repr(self).
+ +
__setstate__(self, object, /)
+ +
__str__(self, /)
Return str(self).
+ +
add_note(self, object, /)
Exception.add_note(note) --
+add a note to the exception
+ +
with_traceback(self, object, /)
Exception.with_traceback(tb) --
+set self.__traceback__ to tb and return self.
+ +
+Data descriptors inherited from builtins.BaseException:
+
__cause__
+
exception cause
+
+
__context__
+
exception context
+
+
__dict__
+
+
__suppress_context__
+
+
__traceback__
+
+
args
+
+

+ + + + + + + +
 
class AIAPIAuthenticatorTimeoutException(AIAPIAuthenticatorException)
   AIAPIAuthenticatorTimeoutException(error_message: str = None)
+ 
+Exception type that is raised by the :class:`ai_api_client_sdk.helpers.authenticator.Authenticator` if
+the XSUAA server responded with request timeout when trying to retrieve a token
 
 
Method resolution order:
+
AIAPIAuthenticatorTimeoutException
+
AIAPIAuthenticatorException
+
AIAPIClientSDKException
+
builtins.Exception
+
builtins.BaseException
+
builtins.object
+
+
+Methods defined here:
+
__init__(self, error_message: str = None)
Initialize self.  See help(type(self)) for accurate signature.
+ +
+Data descriptors inherited from AIAPIClientSDKException:
+
__weakref__
+
list of weak references to the object
+
+
+Static methods inherited from builtins.Exception:
+
__new__(*args, **kwargs) class method of builtins.Exception
Create and return a new object.  See help(type) for accurate signature.
+ +
+Methods inherited from builtins.BaseException:
+
__getattribute__(self, name, /)
Return getattr(self, name).
+ +
__reduce__(self, /)
Helper for pickle.
+ +
__repr__(self, /)
Return repr(self).
+ +
__setstate__(self, object, /)
+ +
__str__(self, /)
Return str(self).
+ +
add_note(self, object, /)
Exception.add_note(note) --
+add a note to the exception
+ +
with_traceback(self, object, /)
Exception.with_traceback(tb) --
+set self.__traceback__ to tb and return self.
+ +
+Data descriptors inherited from builtins.BaseException:
+
__cause__
+
exception cause
+
+
__context__
+
exception context
+
+
__dict__
+
+
__suppress_context__
+
+
__traceback__
+
+
args
+
+

+ + + + + + + +
 
class AIAPIAuthorizationException(AIAPIServerException)
   AIAPIAuthorizationException(
+    description: str,
+    error_message: str,
+    error_code: str = None,
+    request_id: str = None,
+    details: dict = None
+)
+ 
+Exception type that is raised by the :class:`ai_api_client_sdk.helpers.rest_client.RestClient` if a 401 response
+is received from the server. This extends the :class:`ai_api_client_sdk.exception.AIAPIServerException`, refer there
+for object definition
 
 
Method resolution order:
+
AIAPIAuthorizationException
+
AIAPIServerException
+
builtins.Exception
+
builtins.BaseException
+
builtins.object
+
+
+Methods defined here:
+
__init__( + self, + description: str, + error_message: str, + error_code: str = None, + request_id: str = None, + details: dict = None +)
Initialize self.  See help(type(self)) for accurate signature.
+ +
+Methods inherited from AIAPIServerException:
+
__str__(self)
Return str(self).
+ +
+Data descriptors inherited from AIAPIServerException:
+
__weakref__
+
list of weak references to the object
+
+
+Static methods inherited from builtins.Exception:
+
__new__(*args, **kwargs) class method of builtins.Exception
Create and return a new object.  See help(type) for accurate signature.
+ +
+Methods inherited from builtins.BaseException:
+
__getattribute__(self, name, /)
Return getattr(self, name).
+ +
__reduce__(self, /)
Helper for pickle.
+ +
__repr__(self, /)
Return repr(self).
+ +
__setstate__(self, object, /)
+ +
add_note(self, object, /)
Exception.add_note(note) --
+add a note to the exception
+ +
with_traceback(self, object, /)
Exception.with_traceback(tb) --
+set self.__traceback__ to tb and return self.
+ +
+Data descriptors inherited from builtins.BaseException:
+
__cause__
+
exception cause
+
+
__context__
+
exception context
+
+
__dict__
+
+
__suppress_context__
+
+
__traceback__
+
+
args
+
+

+ + + + + + + +
 
class AIAPIClientSDKException(builtins.Exception)
   AIAPIClientSDKException(
+    description: str,
+    status_code: int = None,
+    error_message: str = None
+)
+ 
+Base Exception class for AI API Client SDK exceptions
 
 
Method resolution order:
+
AIAPIClientSDKException
+
builtins.Exception
+
builtins.BaseException
+
builtins.object
+
+
+Methods defined here:
+
__init__( + self, + description: str, + status_code: int = None, + error_message: str = None +)
Initialize self.  See help(type(self)) for accurate signature.
+ +
+Data descriptors defined here:
+
__weakref__
+
list of weak references to the object
+
+
+Static methods inherited from builtins.Exception:
+
__new__(*args, **kwargs) class method of builtins.Exception
Create and return a new object.  See help(type) for accurate signature.
+ +
+Methods inherited from builtins.BaseException:
+
__getattribute__(self, name, /)
Return getattr(self, name).
+ +
__reduce__(self, /)
Helper for pickle.
+ +
__repr__(self, /)
Return repr(self).
+ +
__setstate__(self, object, /)
+ +
__str__(self, /)
Return str(self).
+ +
add_note(self, object, /)
Exception.add_note(note) --
+add a note to the exception
+ +
with_traceback(self, object, /)
Exception.with_traceback(tb) --
+set self.__traceback__ to tb and return self.
+ +
+Data descriptors inherited from builtins.BaseException:
+
__cause__
+
exception cause
+
+
__context__
+
exception context
+
+
__dict__
+
+
__suppress_context__
+
+
__traceback__
+
+
args
+
+

+ + + + + + + +
 
class AIAPIInvalidInputException(AIAPIClientSDKException)
   AIAPIInvalidInputException(description: str)
+ 
+Exception type raised, when the provided input is invalid
 
 
Method resolution order:
+
AIAPIInvalidInputException
+
AIAPIClientSDKException
+
builtins.Exception
+
builtins.BaseException
+
builtins.object
+
+
+Methods defined here:
+
__init__(self, description: str)
Initialize self.  See help(type(self)) for accurate signature.
+ +
+Data descriptors inherited from AIAPIClientSDKException:
+
__weakref__
+
list of weak references to the object
+
+
+Static methods inherited from builtins.Exception:
+
__new__(*args, **kwargs) class method of builtins.Exception
Create and return a new object.  See help(type) for accurate signature.
+ +
+Methods inherited from builtins.BaseException:
+
__getattribute__(self, name, /)
Return getattr(self, name).
+ +
__reduce__(self, /)
Helper for pickle.
+ +
__repr__(self, /)
Return repr(self).
+ +
__setstate__(self, object, /)
+ +
__str__(self, /)
Return str(self).
+ +
add_note(self, object, /)
Exception.add_note(note) --
+add a note to the exception
+ +
with_traceback(self, object, /)
Exception.with_traceback(tb) --
+set self.__traceback__ to tb and return self.
+ +
+Data descriptors inherited from builtins.BaseException:
+
__cause__
+
exception cause
+
+
__context__
+
exception context
+
+
__dict__
+
+
__suppress_context__
+
+
__traceback__
+
+
args
+
+

+ + + + + + + +
 
class AIAPIInvalidRequestException(AIAPIServerException)
   AIAPIInvalidRequestException(
+    description: str,
+    error_code: str,
+    error_message: str,
+    request_id: str,
+    details: dict = None
+)
+ 
+Exception type that is raised by the :class:`ai_api_client_sdk.helpers.rest_client.RestClient` if a 400 response
+is received from the server. This extends the :class:`ai_api_client_sdk.exception.AIAPIServerException`, refer there
+for object definition
 
 
Method resolution order:
+
AIAPIInvalidRequestException
+
AIAPIServerException
+
builtins.Exception
+
builtins.BaseException
+
builtins.object
+
+
+Methods defined here:
+
__init__( + self, + description: str, + error_code: str, + error_message: str, + request_id: str, + details: dict = None +)
Initialize self.  See help(type(self)) for accurate signature.
+ +
+Methods inherited from AIAPIServerException:
+
__str__(self)
Return str(self).
+ +
+Data descriptors inherited from AIAPIServerException:
+
__weakref__
+
list of weak references to the object
+
+
+Static methods inherited from builtins.Exception:
+
__new__(*args, **kwargs) class method of builtins.Exception
Create and return a new object.  See help(type) for accurate signature.
+ +
+Methods inherited from builtins.BaseException:
+
__getattribute__(self, name, /)
Return getattr(self, name).
+ +
__reduce__(self, /)
Helper for pickle.
+ +
__repr__(self, /)
Return repr(self).
+ +
__setstate__(self, object, /)
+ +
add_note(self, object, /)
Exception.add_note(note) --
+add a note to the exception
+ +
with_traceback(self, object, /)
Exception.with_traceback(tb) --
+set self.__traceback__ to tb and return self.
+ +
+Data descriptors inherited from builtins.BaseException:
+
__cause__
+
exception cause
+
+
__context__
+
exception context
+
+
__dict__
+
+
__suppress_context__
+
+
__traceback__
+
+
args
+
+

+ + + + + + + +
 
class AIAPINotFoundException(AIAPIServerException)
   AIAPINotFoundException(
+    description: str,
+    error_code: str,
+    error_message: str,
+    request_id: str,
+    details: dict = None
+)
+ 
+Exception type that is raised by the :class:`ai_api_client_sdk.helpers.rest_client.RestClient` if a 404 response
+is received from the server. This extends the :class:`ai_api_client_sdk.exception.AIAPIServerException`, refer there
+for object definition
 
 
Method resolution order:
+
AIAPINotFoundException
+
AIAPIServerException
+
builtins.Exception
+
builtins.BaseException
+
builtins.object
+
+
+Methods defined here:
+
__init__( + self, + description: str, + error_code: str, + error_message: str, + request_id: str, + details: dict = None +)
Initialize self.  See help(type(self)) for accurate signature.
+ +
+Methods inherited from AIAPIServerException:
+
__str__(self)
Return str(self).
+ +
+Data descriptors inherited from AIAPIServerException:
+
__weakref__
+
list of weak references to the object
+
+
+Static methods inherited from builtins.Exception:
+
__new__(*args, **kwargs) class method of builtins.Exception
Create and return a new object.  See help(type) for accurate signature.
+ +
+Methods inherited from builtins.BaseException:
+
__getattribute__(self, name, /)
Return getattr(self, name).
+ +
__reduce__(self, /)
Helper for pickle.
+ +
__repr__(self, /)
Return repr(self).
+ +
__setstate__(self, object, /)
+ +
add_note(self, object, /)
Exception.add_note(note) --
+add a note to the exception
+ +
with_traceback(self, object, /)
Exception.with_traceback(tb) --
+set self.__traceback__ to tb and return self.
+ +
+Data descriptors inherited from builtins.BaseException:
+
__cause__
+
exception cause
+
+
__context__
+
exception context
+
+
__dict__
+
+
__suppress_context__
+
+
__traceback__
+
+
args
+
+

+ + + + + + + +
 
class AIAPIPreconditionFailedException(AIAPIServerException)
   AIAPIPreconditionFailedException(
+    description: str,
+    error_code: str,
+    error_message: str,
+    request_id: str,
+    details: dict = None
+)
+ 
+Exception type that is raised by the :class:`ai_api_client_sdk.helpers.rest_client.RestClient` if a 412 response
+is received from the server. This extends the :class:`ai_api_client_sdk.exception.AIAPIServerException`, refer there
+for object definition
 
 
Method resolution order:
+
AIAPIPreconditionFailedException
+
AIAPIServerException
+
builtins.Exception
+
builtins.BaseException
+
builtins.object
+
+
+Methods defined here:
+
__init__( + self, + description: str, + error_code: str, + error_message: str, + request_id: str, + details: dict = None +)
Initialize self.  See help(type(self)) for accurate signature.
+ +
+Methods inherited from AIAPIServerException:
+
__str__(self)
Return str(self).
+ +
+Data descriptors inherited from AIAPIServerException:
+
__weakref__
+
list of weak references to the object
+
+
+Static methods inherited from builtins.Exception:
+
__new__(*args, **kwargs) class method of builtins.Exception
Create and return a new object.  See help(type) for accurate signature.
+ +
+Methods inherited from builtins.BaseException:
+
__getattribute__(self, name, /)
Return getattr(self, name).
+ +
__reduce__(self, /)
Helper for pickle.
+ +
__repr__(self, /)
Return repr(self).
+ +
__setstate__(self, object, /)
+ +
add_note(self, object, /)
Exception.add_note(note) --
+add a note to the exception
+ +
with_traceback(self, object, /)
Exception.with_traceback(tb) --
+set self.__traceback__ to tb and return self.
+ +
+Data descriptors inherited from builtins.BaseException:
+
__cause__
+
exception cause
+
+
__context__
+
exception context
+
+
__dict__
+
+
__suppress_context__
+
+
__traceback__
+
+
args
+
+

+ + + + + + + +
 
class AIAPIServerException(builtins.Exception)
   AIAPIServerException(
+    description: str,
+    status_code: int,
+    error_message: str,
+    error_code: str = None,
+    request_id: str = None,
+    details: dict = None
+)
+ 
+Exception type that is raised by the :class:`ai_api_client_sdk.helpers.rest_client.RestClient`, if a non-2XX
+response is received from the server.
+ 
+:param description: description of the exception
+:type description: str
+:param status_code: Status code of the response from the server
+:type status_code: int
+:param error_message: Error message received from the server
+:type error_message: str
+:param error_code: Error code received from the server, defaults to None
+:type error_code: str, optional
+:param request_id: ID of the request, the response belongs to, defaults to None
+:type request_id: str, optional
+:param details: Error details received from the server, defaults to None
+:type details: dict, optional
 
 
Method resolution order:
+
AIAPIServerException
+
builtins.Exception
+
builtins.BaseException
+
builtins.object
+
+
+Methods defined here:
+
__init__( + self, + description: str, + status_code: int, + error_message: str, + error_code: str = None, + request_id: str = None, + details: dict = None +)
Initialize self.  See help(type(self)) for accurate signature.
+ +
__str__(self)
Return str(self).
+ +
+Data descriptors defined here:
+
__weakref__
+
list of weak references to the object
+
+
+Static methods inherited from builtins.Exception:
+
__new__(*args, **kwargs) class method of builtins.Exception
Create and return a new object.  See help(type) for accurate signature.
+ +
+Methods inherited from builtins.BaseException:
+
__getattribute__(self, name, /)
Return getattr(self, name).
+ +
__reduce__(self, /)
Helper for pickle.
+ +
__repr__(self, /)
Return repr(self).
+ +
__setstate__(self, object, /)
+ +
add_note(self, object, /)
Exception.add_note(note) --
+add a note to the exception
+ +
with_traceback(self, object, /)
Exception.with_traceback(tb) --
+set self.__traceback__ to tb and return self.
+ +
+Data descriptors inherited from builtins.BaseException:
+
__cause__
+
exception cause
+
+
__context__
+
exception context
+
+
__dict__
+
+
__suppress_context__
+
+
__traceback__
+
+
args
+
+

+ \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.helpers.authenticator.html b/packages/base/docs/ai_api_client_sdk.helpers.authenticator.html new file mode 100644 index 0000000..1fbd98b --- /dev/null +++ b/packages/base/docs/ai_api_client_sdk.helpers.authenticator.html @@ -0,0 +1,110 @@ + + + + +Python: module ai_api_client_sdk.helpers.authenticator + + + + + +
 
ai_api_client_sdk.helpers.authenticator		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/helpers/authenticator.py
+

+

+ + + + + +
 
Modules
       
os
+		requests
+		tempfile
+		time
+

+ + + + + +
 
Classes
       
+
builtins.object +
+
+
Authenticator +
+
+
+

+ + + + + + + +
 
class Authenticator(builtins.object)
   Authenticator(
+    auth_url: str,
+    client_id: str,
+    client_secret: str = None,
+    cert_str: str = None,
+    key_str: str = None,
+    cert_file_path: str = None,
+    key_file_path: str = None
+)
+ 
+Authenticator class is implemented to retrieve and cache the authorization token from the xsuaa server
+ 
+:param auth_url: URL of the authorization endpoint. Should be the full URL (including /oauth/token)
+:type auth_url: str
+:param client_id: client id to be used for authorization
+:type client_id: str
+:param client_secret: client secret to be used for authorization, either client_secret or
+    (cert_file_path and key_file_path) need to be provided, defaults to None
+:type client_secret: str, optional
+:param cert_str: certificate file content, needs to be provided alongside the key_str parameter, defaults to None
+:type cert_str: str, optional
+:param key_str: key file content, needs to be provided alongside the cert_str parameter, defaults to None
+:type key_str: str, optional
+:param cert_file_path: path to the certificate file, needs to be provided alongside the key_file_path parameter,
+    defaults to None
+:type cert_file_path: str, optional
+:param key_file_path: path to the key file, needs to be provided alongside the cert_file_path parameter,
+    defaults to None
+:type key_file_path: str, optional
 
 Methods defined here:
+
__init__( + self, + auth_url: str, + client_id: str, + client_secret: str = None, + cert_str: str = None, + key_str: str = None, + cert_file_path: str = None, + key_file_path: str = None +)
Initialize self.  See help(type(self)) for accurate signature.
+ +
get_token(self) -> str
Retrieves the token from the xsuaa server or from cache when expiration date not reached.
+ 
+:raises: class:`ai_api_client_sdk.exception.AIAPIAuthenticatorException` if an unexpected exception occurs while
+    trying to retrieve the token
+:return: The Bearer token
+:rtype: str
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables
+
+
__weakref__
+
list of weak references to the object
+
+

+ + + + + +
 
Data
       BASE_DELAY_FOR_TOKEN_RETRY = 0.3
+MAX_RETRY_ATTEMPTS_FOR_TOKEN = 3
+Optional = typing.Optional
+PARAM_ERROR_MESSAGE = 'Either client_secret, or (cert_file_path, key_fi..., or (cert_str, key_str) pair need to be provided'
+ \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.helpers.constants.html b/packages/base/docs/ai_api_client_sdk.helpers.constants.html new file mode 100644 index 0000000..f9506f7 --- /dev/null +++ b/packages/base/docs/ai_api_client_sdk.helpers.constants.html @@ -0,0 +1,95 @@ + + + + +Python: module ai_api_client_sdk.helpers.constants + + + + + +
 
ai_api_client_sdk.helpers.constants		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/helpers/constants.py
+

+

+ + + + + +
 
Modules
       
re
+

+ + + + + +
 
Classes
       
+
enum.Enum(builtins.object) +
+
+
Timeouts +
+
+
+

+ + + + + + + +
 
class Timeouts(enum.Enum)
   Timeouts(*values)
+ 
+
 
 
Method resolution order:
+
Timeouts
+
enum.Enum
+
builtins.object
+
+
+Data and other attributes defined here:
+
NUM_REQUEST_RETRIES = <Timeouts.NUM_REQUEST_RETRIES: 3>
+ +
READ_TIMEOUT = <Timeouts.READ_TIMEOUT: 60>
+ +
+Data descriptors inherited from enum.Enum:
+
name
+
The name of the Enum member.
+
+
value
+
The value of the Enum member.
+
+
+Static methods inherited from enum.EnumType:
+
__contains__(value)
Return True if `value` is in `cls`.
+ 
+`value` is in `cls` if:
+1) `value` is a member of `cls`, or
+2) `value` is the value of one of the `cls`'s members.
+3) `value` is a pseudo-member (flags)
+ +
__getitem__(name)
Return the member matching `name`.
+ +
__iter__()
Return members in definition order.
+ +
__len__()
Return the number of members (no aliases)
+ +
+Readonly properties inherited from enum.EnumType:
+
__members__
+
Returns a mapping of member name->value.
+ 
+This mapping lists all enum members, including aliases.  Note that
+this is a read-only view of the internal mapping.
+
+

+ + + + + +
 
Data
       DEBUG_ENV_VAR_NAME = 'DEBUG'
+SCENARIO_LABEL_NAME_PATTERN = re.compile('^scenarios\\.ai\\.sap\\.com/[\\w.-]+$')
+SKIP_AUTH_ENV_VAR = 'SKIP_AUTHORIZATION'
+ \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.helpers.datetime_parser.html b/packages/base/docs/ai_api_client_sdk.helpers.datetime_parser.html new file mode 100644 index 0000000..8d1a273 --- /dev/null +++ b/packages/base/docs/ai_api_client_sdk.helpers.datetime_parser.html @@ -0,0 +1,30 @@ + + + + +Python: module ai_api_client_sdk.helpers.datetime_parser + + + + + +
 
ai_api_client_sdk.helpers.datetime_parser		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/helpers/datetime_parser.py
+

+

+ + + + + +
 
Functions
       
parse_datetime(datetime_str: str) -> datetime.datetime
+

+ + + + + +
 
Data
       DATETIME_FORMAT = '%Y-%m-%dT%H:%M:%SZ'
+DATETIME_FORMAT_36 = '%Y-%m-%dT%H:%M:%S+00:00'
+DATETIME_FORMAT_FLOAT = '%Y-%m-%dT%H:%M:%S.%fZ'
+DATETIME_FORMAT_FLOAT_TZ = '%Y-%m-%dT%H:%M:%S.%f+00:00'
+ \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.helpers.html b/packages/base/docs/ai_api_client_sdk.helpers.html new file mode 100644 index 0000000..bff6917 --- /dev/null +++ b/packages/base/docs/ai_api_client_sdk.helpers.html @@ -0,0 +1,26 @@ + + + + +Python: package ai_api_client_sdk.helpers + + + + + +
 
ai_api_client_sdk.helpers		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/helpers/__init__.py
+

+

+ + + + + +
 
Package Contents
       
authenticator
+constants
+		datetime_parser
+llm_helper
+		logging
+rest_client
+
+ \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.helpers.llm_helper.html b/packages/base/docs/ai_api_client_sdk.helpers.llm_helper.html new file mode 100644 index 0000000..452abea --- /dev/null +++ b/packages/base/docs/ai_api_client_sdk.helpers.llm_helper.html @@ -0,0 +1,32 @@ + + + + +Python: module ai_api_client_sdk.helpers.llm_helper + + + + + +
 
ai_api_client_sdk.helpers.llm_helper		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/helpers/llm_helper.py
+

+

+ + + + + +
 
Functions
       
check_if_llm_scenario(scenario)
+
filter_for_llm_scenarios(response_dict)
+
get_attr(obj, attr)
+

+ + + + + +
 
Data
       SCENARIO_LABEL_NAME_PATTERN = re.compile('^scenarios\\.ai\\.sap\\.com/[\\w.-]+$')
+get_key = functools.partial(get_attr, attr='key')
+get_labels = functools.partial(get_attr, attr='labels')
+get_value = functools.partial(get_attr, attr='value')
+ \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.helpers.logging.html b/packages/base/docs/ai_api_client_sdk.helpers.logging.html new file mode 100644 index 0000000..a3e4032 --- /dev/null +++ b/packages/base/docs/ai_api_client_sdk.helpers.logging.html @@ -0,0 +1,39 @@ + + + + +Python: module ai_api_client_sdk.helpers.logging + + + + + +
 
ai_api_client_sdk.helpers.logging		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/helpers/logging.py
+

+

+ + + + + +
 
Modules
       
logging
+		os
+

+ + + + + +
 
Functions
       
get_logger()
+
get_logger_name()
+
set_log_level(logger: logging.Logger)
+

+ + + + + +
 
Data
       DEBUG_ENV_VAR_NAME = 'DEBUG'
+DEFAULT_LOG_LEVEL = 20
+LOGGER_NAME = 'ai-api-client-sdk'
+ \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.helpers.rest_client.html b/packages/base/docs/ai_api_client_sdk.helpers.rest_client.html new file mode 100644 index 0000000..f78eac8 --- /dev/null +++ b/packages/base/docs/ai_api_client_sdk.helpers.rest_client.html @@ -0,0 +1,247 @@ + + + + +Python: module ai_api_client_sdk.helpers.rest_client + + + + + +
 
ai_api_client_sdk.helpers.rest_client		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/helpers/rest_client.py
+

+

+ + + + + +
 
Modules
       
humps
+		json
+		os
+		requests
+

+ + + + + +
 
Classes
       
+
builtins.object +
+
+
RestClient +
+
+
+

+ + + + + + + +
 
class RestClient(builtins.object)
   RestClient(
+    base_url: str,
+    get_token: Callable[[], str],
+    resource_group: str = None,
+    client_type: str = None,
+    read_timeout=60,
+    connect_timeout=60,
+    num_request_retries=3
+)
+ 
+RestClient is the class implemented for sending the requests to the server.
+ 
+:param base_url: Base URL of the server. Should include the base path as well. (i.e., "<base_url>/scenarios" should
+    work)
+:type base_url: str
+:param get_token: the function which returns the Bearer token, when called
+:type get_token: Callable[[], str]
+:param resource_group: The default resource group which will be used while sending the requests to the server,
+    defaults to None
+:type resource_group: str
+:param client_type: Used for Metering to distinguish eg AI Launchpad python SDKs etc,
+    defaults to None
+:type client_type: str
+:param read_timeout: Read timeout for requests in seconds, defaults to 60s
+:type read_timeout: int
+:param connect_timeout: Connect timeout for requests in seconds, defaults to 60s
+:type connect_timeout: int
+:param num_request_retries: Number of retries for failing requests with http status code 429, 500, 502, 503 or 504,
+    defaults to 60s
+:type num_request_retries: int
 
 Methods defined here:
+
__init__( + self, + base_url: str, + get_token: Callable[[], str], + resource_group: str = None, + client_type: str = None, + read_timeout=60, + connect_timeout=60, + num_request_retries=3 +)
Initialize self.  See help(type(self)) for accurate signature.
+ +
delete( + self, + path: str, + params: Dict[str, str] = None, + headers: Dict[str, str] = None, + resource_group: str = None, + **kwargs +) -> dict
Sends a DELETE request to the server.
+ 
+:param path: path of the endpoint the request should be sent to
+:type path: str
+:param params: parameters of the request, defaults to None
+:type params: Dict[str, str], optional
+:param headers: headers of the request, defaults to None
+:type headers: Dict[str, str], optional
+:param resource_group: Resource Group which the request should be sent on behalf. Either this, or the
+    resource_group property of this class should be set.
+:type resource_group: str
+:param kwargs: additional keyword arguments to be passed to the request e.g. files, stream, etc.
+:type kwargs: dict
+: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
+:return: The JSON response from the server (The keys decamelized)
+:rtype: dict
+ +
get( + self, + path: str, + params: Dict[str, str] = None, + headers: Dict[str, str] = None, + resource_group: str = None, + return_bytes_content: bool = False, + **kwargs +) -> Union[dict, int]
Sends a GET request to the server.
+ 
+:param path: path of the endpoint the request should be sent to
+:type path: str
+:param params: parameters of the request, defaults to None
+:type params: Dict[str, str], optional
+:param headers: headers of the request, defaults to None
+:type headers: Dict[str, str], optional
+:param resource_group: Resource Group which the request should be sent on behalf. Either this, or the
+    resource_group property of this class should be set.
+:type resource_group: str
+:param return_bytes_content: expected response.content is bytes
+:type return_bytes_content: bool
+:param kwargs: additional keyword arguments to be passed to the request e.g. files, stream, etc.
+:type kwargs: dict
+: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
+:return: The JSON response from the server (The keys decamelized)
+:rtype: Union[dict, int]
+ +
patch( + self, + path: str, + body: Dict[str, Union[str, dict, list]], + headers: Dict[str, str] = None, + resource_group: str = None, + **kwargs +) -> dict
Sends a PATCH request to the server.
+ 
+:param path: path of the endpoint the request should be sent to
+:type path: str
+:param body: body of the request
+:type body: Dict[str, Union[str, dict, list]]
+:param headers: headers of the request, defaults to None
+:type headers: Dict[str, str], optional
+:param resource_group: Resource Group which the request should be sent on behalf. Either this, or the
+    resource_group property of this class should be set.
+:type resource_group: str
+:param kwargs: additional keyword arguments to be passed to the request e.g. files, stream, etc.
+:type kwargs: dict
+: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
+:return: The JSON response from the server (The keys decamelized)
+:rtype: dict
+ +
post( + self, + path: str, + body: Dict[str, Union[str, dict]] = None, + headers: Dict[str, str] = None, + resource_group: str = None, + **kwargs +) -> dict
Sends a POST request to the server.
+ 
+:param path: path of the endpoint the request should be sent to
+:type path: str
+:param body: body of the request, defaults to None
+:type body: Dict[str, str], optional
+:param headers: headers of the request, defaults to None
+:type headers: Dict[str, str], optional
+:param resource_group: Resource Group which the request should be sent on behalf. Either this, or the
+    resource_group property of this class should be set.
+:type resource_group: str
+:param kwargs: additional keyword arguments to be passed to the request e.g. files, stream, etc.
+:type kwargs: dict
+: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
+:return: The JSON response from the server (The keys decamelized)
+:rtype: dict
+ +
+Static methods defined here:
+
raise_ai_api_exception(error_description, response, response_json)
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables
+
+
__weakref__
+
list of weak references to the object
+
+
+Data and other attributes defined here:
+
logger = <Logger ai-api-client-sdk (WARNING)>
+ +

+ + + + + +
 
Data
       Callable = typing.Callable
+Dict = typing.Dict
+SKIP_AUTH_ENV_VAR = 'SKIP_AUTHORIZATION'
+Union = typing.Union
+ \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.html b/packages/base/docs/ai_api_client_sdk.html new file mode 100644 index 0000000..374a56f --- /dev/null +++ b/packages/base/docs/ai_api_client_sdk.html @@ -0,0 +1,25 @@ + + + + +Python: package ai_api_client_sdk + + + + + +
 
ai_api_client_sdk		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/__init__.py
+

+

+ + + + + +
 
Package Contents
       
ai_api_v2_client
+exception
+		helpers (package)
+models (package)
+		resource_clients (package)
+
+ \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.ai_api_capabilities.html b/packages/base/docs/ai_api_client_sdk.models.ai_api_capabilities.html new file mode 100644 index 0000000..1cdccd4 --- /dev/null +++ b/packages/base/docs/ai_api_client_sdk.models.ai_api_capabilities.html @@ -0,0 +1,117 @@ + + + + +Python: module ai_api_client_sdk.models.ai_api_capabilities + + + + + +
 
ai_api_client_sdk.models.ai_api_capabilities		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/ai_api_capabilities.py
+

+

+ + + + + +
 
Classes
       
+
builtins.object +
+
+
AIAPICapabilities +
+
+
+

+ + + + + + + +
 
class AIAPICapabilities(builtins.object)
   AIAPICapabilities(
+    multitenant: bool = True,
+    shareable: bool = True,
+    static_deployments: bool = True,
+    user_deployments: bool = True,
+    time_to_live_deployments: bool = False,
+    user_executions: bool = True,
+    bulk_updates: ai_api_client_sdk.models.ai_api_capabilities_bulk_updates.AIAPICapabilitiesBulkUpdates = None,
+    execution_schedules: bool = False,
+    logs: ai_api_client_sdk.models.ai_api_capabilities_logs.AIAPICapabilitiesLogs = None,
+    **kwargs
+)
+ 
+The AIAPICapabilities object represent the capabilities of the AI API
+ 
+:param multitenant: indicates whether resource groups are supported, defaults to True
+:type multitenant: bool, optional
+:param shareable: indicates whether clients can share an instance, defaults to True
+:type shareable: bool, optional
+:param static_deployments: indicates whether the static, always running deployments are supported, defaults to True
+:type static_deployments: bool, optional
+:param user_deployments: indicates whether deployment creation by users are supported, defaults to True
+:type user_deployments: bool, optional
+:param time_to_live_deployments: indicate whether ttl value of deployment are supported, defaults to False
+:type time_to_live_deployments: bool, optional
+:param user_executions: indicates whether execution creation by users are supported, defaults to True
+:type user_executions: bool, optional
+:param bulk_updates: An object, defining the bulk updates capabilities, defaults to None
+:type bulk_updates: class:`ai_api_client_sdk.models.ai_api_capabilities_bulk_updates.AIAPICapabilitiesBulkUpdates`,
+ optional
+:param execution_schedules: indicates whether execution schedules are supported, defaults to False
+:type execution_schedules: bool, optional
+:param logs: An object, defining the logs capabilities, defaults to None
+:type logs: class:`ai_api_client_sdk.models.ai_api_capabilities_logs.AIAPICapabilitiesLogs`, optional
+:param `**kwargs`: The keyword arguments are there in case there are additional attributes returned from server
 
 Methods defined here:
+
__eq__(self, other)
Return self==value.
+ +
__init__( + self, + multitenant: bool = True, + shareable: bool = True, + static_deployments: bool = True, + user_deployments: bool = True, + time_to_live_deployments: bool = False, + user_executions: bool = True, + bulk_updates: ai_api_client_sdk.models.ai_api_capabilities_bulk_updates.AIAPICapabilitiesBulkUpdates = None, + execution_schedules: bool = False, + logs: ai_api_client_sdk.models.ai_api_capabilities_logs.AIAPICapabilitiesLogs = None, + **kwargs +)
Initialize self.  See help(type(self)) for accurate signature.
+ +
__str__(self)
Return str(self).
+ +
+Static methods defined here:
+
from_dict(ai_api_capabilities_dict: Dict[str, Any])
Returns a :class:`ai_api_client_sdk.models.ai_api_capabilities.AIAPICapabilities` object, created from the
+values in the dict provided as parameter
+ 
+:param ai_api_capabilities_dict: Dict which includes the necessary values to create the object
+:type ai_api_capabilities_dict: Dict[str, Any]
+:return: An object, created from the values provided
+:rtype: class:`ai_api_client_sdk.models.ai_api_capabilities.AIAPICapabilities`
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables
+
+
__weakref__
+
list of weak references to the object
+
+
+Data and other attributes defined here:
+
__hash__ = None
+ +

+ + + + + +
 
Data
       Dict = typing.Dict
+ \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.ai_api_capabilities_bulk_updates.html b/packages/base/docs/ai_api_client_sdk.models.ai_api_capabilities_bulk_updates.html new file mode 100644 index 0000000..a66d2fb --- /dev/null +++ b/packages/base/docs/ai_api_client_sdk.models.ai_api_capabilities_bulk_updates.html @@ -0,0 +1,83 @@ + + + + +Python: module ai_api_client_sdk.models.ai_api_capabilities_bulk_updates + + + + + +
 
ai_api_client_sdk.models.ai_api_capabilities_bulk_updates		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/ai_api_capabilities_bulk_updates.py
+

+

+ + + + + +
 
Classes
       
+
builtins.object +
+
+
AIAPICapabilitiesBulkUpdates +
+
+
+

+ + + + + + + +
 
class AIAPICapabilitiesBulkUpdates(builtins.object)
   AIAPICapabilitiesBulkUpdates(
+    executions: bool = False,
+    deployments: bool = False,
+    **kwargs
+)
+ 
+The AIAPICapabilitiesBulkUpdates object represents the bulk updates capabilities
+ 
+:param deployments: indicates whether bulk updates for executions are supported, defaults to False
+:type deployments: bool, optional
+:param executions: indicates whether bulk updates for executions are supported, defaults to False
+:type executions: bool, optional
+:param `**kwargs`: The keyword arguments are there in case there are additional attributes returned from server
 
 Methods defined here:
+
__eq__(self, other)
Return self==value.
+ +
__init__(self, executions: bool = False, deployments: bool = False, **kwargs)
Initialize self.  See help(type(self)) for accurate signature.
+ +
__str__(self)
Return str(self).
+ +
+Static methods defined here:
+
from_dict(ai_api_capabilities_bulk_updates_dict: Dict[str, bool])
Returns a :class:`ai_api_client_sdk.models.ai_api_capabilities_bulk_updates.AIAPICapabilitiesBulkUpdates` object, created
+from the values in the dict provided as parameter
+ 
+:param ai_api_capabilities_bulk_updates_dict: Dict which includes the necessary values to create the object
+:type ai_api_capabilities_bulk_updates_dict: Dict[str, bool]
+:return: An object, created from the values provided
+:rtype: class:`ai_api_client_sdk.models.ai_api_capabilities_bulk_updates.AIAPICapabilitiesBulkUpdates`
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables
+
+
__weakref__
+
list of weak references to the object
+
+
+Data and other attributes defined here:
+
__hash__ = None
+ +

+ + + + + +
 
Data
       Dict = typing.Dict
+ \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.ai_api_capabilities_logs.html b/packages/base/docs/ai_api_client_sdk.models.ai_api_capabilities_logs.html new file mode 100644 index 0000000..cb6f4d8 --- /dev/null +++ b/packages/base/docs/ai_api_client_sdk.models.ai_api_capabilities_logs.html @@ -0,0 +1,83 @@ + + + + +Python: module ai_api_client_sdk.models.ai_api_capabilities_logs + + + + + +
 
ai_api_client_sdk.models.ai_api_capabilities_logs		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/ai_api_capabilities_logs.py
+

+

+ + + + + +
 
Classes
       
+
builtins.object +
+
+
AIAPICapabilitiesLogs +
+
+
+

+ + + + + + + +
 
class AIAPICapabilitiesLogs(builtins.object)
   AIAPICapabilitiesLogs(
+    executions: bool = True,
+    deployments: bool = True,
+    **kwargs
+)
+ 
+The AIAPICapabilitiesLogs object represents the log capabilities
+ 
+:param user_executions: indicates whether logs for executions are supported, defaults to True
+:type user_executions: bool, optional
+:param user_deployments: indicates whether logs for deployments are supported, defaults to True
+:type user_deployments: bool, optional
+:param `**kwargs`: The keyword arguments are there in case there are additional attributes returned from server
 
 Methods defined here:
+
__eq__(self, other)
Return self==value.
+ +
__init__(self, executions: bool = True, deployments: bool = True, **kwargs)
Initialize self.  See help(type(self)) for accurate signature.
+ +
__str__(self)
Return str(self).
+ +
+Static methods defined here:
+
from_dict(ai_api_capabilities_logs_dict: Dict[str, bool])
Returns a :class:`ai_api_client_sdk.models.ai_api_capabilities_logs.AIAPICapabilitiesLogs` object, created
+from the values in the dict provided as parameter
+ 
+:param ai_api_capabilities_logs_dict: Dict which includes the necessary values to create the object
+:type ai_api_capabilities_logs_dict: Dict[str, bool]
+:return: An object, created from the values provided
+:rtype: class:`ai_api_client_sdk.models.ai_api_capabilities_logs.AIAPICapabilitiesLogs`
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables
+
+
__weakref__
+
list of weak references to the object
+
+
+Data and other attributes defined here:
+
__hash__ = None
+ +

+ + + + + +
 
Data
       Dict = typing.Dict
+ \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.ai_api_limits.html b/packages/base/docs/ai_api_client_sdk.models.ai_api_limits.html new file mode 100644 index 0000000..457eed7 --- /dev/null +++ b/packages/base/docs/ai_api_client_sdk.models.ai_api_limits.html @@ -0,0 +1,88 @@ + + + + +Python: module ai_api_client_sdk.models.ai_api_limits + + + + + +
 
ai_api_client_sdk.models.ai_api_limits		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/ai_api_limits.py
+

+

+ + + + + +
 
Classes
       
+
builtins.object +
+
+
AIAPILimits +
+
+
+

+ + + + + + + +
 
class AIAPILimits(builtins.object)
   AIAPILimits(
+    executions: ai_api_client_sdk.models.ai_api_limits_executions.AIAPILimitsExecutions = None,
+    deployments: ai_api_client_sdk.models.ai_api_limits_deployments.AIAPILimitsDeployments = None,
+    **kwargs
+)
+ 
+The AIAPILimits object represents the the limits for executions and deployments
+ 
+:param executions: represents the limits for executions, defaults to None
+:type executions: class:`ai_api_client_sdk.models.ai_api_limits_executions.AIAPILimitsExecutions`, optional
+:param deployments: represents the limits for deployments, defaults to None
+:type deployments: class:`ai_api_client_sdk.models.ai_api_limits_deployments.AIAPILimitsDeployments`, optional
+:param `**kwargs`: The keyword arguments are there in case there are additional attributes returned from server
 
 Methods defined here:
+
__eq__(self, other)
Return self==value.
+ +
__init__( + self, + executions: ai_api_client_sdk.models.ai_api_limits_executions.AIAPILimitsExecutions = None, + deployments: ai_api_client_sdk.models.ai_api_limits_deployments.AIAPILimitsDeployments = None, + **kwargs +)
Initialize self.  See help(type(self)) for accurate signature.
+ +
__str__(self)
Return str(self).
+ +
+Static methods defined here:
+
from_dict(ai_api_limits_dict: Dict[str, Any])
Returns a :class:`ai_api_client_sdk.models.ai_api_limits.AIAPILimits` object, created from the values in the
+dict provided as parameter
+ 
+:param ai_api_limits_dict: Dict which includes the necessary values to create the object
+:type ai_api_limits_dict: Dict[str, Any]
+:return: An object, created from the values provided
+:rtype: class:`ai_api_client_sdk.models.ai_api_limits.AIAPILimits`
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables
+
+
__weakref__
+
list of weak references to the object
+
+
+Data and other attributes defined here:
+
__hash__ = None
+ +

+ + + + + +
 
Data
       Dict = typing.Dict
+ \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.ai_api_limits_deployments.html b/packages/base/docs/ai_api_client_sdk.models.ai_api_limits_deployments.html new file mode 100644 index 0000000..4a4b356 --- /dev/null +++ b/packages/base/docs/ai_api_client_sdk.models.ai_api_limits_deployments.html @@ -0,0 +1,85 @@ + + + + +Python: module ai_api_client_sdk.models.ai_api_limits_deployments + + + + + +
 
ai_api_client_sdk.models.ai_api_limits_deployments		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/ai_api_limits_deployments.py
+

+

+ + + + + +
 
Classes
       
+
ai_api_client_sdk.models.ai_api_limits_enactments.AIAPILimitsEnactments(builtins.object) +
+
+
AIAPILimitsDeployments +
+
+
+

+ + + + + + + +
 
class AIAPILimitsDeployments(ai_api_client_sdk.models.ai_api_limits_enactments.AIAPILimitsEnactments)
   AIAPILimitsDeployments(max_running_count: int = -1, **kwargs)
+ 
+The AIAPILimitsDeployments object represents the the limits for deployments
+ 
+:param max_running_count: max number of deployments per resource group, <0 means unlimited, defaults to -1
+:type max_running_count: int, optional
+:param `**kwargs`: The keyword arguments are there in case there are additional attributes returned from server
 
 
Method resolution order:
+
AIAPILimitsDeployments
+
ai_api_client_sdk.models.ai_api_limits_enactments.AIAPILimitsEnactments
+
builtins.object
+
+
+Methods defined here:
+
__init__(self, max_running_count: int = -1, **kwargs)
Initialize self.  See help(type(self)) for accurate signature.
+ +
__str__(self)
Return str(self).
+ +
+Static methods defined here:
+
from_dict(ai_api_limits_deployments_dict: Dict[str, int])
Returns a :class:`ai_api_client_sdk.models.ai_api_limits_deployments.AIAPILimitsDeployments` object, created
+from the values in the dict provided as parameter
+ 
+:param ai_api_limits_deployments_dict: Dict which includes the necessary values to create the object
+:type ai_api_limits_deployments_dict: Dict[str, int]
+:return: An object, created from the values provided
+:rtype: class:`ai_api_client_sdk.models.ai_api_limits_deployments.AIAPILimitsDeployments`
+ +
+Methods inherited from ai_api_client_sdk.models.ai_api_limits_enactments.AIAPILimitsEnactments:
+
__eq__(self, other)
Return self==value.
+ +
+Data descriptors inherited from ai_api_client_sdk.models.ai_api_limits_enactments.AIAPILimitsEnactments:
+
__dict__
+
dictionary for instance variables
+
+
__weakref__
+
list of weak references to the object
+
+
+Data and other attributes inherited from ai_api_client_sdk.models.ai_api_limits_enactments.AIAPILimitsEnactments:
+
__hash__ = None
+ +

+ + + + + +
 
Data
       Dict = typing.Dict
+ \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.ai_api_limits_enactments.html b/packages/base/docs/ai_api_client_sdk.models.ai_api_limits_enactments.html new file mode 100644 index 0000000..5afce7d --- /dev/null +++ b/packages/base/docs/ai_api_client_sdk.models.ai_api_limits_enactments.html @@ -0,0 +1,62 @@ + + + + +Python: module ai_api_client_sdk.models.ai_api_limits_enactments + + + + + +
 
ai_api_client_sdk.models.ai_api_limits_enactments		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/ai_api_limits_enactments.py
+

+

+ + + + + +
 
Classes
       
+
builtins.object +
+
+
AIAPILimitsEnactments +
+
+
+

+ + + + + + + +
 
class AIAPILimitsEnactments(builtins.object)
   AIAPILimitsEnactments(max_running_count: int = -1, **kwargs)
+ 
+The AIAPILimitsEnactments object represents the the limits for enactments (common for both executions
+and deployments)
+ 
+:param max_running_count: max number of enactments per resource group, <0 means unlimited, defaults to -1
+:type max_running_count: int, optional
+:param `**kwargs`: The keyword arguments are there in case there are additional attributes returned from server
 
 Methods defined here:
+
__eq__(self, other)
Return self==value.
+ +
__init__(self, max_running_count: int = -1, **kwargs)
Initialize self.  See help(type(self)) for accurate signature.
+ +
__str__(self)
Return str(self).
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables
+
+
__weakref__
+
list of weak references to the object
+
+
+Data and other attributes defined here:
+
__hash__ = None
+ +

+ \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.ai_api_limits_executions.html b/packages/base/docs/ai_api_client_sdk.models.ai_api_limits_executions.html new file mode 100644 index 0000000..2662a10 --- /dev/null +++ b/packages/base/docs/ai_api_client_sdk.models.ai_api_limits_executions.html @@ -0,0 +1,85 @@ + + + + +Python: module ai_api_client_sdk.models.ai_api_limits_executions + + + + + +
 
ai_api_client_sdk.models.ai_api_limits_executions		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/ai_api_limits_executions.py
+

+

+ + + + + +
 
Classes
       
+
ai_api_client_sdk.models.ai_api_limits_enactments.AIAPILimitsEnactments(builtins.object) +
+
+
AIAPILimitsExecutions +
+
+
+

+ + + + + + + +
 
class AIAPILimitsExecutions(ai_api_client_sdk.models.ai_api_limits_enactments.AIAPILimitsEnactments)
   AIAPILimitsExecutions(max_running_count: int = -1, **kwargs)
+ 
+The AIAPILimitsExecutions object represents the the limits for executions
+ 
+:param max_running_count: max number of executions per resource group, <0 means unlimited, defaults to -1
+:type max_running_count: int, optional
+:param `**kwargs`: The keyword arguments are there in case there are additional attributes returned from server
 
 
Method resolution order:
+
AIAPILimitsExecutions
+
ai_api_client_sdk.models.ai_api_limits_enactments.AIAPILimitsEnactments
+
builtins.object
+
+
+Methods defined here:
+
__init__(self, max_running_count: int = -1, **kwargs)
Initialize self.  See help(type(self)) for accurate signature.
+ +
__str__(self)
Return str(self).
+ +
+Static methods defined here:
+
from_dict(ai_api_limits_executions_dict: Dict[str, int])
Returns a :class:`ai_api_client_sdk.models.ai_api_limits_executions.AIAPILimitsExecutions` object, created
+from the values in the dict provided as parameter
+ 
+:param ai_api_limits_executions_dict: Dict which includes the necessary values to create the object
+:type ai_api_limits_executions_dict: Dict[str, int]
+:return: An object, created from the values provided
+:rtype: class:`ai_api_client_sdk.models.ai_api_limits_executions.AIAPILimitsExecutions`
+ +
+Methods inherited from ai_api_client_sdk.models.ai_api_limits_enactments.AIAPILimitsEnactments:
+
__eq__(self, other)
Return self==value.
+ +
+Data descriptors inherited from ai_api_client_sdk.models.ai_api_limits_enactments.AIAPILimitsEnactments:
+
__dict__
+
dictionary for instance variables
+
+
__weakref__
+
list of weak references to the object
+
+
+Data and other attributes inherited from ai_api_client_sdk.models.ai_api_limits_enactments.AIAPILimitsEnactments:
+
__hash__ = None
+ +

+ + + + + +
 
Data
       Dict = typing.Dict
+ \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.ai_api_meta.html b/packages/base/docs/ai_api_client_sdk.models.ai_api_meta.html new file mode 100644 index 0000000..277b382 --- /dev/null +++ b/packages/base/docs/ai_api_client_sdk.models.ai_api_meta.html @@ -0,0 +1,92 @@ + + + + +Python: module ai_api_client_sdk.models.ai_api_meta + + + + + +
 
ai_api_client_sdk.models.ai_api_meta		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/ai_api_meta.py
+

+

+ + + + + +
 
Classes
       
+
builtins.object +
+
+
AIAPIMeta +
+
+
+

+ + + + + + + +
 
class AIAPIMeta(builtins.object)
   AIAPIMeta(
+    version: str,
+    capabilities: ai_api_client_sdk.models.ai_api_capabilities.AIAPICapabilities = None,
+    limits: ai_api_client_sdk.models.ai_api_limits.AIAPILimits = None,
+    **kwargs
+)
+ 
+The AIAPIMeta object represents the metadata and capabilities of the AI API
+ 
+:param version: version of the AI API
+:type version: str
+:param capabilities: capabilities of AI API, defaults to None
+:type capabilities: class:`ai_api_client_sdk.models.ai_api_capabilities.AIAPICapabilities`
+:param limits: limits of AI API, defaults to None
+:type limits: class:`ai_api_client_sdk.models.ai_api_limits.AIAPILimits`, optional
+:param `**kwargs`: The keyword arguments are there in case there are additional attributes returned from server
 
 Methods defined here:
+
__eq__(self, other)
Return self==value.
+ +
__init__( + self, + version: str, + capabilities: ai_api_client_sdk.models.ai_api_capabilities.AIAPICapabilities = None, + limits: ai_api_client_sdk.models.ai_api_limits.AIAPILimits = None, + **kwargs +)
Initialize self.  See help(type(self)) for accurate signature.
+ +
__str__(self)
Return str(self).
+ +
+Static methods defined here:
+
from_dict(ai_api_meta_dict: Dict[str, Any])
Returns a :class:`ai_api_client_sdk.models.ai_api_meta.AIAPIMeta` object, created
+from the values in the dict provided as parameter
+ 
+:param ai_api_meta_dict: Dict which includes the necessary values to create the object
+:type ai_api_meta_dict: Dict[str, Any]
+:return: An object, created from the values provided
+:rtype: class:`ai_api_client_sdk.models.ai_api_meta.AIAPIMeta`
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables
+
+
__weakref__
+
list of weak references to the object
+
+
+Data and other attributes defined here:
+
__hash__ = None
+ +

+ + + + + +
 
Data
       Dict = typing.Dict
+ \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.api_version.html b/packages/base/docs/ai_api_client_sdk.models.api_version.html new file mode 100644 index 0000000..5cb237d --- /dev/null +++ b/packages/base/docs/ai_api_client_sdk.models.api_version.html @@ -0,0 +1,92 @@ + + + + +Python: module ai_api_client_sdk.models.api_version + + + + + +
 
ai_api_client_sdk.models.api_version		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/api_version.py
+

+

+ + + + + +
 
Classes
       
+
builtins.object +
+
+
APIVersion +
+
+
+

+ + + + + + + +
 
class APIVersion(builtins.object)
   APIVersion(
+    version_id: str = None,
+    url: str = None,
+    description: str = None,
+    **kwargs
+)
+ 
+The APIVersion object represents the description of an API version
+ 
+:param version_id: API version identifier, defaults to None
+:type version_id: str, optional
+:param url: URL of the API version, defaults to None
+:type url: str, optional
+:param description: API version description
+:type description: str, optional
+:param `**kwargs`: The keyword arguments are there in case there are additional attributes returned from server
 
 Methods defined here:
+
__eq__(self, other)
Return self==value.
+ +
__init__( + self, + version_id: str = None, + url: str = None, + description: str = None, + **kwargs +)
Initialize self.  See help(type(self)) for accurate signature.
+ +
__str__(self)
Return str(self).
+ +
+Static methods defined here:
+
from_dict(api_version_dict: Dict[str, str])
Returns a :class:`ai_api_client_sdk.models.api_version.APIVersion` object, created from the
+values in the dict provided as parameter
+ 
+:param api_version_dict: Dict which includes the necessary values to create the object
+:type api_version_dict: Dict[str, str]
+:return: An object, created from the values provided
+:rtype: class:`ai_api_client_sdk.models.api_version.APIVersion`
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables
+
+
__weakref__
+
list of weak references to the object
+
+
+Data and other attributes defined here:
+
__hash__ = None
+ +

+ + + + + +
 
Data
       Dict = typing.Dict
+ \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.artifact.html b/packages/base/docs/ai_api_client_sdk.models.artifact.html new file mode 100644 index 0000000..3d205c3 --- /dev/null +++ b/packages/base/docs/ai_api_client_sdk.models.artifact.html @@ -0,0 +1,131 @@ + + + + +Python: module ai_api_client_sdk.models.artifact + + + + + +
 
ai_api_client_sdk.models.artifact		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/artifact.py
+

+

+ + + + + +
 
Classes
       
+
builtins.object +
+
+
Artifact +
+
+
+

+ + + + + + + +
 
class Artifact(builtins.object)
   Artifact(
+    name: str,
+    id: str,
+    url: str,
+    kind: ai_api_client_sdk.models.artifact.Artifact.Kind,
+    scenario_id: str,
+    created_at: datetime.datetime,
+    modified_at: datetime.datetime,
+    execution_id: str = None,
+    configuration_id: str = None,
+    description: str = None,
+    labels: List[ai_api_client_sdk.models.label.Label] = None,
+    scenario: ai_api_client_sdk.models.scenario.Scenario = None,
+    **kwargs
+)
+ 
+The Artifact object defines an artifact
+ 
+:param name: Name of the artifact
+:type name: str
+:param id: ID of the artifact
+:type id: str
+:param url: URL of the artifact
+:type url: str
+:param kind: Kind of the artifact
+:type kind: class:`ai_api_client_sdk.models.artifact.Artifact.Kind`
+:param scenario_id: ID of the scenario which the artifact belongs to
+:type scenario_id: str
+:param created_at: Time when the artifact was created
+:type created_at: datetime
+:param modified_at: Time when the artifact was last modified
+:type modified_at: datetime
+:param execution_id: ID of the execution which the artifact resulted from, defaults to None
+:type execution_id: str, optional
+:param configuration_id: ID of the configuration which the artifact relates to, defaults to None
+:type configuration_id: str, optional
+:param description: Description of the artifact, defaults to None
+:type description: str, optional
+:param labels: List of the labels of the artifact, defaults to None
+:type labels: List[class:`ai_api_client_sdk.models.label.Label`]
+:param scenario: A dict, which gives detailed information on scenario, defaults to None
+:type scenario: class:`ai_api_client_sdk.models.scenario.Scenario`, optional
+:param `**kwargs`: The keyword arguments are there in case there are additional attributes returned from server
 
 Methods defined here:
+
__eq__(self, other)
Return self==value.
+ +
__init__( + self, + name: str, + id: str, + url: str, + kind: ai_api_client_sdk.models.artifact.Artifact.Kind, + scenario_id: str, + created_at: datetime.datetime, + modified_at: datetime.datetime, + execution_id: str = None, + configuration_id: str = None, + description: str = None, + labels: List[ai_api_client_sdk.models.label.Label] = None, + scenario: ai_api_client_sdk.models.scenario.Scenario = None, + **kwargs +)
Initialize self.  See help(type(self)) for accurate signature.
+ +
__str__(self)
Return str(self).
+ +
+Static methods defined here:
+
from_dict(artifact_dict: Dict[str, Any])
Returns a :class:`ai_api_client_sdk.models.artifact.Artifact` object, created from the values in the dict
+provided as parameter
+ 
+:param artifact_dict: Dict which includes the necessary values to create the object
+:type artifact_dict: Dict[str, Any]
+:return: An object, created from the values provided
+:rtype: class:`ai_api_client_sdk.models.artifact.Artifact`
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables
+
+
__weakref__
+
list of weak references to the object
+
+
+Data and other attributes defined here:
+
Kind = <enum 'Kind'>
+ +
__hash__ = None
+ +

+ + + + + +
 
Data
       Dict = typing.Dict
+List = typing.List
+ \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.artifact_create_response.html b/packages/base/docs/ai_api_client_sdk.models.artifact_create_response.html new file mode 100644 index 0000000..be8b014 --- /dev/null +++ b/packages/base/docs/ai_api_client_sdk.models.artifact_create_response.html @@ -0,0 +1,82 @@ + + + + +Python: module ai_api_client_sdk.models.artifact_create_response + + + + + +
 
ai_api_client_sdk.models.artifact_create_response		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/artifact_create_response.py
+

+

+ + + + + +
 
Classes
       
+
ai_api_client_sdk.models.base_models.BasicResponse(builtins.object) +
+
+
ArtifactCreateResponse +
+
+
+

+ + + + + + + +
 
class ArtifactCreateResponse(ai_api_client_sdk.models.base_models.BasicResponse)
   ArtifactCreateResponse(id: str, message: str, url: str, **kwargs)
+ 
+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
 
 
Method resolution order:
+
ArtifactCreateResponse
+
ai_api_client_sdk.models.base_models.BasicResponse
+
builtins.object
+
+
+Methods defined here:
+
__init__(self, id: str, message: str, url: str, **kwargs)
Initialize self.  See help(type(self)) for accurate signature.
+ +
+Static methods defined here:
+
from_dict(response_dict: Dict[str, Any])
Returns a :class:`ai_api_client_sdk.models.artifact_create_response.ArtifactCreateResponse` object, created
+from the values in the dict provided as parameter
+ 
+:param response_dict: Dict which includes the necessary values to create the object
+:type response_dict: Dict[str, Any]
+:return: An object, created from the values provided
+:rtype: class:`ai_api_client_sdk.models.artifact_create_response.ArtifactCreateResponse`
+ +
+Methods inherited from ai_api_client_sdk.models.base_models.BasicResponse:
+
__str__(self)
Return str(self).
+ +
+Data descriptors inherited from ai_api_client_sdk.models.base_models.BasicResponse:
+
__dict__
+
dictionary for instance variables
+
+
__weakref__
+
list of weak references to the object
+
+

+ + + + + +
 
Data
       Dict = typing.Dict
+ \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.artifact_query_response.html b/packages/base/docs/ai_api_client_sdk.models.artifact_query_response.html new file mode 100644 index 0000000..57bec6d --- /dev/null +++ b/packages/base/docs/ai_api_client_sdk.models.artifact_query_response.html @@ -0,0 +1,90 @@ + + + + +Python: module ai_api_client_sdk.models.artifact_query_response + + + + + +
 
ai_api_client_sdk.models.artifact_query_response		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/artifact_query_response.py
+

+

+ + + + + +
 
Classes
       
+
ai_api_client_sdk.models.base_models.QueryResponse(builtins.object) +
+
+
ArtifactQueryResponse +
+
+
+

+ + + + + + + +
 
class ArtifactQueryResponse(ai_api_client_sdk.models.base_models.QueryResponse)
   ArtifactQueryResponse(
+    resources: List[ai_api_client_sdk.models.artifact.Artifact],
+    count: int,
+    **kwargs
+)
+ 
+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
 
 
Method resolution order:
+
ArtifactQueryResponse
+
ai_api_client_sdk.models.base_models.QueryResponse
+
builtins.object
+
+
+Methods defined here:
+
__init__( + self, + resources: List[ai_api_client_sdk.models.artifact.Artifact], + count: int, + **kwargs +)
Initialize self.  See help(type(self)) for accurate signature.
+ +
+Static methods defined here:
+
from_dict(response_dict: Dict[str, Any])
Returns a :class:`ai_api_client_sdk.models.artifact_query_response.ArtifactQueryResponse` object, created
+from the values in the dict provided as parameter
+ 
+:param response_dict: Dict which includes the necessary values to create the object
+:type response_dict: Dict[str, Any]
+:return: An object, created from the values provided
+:rtype: class:`ai_api_client_sdk.models.artifact_query_response.ArtifactQueryResponse`
+ +
+Methods inherited from ai_api_client_sdk.models.base_models.QueryResponse:
+
__str__(self)
Return str(self).
+ +
+Data descriptors inherited from ai_api_client_sdk.models.base_models.QueryResponse:
+
__dict__
+
dictionary for instance variables
+
+
__weakref__
+
list of weak references to the object
+
+

+ + + + + +
 
Data
       Dict = typing.Dict
+List = typing.List
+ \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.base_models.html b/packages/base/docs/ai_api_client_sdk.models.base_models.html new file mode 100644 index 0000000..a069ebf --- /dev/null +++ b/packages/base/docs/ai_api_client_sdk.models.base_models.html @@ -0,0 +1,488 @@ + + + + +Python: module ai_api_client_sdk.models.base_models + + + + + +
 
ai_api_client_sdk.models.base_models		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/base_models.py
+

+

+ + + + + +
 
Classes
       
+
aenum._enum.Enum(enum.Enum) +
+
+
Operation +
+
+
builtins.object +
+
+
BasicErrorResponse +
BasicModifyRequest +
BasicResponse +
BulkModifyErrorResponse +
KeyValue +
Name +
NameValue +
QueryResponse +
+
+
enum.Enum(builtins.object) +
+
+
Order +
+
+
+

+ + + + + + + +
 
class BasicErrorResponse(builtins.object)
   BasicErrorResponse(
+    code: str,
+    message: str,
+    request_id: str,
+    target: str,
+    details: Dict = None,
+    **kwargs
+)
+ 
+The BasicErrorResponse object defines the response from the server
+ 
+:param error_code: Error code from the server
+:type error_code: str
+:param message: Error message from the server
+:type message: str
+:param request_id: Request ID
+:type request_id: str  
+:param target: target
+:type target: str, optional
+:param details: Error details
+:type details: Dict, optional   
+:param `**kwargs`: The keyword arguments are there in case there are additional attributes returned from server
 
 Methods defined here:
+
__init__( + self, + code: str, + message: str, + request_id: str, + target: str, + details: Dict = None, + **kwargs +)
Initialize self.  See help(type(self)) for accurate signature.
+ +
__str__(self)
Return str(self).
+ +
+Static methods defined here:
+
from_dict(ber_dict: Dict[str, str])
Returns a :class:`ai_api_client_sdk.models.base_models.BasicErrorResponse` object, created from the values 
+provided as parameter
+ 
+:param ber_dict: Dict which includes the necessary values to create the object
+:type ber_dict: Dict[str, str]
+:return: An object, created from the values provided
+:rtype: class:`ai_api_client_sdk.models.base_models.BasicErrorResponse`
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables
+
+
__weakref__
+
list of weak references to the object
+
+

+ + + + + + + +
 
class BasicModifyRequest(builtins.object)
   BasicModifyRequest(
+    id: str,
+    target_status: ai_api_client_sdk.models.target_status.TargetStatus,
+    **kwargs
+)
+ 
+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
 
 Methods defined here:
+
__init__( + self, + id: str, + target_status: ai_api_client_sdk.models.target_status.TargetStatus, + **kwargs +)
Initialize self.  See help(type(self)) for accurate signature.
+ +
__str__(self)
Return str(self).
+ +
to_dict(self)
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables
+
+
__weakref__
+
list of weak references to the object
+
+

+ + + + + + + +
 
class BasicResponse(builtins.object)
   BasicResponse(id: str, message: str, **kwargs)
+ 
+The BasicResponse object defines the response from the server
+ 
+:param id: ID of the relevant resource
+:type id: str
+: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
 
 Methods defined here:
+
__init__(self, id: str, message: str, **kwargs)
Initialize self.  See help(type(self)) for accurate signature.
+ +
__str__(self)
Return str(self).
+ +
+Static methods defined here:
+
from_dict(br_dict: Dict[str, str])
Returns a :class:`ai_api_client_sdk.models.base_models.BasicResponse` object, created from the values in the
+dict provided as parameter
+ 
+:param br_dict: Dict which includes the necessary values to create the object
+:type br_dict: Dict[str, str]
+:return: An object, created from the values provided
+:rtype: class:`ai_api_client_sdk.models.base_models.BasicResponse`
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables
+
+
__weakref__
+
list of weak references to the object
+
+

+ + + + + + + +
 
class BulkModifyErrorResponse(builtins.object)
   BulkModifyErrorResponse(
+    id: str,
+    error: ai_api_client_sdk.models.base_models.BasicErrorResponse,
+    **kwargs
+)
+ 
+The BulkModifyErrorResponse object defines the error response from the server
 
 Methods defined here:
+
__init__( + self, + id: str, + error: ai_api_client_sdk.models.base_models.BasicErrorResponse, + **kwargs +)
Creates an error object for a bulk modification call
+ 
+:param id: ID of the relevant resource
+:type id: str
+:param error: Error object response from the server
+:type error: BasicErrorResponse
+:param `**kwargs`: The keyword arguments are there in case there are additional attributes returned from server
+ +
__str__(self)
Return str(self).
+ +
+Static methods defined here:
+
from_dict(error_dict: Dict[str, Union[str, Dict]])
:param error_dict: Dict which includes the necessary values to create the object
+:type error_dict: Dict[str, Union[str, Dict]]
+ 
+Returns:
+    Returns a class:`ai_api_client_sdk.models.base_models.BulkModifyErrorResponse` object
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables
+
+
__weakref__
+
list of weak references to the object
+
+

+ + + + + + + +
 
class KeyValue(builtins.object)
   KeyValue(key: str, value: str, **kwargs)
+ 
+KeyValue object defines a key-value pair
+ 
+:param key: key of the pair
+:type key: str
+:param value: value of the pair
+:type value: str
 
 Methods defined here:
+
__eq__(self, other)
Return self==value.
+ +
__init__(self, key: str, value: str, **kwargs)
Initialize self.  See help(type(self)) for accurate signature.
+ +
__str__(self)
Return str(self).
+ +
to_dict(self)
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables
+
+
__weakref__
+
list of weak references to the object
+
+
+Data and other attributes defined here:
+
__hash__ = None
+ +

+ + + + + + + +
 
class Name(builtins.object)
   Name(name: str, **kwargs)
+ 
+KeyValue object defines a name
+ 
+:param name: name
+:type name: str
 
 Methods defined here:
+
__eq__(self, other)
Return self==value.
+ +
__init__(self, name: str, **kwargs)
Initialize self.  See help(type(self)) for accurate signature.
+ +
__str__(self)
Return str(self).
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables
+
+
__weakref__
+
list of weak references to the object
+
+
+Data and other attributes defined here:
+
__hash__ = None
+ +

+ + + + + + + +
 
class NameValue(builtins.object)
   NameValue(name: str, value: str, **kwargs)
+ 
+KeyValue object defines a name-value pair
+ 
+:param name: name of the pair
+:type name: str
+:param value: value of the pair
+:type value: str
 
 Methods defined here:
+
__eq__(self, other)
Return self==value.
+ +
__init__(self, name: str, value: str, **kwargs)
Initialize self.  See help(type(self)) for accurate signature.
+ +
__str__(self)
Return str(self).
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables
+
+
__weakref__
+
list of weak references to the object
+
+
+Data and other attributes defined here:
+
__hash__ = None
+ +

+ + + + + + + +
 
class Operation(aenum._enum.Enum)
   Operation(*values)
+ 
+An enumeration.
 
 
Method resolution order:
+
Operation
+
aenum._enum.Enum
+
enum.Enum
+
builtins.object
+
+
+Data and other attributes defined here:
+
CASCADE_UPDATE = <Operation.CASCADE_UPDATE: 'CASCADE-UPDATE'>
+ +
CREATE = <Operation.CREATE: 'CREATE'>
+ +
DELETE = <Operation.DELETE: 'DELETE'>
+ +
UPDATE = <Operation.UPDATE: 'UPDATE'>
+ +
+Class methods inherited from aenum._enum.Enum:
+
__init_subclass__(**kwds) from aenum._enum
This method is called when a class is subclassed.
+ 
+The default implementation does nothing. It may be
+overridden to extend subclasses.
+ +
+Data descriptors inherited from aenum._enum.Enum:
+
name
+
+
name
+
+
value
+
+
value
+
+
values
+
+
+Static methods inherited from aenum._enum.EnumType:
+
__contains__(value)
Return True if `value` is in `cls`.
+ 
+`value` is in `cls` if:
+1) `value` is a member of `cls`, or
+2) `value` is the value of one of the `cls`'s members.
+ +
__getitem__(name)
Return the member matching `name`.
+ +
__iter__()
Return members in definition order.
+ +
__len__()
Return the number of members (no aliases)
+ +
+Readonly properties inherited from aenum._enum.EnumType:
+
__members__
+
Returns a mapping of member name->value.
+ 
+This mapping lists all enum members, including aliases. Note that this
+is a copy of the internal mapping.
+
+

+ + + + + + + +
 
class Order(enum.Enum)
   Order(*values)
+ 
+
 
 
Method resolution order:
+
Order
+
enum.Enum
+
builtins.object
+
+
+Data and other attributes defined here:
+
ASC = <Order.ASC: 'asc'>
+ +
DESC = <Order.DESC: 'desc'>
+ +
+Data descriptors inherited from enum.Enum:
+
name
+
The name of the Enum member.
+
+
value
+
The value of the Enum member.
+
+
+Static methods inherited from enum.EnumType:
+
__contains__(value)
Return True if `value` is in `cls`.
+ 
+`value` is in `cls` if:
+1) `value` is a member of `cls`, or
+2) `value` is the value of one of the `cls`'s members.
+3) `value` is a pseudo-member (flags)
+ +
__getitem__(name)
Return the member matching `name`.
+ +
__iter__()
Return members in definition order.
+ +
__len__()
Return the number of members (no aliases)
+ +
+Readonly properties inherited from enum.EnumType:
+
__members__
+
Returns a mapping of member name->value.
+ 
+This mapping lists all enum members, including aliases.  Note that
+this is a read-only view of the internal mapping.
+
+

+ + + + + + + +
 
class QueryResponse(builtins.object)
   QueryResponse(resources: list, count: int, **kwargs)
+ 
+The QueryResponse object defines the response from the server to a query request
+ 
+:param resources: List of the resources returned from the server
+:type resources: list
+:param count: Total number of the queried resources
+:type count: int
+:param `**kwargs`: The keyword arguments are there in case there are additional attributes returned from server
 
 Methods defined here:
+
__init__(self, resources: list, count: int, **kwargs)
Initialize self.  See help(type(self)) for accurate signature.
+ +
__str__(self)
Return str(self).
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables
+
+
__weakref__
+
list of weak references to the object
+
+

+ + + + + +
 
Data
       Dict = typing.Dict
+Union = typing.Union
+ \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.capabilities.html b/packages/base/docs/ai_api_client_sdk.models.capabilities.html new file mode 100644 index 0000000..f318d79 --- /dev/null +++ b/packages/base/docs/ai_api_client_sdk.models.capabilities.html @@ -0,0 +1,94 @@ + + + + +Python: module ai_api_client_sdk.models.capabilities + + + + + +
 
ai_api_client_sdk.models.capabilities		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/capabilities.py
+

+

+ + + + + +
 
Classes
       
+
builtins.object +
+
+
Capabilities +
+
+
+

+ + + + + + + +
 
class Capabilities(builtins.object)
   Capabilities(
+    ai_api: ai_api_client_sdk.models.ai_api_meta.AIAPIMeta,
+    runtime_identifier: str = None,
+    runtime_api_version: str = None,
+    description: str = None,
+    extensions: ai_api_client_sdk.models.extensions.Extensions = None,
+    **kwargs
+)
+ 
+The Capabilities object represents the metadata and capabilities of, and extensions to the AI API
+ 
+:param ai_api: Metadata and capabilities of the AI API
+:type ai_api: class:`ai_api_client_sdk.models.ai_api_meta.AIAPIMeta`
+:param runtime_identifier: The name of runtime, defaults to None
+:type runtime_identifier: str, optional
+:param runtime_api_version: The version of the runtime, defaults to None
+:type runtime_api_version: str, optional
+:param description: description, defaults to None
+:type description: str, optional
+:param extensions: Extensions to the AI API, defaults to None
+:type extensions: class:`ai_api_client_sdk.models.extensions.Extensions`, optional
+:param `**kwargs`: The keyword arguments are there in case there are additional attributes returned from server
 
 Methods defined here:
+
__init__( + self, + ai_api: ai_api_client_sdk.models.ai_api_meta.AIAPIMeta, + runtime_identifier: str = None, + runtime_api_version: str = None, + description: str = None, + extensions: ai_api_client_sdk.models.extensions.Extensions = None, + **kwargs +)
Initialize self.  See help(type(self)) for accurate signature.
+ +
__str__(self)
Return str(self).
+ +
+Static methods defined here:
+
from_dict(capabilities_dict: Dict[str, Any])
Returns a :class:`ai_api_client_sdk.models.capabilities.Capabilities` object, created
+from the values in the dict provided as parameter
+ 
+:param capabilities_dict: Dict which includes the necessary values to create the object
+:type capabilities_dict: Dict[str, Any]
+:return: An object, created from the values provided
+:rtype: class:`ai_api_client_sdk.models.capabilities.Capabilities`
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables
+
+
__weakref__
+
list of weak references to the object
+
+

+ + + + + +
 
Data
       Dict = typing.Dict
+ \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.configuration.html b/packages/base/docs/ai_api_client_sdk.models.configuration.html new file mode 100644 index 0000000..089765b --- /dev/null +++ b/packages/base/docs/ai_api_client_sdk.models.configuration.html @@ -0,0 +1,108 @@ + + + + +Python: module ai_api_client_sdk.models.configuration + + + + + +
 
ai_api_client_sdk.models.configuration		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/configuration.py
+

+

+ + + + + +
 
Classes
       
+
builtins.object +
+
+
Configuration +
+
+
+

+ + + + + + + +
 
class Configuration(builtins.object)
   Configuration(
+    id: str,
+    name: str,
+    scenario_id: str,
+    executable_id: str,
+    created_at: datetime.datetime,
+    parameter_bindings: List[ai_api_client_sdk.models.parameter_binding.ParameterBinding] = None,
+    input_artifact_bindings: List[ai_api_client_sdk.models.input_artifact_binding.InputArtifactBinding] = None,
+    scenario: ai_api_client_sdk.models.scenario.Scenario = None,
+    **kwargs
+)
+ 
+The Configuration object defines a configuration
+ 
+:param id: ID of the configuration
+:type id: str
+:param name: Name of the configuration
+:type name: str
+:param scenario_id: ID of the scenario which the configuration belongs to
+:type scenario_id: str
+:param executable_id: ID of the executable, which is configured
+:type executable_id: str
+:param created_at: Time when the configuration was created
+:type created_at: datetime
+:param parameter_bindings: List of the input parameters defined as key-value pairs, defaults to None
+:type parameter_bindings: List[class:`ai_api_client_sdk.models.parameter_binding.ParameterBinding`], optional
+:param input_artifact_bindings: List of the input artifacts which are to be used by the executable, defaults to None
+:type input_artifact_bindings: List[class:`ai_api_client_sdk.models.input_artifact_binding.InputArtifactBinding`],
+    optional
+:param scenario: A dict, which gives detailed information on scenario, defaults to None
+:type scenario: class:`ai_api_client_sdk.models.scenario.Scenario`, optional
+:param `**kwargs`: The keyword arguments are there in case there are additional attributes returned from server
 
 Methods defined here:
+
__init__( + self, + id: str, + name: str, + scenario_id: str, + executable_id: str, + created_at: datetime.datetime, + parameter_bindings: List[ai_api_client_sdk.models.parameter_binding.ParameterBinding] = None, + input_artifact_bindings: List[ai_api_client_sdk.models.input_artifact_binding.InputArtifactBinding] = None, + scenario: ai_api_client_sdk.models.scenario.Scenario = None, + **kwargs +)
Initialize self.  See help(type(self)) for accurate signature.
+ +
__str__(self)
Return str(self).
+ +
+Static methods defined here:
+
from_dict(configuration_dict: Dict[str, Any])
Returns a :class:`ai_api_client_sdk.models.configuration.Configuration` object, created from the values in the
+dict provided as parameter
+ 
+:param configuration_dict: Dict which includes the necessary values to create the object
+:type configuration_dict: Dict[str, Any]
+:return: An object, created from the values provided
+:rtype: class:`ai_api_client_sdk.models.configuration.Configuration`
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables
+
+
__weakref__
+
list of weak references to the object
+
+

+ + + + + +
 
Data
       Dict = typing.Dict
+List = typing.List
+ \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.configuration_create_response.html b/packages/base/docs/ai_api_client_sdk.models.configuration_create_response.html new file mode 100644 index 0000000..40d0605 --- /dev/null +++ b/packages/base/docs/ai_api_client_sdk.models.configuration_create_response.html @@ -0,0 +1,74 @@ + + + + +Python: module ai_api_client_sdk.models.configuration_create_response + + + + + +
 
ai_api_client_sdk.models.configuration_create_response		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/configuration_create_response.py
+

+

+ + + + + +
 
Classes
       
+
ai_api_client_sdk.models.base_models.BasicResponse(builtins.object) +
+
+
ConfigurationCreateResponse +
+
+
+

+ + + + + + + +
 
class ConfigurationCreateResponse(ai_api_client_sdk.models.base_models.BasicResponse)
   ConfigurationCreateResponse(id: str, message: str, **kwargs)
+ 
+The ConfigurationCreateResponse object defines the response of the configuration create request. Refer to
+:class:`ai_api_client_sdk.models.base_models.BasicResponse`, for the object definition
 
 
Method resolution order:
+
ConfigurationCreateResponse
+
ai_api_client_sdk.models.base_models.BasicResponse
+
builtins.object
+
+
+Static methods defined here:
+
from_dict(response_dict: Dict[str, Any])
Returns a :class:`ai_api_client_sdk.models.configuration_create_response.ConfigurationCreateResponse` object,
+created from the values in the dict provided as parameter
+ 
+:param response_dict: Dict which includes the necessary values to create the object
+:type response_dict: Dict[str, Any]
+:return: An object, created from the values provided
+:rtype: class:`ai_api_client_sdk.models.configuration_create_response.ConfigurationCreateResponse`
+ +
+Methods inherited from ai_api_client_sdk.models.base_models.BasicResponse:
+
__init__(self, id: str, message: str, **kwargs)
Initialize self.  See help(type(self)) for accurate signature.
+ +
__str__(self)
Return str(self).
+ +
+Data descriptors inherited from ai_api_client_sdk.models.base_models.BasicResponse:
+
__dict__
+
dictionary for instance variables
+
+
__weakref__
+
list of weak references to the object
+
+

+ + + + + +
 
Data
       Dict = typing.Dict
+ \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.configuration_query_response.html b/packages/base/docs/ai_api_client_sdk.models.configuration_query_response.html new file mode 100644 index 0000000..3b8b254 --- /dev/null +++ b/packages/base/docs/ai_api_client_sdk.models.configuration_query_response.html @@ -0,0 +1,90 @@ + + + + +Python: module ai_api_client_sdk.models.configuration_query_response + + + + + +
 
ai_api_client_sdk.models.configuration_query_response		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/configuration_query_response.py
+

+

+ + + + + +
 
Classes
       
+
ai_api_client_sdk.models.base_models.QueryResponse(builtins.object) +
+
+
ConfigurationQueryResponse +
+
+
+

+ + + + + + + +
 
class ConfigurationQueryResponse(ai_api_client_sdk.models.base_models.QueryResponse)
   ConfigurationQueryResponse(
+    resources: List[ai_api_client_sdk.models.configuration.Configuration],
+    count: int,
+    **kwargs
+)
+ 
+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
 
 
Method resolution order:
+
ConfigurationQueryResponse
+
ai_api_client_sdk.models.base_models.QueryResponse
+
builtins.object
+
+
+Methods defined here:
+
__init__( + self, + resources: List[ai_api_client_sdk.models.configuration.Configuration], + count: int, + **kwargs +)
Initialize self.  See help(type(self)) for accurate signature.
+ +
+Static methods defined here:
+
from_dict(response_dict: Dict[str, Any])
Returns a :class:`ai_api_client_sdk.models.configuration_query_response.ConfigurationQueryResponse` object,
+created from the values in the dict provided as parameter
+ 
+:param response_dict: Dict which includes the necessary values to create the object
+:type response_dict: Dict[str, Any]
+:return: An object, created from the values provided
+:rtype: class:`ai_api_client_sdk.models.configuration_query_response.ConfigurationQueryResponse`
+ +
+Methods inherited from ai_api_client_sdk.models.base_models.QueryResponse:
+
__str__(self)
Return str(self).
+ +
+Data descriptors inherited from ai_api_client_sdk.models.base_models.QueryResponse:
+
__dict__
+
dictionary for instance variables
+
+
__weakref__
+
list of weak references to the object
+
+

+ + + + + +
 
Data
       Dict = typing.Dict
+List = typing.List
+ \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.dataset_capabilities.html b/packages/base/docs/ai_api_client_sdk.models.dataset_capabilities.html new file mode 100644 index 0000000..65e16df --- /dev/null +++ b/packages/base/docs/ai_api_client_sdk.models.dataset_capabilities.html @@ -0,0 +1,92 @@ + + + + +Python: module ai_api_client_sdk.models.dataset_capabilities + + + + + +
 
ai_api_client_sdk.models.dataset_capabilities		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/dataset_capabilities.py
+

+

+ + + + + +
 
Classes
       
+
builtins.object +
+
+
DatasetCapabilities +
+
+
+

+ + + + + + + +
 
class DatasetCapabilities(builtins.object)
   DatasetCapabilities(
+    upload: bool = True,
+    download: bool = True,
+    delete: bool = True,
+    **kwargs
+)
+ 
+The DatasetCapabilities object represents the capabilities of the Dataset API
+ 
+:param upload: indicates whether uploading files is supported, defaults to True
+:type upload: bool, optional
+:param download: indicates whether downloading files is supported, defaults to True
+:type download: bool, optional
+:param delete: indicates whether deleting files is supported, defaults to True
+:type delete: bool, optional
+:param `**kwargs`: The keyword arguments are there in case there are additional attributes returned from server
 
 Methods defined here:
+
__eq__(self, other)
Return self==value.
+ +
__init__( + self, + upload: bool = True, + download: bool = True, + delete: bool = True, + **kwargs +)
Initialize self.  See help(type(self)) for accurate signature.
+ +
__str__(self)
Return str(self).
+ +
+Static methods defined here:
+
from_dict(dataset_capabilities_dict: Dict[str, bool])
Returns a :class:`ai_api_client_sdk.models.dataset_capabilities.DatasetCapabilities` object, created from
+the values in the dict provided as parameter
+ 
+:param dataset_capabilities_dict: Dict which includes the necessary values to create the object
+:type dataset_capabilities_dict: Dict[str, bool]
+:return: An object, created from the values provided
+:rtype: class:`ai_api_client_sdk.models.dataset_capabilities.DatasetCapabilities`
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables
+
+
__weakref__
+
list of weak references to the object
+
+
+Data and other attributes defined here:
+
__hash__ = None
+ +

+ + + + + +
 
Data
       Dict = typing.Dict
+ \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.dataset_limits.html b/packages/base/docs/ai_api_client_sdk.models.dataset_limits.html new file mode 100644 index 0000000..84c9ee9 --- /dev/null +++ b/packages/base/docs/ai_api_client_sdk.models.dataset_limits.html @@ -0,0 +1,88 @@ + + + + +Python: module ai_api_client_sdk.models.dataset_limits + + + + + +
 
ai_api_client_sdk.models.dataset_limits		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/dataset_limits.py
+

+

+ + + + + +
 
Classes
       
+
builtins.object +
+
+
DatasetLimits +
+
+
+

+ + + + + + + +
 
class DatasetLimits(builtins.object)
   DatasetLimits(
+    max_upload_file_size: int = 104857600,
+    max_files_per_dataset: int = -1,
+    **kwargs
+)
+ 
+The DatasetLimits object represents the limits of the Dataset API
+ 
+:param max_upload_file_size: Max size (in bytes) of a single uploaded file, defaults to 104857600
+:type max_upload_file_size: int, optional
+:param max_files_per_dataset: Max number of files per dataset. <0 means unlimited, defaults to -1
+:type max_files_per_dataset: int, optional
+:param `**kwargs`: The keyword arguments are there in case there are additional attributes returned from server
 
 Methods defined here:
+
__eq__(self, other)
Return self==value.
+ +
__init__( + self, + max_upload_file_size: int = 104857600, + max_files_per_dataset: int = -1, + **kwargs +)
Initialize self.  See help(type(self)) for accurate signature.
+ +
__str__(self)
Return str(self).
+ +
+Static methods defined here:
+
from_dict(dataset_limits_dict: Dict[str, int])
Returns a :class:`ai_api_client_sdk.models.dataset_limits.DatasetLimits` object, created from the values in
+the dict provided as parameter
+ 
+:param dataset_limits_dict: Dict which includes the necessary values to create the object
+:type dataset_limits_dict: Dict[str, int]
+:return: An object, created from the values provided
+:rtype: class:`ai_api_client_sdk.models.dataset_limits.DatasetLimits`
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables
+
+
__weakref__
+
list of weak references to the object
+
+
+Data and other attributes defined here:
+
__hash__ = None
+ +

+ + + + + +
 
Data
       Dict = typing.Dict
+ \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.deployment.html b/packages/base/docs/ai_api_client_sdk.models.deployment.html new file mode 100644 index 0000000..0e2b167 --- /dev/null +++ b/packages/base/docs/ai_api_client_sdk.models.deployment.html @@ -0,0 +1,160 @@ + + + + +Python: module ai_api_client_sdk.models.deployment + + + + + +
 
ai_api_client_sdk.models.deployment		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/deployment.py
+

+

+ + + + + +
 
Modules
       
humps
+

+ + + + + +
 
Classes
       
+
ai_api_client_sdk.models.enactment.Enactment(builtins.object) +
+
+
Deployment +
+
+
+

+ + + + + + + +
 
class Deployment(ai_api_client_sdk.models.enactment.Enactment)
   Deployment(
+    id: str,
+    deployment_url: str,
+    configuration_id: str,
+    configuration_name: str,
+    scenario_id: str,
+    status: ai_api_client_sdk.models.status.Status,
+    target_status: ai_api_client_sdk.models.target_status.TargetStatus,
+    created_at: datetime.datetime,
+    modified_at: datetime.datetime,
+    status_message: str = None,
+    status_details: Dict[str, Any] = None,
+    details: Dict[str, Any] = None,
+    submission_time: datetime.datetime = None,
+    start_time: datetime.datetime = None,
+    completion_time: datetime.datetime = None,
+    last_operation: ai_api_client_sdk.models.base_models.Operation = None,
+    latest_running_configuration_id: str = None,
+    ttl: str = None,
+    **kwargs
+)
+ 
+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
+:type details: Dict[str, Any], optional
+:param submission_time: Time when the deployment was submitted
+:type submission_time: datetime, optional
+:param start_time: Time when the deployment status changed to RUNNING
+:type start_time: datetime, optional
+:param completion_time: Time when the deployment status changed to DEAD/STOPPED
+:type completion_time: datetime, optional
+:param last_operation: Last operation applied to the deployment
+:type last_operation: Operation, optional
+:param latest_running_configuration_id: The configuration ID that was running, before a PATCH operation has modified
+    the configuration ID of the deployment.
+:type latest_running_configuration_id: str, optional
+:param ttl: Time to live for a deployment
+:type ttl: str, optional
+:param `**kwargs`: The keyword arguments are there in case there are additional attributes returned from server
 
 
Method resolution order:
+
Deployment
+
ai_api_client_sdk.models.enactment.Enactment
+
builtins.object
+
+
+Methods defined here:
+
__init__( + self, + id: str, + deployment_url: str, + configuration_id: str, + configuration_name: str, + scenario_id: str, + status: ai_api_client_sdk.models.status.Status, + target_status: ai_api_client_sdk.models.target_status.TargetStatus, + created_at: datetime.datetime, + modified_at: datetime.datetime, + status_message: str = None, + status_details: Dict[str, Any] = None, + details: Dict[str, Any] = None, + submission_time: datetime.datetime = None, + start_time: datetime.datetime = None, + completion_time: datetime.datetime = None, + last_operation: ai_api_client_sdk.models.base_models.Operation = None, + latest_running_configuration_id: str = None, + ttl: str = None, + **kwargs +)
Initialize self.  See help(type(self)) for accurate signature.
+ +
__str__(self)
Return str(self).
+ +
+Static methods defined here:
+
from_dict(deployment_dict: Dict[str, Any])
Returns a :class:`ai_api_client_sdk.models.deployment.Deployment` 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.Deployment`
+ +
+Data descriptors inherited from ai_api_client_sdk.models.enactment.Enactment:
+
__dict__
+
dictionary for instance variables
+
+
__weakref__
+
list of weak references to the object
+
+

+ + + + + +
 
Data
       Dict = typing.Dict
+ \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.deployment_bulk_modify_response.html b/packages/base/docs/ai_api_client_sdk.models.deployment_bulk_modify_response.html new file mode 100644 index 0000000..00d5478 --- /dev/null +++ b/packages/base/docs/ai_api_client_sdk.models.deployment_bulk_modify_response.html @@ -0,0 +1,78 @@ + + + + +Python: module ai_api_client_sdk.models.deployment_bulk_modify_response + + + + + +
 
ai_api_client_sdk.models.deployment_bulk_modify_response		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/deployment_bulk_modify_response.py
+

+

+ + + + + +
 
Classes
       
+
builtins.object +
+
+
DeploymentBulkModifyResponse +
+
+
+

+ + + + + + + +
 
class DeploymentBulkModifyResponse(builtins.object)
   DeploymentBulkModifyResponse(
+    deployments: List[Union[ai_api_client_sdk.models.base_models.BasicResponse, ai_api_client_sdk.models.base_models.BulkModifyErrorResponse]],
+    **kwargs
+)
+ 
+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]]
 
 Methods defined here:
+
__init__( + self, + deployments: List[Union[ai_api_client_sdk.models.base_models.BasicResponse, ai_api_client_sdk.models.base_models.BulkModifyErrorResponse]], + **kwargs +)
Initialize self.  See help(type(self)) for accurate signature.
+ +
__str__(self)
Return str(self).
+ +
+Static methods defined here:
+
from_dict(response_dict: Dict[str, List[Dict[str, Union[str, Dict]]]])
Returns a :class:`ai_api_client_sdk.models.Deployment_Bulk_Modify_Response.DeploymentBulkModifyResponse`
+object, created from the values provided as parameter
+ 
+:param response_dict: Which includes the necessary values to create the object
+:type response_dict: Dict[str, List[Dict[str, Union[str, Dict]]]]
+:return: An object, created from the values provided
+:rtype: class:`ai_api_client_sdk.models.Deployment_Bulk_Modify_Response.DeploymentBulkModifyResponse`
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables
+
+
__weakref__
+
list of weak references to the object
+
+

+ + + + + +
 
Data
       Dict = typing.Dict
+List = typing.List
+Union = typing.Union
+ \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.deployment_create_response.html b/packages/base/docs/ai_api_client_sdk.models.deployment_create_response.html new file mode 100644 index 0000000..c719b0b --- /dev/null +++ b/packages/base/docs/ai_api_client_sdk.models.deployment_create_response.html @@ -0,0 +1,101 @@ + + + + +Python: module ai_api_client_sdk.models.deployment_create_response + + + + + +
 
ai_api_client_sdk.models.deployment_create_response		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/deployment_create_response.py
+

+

+ + + + + +
 
Classes
       
+
ai_api_client_sdk.models.base_models.BasicResponse(builtins.object) +
+
+
DeploymentCreateResponse +
+
+
+

+ + + + + + + +
 
class DeploymentCreateResponse(ai_api_client_sdk.models.base_models.BasicResponse)
   DeploymentCreateResponse(
+    id: str,
+    message: str,
+    deployment_url: str,
+    status: ai_api_client_sdk.models.status.Status,
+    ttl: str = None,
+    **kwargs
+)
+ 
+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
 
 
Method resolution order:
+
DeploymentCreateResponse
+
ai_api_client_sdk.models.base_models.BasicResponse
+
builtins.object
+
+
+Methods defined here:
+
__init__( + self, + id: str, + message: str, + deployment_url: str, + status: ai_api_client_sdk.models.status.Status, + ttl: str = None, + **kwargs +)
Initialize self.  See help(type(self)) for accurate signature.
+ +
+Static methods defined here:
+
from_dict(response_dict: Dict[str, Any])
Returns a :class:`ai_api_client_sdk.models.deployment_create_response.DeploymentCreateResponse` object,
+created from the values in the dict provided as parameter
+ 
+:param response_dict: Dict which includes the necessary values to create the object
+:type response_dict: Dict[str, Any]
+:return: An object, created from the values provided
+:rtype: class:`ai_api_client_sdk.models.deployment_create_response.DeploymentCreateResponse`
+ +
+Methods inherited from ai_api_client_sdk.models.base_models.BasicResponse:
+
__str__(self)
Return str(self).
+ +
+Data descriptors inherited from ai_api_client_sdk.models.base_models.BasicResponse:
+
__dict__
+
dictionary for instance variables
+
+
__weakref__
+
list of weak references to the object
+
+

+ + + + + +
 
Data
       Dict = typing.Dict
+ \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.deployment_get_status_response.html b/packages/base/docs/ai_api_client_sdk.models.deployment_get_status_response.html new file mode 100644 index 0000000..c4ef313 --- /dev/null +++ b/packages/base/docs/ai_api_client_sdk.models.deployment_get_status_response.html @@ -0,0 +1,101 @@ + + + + +Python: module ai_api_client_sdk.models.deployment_get_status_response + + + + + +
 
ai_api_client_sdk.models.deployment_get_status_response		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/deployment_get_status_response.py
+

+

+ + + + + +
 
Classes
       
+
ai_api_client_sdk.models.enactment_get_status_response.EnactmentGetStatusResponse(builtins.object) +
+
+
DeploymentGetStatusResponse +
+
+
+

+ + + + + + + +
 
class DeploymentGetStatusResponse(ai_api_client_sdk.models.enactment_get_status_response.EnactmentGetStatusResponse)
   DeploymentGetStatusResponse(
+    id: str,
+    configuration_id: str,
+    status: ai_api_client_sdk.models.status.Status,
+    created_at: datetime.datetime,
+    modified_at: datetime.datetime,
+    status_details: Dict[str, Any] = None,
+    details: Dict[str, Any] = None
+)
+ 
+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
 
 
Method resolution order:
+
DeploymentGetStatusResponse
+
ai_api_client_sdk.models.enactment_get_status_response.EnactmentGetStatusResponse
+
builtins.object
+
+
+Methods defined here:
+
__init__( + self, + id: str, + configuration_id: str, + status: ai_api_client_sdk.models.status.Status, + created_at: datetime.datetime, + modified_at: datetime.datetime, + status_details: Dict[str, Any] = None, + details: Dict[str, Any] = None +)
Initialize self.  See help(type(self)) for accurate signature.
+ +
__str__(self)
Return str(self).
+ +
+Static methods defined here:
+
from_dict(deployment_dict: Dict[str, Any])
Returns a :class:`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`
+ +
+Data descriptors inherited from ai_api_client_sdk.models.enactment_get_status_response.EnactmentGetStatusResponse:
+
__dict__
+
dictionary for instance variables
+
+
__weakref__
+
list of weak references to the object
+
+

+ + + + + +
 
Data
       Dict = typing.Dict
+ \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.deployment_query_response.html b/packages/base/docs/ai_api_client_sdk.models.deployment_query_response.html new file mode 100644 index 0000000..4c24576 --- /dev/null +++ b/packages/base/docs/ai_api_client_sdk.models.deployment_query_response.html @@ -0,0 +1,90 @@ + + + + +Python: module ai_api_client_sdk.models.deployment_query_response + + + + + +
 
ai_api_client_sdk.models.deployment_query_response		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/deployment_query_response.py
+

+

+ + + + + +
 
Classes
       
+
ai_api_client_sdk.models.base_models.QueryResponse(builtins.object) +
+
+
DeploymentQueryResponse +
+
+
+

+ + + + + + + +
 
class DeploymentQueryResponse(ai_api_client_sdk.models.base_models.QueryResponse)
   DeploymentQueryResponse(
+    resources: List[ai_api_client_sdk.models.deployment.Deployment],
+    count: int,
+    **kwargs
+)
+ 
+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
 
 
Method resolution order:
+
DeploymentQueryResponse
+
ai_api_client_sdk.models.base_models.QueryResponse
+
builtins.object
+
+
+Methods defined here:
+
__init__( + self, + resources: List[ai_api_client_sdk.models.deployment.Deployment], + count: int, + **kwargs +)
Initialize self.  See help(type(self)) for accurate signature.
+ +
+Static methods defined here:
+
from_dict(response_dict: Dict[str, Any])
Returns a :class:`ai_api_client_sdk.models.deployment_query_response.DeploymentQueryResponse` object, created 
+from the values in the dict provided as parameter
+ 
+:param response_dict: Dict which includes the necessary values to create the object
+:type response_dict: Dict[str, Any]
+:return: An object, created from the values provided
+:rtype: class:`ai_api_client_sdk.models.deployment_query_response.DeploymentQueryResponse`
+ +
+Methods inherited from ai_api_client_sdk.models.base_models.QueryResponse:
+
__str__(self)
Return str(self).
+ +
+Data descriptors inherited from ai_api_client_sdk.models.base_models.QueryResponse:
+
__dict__
+
dictionary for instance variables
+
+
__weakref__
+
list of weak references to the object
+
+

+ + + + + +
 
Data
       Dict = typing.Dict
+List = typing.List
+ \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.enactment.html b/packages/base/docs/ai_api_client_sdk.models.enactment.html new file mode 100644 index 0000000..106d478 --- /dev/null +++ b/packages/base/docs/ai_api_client_sdk.models.enactment.html @@ -0,0 +1,116 @@ + + + + +Python: module ai_api_client_sdk.models.enactment + + + + + +
 
ai_api_client_sdk.models.enactment		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/enactment.py
+

+

+ + + + + +
 
Classes
       
+
builtins.object +
+
+
Enactment +
+
+
+

+ + + + + + + +
 
class Enactment(builtins.object)
   Enactment(
+    id: str,
+    configuration_id: str,
+    configuration_name,
+    scenario_id: str,
+    status: ai_api_client_sdk.models.status.Status,
+    target_status: ai_api_client_sdk.models.target_status.TargetStatus,
+    created_at: datetime.datetime,
+    modified_at: datetime.datetime,
+    status_message: str = None,
+    status_details: Dict[str, Any] = None,
+    submission_time: datetime.datetime = None,
+    start_time: datetime.datetime = None,
+    completion_time: datetime.datetime = None,
+    **kwargs
+)
+ 
+Enactment object is base class for Execution/Deployment, defining their common attributes
+ 
+: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 configuration_name: Name of the configuration which configured the enactment
+:type configuration_name: str
+:param scenario_id: ID of the scenario which the enactment belongs to
+:type scenario_id: str
+:param status: Status of the enactment
+:type status: class:`ai_api_client_sdk.models.status.Status`
+:param target_status: Target status of the enactment
+:type target_status: class:`ai_api_client_sdk.models.target_status.TargetStatus`
+: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_message: A string, which gives information about the status of the enactment, defaults to None
+:type status_message: str, optional
+: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
+:param submission_time: Time when the enactment was submitted
+:type submission_time: datetime, optional
+:param start_time: Time when the enactment status changed to RUNNING
+:type start_time: datetime, optional
+:param completion_time: Time when the enactment status changed to COMPLETED/DEAD/STOPPED
+:type completion_time: datetime, optional
+:param `**kwargs`: The keyword arguments are there in case there are additional attributes returned from server
 
 Methods defined here:
+
__init__( + self, + id: str, + configuration_id: str, + configuration_name, + scenario_id: str, + status: ai_api_client_sdk.models.status.Status, + target_status: ai_api_client_sdk.models.target_status.TargetStatus, + created_at: datetime.datetime, + modified_at: datetime.datetime, + status_message: str = None, + status_details: Dict[str, Any] = None, + submission_time: datetime.datetime = None, + start_time: datetime.datetime = None, + completion_time: datetime.datetime = None, + **kwargs +)
Initialize self.  See help(type(self)) for accurate signature.
+ +
__str__(self)
Return str(self).
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables
+
+
__weakref__
+
list of weak references to the object
+
+

+ + + + + +
 
Data
       Dict = typing.Dict
+ \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.enactment_get_status_response.html b/packages/base/docs/ai_api_client_sdk.models.enactment_get_status_response.html new file mode 100644 index 0000000..6be4fb6 --- /dev/null +++ b/packages/base/docs/ai_api_client_sdk.models.enactment_get_status_response.html @@ -0,0 +1,84 @@ + + + + +Python: module ai_api_client_sdk.models.enactment_get_status_response + + + + + +
 
ai_api_client_sdk.models.enactment_get_status_response		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/enactment_get_status_response.py
+

+

+ + + + + +
 
Classes
       
+
builtins.object +
+
+
EnactmentGetStatusResponse +
+
+
+

+ + + + + + + +
 
class EnactmentGetStatusResponse(builtins.object)
   EnactmentGetStatusResponse(
+    id: str,
+    configuration_id: str,
+    status: ai_api_client_sdk.models.status.Status,
+    created_at: datetime.datetime,
+    modified_at: datetime.datetime,
+    status_details: Dict[str, Any] = None
+)
+ 
+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
 
 Methods defined here:
+
__init__( + self, + id: str, + configuration_id: str, + status: ai_api_client_sdk.models.status.Status, + created_at: datetime.datetime, + modified_at: datetime.datetime, + status_details: Dict[str, Any] = None +)
Initialize self.  See help(type(self)) for accurate signature.
+ +
__str__(self)
Return str(self).
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables
+
+
__weakref__
+
list of weak references to the object
+
+

+ + + + + +
 
Data
       Dict = typing.Dict
+ \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.executable.html b/packages/base/docs/ai_api_client_sdk.models.executable.html new file mode 100644 index 0000000..2e2ff5a --- /dev/null +++ b/packages/base/docs/ai_api_client_sdk.models.executable.html @@ -0,0 +1,128 @@ + + + + +Python: module ai_api_client_sdk.models.executable + + + + + +
 
ai_api_client_sdk.models.executable		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/executable.py
+

+

+ + + + + +
 
Classes
       
+
builtins.object +
+
+
Executable +
+
+
+

+ + + + + + + +
 
class Executable(builtins.object)
   Executable(
+    id: str,
+    scenario_id: str,
+    version_id: str,
+    name: str,
+    deployable: bool,
+    created_at: datetime.datetime,
+    modified_at: datetime.datetime,
+    description: str = None,
+    parameters: List[ai_api_client_sdk.models.parameter.Parameter] = None,
+    input_artifacts: List[ai_api_client_sdk.models.input_artifact.InputArtifact] = None,
+    output_artifacts: List[ai_api_client_sdk.models.output_artifact.OutputArtifact] = None,
+    labels: List[ai_api_client_sdk.models.label.Label] = None,
+    **kwargs
+)
+ 
+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
 
 Methods defined here:
+
__eq__(self, other)
Return self==value.
+ +
__init__( + self, + id: str, + scenario_id: str, + version_id: str, + name: str, + deployable: bool, + created_at: datetime.datetime, + modified_at: datetime.datetime, + description: str = None, + parameters: List[ai_api_client_sdk.models.parameter.Parameter] = None, + input_artifacts: List[ai_api_client_sdk.models.input_artifact.InputArtifact] = None, + output_artifacts: List[ai_api_client_sdk.models.output_artifact.OutputArtifact] = None, + labels: List[ai_api_client_sdk.models.label.Label] = None, + **kwargs +)
Initialize self.  See help(type(self)) for accurate signature.
+ +
__str__(self)
Return str(self).
+ +
+Static methods defined here:
+
from_dict(executable_dict: Dict[str, Any])
Returns a :class:`ai_api_client_sdk.models.executable.Executable` object, created from the values in the dict
+provided as parameter
+ 
+:param executable_dict: Dict which includes the necessary values to create the object
+:type executable_dict: Dict[str, Any]
+:return: An object, created from the values provided
+:rtype: class:`ai_api_client_sdk.models.executable.Executable`
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables
+
+
__weakref__
+
list of weak references to the object
+
+
+Data and other attributes defined here:
+
__hash__ = None
+ +

+ + + + + +
 
Data
       Dict = typing.Dict
+List = typing.List
+ \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.executable_query_response.html b/packages/base/docs/ai_api_client_sdk.models.executable_query_response.html new file mode 100644 index 0000000..0f55a60 --- /dev/null +++ b/packages/base/docs/ai_api_client_sdk.models.executable_query_response.html @@ -0,0 +1,90 @@ + + + + +Python: module ai_api_client_sdk.models.executable_query_response + + + + + +
 
ai_api_client_sdk.models.executable_query_response		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/executable_query_response.py
+

+

+ + + + + +
 
Classes
       
+
ai_api_client_sdk.models.base_models.QueryResponse(builtins.object) +
+
+
ExecutableQueryResponse +
+
+
+

+ + + + + + + +
 
class ExecutableQueryResponse(ai_api_client_sdk.models.base_models.QueryResponse)
   ExecutableQueryResponse(
+    resources: List[ai_api_client_sdk.models.executable.Executable],
+    count: int,
+    **kwargs
+)
+ 
+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
 
 
Method resolution order:
+
ExecutableQueryResponse
+
ai_api_client_sdk.models.base_models.QueryResponse
+
builtins.object
+
+
+Methods defined here:
+
__init__( + self, + resources: List[ai_api_client_sdk.models.executable.Executable], + count: int, + **kwargs +)
Initialize self.  See help(type(self)) for accurate signature.
+ +
+Static methods defined here:
+
from_dict(response_dict: Dict[str, Any])
Returns a :class:`ai_api_client_sdk.models.executable_query_response.ExecutableQueryResponse` object, created 
+from the values in the dict provided as parameter
+ 
+:param response_dict: Dict which includes the necessary values to create the object
+:type response_dict: Dict[str, Any]
+:return: An object, created from the values provided
+:rtype: class:`ai_api_client_sdk.models.executable_query_response.ExecutableQueryResponse`
+ +
+Methods inherited from ai_api_client_sdk.models.base_models.QueryResponse:
+
__str__(self)
Return str(self).
+ +
+Data descriptors inherited from ai_api_client_sdk.models.base_models.QueryResponse:
+
__dict__
+
dictionary for instance variables
+
+
__weakref__
+
list of weak references to the object
+
+

+ + + + + +
 
Data
       Dict = typing.Dict
+List = typing.List
+ \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.execution.html b/packages/base/docs/ai_api_client_sdk.models.execution.html new file mode 100644 index 0000000..8d89af2 --- /dev/null +++ b/packages/base/docs/ai_api_client_sdk.models.execution.html @@ -0,0 +1,141 @@ + + + + +Python: module ai_api_client_sdk.models.execution + + + + + +
 
ai_api_client_sdk.models.execution		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/execution.py
+

+

+ + + + + +
 
Classes
       
+
ai_api_client_sdk.models.enactment.Enactment(builtins.object) +
+
+
Execution +
+
+
+

+ + + + + + + +
 
class Execution(ai_api_client_sdk.models.enactment.Enactment)
   Execution(
+    id: str,
+    configuration_id: str,
+    configuration_name: str,
+    scenario_id: str,
+    status: ai_api_client_sdk.models.status.Status,
+    target_status: ai_api_client_sdk.models.target_status.TargetStatus,
+    created_at: datetime.datetime,
+    modified_at: datetime.datetime,
+    output_artifacts: List[ai_api_client_sdk.models.artifact.Artifact] = None,
+    status_message: str = None,
+    status_details: Dict[str, Any] = None,
+    submission_time: datetime.datetime = None,
+    start_time: datetime.datetime = None,
+    execution_schedule_id: str = None,
+    completion_time: datetime.datetime = None,
+    **kwargs
+)
+ 
+The Execution object defines an execution
+ 
+: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 configuration_name: Name of the configuration which configured the execution
+:type configuration_name: str
+:param scenario_id: ID of the scenario which the execution belongs to
+:type scenario_id: str
+:param status: Status of the execution
+:type status: class:`ai_api_client_sdk.models.status.Status`
+:param target_status: Target status of the execution
+:type target_status: class:`ai_api_client_sdk.models.target_status.TargetStatus`
+:param execution_schedule_id: ID of the execution schedule, defaults to None
+:type execution_schedule_id: str, optional
+: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 output_artifacts: List of the artifacts created by the execution, defaults to None
+:type output_artifacts: List[class:`ai_api_client_sdk.models.artifact.Artifact`], optional
+:param status_message: Gives information about the status of the execution, defaults to None
+:type status_message: str, optional
+: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
+:param submission_time: Time when the execution was submitted
+:type submission_time: datetime, optional
+:param start_time: Time when the execution status changed to RUNNING
+:type start_time: datetime, optional
+:param completion_time: Time when the execution status changed to COMPLETED/DEAD/STOPPED
+:type completion_time: datetime, optional
+:param `**kwargs`: The keyword arguments are there in case there are additional attributes returned from server
 
 
Method resolution order:
+
Execution
+
ai_api_client_sdk.models.enactment.Enactment
+
builtins.object
+
+
+Methods defined here:
+
__init__( + self, + id: str, + configuration_id: str, + configuration_name: str, + scenario_id: str, + status: ai_api_client_sdk.models.status.Status, + target_status: ai_api_client_sdk.models.target_status.TargetStatus, + created_at: datetime.datetime, + modified_at: datetime.datetime, + output_artifacts: List[ai_api_client_sdk.models.artifact.Artifact] = None, + status_message: str = None, + status_details: Dict[str, Any] = None, + submission_time: datetime.datetime = None, + start_time: datetime.datetime = None, + execution_schedule_id: str = None, + completion_time: datetime.datetime = None, + **kwargs +)
Initialize self.  See help(type(self)) for accurate signature.
+ +
__str__(self)
Return str(self).
+ +
+Static methods defined here:
+
from_dict(execution_dict: Dict[str, Any])
Returns a :class:`ai_api_client_sdk.models.execution.Execution` object, created from the values in the dict
+provided as parameter
+ 
+:param execution_dict: Dict which includes the necessary values to create the object
+:type execution_dict: Dict[str, Any]
+:return: An object, created from the values provided
+:rtype: class:`ai_api_client_sdk.models.execution.Execution`
+ +
+Data descriptors inherited from ai_api_client_sdk.models.enactment.Enactment:
+
__dict__
+
dictionary for instance variables
+
+
__weakref__
+
list of weak references to the object
+
+

+ + + + + +
 
Data
       Dict = typing.Dict
+List = typing.List
+ \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.execution_bulk_modify_response.html b/packages/base/docs/ai_api_client_sdk.models.execution_bulk_modify_response.html new file mode 100644 index 0000000..7d9a938 --- /dev/null +++ b/packages/base/docs/ai_api_client_sdk.models.execution_bulk_modify_response.html @@ -0,0 +1,78 @@ + + + + +Python: module ai_api_client_sdk.models.execution_bulk_modify_response + + + + + +
 
ai_api_client_sdk.models.execution_bulk_modify_response		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/execution_bulk_modify_response.py
+

+

+ + + + + +
 
Classes
       
+
builtins.object +
+
+
ExecutionBulkModifyResponse +
+
+
+

+ + + + + + + +
 
class ExecutionBulkModifyResponse(builtins.object)
   ExecutionBulkModifyResponse(
+    executions: List[Union[ai_api_client_sdk.models.base_models.BasicResponse, ai_api_client_sdk.models.base_models.BulkModifyErrorResponse]],
+    **kwargs
+)
+ 
+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]]
 
 Methods defined here:
+
__init__( + self, + executions: List[Union[ai_api_client_sdk.models.base_models.BasicResponse, ai_api_client_sdk.models.base_models.BulkModifyErrorResponse]], + **kwargs +)
Initialize self.  See help(type(self)) for accurate signature.
+ +
__str__(self)
Return str(self).
+ +
+Static methods defined here:
+
from_dict(response_dict: Dict[str, List[Dict[str, Union[str, Dict]]]])
Returns a :class:`ai_api_client_sdk.models.execution_bulk_modify_response.ExecutionBulkModifyResponse` object,
+created from the values provided as parameter
+ 
+:param response_dict: Which includes the necessary values to create the object
+:type response_dict: Dict[str, List[Dict[str, Union[str, Dict]]]]
+:return: An object, created from the values provided
+:rtype: class:`ai_api_client_sdk.models.execution_bulk_modify_response.ExecutionBulkModifyResponse`
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables
+
+
__weakref__
+
list of weak references to the object
+
+

+ + + + + +
 
Data
       Dict = typing.Dict
+List = typing.List
+Union = typing.Union
+ \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.execution_create_response.html b/packages/base/docs/ai_api_client_sdk.models.execution_create_response.html new file mode 100644 index 0000000..43e66a2 --- /dev/null +++ b/packages/base/docs/ai_api_client_sdk.models.execution_create_response.html @@ -0,0 +1,93 @@ + + + + +Python: module ai_api_client_sdk.models.execution_create_response + + + + + +
 
ai_api_client_sdk.models.execution_create_response		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/execution_create_response.py
+

+

+ + + + + +
 
Classes
       
+
ai_api_client_sdk.models.base_models.BasicResponse(builtins.object) +
+
+
ExecutionCreateResponse +
+
+
+

+ + + + + + + +
 
class ExecutionCreateResponse(ai_api_client_sdk.models.base_models.BasicResponse)
   ExecutionCreateResponse(
+    id: str,
+    message: str,
+    status: ai_api_client_sdk.models.status.Status,
+    **kwargs
+)
+ 
+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
 
 
Method resolution order:
+
ExecutionCreateResponse
+
ai_api_client_sdk.models.base_models.BasicResponse
+
builtins.object
+
+
+Methods defined here:
+
__init__( + self, + id: str, + message: str, + status: ai_api_client_sdk.models.status.Status, + **kwargs +)
Initialize self.  See help(type(self)) for accurate signature.
+ +
+Static methods defined here:
+
from_dict(response_dict: Dict[str, Any])
Returns a :class:`ai_api_client_sdk.models.execution_create_response.ExecutionCreateResponse` object,
+created from the values in the dict provided as parameter
+ 
+:param response_dict: Dict which includes the necessary values to create the object
+:type response_dict: Dict[str, Any]
+:return: An object, created from the values provided
+:rtype: class:`ai_api_client_sdk.models.execution_create_response.ExecutionCreateResponse`
+ +
+Methods inherited from ai_api_client_sdk.models.base_models.BasicResponse:
+
__str__(self)
Return str(self).
+ +
+Data descriptors inherited from ai_api_client_sdk.models.base_models.BasicResponse:
+
__dict__
+
dictionary for instance variables
+
+
__weakref__
+
list of weak references to the object
+
+

+ + + + + +
 
Data
       Dict = typing.Dict
+ \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.execution_get_status_response.html b/packages/base/docs/ai_api_client_sdk.models.execution_get_status_response.html new file mode 100644 index 0000000..6fb2a67 --- /dev/null +++ b/packages/base/docs/ai_api_client_sdk.models.execution_get_status_response.html @@ -0,0 +1,99 @@ + + + + +Python: module ai_api_client_sdk.models.execution_get_status_response + + + + + +
 
ai_api_client_sdk.models.execution_get_status_response		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/execution_get_status_response.py
+

+

+ + + + + +
 
Classes
       
+
ai_api_client_sdk.models.enactment_get_status_response.EnactmentGetStatusResponse(builtins.object) +
+
+
ExecutionGetStatusResponse +
+
+
+

+ + + + + + + +
 
class ExecutionGetStatusResponse(ai_api_client_sdk.models.enactment_get_status_response.EnactmentGetStatusResponse)
   ExecutionGetStatusResponse(
+    id: str,
+    configuration_id: str,
+    status: ai_api_client_sdk.models.status.Status,
+    created_at: datetime.datetime,
+    modified_at: datetime.datetime,
+    status_details: Dict[str, Any] = None
+)
+ 
+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
 
 
Method resolution order:
+
ExecutionGetStatusResponse
+
ai_api_client_sdk.models.enactment_get_status_response.EnactmentGetStatusResponse
+
builtins.object
+
+
+Methods defined here:
+
__init__( + self, + id: str, + configuration_id: str, + status: ai_api_client_sdk.models.status.Status, + created_at: datetime.datetime, + modified_at: datetime.datetime, + status_details: Dict[str, Any] = None +)
Initialize self.  See help(type(self)) for accurate signature.
+ +
__str__(self)
Return str(self).
+ +
+Static methods defined here:
+
from_dict(execution_dict: Dict[str, Any])
Returns a :class:`ai_api_client_sdk.models.execution_get_status_response.ExecutionGetStatusResponse` object,
+ created from the values in the dict provided as parameter
+:param execution_dict: Dict which includes the necessary values to create the object
+:type execution_dict: Dict[str, Any]
+:return: An object, created from the values provided
+:rtype: class:`ai_api_client_sdk.models.execution_get_status_response.ExecutionGetStatusResponse`
+ +
+Data descriptors inherited from ai_api_client_sdk.models.enactment_get_status_response.EnactmentGetStatusResponse:
+
__dict__
+
dictionary for instance variables
+
+
__weakref__
+
list of weak references to the object
+
+

+ + + + + +
 
Data
       Dict = typing.Dict
+ \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.execution_query_response.html b/packages/base/docs/ai_api_client_sdk.models.execution_query_response.html new file mode 100644 index 0000000..7c54721 --- /dev/null +++ b/packages/base/docs/ai_api_client_sdk.models.execution_query_response.html @@ -0,0 +1,90 @@ + + + + +Python: module ai_api_client_sdk.models.execution_query_response + + + + + +
 
ai_api_client_sdk.models.execution_query_response		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/execution_query_response.py
+

+

+ + + + + +
 
Classes
       
+
ai_api_client_sdk.models.base_models.QueryResponse(builtins.object) +
+
+
ExecutionQueryResponse +
+
+
+

+ + + + + + + +
 
class ExecutionQueryResponse(ai_api_client_sdk.models.base_models.QueryResponse)
   ExecutionQueryResponse(
+    resources: List[ai_api_client_sdk.models.execution.Execution],
+    count: int,
+    **kwargs
+)
+ 
+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
 
 
Method resolution order:
+
ExecutionQueryResponse
+
ai_api_client_sdk.models.base_models.QueryResponse
+
builtins.object
+
+
+Methods defined here:
+
__init__( + self, + resources: List[ai_api_client_sdk.models.execution.Execution], + count: int, + **kwargs +)
Initialize self.  See help(type(self)) for accurate signature.
+ +
+Static methods defined here:
+
from_dict(response_dict: Dict[str, Any])
Returns a :class:`ai_api_client_sdk.models.execution_query_response.ExecutionQueryResponse` object, created 
+from the values in the dict provided as parameter
+ 
+:param response_dict: Dict which includes the necessary values to create the object
+:type response_dict: Dict[str, Any]
+:return: An object, created from the values provided
+:rtype: class:`ai_api_client_sdk.models.execution_query_response.ExecutionQueryResponse`
+ +
+Methods inherited from ai_api_client_sdk.models.base_models.QueryResponse:
+
__str__(self)
Return str(self).
+ +
+Data descriptors inherited from ai_api_client_sdk.models.base_models.QueryResponse:
+
__dict__
+
dictionary for instance variables
+
+
__weakref__
+
list of weak references to the object
+
+

+ + + + + +
 
Data
       Dict = typing.Dict
+List = typing.List
+ \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.execution_schedule.html b/packages/base/docs/ai_api_client_sdk.models.execution_schedule.html new file mode 100644 index 0000000..f6180a1 --- /dev/null +++ b/packages/base/docs/ai_api_client_sdk.models.execution_schedule.html @@ -0,0 +1,110 @@ + + + + +Python: module ai_api_client_sdk.models.execution_schedule + + + + + +
 
ai_api_client_sdk.models.execution_schedule		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/execution_schedule.py
+

+

+ + + + + +
 
Classes
       
+
builtins.object +
+
+
ExecutionSchedule +
+
+
+

+ + + + + + + +
 
class ExecutionSchedule(builtins.object)
   ExecutionSchedule(
+    id: str,
+    name: str,
+    cron: str,
+    configuration_id: str,
+    status: ai_api_client_sdk.models.status.ScheduleStatus,
+    created_at: datetime.datetime,
+    modified_at: datetime.datetime,
+    start: datetime.datetime = None,
+    end: datetime.datetime = None,
+    **kwargs
+)
+ 
+An Execution Schedule allows to trigger executions periodically
+ 
+:param id: ID of the execution schedule
+:type id: str
+:param name: Name of the execution schedule
+:type name: str
+:param cron: Cron defining the schedule to run the executions
+:type cron: str
+:param configuration_id: ID of the configuration for the execution schedule
+:type configuration_id: str
+:param status: status of the execution schedule
+:type status: str
+:param created_at: Time when the execution schedule was created
+:type created_at: datetime, optional
+:param modified_at: Time when the execution schedule was last modified
+:type modified_at: datetime, optional
+:param start: Start time of the execution schedule
+:type start: datetime, optional
+:param end: End time of the execution schedule
+:type end: datetime, optional
+:param `**kwargs`: The keyword arguments are there in case there are additional attributes returned from server
 
 Methods defined here:
+
__init__( + self, + id: str, + name: str, + cron: str, + configuration_id: str, + status: ai_api_client_sdk.models.status.ScheduleStatus, + created_at: datetime.datetime, + modified_at: datetime.datetime, + start: datetime.datetime = None, + end: datetime.datetime = None, + **kwargs +)
Initialize self.  See help(type(self)) for accurate signature.
+ +
__str__(self)
Return str(self).
+ +
+Static methods defined here:
+
from_dict(execution_schedule_dict: Dict[str, Any])
Returns a :class:`ai_api_client_sdk.models.execution_schedule.Schedule` object, created from the values in
+the dict provided as parameter
+ 
+:param execution_schedule_dict: Dict which includes the necessary values to create the object
+:type execution_schedule_dict: Dict[str, Any]
+:return: An object, created from the values provided
+:rtype: class:`ai_api_client_sdk.models.execution_schedule.Schedule`
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables
+
+
__weakref__
+
list of weak references to the object
+
+

+ + + + + +
 
Data
       Dict = typing.Dict
+ \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.execution_schedule_create_response.html b/packages/base/docs/ai_api_client_sdk.models.execution_schedule_create_response.html new file mode 100644 index 0000000..3aea875 --- /dev/null +++ b/packages/base/docs/ai_api_client_sdk.models.execution_schedule_create_response.html @@ -0,0 +1,74 @@ + + + + +Python: module ai_api_client_sdk.models.execution_schedule_create_response + + + + + +
 
ai_api_client_sdk.models.execution_schedule_create_response		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/execution_schedule_create_response.py
+

+

+ + + + + +
 
Classes
       
+
ai_api_client_sdk.models.base_models.BasicResponse(builtins.object) +
+
+
ExecutionScheduleCreateResponse +
+
+
+

+ + + + + + + +
 
class ExecutionScheduleCreateResponse(ai_api_client_sdk.models.base_models.BasicResponse)
   ExecutionScheduleCreateResponse(id: str, message: str, **kwargs)
+ 
+The ExecutionScheduleCreateResponse object defines the response of the execution schedule create request.
+Refer to :class:`ai_api_client_sdk.models.base_models.BasicResponse`, for the object definition
 
 
Method resolution order:
+
ExecutionScheduleCreateResponse
+
ai_api_client_sdk.models.base_models.BasicResponse
+
builtins.object
+
+
+Static methods defined here:
+
from_dict(response_dict: Dict[str, Any])
Returns a :class:`ai_api_client_sdk.models.execution_schedule_create_response.ExecutionScheduleCreateResponse`
+object, created from the values in the dict provided as parameter
+ 
+:param response_dict: Dict which includes the necessary values to create the object
+:type response_dict: Dict[str, Any]
+:return: An object, created from the values provided
+:rtype: class:`ai_api_client_sdk.models.execution_schedule_create_response.ExecutionScheduleCreateResponse`
+ +
+Methods inherited from ai_api_client_sdk.models.base_models.BasicResponse:
+
__init__(self, id: str, message: str, **kwargs)
Initialize self.  See help(type(self)) for accurate signature.
+ +
__str__(self)
Return str(self).
+ +
+Data descriptors inherited from ai_api_client_sdk.models.base_models.BasicResponse:
+
__dict__
+
dictionary for instance variables
+
+
__weakref__
+
list of weak references to the object
+
+

+ + + + + +
 
Data
       Dict = typing.Dict
+ \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.execution_schedule_query_response.html b/packages/base/docs/ai_api_client_sdk.models.execution_schedule_query_response.html new file mode 100644 index 0000000..3d80313 --- /dev/null +++ b/packages/base/docs/ai_api_client_sdk.models.execution_schedule_query_response.html @@ -0,0 +1,90 @@ + + + + +Python: module ai_api_client_sdk.models.execution_schedule_query_response + + + + + +
 
ai_api_client_sdk.models.execution_schedule_query_response		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/execution_schedule_query_response.py
+

+

+ + + + + +
 
Classes
       
+
ai_api_client_sdk.models.base_models.QueryResponse(builtins.object) +
+
+
ExecutionScheduleQueryResponse +
+
+
+

+ + + + + + + +
 
class ExecutionScheduleQueryResponse(ai_api_client_sdk.models.base_models.QueryResponse)
   ExecutionScheduleQueryResponse(
+    resources: List[ai_api_client_sdk.models.execution_schedule.ExecutionSchedule],
+    count: int,
+    **kwargs
+)
+ 
+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
 
 
Method resolution order:
+
ExecutionScheduleQueryResponse
+
ai_api_client_sdk.models.base_models.QueryResponse
+
builtins.object
+
+
+Methods defined here:
+
__init__( + self, + resources: List[ai_api_client_sdk.models.execution_schedule.ExecutionSchedule], + count: int, + **kwargs +)
Initialize self.  See help(type(self)) for accurate signature.
+ +
+Static methods defined here:
+
from_dict(response_dict: Dict[str, Any])
Returns a :class:`ai_api_client_sdk.models.execution_schedule_query_response.ExecutionScheduleQueryResponse`
+object, created from the values in the dict provided as parameter
+ 
+:param response_dict: Dict which includes the necessary values to create the object
+:type response_dict: Dict[str, Any]
+:return: An object, created from the values provided
+:rtype: class:`ai_api_client_sdk.models.execution_schedule_query_response.ExecutionScheduleQueryResponse`
+ +
+Methods inherited from ai_api_client_sdk.models.base_models.QueryResponse:
+
__str__(self)
Return str(self).
+ +
+Data descriptors inherited from ai_api_client_sdk.models.base_models.QueryResponse:
+
__dict__
+
dictionary for instance variables
+
+
__weakref__
+
list of weak references to the object
+
+

+ + + + + +
 
Data
       Dict = typing.Dict
+List = typing.List
+ \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.extensions.html b/packages/base/docs/ai_api_client_sdk.models.extensions.html new file mode 100644 index 0000000..e12ea47 --- /dev/null +++ b/packages/base/docs/ai_api_client_sdk.models.extensions.html @@ -0,0 +1,93 @@ + + + + +Python: module ai_api_client_sdk.models.extensions + + + + + +
 
ai_api_client_sdk.models.extensions		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/extensions.py
+

+

+ + + + + +
 
Classes
       
+
builtins.object +
+
+
Extensions +
+
+
+

+ + + + + + + +
 
class Extensions(builtins.object)
   Extensions(
+    analytics: ai_api_client_sdk.models.extensions_analytics.ExtensionsAnalytics = None,
+    resource_groups: ai_api_client_sdk.models.extensions_resource_groups.ExtensionsResourceGroups = None,
+    dataset: ai_api_client_sdk.models.extensions_dataset.ExtensionsDataset = None,
+    **kwargs
+)
+ 
+The Extensions object represents the extensions to the AI API
+ 
+:param analytics: Metadata and capabilities of the Analytics API, defaults to None
+:type analytics: class:`ai_api_client_sdk.models.extensions_analytics.ExtensionsAnalytics`, optional
+:param resource_groups: Metadata and capabilities of the Resource Groups API, defaults to None
+:type resource_groups: class:`ai_api_client_sdk.models.extensions_resource_groups.ExtensionsResourceGroups`,
+    optional
+:param dataset: Metadata and capabilities of the Dataset API, defaults to None
+:type dataset: class:`ai_api_client_sdk.models.extensions_dataset.ExtensionsDataset`, optional
+:param `**kwargs`: The keyword arguments are there in case there are additional attributes returned from server
 
 Methods defined here:
+
__eq__(self, other)
Return self==value.
+ +
__init__( + self, + analytics: ai_api_client_sdk.models.extensions_analytics.ExtensionsAnalytics = None, + resource_groups: ai_api_client_sdk.models.extensions_resource_groups.ExtensionsResourceGroups = None, + dataset: ai_api_client_sdk.models.extensions_dataset.ExtensionsDataset = None, + **kwargs +)
Initialize self.  See help(type(self)) for accurate signature.
+ +
__str__(self)
Return str(self).
+ +
+Static methods defined here:
+
from_dict(extensions_dict: Dict[str, Any])
Returns a :class:`ai_api_client_sdk.models.extensions.Extensions` object, created from the values in the
+dict provided as parameter
+ 
+:param extensions_dict: Dict which includes the necessary values to create the object
+:type extensions_dict: Dict[str, Any]
+:return: An object, created from the values provided
+:rtype: class:`ai_api_client_sdk.models.extensions.Extensions`
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables
+
+
__weakref__
+
list of weak references to the object
+
+
+Data and other attributes defined here:
+
__hash__ = None
+ +

+ + + + + +
 
Data
       Dict = typing.Dict
+ \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.extensions_analytics.html b/packages/base/docs/ai_api_client_sdk.models.extensions_analytics.html new file mode 100644 index 0000000..37c549a --- /dev/null +++ b/packages/base/docs/ai_api_client_sdk.models.extensions_analytics.html @@ -0,0 +1,77 @@ + + + + +Python: module ai_api_client_sdk.models.extensions_analytics + + + + + +
 
ai_api_client_sdk.models.extensions_analytics		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/extensions_analytics.py
+

+

+ + + + + +
 
Classes
       
+
builtins.object +
+
+
ExtensionsAnalytics +
+
+
+

+ + + + + + + +
 
class ExtensionsAnalytics(builtins.object)
   ExtensionsAnalytics(version: str, **kwargs)
+ 
+The ExtensionsAnalytics object represents the metadata and capabilities of the Analytics API
+ 
+:param version: Version of the Analytics API
+:type version: str
+:param `**kwargs`: The keyword arguments are there in case there are additional attributes returned from server
 
 Methods defined here:
+
__eq__(self, other)
Return self==value.
+ +
__init__(self, version: str, **kwargs)
Initialize self.  See help(type(self)) for accurate signature.
+ +
__str__(self)
Return str(self).
+ +
+Static methods defined here:
+
from_dict(extensions_analytics_dict: Dict[str, str])
Returns a :class:`ai_api_client_sdk.models.extensions_analytics.ExtensionsAnalytics` object, created from
+the values in the dict provided as parameter
+ 
+:param extensions_analytics_dict: Dict which includes the necessary values to create the object
+:type extensions_analytics_dict: Dict[str, str]
+:return: An object, created from the values provided
+:rtype: class:`ai_api_client_sdk.models.extensions_analytics.ExtensionsAnalytics`
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables
+
+
__weakref__
+
list of weak references to the object
+
+
+Data and other attributes defined here:
+
__hash__ = None
+ +

+ + + + + +
 
Data
       Dict = typing.Dict
+ \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.extensions_dataset.html b/packages/base/docs/ai_api_client_sdk.models.extensions_dataset.html new file mode 100644 index 0000000..15d0b75 --- /dev/null +++ b/packages/base/docs/ai_api_client_sdk.models.extensions_dataset.html @@ -0,0 +1,92 @@ + + + + +Python: module ai_api_client_sdk.models.extensions_dataset + + + + + +
 
ai_api_client_sdk.models.extensions_dataset		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/extensions_dataset.py
+

+

+ + + + + +
 
Classes
       
+
builtins.object +
+
+
ExtensionsDataset +
+
+
+

+ + + + + + + +
 
class ExtensionsDataset(builtins.object)
   ExtensionsDataset(
+    version: str,
+    capabilities: ai_api_client_sdk.models.dataset_capabilities.DatasetCapabilities = None,
+    limits: ai_api_client_sdk.models.dataset_limits.DatasetLimits = None,
+    **kwargs
+)
+ 
+The ExtensionsDataset object represents the metadata and capabilities of the Dataset API
+ 
+:param version: Version of the Dataset API
+:type version: str
+:param capabilities: Capabilities of the Dataset API, defaults to None
+:type capabilities: class:`ai_api_client_sdk.models.dataset_capabilities.DatasetCapabilities`, optional
+:param limits: Limits of the Dataset API, defaults to None
+:type limits: class:`ai_api_client_sdk.models.dataset_limits.DatasetLimits`, optional
+:param `**kwargs`: The keyword arguments are there in case there are additional attributes returned from server
 
 Methods defined here:
+
__eq__(self, other)
Return self==value.
+ +
__init__( + self, + version: str, + capabilities: ai_api_client_sdk.models.dataset_capabilities.DatasetCapabilities = None, + limits: ai_api_client_sdk.models.dataset_limits.DatasetLimits = None, + **kwargs +)
Initialize self.  See help(type(self)) for accurate signature.
+ +
__str__(self)
Return str(self).
+ +
+Static methods defined here:
+
from_dict(extensions_dataset_dict: Dict[str, Any])
Returns a :class:`ai_api_client_sdk.models.extensions_dataset.ExtensionsDataset` object, created from the
+values in the dict provided as parameter
+ 
+:param extensions_dataset_dict: Dict which includes the necessary values to create the object
+:type extensions_dataset_dict: Dict[str, Any]
+:return: An object, created from the values provided
+:rtype: class:`ai_api_client_sdk.models.extensions_dataset.ExtensionsDataset`
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables
+
+
__weakref__
+
list of weak references to the object
+
+
+Data and other attributes defined here:
+
__hash__ = None
+ +

+ + + + + +
 
Data
       Dict = typing.Dict
+ \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.extensions_resource_groups.html b/packages/base/docs/ai_api_client_sdk.models.extensions_resource_groups.html new file mode 100644 index 0000000..5be017e --- /dev/null +++ b/packages/base/docs/ai_api_client_sdk.models.extensions_resource_groups.html @@ -0,0 +1,77 @@ + + + + +Python: module ai_api_client_sdk.models.extensions_resource_groups + + + + + +
 
ai_api_client_sdk.models.extensions_resource_groups		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/extensions_resource_groups.py
+

+

+ + + + + +
 
Classes
       
+
builtins.object +
+
+
ExtensionsResourceGroups +
+
+
+

+ + + + + + + +
 
class ExtensionsResourceGroups(builtins.object)
   ExtensionsResourceGroups(version: str, **kwargs)
+ 
+The ExtensionsResourceGroups object represents the metadata and capabilities of the Resource Groups API
+ 
+:param version: Version of the Resource Groups API
+:type version: str
+:param `**kwargs`: The keyword arguments are there in case there are additional attributes returned from server
 
 Methods defined here:
+
__eq__(self, other)
Return self==value.
+ +
__init__(self, version: str, **kwargs)
Initialize self.  See help(type(self)) for accurate signature.
+ +
__str__(self)
Return str(self).
+ +
+Static methods defined here:
+
from_dict(extensions_resource_groups_dict: Dict[str, str])
Returns a :class:`ai_api_client_sdk.models.extensions_resource_groups.ExtensionsResourceGroups` object,
+created from the values in the dict provided as parameter
+ 
+:param extensions_resource_groups_dict: Dict which includes the necessary values to create the object
+:type extensions_resource_groups_dict: Dict[str, str]
+:return: An object, created from the values provided
+:rtype: class:`ai_api_client_sdk.models.extensions_resource_groups.ExtensionsResourceGroups`
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables
+
+
__weakref__
+
list of weak references to the object
+
+
+Data and other attributes defined here:
+
__hash__ = None
+ +

+ + + + + +
 
Data
       Dict = typing.Dict
+ \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.healthz_status.html b/packages/base/docs/ai_api_client_sdk.models.healthz_status.html new file mode 100644 index 0000000..fcccd7e --- /dev/null +++ b/packages/base/docs/ai_api_client_sdk.models.healthz_status.html @@ -0,0 +1,139 @@ + + + + +Python: module ai_api_client_sdk.models.healthz_status + + + + + +
 
ai_api_client_sdk.models.healthz_status		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/healthz_status.py
+

+

+ + + + + +
 
Classes
       
+
builtins.object +
+
+
HealthzStatus +
+
+
enum.Enum(builtins.object) +
+
+
HealthStatus +
+
+
+

+ + + + + + + +
 
class HealthStatus(enum.Enum)
   HealthStatus(*values)
+ 
+
 
 
Method resolution order:
+
HealthStatus
+
enum.Enum
+
builtins.object
+
+
+Data and other attributes defined here:
+
NOT_READY = <HealthStatus.NOT_READY: 'NOT READY'>
+ +
READY = <HealthStatus.READY: 'READY'>
+ +
+Data descriptors inherited from enum.Enum:
+
name
+
The name of the Enum member.
+
+
value
+
The value of the Enum member.
+
+
+Static methods inherited from enum.EnumType:
+
__contains__(value)
Return True if `value` is in `cls`.
+ 
+`value` is in `cls` if:
+1) `value` is a member of `cls`, or
+2) `value` is the value of one of the `cls`'s members.
+3) `value` is a pseudo-member (flags)
+ +
__getitem__(name)
Return the member matching `name`.
+ +
__iter__()
Return members in definition order.
+ +
__len__()
Return the number of members (no aliases)
+ +
+Readonly properties inherited from enum.EnumType:
+
__members__
+
Returns a mapping of member name->value.
+ 
+This mapping lists all enum members, including aliases.  Note that
+this is a read-only view of the internal mapping.
+
+

+ + + + + + + +
 
class HealthzStatus(builtins.object)
   HealthzStatus(
+    status: ai_api_client_sdk.models.healthz_status.HealthStatus,
+    message: str,
+    **kwargs
+)
+ 
+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
 
 Methods defined here:
+
__init__( + self, + status: ai_api_client_sdk.models.healthz_status.HealthStatus, + message: str, + **kwargs +)
Initialize self.  See help(type(self)) for accurate signature.
+ +
__str__(self)
Return str(self).
+ +
+Static methods defined here:
+
from_dict(healthz_status_dict: Dict[str, Any])
Returns a :class:`ai_api_client_sdk.models.healthz_status.HealthzStatus` object, created from the values in
+the dict provided as parameter
+ 
+:param healthz_status_dict: Dict which includes the necessary values to create the object
+:type healthz_status_dict: Dict[str, str]
+:return: An object, created from the values provided
+:rtype: class:`ai_api_client_sdk.models.healthz_status.HealthzStatus`
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables
+
+
__weakref__
+
list of weak references to the object
+
+

+ + + + + +
 
Data
       Dict = typing.Dict
+ \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.html b/packages/base/docs/ai_api_client_sdk.models.html new file mode 100644 index 0000000..e9cf1ce --- /dev/null +++ b/packages/base/docs/ai_api_client_sdk.models.html @@ -0,0 +1,88 @@ + + + + +Python: package ai_api_client_sdk.models + + + + + +
 
ai_api_client_sdk.models		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/__init__.py
+

+

+ + + + + +
 
Package Contents
       
ai_api_capabilities
+ai_api_capabilities_bulk_updates
+ai_api_capabilities_logs
+ai_api_limits
+ai_api_limits_deployments
+ai_api_limits_enactments
+ai_api_limits_executions
+ai_api_meta
+api_version
+artifact
+artifact_create_response
+artifact_query_response
+base_models
+capabilities
+configuration
+configuration_create_response
+configuration_query_response
+		dataset_capabilities
+dataset_limits
+deployment
+deployment_bulk_modify_response
+deployment_create_response
+deployment_get_status_response
+deployment_query_response
+enactment
+enactment_get_status_response
+executable
+executable_query_response
+execution
+execution_bulk_modify_response
+execution_create_response
+execution_get_status_response
+execution_query_response
+execution_schedule
+		execution_schedule_create_response
+execution_schedule_query_response
+extensions
+extensions_analytics
+extensions_dataset
+extensions_resource_groups
+healthz_status
+input_artifact
+input_artifact_binding
+label
+log_response
+metric
+metric_custom_info
+metric_label
+metric_resource
+metric_tag
+metrics_query_response
+		model
+model_base_data_allowed_scenarios
+model_query_response
+model_version
+output_artifact
+parameter
+parameter_binding
+resource_group
+resource_group_query_response
+resource_group_status
+scenario
+scenario_query_response
+status
+target_status
+version
+version_list
+version_query_response
+
+ \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.input_artifact.html b/packages/base/docs/ai_api_client_sdk.models.input_artifact.html new file mode 100644 index 0000000..0305cbe --- /dev/null +++ b/packages/base/docs/ai_api_client_sdk.models.input_artifact.html @@ -0,0 +1,93 @@ + + + + +Python: module ai_api_client_sdk.models.input_artifact + + + + + +
 
ai_api_client_sdk.models.input_artifact		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/input_artifact.py
+

+

+ + + + + +
 
Classes
       
+
builtins.object +
+
+
InputArtifact +
+
+
+

+ + + + + + + +
 
class InputArtifact(builtins.object)
   InputArtifact(
+    name: str,
+    kind: str = None,
+    description: str = None,
+    labels: List[ai_api_client_sdk.models.label.Label] = None
+)
+ 
+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`]
 
 Methods defined here:
+
__eq__(self, other)
Return self==value.
+ +
__init__( + self, + name: str, + kind: str = None, + description: str = None, + labels: List[ai_api_client_sdk.models.label.Label] = None +)
Initialize self.  See help(type(self)) for accurate signature.
+ +
__str__(self)
Return str(self).
+ +
+Static methods defined here:
+
from_dict(input_artifact_dict: Dict[str, Any])
Returns a :class:`ai_api_client_sdk.models.input_artifact.InputArtifact` object, created from the values
+in the dict provided as parameter
+ 
+:param input_artifact_dict: Dict which includes the necessary values to create the object
+:type input_artifact_dict: Dict[str, Any]
+:return: An object, created from the values provided
+:rtype: class:`ai_api_client_sdk.models.input_artifact.InputArtifact`
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables
+
+
__weakref__
+
list of weak references to the object
+
+
+Data and other attributes defined here:
+
__hash__ = None
+ +

+ + + + + +
 
Data
       Dict = typing.Dict
+List = typing.List
+ \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.input_artifact_binding.html b/packages/base/docs/ai_api_client_sdk.models.input_artifact_binding.html new file mode 100644 index 0000000..eeeb524 --- /dev/null +++ b/packages/base/docs/ai_api_client_sdk.models.input_artifact_binding.html @@ -0,0 +1,82 @@ + + + + +Python: module ai_api_client_sdk.models.input_artifact_binding + + + + + +
 
ai_api_client_sdk.models.input_artifact_binding		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/input_artifact_binding.py
+

+

+ + + + + +
 
Classes
       
+
builtins.object +
+
+
InputArtifactBinding +
+
+
+

+ + + + + + + +
 
class InputArtifactBinding(builtins.object)
   InputArtifactBinding(key: str, artifact_id: str, **kwargs)
+ 
+The InputArtifactBinding object defines the input artifact specified in the configuration.
+ 
+:param key: matches the input artifact name in the executable definition
+:type key: str
+:param id: ID of the artifact
+:type id: str
+:param `**kwargs`: The keyword arguments are there in case there are additional attributes returned from server
 
 Methods defined here:
+
__eq__(self, other)
Return self==value.
+ +
__init__(self, key: str, artifact_id: str, **kwargs)
Initialize self.  See help(type(self)) for accurate signature.
+ +
to_dict(self) -> Dict[str, str]
Returns the attributes of the object as a dictionary
+ 
+:return: A dict, including all the attributes of the object
+:rtype: Dict[str, str]
+ +
+Static methods defined here:
+
from_dict(input_artifact_binding_dict: Dict[str, str])
Returns a :class:`ai_api_client_sdk.models.input_artifact_binding.InputArtifactBinding` object, created from
+the values in the dict provided as parameter
+ 
+:param input_artifact_binding_dict: Dict which includes the necessary values to create the object
+:type input_artifact_binding_dict: Dict[str, Any]
+:return: An object, created from the values provided
+:rtype: class:`ai_api_client_sdk.models.input_artifact_binding.InputArtifactBinding`
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables
+
+
__weakref__
+
list of weak references to the object
+
+
+Data and other attributes defined here:
+
__hash__ = None
+ +

+ + + + + +
 
Data
       Dict = typing.Dict
+ \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.label.html b/packages/base/docs/ai_api_client_sdk.models.label.html new file mode 100644 index 0000000..305f950 --- /dev/null +++ b/packages/base/docs/ai_api_client_sdk.models.label.html @@ -0,0 +1,84 @@ + + + + +Python: module ai_api_client_sdk.models.label + + + + + +
 
ai_api_client_sdk.models.label		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/label.py
+

+

+ + + + + +
 
Classes
       
+
ai_api_client_sdk.models.base_models.KeyValue(builtins.object) +
+
+
Label +
+
+
+

+ + + + + + + +
 
class Label(ai_api_client_sdk.models.base_models.KeyValue)
   Label(key: str, value: str, **kwargs)
+ 
+The Label object defines a label as a key-value pair. Refer to
+:class:`ai_api_client_sdk.models.base_models.KeyValue`, for the object definition
 
 
Method resolution order:
+
Label
+
ai_api_client_sdk.models.base_models.KeyValue
+
builtins.object
+
+
+Methods defined here:
+
__str__(self)
Return str(self).
+ +
+Static methods defined here:
+
from_dict(label_dict: Dict[str, str])
Returns a :class:`ai_api_client_sdk.models.label.Label` object, created from the values in the dict provided
+as parameter
+ 
+:param label_dict: Dict which includes the necessary values to create the object
+:type label_dict: Dict[str, Any]
+:return: An object, created from the values provided
+:rtype: class:`ai_api_client_sdk.models.label.Label`
+ +
+Methods inherited from ai_api_client_sdk.models.base_models.KeyValue:
+
__eq__(self, other)
Return self==value.
+ +
__init__(self, key: str, value: str, **kwargs)
Initialize self.  See help(type(self)) for accurate signature.
+ +
to_dict(self)
+ +
+Data descriptors inherited from ai_api_client_sdk.models.base_models.KeyValue:
+
__dict__
+
dictionary for instance variables
+
+
__weakref__
+
list of weak references to the object
+
+
+Data and other attributes inherited from ai_api_client_sdk.models.base_models.KeyValue:
+
__hash__ = None
+ +

+ + + + + +
 
Data
       Dict = typing.Dict
+ \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.log_response.html b/packages/base/docs/ai_api_client_sdk.models.log_response.html new file mode 100644 index 0000000..f60d310 --- /dev/null +++ b/packages/base/docs/ai_api_client_sdk.models.log_response.html @@ -0,0 +1,157 @@ + + + + +Python: module ai_api_client_sdk.models.log_response + + + + + +
 
ai_api_client_sdk.models.log_response		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/log_response.py
+

+

+ + + + + +
 
Classes
       
+
builtins.object +
+
+
LogResponse +
LogResponseData +
LogResultItem +
+
+
+

+ + + + + + + +
 
class LogResponse(builtins.object)
   LogResponse(
+    data: ai_api_client_sdk.models.log_response.LogResponseData,
+    **kwargs
+)
+ 
+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
 
 Methods defined here:
+
__init__( + self, + data: ai_api_client_sdk.models.log_response.LogResponseData, + **kwargs +)
Initialize self.  See help(type(self)) for accurate signature.
+ +
__str__(self)
Return str(self).
+ +
+Static methods defined here:
+
from_dict(log_response_dict: Dict[str, Any])
Returns a :class:`ai_api_client_sdk.models.log_response.LogResponse` object, created from the values
+in the dict provided as parameter
+ 
+:param log_response_dict: Dict which includes the necessary values to create the object
+:type log_response_dict: Dict[str, Any]
+:return: An object, created from the values provided
+:rtype: class:`ai_api_client_sdk.models.log_response.LogResponse`
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables
+
+
__weakref__
+
list of weak references to the object
+
+

+ + + + + + + +
 
class LogResponseData(builtins.object)
   LogResponseData(
+    result: List[ai_api_client_sdk.models.log_response.LogResultItem],
+    **kwargs
+)
+ 
+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
 
 Methods defined here:
+
__init__( + self, + result: List[ai_api_client_sdk.models.log_response.LogResultItem], + **kwargs +)
Initialize self.  See help(type(self)) for accurate signature.
+ +
+Static methods defined here:
+
from_dict(log_response_data_dict: Dict[str, Any])
Returns a :class:`ai_api_client_sdk.models.log_response.LogResponseData` object, created from the values
+in the dict provided as parameter
+ 
+:param log_response_data_dict: Dict which includes the necessary values to create the object
+:type log_response_data_dict: Dict[str, Any]
+:return: An object, created from the values provided
+:rtype: class:`ai_api_client_sdk.models.log_response.LogResponseData`
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables
+
+
__weakref__
+
list of weak references to the object
+
+

+ + + + + + + +
 
class LogResultItem(builtins.object)
   LogResultItem(msg: str, timestamp: datetime.datetime, **kwargs)
+ 
+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
 
 Methods defined here:
+
__init__(self, msg: str, timestamp: datetime.datetime, **kwargs)
Initialize self.  See help(type(self)) for accurate signature.
+ +
+Static methods defined here:
+
from_dict(log_result_item_dict: Dict[str, str])
Returns a :class:`ai_api_client_sdk.models.log_response.LogResultItem` object, created from the values
+in the dict provided as parameter
+ 
+:param log_result_item_dict: Dict which includes the necessary values to create the object
+:type log_result_item_dict: Dict[str, Any]
+:return: An object, created from the values provided
+:rtype: class:`ai_api_client_sdk.models.log_response.LogResultItem`
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables
+
+
__weakref__
+
list of weak references to the object
+
+

+ + + + + +
 
Data
       Dict = typing.Dict
+List = typing.List
+ \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.metric.html b/packages/base/docs/ai_api_client_sdk.models.metric.html new file mode 100644 index 0000000..3a93157 --- /dev/null +++ b/packages/base/docs/ai_api_client_sdk.models.metric.html @@ -0,0 +1,107 @@ + + + + +Python: module ai_api_client_sdk.models.metric + + + + + +
 
ai_api_client_sdk.models.metric		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/metric.py
+

+

+ + + + + +
 
Classes
       
+
builtins.object +
+
+
Metric +
+
+
+

+ + + + + + + +
 
class Metric(builtins.object)
   Metric(
+    name: str,
+    value: float,
+    timestamp: datetime.datetime,
+    step: int = None,
+    labels: List[ai_api_client_sdk.models.metric_label.MetricLabel] = None,
+    **kwargs
+)
+ 
+The Metric object, defines a single metric.
+ 
+:param name: Name of the metric
+:type name: str
+:param value: numeric value of the metric
+:type value: float
+:param timestamp: Time when the metric was created
+:type timestamp: datetime
+:param step: any measurement of training progress (number of training iterations, number of epochs, etc.)
+:type step: int
+:param labels: List of the labels of the metric, defaults to None
+:type labels: List[class:`ai_api_client_sdk.models.metric_label.MetricLabel`]
+:param `**kwargs`: The keyword arguments are there in case there are additional attributes returned from server
 
 Methods defined here:
+
__eq__(self, other)
Return self==value.
+ +
__init__( + self, + name: str, + value: float, + timestamp: datetime.datetime, + step: int = None, + labels: List[ai_api_client_sdk.models.metric_label.MetricLabel] = None, + **kwargs +)
Initialize self.  See help(type(self)) for accurate signature.
+ +
__str__(self)
Return str(self).
+ +
to_dict(self)
Returns the attributes of the object as a dictionary
+ 
+:return: A dict, including all the attributes of the object
+:rtype: Dict[str, str]
+ +
+Static methods defined here:
+
from_dict(metric_dict: Dict[str, Any])
Returns a :class:`ai_api_client_sdk.models.metric.Metric` object, created from the values in the dict
+provided as parameter
+ 
+:param metric_dict: Dict which includes the necessary values to create the object
+:type metric_dict: Dict[str, Any]
+:return: An object, created from the values provided
+:rtype: class:`ai_api_client_sdk.models.metric.Metric`
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables
+
+
__weakref__
+
list of weak references to the object
+
+
+Data and other attributes defined here:
+
__hash__ = None
+ +

+ + + + + +
 
Data
       DATETIME_FORMAT = '%Y-%m-%dT%H:%M:%SZ'
+Dict = typing.Dict
+List = typing.List
+ \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.metric_custom_info.html b/packages/base/docs/ai_api_client_sdk.models.metric_custom_info.html new file mode 100644 index 0000000..33c1f07 --- /dev/null +++ b/packages/base/docs/ai_api_client_sdk.models.metric_custom_info.html @@ -0,0 +1,81 @@ + + + + +Python: module ai_api_client_sdk.models.metric_custom_info + + + + + +
 
ai_api_client_sdk.models.metric_custom_info		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/metric_custom_info.py
+

+

+ + + + + +
 
Classes
       
+
ai_api_client_sdk.models.base_models.NameValue(builtins.object) +
+
+
MetricCustomInfo +
+
+
+

+ + + + + + + +
 
class MetricCustomInfo(ai_api_client_sdk.models.base_models.NameValue)
   MetricCustomInfo(name: str, value: str, **kwargs)
+ 
+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
+:class:`ai_api_client_sdk.models.base_models.NameValue`, for the object definition
 
 
Method resolution order:
+
MetricCustomInfo
+
ai_api_client_sdk.models.base_models.NameValue
+
builtins.object
+
+
+Static methods defined here:
+
from_dict(metric_custom_info_dict: Dict[str, str])
Returns a :class:`ai_api_client_sdk.models.metric_custom_info.MetricCustomInfo` object, created from the
+values in the dict provided as parameter
+ 
+:param metric_custom_info_dict: Dict which includes the necessary values to create the object
+:type metric_custom_info_dict: Dict[str, Any]
+:return: An object, created from the values provided
+:rtype: class:`ai_api_client_sdk.models.metric_custom_info.MetricCustomInfo`
+ +
+Methods inherited from ai_api_client_sdk.models.base_models.NameValue:
+
__eq__(self, other)
Return self==value.
+ +
__init__(self, name: str, value: str, **kwargs)
Initialize self.  See help(type(self)) for accurate signature.
+ +
__str__(self)
Return str(self).
+ +
+Data descriptors inherited from ai_api_client_sdk.models.base_models.NameValue:
+
__dict__
+
dictionary for instance variables
+
+
__weakref__
+
list of weak references to the object
+
+
+Data and other attributes inherited from ai_api_client_sdk.models.base_models.NameValue:
+
__hash__ = None
+ +

+ + + + + +
 
Data
       Dict = typing.Dict
+ \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.metric_label.html b/packages/base/docs/ai_api_client_sdk.models.metric_label.html new file mode 100644 index 0000000..34d5ddd --- /dev/null +++ b/packages/base/docs/ai_api_client_sdk.models.metric_label.html @@ -0,0 +1,87 @@ + + + + +Python: module ai_api_client_sdk.models.metric_label + + + + + +
 
ai_api_client_sdk.models.metric_label		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/metric_label.py
+

+

+ + + + + +
 
Classes
       
+
ai_api_client_sdk.models.base_models.NameValue(builtins.object) +
+
+
MetricLabel +
+
+
+

+ + + + + + + +
 
class MetricLabel(ai_api_client_sdk.models.base_models.NameValue)
   MetricLabel(name: str, value: str, **kwargs)
+ 
+The MetricLabel object defines a metric label as a name-value pair. Refer to
+:class:`ai_api_client_sdk.models.base_models.NameValue`, for the object definition
 
 
Method resolution order:
+
MetricLabel
+
ai_api_client_sdk.models.base_models.NameValue
+
builtins.object
+
+
+Methods defined here:
+
to_dict(self)
Returns the attributes of the object as a dictionary
+ 
+:return: A dict, including all the attributes of the object
+:rtype: Dict[str, str]
+ +
+Static methods defined here:
+
from_dict(metric_label_dict: Dict[str, str])
Returns a :class:`ai_api_client_sdk.models.metric_label.MetricLabel` object, created from the values in the
+dict provided as parameter
+ 
+:param metric_label_dict: Dict which includes the necessary values to create the object
+:type metric_label_dict: Dict[str, Any]
+:return: An object, created from the values provided
+:rtype: class:`ai_api_client_sdk.models.metric_label.MetricLabel`
+ +
+Methods inherited from ai_api_client_sdk.models.base_models.NameValue:
+
__eq__(self, other)
Return self==value.
+ +
__init__(self, name: str, value: str, **kwargs)
Initialize self.  See help(type(self)) for accurate signature.
+ +
__str__(self)
Return str(self).
+ +
+Data descriptors inherited from ai_api_client_sdk.models.base_models.NameValue:
+
__dict__
+
dictionary for instance variables
+
+
__weakref__
+
list of weak references to the object
+
+
+Data and other attributes inherited from ai_api_client_sdk.models.base_models.NameValue:
+
__hash__ = None
+ +

+ + + + + +
 
Data
       Dict = typing.Dict
+ \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.metric_resource.html b/packages/base/docs/ai_api_client_sdk.models.metric_resource.html new file mode 100644 index 0000000..0096b87 --- /dev/null +++ b/packages/base/docs/ai_api_client_sdk.models.metric_resource.html @@ -0,0 +1,91 @@ + + + + +Python: module ai_api_client_sdk.models.metric_resource + + + + + +
 
ai_api_client_sdk.models.metric_resource		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/metric_resource.py
+

+

+ + + + + +
 
Classes
       
+
builtins.object +
+
+
MetricResource +
+
+
+

+ + + + + + + +
 
class MetricResource(builtins.object)
   MetricResource(
+    execution_id: str,
+    metrics: List[ai_api_client_sdk.models.metric.Metric] = None,
+    tags: List[ai_api_client_sdk.models.metric_tag.MetricTag] = None,
+    custom_info: List[ai_api_client_sdk.models.metric_custom_info.MetricCustomInfo] = None,
+    **kwargs
+)
+ 
+The Metric object, defines collection of various metrics/tags/labels related to an execution.
+ 
+:param execution_id: ID of the execution
+:type execution_id: str
+:param metrics: List of the metrics related to the execution, defaults to None
+:type metrics: List[class:`ai_api_client_sdk.metric.Metric`], optional
+:param tags: List of the tags related to the execution, defaults to None
+:type tags: List[class:'ai_api_client_sdk.models.metric_tag.MetricTag'], optional
+:param custom_info: List of custom info related to the execution, defaults to None
+:type custom_info: List[class:`ai_api_client_sdk.models.metric_custom_info.MetricCustomInfo`], optional
+:param `**kwargs`: The keyword arguments are there in case there are additional attributes returned from server
 
 Methods defined here:
+
__init__( + self, + execution_id: str, + metrics: List[ai_api_client_sdk.models.metric.Metric] = None, + tags: List[ai_api_client_sdk.models.metric_tag.MetricTag] = None, + custom_info: List[ai_api_client_sdk.models.metric_custom_info.MetricCustomInfo] = None, + **kwargs +)
Initialize self.  See help(type(self)) for accurate signature.
+ +
__str__(self)
Return str(self).
+ +
+Static methods defined here:
+
from_dict(metric_resource_dict: Dict[str, Any])
Returns a :class:`ai_api_client_sdk.models.metric_resource.MetricResource` object, created from the values
+in the dict provided as parameter
+ 
+:param metric_resource_dict: Dict which includes the necessary values to create the object
+:type metric_resource_dict: Dict[str, Any]
+:return: An object, created from the values provided
+:rtype: class:`ai_api_client_sdk.models.metric_resource.MetricResource`
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables
+
+
__weakref__
+
list of weak references to the object
+
+

+ + + + + +
 
Data
       Dict = typing.Dict
+List = typing.List
+ \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.metric_tag.html b/packages/base/docs/ai_api_client_sdk.models.metric_tag.html new file mode 100644 index 0000000..1f27572 --- /dev/null +++ b/packages/base/docs/ai_api_client_sdk.models.metric_tag.html @@ -0,0 +1,82 @@ + + + + +Python: module ai_api_client_sdk.models.metric_tag + + + + + +
 
ai_api_client_sdk.models.metric_tag		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/metric_tag.py
+

+

+ + + + + +
 
Classes
       
+
ai_api_client_sdk.models.base_models.NameValue(builtins.object) +
+
+
MetricTag +
+
+
+

+ + + + + + + +
 
class MetricTag(ai_api_client_sdk.models.base_models.NameValue)
   MetricTag(name: str, value: str, **kwargs)
+ 
+The MetricTag object defines a tag as a name-value pair. Refer to
+:class:`ai_api_client_sdk.models.base_models.NameValue`, for the object definition
 
 
Method resolution order:
+
MetricTag
+
ai_api_client_sdk.models.base_models.NameValue
+
builtins.object
+
+
+Methods defined here:
+
__str__(self)
Return str(self).
+ +
+Static methods defined here:
+
from_dict(metric_tag_dict: Dict[str, str])
Returns a :class:`ai_api_client_sdk.models.metric_tag.MetricTag` object, created from the values in the dict
+provided as parameter
+ 
+:param metric_tag_dict: Dict which includes the necessary values to create the object
+:type metric_tag_dict: Dict[str, Any]
+:return: An object, created from the values provided
+:rtype: class:`ai_api_client_sdk.models.metric_tag.MetricTag`
+ +
+Methods inherited from ai_api_client_sdk.models.base_models.NameValue:
+
__eq__(self, other)
Return self==value.
+ +
__init__(self, name: str, value: str, **kwargs)
Initialize self.  See help(type(self)) for accurate signature.
+ +
+Data descriptors inherited from ai_api_client_sdk.models.base_models.NameValue:
+
__dict__
+
dictionary for instance variables
+
+
__weakref__
+
list of weak references to the object
+
+
+Data and other attributes inherited from ai_api_client_sdk.models.base_models.NameValue:
+
__hash__ = None
+ +

+ + + + + +
 
Data
       Dict = typing.Dict
+ \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.metrics_query_response.html b/packages/base/docs/ai_api_client_sdk.models.metrics_query_response.html new file mode 100644 index 0000000..49cc05c --- /dev/null +++ b/packages/base/docs/ai_api_client_sdk.models.metrics_query_response.html @@ -0,0 +1,90 @@ + + + + +Python: module ai_api_client_sdk.models.metrics_query_response + + + + + +
 
ai_api_client_sdk.models.metrics_query_response		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/metrics_query_response.py
+

+

+ + + + + +
 
Classes
       
+
ai_api_client_sdk.models.base_models.QueryResponse(builtins.object) +
+
+
MetricsQueryResponse +
+
+
+

+ + + + + + + +
 
class MetricsQueryResponse(ai_api_client_sdk.models.base_models.QueryResponse)
   MetricsQueryResponse(
+    resources: List[ai_api_client_sdk.models.metric_resource.MetricResource],
+    count: int,
+    **kwargs
+)
+ 
+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
 
 
Method resolution order:
+
MetricsQueryResponse
+
ai_api_client_sdk.models.base_models.QueryResponse
+
builtins.object
+
+
+Methods defined here:
+
__init__( + self, + resources: List[ai_api_client_sdk.models.metric_resource.MetricResource], + count: int, + **kwargs +)
Initialize self.  See help(type(self)) for accurate signature.
+ +
+Static methods defined here:
+
from_dict(response_dict: Dict[str, Any])
Returns a :class:`ai_api_client_sdk.models.metrics_query_response.MetricsQueryResponse` object, created
+from the values in the dict provided as parameter
+ 
+:param response_dict: Dict which includes the necessary values to create the object
+:type response_dict: Dict[str, Any]
+:return: An object, created from the values provided
+:rtype: class:`ai_api_client_sdk.models.metrics_query_response.MetricsQueryResponse`
+ +
+Methods inherited from ai_api_client_sdk.models.base_models.QueryResponse:
+
__str__(self)
Return str(self).
+ +
+Data descriptors inherited from ai_api_client_sdk.models.base_models.QueryResponse:
+
__dict__
+
dictionary for instance variables
+
+
__weakref__
+
list of weak references to the object
+
+

+ + + + + +
 
Data
       Dict = typing.Dict
+List = typing.List
+ \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.model.html b/packages/base/docs/ai_api_client_sdk.models.model.html new file mode 100644 index 0000000..3bb89b9 --- /dev/null +++ b/packages/base/docs/ai_api_client_sdk.models.model.html @@ -0,0 +1,105 @@ + + + + +Python: module ai_api_client_sdk.models.model + + + + + +
 
ai_api_client_sdk.models.model		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/model.py
+

+

+ + + + + +
 
Classes
       
+
builtins.object +
+
+
Model +
+
+
+

+ + + + + + + +
 
class Model(builtins.object)
   Model(
+    executable_id: str,
+    model: str,
+    description: str = None,
+    versions: List[ai_api_client_sdk.models.model_version.ModelVersion] = None,
+    display_name: str = None,
+    access_type: str = None,
+    provider: str = None,
+    allowed_scenarios: List[ai_api_client_sdk.models.model_base_data_allowed_scenarios.ModelBaseDataAllowedScenarios] = None,
+    **kwargs
+)
+ 
+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
+:param `**kwargs`: The keyword arguments are there in case there are additional attributes returned from server
 
 Methods defined here:
+
__init__( + self, + executable_id: str, + model: str, + description: str = None, + versions: List[ai_api_client_sdk.models.model_version.ModelVersion] = None, + display_name: str = None, + access_type: str = None, + provider: str = None, + allowed_scenarios: List[ai_api_client_sdk.models.model_base_data_allowed_scenarios.ModelBaseDataAllowedScenarios] = None, + **kwargs +)
Initialize self.  See help(type(self)) for accurate signature.
+ +
+Static methods defined here:
+
from_dict(model_dict: Dict[str, Any])
Returns a :class:`ai_api_client_sdk.models.model.Model` object, created from the values in the dict
+provided as parameter
+ 
+:param model_dict: Dict which includes the necessary values to create the object
+:type model_dict: Dict[str, Any]
+:return: An object, created from the values provided
+:rtype: class:`ai_api_client_sdk.models.model.Model`
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables
+
+
__weakref__
+
list of weak references to the object
+
+

+ + + + + +
 
Data
       Dict = typing.Dict
+List = typing.List
+ \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.model_base_data_allowed_scenarios.html b/packages/base/docs/ai_api_client_sdk.models.model_base_data_allowed_scenarios.html new file mode 100644 index 0000000..b6e3f44 --- /dev/null +++ b/packages/base/docs/ai_api_client_sdk.models.model_base_data_allowed_scenarios.html @@ -0,0 +1,62 @@ + + + + +Python: module ai_api_client_sdk.models.model_base_data_allowed_scenarios + + + + + +
 
ai_api_client_sdk.models.model_base_data_allowed_scenarios		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/model_base_data_allowed_scenarios.py
+

+

+ + + + + +
 
Classes
       
+
builtins.object +
+
+
ModelBaseDataAllowedScenarios +
+
+
+

+ + + + + + + +
 
class ModelBaseDataAllowedScenarios(builtins.object)
   ModelBaseDataAllowedScenarios(scenario_id: str, executable_id: str)
+ 
+This class defines the allowed scenarios for the model base data.
 
 Methods defined here:
+
__init__(self, scenario_id: str, executable_id: str)
:param scenario_id: ID of the scenario
+:type scenario_id: str
+:param executable_id: ID of the executable
+:type executable_id: str
+ +
+Static methods defined here:
+
from_dict(allowed_scenarios_dict: dict[str, any])
Returns a :class:`ai_api_client_sdk.models.model_base_data_allowed_scenarios.ModelBaseDataAllowedScenarios`
+object, created from the values in the dict provided as parameter
+ 
+:param allowed_scenarios_dict: Dict which includes the necessary values to create the object
+:type allowed_scenarios_dict: Dict[str, Any]
+:return: An object, created from the values provided
+:rtype: class:`ai_api_client_sdk.models.model_base_data_allowed_scenarios.ModelBaseDataAllowedScenarios`
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables
+
+
__weakref__
+
list of weak references to the object
+
+

+ \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.model_query_response.html b/packages/base/docs/ai_api_client_sdk.models.model_query_response.html new file mode 100644 index 0000000..da7be2c --- /dev/null +++ b/packages/base/docs/ai_api_client_sdk.models.model_query_response.html @@ -0,0 +1,90 @@ + + + + +Python: module ai_api_client_sdk.models.model_query_response + + + + + +
 
ai_api_client_sdk.models.model_query_response		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/model_query_response.py
+

+

+ + + + + +
 
Classes
       
+
ai_api_client_sdk.models.base_models.QueryResponse(builtins.object) +
+
+
ModelQueryResponse +
+
+
+

+ + + + + + + +
 
class ModelQueryResponse(ai_api_client_sdk.models.base_models.QueryResponse)
   ModelQueryResponse(
+    resources: List[ai_api_client_sdk.models.model.Model],
+    count: int,
+    **kwargs
+)
+ 
+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
 
 
Method resolution order:
+
ModelQueryResponse
+
ai_api_client_sdk.models.base_models.QueryResponse
+
builtins.object
+
+
+Methods defined here:
+
__init__( + self, + resources: List[ai_api_client_sdk.models.model.Model], + count: int, + **kwargs +)
Initialize self.  See help(type(self)) for accurate signature.
+ +
+Static methods defined here:
+
from_dict(response_dict: Dict[str, Any])
Returns a :class:`ai_api_client_sdk.models.executable_query_response.ModelQueryResponse` object, created
+from the values in the dict provided as parameter
+ 
+:param response_dict: Dict which includes the necessary values to create the object
+:type response_dict: Dict[str, Any]
+:return: An object, created from the values provided
+:rtype: class:`ai_api_client_sdk.models.executable_query_response.ModelQueryResponse`
+ +
+Methods inherited from ai_api_client_sdk.models.base_models.QueryResponse:
+
__str__(self)
Return str(self).
+ +
+Data descriptors inherited from ai_api_client_sdk.models.base_models.QueryResponse:
+
__dict__
+
dictionary for instance variables
+
+
__weakref__
+
list of weak references to the object
+
+

+ + + + + +
 
Data
       Dict = typing.Dict
+List = typing.List
+ \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.model_version.html b/packages/base/docs/ai_api_client_sdk.models.model_version.html new file mode 100644 index 0000000..bbf3cdc --- /dev/null +++ b/packages/base/docs/ai_api_client_sdk.models.model_version.html @@ -0,0 +1,127 @@ + + + + +Python: module ai_api_client_sdk.models.model_version + + + + + +
 
ai_api_client_sdk.models.model_version		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/model_version.py
+

+

+ + + + + +
 
Classes
       
+
builtins.object +
+
+
ModelVersion +
+
+
+

+ + + + + + + +
 
class ModelVersion(builtins.object)
   ModelVersion(
+    name: str,
+    is_latest: bool,
+    deprecated: bool,
+    retirement_date: Optional[datetime.datetime] = None,
+    context_length: Optional[int] = None,
+    input_types: Optional[List[str]] = None,
+    capabilities: Optional[List[str]] = None,
+    metadata: Optional[Dict[str, str]] = None,
+    cost: Optional[Dict[str, str]] = None,
+    suggested_replacements: Optional[List[str]] = None,
+    streaming_supported: Optional[bool] = None,
+    orchestration_capabilities: Optional[List[str]] = None,
+    **kwargs
+)
+ 
+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
 
 Methods defined here:
+
__eq__(self, other)
Return self==value.
+ +
__init__( + self, + name: str, + is_latest: bool, + deprecated: bool, + retirement_date: Optional[datetime.datetime] = None, + context_length: Optional[int] = None, + input_types: Optional[List[str]] = None, + capabilities: Optional[List[str]] = None, + metadata: Optional[Dict[str, str]] = None, + cost: Optional[Dict[str, str]] = None, + suggested_replacements: Optional[List[str]] = None, + streaming_supported: Optional[bool] = None, + orchestration_capabilities: Optional[List[str]] = None, + **kwargs +)
Initialize self.  See help(type(self)) for accurate signature.
+ +
+Static methods defined here:
+
from_dict(model_version_dict: Dict[str, Any])
Returns a :class:`ai_api_client_sdk.models.model_version.ModelVersion` object, created from the values in the dict
+provided as parameter
+ 
+:param model_version_dict: Dict which includes the necessary values to create the object
+:type model_version_dict: Dict[str, Any]
+:return: An object, created from the values provided
+:rtype: class:`ai_api_client_sdk.models.model_version.ModelVersion`
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables
+
+
__weakref__
+
list of weak references to the object
+
+
+Data and other attributes defined here:
+
__hash__ = None
+ +

+ + + + + +
 
Data
       Dict = typing.Dict
+List = typing.List
+Optional = typing.Optional
+ \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.output_artifact.html b/packages/base/docs/ai_api_client_sdk.models.output_artifact.html new file mode 100644 index 0000000..1c2b58d --- /dev/null +++ b/packages/base/docs/ai_api_client_sdk.models.output_artifact.html @@ -0,0 +1,93 @@ + + + + +Python: module ai_api_client_sdk.models.output_artifact + + + + + +
 
ai_api_client_sdk.models.output_artifact		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/output_artifact.py
+

+

+ + + + + +
 
Classes
       
+
builtins.object +
+
+
OutputArtifact +
+
+
+

+ + + + + + + +
 
class OutputArtifact(builtins.object)
   OutputArtifact(
+    name: str,
+    kind: str = None,
+    description: str = None,
+    labels: List[ai_api_client_sdk.models.label.Label] = None
+)
+ 
+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`]
 
 Methods defined here:
+
__eq__(self, other)
Return self==value.
+ +
__init__( + self, + name: str, + kind: str = None, + description: str = None, + labels: List[ai_api_client_sdk.models.label.Label] = None +)
Initialize self.  See help(type(self)) for accurate signature.
+ +
__str__(self)
Return str(self).
+ +
+Static methods defined here:
+
from_dict(output_artifact_dict: Dict[str, Any])
Returns a :class:`ai_api_client_sdk.models.output_artifact.OutputArtifact` object, created from the values
+in the dict provided as parameter
+ 
+:param output_artifact_dict: Dict which includes the necessary values to create the object
+:type output_artifact_dict: Dict[str, Any]
+:return: An object, created from the values provided
+:rtype: class:`ai_api_client_sdk.models.output_artifact.OutputArtifact`
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables
+
+
__weakref__
+
list of weak references to the object
+
+
+Data and other attributes defined here:
+
__hash__ = None
+ +

+ + + + + +
 
Data
       Dict = typing.Dict
+List = typing.List
+ \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.parameter.html b/packages/base/docs/ai_api_client_sdk.models.parameter.html new file mode 100644 index 0000000..2c23ff3 --- /dev/null +++ b/packages/base/docs/ai_api_client_sdk.models.parameter.html @@ -0,0 +1,98 @@ + + + + +Python: module ai_api_client_sdk.models.parameter + + + + + +
 
ai_api_client_sdk.models.parameter		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/parameter.py
+

+

+ + + + + +
 
Classes
       
+
builtins.object +
+
+
Parameter +
+
+
+

+ + + + + + + +
 
class Parameter(builtins.object)
   Parameter(
+    name: str,
+    type: ai_api_client_sdk.models.parameter.Parameter.Type,
+    description: str = None,
+    default: str = None,
+    **kwargs
+)
+ 
+The Parameter object defines the parameter specified in the executable definition.
+ 
+:param name: name of the parameter
+:type name: str
+:param type: Type of the parameter
+:type type: class:`ai_api_client_sdk.models.parameter.Parameter.Type`
+:param description: description for parameter
+:type description: str
+:param default: default value for parameter
+:type default: str
+:param `**kwargs`: The keyword arguments are there in case there are additional attributes returned from server
 
 Methods defined here:
+
__eq__(self, other)
Return self==value.
+ +
__init__( + self, + name: str, + type: ai_api_client_sdk.models.parameter.Parameter.Type, + description: str = None, + default: str = None, + **kwargs +)
Initialize self.  See help(type(self)) for accurate signature.
+ +
__str__(self)
Return str(self).
+ +
+Static methods defined here:
+
from_dict(parameter_dict: Dict[str, Any])
Returns a :class:`ai_api_client_sdk.models.parameter.Parameter` object, created from the values in the dict
+provided as parameter
+ 
+:param parameter_dict: Dict which includes the necessary values to create the object
+:type parameter_dict: Dict[str, Any]
+:return: An object, created from the values provided
+:rtype: class:`ai_api_client_sdk.models.parameter.Parameter`
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables
+
+
__weakref__
+
list of weak references to the object
+
+
+Data and other attributes defined here:
+
Type = <enum 'Type'>
+ +
__hash__ = None
+ +

+ + + + + +
 
Data
       Dict = typing.Dict
+ \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.parameter_binding.html b/packages/base/docs/ai_api_client_sdk.models.parameter_binding.html new file mode 100644 index 0000000..e9ac637 --- /dev/null +++ b/packages/base/docs/ai_api_client_sdk.models.parameter_binding.html @@ -0,0 +1,84 @@ + + + + +Python: module ai_api_client_sdk.models.parameter_binding + + + + + +
 
ai_api_client_sdk.models.parameter_binding		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/parameter_binding.py
+

+

+ + + + + +
 
Classes
       
+
ai_api_client_sdk.models.base_models.KeyValue(builtins.object) +
+
+
ParameterBinding +
+
+
+

+ + + + + + + +
 
class ParameterBinding(ai_api_client_sdk.models.base_models.KeyValue)
   ParameterBinding(key: str, value: str, **kwargs)
+ 
+The ParameterBinding object defines the input artifact specified in the configuration, as a key-value pair. Refer
+to :class:`ai_api_client_sdk.models.base_models.KeyValue`, for the object definition
 
 
Method resolution order:
+
ParameterBinding
+
ai_api_client_sdk.models.base_models.KeyValue
+
builtins.object
+
+
+Methods defined here:
+
__str__(self)
Return str(self).
+ +
+Static methods defined here:
+
from_dict(parameter_binding_dict: Dict[str, str])
Returns a :class:`ai_api_client_sdk.models.parameter_binding.ParameterBinding` object, created from
+the values in the dict provided as parameter
+ 
+:param parameter_binding_dict: Dict which includes the necessary values to create the object
+:type parameter_binding_dict: Dict[str, Any]
+:return: An object, created from the values provided
+:rtype: class:`ai_api_client_sdk.models.parameter_binding.ParameterBinding`
+ +
+Methods inherited from ai_api_client_sdk.models.base_models.KeyValue:
+
__eq__(self, other)
Return self==value.
+ +
__init__(self, key: str, value: str, **kwargs)
Initialize self.  See help(type(self)) for accurate signature.
+ +
to_dict(self)
+ +
+Data descriptors inherited from ai_api_client_sdk.models.base_models.KeyValue:
+
__dict__
+
dictionary for instance variables
+
+
__weakref__
+
list of weak references to the object
+
+
+Data and other attributes inherited from ai_api_client_sdk.models.base_models.KeyValue:
+
__hash__ = None
+ +

+ + + + + +
 
Data
       Dict = typing.Dict
+ \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.resource_group.html b/packages/base/docs/ai_api_client_sdk.models.resource_group.html new file mode 100644 index 0000000..6f38a0d --- /dev/null +++ b/packages/base/docs/ai_api_client_sdk.models.resource_group.html @@ -0,0 +1,92 @@ + + + + +Python: module ai_api_client_sdk.models.resource_group + + + + + +
 
ai_api_client_sdk.models.resource_group		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/resource_group.py
+

+

+ + + + + +
 
Classes
       
+
builtins.object +
+
+
ResourceGroup +
+
+
+

+ + + + + + + +
 
class ResourceGroup(builtins.object)
   ResourceGroup(
+    resource_group_id: str = None,
+    labels: List[ai_api_client_sdk.models.label.Label] = None,
+    status: ai_api_client_sdk.models.resource_group_status.ResourceGroupStatus = None,
+    created_at: datetime.datetime = None,
+    *args,
+    **kwargs
+)
+ 
+ResourceGroup represents the resource group.
+ 
+:param resource_group_id: The resource_group_id of this ResourceGroup.
+:type resource_group_id: str
+:param labels: The labels of this ResourceGroup.
+:type labels: ResourceGroupLabels
+:param status: The status of this ResourceGroup.
+:type status: str
+:param created_at: Time when the resource group was created
+:type created_at: datetime
 
 Methods defined here:
+
__init__( + self, + resource_group_id: str = None, + labels: List[ai_api_client_sdk.models.label.Label] = None, + status: ai_api_client_sdk.models.resource_group_status.ResourceGroupStatus = None, + created_at: datetime.datetime = None, + *args, + **kwargs +)
Initialize self.  See help(type(self)) for accurate signature.
+ +
__str__(self)
Return str(self).
+ +
+Static methods defined here:
+
from_dict(resource_group_dict: Dict[str, Any])
Returns a :class:`ai_core_sdk.models.resource_group.ResourceGroup` object, created
+from the values in the dict provided as parameter
+ 
+:param resource_group_dict: Dict which includes the necessary values to create the object
+:type resource_group_dict: Dict[str, Any]
+:return: An object, created from the values provided
+:rtype: class:`ai_core_sdk.models.resource_group.ResourceGroup`
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables
+
+
__weakref__
+
list of weak references to the object
+
+

+ + + + + +
 
Data
       Dict = typing.Dict
+List = typing.List
+ \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.resource_group_query_response.html b/packages/base/docs/ai_api_client_sdk.models.resource_group_query_response.html new file mode 100644 index 0000000..9f1a4fd --- /dev/null +++ b/packages/base/docs/ai_api_client_sdk.models.resource_group_query_response.html @@ -0,0 +1,91 @@ + + + + +Python: module ai_api_client_sdk.models.resource_group_query_response + + + + + +
 
ai_api_client_sdk.models.resource_group_query_response		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/resource_group_query_response.py
+

+

+ + + + + +
 
Classes
       
+
ai_api_client_sdk.models.base_models.QueryResponse(builtins.object) +
+
+
ResourceGroupQueryResponse +
+
+
+

+ + + + + + + +
 
class ResourceGroupQueryResponse(ai_api_client_sdk.models.base_models.QueryResponse)
   ResourceGroupQueryResponse(
+    resources: List[ai_api_client_sdk.models.resource_group.ResourceGroup],
+    count: int,
+    **kwargs
+)
+ 
+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
 
 
Method resolution order:
+
ResourceGroupQueryResponse
+
ai_api_client_sdk.models.base_models.QueryResponse
+
builtins.object
+
+
+Methods defined here:
+
__init__( + self, + resources: List[ai_api_client_sdk.models.resource_group.ResourceGroup], + count: int, + **kwargs +)
Initialize self.  See help(type(self)) for accurate signature.
+ +
+Static methods defined here:
+
from_dict(response_dict: Dict[str, Any])
Returns a
+:class:`ai_core_sdk.models.docker_registry_secret_query_response.DockerRegistrySecretQueryResponse`
+object, created from the values in the dict provided as parameter
+ 
+:param response_dict: Dict which includes the necessary values to create the object
+:type response_dict: Dict[str, Any]
+:return: An object, created from the values provided
+:rtype: class:`ai_core_sdk.models.docker_registry_secret_query_response.DockerRegistrySecretQueryResponse`
+ +
+Methods inherited from ai_api_client_sdk.models.base_models.QueryResponse:
+
__str__(self)
Return str(self).
+ +
+Data descriptors inherited from ai_api_client_sdk.models.base_models.QueryResponse:
+
__dict__
+
dictionary for instance variables
+
+
__weakref__
+
list of weak references to the object
+
+

+ + + + + +
 
Data
       Dict = typing.Dict
+List = typing.List
+ \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.resource_group_status.html b/packages/base/docs/ai_api_client_sdk.models.resource_group_status.html new file mode 100644 index 0000000..0918241 --- /dev/null +++ b/packages/base/docs/ai_api_client_sdk.models.resource_group_status.html @@ -0,0 +1,82 @@ + + + + +Python: module ai_api_client_sdk.models.resource_group_status + + + + + +
 
ai_api_client_sdk.models.resource_group_status		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/resource_group_status.py
+

+

+ + + + + +
 
Classes
       
+
enum.Enum(builtins.object) +
+
+
ResourceGroupStatus +
+
+
+

+ + + + + + + +
 
class ResourceGroupStatus(enum.Enum)
   ResourceGroupStatus(*values)
+ 
+ResourceGroupStatus is an Enum defining the valid values of the status of a resource group
 
 
Method resolution order:
+
ResourceGroupStatus
+
enum.Enum
+
builtins.object
+
+
+Data and other attributes defined here:
+
ERROR = <ResourceGroupStatus.ERROR: 'ERROR'>
+ +
PROVISIONED = <ResourceGroupStatus.PROVISIONED: 'PROVISIONED'>
+ +
PROVISIONING = <ResourceGroupStatus.PROVISIONING: 'PROVISIONING'>
+ +
+Data descriptors inherited from enum.Enum:
+
name
+
The name of the Enum member.
+
+
value
+
The value of the Enum member.
+
+
+Static methods inherited from enum.EnumType:
+
__contains__(value)
Return True if `value` is in `cls`.
+ 
+`value` is in `cls` if:
+1) `value` is a member of `cls`, or
+2) `value` is the value of one of the `cls`'s members.
+3) `value` is a pseudo-member (flags)
+ +
__getitem__(name)
Return the member matching `name`.
+ +
__iter__()
Return members in definition order.
+ +
__len__()
Return the number of members (no aliases)
+ +
+Readonly properties inherited from enum.EnumType:
+
__members__
+
Returns a mapping of member name->value.
+ 
+This mapping lists all enum members, including aliases.  Note that
+this is a read-only view of the internal mapping.
+
+

+ \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.scenario.html b/packages/base/docs/ai_api_client_sdk.models.scenario.html new file mode 100644 index 0000000..db28c48 --- /dev/null +++ b/packages/base/docs/ai_api_client_sdk.models.scenario.html @@ -0,0 +1,109 @@ + + + + +Python: module ai_api_client_sdk.models.scenario + + + + + +
 
ai_api_client_sdk.models.scenario		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/scenario.py
+

+

+ + + + + +
 
Classes
       
+
builtins.object +
+
+
Scenario +
+
+
+

+ + + + + + + +
 
class Scenario(builtins.object)
   Scenario(
+    id: str,
+    created_at: datetime.datetime,
+    modified_at: datetime.datetime,
+    name: str,
+    description: str = None,
+    labels: List[ai_api_client_sdk.models.label.Label] = None,
+    **kwargs
+)
+ 
+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
 
 Methods defined here:
+
__eq__(self, other)
Return self==value.
+ +
__init__( + self, + id: str, + created_at: datetime.datetime, + modified_at: datetime.datetime, + name: str, + description: str = None, + labels: List[ai_api_client_sdk.models.label.Label] = None, + **kwargs +)
Initialize self.  See help(type(self)) for accurate signature.
+ +
__str__(self)
Return str(self).
+ +
is_llm_scenario(self)
Returns if the scenario is a LLM scenario or not
+ 
+:return: True if scenario is llm scenario, False otherwise
+:rtype: bool
+ +
+Static methods defined here:
+
from_dict(scenario_dict: Dict[str, Any])
Returns a :class:`ai_api_client_sdk.models.scenario.Scenario` object, created from the values in the dict
+provided as parameter
+ 
+:param scenario_dict: Dict which includes the necessary values to create the object
+:type scenario_dict: Dict[str, Any]
+:return: An object, created from the values provided
+:rtype: class:`ai_api_client_sdk.models.scenario.Scenario`
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables
+
+
__weakref__
+
list of weak references to the object
+
+
+Data and other attributes defined here:
+
__hash__ = None
+ +

+ + + + + +
 
Data
       Dict = typing.Dict
+List = typing.List
+ \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.scenario_query_response.html b/packages/base/docs/ai_api_client_sdk.models.scenario_query_response.html new file mode 100644 index 0000000..9519075 --- /dev/null +++ b/packages/base/docs/ai_api_client_sdk.models.scenario_query_response.html @@ -0,0 +1,90 @@ + + + + +Python: module ai_api_client_sdk.models.scenario_query_response + + + + + +
 
ai_api_client_sdk.models.scenario_query_response		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/scenario_query_response.py
+

+

+ + + + + +
 
Classes
       
+
ai_api_client_sdk.models.base_models.QueryResponse(builtins.object) +
+
+
ScenarioQueryResponse +
+
+
+

+ + + + + + + +
 
class ScenarioQueryResponse(ai_api_client_sdk.models.base_models.QueryResponse)
   ScenarioQueryResponse(
+    resources: List[ai_api_client_sdk.models.scenario.Scenario],
+    count: int,
+    **kwargs
+)
+ 
+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
 
 
Method resolution order:
+
ScenarioQueryResponse
+
ai_api_client_sdk.models.base_models.QueryResponse
+
builtins.object
+
+
+Methods defined here:
+
__init__( + self, + resources: List[ai_api_client_sdk.models.scenario.Scenario], + count: int, + **kwargs +)
Initialize self.  See help(type(self)) for accurate signature.
+ +
+Static methods defined here:
+
from_dict(response_dict: Dict[str, Any])
Returns a :class:`ai_api_client_sdk.models.scenario_query_response.ScenarioQueryResponse` object, created
+from the values in the dict provided as parameter
+ 
+:param response_dict: Dict which includes the necessary values to create the object
+:type response_dict: Dict[str, Any]
+:return: An object, created from the values provided
+:rtype: class:`ai_api_client_sdk.models.scenario_query_response.ScenarioQueryResponse`
+ +
+Methods inherited from ai_api_client_sdk.models.base_models.QueryResponse:
+
__str__(self)
Return str(self).
+ +
+Data descriptors inherited from ai_api_client_sdk.models.base_models.QueryResponse:
+
__dict__
+
dictionary for instance variables
+
+
__weakref__
+
list of weak references to the object
+
+

+ + + + + +
 
Data
       Dict = typing.Dict
+List = typing.List
+ \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.status.html b/packages/base/docs/ai_api_client_sdk.models.status.html new file mode 100644 index 0000000..190080c --- /dev/null +++ b/packages/base/docs/ai_api_client_sdk.models.status.html @@ -0,0 +1,143 @@ + + + + +Python: module ai_api_client_sdk.models.status + + + + + +
 
ai_api_client_sdk.models.status		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/status.py
+

+

+ + + + + +
 
Classes
       
+
enum.Enum(builtins.object) +
+
+
ScheduleStatus +
Status +
+
+
+

+ + + + + + + +
 
class ScheduleStatus(enum.Enum)
   ScheduleStatus(*values)
+ 
+Enum defining the status values for execution schedules
 
 
Method resolution order:
+
ScheduleStatus
+
enum.Enum
+
builtins.object
+
+
+Data and other attributes defined here:
+
ACTIVE = <ScheduleStatus.ACTIVE: 'ACTIVE'>
+ +
INACTIVE = <ScheduleStatus.INACTIVE: 'INACTIVE'>
+ +
+Data descriptors inherited from enum.Enum:
+
name
+
The name of the Enum member.
+
+
value
+
The value of the Enum member.
+
+
+Static methods inherited from enum.EnumType:
+
__contains__(value)
Return True if `value` is in `cls`.
+ 
+`value` is in `cls` if:
+1) `value` is a member of `cls`, or
+2) `value` is the value of one of the `cls`'s members.
+3) `value` is a pseudo-member (flags)
+ +
__getitem__(name)
Return the member matching `name`.
+ +
__iter__()
Return members in definition order.
+ +
__len__()
Return the number of members (no aliases)
+ +
+Readonly properties inherited from enum.EnumType:
+
__members__
+
Returns a mapping of member name->value.
+ 
+This mapping lists all enum members, including aliases.  Note that
+this is a read-only view of the internal mapping.
+
+

+ + + + + + + +
 
class Status(enum.Enum)
   Status(*values)
+ 
+Status is an Enum defining the valid values of the status of an execution/deployment
 
 
Method resolution order:
+
Status
+
enum.Enum
+
builtins.object
+
+
+Data and other attributes defined here:
+
COMPLETED = <Status.COMPLETED: 'COMPLETED'>
+ +
DEAD = <Status.DEAD: 'DEAD'>
+ +
PENDING = <Status.PENDING: 'PENDING'>
+ +
RUNNING = <Status.RUNNING: 'RUNNING'>
+ +
STOPPED = <Status.STOPPED: 'STOPPED'>
+ +
STOPPING = <Status.STOPPING: 'STOPPING'>
+ +
UNKNOWN = <Status.UNKNOWN: 'UNKNOWN'>
+ +
+Data descriptors inherited from enum.Enum:
+
name
+
The name of the Enum member.
+
+
value
+
The value of the Enum member.
+
+
+Static methods inherited from enum.EnumType:
+
__contains__(value)
Return True if `value` is in `cls`.
+ 
+`value` is in `cls` if:
+1) `value` is a member of `cls`, or
+2) `value` is the value of one of the `cls`'s members.
+3) `value` is a pseudo-member (flags)
+ +
__getitem__(name)
Return the member matching `name`.
+ +
__iter__()
Return members in definition order.
+ +
__len__()
Return the number of members (no aliases)
+ +
+Readonly properties inherited from enum.EnumType:
+
__members__
+
Returns a mapping of member name->value.
+ 
+This mapping lists all enum members, including aliases.  Note that
+this is a read-only view of the internal mapping.
+
+

+ \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.target_status.html b/packages/base/docs/ai_api_client_sdk.models.target_status.html new file mode 100644 index 0000000..52ed398 --- /dev/null +++ b/packages/base/docs/ai_api_client_sdk.models.target_status.html @@ -0,0 +1,84 @@ + + + + +Python: module ai_api_client_sdk.models.target_status + + + + + +
 
ai_api_client_sdk.models.target_status		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/target_status.py
+

+

+ + + + + +
 
Classes
       
+
enum.Enum(builtins.object) +
+
+
TargetStatus +
+
+
+

+ + + + + + + +
 
class TargetStatus(enum.Enum)
   TargetStatus(*values)
+ 
+TargetStatus is an Enum defining the valid values of the target status of an execution/deployment
 
 
Method resolution order:
+
TargetStatus
+
enum.Enum
+
builtins.object
+
+
+Data and other attributes defined here:
+
COMPLETED = <TargetStatus.COMPLETED: 'COMPLETED'>
+ +
DELETED = <TargetStatus.DELETED: 'DELETED'>
+ +
RUNNING = <TargetStatus.RUNNING: 'RUNNING'>
+ +
STOPPED = <TargetStatus.STOPPED: 'STOPPED'>
+ +
+Data descriptors inherited from enum.Enum:
+
name
+
The name of the Enum member.
+
+
value
+
The value of the Enum member.
+
+
+Static methods inherited from enum.EnumType:
+
__contains__(value)
Return True if `value` is in `cls`.
+ 
+`value` is in `cls` if:
+1) `value` is a member of `cls`, or
+2) `value` is the value of one of the `cls`'s members.
+3) `value` is a pseudo-member (flags)
+ +
__getitem__(name)
Return the member matching `name`.
+ +
__iter__()
Return members in definition order.
+ +
__len__()
Return the number of members (no aliases)
+ +
+Readonly properties inherited from enum.EnumType:
+
__members__
+
Returns a mapping of member name->value.
+ 
+This mapping lists all enum members, including aliases.  Note that
+this is a read-only view of the internal mapping.
+
+

+ \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.version.html b/packages/base/docs/ai_api_client_sdk.models.version.html new file mode 100644 index 0000000..01c5c0c --- /dev/null +++ b/packages/base/docs/ai_api_client_sdk.models.version.html @@ -0,0 +1,93 @@ + + + + +Python: module ai_api_client_sdk.models.version + + + + + +
 
ai_api_client_sdk.models.version		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/version.py
+

+

+ + + + + +
 
Classes
       
+
builtins.object +
+
+
Version +
+
+
+

+ + + + + + + +
 
class Version(builtins.object)
   Version(
+    id: str,
+    scenario_id: str,
+    created_at: datetime.datetime,
+    modified_at: datetime.datetime,
+    description: str = None,
+    **kwargs
+)
+ 
+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
 
 Methods defined here:
+
__init__( + self, + id: str, + scenario_id: str, + created_at: datetime.datetime, + modified_at: datetime.datetime, + description: str = None, + **kwargs +)
Initialize self.  See help(type(self)) for accurate signature.
+ +
__str__(self)
Return str(self).
+ +
+Static methods defined here:
+
from_dict(version_dict: Dict[str, Any])
Returns a :class:`ai_api_client_sdk.models.version.Version` object, created from the values in the dict
+provided as parameter
+ 
+:param version_dict: Dict which includes the necessary values to create the object
+:type version_dict: Dict[str, Any]
+:return: An object, created from the values provided
+:rtype: class:`ai_api_client_sdk.models.version.Version`
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables
+
+
__weakref__
+
list of weak references to the object
+
+

+ + + + + +
 
Data
       Dict = typing.Dict
+ \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.version_list.html b/packages/base/docs/ai_api_client_sdk.models.version_list.html new file mode 100644 index 0000000..d3a6baa --- /dev/null +++ b/packages/base/docs/ai_api_client_sdk.models.version_list.html @@ -0,0 +1,77 @@ + + + + +Python: module ai_api_client_sdk.models.version_list + + + + + +
 
ai_api_client_sdk.models.version_list		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/version_list.py
+

+

+ + + + + +
 
Classes
       
+
builtins.object +
+
+
VersionList +
+
+
+

+ + + + + + + +
 
class VersionList(builtins.object)
   VersionList(
+    versions: List[ai_api_client_sdk.models.api_version.APIVersion] = None
+)
+ 
+The VersionList object, is a list of API version descriptions
+ 
+:param versions: A list of objects describing the API versions, defaults to None
+:type versions: class:`ai_api_client_sdk.models.api_version.APIVersion`, optional
+:param `**kwargs`: The keyword arguments are there in case there are additional attributes returned from server
 
 Methods defined here:
+
__init__( + self, + versions: List[ai_api_client_sdk.models.api_version.APIVersion] = None +)
Initialize self.  See help(type(self)) for accurate signature.
+ +
__str__(self)
Return str(self).
+ +
+Static methods defined here:
+
from_dict(version_list_dict: Dict[str, List[Dict[str, str]]])
Returns a :class:`ai_api_client_sdk.models.version_list.VersionList` object, created from the
+values in the dict provided as parameter
+ 
+:param version_list_dict: Dict which includes the necessary values to create the object
+:type version_list_dict: Dict[str, List[Dict[str, str]]
+:return: An object, created from the values provided
+:rtype: class:`ai_api_client_sdk.models.version_list.VersionList`
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables
+
+
__weakref__
+
list of weak references to the object
+
+

+ + + + + +
 
Data
       Dict = typing.Dict
+List = typing.List
+ \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.models.version_query_response.html b/packages/base/docs/ai_api_client_sdk.models.version_query_response.html new file mode 100644 index 0000000..c8cca65 --- /dev/null +++ b/packages/base/docs/ai_api_client_sdk.models.version_query_response.html @@ -0,0 +1,90 @@ + + + + +Python: module ai_api_client_sdk.models.version_query_response + + + + + +
 
ai_api_client_sdk.models.version_query_response		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/models/version_query_response.py
+

+

+ + + + + +
 
Classes
       
+
ai_api_client_sdk.models.base_models.QueryResponse(builtins.object) +
+
+
VersionQueryResponse +
+
+
+

+ + + + + + + +
 
class VersionQueryResponse(ai_api_client_sdk.models.base_models.QueryResponse)
   VersionQueryResponse(
+    resources: List[ai_api_client_sdk.models.version.Version],
+    count: int,
+    **kwargs
+)
+ 
+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
 
 
Method resolution order:
+
VersionQueryResponse
+
ai_api_client_sdk.models.base_models.QueryResponse
+
builtins.object
+
+
+Methods defined here:
+
__init__( + self, + resources: List[ai_api_client_sdk.models.version.Version], + count: int, + **kwargs +)
Initialize self.  See help(type(self)) for accurate signature.
+ +
+Static methods defined here:
+
from_dict(response_dict: Dict[str, Any])
Returns a :class:`ai_api_client_sdk.models.version_query_response.VersionQueryResponse` object, created
+from the values in the dict provided as parameter
+ 
+:param response_dict: Dict which includes the necessary values to create the object
+:type response_dict: Dict[str, Any]
+:return: An object, created from the values provided
+:rtype: class:`ai_api_client_sdk.models.version_query_response.VersionQueryResponse`
+ +
+Methods inherited from ai_api_client_sdk.models.base_models.QueryResponse:
+
__str__(self)
Return str(self).
+ +
+Data descriptors inherited from ai_api_client_sdk.models.base_models.QueryResponse:
+
__dict__
+
dictionary for instance variables
+
+
__weakref__
+
list of weak references to the object
+
+

+ + + + + +
 
Data
       Dict = typing.Dict
+List = typing.List
+ \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.resource_clients.artifact_client.html b/packages/base/docs/ai_api_client_sdk.resource_clients.artifact_client.html new file mode 100644 index 0000000..20ac44b --- /dev/null +++ b/packages/base/docs/ai_api_client_sdk.resource_clients.artifact_client.html @@ -0,0 +1,212 @@ + + + + +Python: module ai_api_client_sdk.resource_clients.artifact_client + + + + + +
 
ai_api_client_sdk.resource_clients.artifact_client		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/resource_clients/artifact_client.py
+

+

+ + + + + +
 
Classes
       
+
ai_api_client_sdk.resource_clients.base_client.BaseClient(builtins.object) +
+
+
ArtifactClient +
+
+
+

+ + + + + + + +
 
class ArtifactClient(ai_api_client_sdk.resource_clients.base_client.BaseClient)
   ArtifactClient(rest_client: ai_api_client_sdk.helpers.rest_client.RestClient)
+ 
+ArtifactClient is a class implemented for interacting with the artifact related endpoints of the server. It
+implements the base class :class:`ai_api_client_sdk.resource_clients.base_client.BaseClient`
 
 
Method resolution order:
+
ArtifactClient
+
ai_api_client_sdk.resource_clients.base_client.BaseClient
+
builtins.object
+
+
+Methods defined here:
+
count( + self, + scenario_id: str = None, + execution_id: str = None, + name: str = None, + kind: ai_api_client_sdk.models.artifact.Artifact.Kind = None, + artifact_label_selector: List[str] = None, + resource_group: str = None +) -> int
Counts the artifacts.
+ 
+:param scenario_id: ID of the scenario the artifacts should belong to, defaults to None
+:type scenario_id: str, optional
+:param execution_id: ID of the execution the artifact should be resulted from, defaults to None
+:type execution_id: str, optional
+:param name: Name of the artifact(s) to be retrieved, defaults to None
+:type name: str, optional
+:param kind: Kind of the artifacts to be retrieved, defaults to None
+:type kind: class:`ai_api_client_sdk.models.artifact.Artifact.Kind`, optional
+:param artifact_label_selector: 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
+:type artifact_label_selector: List[str], optional
+:param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
+    resource group in the :class:`ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client` should be specified,
+    defaults to None
+:type resource_group: str
+: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
+:return: An object representing the response from the server
+:rtype: int
+ +
create( + self, + name: str, + kind: ai_api_client_sdk.models.artifact.Artifact.Kind, + url: str, + scenario_id: str, + description: str = None, + labels: List[ai_api_client_sdk.models.label.Label] = None, + resource_group: str = None +) -> ai_api_client_sdk.models.artifact_create_response.ArtifactCreateResponse
Creates an artifact.
+ 
+:param name: Name of the artifact
+:type name: str
+:param kind: Kind of the artifact
+:type kind: class:`ai_api_client_sdk.models.artifact.Artifact.Kind`
+:param url: URL of the artifact
+:type url: str
+:param scenario_id: ID of the scenario which the artifact should belong to
+:type scenario_id: str
+:param description: Description of the artifact, defaults to None
+:type description: str, optional
+:param labels: List of the labels of the artifact, defaults to None
+:type labels: List[class:`ai_api_client_sdk.models.label.Label`]
+:param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
+    resource group in the :class:`ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client` should be specified,
+    defaults to None
+:type resource_group: str
+: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
+:return: An object representing the response from the server
+:rtype: class:`ai_api_client_sdk.models.artifact_create_response.ArtifactCreateResponse`
+ +
get(self, artifact_id: str, expand: str = None, resource_group: str = None) -> ai_api_client_sdk.models.artifact.Artifact
Retrieves the artifact from the server.
+ 
+:param artifact_id: ID of the artifact to be retrieved
+:type artifact_id: str
+:param expand: Entity whose details to be displayed in the response, defaults to None
+:type expand: str, optional
+:param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
+    resource group in the :class:`ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client` should be specified,
+    defaults to None
+:type resource_group: str
+: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: The retrieved artifact
+:rtype: class:`ai_api_client_sdk.models.artifact.Artifact`
+ +
query( + self, + scenario_id: str = None, + execution_id: str = None, + name: str = None, + kind: ai_api_client_sdk.models.artifact.Artifact.Kind = None, + artifact_label_selector: List[str] = None, + top: int = None, + skip: int = None, + search: str = None, + search_case_insensitive: bool = None, + expand: str = None, + resource_group: str = None +) -> ai_api_client_sdk.models.artifact_query_response.ArtifactQueryResponse
Queries the artifacts.
+ 
+:param scenario_id: ID of the scenario the artifacts should belong to, defaults to None
+:type scenario_id: str, optional
+:param execution_id: ID of the execution the artifact should be resulted from, defaults to None
+:type execution_id: str, optional
+:param name: Name of the artifact(s) to be retrieved, defaults to None
+:type name: str, optional
+:param kind: Kind of the artifacts to be retrieved, defaults to None
+:type kind: class:`ai_api_client_sdk.models.artifact.Artifact.Kind`, optional
+:param artifact_label_selector: Query the artifacts based on their labels in the form of "key=value" or
+    "key!=value" separated by commas, defaults to None
+:type artifact_label_selector: list, optional
+:param top: Number of artifacts to be retrieved, defaults to None
+:type top: int, optional
+:param skip: Number of artifacts to be skipped, from the list of the queried artifacts, defaults to None
+:type skip: int, optional
+:param search: Generic search term to be looked for in various attributes of artifacts, defaults to None
+:type search: str, optional
+:param search_case_insensitive: Indicates whether the search should be case insensitive
+:type search_case_insensitive: bool, optional
+:param expand: Entity whose details to be displayed in the response, defaults to None
+:type expand: str, optional
+:param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
+    resource group in the :class:`ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client` should be specified,
+    defaults to None
+:type resource_group: str
+: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
+:return: An object representing the response from the server
+:rtype: class:`ai_api_client_sdk.models.artifact_query_response.ArtifactQueryResponse`
+ +
+Methods inherited from ai_api_client_sdk.resource_clients.base_client.BaseClient:
+
__init__(self, rest_client: ai_api_client_sdk.helpers.rest_client.RestClient)
Initialize self.  See help(type(self)) for accurate signature.
+ +
bulk_modify(self, *args, **kwargs)
Modifies multiple instances of the relevant resource. Will be implemented by the respective resource clients
+ +
delete(self, *args, **kwargs)
Deletes the relevant resource. Will be implemented by the respective resource clients
+ +
modify(self, *args, **kwargs)
Modifies the relevant resource. Will be implemented by the respective resource clients
+ +
query_logs(self, *args, **kwargs)
Queries the relevant logs. Will be implemented by the respective resource clients
+ +
+Data descriptors inherited from ai_api_client_sdk.resource_clients.base_client.BaseClient:
+
__dict__
+
dictionary for instance variables
+
+
__weakref__
+
list of weak references to the object
+
+

+ + + + + +
 
Data
       List = typing.List
+ \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.resource_clients.base_client.html b/packages/base/docs/ai_api_client_sdk.resource_clients.base_client.html new file mode 100644 index 0000000..c1400f0 --- /dev/null +++ b/packages/base/docs/ai_api_client_sdk.resource_clients.base_client.html @@ -0,0 +1,75 @@ + + + + +Python: module ai_api_client_sdk.resource_clients.base_client + + + + + +
 
ai_api_client_sdk.resource_clients.base_client		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/resource_clients/base_client.py
+

+

+ + + + + +
 
Classes
       
+
builtins.object +
+
+
BaseClient +
+
+
+

+ + + + + + + +
 
class BaseClient(builtins.object)
   BaseClient(rest_client: ai_api_client_sdk.helpers.rest_client.RestClient)
+ 
+BaseClient defines the interface for the resource clients.
+ 
+:param rest_client: the client used to make calls to the server
+:type rest_client: class:`ai_api_client_sdk.helpers.rest_client.RestClient`
 
 Methods defined here:
+
__init__(self, rest_client: ai_api_client_sdk.helpers.rest_client.RestClient)
Initialize self.  See help(type(self)) for accurate signature.
+ +
bulk_modify(self, *args, **kwargs)
Modifies multiple instances of the relevant resource. Will be implemented by the respective resource clients
+ +
count(self, *args, **kwargs)
Counts the relevant resources. Will be implemented by the respective resource clients
+ +
create(self, *args, **kwargs)
Creates the relevant resource. Will be implemented by the respective resource clients
+ +
delete(self, *args, **kwargs)
Deletes the relevant resource. Will be implemented by the respective resource clients
+ +
get(self, *args, **kwargs)
Retrieves the relevant resource. Will be implemented by the respective resource clients
+ +
modify(self, *args, **kwargs)
Modifies the relevant resource. Will be implemented by the respective resource clients
+ +
query(self, *args, **kwargs)
Queries the relevant resources. Will be implemented by the respective resource clients
+ +
query_logs(self, *args, **kwargs)
Queries the relevant logs. Will be implemented by the respective resource clients
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables
+
+
__weakref__
+
list of weak references to the object
+
+

+ + + + + +
 
Data
       DATETIME_FORMAT = '%Y-%m-%dT%H:%M:%SZ'
+Dict = typing.Dict
+ \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.resource_clients.configuration_client.html b/packages/base/docs/ai_api_client_sdk.resource_clients.configuration_client.html new file mode 100644 index 0000000..c5f5fe1 --- /dev/null +++ b/packages/base/docs/ai_api_client_sdk.resource_clients.configuration_client.html @@ -0,0 +1,197 @@ + + + + +Python: module ai_api_client_sdk.resource_clients.configuration_client + + + + + +
 
ai_api_client_sdk.resource_clients.configuration_client		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/resource_clients/configuration_client.py
+

+

+ + + + + +
 
Classes
       
+
ai_api_client_sdk.resource_clients.base_client.BaseClient(builtins.object) +
+
+
ConfigurationClient +
+
+
+

+ + + + + + + +
 
class ConfigurationClient(ai_api_client_sdk.resource_clients.base_client.BaseClient)
   ConfigurationClient(
+    rest_client: ai_api_client_sdk.helpers.rest_client.RestClient
+)
+ 
+ConfigurationClient is a class implemented for interacting with the configuration related endpoints of the
+server. It implements the base class :class:`ai_api_client_sdk.resource_clients.base_client.BaseClient`
 
 
Method resolution order:
+
ConfigurationClient
+
ai_api_client_sdk.resource_clients.base_client.BaseClient
+
builtins.object
+
+
+Methods defined here:
+
count( + self, + scenario_id: str = None, + executable_ids: List[str] = None, + search: str = None, + resource_group: str = None +) -> int
Counts the configurations.
+ 
+:param scenario_id: ID of the scenario the configurations should belong to, defaults to None
+:type scenario_id: str, optional
+:param executable_ids: IDs of the executables the configurations should have configured, defaults to None
+:type executable_ids: List[str], optional
+:param search: Generic search term to be looked for in various attributes of configurations, defaults to None
+:type search: str, optional
+:param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
+    resource group in the :class:`ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client` should be specified,
+    defaults to None
+:type resource_group: str
+: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
+:return: An object representing the response from the server
+:rtype: int
+ +
create( + self, + name: str, + scenario_id: str, + executable_id: str, + parameter_bindings: List[ai_api_client_sdk.models.parameter_binding.ParameterBinding] = None, + input_artifact_bindings: List[ai_api_client_sdk.models.input_artifact_binding.InputArtifactBinding] = None, + resource_group: str = None +) -> ai_api_client_sdk.models.configuration_create_response.ConfigurationCreateResponse
Creates a configuration.
+ 
+:param name: Name of the configuration
+:type name: str
+:param scenario_id: ID of the scenario which the configuration should belong to
+:type scenario_id: str
+:param executable_id: ID of the executable, which should be configured
+:type executable_id: str
+:param parameter_bindings: List of the input parameters, defaults to None
+:type parameter_bindings: List[class:`ai_api_client_sdk.models.parameter_binding.ParameterBinding`], optional
+:param input_artifact_bindings: List of the input artifacts which are to be used by the executable,
+    defaults to None
+:type input_artifact_bindings:
+    List[class:`ai_api_client_sdk.models.input_artifact_binding.InputArtifactBinding`], optional
+:param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
+    resource group in the :class:`ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client` should be specified,
+    defaults to None
+:type resource_group: str
+: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
+:return: An object representing the response from the server
+:rtype: class:`ai_api_client_sdk.models.configuration_create_response.ConfigurationCreateResponse`
+ +
get(self, configuration_id: str, expand: str = None, resource_group: str = None) -> ai_api_client_sdk.models.configuration.Configuration
Retrieves the configuration from the server.
+ 
+:param configuration_id: ID of the configuration to be retrieved
+:type configuration_id: str
+:param expand: Entity whose details to be displayed in the response, defaults to None
+:type expand: str, optional
+:param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
+    resource group in the :class:`ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client` should be specified,
+    defaults to None
+:type resource_group: str
+: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: The retrieved configuration
+:rtype: class:`ai_api_client_sdk.models.configuration.Configuration`
+ +
query( + self, + scenario_id: str = None, + executable_ids: List[str] = None, + top: int = None, + skip: int = None, + search: str = None, + search_case_insensitive: bool = None, + expand: str = None, + resource_group: str = None +) -> ai_api_client_sdk.models.configuration_query_response.ConfigurationQueryResponse
Queries the configurations.
+ 
+:param scenario_id: ID of the scenario the configurations should belong to, defaults to None
+:type scenario_id: str, optional
+:param executable_ids: IDs of the executables the configurations should have configured, defaults to None
+:type executable_ids: List[str], optional
+:param top: Number of configurations to be retrieved, defaults to None
+:type top: int, optional
+:param skip: Number of configurations to be skipped, from the list of the queried configurations, defaults to
+    None
+:type skip: int, optional
+:param search: Generic search term to be looked for in various attributes of configurations, defaults to None
+:type search: str, optional
+:param search_case_insensitive: Indicates whether the search should be case insensitive
+:type search_case_insensitive: bool, optional
+:param expand: Entity whose details to be displayed in the response, defaults to None
+:type expand: str, optional
+:param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
+    resource group in the :class:`ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client` should be specified,
+    defaults to None
+:type resource_group: str
+: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
+:return: An object representing the response from the server
+:rtype: class:`ai_api_client_sdk.models.configuration_query_response.ConfigurationQueryResponse`
+ +
+Methods inherited from ai_api_client_sdk.resource_clients.base_client.BaseClient:
+
__init__(self, rest_client: ai_api_client_sdk.helpers.rest_client.RestClient)
Initialize self.  See help(type(self)) for accurate signature.
+ +
bulk_modify(self, *args, **kwargs)
Modifies multiple instances of the relevant resource. Will be implemented by the respective resource clients
+ +
delete(self, *args, **kwargs)
Deletes the relevant resource. Will be implemented by the respective resource clients
+ +
modify(self, *args, **kwargs)
Modifies the relevant resource. Will be implemented by the respective resource clients
+ +
query_logs(self, *args, **kwargs)
Queries the relevant logs. Will be implemented by the respective resource clients
+ +
+Data descriptors inherited from ai_api_client_sdk.resource_clients.base_client.BaseClient:
+
__dict__
+
dictionary for instance variables
+
+
__weakref__
+
list of weak references to the object
+
+

+ + + + + +
 
Data
       List = typing.List
+ \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.resource_clients.deployment_client.html b/packages/base/docs/ai_api_client_sdk.resource_clients.deployment_client.html new file mode 100644 index 0000000..92277d8 --- /dev/null +++ b/packages/base/docs/ai_api_client_sdk.resource_clients.deployment_client.html @@ -0,0 +1,280 @@ + + + + +Python: module ai_api_client_sdk.resource_clients.deployment_client + + + + + +
 
ai_api_client_sdk.resource_clients.deployment_client		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/resource_clients/deployment_client.py
+

+

+ + + + + +
 
Classes
       
+
ai_api_client_sdk.resource_clients.base_client.BaseClient(builtins.object) +
+
+
DeploymentClient +
+
+
+

+ + + + + + + +
 
class DeploymentClient(ai_api_client_sdk.resource_clients.base_client.BaseClient)
   DeploymentClient(rest_client: ai_api_client_sdk.helpers.rest_client.RestClient)
+ 
+DeploymentClient is a class implemented for interacting with the deployment related endpoints of the server. It
+implements the base class :class:`ai_api_client_sdk.resource_clients.base_client.BaseClient`
 
 
Method resolution order:
+
DeploymentClient
+
ai_api_client_sdk.resource_clients.base_client.BaseClient
+
builtins.object
+
+
+Methods defined here:
+
bulk_modify( + self, + deployments: List[ai_api_client_sdk.models.base_models.BasicModifyRequest], + resource_group: str = None +) -> ai_api_client_sdk.models.deployment_bulk_modify_response.DeploymentBulkModifyResponse
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 :class:`ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client` should be specified,
+    defaults to None
+:type resource_group: str
+: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
+:return: An object representing the response from the server
+:rtype: class:`ai_api_client_sdk.models.deployment_bulk_modify_response.DeploymentBulkModifyResponse`
+ +
count( + self, + scenario_id: str = None, + configuration_id: str = None, + executable_ids: List[str] = None, + status: ai_api_client_sdk.models.status.Status = None, + resource_group: str = None +) -> int
Counts the number of deployments.
+ 
+:param scenario_id: ID of the scenario, the deployments should belong to, defaults to None
+:type scenario_id: str, optional
+:param configuration_id: ID of the configuration, the deployments should be configured by, defaults to None
+:type configuration_id: str, optional
+:param executable_ids: IDs of the executables, the deployments should be created from, defaults to None
+:type executable_ids: List[str], optional
+:param status: Status which the deployments should currently have
+:type status: class:`ai_api_client_sdk.models.status.Status`, optional
+:param resource_group: Resource group which the request should be sent on behalf. Either this or a default
+    resource group in the :class:`ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client` should be specified,
+    defaults to None
+:type resource_group: str
+: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
+:return: An object representing the response from the server
+:rtype: int
+ +
create(self, configuration_id: str, ttl: str = None, resource_group: str = None) -> ai_api_client_sdk.models.deployment_create_response.DeploymentCreateResponse
Creates a deployment.
+ 
+:param configuration_id: ID of the configuration, that should configure the deployment
+:type configuration_id: str
+:param ttl: Time to live for deployment and can be none or take  a number followed by the unit
+(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 :class:`ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client` should be specified,
+    defaults to None
+:type resource_group: str
+: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
+:return: An object representing the response from the server
+:rtype: class:`ai_api_client_sdk.models.deployment_create_response.DeploymentCreateResponse`
+ +
delete(self, deployment_id: str, resource_group: str = None) -> ai_api_client_sdk.models.base_models.BasicResponse
Deletes the deployment.
+ 
+:param deployment_id: ID of the deployment to be deleted
+:type deployment_id: str
+:param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
+    resource group in the :class:`ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client` should be specified,
+    defaults to None
+:type resource_group: str
+: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
+:return: An object representing the response from the server
+:rtype: class:`ai_api_client_sdk.models.base_models.BasicResponse`
+ +
get(self, deployment_id: str, resource_group: str = None, select: str = None) -> Union[ai_api_client_sdk.models.deployment.Deployment, ai_api_client_sdk.models.deployment_get_status_response.DeploymentGetStatusResponse]
Retrieves the deployment from the server.
+ 
+:param deployment_id: ID of the deployment to be retrieved
+:type deployment_id: str
+:param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
+    resource group in the :class:`ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client` should be specified,
+    defaults to None
+:type resource_group: str
+:param select: only status supported. Get deployment for a given deployment id and select status
+:type select: str, optional
+: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: The retrieved deployment
+:rtype: class:Union[`ai_api_client_sdk.models.deployment.Deployment`,
+    `ai_api_client_sdk.models.deployment_get_status_response.DeploymentGetStatusResponse`]
+ +
modify( + self, + deployment_id: str, + target_status: ai_api_client_sdk.models.target_status.TargetStatus = None, + configuration_id: str = None, + resource_group: str = None +) -> ai_api_client_sdk.models.base_models.BasicResponse
Modifies the deployment, by changing either the target status, or the configuration ID.
+ 
+:param deployment_id: ID of the deployment to be modified
+:type deployment_id: str
+:param target_status: Desired target status of the deployment, defaults to None
+:type target_status: class:`ai_api_client_sdk.models.target_status.TargetStatus`, optional
+:param configuration_id: ID of the new configuration to be used by the deployment, defaults to None
+:type configuration_id: str, optional
+:param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
+    resource group in the :class:`ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client` should be specified,
+    defaults to None
+:type resource_group: str
+: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
+:return: An object representing the response from the server
+:rtype: class:`ai_api_client_sdk.models.base_models.BasicResponse`
+ +
query( + self, + scenario_id: str = None, + configuration_id: str = None, + executable_ids: List[str] = None, + status: ai_api_client_sdk.models.status.Status = None, + top: int = None, + skip: int = None, + resource_group: str = None +) -> ai_api_client_sdk.models.deployment_query_response.DeploymentQueryResponse
Queries the deployments.
+ 
+:param scenario_id: ID of the scenario the deployments should belong to, defaults to None
+:type scenario_id: str, optional
+:param configuration_id: ID of the configuration, the deployments should be configured by, defaults to None
+:type configuration_id: str, optional
+:param executable_ids: IDs of the executables the deployments should be created from, defaults to None
+:type executable_ids: List[str], optional
+:param status: Status which the deployments should currently have
+:type status: class:`ai_api_client_sdk.models.status.Status`, optional
+:param top: Number of deployments to be retrieved, defaults to None
+:type top: int, optional
+:param skip: Number of deployments to be skipped, from the list of the queried deployments, defaults to None
+:type skip: int, optional
+:param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
+    resource group in the :class:`ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client` should be specified,
+    defaults to None
+:type resource_group: str
+: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
+:return: An object representing the response from the server
+:rtype: class:`ai_api_client_sdk.models.deployment_query_response.DeploymentQueryResponse`
+ +
query_logs( + self, + deployment_id: str, + top: int = None, + start: datetime.datetime = None, + end: datetime.datetime = None, + order: ai_api_client_sdk.models.base_models.Order = None, + resource_group: str = None +) -> ai_api_client_sdk.models.log_response.LogResponse
Queries the logs of the deployment.
+ 
+:param deployment_id: ID of the deployment
+:type deployment_id: str
+:param top: The max number of entries to return. Defaults to 1000. Limited to 5000 max.
+:type top: int
+:param start: The start time for the query. Defaults to one hour ago.
+:type start: datetime
+:param end: The end time for the query. Defaults to now.
+:type end: datetime
+:param order: Determines the sort order with respect to time. Defaults to asc.
+:type order: class:`ai_api_client_sdk.models.base_models.Order`
+:param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
+    resource group in the :class:`ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client` should be specified,
+    defaults to None
+:type resource_group: str
+: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: Logs from the execution
+:rtype: class:`ai_api_client_sdk.models.log_response.LogResponse`
+ +
+Methods inherited from ai_api_client_sdk.resource_clients.base_client.BaseClient:
+
__init__(self, rest_client: ai_api_client_sdk.helpers.rest_client.RestClient)
Initialize self.  See help(type(self)) for accurate signature.
+ +
+Data descriptors inherited from ai_api_client_sdk.resource_clients.base_client.BaseClient:
+
__dict__
+
dictionary for instance variables
+
+
__weakref__
+
list of weak references to the object
+
+

+ + + + + +
 
Data
       List = typing.List
+Union = typing.Union
+ \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.resource_clients.executable_client.html b/packages/base/docs/ai_api_client_sdk.resource_clients.executable_client.html new file mode 100644 index 0000000..2f6e1fb --- /dev/null +++ b/packages/base/docs/ai_api_client_sdk.resource_clients.executable_client.html @@ -0,0 +1,115 @@ + + + + +Python: module ai_api_client_sdk.resource_clients.executable_client + + + + + +
 
ai_api_client_sdk.resource_clients.executable_client		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/resource_clients/executable_client.py
+

+

+ + + + + +
 
Classes
       
+
ai_api_client_sdk.resource_clients.base_client.BaseClient(builtins.object) +
+
+
ExecutableClient +
+
+
+

+ + + + + + + +
 
class ExecutableClient(ai_api_client_sdk.resource_clients.base_client.BaseClient)
   ExecutableClient(rest_client: ai_api_client_sdk.helpers.rest_client.RestClient)
+ 
+ExecutableClient is a class implemented for interacting with the executable related endpoints of the server. It
+implements the base class :class:`ai_api_client_sdk.resource_clients.base_client.BaseClient`
 
 
Method resolution order:
+
ExecutableClient
+
ai_api_client_sdk.resource_clients.base_client.BaseClient
+
builtins.object
+
+
+Methods defined here:
+
get(self, scenario_id: str, executable_id: str, resource_group: str = None) -> ai_api_client_sdk.models.executable.Executable
Retrieves the executable from the server.
+ 
+:param scenario_id: ID of the scenario the executable belongs to
+:type scenario_id: str
+:param executable_id: ID of the executable to be retrieved
+:type executable_id: str
+:param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
+    resource group in the :class:`ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client` should be specified,
+    defaults to None
+:type resource_group: str
+: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: The retrieved executable
+:rtype: class:`ai_api_client_sdk.models.executable.Executable`
+ +
query( + self, + scenario_id: str, + version_id: str = None, + resource_group: str = None +) -> ai_api_client_sdk.models.executable_query_response.ExecutableQueryResponse
Queries the executables.
+ 
+:param scenario_id: ID of the scenario the executables should belong to, defaults to None
+:type scenario_id: str, optional
+:param version_id: ID of the version, the executions should have, defaults to None
+:type version_id: str, optional
+:param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
+    resource group in the :class:`ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client` should be specified,
+    defaults to None
+:type resource_group: str
+: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
+:return: An object representing the response from the server
+:rtype: class:`ai_api_client_sdk.models.executable_query_response.ExecutableQueryResponse`
+ +
+Methods inherited from ai_api_client_sdk.resource_clients.base_client.BaseClient:
+
__init__(self, rest_client: ai_api_client_sdk.helpers.rest_client.RestClient)
Initialize self.  See help(type(self)) for accurate signature.
+ +
bulk_modify(self, *args, **kwargs)
Modifies multiple instances of the relevant resource. Will be implemented by the respective resource clients
+ +
count(self, *args, **kwargs)
Counts the relevant resources. Will be implemented by the respective resource clients
+ +
create(self, *args, **kwargs)
Creates the relevant resource. Will be implemented by the respective resource clients
+ +
delete(self, *args, **kwargs)
Deletes the relevant resource. Will be implemented by the respective resource clients
+ +
modify(self, *args, **kwargs)
Modifies the relevant resource. Will be implemented by the respective resource clients
+ +
query_logs(self, *args, **kwargs)
Queries the relevant logs. Will be implemented by the respective resource clients
+ +
+Data descriptors inherited from ai_api_client_sdk.resource_clients.base_client.BaseClient:
+
__dict__
+
dictionary for instance variables
+
+
__weakref__
+
list of weak references to the object
+
+

+ \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.resource_clients.execution_client.html b/packages/base/docs/ai_api_client_sdk.resource_clients.execution_client.html new file mode 100644 index 0000000..d208296 --- /dev/null +++ b/packages/base/docs/ai_api_client_sdk.resource_clients.execution_client.html @@ -0,0 +1,282 @@ + + + + +Python: module ai_api_client_sdk.resource_clients.execution_client + + + + + +
 
ai_api_client_sdk.resource_clients.execution_client		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/resource_clients/execution_client.py
+

+

+ + + + + +
 
Classes
       
+
ai_api_client_sdk.resource_clients.base_client.BaseClient(builtins.object) +
+
+
ExecutionClient +
+
+
+

+ + + + + + + +
 
class ExecutionClient(ai_api_client_sdk.resource_clients.base_client.BaseClient)
   ExecutionClient(rest_client: ai_api_client_sdk.helpers.rest_client.RestClient)
+ 
+ExecutionClient is a class implemented for interacting with the execution related endpoints of the server. It
+implements the base class :class:`ai_api_client_sdk.resource_clients.base_client.BaseClient`
 
 
Method resolution order:
+
ExecutionClient
+
ai_api_client_sdk.resource_clients.base_client.BaseClient
+
builtins.object
+
+
+Methods defined here:
+
bulk_modify( + self, + executions: List[ai_api_client_sdk.models.base_models.BasicModifyRequest], + resource_group: str = None +) -> ai_api_client_sdk.models.execution_bulk_modify_response.ExecutionBulkModifyResponse
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 :class:`ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client` should be specified,
+    defaults to None
+:type resource_group: str, optional
+: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
+:return: An object representing the response from the server
+:rtype: class:`ai_api_client_sdk.models.execution_bulk_modify_response.ExecutionBulkModifyResponse`
+ +
count( + self, + scenario_id: str = None, + configuration_id: str = None, + executable_ids: List[str] = None, + execution_schedule_id: str = None, + status: ai_api_client_sdk.models.status.Status = None, + resource_group: str = None +) -> int
Counts the number of executions.
+ 
+:param scenario_id: ID of the scenario, the executions should belong to, defaults to None
+:type scenario_id: str, optional
+:param configuration_id: ID of the configuration, the executions should be configured by, defaults to None
+:type configuration_id: str, optional
+:param executable_ids: IDs of the executables, the executions should be created from, defaults to None
+:type executable_ids: List[str], optional
+:param execution_schedule_id: ID of the execution schedule, defaults to None
+:type execution_schedule_id: str, optional
+:param status: Status which the executions should currently have
+:type status: class:`ai_api_client_sdk.models.status.Status`, optional
+:param resource_group: Resource group which the request should be sent on behalf. Either this or a default
+    resource group in the :class:`ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client` should be specified,
+    defaults to None
+:type resource_group: str
+: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
+:return: An object representing the response from the server
+:rtype: int
+ +
create(self, configuration_id: str, resource_group: str = None) -> ai_api_client_sdk.models.execution_create_response.ExecutionCreateResponse
Creates an execution.
+ 
+:param configuration_id: ID of the configuration, that should configure the execution
+:type configuration_id: str
+:param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
+    resource group in the :class:`ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client` should be specified,
+    defaults to None
+:type resource_group: str
+: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
+:return: An object representing the response from the server
+:rtype: class:`ai_api_client_sdk.models.execution_create_response.ExecutionCreateResponse`
+ +
delete(self, execution_id: str, resource_group: str = None) -> ai_api_client_sdk.models.base_models.BasicResponse
Deletes the execution.
+ 
+:param execution_id: ID of the execution to be deleted
+:type execution_id: str
+:param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
+    resource group in the :class:`ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client` should be specified,
+    defaults to None
+:type resource_group: str
+: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
+:return: An object representing the response from the server
+:rtype: class:`ai_api_client_sdk.models.base_models.BasicResponse`
+ +
get(self, execution_id: str, resource_group: str = None, select: str = None) -> Union[ai_api_client_sdk.models.execution.Execution, ai_api_client_sdk.models.execution_get_status_response.ExecutionGetStatusResponse]
Retrieves the execution from the server.
+ 
+:param execution_id: ID of the execution to be retrieved
+:type execution_id: str
+:param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
+    resource group in the :class:`ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client` should be specified,
+    defaults to None
+:type resource_group: str
+:param select: only status supported. Get execution for a given execution id and select status
+:type select: str, optional
+: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: The retrieved execution
+:rtype: class:Union[`ai_api_client_sdk.models.execution.Execution`,
+    `ai_api_client_sdk.models.execution_get_status_response.ExecutionGetStatusResponse`]
+ +
modify( + self, + execution_id: str, + target_status: ai_api_client_sdk.models.target_status.TargetStatus, + resource_group: str = None +) -> ai_api_client_sdk.models.base_models.BasicResponse
Modifies the execution, by changing the target status.
+ 
+:param execution_id: ID of the execution to be modified
+:type execution_id: str
+:param target_status: Desired target status of the execution, defaults to None
+:type target_status: class:`ai_api_client_sdk.models.target_status.TargetStatus`, optional
+:param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
+    resource group in the :class:`ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client` should be specified,
+    defaults to None
+:type resource_group: str
+: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
+:return: An object representing the response from the server
+:rtype: class:`ai_api_client_sdk.models.base_models.BasicResponse`
+ +
query( + self, + scenario_id: str = None, + configuration_id: str = None, + executable_ids: List[str] = None, + execution_schedule_id: str = None, + status: ai_api_client_sdk.models.status.Status = None, + top: int = None, + skip: int = None, + resource_group: str = None +) -> ai_api_client_sdk.models.execution_query_response.ExecutionQueryResponse
Queries the executions.
+ 
+:param scenario_id: ID of the scenario the executions should belong to, defaults to None
+:type scenario_id: str, optional
+:param configuration_id: ID of the configuration, the executions should be configured by, defaults to None
+:type configuration_id: str, optional
+:param executable_ids: IDs of the executables the executions should be created from, defaults to None
+:type executable_ids: List[str], optional
+:param execution_schedule_id: ID of the execution schedule, defaults to None
+:type execution_schedule_id: str, optional
+:param status: Status which the executions should currently have
+:type status: class:`ai_api_client_sdk.models.status.Status`, optional
+:param top: Number of executions to be retrieved, defaults to None
+:type top: int, optional
+:param skip: Number of executions to be skipped, from the list of the queried executions, defaults to None
+:type skip: int, optional
+:param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
+    resource group in the :class:`ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client` should be specified,
+    defaults to None
+:type resource_group: str
+: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
+:return: An object representing the response from the server
+:rtype: class:`ai_api_client_sdk.models.execution_query_response.ExecutionQueryResponse`
+ +
query_logs( + self, + execution_id: str, + top: int = None, + start: datetime.datetime = None, + end: datetime.datetime = None, + order: ai_api_client_sdk.models.base_models.Order = None, + resource_group: str = None +) -> ai_api_client_sdk.models.log_response.LogResponse
Queries the logs of the execution.
+ 
+:param execution_id: ID of the execution
+:type execution_id: str
+:param top: The max number of entries to return. Defaults to 1000. Limited to 5000 max.
+:type top: int
+:param start: The start time for the query. Defaults to one hour ago.
+:type start: datetime
+:param end: The end time for the query. Defaults to now.
+:type end: datetime
+:param order: Determines the sort order with respect to time. Defaults to asc.
+:type order: class:`ai_api_client_sdk.models.base_models.Order`
+:param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
+    resource group in the :class:`ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client` should be specified,
+    defaults to None
+:type resource_group: str
+: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: Logs from the execution
+:rtype: class:`ai_api_client_sdk.models.log_response.LogResponse`
+ +
+Methods inherited from ai_api_client_sdk.resource_clients.base_client.BaseClient:
+
__init__(self, rest_client: ai_api_client_sdk.helpers.rest_client.RestClient)
Initialize self.  See help(type(self)) for accurate signature.
+ +
+Data descriptors inherited from ai_api_client_sdk.resource_clients.base_client.BaseClient:
+
__dict__
+
dictionary for instance variables
+
+
__weakref__
+
list of weak references to the object
+
+

+ + + + + +
 
Data
       List = typing.List
+Union = typing.Union
+ \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.resource_clients.execution_schedule_client.html b/packages/base/docs/ai_api_client_sdk.resource_clients.execution_schedule_client.html new file mode 100644 index 0000000..54c1b49 --- /dev/null +++ b/packages/base/docs/ai_api_client_sdk.resource_clients.execution_schedule_client.html @@ -0,0 +1,235 @@ + + + + +Python: module ai_api_client_sdk.resource_clients.execution_schedule_client + + + + + +
 
ai_api_client_sdk.resource_clients.execution_schedule_client		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/resource_clients/execution_schedule_client.py
+

+

+ + + + + +
 
Classes
       
+
ai_api_client_sdk.resource_clients.base_client.BaseClient(builtins.object) +
+
+
ExecutionScheduleClient +
+
+
+

+ + + + + + + +
 
class ExecutionScheduleClient(ai_api_client_sdk.resource_clients.base_client.BaseClient)
   ExecutionScheduleClient(
+    rest_client: ai_api_client_sdk.helpers.rest_client.RestClient
+)
+ 
+ExecutionScheduleClient is a class implemented for interacting with the execution schedules related endpoints of
+the server. It implements the base class :class:`ai_api_client_sdk.resource_clients.base_client.BaseClient`
 
 
Method resolution order:
+
ExecutionScheduleClient
+
ai_api_client_sdk.resource_clients.base_client.BaseClient
+
builtins.object
+
+
+Methods defined here:
+
count( + self, + configuration_id: str = None, + status: ai_api_client_sdk.models.status.ScheduleStatus = None, + resource_group: str = None +) -> int
Counts the number of executions schedules.
+ 
+:param configuration_id: ID of the configuration, the executions should be configured by, defaults to None
+:type configuration_id: str, optional
+:param status: ScheduleStatus which the execution schedule should currently have, defaults to None
+:type status: class:`ai_api_client_sdk.models.schedule_status.ScheduleStatus`, optional
+:param resource_group: Resource group which the request should be sent on behalf. Either this or a default
+    resource group in the :class:`ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client` should be specified,
+    defaults to None
+:type resource_group: str
+: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
+:return: An object representing the response from the server
+:rtype: int
+ +
create( + self, + name: str, + cron: str, + configuration_id: str, + start: datetime.datetime = None, + end: datetime.datetime = None, + resource_group: str = None +) -> ai_api_client_sdk.models.execution_schedule_create_response.ExecutionScheduleCreateResponse
Creates an execution schedule.
+ 
+:param name: Name of the execution schedule
+:type name: str
+:param cron: Cron defining the schedule to run the executions
+:type name: str
+:param configuration_id: ID of the configuration for the execution schedule
+:type configuration_id: str
+:param start: Start time of the execution schedule in UTC, defaults to None
+:type start: datetime, optional
+:param end: End time of the execution schedule in UTC e.g., defaults to None
+:type end: datetime, optional
+:param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
+    resource group in the :class:`ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client` should be specified,
+    defaults to None
+:type resource_group: str
+: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
+:return: An object representing the response from the server
+:rtype: class:`ai_api_client_sdk.models.execution_schedule_create_response.ExecutionScheduleCreateResponse`
+ +
delete(self, execution_schedule_id: str, resource_group: str = None) -> ai_api_client_sdk.models.base_models.BasicResponse
Deletes the execution schedule.
+ 
+:param execution_schedule_id: ID of the execution schedule to be deleted
+:type execution_schedule_id: str
+:param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
+    resource group in the :class:`ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client` should be specified,
+    defaults to None
+:type resource_group: str
+: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
+:return: An object representing the response from the server
+:rtype: class:`ai_api_client_sdk.models.base_models.BasicResponse`
+ +
get(self, execution_schedule_id: str, resource_group: str = None) -> ai_api_client_sdk.models.execution_schedule.ExecutionSchedule
Retrieves the execution schedule from the server.
+ 
+:param execution_schedule_id: ID of the execution schedule to be retrieved
+:type execution_schedule_id: str
+:param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
+    resource group in the :class:`ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client` should be specified,
+    defaults to None
+:type resource_group: str
+: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: The retrieved execution
+:rtype: class:`ai_api_client_sdk.models.execution.Execution`
+ +
modify( + self, + execution_schedule_id: str, + cron: str = None, + start: datetime.datetime = None, + end: datetime.datetime = None, + configurationId: str = None, + status: ai_api_client_sdk.models.status.ScheduleStatus = None, + resource_group: str = None +) -> ai_api_client_sdk.models.base_models.BasicResponse
Modifies the execution schedule.
+ 
+:param execution_schedule_id: ID of the execution to be modified
+:type execution_schedule_id: str
+:param cron: Cron defining the schedule to run the executions, defaults to None
+:type cron: str, optional
+:param configurationId: ID of the configuration for the execution schedule, defaults to None
+:type configurationId: str, optional
+:param start: Start time of the execution schedule in UTC, defaults to None
+:type start: datetime, optional
+:param end: End time of the execution schedule in UTC, defaults to None
+:type end: datetime, optional
+:param status: pause / resume Status of the execution schedule, defaults to None
+:type status: class:`ai_api_client_sdk.models.status.ScheduleStatus`, optional
+:param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
+    resource group in the :class:`ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client` should be specified,
+    defaults to None
+:type resource_group: str
+: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: An object representing the response from the server
+:rtype: class:`ai_api_client_sdk.models.base_models.BasicResponse`
+ +
query( + self, + configuration_id: str = None, + status: ai_api_client_sdk.models.status.ScheduleStatus = None, + top: int = None, + skip: int = None, + resource_group: str = None +) -> ai_api_client_sdk.models.execution_schedule_query_response.ExecutionScheduleQueryResponse
Queries the execution schedules.
+ 
+:param configuration_id: ID of the configuration, the executions should be configured by, defaults to None
+:type configuration_id: str, optional
+:param status:  ScheduleStatus which the execution schedule should currently have
+:type status: class:`ai_api_client_sdk.models.schedule_status.ScheduleStatus`, optional
+:param top: Number of executions to be retrieved, defaults to None
+:type top: int, optional
+:param skip: Number of executions to be skipped, from the list of the queried executions, defaults to None
+:type skip: int, optional
+:param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
+    resource group in the :class:`ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client` should be specified,
+    defaults to None
+:type resource_group: str
+: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
+:return: An object representing the response from the server
+:rtype: class:`ai_api_client_sdk.models.execution_query_response.ExecutionQueryResponse`
+ +
+Methods inherited from ai_api_client_sdk.resource_clients.base_client.BaseClient:
+
__init__(self, rest_client: ai_api_client_sdk.helpers.rest_client.RestClient)
Initialize self.  See help(type(self)) for accurate signature.
+ +
bulk_modify(self, *args, **kwargs)
Modifies multiple instances of the relevant resource. Will be implemented by the respective resource clients
+ +
query_logs(self, *args, **kwargs)
Queries the relevant logs. Will be implemented by the respective resource clients
+ +
+Data descriptors inherited from ai_api_client_sdk.resource_clients.base_client.BaseClient:
+
__dict__
+
dictionary for instance variables
+
+
__weakref__
+
list of weak references to the object
+
+

+ + + + + +
 
Data
       DATETIME_FORMAT = '%Y-%m-%dT%H:%M:%SZ'
+ \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.resource_clients.healthz_client.html b/packages/base/docs/ai_api_client_sdk.resource_clients.healthz_client.html new file mode 100644 index 0000000..613facd --- /dev/null +++ b/packages/base/docs/ai_api_client_sdk.resource_clients.healthz_client.html @@ -0,0 +1,79 @@ + + + + +Python: module ai_api_client_sdk.resource_clients.healthz_client + + + + + +
 
ai_api_client_sdk.resource_clients.healthz_client		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/resource_clients/healthz_client.py
+

+

+ + + + + +
 
Classes
       
+
ai_api_client_sdk.resource_clients.base_client.BaseClient(builtins.object) +
+
+
HealthzClient +
+
+
+

+ + + + + + + +
 
class HealthzClient(ai_api_client_sdk.resource_clients.base_client.BaseClient)
   HealthzClient(rest_client: ai_api_client_sdk.helpers.rest_client.RestClient)
+ 
+HealthzClient is a class implemented for interacting with the healthz endpoint of the server. It implements the
+base class :class:`ai_api_client_sdk.resource_clients.base_client.BaseClient`
 
 
Method resolution order:
+
HealthzClient
+
ai_api_client_sdk.resource_clients.base_client.BaseClient
+
builtins.object
+
+
+Methods defined here:
+
get(self) -> ai_api_client_sdk.models.healthz_status.HealthzStatus
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
+:return: The health status of the server
+:rtype: class:`ai_api_client_sdk.models.healthz_status.HealthzStatus`
+ +
+Methods inherited from ai_api_client_sdk.resource_clients.base_client.BaseClient:
+
__init__(self, rest_client: ai_api_client_sdk.helpers.rest_client.RestClient)
Initialize self.  See help(type(self)) for accurate signature.
+ +
bulk_modify(self, *args, **kwargs)
Modifies multiple instances of the relevant resource. Will be implemented by the respective resource clients
+ +
count(self, *args, **kwargs)
Counts the relevant resources. Will be implemented by the respective resource clients
+ +
create(self, *args, **kwargs)
Creates the relevant resource. Will be implemented by the respective resource clients
+ +
delete(self, *args, **kwargs)
Deletes the relevant resource. Will be implemented by the respective resource clients
+ +
modify(self, *args, **kwargs)
Modifies the relevant resource. Will be implemented by the respective resource clients
+ +
query(self, *args, **kwargs)
Queries the relevant resources. Will be implemented by the respective resource clients
+ +
query_logs(self, *args, **kwargs)
Queries the relevant logs. Will be implemented by the respective resource clients
+ +
+Data descriptors inherited from ai_api_client_sdk.resource_clients.base_client.BaseClient:
+
__dict__
+
dictionary for instance variables
+
+
__weakref__
+
list of weak references to the object
+
+

+ \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.resource_clients.html b/packages/base/docs/ai_api_client_sdk.resource_clients.html new file mode 100644 index 0000000..8790b97 --- /dev/null +++ b/packages/base/docs/ai_api_client_sdk.resource_clients.html @@ -0,0 +1,33 @@ + + + + +Python: package ai_api_client_sdk.resource_clients + + + + + +
 
ai_api_client_sdk.resource_clients		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/resource_clients/__init__.py
+

+

+ + + + + +
 
Package Contents
       
artifact_client
+base_client
+configuration_client
+deployment_client
+		executable_client
+execution_client
+execution_schedule_client
+healthz_client
+		meta_client
+metrics_client
+model_client
+resource_groups_client
+		scenario_client
+
+ \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.resource_clients.meta_client.html b/packages/base/docs/ai_api_client_sdk.resource_clients.meta_client.html new file mode 100644 index 0000000..40eb4a2 --- /dev/null +++ b/packages/base/docs/ai_api_client_sdk.resource_clients.meta_client.html @@ -0,0 +1,75 @@ + + + + +Python: module ai_api_client_sdk.resource_clients.meta_client + + + + + +
 
ai_api_client_sdk.resource_clients.meta_client		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/resource_clients/meta_client.py
+

+

+ + + + + +
 
Classes
       
+
ai_api_client_sdk.resource_clients.base_client.BaseClient(builtins.object) +
+
+
MetaClient +
+
+
+

+ + + + + + + +
 
class MetaClient(ai_api_client_sdk.resource_clients.base_client.BaseClient)
   MetaClient(rest_client: ai_api_client_sdk.helpers.rest_client.RestClient)
+ 
+
 
 
Method resolution order:
+
MetaClient
+
ai_api_client_sdk.resource_clients.base_client.BaseClient
+
builtins.object
+
+
+Methods defined here:
+
get(self) -> ai_api_client_sdk.models.capabilities.Capabilities
Retrieves the relevant resource. Will be implemented by the respective resource clients
+ +
get_versions(self) -> ai_api_client_sdk.models.version_list.VersionList
+ +
+Methods inherited from ai_api_client_sdk.resource_clients.base_client.BaseClient:
+
__init__(self, rest_client: ai_api_client_sdk.helpers.rest_client.RestClient)
Initialize self.  See help(type(self)) for accurate signature.
+ +
bulk_modify(self, *args, **kwargs)
Modifies multiple instances of the relevant resource. Will be implemented by the respective resource clients
+ +
count(self, *args, **kwargs)
Counts the relevant resources. Will be implemented by the respective resource clients
+ +
create(self, *args, **kwargs)
Creates the relevant resource. Will be implemented by the respective resource clients
+ +
delete(self, *args, **kwargs)
Deletes the relevant resource. Will be implemented by the respective resource clients
+ +
modify(self, *args, **kwargs)
Modifies the relevant resource. Will be implemented by the respective resource clients
+ +
query(self, *args, **kwargs)
Queries the relevant resources. Will be implemented by the respective resource clients
+ +
query_logs(self, *args, **kwargs)
Queries the relevant logs. Will be implemented by the respective resource clients
+ +
+Data descriptors inherited from ai_api_client_sdk.resource_clients.base_client.BaseClient:
+
__dict__
+
dictionary for instance variables
+
+
__weakref__
+
list of weak references to the object
+
+

+ \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.resource_clients.metrics_client.html b/packages/base/docs/ai_api_client_sdk.resource_clients.metrics_client.html new file mode 100644 index 0000000..19f916f --- /dev/null +++ b/packages/base/docs/ai_api_client_sdk.resource_clients.metrics_client.html @@ -0,0 +1,129 @@ + + + + +Python: module ai_api_client_sdk.resource_clients.metrics_client + + + + + +
 
ai_api_client_sdk.resource_clients.metrics_client		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/resource_clients/metrics_client.py
+

+

+ + + + + +
 
Modules
       
warnings
+

+ + + + + +
 
Classes
       
+
ai_api_client_sdk.resource_clients.base_client.BaseClient(builtins.object) +
+
+
MetricsClient +
+
+
+

+ + + + + + + +
 
class MetricsClient(ai_api_client_sdk.resource_clients.base_client.BaseClient)
   MetricsClient(rest_client: ai_api_client_sdk.helpers.rest_client.RestClient)
+ 
+MetricsClient is a class implemented for interacting with the metrics related endpoints of the server. It
+implements the base class :class:`ai_api_client_sdk.resource_clients.base_client.BaseClient`
 
 
Method resolution order:
+
MetricsClient
+
ai_api_client_sdk.resource_clients.base_client.BaseClient
+
builtins.object
+
+
+Methods defined here:
+
delete(self, execution_id: str, resource_group: str = None) -> None
Deletes the metrics.
+ 
+:param execution_id: ID of the execution, of which the metrics should be deleted.
+:type execution_id: str
+:param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
+    resource group in the :class:`ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client` should be specified,
+    defaults to None
+:type resource_group: str
+: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
+ +
query( + self, + filter: str = None, + execution_ids: List[str] = None, + select: List[str] = None, + resource_group: str = None +) -> ai_api_client_sdk.models.metrics_query_response.MetricsQueryResponse
Queries the metrics.
+ 
+:param filter: 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
+:type filter: str, optional
+:param execution_ids: IDs of the executions, of which the metrics should be retrieved, defaults to None
+:type execution_ids: List[str], optional
+:param select: 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
+:type select: List[str], optional
+:param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
+    resource group in the :class:`ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client` should be specified,
+    defaults to None
+:type resource_group: str
+: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
+:return: An object representing the response from the server
+:rtype: class:`ai_api_client_sdk.models.metrics_query_response.MetricsQueryResponse`
+ +
+Methods inherited from ai_api_client_sdk.resource_clients.base_client.BaseClient:
+
__init__(self, rest_client: ai_api_client_sdk.helpers.rest_client.RestClient)
Initialize self.  See help(type(self)) for accurate signature.
+ +
bulk_modify(self, *args, **kwargs)
Modifies multiple instances of the relevant resource. Will be implemented by the respective resource clients
+ +
count(self, *args, **kwargs)
Counts the relevant resources. Will be implemented by the respective resource clients
+ +
create(self, *args, **kwargs)
Creates the relevant resource. Will be implemented by the respective resource clients
+ +
get(self, *args, **kwargs)
Retrieves the relevant resource. Will be implemented by the respective resource clients
+ +
modify(self, *args, **kwargs)
Modifies the relevant resource. Will be implemented by the respective resource clients
+ +
query_logs(self, *args, **kwargs)
Queries the relevant logs. Will be implemented by the respective resource clients
+ +
+Data descriptors inherited from ai_api_client_sdk.resource_clients.base_client.BaseClient:
+
__dict__
+
dictionary for instance variables
+
+
__weakref__
+
list of weak references to the object
+
+

+ + + + + +
 
Data
       List = typing.List
+ \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.resource_clients.model_client.html b/packages/base/docs/ai_api_client_sdk.resource_clients.model_client.html new file mode 100644 index 0000000..dbec6b4 --- /dev/null +++ b/packages/base/docs/ai_api_client_sdk.resource_clients.model_client.html @@ -0,0 +1,91 @@ + + + + +Python: module ai_api_client_sdk.resource_clients.model_client + + + + + +
 
ai_api_client_sdk.resource_clients.model_client		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/resource_clients/model_client.py
+

+

+ + + + + +
 
Classes
       
+
ai_api_client_sdk.resource_clients.base_client.BaseClient(builtins.object) +
+
+
ModelClient +
+
+
+

+ + + + + + + +
 
class ModelClient(ai_api_client_sdk.resource_clients.base_client.BaseClient)
   ModelClient(rest_client: ai_api_client_sdk.helpers.rest_client.RestClient)
+ 
+ModelClient is a class implemented for interacting with model related endpoints of the server. It
+implements the base class :class:`ai_api_client_sdk.resource_clients.base_client.BaseClient`
 
 
Method resolution order:
+
ModelClient
+
ai_api_client_sdk.resource_clients.base_client.BaseClient
+
builtins.object
+
+
+Methods defined here:
+
query(self, resource_group: str = None) -> ai_api_client_sdk.models.model_query_response.ModelQueryResponse
Queries the models.
+ 
+:param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
+    resource group in the :class:`ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client` should be specified,
+    defaults to None
+:type resource_group: str
+: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
+:return: An object representing the response from the server
+:rtype: class:`ai_api_client_sdk.models.executable_query_response.ModelQueryResponse`
+ +
+Data and other attributes defined here:
+
DEFAULT_SCENARIO_ID = 'foundation-models'
+ +
+Methods inherited from ai_api_client_sdk.resource_clients.base_client.BaseClient:
+
__init__(self, rest_client: ai_api_client_sdk.helpers.rest_client.RestClient)
Initialize self.  See help(type(self)) for accurate signature.
+ +
bulk_modify(self, *args, **kwargs)
Modifies multiple instances of the relevant resource. Will be implemented by the respective resource clients
+ +
count(self, *args, **kwargs)
Counts the relevant resources. Will be implemented by the respective resource clients
+ +
create(self, *args, **kwargs)
Creates the relevant resource. Will be implemented by the respective resource clients
+ +
delete(self, *args, **kwargs)
Deletes the relevant resource. Will be implemented by the respective resource clients
+ +
get(self, *args, **kwargs)
Retrieves the relevant resource. Will be implemented by the respective resource clients
+ +
modify(self, *args, **kwargs)
Modifies the relevant resource. Will be implemented by the respective resource clients
+ +
query_logs(self, *args, **kwargs)
Queries the relevant logs. Will be implemented by the respective resource clients
+ +
+Data descriptors inherited from ai_api_client_sdk.resource_clients.base_client.BaseClient:
+
__dict__
+
dictionary for instance variables
+
+
__weakref__
+
list of weak references to the object
+
+

+ \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.resource_clients.resource_groups_client.html b/packages/base/docs/ai_api_client_sdk.resource_clients.resource_groups_client.html new file mode 100644 index 0000000..f56cdd2 --- /dev/null +++ b/packages/base/docs/ai_api_client_sdk.resource_clients.resource_groups_client.html @@ -0,0 +1,159 @@ + + + + +Python: module ai_api_client_sdk.resource_clients.resource_groups_client + + + + + +
 
ai_api_client_sdk.resource_clients.resource_groups_client		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/resource_clients/resource_groups_client.py
+

+

+ + + + + +
 
Classes
       
+
ai_api_client_sdk.resource_clients.base_client.BaseClient(builtins.object) +
+
+
ResourceGroupsClient +
+
+
+

+ + + + + + + +
 
class ResourceGroupsClient(ai_api_client_sdk.resource_clients.base_client.BaseClient)
   ResourceGroupsClient(
+    rest_client: ai_api_client_sdk.helpers.rest_client.RestClient
+)
+ 
+ResourceGroupsClient is a class implemented for interacting with the resource groups endpoints of the server.
+It implements the base class
+:class:`ai_api_client_sdk.resource_clients.base_client.BaseClient`
 
 
Method resolution order:
+
ResourceGroupsClient
+
ai_api_client_sdk.resource_clients.base_client.BaseClient
+
builtins.object
+
+
+Methods defined here:
+
create( + self, + resource_group_id: str, + labels: List[ai_api_client_sdk.models.label.Label] = None +) -> ai_api_client_sdk.models.resource_group.ResourceGroup
Creates resource group for a given tenant.
+ 
+:param resource_group_id: the id of the resource group and the length must be between 3 and 10 characters.
+:type resource_group_id: str
+:param labels: key-value pairs of the labels that will be added to the resource group.
+:type labels: List[Label]
+: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
+:return: An object representing the response from the server
+:rtype: class:`ai_core_sdk.models.resource_group.ResourceGroup`
+ +
delete(self, resource_group_id: str) -> ai_api_client_sdk.models.base_models.BasicResponse
Deletes the resource group.
+ 
+:param resource_group_id: the id of the resource group to be deleted
+:type resource_group_id: str
+: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
+:return: An object representing the response from the server
+:rtype: class:`ai_api_client_sdk.models.base_models.BasicResponse`
+ +
get(self, resource_group_id: str) -> ai_api_client_sdk.models.resource_group.ResourceGroup
Gets a resource group of a given tenant.
+ 
+:param resource_group_id: the id of the resource group to be retrieved
+:type resource_group_id: str
+: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: An object representing the resource group from the server
+:rtype: class:`ai_core_sdk.models.resource_group.ResourceGroup`
+ +
modify( + self, + resource_group_id: str, + labels: List[ai_api_client_sdk.models.label.Label] +) -> None
Modifies a resource group.
+ 
+:param resource_group_id: the id of the resource group
+:type resource_group_id: str
+:param labels: key-value pairs of the labels that will be added to the resource group.
+:type labels: List[Label]
+: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
+:return: An object representing the response from the server
+ +
query(self, search: str = None, search_case_insensitive: bool = None) -> ai_api_client_sdk.models.resource_group_query_response.ResourceGroupQueryResponse
Get all resource groups.
+ 
+:param search: Generic search term to be looked for in various attributes of resource groups, defaults to None
+:type search: str, optional
+:param search_case_insensitive: Indicates whether the search should be case insensitive
+:type search_case_insensitive: bool, optional
+: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
+:return: A list of resource groups for a given tenant.
+:rtype: class:`ai_core_sdk.models.resource_group_query_response.ResourceGroupQueryResponse`
+ +
+Methods inherited from ai_api_client_sdk.resource_clients.base_client.BaseClient:
+
__init__(self, rest_client: ai_api_client_sdk.helpers.rest_client.RestClient)
Initialize self.  See help(type(self)) for accurate signature.
+ +
bulk_modify(self, *args, **kwargs)
Modifies multiple instances of the relevant resource. Will be implemented by the respective resource clients
+ +
count(self, *args, **kwargs)
Counts the relevant resources. Will be implemented by the respective resource clients
+ +
query_logs(self, *args, **kwargs)
Queries the relevant logs. Will be implemented by the respective resource clients
+ +
+Data descriptors inherited from ai_api_client_sdk.resource_clients.base_client.BaseClient:
+
__dict__
+
dictionary for instance variables
+
+
__weakref__
+
list of weak references to the object
+
+

+ + + + + +
 
Data
       List = typing.List
+ \ No newline at end of file diff --git a/packages/base/docs/ai_api_client_sdk.resource_clients.scenario_client.html b/packages/base/docs/ai_api_client_sdk.resource_clients.scenario_client.html new file mode 100644 index 0000000..e33cb1a --- /dev/null +++ b/packages/base/docs/ai_api_client_sdk.resource_clients.scenario_client.html @@ -0,0 +1,150 @@ + + + + +Python: module ai_api_client_sdk.resource_clients.scenario_client + + + + + +
 
ai_api_client_sdk.resource_clients.scenario_client		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/base/ai_api_client_sdk/resource_clients/scenario_client.py
+

+

+ + + + + +
 
Classes
       
+
ai_api_client_sdk.resource_clients.base_client.BaseClient(builtins.object) +
+
+
ScenarioClient +
+
+
+

+ + + + + + + +
 
class ScenarioClient(ai_api_client_sdk.resource_clients.base_client.BaseClient)
   ScenarioClient(rest_client: ai_api_client_sdk.helpers.rest_client.RestClient)
+ 
+ScenarioClient is a class implemented for interacting with the scenario related endpoints of the server. It
+implements the base class :class:`ai_api_client_sdk.resource_clients.base_client.BaseClient`
 
 
Method resolution order:
+
ScenarioClient
+
ai_api_client_sdk.resource_clients.base_client.BaseClient
+
builtins.object
+
+
+Methods defined here:
+
get(self, scenario_id: str, resource_group: str = None) -> ai_api_client_sdk.models.scenario.Scenario
Retrieves the scenario from the server.
+ 
+:param scenario_id: ID of the scenario to be retrieved
+:type scenario_id: str
+:param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
+    resource group in the :class:`ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client` should be specified,
+    defaults to None
+:type resource_group: str
+: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: The retrieved scenario
+:rtype: class:`ai_api_client_sdk.models.scenario.Scenario`
+ +
query(self, only_llm_scenarios: bool = False, resource_group: str = None) -> ai_api_client_sdk.models.scenario_query_response.ScenarioQueryResponse
Queries the scenarios.
+ 
+:param only_llm_scenarios: indicates whether to query for LLM scenarios only, defaults to False
+:type only_llm_scenarios:  bool, optional
+:param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
+    resource group in the :class:`ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client` should be specified,
+    defaults to None
+:type resource_group: str
+: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
+:return: An object representing the response from the server
+:rtype: class:`ai_api_client_sdk.models.scenario_query_response.ScenarioQueryResponse`
+ +
query_llm_scenarios(self, resource_group: str = None) -> ai_api_client_sdk.models.scenario_query_response.ScenarioQueryResponse
Queries for the LLM scenarios.
+ 
+:param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
+    resource group in the :class:`ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client` should be specified,
+    defaults to None
+:type resource_group: str
+: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
+:return: An object representing the response from the server
+:rtype: class:`ai_api_client_sdk.models.scenario_query_response.ScenarioQueryResponse`
+ +
query_versions( + self, + scenario_id: str, + label_selector: List[str] = None, + resource_group: str = None +) -> ai_api_client_sdk.models.version_query_response.VersionQueryResponse
Queries the versions.
+ 
+:param scenario_id: ID of the scenario, the versions should belong to
+:type scenario_id: str
+:param label_selector: 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
+:type label_selector: List[str], optional
+:param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
+    resource group in the :class:`ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client` should be specified,
+    defaults to None
+:type resource_group: str
+: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
+:return: An object representing the response from the server
+:rtype: class:`ai_api_client_sdk.models.scenario_query_response.ScenarioQueryResponse`
+ +
+Methods inherited from ai_api_client_sdk.resource_clients.base_client.BaseClient:
+
__init__(self, rest_client: ai_api_client_sdk.helpers.rest_client.RestClient)
Initialize self.  See help(type(self)) for accurate signature.
+ +
bulk_modify(self, *args, **kwargs)
Modifies multiple instances of the relevant resource. Will be implemented by the respective resource clients
+ +
count(self, *args, **kwargs)
Counts the relevant resources. Will be implemented by the respective resource clients
+ +
create(self, *args, **kwargs)
Creates the relevant resource. Will be implemented by the respective resource clients
+ +
delete(self, *args, **kwargs)
Deletes the relevant resource. Will be implemented by the respective resource clients
+ +
modify(self, *args, **kwargs)
Modifies the relevant resource. Will be implemented by the respective resource clients
+ +
query_logs(self, *args, **kwargs)
Queries the relevant logs. Will be implemented by the respective resource clients
+ +
+Data descriptors inherited from ai_api_client_sdk.resource_clients.base_client.BaseClient:
+
__dict__
+
dictionary for instance variables
+
+
__weakref__
+
list of weak references to the object
+
+

+ + + + + +
 
Data
       List = typing.List
+ \ No newline at end of file diff --git a/packages/core/docs/ai_core_sdk.ai_core_v2_client.html b/packages/core/docs/ai_core_sdk.ai_core_v2_client.html new file mode 100644 index 0000000..c67c3de --- /dev/null +++ b/packages/core/docs/ai_core_sdk.ai_core_v2_client.html @@ -0,0 +1,150 @@ + + + + +Python: module ai_core_sdk.ai_core_v2_client + + + + + +
 
ai_core_sdk.ai_core_v2_client		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/core/ai_core_sdk/ai_core_v2_client.py
+

+

+ + + + + +
 
Modules
       
os
+

+ + + + + +
 
Classes
       
+
builtins.object +
+
+
AICoreV2Client +
+
+
+

+ + + + + + + +
 
class AICoreV2Client(builtins.object)
   AICoreV2Client(
+    base_url: str,
+    auth_url: str = None,
+    client_id: str = None,
+    client_secret: str = None,
+    cert_str: str = None,
+    key_str: str = None,
+    cert_file_path: str = None,
+    key_file_path: str = None,
+    token_creator: Callable[[], str] = None,
+    resource_group: str = None,
+    client_type: str = 'AI Core Python SDK',
+    **kwargs
+)
+ 
+The AICoreV2Client is the class implemented to interact with the AI Core endpoints. The user can use its
+attributes corresponding to the resources, for interacting with endpoints related to that resource. (i.e.,
+aicoreclient.scenario)
+ 
+:param base_url: Base URL of the AI Core. Should include the base path as well. (i.e., "<base_url>/lm/scenarios"
+    should work)
+:type base_url: str
+:param auth_url: URL of the authorization endpoint. Should be the full URL (including /oauth/token), defaults to
+    None
+:type auth_url: str, optional
+:param client_id: client id to be used for authorization, defaults to None
+:type client_id: str, optional
+:param client_secret: client secret to be used for authorization, defaults to None
+:type client_secret: str, optional
+:param cert_str: certificate file content, needs to be provided alongside the key_str parameter, defaults to None
+:type cert_str: str, optional
+:param key_str: key file content, needs to be provided alongside the cert_str parameter, defaults to None
+:type key_str: str, optional
+:param cert_file_path: path to the certificate file, needs to be provided alongside the key_file_path parameter,
+    defaults to None
+:type cert_file_path: str, optional
+:param key_file_path: path to the key file, needs to be provided alongside the cert_file_path parameter,
+    defaults to None
+:type key_file_path: str, optional
+:param token_creator: the function which returns the Bearer token, when called. Either this, or
+    auth_url & client_id & client_secret should be specified, defaults to None
+:type token_creator: Callable[[], str], optional
+:param resource_group: The default resource group which will be used while sending the requests to the server. If
+    not set, the resource_group should be specified with every request to the server, defaults to None
+:type resource_group: str, optional
+:param client_type: The client type which will be sent in the User-Agent header of the requests, defaults to
+    "AI Core Python SDK"
+:type client_type: str, optional
+:param \**kwargs:
+    * *read_timeout* (int): Read timeout for requests in seconds, defaults to 60s
+    * *connect_timeout* (int): Connect timeout for requests in seconds, defaults to 60s
+    * *num_request_retries* (int): Number of retries for failing requests with http status code 429, 500, 502, 503 or 504, defaults to 10
 
 Methods defined here:
+
__init__( + self, + base_url: str, + auth_url: str = None, + client_id: str = None, + client_secret: str = None, + cert_str: str = None, + key_str: str = None, + cert_file_path: str = None, + key_file_path: str = None, + token_creator: Callable[[], str] = None, + resource_group: str = None, + client_type: str = 'AI Core Python SDK', + **kwargs +)
Initialize self.  See help(type(self)) for accurate signature.
+ +
+Static methods defined here:
+
from_env(profile_name: str = None, **kwargs)
Alternative way to create an AICoreV2Client object.
+Parameters for base_url, auth_url, client_id, client_secret, x.509 credentials (either as file path or string)
+and resource_group can be passed as keyword or are pulled from environment variables.
+It is also possible to use a profile, which is a json file in the config directory. The profile name can be
+passed as keyword or is pulled from the environment variable AICORE_PROFILE. If no profile is specified,
+the default profile is used.
+A specific path to a config, that should be used, can be set via the environment variable AICORE_CONFIG.
+The hierarchy of precedence is:
+1. keyword argument
+2. environment variable
+3. configuration file
+4. value from VCAP_SERVICES environment variable, if exists
+ 
+:param profile_name: name of the profile to use, defaults to None. If None is passed, the profile is read from
+    the environment variable AICORE_PROFILE. If this is not set, the default profile is used.
+    The default profile is read from $AICORE_HOME/config.json.
+:type profile_name: optional, str
+**kwargs: check the parameters of the class constructor
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables
+
+
__weakref__
+
list of weak references to the object
+
+
+Data and other attributes defined here:
+
logger = <Logger ai_core_sdk (INFO)>
+ +

+ + + + + +
 
Data
       Callable = typing.Callable
+ \ No newline at end of file diff --git a/packages/core/docs/ai_core_sdk.cli.html b/packages/core/docs/ai_core_sdk.cli.html new file mode 100644 index 0000000..d4fdfe0 --- /dev/null +++ b/packages/core/docs/ai_core_sdk.cli.html @@ -0,0 +1,64 @@ + + + + +Python: module ai_core_sdk.cli + + + + + +
 
ai_core_sdk.cli		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/core/ai_core_sdk/cli.py
+

+

+ + + + + +
 
Modules
       
click
+		json
+		pathlib
+

+ + + + + +
 
Functions
       
confirm_resource_group(resource_group: 'Optional[str]' = None)
+
create_config(**kwargs)
# Utility Functions
+
create_config_file( + config_path: 'pathlib.Path', + auth_url: 'str', + client_id: 'str', + client_secret: 'str', + cert_file_path: 'pathlib.Path', + key_file_path: 'pathlib.Path', + base_url: 'str', + resource_group: 'str' +)
+
get_auth_url(auth_url: 'Optional[str]' = None)
+
get_base_url(base_url: 'Optional[str]' = None)
+
get_profile_config_path(profile: 'str')
+
get_str_value(msg: 'str', value: 'Optional[str]' = None)
+
is_valid_url(url, path_forbidden=True)
+
load_service_key(service_key_json: 'str')
+
prompt_for_input(prompt_text, is_url=False, path_forbidden=True)
+

+ + + + + +
 
Data
       AI_CORE_PREFIX = 'AICORE'
+API_V2_SUFFIX = '/v2'
+CORE_CREDENTIAL_VALUES = [CredentialsValue(name='client_id', vcap_key=('credentials', 'clientid'), transform_fn=None), CredentialsValue(name='client_secret', vcap_key=('credentials', 'clientsecret'), transform_fn=None), CredentialsValue(name='auth_url', vcap_key=('credentials', 'url'), transform_fn=<lambda>), CredentialsValue(name='base_url', vcap_key=('cre...rviceurls', 'AI_API_URL'), transform_fn=<lambda>), CredentialsValue(name='resource_group', vcap_key=None, transform_fn=None), CredentialsValue(name='cert_url', vcap_key=('credentials', 'certurl'), transform_fn=<lambda>), CredentialsValue(name='cert_file_path', vcap_key=None, transform_fn=None), CredentialsValue(name='key_file_path', vcap_key=None, transform_fn=None), CredentialsValue(name='cert_str', vcap_key=('credentials', 'certificate'), transform_fn=<lambda>), CredentialsValue(name='key_str', vcap_key=('credentials', 'key'), transform_fn=<lambda>)]
+DEFAULT_CONFIG = 'config.json'
+DEFAULT_PROFILE = 'default'
+DEFAULT_RESOURCE_GROUP = 'default'
+MAX_TRIES = 5
+OAUTH_TOKEN_SUFFIX = '/oauth/token'
+Optional = typing.Optional
+cli = <Group cli>
+configure = <Command configure>
+ \ No newline at end of file diff --git a/packages/core/docs/ai_core_sdk.credentials.html b/packages/core/docs/ai_core_sdk.credentials.html new file mode 100644 index 0000000..3621959 --- /dev/null +++ b/packages/core/docs/ai_core_sdk.credentials.html @@ -0,0 +1,262 @@ + + + + +Python: module ai_core_sdk.credentials + + + + + +
 
ai_core_sdk.credentials		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/core/ai_core_sdk/credentials.py
+

+

+ + + + + +
 
Modules
       
json
+		os
+		pathlib
+

+ + + + + +
 
Classes
       
+
builtins.object +
+
+
CredentialsValue +
Service +
Source +
VCAPEnvironment +
+
+
+

+ + + + + + + +
 
class CredentialsValue(builtins.object)
   CredentialsValue(
+    name: 'str',
+    vcap_key: 'Optional[Tuple[str, ...]]' = None,
+    transform_fn: 'Optional[Callable]' = None
+) -&gt; None
+ 
+CredentialsValue(name: 'str', vcap_key: 'Optional[Tuple[str, ...]]' = None, transform_fn: 'Optional[Callable]' = None)
 
 Methods defined here:
+
__eq__(self, other)
Return self==value.
+ +
__init__( + self, + name: 'str', + vcap_key: 'Optional[Tuple[str, ...]]' = None, + transform_fn: 'Optional[Callable]' = None +) -> None
Initialize self.  See help(type(self)) for accurate signature.
+ +
__replace__ = _replace(self, /, **changes) from dataclasses
+ +
__repr__(self)
Return repr(self).
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables
+
+
__weakref__
+
list of weak references to the object
+
+
+Data and other attributes defined here:
+
__annotations__ = {'name': 'str', 'transform_fn': 'Optional[Callable]', 'vcap_key': 'Optional[Tuple[str, ...]]'}
+ +
__dataclass_fields__ = {'name': Field(name='name',type='str',default=<dataclasse...appingproxy({}),kw_only=False,_field_type=_FIELD), 'transform_fn': Field(name='transform_fn',type='Optional[Callabl...appingproxy({}),kw_only=False,_field_type=_FIELD), 'vcap_key': Field(name='vcap_key',type='Optional[Tuple[str, ...appingproxy({}),kw_only=False,_field_type=_FIELD)}
+ +
__dataclass_params__ = _DataclassParams(init=True,repr=True,eq=True,ord...rue,kw_only=False,slots=False,weakref_slot=False)
+ +
__hash__ = None
+ +
__match_args__ = ('name', 'vcap_key', 'transform_fn')
+ +
transform_fn = None
+ +
vcap_key = None
+ +

+ + + + + + + +
 
class Service(builtins.object)
   Service(env: 'Dict[str, Any]')
+ 
+
 
 Methods defined here:
+
__getitem__(self, key)
+ +
__init__(self, env: 'Dict[str, Any]')
Initialize self.  See help(type(self)) for accurate signature.
+ +
get(self, key, default=NoDefault)
+ +
+Readonly properties defined here:
+
label
+
+
name
+
+
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables
+
+
__weakref__
+
list of weak references to the object
+
+

+ + + + + + + +
 
class Source(builtins.object)
   Source(name: 'str', get: 'Callable[[CredentialsValue], Optional[str]]') -&gt; None
+ 
+Source(name: 'str', get: 'Callable[[CredentialsValue], Optional[str]]')
 
 Methods defined here:
+
__eq__(self, other)
Return self==value.
+ +
__init__(self, name: 'str', get: 'Callable[[CredentialsValue], Optional[str]]') -> None
Initialize self.  See help(type(self)) for accurate signature.
+ +
__replace__ = _replace(self, /, **changes) from dataclasses
+ +
__repr__(self)
Return repr(self).
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables
+
+
__weakref__
+
list of weak references to the object
+
+
+Data and other attributes defined here:
+
__annotations__ = {'get': 'Callable[[CredentialsValue], Optional[str]]', 'name': 'str'}
+ +
__dataclass_fields__ = {'get': Field(name='get',type='Callable[[CredentialsValu...appingproxy({}),kw_only=False,_field_type=_FIELD), 'name': Field(name='name',type='str',default=<dataclasse...appingproxy({}),kw_only=False,_field_type=_FIELD)}
+ +
__dataclass_params__ = _DataclassParams(init=True,repr=True,eq=True,ord...rue,kw_only=False,slots=False,weakref_slot=False)
+ +
__hash__ = None
+ +
__match_args__ = ('name', 'get')
+ +

+ + + + + + + +
 
class VCAPEnvironment(builtins.object)
   VCAPEnvironment(services: 'List[Service]') -&gt; None
+ 
+VCAPEnvironment(services: 'List[Service]')
 
 Methods defined here:
+
__eq__(self, other)
Return self==value.
+ +
__getitem__(self, name) -> 'Service'
+ +
__init__(self, services: 'List[Service]') -> None
Initialize self.  See help(type(self)) for accurate signature.
+ +
__replace__ = _replace(self, /, **changes) from dataclasses
+ +
__repr__(self)
Return repr(self).
+ +
get_service(self, label, exactly_one: 'bool' = True) -> 'Service'
+ +
get_service_by_name(self, name, exactly_one: 'bool' = True) -> 'Service'
+ +
+Class methods defined here:
+
from_dict(env: 'Dict[str, Any]')
+ +
from_env(env_var: 'Optional[str]' = None)
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables
+
+
__weakref__
+
list of weak references to the object
+
+
+Data and other attributes defined here:
+
__annotations__ = {'services': 'List[Service]'}
+ +
__dataclass_fields__ = {'services': Field(name='services',type='List[Service]',defau...appingproxy({}),kw_only=False,_field_type=_FIELD)}
+ +
__dataclass_params__ = _DataclassParams(init=True,repr=True,eq=True,ord...rue,kw_only=False,slots=False,weakref_slot=False)
+ +
__hash__ = None
+ +
__match_args__ = ('services',)
+ +

+ + + + + +
 
Functions
       
fetch_credentials( + profile: 'str' = None, + credential_values: 'List[CredentialsValue]' = [CredentialsValue(name='client_id', vcap_key=('credentials', 'clientid'), transform_fn=None), CredentialsValue(name='client_secret', vcap_key=('credentials', 'clientsecret'), transform_fn=None), CredentialsValue(name='auth_url', vcap_key=('credentials', 'url'), transform_fn=<lambda>), CredentialsValue(name='base_url', vcap_key=('credentials', 'serviceurls', 'AI_API_URL'), transform_fn=<lambda>), CredentialsValue(name='resource_group', vcap_key=None, transform_fn=None), CredentialsValue(name='cert_url', vcap_key=('credentials', 'certurl'), transform_fn=<lambda>), CredentialsValue(name='cert_file_path', vcap_key=None, transform_fn=None), CredentialsValue(name='key_file_path', vcap_key=None, transform_fn=None), CredentialsValue(name='cert_str', vcap_key=('credentials', 'certificate'), transform_fn=<lambda>), CredentialsValue(name='key_str', vcap_key=('credentials', 'key'), transform_fn=<lambda>)], + validate: 'bool' = True, + **kwargs +) -> 'Dict[str, str]'
Fetch credentials from a single source based on precedence.
+ 
+Precedence order: kwargs > environment variables > config file > VCAP service
+ 
+Once a source is selected (first one with any credential), all credentials
+come from that source only. Resource group is an exception and follows
+precedence independently.
+ 
+If credential_values is provided and it's not extended from the CORE_CREDENTIAL_VALUES, set validate to False
+
get_nested_value(data_dict, keys: 'List[str]')
Retrieve a nested value from a dictionary using a list of strings.
+ 
+:param data_dict: The dictionary to search.
+:param keys: A list of strings representing nested keys.
+:return: The value associated with the nested keys, or None if not found.
+
init_conf(profile: 'str' = None)
+
resolve_resource_group(sources: 'List[Source]') -> 'Optional[str]'
Find resource_group from the first source that defines it.
+
validate_credentials(credentials: 'Dict[str, str]') -> 'None'
Validate that we have a complete authentication method.
+

+ + + + + +
 
Data
       AI_CORE_PREFIX = 'AICORE'
+AUTH_ENDPOINT_SUFFIX = '/oauth/token'
+CONFIG_FILE_ENV_VAR = 'AICORE_CONFIG'
+CORE_CREDENTIAL_VALUES = [CredentialsValue(name='client_id', vcap_key=('credentials', 'clientid'), transform_fn=None), CredentialsValue(name='client_secret', vcap_key=('credentials', 'clientsecret'), transform_fn=None), CredentialsValue(name='auth_url', vcap_key=('credentials', 'url'), transform_fn=<lambda>), CredentialsValue(name='base_url', vcap_key=('cre...rviceurls', 'AI_API_URL'), transform_fn=<lambda>), CredentialsValue(name='resource_group', vcap_key=None, transform_fn=None), CredentialsValue(name='cert_url', vcap_key=('credentials', 'certurl'), transform_fn=<lambda>), CredentialsValue(name='cert_file_path', vcap_key=None, transform_fn=None), CredentialsValue(name='key_file_path', vcap_key=None, transform_fn=None), CredentialsValue(name='cert_str', vcap_key=('credentials', 'certificate'), transform_fn=<lambda>), CredentialsValue(name='key_str', vcap_key=('credentials', 'key'), transform_fn=<lambda>)]
+Callable = typing.Callable
+Dict = typing.Dict
+Final = typing.Final
+List = typing.List
+NoDefault = NoDefault
+Optional = typing.Optional
+PROFILE_ENV_VAR = 'AICORE_PROFILE'
+Tuple = typing.Tuple
+VCAP_AICORE_SERVICE_NAME = 'aicore'
+VCAP_SERVICES_ENV_VAR = 'VCAP_SERVICES'
+__annotations__ = {'CORE_CREDENTIAL_VALUES': 'Final[List[CredentialsValue]]'}
+logger = <Logger ai_core_sdk (INFO)>
+ \ No newline at end of file diff --git a/packages/core/docs/ai_core_sdk.exception.html b/packages/core/docs/ai_core_sdk.exception.html new file mode 100644 index 0000000..8005afe --- /dev/null +++ b/packages/core/docs/ai_core_sdk.exception.html @@ -0,0 +1,156 @@ + + + + +Python: module ai_core_sdk.exception + + + + + +
 
ai_core_sdk.exception		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/core/ai_core_sdk/exception.py
+

+

+ + + + + +
 
Classes
       
+
builtins.Exception(builtins.BaseException) +
+
+
AICoreSDKException +
+
+
AICoreInvalidInputException +
+
+
+
+
+

+ + + + + + + +
 
class AICoreInvalidInputException(AICoreSDKException)
   Exception thrown in case of invalid input
 
 
Method resolution order:
+
AICoreInvalidInputException
+
AICoreSDKException
+
builtins.Exception
+
builtins.BaseException
+
builtins.object
+
+
+Data descriptors inherited from AICoreSDKException:
+
__weakref__
+
list of weak references to the object
+
+
+Methods inherited from builtins.Exception:
+
__init__(self, /, *args, **kwargs)
Initialize self.  See help(type(self)) for accurate signature.
+ +
+Static methods inherited from builtins.Exception:
+
__new__(*args, **kwargs) class method of builtins.Exception
Create and return a new object.  See help(type) for accurate signature.
+ +
+Methods inherited from builtins.BaseException:
+
__getattribute__(self, name, /)
Return getattr(self, name).
+ +
__reduce__(self, /)
Helper for pickle.
+ +
__repr__(self, /)
Return repr(self).
+ +
__setstate__(self, object, /)
+ +
__str__(self, /)
Return str(self).
+ +
add_note(self, object, /)
Exception.add_note(note) --
+add a note to the exception
+ +
with_traceback(self, object, /)
Exception.with_traceback(tb) --
+set self.__traceback__ to tb and return self.
+ +
+Data descriptors inherited from builtins.BaseException:
+
__cause__
+
exception cause
+
+
__context__
+
exception context
+
+
__dict__
+
+
__suppress_context__
+
+
__traceback__
+
+
args
+
+

+ + + + + + + +
 
class AICoreSDKException(builtins.Exception)
   Base Exception class for AI Core SDK exceptions
 
 
Method resolution order:
+
AICoreSDKException
+
builtins.Exception
+
builtins.BaseException
+
builtins.object
+
+
+Data descriptors defined here:
+
__weakref__
+
list of weak references to the object
+
+
+Methods inherited from builtins.Exception:
+
__init__(self, /, *args, **kwargs)
Initialize self.  See help(type(self)) for accurate signature.
+ +
+Static methods inherited from builtins.Exception:
+
__new__(*args, **kwargs) class method of builtins.Exception
Create and return a new object.  See help(type) for accurate signature.
+ +
+Methods inherited from builtins.BaseException:
+
__getattribute__(self, name, /)
Return getattr(self, name).
+ +
__reduce__(self, /)
Helper for pickle.
+ +
__repr__(self, /)
Return repr(self).
+ +
__setstate__(self, object, /)
+ +
__str__(self, /)
Return str(self).
+ +
add_note(self, object, /)
Exception.add_note(note) --
+add a note to the exception
+ +
with_traceback(self, object, /)
Exception.with_traceback(tb) --
+set self.__traceback__ to tb and return self.
+ +
+Data descriptors inherited from builtins.BaseException:
+
__cause__
+
exception cause
+
+
__context__
+
exception context
+
+
__dict__
+
+
__suppress_context__
+
+
__traceback__
+
+
args
+
+

+ \ No newline at end of file diff --git a/packages/core/docs/ai_core_sdk.helpers.constants.html b/packages/core/docs/ai_core_sdk.helpers.constants.html new file mode 100644 index 0000000..ed3acc2 --- /dev/null +++ b/packages/core/docs/ai_core_sdk.helpers.constants.html @@ -0,0 +1,101 @@ + + + + +Python: module ai_core_sdk.helpers.constants + + + + + +
 
ai_core_sdk.helpers.constants		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/core/ai_core_sdk/helpers/constants.py
+

+

+ + + + + +
 
Modules
       
os
+

+ + + + + +
 
Classes
       
+
enum.Enum(builtins.object) +
+
+
Timeouts +
+
+
+

+ + + + + + + +
 
class Timeouts(enum.Enum)
   Timeouts(*values)
+ 
+
 
 
Method resolution order:
+
Timeouts
+
enum.Enum
+
builtins.object
+
+
+Data and other attributes defined here:
+
NUM_REQUEST_RETRIES = <Timeouts.NUM_REQUEST_RETRIES: 3>
+ +
READ_TIMEOUT = <Timeouts.READ_TIMEOUT: 60>
+ +
+Data descriptors inherited from enum.Enum:
+
name
+
The name of the Enum member.
+
+
value
+
The value of the Enum member.
+
+
+Static methods inherited from enum.EnumType:
+
__contains__(value)
Return True if `value` is in `cls`.
+ 
+`value` is in `cls` if:
+1) `value` is a member of `cls`, or
+2) `value` is the value of one of the `cls`'s members.
+3) `value` is a pseudo-member (flags)
+ +
__getitem__(name)
Return the member matching `name`.
+ +
__iter__()
Return members in definition order.
+ +
__len__()
Return the number of members (no aliases)
+ +
+Readonly properties inherited from enum.EnumType:
+
__members__
+
Returns a mapping of member name->value.
+ 
+This mapping lists all enum members, including aliases.  Note that
+this is a read-only view of the internal mapping.
+
+

+ + + + + +
 
Data
       AI_CORE_PREFIX = 'AICORE'
+AUTH_ENDPOINT_SUFFIX = '/oauth/token'
+CONFIG_FILE_ENV_VAR = 'AICORE_CONFIG'
+DEBUG_ENV_VAR_NAME = 'DEBUG'
+DEFAULT_HOME_PATH = '/home/runner/.aicore'
+HOME_PATH_ENV_VAR = 'AICORE_HOME'
+PROFILE_ENV_VAR = 'AICORE_PROFILE'
+VCAP_AICORE_SERVICE_NAME = 'aicore'
+VCAP_SERVICES_ENV_VAR = 'VCAP_SERVICES'
+ \ No newline at end of file diff --git a/packages/core/docs/ai_core_sdk.helpers.html b/packages/core/docs/ai_core_sdk.helpers.html new file mode 100644 index 0000000..861db41 --- /dev/null +++ b/packages/core/docs/ai_core_sdk.helpers.html @@ -0,0 +1,49 @@ + + + + +Python: package ai_core_sdk.helpers + + + + + +
 
ai_core_sdk.helpers		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/core/ai_core_sdk/helpers/__init__.py
+

+

+ + + + + +
 
Package Contents
       
constants
+		logging
+

+ + + + + +
 
Functions
       
form_top_skip_params(top: int = None, skip: int = None) -> Dict[str, int]
Frame query param
+ 
+:param top: Number of objects to be retrieved, defaults to None
+:type top: int, optional
+:param skip: Number of objects to be skipped, from the list of the queried objects,
+    defaults to None
+:type skip: int, optional
+
get_home() -> str
+
is_within_aicore() -> bool
[summary]
+Function to check whether the sdk is used within or out of aicore cluster
+Returns:
+    bool: True if the ai-core-sdk is used within aicore cluster
+          False if the ai-core-sdk is used outside aicore cluster
+

+ + + + + +
 
Data
       DEFAULT_HOME_PATH = '/home/runner/.aicore'
+Dict = typing.Dict
+HOME_PATH_ENV_VAR = 'AICORE_HOME'
+ \ No newline at end of file diff --git a/packages/core/docs/ai_core_sdk.helpers.logging.html b/packages/core/docs/ai_core_sdk.helpers.logging.html new file mode 100644 index 0000000..aad6177 --- /dev/null +++ b/packages/core/docs/ai_core_sdk.helpers.logging.html @@ -0,0 +1,38 @@ + + + + +Python: module ai_core_sdk.helpers.logging + + + + + +
 
ai_core_sdk.helpers.logging		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/core/ai_core_sdk/helpers/logging.py
+

+

+ + + + + +
 
Modules
       
logging
+		os
+

+ + + + + +
 
Functions
       
get_logger(name: str = None)
+
set_log_level(logger: logging.Logger, default_level=20)
+

+ + + + + +
 
Data
       BASE_LOGGER_NAME = 'ai_core_sdk'
+DEBUG_ENV_VAR_NAME = 'DEBUG'
+DEFAULT_LOG_LEVEL = 20
+ \ No newline at end of file diff --git a/packages/core/docs/ai_core_sdk.html b/packages/core/docs/ai_core_sdk.html new file mode 100644 index 0000000..94f1d13 --- /dev/null +++ b/packages/core/docs/ai_core_sdk.html @@ -0,0 +1,28 @@ + + + + +Python: package ai_core_sdk + + + + + +
 
ai_core_sdk		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/core/ai_core_sdk/__init__.py
+

+

+ + + + + +
 
Package Contents
       
ai_core_v2_client
+cli
+		credentials
+exception
+		helpers (package)
+models (package)
+		resource_clients (package)
+tracking (package)
+
+ \ No newline at end of file diff --git a/packages/core/docs/ai_core_sdk.models.application.html b/packages/core/docs/ai_core_sdk.models.application.html new file mode 100644 index 0000000..14dc2be --- /dev/null +++ b/packages/core/docs/ai_core_sdk.models.application.html @@ -0,0 +1,89 @@ + + + + +Python: module ai_core_sdk.models.application + + + + + +
 
ai_core_sdk.models.application		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/core/ai_core_sdk/models/application.py
+

+

+ + + + + +
 
Classes
       
+
builtins.object +
+
+
Application +
+
+
+

+ + + + + + + +
 
class Application(builtins.object)
   Application(
+    path: str,
+    revision: str,
+    repository_url: str,
+    application_name: str,
+    **kwargs
+)
+ 
+The Application object defines the application.
+ 
+:param path: path within the repository
+:type path: str
+:param revision: revision
+:type revision: str
+:param repository_url: URL of the repository
+:type repository_url: str
+:param application_name: name of the application
+:type application_name: str
 
 Methods defined here:
+
__init__( + self, + path: str, + revision: str, + repository_url: str, + application_name: str, + **kwargs +)
Initialize self.  See help(type(self)) for accurate signature.
+ +
__str__(self)
Return str(self).
+ +
+Static methods defined here:
+
from_dict(application_dict: Dict[str, str])
Returns a :class:`ai_core_sdk.models.application.Application` object, created from the values in
+the dict provided as parameter
+ 
+:param application_dict: Dict which includes the necessary values to create the object
+:type application_dict: Dict[str, Any]
+:return: An object, created from the values provided
+:rtype: class:`ai_core_sdk.models.application.Application`
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables
+
+
__weakref__
+
list of weak references to the object
+
+

+ + + + + +
 
Data
       Dict = typing.Dict
+ \ No newline at end of file diff --git a/packages/core/docs/ai_core_sdk.models.application_query_response.html b/packages/core/docs/ai_core_sdk.models.application_query_response.html new file mode 100644 index 0000000..d51cc5e --- /dev/null +++ b/packages/core/docs/ai_core_sdk.models.application_query_response.html @@ -0,0 +1,91 @@ + + + + +Python: module ai_core_sdk.models.application_query_response + + + + + +
 
ai_core_sdk.models.application_query_response		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/core/ai_core_sdk/models/application_query_response.py
+

+

+ + + + + +
 
Classes
       
+
ai_api_client_sdk.models.base_models.QueryResponse(builtins.object) +
+
+
ApplicationQueryResponse +
+
+
+

+ + + + + + + +
 
class ApplicationQueryResponse(ai_api_client_sdk.models.base_models.QueryResponse)
   ApplicationQueryResponse(
+    resources: List[ai_core_sdk.models.application.Application],
+    count: int,
+    **kwargs
+)
+ 
+The ApplicationQueryResponse object defines the response of the applications query request
+:param resources: List of the applications returned from the server
+:type resources: List[class:`ai_core_sdk.models.application.Application`]
+:param count: Total number of the queried applications
+:type count: int
+:param `**kwargs`: The keyword arguments are there in case there are additional attributes returned from server
 
 
Method resolution order:
+
ApplicationQueryResponse
+
ai_api_client_sdk.models.base_models.QueryResponse
+
builtins.object
+
+
+Methods defined here:
+
__init__( + self, + resources: List[ai_core_sdk.models.application.Application], + count: int, + **kwargs +)
Initialize self.  See help(type(self)) for accurate signature.
+ +
+Static methods defined here:
+
from_dict(response_dict: Dict[str, Any])
Returns a
+:class:`ai_core_sdk.models.application_query_response.ApplicationQueryResponse`
+object, created from the values in the dict provided as parameter
+ 
+:param response_dict: Dict which includes the necessary values to create the object
+:type response_dict: Dict[str, Any]
+:return: An object, created from the values provided
+:rtype: class:`ai_core_sdk.models.application_query_response.ApplicationQueryResponse`
+ +
+Methods inherited from ai_api_client_sdk.models.base_models.QueryResponse:
+
__str__(self)
Return str(self).
+ +
+Data descriptors inherited from ai_api_client_sdk.models.base_models.QueryResponse:
+
__dict__
+
dictionary for instance variables
+
+
__weakref__
+
list of weak references to the object
+
+

+ + + + + +
 
Data
       Dict = typing.Dict
+List = typing.List
+ \ No newline at end of file diff --git a/packages/core/docs/ai_core_sdk.models.application_resource_sync_status.html b/packages/core/docs/ai_core_sdk.models.application_resource_sync_status.html new file mode 100644 index 0000000..df97119 --- /dev/null +++ b/packages/core/docs/ai_core_sdk.models.application_resource_sync_status.html @@ -0,0 +1,87 @@ + + + + +Python: module ai_core_sdk.models.application_resource_sync_status + + + + + +
 
ai_core_sdk.models.application_resource_sync_status		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/core/ai_core_sdk/models/application_resource_sync_status.py
+

+

+ + + + + +
 
Classes
       
+
builtins.object +
+
+
ApplicationResourceSyncStatus +
+
+
+

+ + + + + + + +
 
class ApplicationResourceSyncStatus(builtins.object)
   ApplicationResourceSyncStatus(
+    name: str = None,
+    kind: str = None,
+    status: str = None,
+    message: str = None,
+    **kwargs
+)
+ 
+The ApplicationSyncResourcesStatus object defines the status of sync of application resource.
+ 
+:param name: Name of the application resource, defaults to None
+:type name: str, optional
+:param kind: kind of the application resource
+:type kind: str, optional
+:param status: status of the sync of the application resource
+:type status: str, optional
+:param message: application resource message
+:type message: str, optional
 
 Methods defined here:
+
__init__( + self, + name: str = None, + kind: str = None, + status: str = None, + message: str = None, + **kwargs +)
Initialize self.  See help(type(self)) for accurate signature.
+ +
+Static methods defined here:
+
from_dict(app_res_sync_status_dict: Dict[str, str])
Returns a :class:`ai_core_sdk.models.application_resource_sync_status.ApplicationResourceSyncStatus`
+object, created from the values in the dict provided as parameter
+ 
+:param app_res_sync_status_dict: Dict which includes the necessary values to create the object
+:type app_res_sync_status_dict: Dict[str, str]
+:return: An object, created from the values provided
+:rtype: class:`ai_core_sdk.models.application_resource_sync_status.ApplicationResourceSyncStatus`
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables
+
+
__weakref__
+
list of weak references to the object
+
+

+ + + + + +
 
Data
       Dict = typing.Dict
+ \ No newline at end of file diff --git a/packages/core/docs/ai_core_sdk.models.application_source.html b/packages/core/docs/ai_core_sdk.models.application_source.html new file mode 100644 index 0000000..43be580 --- /dev/null +++ b/packages/core/docs/ai_core_sdk.models.application_source.html @@ -0,0 +1,85 @@ + + + + +Python: module ai_core_sdk.models.application_source + + + + + +
 
ai_core_sdk.models.application_source		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/core/ai_core_sdk/models/application_source.py
+

+

+ + + + + +
 
Classes
       
+
builtins.object +
+
+
ApplicationSource +
+
+
+

+ + + + + + + +
 
class ApplicationSource(builtins.object)
   ApplicationSource(
+    repo_url: str = None,
+    path: str = None,
+    revision: str = None,
+    **kwargs
+)
+ 
+The ApplicationSource object defines the application source.
+ 
+:param repo_url: URL of the repository, defaults to None
+:type repo_url: str, optional
+:param path: path within the repository, defaults to None
+:type path: str, optional
+:param revision: revision number of the application, defaults to None
+:type revision: str, optional
 
 Methods defined here:
+
__init__( + self, + repo_url: str = None, + path: str = None, + revision: str = None, + **kwargs +)
Initialize self.  See help(type(self)) for accurate signature.
+ +
__str__(self)
Return str(self).
+ +
+Static methods defined here:
+
from_dict(application_source_dict: Dict[str, str])
Returns a :class:`ai_core_sdk.models.application_source.ApplicationSource` object, created from the values in
+the dict provided as parameter
+ 
+:param application_source_dict: Dict which includes the necessary values to create the object
+:type application_source_dict: Dict[str, Any]
+:return: An object, created from the values provided
+:rtype: class:`ai_core_sdk.models.application_source.ApplicationSource`
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables
+
+
__weakref__
+
list of weak references to the object
+
+

+ + + + + +
 
Data
       Dict = typing.Dict
+ \ No newline at end of file diff --git a/packages/core/docs/ai_core_sdk.models.application_status.html b/packages/core/docs/ai_core_sdk.models.application_status.html new file mode 100644 index 0000000..c5ab56a --- /dev/null +++ b/packages/core/docs/ai_core_sdk.models.application_status.html @@ -0,0 +1,107 @@ + + + + +Python: module ai_core_sdk.models.application_status + + + + + +
 
ai_core_sdk.models.application_status		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/core/ai_core_sdk/models/application_status.py
+

+

+ + + + + +
 
Classes
       
+
builtins.object +
+
+
ApplicationStatus +
+
+
+

+ + + + + + + +
 
class ApplicationStatus(builtins.object)
   ApplicationStatus(
+    health_status: str = None,
+    sync_status: str = None,
+    message: str = None,
+    source: ai_core_sdk.models.application_source.ApplicationSource = None,
+    sync_finished_at: str = None,
+    sync_started_at: str = None,
+    reconciled_at: str = None,
+    sync_resources_status: List[ai_core_sdk.models.application_resource_sync_status.ApplicationResourceSyncStatus] = None,
+    **kwargs
+)
+ 
+The Application object defines the application.
+ 
+:param health_status: Application health status, defaults to None
+:type health_status: str, optional
+:param sync_status: Application sync status, defaults to None
+:type sync_status: str, optional
+:param message: Application health status message, defaults to None
+:type message: str, optional
+:param source: Application source, defaults to None
+:type source: class:`ai_core_sdk.models.application_status.ApplicationStatus`, optional
+:param sync_finished_at: Application sync finish time, defaults to None
+:type sync_finished_at: str, optional
+:param sync_started_at: Application sync start time, defaults to None
+:type sync_started_at: str, optional
+:param reconciled_at: Application reconciliation time, defaults to None
+:type reconciled_at: str, optional
+:param sync_resources_status: Status of the synchronization of the application resources, defaults to None
+:type sync_resources_status:
+    List[class:`ai_core_sdk.models.application_resource_sync_status.ApplicationResourceSyncStatus`], optional
 
 Methods defined here:
+
__init__( + self, + health_status: str = None, + sync_status: str = None, + message: str = None, + source: ai_core_sdk.models.application_source.ApplicationSource = None, + sync_finished_at: str = None, + sync_started_at: str = None, + reconciled_at: str = None, + sync_resources_status: List[ai_core_sdk.models.application_resource_sync_status.ApplicationResourceSyncStatus] = None, + **kwargs +)
Initialize self.  See help(type(self)) for accurate signature.
+ +
__str__(self)
Return str(self).
+ +
+Static methods defined here:
+
from_dict(application_status_dict: Dict[str, Any])
Returns a :class:`ai_core_sdk.models.application_status.ApplicationStatus` object, created from the values in
+the dict provided as parameter
+ 
+:param application_status_dict: Dict which includes the necessary values to create the object
+:type application_status_dict: Dict[str, Any]
+:return: An object, created from the values provided
+:rtype: class:`ai_core_sdk.models.application_status.ApplicationStatus`
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables
+
+
__weakref__
+
list of weak references to the object
+
+

+ + + + + +
 
Data
       Dict = typing.Dict
+List = typing.List
+ \ No newline at end of file diff --git a/packages/core/docs/ai_core_sdk.models.base_models.html b/packages/core/docs/ai_core_sdk.models.base_models.html new file mode 100644 index 0000000..7c108f3 --- /dev/null +++ b/packages/core/docs/ai_core_sdk.models.base_models.html @@ -0,0 +1,116 @@ + + + + +Python: module ai_core_sdk.models.base_models + + + + + +
 
ai_core_sdk.models.base_models		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/core/ai_core_sdk/models/base_models.py
+

+

+ + + + + +
 
Classes
       
+
builtins.object +
+
+
BasicNameResponse +
Message +
+
+
+

+ + + + + + + +
 
class BasicNameResponse(builtins.object)
   BasicNameResponse(name: str, message: str, **kwargs)
+ 
+The BasicNameResponse object defines the response with name from the server
+ 
+:param name: Name of the relevant resource
+:type id: str
+: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
 
 Methods defined here:
+
__init__(self, name: str, message: str, **kwargs)
Initialize self.  See help(type(self)) for accurate signature.
+ +
__str__(self)
Return str(self).
+ +
+Static methods defined here:
+
from_dict(bnr_dict: Dict[str, str])
Returns a :class:`ai_core_sdk.models.base_models.BasicNameResponse` object, created from the values in the
+dict provided as parameter
+ 
+:param bnr_dict: Dict which includes the necessary values to create the object
+:type bnr_dict: Dict[str, str]
+:return: An object, created from the values provided
+:rtype: class:`ai_core_sdk.models.base_models.BasicNameResponse`
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables
+
+
__weakref__
+
list of weak references to the object
+
+

+ + + + + + + +
 
class Message(builtins.object)
   Message(message: str, **kwargs)
+ 
+Message object defines a message
+ 
+:param message: message
+:type message: str
 
 Methods defined here:
+
__eq__(self, other)
Return self==value.
+ +
__init__(self, message: str, **kwargs)
Initialize self.  See help(type(self)) for accurate signature.
+ +
__str__(self)
Return str(self).
+ +
+Static methods defined here:
+
from_dict(message_dict: Dict[str, str])
Returns a :class:`ai_core_sdk.models.base_models.Message` object, created from the values in the
+dict provided as parameter
+ 
+:param message_dict: Dict which includes the necessary values to create the object
+:type message_dict: Dict[str, str]
+:return: An object, created from the values provided
+:rtype: class:`ai_core_sdk.models.base_models.Message`
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables
+
+
__weakref__
+
list of weak references to the object
+
+
+Data and other attributes defined here:
+
__hash__ = None
+ +

+ + + + + +
 
Data
       Dict = typing.Dict
+ \ No newline at end of file diff --git a/packages/core/docs/ai_core_sdk.models.docker_registry_secret.html b/packages/core/docs/ai_core_sdk.models.docker_registry_secret.html new file mode 100644 index 0000000..3d48ab5 --- /dev/null +++ b/packages/core/docs/ai_core_sdk.models.docker_registry_secret.html @@ -0,0 +1,82 @@ + + + + +Python: module ai_core_sdk.models.docker_registry_secret + + + + + +
 
ai_core_sdk.models.docker_registry_secret		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/core/ai_core_sdk/models/docker_registry_secret.py
+

+

+ + + + + +
 
Classes
       
+
ai_api_client_sdk.models.base_models.Name(builtins.object) +
+
+
DockerRegistrySecret +
+
+
+

+ + + + + + + +
 
class DockerRegistrySecret(ai_api_client_sdk.models.base_models.Name)
   DockerRegistrySecret(name: str, **kwargs)
+ 
+The DockerRegistrySecret object defines the docker registry secret. Refer to
+:class:`ai_api_client_sdk.models.base_models.Name`, for the object definition
 
 
Method resolution order:
+
DockerRegistrySecret
+
ai_api_client_sdk.models.base_models.Name
+
builtins.object
+
+
+Methods defined here:
+
__str__(self)
Return str(self).
+ +
+Static methods defined here:
+
from_dict(docker_registry_secret_dict: Dict[str, str])
Returns a :class:`ai_core_sdk.models.docker_registry_secret.DockerRegistrySecret` object, created
+from the values in the dict provided as parameter
+ 
+:param docker_registry_secret_dict: Dict which includes the necessary values to create the object
+:type docker_registry_secret_dict: Dict[str, str]
+:return: An object, created from the values provided
+:rtype: class:`ai_core_sdk.models.docker_registry_secret.DockerRegistrySecret`
+ +
+Methods inherited from ai_api_client_sdk.models.base_models.Name:
+
__eq__(self, other)
Return self==value.
+ +
__init__(self, name: str, **kwargs)
Initialize self.  See help(type(self)) for accurate signature.
+ +
+Data descriptors inherited from ai_api_client_sdk.models.base_models.Name:
+
__dict__
+
dictionary for instance variables
+
+
__weakref__
+
list of weak references to the object
+
+
+Data and other attributes inherited from ai_api_client_sdk.models.base_models.Name:
+
__hash__ = None
+ +

+ + + + + +
 
Data
       Dict = typing.Dict
+ \ No newline at end of file diff --git a/packages/core/docs/ai_core_sdk.models.docker_registry_secret_query_response.html b/packages/core/docs/ai_core_sdk.models.docker_registry_secret_query_response.html new file mode 100644 index 0000000..59b001f --- /dev/null +++ b/packages/core/docs/ai_core_sdk.models.docker_registry_secret_query_response.html @@ -0,0 +1,91 @@ + + + + +Python: module ai_core_sdk.models.docker_registry_secret_query_response + + + + + +
 
ai_core_sdk.models.docker_registry_secret_query_response		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/core/ai_core_sdk/models/docker_registry_secret_query_response.py
+

+

+ + + + + +
 
Classes
       
+
ai_api_client_sdk.models.base_models.QueryResponse(builtins.object) +
+
+
DockerRegistrySecretQueryResponse +
+
+
+

+ + + + + + + +
 
class DockerRegistrySecretQueryResponse(ai_api_client_sdk.models.base_models.QueryResponse)
   DockerRegistrySecretQueryResponse(
+    resources: List[ai_core_sdk.models.docker_registry_secret.DockerRegistrySecret],
+    count: int,
+    **kwargs
+)
+ 
+The DockerRegistrySecretQueryResponse object defines the response of the dockerRegistrySecrets query request
+:param resources: List of the docker registry secrets returned from the server
+:type resources: List[class:`ai_core_sdk.models.docker_registry_secret.DockerRegistrySecret`]
+: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
 
 
Method resolution order:
+
DockerRegistrySecretQueryResponse
+
ai_api_client_sdk.models.base_models.QueryResponse
+
builtins.object
+
+
+Methods defined here:
+
__init__( + self, + resources: List[ai_core_sdk.models.docker_registry_secret.DockerRegistrySecret], + count: int, + **kwargs +)
Initialize self.  See help(type(self)) for accurate signature.
+ +
+Static methods defined here:
+
from_dict(response_dict: Dict[str, Any])
Returns a
+:class:`ai_core_sdk.models.docker_registry_secret_query_response.DockerRegistrySecretQueryResponse`
+object, created from the values in the dict provided as parameter
+ 
+:param response_dict: Dict which includes the necessary values to create the object
+:type response_dict: Dict[str, Any]
+:return: An object, created from the values provided
+:rtype: class:`ai_core_sdk.models.docker_registry_secret_query_response.DockerRegistrySecretQueryResponse`
+ +
+Methods inherited from ai_api_client_sdk.models.base_models.QueryResponse:
+
__str__(self)
Return str(self).
+ +
+Data descriptors inherited from ai_api_client_sdk.models.base_models.QueryResponse:
+
__dict__
+
dictionary for instance variables
+
+
__weakref__
+
list of weak references to the object
+
+

+ + + + + +
 
Data
       Dict = typing.Dict
+List = typing.List
+ \ No newline at end of file diff --git a/packages/core/docs/ai_core_sdk.models.html b/packages/core/docs/ai_core_sdk.models.html new file mode 100644 index 0000000..5d3dc2d --- /dev/null +++ b/packages/core/docs/ai_core_sdk.models.html @@ -0,0 +1,39 @@ + + + + +Python: package ai_core_sdk.models + + + + + +
 
ai_core_sdk.models		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/core/ai_core_sdk/models/__init__.py
+

+

+ + + + + +
 
Package Contents
       
application
+application_query_response
+application_resource_sync_status
+application_source
+application_status
+		base_models
+docker_registry_secret
+docker_registry_secret_query_response
+kpi
+object_store_secret
+		object_store_secret_query_response
+repository
+repository_query_response
+repository_status
+resource_group
+		resource_group_query_response
+resource_group_status
+secret
+secret_query_response
+
+ \ No newline at end of file diff --git a/packages/core/docs/ai_core_sdk.models.kpi.html b/packages/core/docs/ai_core_sdk.models.kpi.html new file mode 100644 index 0000000..3391963 --- /dev/null +++ b/packages/core/docs/ai_core_sdk.models.kpi.html @@ -0,0 +1,69 @@ + + + + +Python: module ai_core_sdk.models.kpi + + + + + +
 
ai_core_sdk.models.kpi		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/core/ai_core_sdk/models/kpi.py
+

+

+ + + + + +
 
Classes
       
+
builtins.object +
+
+
Kpi +
+
+
+

+ + + + + + + +
 
class Kpi(builtins.object)
   Kpi(header: List[str], rows: List[Union[str, int]], **kwargs)
+ 
+The Kpi object defines the Kpi data.
 
 Methods defined here:
+
__init__(self, header: List[str], rows: List[Union[str, int]], **kwargs)
Initialize self.  See help(type(self)) for accurate signature.
+ +
__str__(self)
Return str(self).
+ +
+Static methods defined here:
+
from_dict(kpi_dict: Dict[str, Any])
Returns a :class:`ai_core_sdk.models.kpi.Kpi` object, created
+from the values in the dict provided as parameter
+ 
+:param kpi_dict: Dict which includes the necessary values to create the object
+:type kpi_dict: Dict[str, Any]
+:return: An object, created from the values provided
+:rtype: class:`ai_core_sdk.models.kpi.Kpi`
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables
+
+
__weakref__
+
list of weak references to the object
+
+

+ + + + + +
 
Data
       Dict = typing.Dict
+List = typing.List
+Union = typing.Union
+ \ No newline at end of file diff --git a/packages/core/docs/ai_core_sdk.models.object_store_secret.html b/packages/core/docs/ai_core_sdk.models.object_store_secret.html new file mode 100644 index 0000000..28d2cb4 --- /dev/null +++ b/packages/core/docs/ai_core_sdk.models.object_store_secret.html @@ -0,0 +1,67 @@ + + + + +Python: module ai_core_sdk.models.object_store_secret + + + + + +
 
ai_core_sdk.models.object_store_secret		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/core/ai_core_sdk/models/object_store_secret.py
+

+

+ + + + + +
 
Classes
       
+
builtins.object +
+
+
ObjectStoreSecret +
+
+
+

+ + + + + + + +
 
class ObjectStoreSecret(builtins.object)
   ObjectStoreSecret(name: str, metadata: Dict[str, str], **kwargs)
+ 
+The ObjectStoreSecret object defines the object store secret response.
 
 Methods defined here:
+
__init__(self, name: str, metadata: Dict[str, str], **kwargs)
Initialize self.  See help(type(self)) for accurate signature.
+ +
__str__(self)
Return str(self).
+ +
+Static methods defined here:
+
from_dict(object_store_secret_dict: Dict[str, Any])
Returns a :class:`ai_core_sdk.models.object_store_secret.ObjectStoreSecret` object, created
+from the values in the dict provided as parameter
+ 
+:param object_store_secret_dict: Dict which includes the necessary values to create the object
+:type object_store_secret_dict: Dict[str, Any]
+:return: An object, created from the values provided
+:rtype: class:`ai_core_sdk.models.object_store_secret.ObjectStoreSecret`
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables
+
+
__weakref__
+
list of weak references to the object
+
+

+ + + + + +
 
Data
       Dict = typing.Dict
+ \ No newline at end of file diff --git a/packages/core/docs/ai_core_sdk.models.object_store_secret_query_response.html b/packages/core/docs/ai_core_sdk.models.object_store_secret_query_response.html new file mode 100644 index 0000000..0eda720 --- /dev/null +++ b/packages/core/docs/ai_core_sdk.models.object_store_secret_query_response.html @@ -0,0 +1,91 @@ + + + + +Python: module ai_core_sdk.models.object_store_secret_query_response + + + + + +
 
ai_core_sdk.models.object_store_secret_query_response		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/core/ai_core_sdk/models/object_store_secret_query_response.py
+

+

+ + + + + +
 
Classes
       
+
ai_api_client_sdk.models.base_models.QueryResponse(builtins.object) +
+
+
ObjectStoreSecretQueryResponse +
+
+
+

+ + + + + + + +
 
class ObjectStoreSecretQueryResponse(ai_api_client_sdk.models.base_models.QueryResponse)
   ObjectStoreSecretQueryResponse(
+    resources: List[ai_core_sdk.models.object_store_secret.ObjectStoreSecret],
+    count: int,
+    **kwargs
+)
+ 
+The ObjectStoreSecretQueryResponse object defines the response of the object store secret query request
+:param resources: List of the object store secrets returned from the server
+:type resources: List[class:`ai_core_sdk.models.object_store_secret.ObjectStoreSecret`]
+:param count: Total number of the queried object store secrets
+:type count: int
+:param `**kwargs`: The keyword arguments are there in case there are additional attributes returned from server
 
 
Method resolution order:
+
ObjectStoreSecretQueryResponse
+
ai_api_client_sdk.models.base_models.QueryResponse
+
builtins.object
+
+
+Methods defined here:
+
__init__( + self, + resources: List[ai_core_sdk.models.object_store_secret.ObjectStoreSecret], + count: int, + **kwargs +)
Initialize self.  See help(type(self)) for accurate signature.
+ +
+Static methods defined here:
+
from_dict(response_dict: Dict[str, Any])
Returns a
+:class:`ai_core_sdk.models.object_store_secret_query_response.ObjectStoreSecretQueryResponse`
+object, created from the values in the dict provided as parameter
+ 
+:param response_dict: Dict which includes the necessary values to create the object
+:type response_dict: Dict[str, Any]
+:return: An object, created from the values provided
+:rtype: class:`ai_core_sdk.models.object_store_secret_query_response.ObjectStoreSecretQueryResponse`
+ +
+Methods inherited from ai_api_client_sdk.models.base_models.QueryResponse:
+
__str__(self)
Return str(self).
+ +
+Data descriptors inherited from ai_api_client_sdk.models.base_models.QueryResponse:
+
__dict__
+
dictionary for instance variables
+
+
__weakref__
+
list of weak references to the object
+
+

+ + + + + +
 
Data
       Dict = typing.Dict
+List = typing.List
+ \ No newline at end of file diff --git a/packages/core/docs/ai_core_sdk.models.repository.html b/packages/core/docs/ai_core_sdk.models.repository.html new file mode 100644 index 0000000..826135a --- /dev/null +++ b/packages/core/docs/ai_core_sdk.models.repository.html @@ -0,0 +1,85 @@ + + + + +Python: module ai_core_sdk.models.repository + + + + + +
 
ai_core_sdk.models.repository		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/core/ai_core_sdk/models/repository.py
+

+

+ + + + + +
 
Classes
       
+
builtins.object +
+
+
Repository +
+
+
+

+ + + + + + + +
 
class Repository(builtins.object)
   Repository(
+    name: str,
+    url: str,
+    status: ai_core_sdk.models.repository_status.RepositoryStatus = None,
+    **kwargs
+)
+ 
+The Repository object defines the repository
+ 
+:param name: name of the repository
+:type name: str
+:param url: URL of the repository
+:type url: str
+:param status: status of the repository, defaults to None
+:type status: class:`ai_core_sdk.models.repository_status.RepositoryStatus`, optional
 
 Methods defined here:
+
__init__( + self, + name: str, + url: str, + status: ai_core_sdk.models.repository_status.RepositoryStatus = None, + **kwargs +)
Initialize self.  See help(type(self)) for accurate signature.
+ +
__str__(self)
Return str(self).
+ +
+Static methods defined here:
+
from_dict(repository_dict: Dict[str, str])
Returns a :class:`ai_core_sdk.models.repository.Repository` object, created
+from the values in the dict provided as parameter
+ 
+:param repository_dict: Dict which includes the necessary values to create the object
+:type repository_dict: Dict[str, Any]
+:return: An object, created from the values provided
+:rtype: class:`ai_core_sdk.models.repository.Repository`
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables
+
+
__weakref__
+
list of weak references to the object
+
+

+ + + + + +
 
Data
       Dict = typing.Dict
+ \ No newline at end of file diff --git a/packages/core/docs/ai_core_sdk.models.repository_query_response.html b/packages/core/docs/ai_core_sdk.models.repository_query_response.html new file mode 100644 index 0000000..3c356ed --- /dev/null +++ b/packages/core/docs/ai_core_sdk.models.repository_query_response.html @@ -0,0 +1,91 @@ + + + + +Python: module ai_core_sdk.models.repository_query_response + + + + + +
 
ai_core_sdk.models.repository_query_response		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/core/ai_core_sdk/models/repository_query_response.py
+

+

+ + + + + +
 
Classes
       
+
ai_api_client_sdk.models.base_models.QueryResponse(builtins.object) +
+
+
RepositoryQueryResponse +
+
+
+

+ + + + + + + +
 
class RepositoryQueryResponse(ai_api_client_sdk.models.base_models.QueryResponse)
   RepositoryQueryResponse(
+    resources: List[ai_core_sdk.models.repository.Repository],
+    count: int,
+    **kwargs
+)
+ 
+The RepositoryQueryResponse object defines the response of the repository query request
+:param resources: List of the repositories returned from the server
+:type resources: List[class:`ai_core_sdk.models.repository.Repository`]
+:param count: Total number of the queried repositories
+:type count: int
+:param `**kwargs`: The keyword arguments are there in case there are additional attributes returned from server
 
 
Method resolution order:
+
RepositoryQueryResponse
+
ai_api_client_sdk.models.base_models.QueryResponse
+
builtins.object
+
+
+Methods defined here:
+
__init__( + self, + resources: List[ai_core_sdk.models.repository.Repository], + count: int, + **kwargs +)
Initialize self.  See help(type(self)) for accurate signature.
+ +
+Static methods defined here:
+
from_dict(response_dict: Dict[str, Any])
Returns a
+:class:`ai_core_client_sdk.models.repository_query_response.RepositoryQueryResponse`
+object, created from the values in the dict provided as parameter
+ 
+:param response_dict: Dict which includes the necessary values to create the object
+:type response_dict: Dict[str, Any]
+:return: An object, created from the values provided
+:rtype: class:`ai_core_sdk.models.repository_query_response.RepositoryQueryResponse`
+ +
+Methods inherited from ai_api_client_sdk.models.base_models.QueryResponse:
+
__str__(self)
Return str(self).
+ +
+Data descriptors inherited from ai_api_client_sdk.models.base_models.QueryResponse:
+
__dict__
+
dictionary for instance variables
+
+
__weakref__
+
list of weak references to the object
+
+

+ + + + + +
 
Data
       Dict = typing.Dict
+List = typing.List
+ \ No newline at end of file diff --git a/packages/core/docs/ai_core_sdk.models.repository_status.html b/packages/core/docs/ai_core_sdk.models.repository_status.html new file mode 100644 index 0000000..b3e73cc --- /dev/null +++ b/packages/core/docs/ai_core_sdk.models.repository_status.html @@ -0,0 +1,82 @@ + + + + +Python: module ai_core_sdk.models.repository_status + + + + + +
 
ai_core_sdk.models.repository_status		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/core/ai_core_sdk/models/repository_status.py
+

+

+ + + + + +
 
Classes
       
+
enum.Enum(builtins.object) +
+
+
RepositoryStatus +
+
+
+

+ + + + + + + +
 
class RepositoryStatus(enum.Enum)
   RepositoryStatus(*values)
+ 
+RepositoryStatus is an Enum defining the valid values of the status of a repository
 
 
Method resolution order:
+
RepositoryStatus
+
enum.Enum
+
builtins.object
+
+
+Data and other attributes defined here:
+
COMPLETED = <RepositoryStatus.COMPLETED: 'COMPLETED'>
+ +
ERROR = <RepositoryStatus.ERROR: 'ERROR'>
+ +
IN_PROGRESS = <RepositoryStatus.IN_PROGRESS: 'IN-PROGRESS'>
+ +
+Data descriptors inherited from enum.Enum:
+
name
+
The name of the Enum member.
+
+
value
+
The value of the Enum member.
+
+
+Static methods inherited from enum.EnumType:
+
__contains__(value)
Return True if `value` is in `cls`.
+ 
+`value` is in `cls` if:
+1) `value` is a member of `cls`, or
+2) `value` is the value of one of the `cls`'s members.
+3) `value` is a pseudo-member (flags)
+ +
__getitem__(name)
Return the member matching `name`.
+ +
__iter__()
Return members in definition order.
+ +
__len__()
Return the number of members (no aliases)
+ +
+Readonly properties inherited from enum.EnumType:
+
__members__
+
Returns a mapping of member name->value.
+ 
+This mapping lists all enum members, including aliases.  Note that
+this is a read-only view of the internal mapping.
+
+

+ \ No newline at end of file diff --git a/packages/core/docs/ai_core_sdk.models.resource_group.html b/packages/core/docs/ai_core_sdk.models.resource_group.html new file mode 100644 index 0000000..b50ed3c --- /dev/null +++ b/packages/core/docs/ai_core_sdk.models.resource_group.html @@ -0,0 +1,98 @@ + + + + +Python: module ai_core_sdk.models.resource_group + + + + + +
 
ai_core_sdk.models.resource_group		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/core/ai_core_sdk/models/resource_group.py
+

+

+ + + + + +
 
Classes
       
+
builtins.object +
+
+
ResourceGroup +
+
+
+

+ + + + + + + +
 
class ResourceGroup(builtins.object)
   ResourceGroup(
+    resource_group_id: str = None,
+    tenant_id: str = None,
+    zone_id: str = None,
+    labels: List[ai_api_client_sdk.models.label.Label] = None,
+    status: ai_core_sdk.models.resource_group_status.ResourceGroupStatus = None,
+    status_message: str = None,
+    **kwargs
+)
+ 
+ResourceGroup represents the resource group.
+ 
+:param resource_group_id: The resource_group_id of this ResourceGroup.
+:type resource_group_id: str
+:param tenant_id: The tenant_id of this ResourceGroup.
+:type tenant_id: str
+:param zone_id: The zone_id of this ResourceGroup.
+:type zone_id: str
+:param labels: The labels of this ResourceGroup.
+:type labels: ResourceGroupLabels
+:param status: The status of this ResourceGroup.
+:type status: str
+:param status_message: The status_message of this ResourceGroup.
+:type status_message: str
 
 Methods defined here:
+
__init__( + self, + resource_group_id: str = None, + tenant_id: str = None, + zone_id: str = None, + labels: List[ai_api_client_sdk.models.label.Label] = None, + status: ai_core_sdk.models.resource_group_status.ResourceGroupStatus = None, + status_message: str = None, + **kwargs +)
Initialize self.  See help(type(self)) for accurate signature.
+ +
__str__(self)
Return str(self).
+ +
+Static methods defined here:
+
from_dict(resource_group_dict: Dict[str, Any])
Returns a :class:`ai_core_sdk.models.resource_group.ResourceGroup` object, created
+from the values in the dict provided as parameter
+ 
+:param resource_group_dict: Dict which includes the necessary values to create the object
+:type resource_group_dict: Dict[str, Any]
+:return: An object, created from the values provided
+:rtype: class:`ai_core_sdk.models.resource_group.ResourceGroup`
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables
+
+
__weakref__
+
list of weak references to the object
+
+

+ + + + + +
 
Data
       Dict = typing.Dict
+List = typing.List
+ \ No newline at end of file diff --git a/packages/core/docs/ai_core_sdk.models.resource_group_query_response.html b/packages/core/docs/ai_core_sdk.models.resource_group_query_response.html new file mode 100644 index 0000000..d56334f --- /dev/null +++ b/packages/core/docs/ai_core_sdk.models.resource_group_query_response.html @@ -0,0 +1,91 @@ + + + + +Python: module ai_core_sdk.models.resource_group_query_response + + + + + +
 
ai_core_sdk.models.resource_group_query_response		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/core/ai_core_sdk/models/resource_group_query_response.py
+

+

+ + + + + +
 
Classes
       
+
ai_api_client_sdk.models.base_models.QueryResponse(builtins.object) +
+
+
ResourceGroupQueryResponse +
+
+
+

+ + + + + + + +
 
class ResourceGroupQueryResponse(ai_api_client_sdk.models.base_models.QueryResponse)
   ResourceGroupQueryResponse(
+    resources: List[ai_core_sdk.models.resource_group.ResourceGroup],
+    count: int,
+    **kwargs
+)
+ 
+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
 
 
Method resolution order:
+
ResourceGroupQueryResponse
+
ai_api_client_sdk.models.base_models.QueryResponse
+
builtins.object
+
+
+Methods defined here:
+
__init__( + self, + resources: List[ai_core_sdk.models.resource_group.ResourceGroup], + count: int, + **kwargs +)
Initialize self.  See help(type(self)) for accurate signature.
+ +
+Static methods defined here:
+
from_dict(response_dict: Dict[str, Any])
Returns a
+:class:`ai_core_sdk.models.docker_registry_secret_query_response.DockerRegistrySecretQueryResponse`
+object, created from the values in the dict provided as parameter
+ 
+:param response_dict: Dict which includes the necessary values to create the object
+:type response_dict: Dict[str, Any]
+:return: An object, created from the values provided
+:rtype: class:`ai_core_sdk.models.docker_registry_secret_query_response.DockerRegistrySecretQueryResponse`
+ +
+Methods inherited from ai_api_client_sdk.models.base_models.QueryResponse:
+
__str__(self)
Return str(self).
+ +
+Data descriptors inherited from ai_api_client_sdk.models.base_models.QueryResponse:
+
__dict__
+
dictionary for instance variables
+
+
__weakref__
+
list of weak references to the object
+
+

+ + + + + +
 
Data
       Dict = typing.Dict
+List = typing.List
+ \ No newline at end of file diff --git a/packages/core/docs/ai_core_sdk.models.resource_group_status.html b/packages/core/docs/ai_core_sdk.models.resource_group_status.html new file mode 100644 index 0000000..976e79e --- /dev/null +++ b/packages/core/docs/ai_core_sdk.models.resource_group_status.html @@ -0,0 +1,82 @@ + + + + +Python: module ai_core_sdk.models.resource_group_status + + + + + +
 
ai_core_sdk.models.resource_group_status		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/core/ai_core_sdk/models/resource_group_status.py
+

+

+ + + + + +
 
Classes
       
+
enum.Enum(builtins.object) +
+
+
ResourceGroupStatus +
+
+
+

+ + + + + + + +
 
class ResourceGroupStatus(enum.Enum)
   ResourceGroupStatus(*values)
+ 
+ResourceGroupStatus is an Enum defining the valid values of the status of a resource group
 
 
Method resolution order:
+
ResourceGroupStatus
+
enum.Enum
+
builtins.object
+
+
+Data and other attributes defined here:
+
ERROR = <ResourceGroupStatus.ERROR: 'ERROR'>
+ +
PROVISIONED = <ResourceGroupStatus.PROVISIONED: 'PROVISIONED'>
+ +
PROVISIONING = <ResourceGroupStatus.PROVISIONING: 'PROVISIONING'>
+ +
+Data descriptors inherited from enum.Enum:
+
name
+
The name of the Enum member.
+
+
value
+
The value of the Enum member.
+
+
+Static methods inherited from enum.EnumType:
+
__contains__(value)
Return True if `value` is in `cls`.
+ 
+`value` is in `cls` if:
+1) `value` is a member of `cls`, or
+2) `value` is the value of one of the `cls`'s members.
+3) `value` is a pseudo-member (flags)
+ +
__getitem__(name)
Return the member matching `name`.
+ +
__iter__()
Return members in definition order.
+ +
__len__()
Return the number of members (no aliases)
+ +
+Readonly properties inherited from enum.EnumType:
+
__members__
+
Returns a mapping of member name->value.
+ 
+This mapping lists all enum members, including aliases.  Note that
+this is a read-only view of the internal mapping.
+
+

+ \ No newline at end of file diff --git a/packages/core/docs/ai_core_sdk.models.secret.html b/packages/core/docs/ai_core_sdk.models.secret.html new file mode 100644 index 0000000..8b8ba95 --- /dev/null +++ b/packages/core/docs/ai_core_sdk.models.secret.html @@ -0,0 +1,72 @@ + + + + +Python: module ai_core_sdk.models.secret + + + + + +
 
ai_core_sdk.models.secret		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/core/ai_core_sdk/models/secret.py
+

+

+ + + + + +
 
Classes
       
+
builtins.object +
+
+
Secret +
+
+
+

+ + + + + + + +
 
class Secret(builtins.object)
   Secret(name: str, data: Dict[str, str] = None, **kwargs)
+ 
+The Secret object defines the secret response.
+ 
+:param name: Secret name
+:type name: str
+:param data: Secret data dictionary, defaults to None
+:type data: dict, optional
 
 Methods defined here:
+
__init__(self, name: str, data: Dict[str, str] = None, **kwargs)
Initialize self.  See help(type(self)) for accurate signature.
+ +
__str__(self)
Return str(self).
+ +
+Static methods defined here:
+
from_dict(secret_dict: Dict[str, Any])
Returns a :class:`ai_core_sdk.models.secret.Secret` object, created
+from the values in the dict provided as parameter
+ 
+:param secret_dict: Dict which includes the necessary values to create the object
+:type secret_dict: Dict[str, Any]
+:return: An object, created from the values provided
+:rtype: class:`ai_core_sdk.models.secret.Secret`
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables
+
+
__weakref__
+
list of weak references to the object
+
+

+ + + + + +
 
Data
       Dict = typing.Dict
+ \ No newline at end of file diff --git a/packages/core/docs/ai_core_sdk.models.secret_query_response.html b/packages/core/docs/ai_core_sdk.models.secret_query_response.html new file mode 100644 index 0000000..8efe149 --- /dev/null +++ b/packages/core/docs/ai_core_sdk.models.secret_query_response.html @@ -0,0 +1,91 @@ + + + + +Python: module ai_core_sdk.models.secret_query_response + + + + + +
 
ai_core_sdk.models.secret_query_response		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/core/ai_core_sdk/models/secret_query_response.py
+

+

+ + + + + +
 
Classes
       
+
ai_api_client_sdk.models.base_models.QueryResponse(builtins.object) +
+
+
SecretQueryResponse +
+
+
+

+ + + + + + + +
 
class SecretQueryResponse(ai_api_client_sdk.models.base_models.QueryResponse)
   SecretQueryResponse(
+    resources: List[ai_core_sdk.models.secret.Secret],
+    count: int,
+    **kwargs
+)
+ 
+The SecretQueryResponse object defines the response of the secret query request
+:param resources: List of the secrets returned from the server
+:type resources: List[class:`ai_core_sdk.models.secret.Secret`]
+:param count: Total number of the queried secrets
+:type count: int
+:param `**kwargs`: The keyword arguments are there in case there are additional attributes returned from server
 
 
Method resolution order:
+
SecretQueryResponse
+
ai_api_client_sdk.models.base_models.QueryResponse
+
builtins.object
+
+
+Methods defined here:
+
__init__( + self, + resources: List[ai_core_sdk.models.secret.Secret], + count: int, + **kwargs +)
Initialize self.  See help(type(self)) for accurate signature.
+ +
+Static methods defined here:
+
from_dict(response_dict: Dict[str, Any])
Returns a
+:class:`ai_core_sdk.models.secret_query_response.SecretQueryResponse`
+object, created from the values in the dict provided as parameter
+ 
+:param response_dict: Dict which includes the necessary values to create the object
+:type response_dict: Dict[str, Any]
+:return: An object, created from the values provided
+:rtype: class:`ai_core_sdk.models.secret_query_response.SecretQueryResponse`
+ +
+Methods inherited from ai_api_client_sdk.models.base_models.QueryResponse:
+
__str__(self)
Return str(self).
+ +
+Data descriptors inherited from ai_api_client_sdk.models.base_models.QueryResponse:
+
__dict__
+
dictionary for instance variables
+
+
__weakref__
+
list of weak references to the object
+
+

+ + + + + +
 
Data
       Dict = typing.Dict
+List = typing.List
+ \ No newline at end of file diff --git a/packages/core/docs/ai_core_sdk.resource_clients.applications_client.html b/packages/core/docs/ai_core_sdk.resource_clients.applications_client.html new file mode 100644 index 0000000..c5ce356 --- /dev/null +++ b/packages/core/docs/ai_core_sdk.resource_clients.applications_client.html @@ -0,0 +1,199 @@ + + + + +Python: module ai_core_sdk.resource_clients.applications_client + + + + + +
 
ai_core_sdk.resource_clients.applications_client		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/core/ai_core_sdk/resource_clients/applications_client.py
+

+

+ + + + + +
 
Classes
       
+
ai_api_client_sdk.resource_clients.base_client.BaseClient(builtins.object) +
+
+
ApplicationsClient +
+
+
+

+ + + + + + + +
 
class ApplicationsClient(ai_api_client_sdk.resource_clients.base_client.BaseClient)
   ApplicationsClient(
+    rest_client: ai_api_client_sdk.helpers.rest_client.RestClient
+)
+ 
+ApplicationsClient is a class implemented for interacting with the applications related
+endpoints of the server. It implements the base class
+:class:`ai_api_client_sdk.resource_clients.base_client.BaseClient`
 
 
Method resolution order:
+
ApplicationsClient
+
ai_api_client_sdk.resource_clients.base_client.BaseClient
+
builtins.object
+
+
+Methods defined here:
+
create( + self, + revision: str, + path: str, + application_name: str = None, + repository_name: str = None, + repository_url: str = None +) -> ai_api_client_sdk.models.base_models.BasicResponse
Creates an application.
+ 
+:param revision: revision to synchronize
+:type revision: str
+:param path: within the repository to synchronize
+:type path: str
+:param application_name: Name of the application
+:type application_name: str, optional
+:param repository_name: Name of the repository to synchronize. Either this or the repository_url needs to be
+    provided
+:type repository_name: str, optional
+:param repository_url: URL of the repository to synchronize. Either this or the repository_name needs to be
+    provided
+:type repository_url: str, optional
+: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
+:return: An object representing the response from the server
+:rtype: class:`ai_api_client_sdk.models.base_models.BasicResponse`
+ +
delete(self, application_name: str) -> ai_api_client_sdk.models.base_models.BasicResponse
Deletes the application.
+ 
+:param application_name: name of the application to be deleted
+:type application_name: str
+: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
+:return: An object representing the response from the server
+:rtype: class:`ai_api_client_sdk.models.base_models.BasicResponse`
+ +
get(self, application_name: str) -> ai_core_sdk.models.application.Application
Retrieves the application from the server.
+ 
+:param application_name: name of the application to be retrieved
+:type application_name: str
+: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: The retrieved application
+:rtype: class:`ai_core_sdk.models.application.Application`
+ +
get_status(self, application_name: str) -> ai_core_sdk.models.application_status.ApplicationStatus
Retrieves the application status from the server.
+ 
+:param application_name: name of the application
+:type application_name: str
+: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: The retrieved application status
+:rtype: class:`ai_core_sdk.models.application_status.ApplicationStatus`
+ +
modify( + self, + application_name: str, + repository_url: str, + path: str, + revision: str +) -> ai_api_client_sdk.models.base_models.BasicResponse
Modifies the application
+ 
+:param application_name: name of the application to be modified
+:type name: str
+:param repository_url:
+:type repository_url: str
+:param revision:
+:type revision: str
+:param path:
+:type path: str
+: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
+:return: An object representing the response from the server
+:rtype: class:`ai_api_client_sdk.models.base_models.BasicResponse`
+ +
query(self) -> ai_core_sdk.models.application_query_response.ApplicationQueryResponse
Returns the applications.
+ 
+: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
+:return: The retrieved applications
+:rtype: class:`ai_core_sdk.models.application_query_response.ApplicationQueryResponse`
+ +
refresh(self, application_name: str) -> ai_api_client_sdk.models.base_models.BasicResponse
Triggers synchronisation of the application.
+ 
+:param application_name: name of the application to be refreshed
+:type application_name: str
+: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
+:return: An object representing the response from the server
+:rtype: class:`ai_api_client_sdk.models.base_models.BasicResponse`
+ +
+Methods inherited from ai_api_client_sdk.resource_clients.base_client.BaseClient:
+
__init__(self, rest_client: ai_api_client_sdk.helpers.rest_client.RestClient)
Initialize self.  See help(type(self)) for accurate signature.
+ +
bulk_modify(self, *args, **kwargs)
Modifies multiple instances of the relevant resource. Will be implemented by the respective resource clients
+ +
count(self, *args, **kwargs)
Counts the relevant resources. Will be implemented by the respective resource clients
+ +
query_logs(self, *args, **kwargs)
Queries the relevant logs. Will be implemented by the respective resource clients
+ +
+Data descriptors inherited from ai_api_client_sdk.resource_clients.base_client.BaseClient:
+
__dict__
+
dictionary for instance variables
+
+
__weakref__
+
list of weak references to the object
+
+

+ \ No newline at end of file diff --git a/packages/core/docs/ai_core_sdk.resource_clients.docker_registry_secrets_client.html b/packages/core/docs/ai_core_sdk.resource_clients.docker_registry_secrets_client.html new file mode 100644 index 0000000..cb72541 --- /dev/null +++ b/packages/core/docs/ai_core_sdk.resource_clients.docker_registry_secrets_client.html @@ -0,0 +1,147 @@ + + + + +Python: module ai_core_sdk.resource_clients.docker_registry_secrets_client + + + + + +
 
ai_core_sdk.resource_clients.docker_registry_secrets_client		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/core/ai_core_sdk/resource_clients/docker_registry_secrets_client.py
+

+

+ + + + + +
 
Classes
       
+
ai_api_client_sdk.resource_clients.base_client.BaseClient(builtins.object) +
+
+
DockerRegistrySecretsClient +
+
+
+

+ + + + + + + +
 
class DockerRegistrySecretsClient(ai_api_client_sdk.resource_clients.base_client.BaseClient)
   DockerRegistrySecretsClient(
+    rest_client: ai_api_client_sdk.helpers.rest_client.RestClient
+)
+ 
+DockerRegistrySecretsClient is a class implemented for interacting with the docker registry secret related
+endpoints of the server. It implements the base class
+:class:`ai_api_client_sdk.resource_clients.base_client.BaseClient`
 
 
Method resolution order:
+
DockerRegistrySecretsClient
+
ai_api_client_sdk.resource_clients.base_client.BaseClient
+
builtins.object
+
+
+Methods defined here:
+
create(self, name: str, data: dict) -> ai_core_sdk.models.base_models.Message
Creates a docker secret based on the configuration in the request body.
+ 
+:param name: name of the docker registry secret
+:type name: str
+:param data: json dict, defining the docker registry secret
+:type data: dict
+: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
+:return: An object representing the response from the server
+:rtype: class:`ai_core_sdk.models.base_models.Message`
+ +
delete(self, name: str) -> ai_api_client_sdk.models.base_models.BasicResponse
Deletes the docker registry secret with the given name if it exists.
+ 
+:param name: name of the docker registry secret to be deleted
+:type name: str
+: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
+:return: An object representing the response from the server
+:rtype: class:`ai_api_client_sdk.models.base_models.BasicResponse`
+ +
get(self, name: str) -> ai_core_sdk.models.docker_registry_secret.DockerRegistrySecret
Returns the metadata of the docker registry secrets which matches the given name.
+ 
+:param name: name of the docker registry secret to be retrieved
+:type name: str
+: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: The retrieved metadata of the docker registry secret
+:rtype: class:`ai_core_sdk.models.docker_registry_secret.DockerRegistrySecret`
+ +
modify(self, name: str, data: dict) -> ai_api_client_sdk.models.base_models.BasicResponse
Updates the docker registry secret
+ 
+:param name: name of the docker registry secret to be modified
+:type name: str
+:param data: json dict, defining the docker registry secret
+:type data: dict
+: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
+:return: An object representing the response from the server
+:rtype: class:`ai_api_client_sdk.models.base_models.BasicResponse`
+ +
query(self, top: int = None, skip: int = None) -> ai_core_sdk.models.docker_registry_secret_query_response.DockerRegistrySecretQueryResponse
Gets a list of metadata of docker registry secrets.
+ 
+:param top: Number of docker registry secrets to be retrieved, defaults to None
+:type top: int, optional
+:param skip: Number of docker registry secrets to be skipped, from the list of the queried docker registry
+    secrets, defaults to None
+:type skip: int, optional
+: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
+:return: A list of metadata of secrets
+:rtype: class:`ai_core_sdk.models.docker_registry_secret_query_response.DockerRegistrySecretQueryResponse`
+ +
+Methods inherited from ai_api_client_sdk.resource_clients.base_client.BaseClient:
+
__init__(self, rest_client: ai_api_client_sdk.helpers.rest_client.RestClient)
Initialize self.  See help(type(self)) for accurate signature.
+ +
bulk_modify(self, *args, **kwargs)
Modifies multiple instances of the relevant resource. Will be implemented by the respective resource clients
+ +
count(self, *args, **kwargs)
Counts the relevant resources. Will be implemented by the respective resource clients
+ +
query_logs(self, *args, **kwargs)
Queries the relevant logs. Will be implemented by the respective resource clients
+ +
+Data descriptors inherited from ai_api_client_sdk.resource_clients.base_client.BaseClient:
+
__dict__
+
dictionary for instance variables
+
+
__weakref__
+
list of weak references to the object
+
+

+ \ No newline at end of file diff --git a/packages/core/docs/ai_core_sdk.resource_clients.html b/packages/core/docs/ai_core_sdk.resource_clients.html new file mode 100644 index 0000000..58d294e --- /dev/null +++ b/packages/core/docs/ai_core_sdk.resource_clients.html @@ -0,0 +1,28 @@ + + + + +Python: package ai_core_sdk.resource_clients + + + + + +
 
ai_core_sdk.resource_clients		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/core/ai_core_sdk/resource_clients/__init__.py
+

+

+ + + + + +
 
Package Contents
       
applications_client
+docker_registry_secrets_client
+		internal_rest_client
+kpi_client
+		metrics_client
+object_store_secrets_client
+		repositories_client
+secrets_client
+
+ \ No newline at end of file diff --git a/packages/core/docs/ai_core_sdk.resource_clients.internal_rest_client.html b/packages/core/docs/ai_core_sdk.resource_clients.internal_rest_client.html new file mode 100644 index 0000000..a318136 --- /dev/null +++ b/packages/core/docs/ai_core_sdk.resource_clients.internal_rest_client.html @@ -0,0 +1,220 @@ + + + + +Python: module ai_core_sdk.resource_clients.internal_rest_client + + + + + +
 
ai_core_sdk.resource_clients.internal_rest_client		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/core/ai_core_sdk/resource_clients/internal_rest_client.py
+

+

+ + + + + +
 
Modules
       
os
+

+ + + + + +
 
Classes
       
+
ai_api_client_sdk.helpers.rest_client.RestClient(builtins.object) +
+
+
InternalRestClient +
+
+
+

+ + + + + + + +
 
class InternalRestClient(ai_api_client_sdk.helpers.rest_client.RestClient)
   InternalRestClient(
+    base_url=None,
+    get_token=None,
+    resource_group=None,
+    *args,
+    **kwargs
+)
+ 
+InternalRestClient is a class implemented for sending requests to services within aicore. The InternalRestClient should only be used for services that do not require authentication when called within aicore.
 
 
Method resolution order:
+
InternalRestClient
+
ai_api_client_sdk.helpers.rest_client.RestClient
+
builtins.object
+
+
+Methods defined here:
+
__init__( + self, + base_url=None, + get_token=None, + resource_group=None, + *args, + **kwargs +)
Initialize self.  See help(type(self)) for accurate signature.
+ +
+Methods inherited from ai_api_client_sdk.helpers.rest_client.RestClient:
+
delete( + self, + path: str, + params: Dict[str, str] = None, + headers: Dict[str, str] = None, + resource_group: str = None, + **kwargs +) -> dict
Sends a DELETE request to the server.
+ 
+:param path: path of the endpoint the request should be sent to
+:type path: str
+:param params: parameters of the request, defaults to None
+:type params: Dict[str, str], optional
+:param headers: headers of the request, defaults to None
+:type headers: Dict[str, str], optional
+:param resource_group: Resource Group which the request should be sent on behalf. Either this, or the
+    resource_group property of this class should be set.
+:type resource_group: str
+:param kwargs: additional keyword arguments to be passed to the request e.g. files, stream, etc.
+:type kwargs: dict
+: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
+:return: The JSON response from the server (The keys decamelized)
+:rtype: dict
+ +
get( + self, + path: str, + params: Dict[str, str] = None, + headers: Dict[str, str] = None, + resource_group: str = None, + return_bytes_content: bool = False, + **kwargs +) -> Union[dict, int]
Sends a GET request to the server.
+ 
+:param path: path of the endpoint the request should be sent to
+:type path: str
+:param params: parameters of the request, defaults to None
+:type params: Dict[str, str], optional
+:param headers: headers of the request, defaults to None
+:type headers: Dict[str, str], optional
+:param resource_group: Resource Group which the request should be sent on behalf. Either this, or the
+    resource_group property of this class should be set.
+:type resource_group: str
+:param return_bytes_content: expected response.content is bytes
+:type return_bytes_content: bool
+:param kwargs: additional keyword arguments to be passed to the request e.g. files, stream, etc.
+:type kwargs: dict
+: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
+:return: The JSON response from the server (The keys decamelized)
+:rtype: Union[dict, int]
+ +
patch( + self, + path: str, + body: Dict[str, Union[str, dict, list]], + headers: Dict[str, str] = None, + resource_group: str = None, + **kwargs +) -> dict
Sends a PATCH request to the server.
+ 
+:param path: path of the endpoint the request should be sent to
+:type path: str
+:param body: body of the request
+:type body: Dict[str, Union[str, dict, list]]
+:param headers: headers of the request, defaults to None
+:type headers: Dict[str, str], optional
+:param resource_group: Resource Group which the request should be sent on behalf. Either this, or the
+    resource_group property of this class should be set.
+:type resource_group: str
+:param kwargs: additional keyword arguments to be passed to the request e.g. files, stream, etc.
+:type kwargs: dict
+: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
+:return: The JSON response from the server (The keys decamelized)
+:rtype: dict
+ +
post( + self, + path: str, + body: Dict[str, Union[str, dict]] = None, + headers: Dict[str, str] = None, + resource_group: str = None, + **kwargs +) -> dict
Sends a POST request to the server.
+ 
+:param path: path of the endpoint the request should be sent to
+:type path: str
+:param body: body of the request, defaults to None
+:type body: Dict[str, str], optional
+:param headers: headers of the request, defaults to None
+:type headers: Dict[str, str], optional
+:param resource_group: Resource Group which the request should be sent on behalf. Either this, or the
+    resource_group property of this class should be set.
+:type resource_group: str
+:param kwargs: additional keyword arguments to be passed to the request e.g. files, stream, etc.
+:type kwargs: dict
+: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
+:return: The JSON response from the server (The keys decamelized)
+:rtype: dict
+ +
+Static methods inherited from ai_api_client_sdk.helpers.rest_client.RestClient:
+
raise_ai_api_exception(error_description, response, response_json)
+ +
+Data descriptors inherited from ai_api_client_sdk.helpers.rest_client.RestClient:
+
__dict__
+
dictionary for instance variables
+
+
__weakref__
+
list of weak references to the object
+
+
+Data and other attributes inherited from ai_api_client_sdk.helpers.rest_client.RestClient:
+
logger = <Logger ai-api-client-sdk (WARNING)>
+ +

+ \ No newline at end of file diff --git a/packages/core/docs/ai_core_sdk.resource_clients.kpi_client.html b/packages/core/docs/ai_core_sdk.resource_clients.kpi_client.html new file mode 100644 index 0000000..c1c380c --- /dev/null +++ b/packages/core/docs/ai_core_sdk.resource_clients.kpi_client.html @@ -0,0 +1,85 @@ + + + + +Python: module ai_core_sdk.resource_clients.kpi_client + + + + + +
 
ai_core_sdk.resource_clients.kpi_client		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/core/ai_core_sdk/resource_clients/kpi_client.py
+

+

+ + + + + +
 
Classes
       
+
ai_api_client_sdk.resource_clients.base_client.BaseClient(builtins.object) +
+
+
KpiClient +
+
+
+

+ + + + + + + +
 
class KpiClient(ai_api_client_sdk.resource_clients.base_client.BaseClient)
   KpiClient(rest_client: ai_api_client_sdk.helpers.rest_client.RestClient)
+ 
+KpiClient is a class implemented for interacting with the analytics kpi
+endpoint of the server. It implements the base class
+:class:`ai_api_client_sdk.resource_clients.base_client.BaseClient`
 
 
Method resolution order:
+
KpiClient
+
ai_api_client_sdk.resource_clients.base_client.BaseClient
+
builtins.object
+
+
+Methods defined here:
+
query(self) -> ai_core_sdk.models.kpi.Kpi
Retrieves the number of executions, artifacts, and deployments
+for each resource group, scenario, and executable.
+ 
+: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: The retrieved KPI data
+:rtype: class:`ai_core_sdk.models.kpi.Kpi`
+ +
+Methods inherited from ai_api_client_sdk.resource_clients.base_client.BaseClient:
+
__init__(self, rest_client: ai_api_client_sdk.helpers.rest_client.RestClient)
Initialize self.  See help(type(self)) for accurate signature.
+ +
bulk_modify(self, *args, **kwargs)
Modifies multiple instances of the relevant resource. Will be implemented by the respective resource clients
+ +
count(self, *args, **kwargs)
Counts the relevant resources. Will be implemented by the respective resource clients
+ +
create(self, *args, **kwargs)
Creates the relevant resource. Will be implemented by the respective resource clients
+ +
delete(self, *args, **kwargs)
Deletes the relevant resource. Will be implemented by the respective resource clients
+ +
get(self, *args, **kwargs)
Retrieves the relevant resource. Will be implemented by the respective resource clients
+ +
modify(self, *args, **kwargs)
Modifies the relevant resource. Will be implemented by the respective resource clients
+ +
query_logs(self, *args, **kwargs)
Queries the relevant logs. Will be implemented by the respective resource clients
+ +
+Data descriptors inherited from ai_api_client_sdk.resource_clients.base_client.BaseClient:
+
__dict__
+
dictionary for instance variables
+
+
__weakref__
+
list of weak references to the object
+
+

+ \ No newline at end of file diff --git a/packages/core/docs/ai_core_sdk.resource_clients.metrics_client.html b/packages/core/docs/ai_core_sdk.resource_clients.metrics_client.html new file mode 100644 index 0000000..68deb4b --- /dev/null +++ b/packages/core/docs/ai_core_sdk.resource_clients.metrics_client.html @@ -0,0 +1,215 @@ + + + + +Python: module ai_core_sdk.resource_clients.metrics_client + + + + + +
 
ai_core_sdk.resource_clients.metrics_client		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/core/ai_core_sdk/resource_clients/metrics_client.py
+

+

+ + + + + +
 
Classes
       
+
ai_api_client_sdk.resource_clients.metrics_client.MetricsClient(ai_api_client_sdk.resource_clients.base_client.BaseClient) +
+
+
MetricsCoreClient +
+
+
+

+ + + + + + + +
 
class MetricsCoreClient(ai_api_client_sdk.resource_clients.metrics_client.MetricsClient)
   MetricsCoreClient(rest_client, execution_id: str = None) -&gt; None
+ 
+MetricsCoreClient is a class implemented for interacting with the metrics related
+endpoints of the server. It is inherited from the base class
+:class:`ai_api_client_sdk.resource_clients.metrics_client.MetricsClient`
 
 
Method resolution order:
+
MetricsCoreClient
+
ai_api_client_sdk.resource_clients.metrics_client.MetricsClient
+
ai_api_client_sdk.resource_clients.base_client.BaseClient
+
builtins.object
+
+
+Methods defined here:
+
__init__(self, rest_client, execution_id: str = None) -> None
Initialize self.  See help(type(self)) for accurate signature.
+ +
log_metrics( + self, + metrics: List[ai_api_client_sdk.models.metric.Metric], + execution_id: str = '', + artifact_name: str = None, + resource_group: str = None +) -> None
Creates or updates the metrics for an execution.
+ 
+    :param metrics: List of the metrics related to the execution,
+    :type metrics: List[class:`ai_api_client_sdk.metric.Metric`]
+    :param execution_id: ID of the execution, of which the metrics should be modified.
+    :type execution_id: str
+    :param artifact_name: Name of the artifact to associate with a metric, defaults to None
+    :type artifact_name: str
+    :param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
+        resource group in the :class:`ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client` should be specified,
+        defaults to None
+    :type resource_group: str
+    :raises: class:`ai_api_client_sdk.exception.AIAPIInvalidRequestException` if a 400 response is received from the
+server
+    :raises: class:`ai_api_client_sdk.exception.AIAPIServerException` if a non-2XX response is received from the
+        server
+ +
modify( + self, + execution_id: str = '', + metrics: List[ai_api_client_sdk.models.metric.Metric] = None, + tags: List[ai_api_client_sdk.models.metric_tag.MetricTag] = None, + custom_info: List[ai_api_client_sdk.models.metric_custom_info.MetricCustomInfo] = None, + resource_group: str = None +) -> None
Creates or updates the metrics for an execution.
+ 
+    :param execution_id: ID of the execution, of which the metrics should be modified.
+    :type execution_id: str
+    :param metrics: List of the metrics related to the execution, defaults to None
+    :type metrics: List[class:`ai_api_client_sdk.metric.Metric`], optional
+    :param tags: List of the tags related to the execution, defaults to None
+    :type tags: List[class:'ai_api_client_sdk.models.metric_tag.MetricTag'], optional
+    :param custom_info: List of custom info related to the execution, defaults to None
+    :type custom_info: List[class:`ai_api_client_sdk.models.metric_custom_info.MetricCustomInfo`], optional
+    :param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
+        resource group in the :class:`ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client` should be specified,
+        defaults to None
+    :type resource_group: str
+    :raises: class:`ai_api_client_sdk.exception.AIAPIInvalidRequestException` if a 400 response is received from the
+server
+    :raises: class:`ai_api_client_sdk.exception.AIAPIServerException` if a non-2XX response is received from the
+        server
+ +
set_custom_info( + self, + custom_info: List[ai_api_client_sdk.models.metric_custom_info.MetricCustomInfo], + execution_id: str = '', + resource_group: str = None +) -> None
log custom info against the given execution
+    captures consumption semantics for the metrics or complex metric in JSON format.
+ 
+ 
+    :param custom_info: List of custom info related to the execution
+    :type custom_info: List[class:`ai_api_client_sdk.models.metric_custom_info.MetricCustomInfo`], optional
+    :param execution_id: ID of the execution, of which the metrics should be modified.
+    :type execution_id: str
+    :param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
+        resource group in the :class:`ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client` should be specified,
+        defaults to None
+    :type resource_group: str
+    :raises: class:`ai_api_client_sdk.exception.AIAPIInvalidRequestException` if a 400 response is received from the
+server
+    :raises: class:`ai_api_client_sdk.exception.AIAPIServerException` if a non-2XX response is received from the
+        server
+ +
set_tags( + self, + tags: List[ai_api_client_sdk.models.metric_tag.MetricTag], + execution_id: str = '', + resource_group: str = None +) -> None
log tags against the given execution
+ 
+    :param tags: List of the tags related to the execution, defaults to None
+    :type tags: List[class:'ai_api_client_sdk.models.metric_tag.MetricTag']
+    :param execution_id: ID of the execution, of which the metrics should be modified.
+    :type execution_id: str
+    :param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
+        resource group in the :class:`ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client` should be specified,
+        defaults to None
+    :type resource_group: str
+    :raises: class:`ai_api_client_sdk.exception.AIAPIInvalidRequestException` if a 400 response is received from the
+server
+    :raises: class:`ai_api_client_sdk.exception.AIAPIServerException` if a non-2XX response is received from the
+        server
+ +
+Methods inherited from ai_api_client_sdk.resource_clients.metrics_client.MetricsClient:
+
delete(self, execution_id: str, resource_group: str = None) -> None
Deletes the metrics.
+ 
+:param execution_id: ID of the execution, of which the metrics should be deleted.
+:type execution_id: str
+:param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
+    resource group in the :class:`ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client` should be specified,
+    defaults to None
+:type resource_group: str
+: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
+ +
query( + self, + filter: str = None, + execution_ids: List[str] = None, + select: List[str] = None, + resource_group: str = None +) -> ai_api_client_sdk.models.metrics_query_response.MetricsQueryResponse
Queries the metrics.
+ 
+:param filter: 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
+:type filter: str, optional
+:param execution_ids: IDs of the executions, of which the metrics should be retrieved, defaults to None
+:type execution_ids: List[str], optional
+:param select: 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
+:type select: List[str], optional
+:param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
+    resource group in the :class:`ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client` should be specified,
+    defaults to None
+:type resource_group: str
+: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
+:return: An object representing the response from the server
+:rtype: class:`ai_api_client_sdk.models.metrics_query_response.MetricsQueryResponse`
+ +
+Methods inherited from ai_api_client_sdk.resource_clients.base_client.BaseClient:
+
bulk_modify(self, *args, **kwargs)
Modifies multiple instances of the relevant resource. Will be implemented by the respective resource clients
+ +
count(self, *args, **kwargs)
Counts the relevant resources. Will be implemented by the respective resource clients
+ +
create(self, *args, **kwargs)
Creates the relevant resource. Will be implemented by the respective resource clients
+ +
get(self, *args, **kwargs)
Retrieves the relevant resource. Will be implemented by the respective resource clients
+ +
query_logs(self, *args, **kwargs)
Queries the relevant logs. Will be implemented by the respective resource clients
+ +
+Data descriptors inherited from ai_api_client_sdk.resource_clients.base_client.BaseClient:
+
__dict__
+
dictionary for instance variables
+
+
__weakref__
+
list of weak references to the object
+
+

+ + + + + +
 
Data
       List = typing.List
+ \ No newline at end of file diff --git a/packages/core/docs/ai_core_sdk.resource_clients.object_store_secrets_client.html b/packages/core/docs/ai_core_sdk.resource_clients.object_store_secrets_client.html new file mode 100644 index 0000000..659124f --- /dev/null +++ b/packages/core/docs/ai_core_sdk.resource_clients.object_store_secrets_client.html @@ -0,0 +1,229 @@ + + + + +Python: module ai_core_sdk.resource_clients.object_store_secrets_client + + + + + +
 
ai_core_sdk.resource_clients.object_store_secrets_client		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/core/ai_core_sdk/resource_clients/object_store_secrets_client.py
+

+

+ + + + + +
 
Classes
       
+
ai_api_client_sdk.resource_clients.base_client.BaseClient(builtins.object) +
+
+
ObjectStoreSecretsClient +
+
+
+

+ + + + + + + +
 
class ObjectStoreSecretsClient(ai_api_client_sdk.resource_clients.base_client.BaseClient)
   ObjectStoreSecretsClient(
+    rest_client: ai_api_client_sdk.helpers.rest_client.RestClient
+)
+ 
+ObjectStoreSecretsClient is a class implemented for interacting with the object store secret related
+endpoints of the server. It implements the base class
+:class:`ai_api_client_sdk.resource_clients.base_client.BaseClient`
 
 
Method resolution order:
+
ObjectStoreSecretsClient
+
ai_api_client_sdk.resource_clients.base_client.BaseClient
+
builtins.object
+
+
+Methods defined here:
+
create( + self, + name: str, + type: str, + data: dict, + bucket: str = None, + endpoint: str = None, + region: str = None, + path_prefix: str = None, + verifyssl: str = None, + usehttps: str = None, + resource_group: str = None +) -> ai_core_sdk.models.base_models.Message
Creates an object store secret.
+ 
+:param name: name of the object store secret
+:type name: str
+:param type: type of object storage
+:type type: str
+:param data: data to be posted
+:type data: str
+:param bucket: name of the bucket
+:type bucket: str
+:param endpoint: endpoint of object storage
+:type endpoint: str
+:param region: region of object storage
+:type region: str
+:param path_prefix: path prefix
+:type path_prefix: str
+:param verifyssl: verify ssl
+:type verifyssl: str
+:param usehttps: use https
+:type usehttps: str
+:param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
+    resource group in the :class:`ai_core_sdk.ai_core_v2_client.AICoreV2Client` should be specified,
+    defaults to None
+:type resource_group: str
+: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.AIAPIForbiddenException` if a 403 response is received from the
+    server
+:raises: class:`ai_api_client_sdk.exception.AIAPIConflictException` if a 409 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: A list of metadata of available secrets
+:rtype: class:`ai_core_sdk.models.base_models.BasicNameResponse`
+ +
delete(self, name: str, resource_group: str = None) -> ai_api_client_sdk.models.base_models.BasicResponse
Deletes the object store secret.
+ 
+:param name: name of the object store secret to be deleted
+:type name: str
+:param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
+    resource group in the :class:`ai_core_sdk.ai_core_v2_client.AICoreV2Client` should be specified,
+    defaults to None
+:type resource_group: str
+: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.AIAPIForbiddenException` if a 403 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: An object representing the response from the server
+:rtype: class:`ai_api_client_sdk.models.base_models.BasicResponse`
+ +
get(self, name: str, resource_group: str = None) -> ai_core_sdk.models.object_store_secret.ObjectStoreSecret
Retrieves the object store secret from the server.
+ 
+:param name: name of the object store secret to be retrieved
+:type name: str
+:param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
+    resource group in the :class:`ai_core_sdk.ai_core_v2_client.AICoreV2Client` should be specified,
+    defaults to None
+:type resource_group: str
+: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.AIAPIForbiddenException` if a 403 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: The retrieved object store secret
+:rtype: class:`ai_core_sdk.models.object_store_secret.ObjectStoreSecret`
+ +
modify( + self, + name: str, + type: str, + data: dict, + bucket: str = None, + endpoint: str = None, + region: str = None, + path_prefix: str = None, + verifyssl: str = None, + usehttps: str = None, + resource_group: str = None +) -> ai_api_client_sdk.models.base_models.BasicResponse
Modifies the object store secret
+ 
+:param name: name of the object store secret to be modified
+:type name: str
+:param type: type of object storage
+:type type: str
+:param data: data to be posted
+:type data: str
+:param bucket: name of the bucket
+:type bucket: str
+:param endpoint: endpoint of object storage
+:type endpoint: str
+:param region: region of object storage
+:type region: str
+:param path_prefix: path prefix
+:type path_prefix: str
+:param verifyssl: verify ssl
+:type verifyssl: str
+:param usehttps: use https
+:type usehttps: str
+:param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
+    resource group in the :class:`ai_core_sdk.ai_core_v2_client.AICoreV2Client` should be specified,
+    defaults to None
+:type resource_group: str
+: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.AIAPIForbiddenException` if a 403 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
+:return: An object representing the response from the server
+:rtype: class:`ai_api_client_sdk.models.base_models.BasicResponse`
+ +
query(self, top: int = None, skip: int = None, resource_group: str = None) -> ai_core_sdk.models.object_store_secret_query_response.ObjectStoreSecretQueryResponse
Returns the object store secrets.
+ 
+:param top: Number of object store secrets to be retrieved, defaults to None
+:type top: int, optional
+:param skip: Number of object store secrets to be skipped, from the list of the queried object store
+    secrets, defaults to None
+:type skip: int, optional
+:param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
+    resource group in the :class:`ai_core_sdk.ai_core_v2_client.AICoreV2Client` should be specified,
+    defaults to None
+:type resource_group: str
+: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.AIAPIForbiddenException` if a 403 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: A list of object store secrets
+:rtype: class:`ai_core_sdk.models.object_store_secret_query_response.ObjectStoreSecretQueryResponse`
+ +
+Methods inherited from ai_api_client_sdk.resource_clients.base_client.BaseClient:
+
__init__(self, rest_client: ai_api_client_sdk.helpers.rest_client.RestClient)
Initialize self.  See help(type(self)) for accurate signature.
+ +
bulk_modify(self, *args, **kwargs)
Modifies multiple instances of the relevant resource. Will be implemented by the respective resource clients
+ +
count(self, *args, **kwargs)
Counts the relevant resources. Will be implemented by the respective resource clients
+ +
query_logs(self, *args, **kwargs)
Queries the relevant logs. Will be implemented by the respective resource clients
+ +
+Data descriptors inherited from ai_api_client_sdk.resource_clients.base_client.BaseClient:
+
__dict__
+
dictionary for instance variables
+
+
__weakref__
+
list of weak references to the object
+
+

+ \ No newline at end of file diff --git a/packages/core/docs/ai_core_sdk.resource_clients.repositories_client.html b/packages/core/docs/ai_core_sdk.resource_clients.repositories_client.html new file mode 100644 index 0000000..1798ac8 --- /dev/null +++ b/packages/core/docs/ai_core_sdk.resource_clients.repositories_client.html @@ -0,0 +1,148 @@ + + + + +Python: module ai_core_sdk.resource_clients.repositories_client + + + + + +
 
ai_core_sdk.resource_clients.repositories_client		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/core/ai_core_sdk/resource_clients/repositories_client.py
+

+

+ + + + + +
 
Classes
       
+
ai_api_client_sdk.resource_clients.base_client.BaseClient(builtins.object) +
+
+
RepositoriesClient +
+
+
+

+ + + + + + + +
 
class RepositoriesClient(ai_api_client_sdk.resource_clients.base_client.BaseClient)
   RepositoriesClient(
+    rest_client: ai_api_client_sdk.helpers.rest_client.RestClient
+)
+ 
+RepositoriesClient is a class implemented for interacting with the repositories related
+endpoints of the server. It implements the base class
+:class:`ai_api_client_sdk.resource_clients.base_client.BaseClient`
 
 
Method resolution order:
+
RepositoriesClient
+
ai_api_client_sdk.resource_clients.base_client.BaseClient
+
builtins.object
+
+
+Methods defined here:
+
create(self, name: str, url: str, username: str, password: str) -> ai_core_sdk.models.base_models.Message
On-boards a new GitOps repository
+ 
+:param name: name of the GitOps repository
+:type name: str
+:param url: url of the GitOps repository
+:type url: str
+:param username: username to the GitOps repository
+:type username: str
+:param password: password to the GitOps repository
+:type password: str
+: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
+:return: An object representing the response from the server
+:rtype: class:`ai_core_sdk.models.base_models.BasicNameResponse`
+ +
delete(self, name: str) -> ai_api_client_sdk.models.base_models.BasicResponse
Off-boards a GitOps repository.
+ 
+:param name: name of the repository to be deleted
+:type name: str
+: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
+:return: An object representing the response from the server
+:rtype: class:`ai_api_client_sdk.models.base_models.BasicResponse`
+ +
get(self, name: str) -> ai_core_sdk.models.repository.Repository
Retrieves the access details for a repository if it exists.
+ 
+:param name: name of the repository to be retrieved
+:type name: str
+: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: The access details for a repository
+:rtype: class:`ai_core_client_sdk.models.docker_registry_secret.DockerRegistrySecret`
+ +
modify(self, name: str, username: str, password: str) -> ai_api_client_sdk.models.base_models.BasicResponse
Updates the referenced repository credentials to synchronize repository.
+ 
+:param name: name of the repository to be modified
+:type name: str
+:param username: username to the repository
+:type username: str
+:param password: password to the repository
+:type password: str
+: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
+:return: An object representing the response from the server
+:rtype: class:`ai_api_client_sdk.models.base_models.BasicResponse`
+ +
query(self) -> ai_core_sdk.models.repository_query_response.RepositoryQueryResponse
Retrieves a list of all GitOps repositories for a tenant.
+ 
+: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
+:return: A list all GitOps repositories for a tenant
+:rtype: class:`ai_core_client_sdk.models.repository_query_response.RepositoryQueryResponse`
+ +
+Methods inherited from ai_api_client_sdk.resource_clients.base_client.BaseClient:
+
__init__(self, rest_client: ai_api_client_sdk.helpers.rest_client.RestClient)
Initialize self.  See help(type(self)) for accurate signature.
+ +
bulk_modify(self, *args, **kwargs)
Modifies multiple instances of the relevant resource. Will be implemented by the respective resource clients
+ +
count(self, *args, **kwargs)
Counts the relevant resources. Will be implemented by the respective resource clients
+ +
query_logs(self, *args, **kwargs)
Queries the relevant logs. Will be implemented by the respective resource clients
+ +
+Data descriptors inherited from ai_api_client_sdk.resource_clients.base_client.BaseClient:
+
__dict__
+
dictionary for instance variables
+
+
__weakref__
+
list of weak references to the object
+
+

+ \ No newline at end of file diff --git a/packages/core/docs/ai_core_sdk.resource_clients.secrets_client.html b/packages/core/docs/ai_core_sdk.resource_clients.secrets_client.html new file mode 100644 index 0000000..5a8415c --- /dev/null +++ b/packages/core/docs/ai_core_sdk.resource_clients.secrets_client.html @@ -0,0 +1,181 @@ + + + + +Python: module ai_core_sdk.resource_clients.secrets_client + + + + + +
 
ai_core_sdk.resource_clients.secrets_client		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/core/ai_core_sdk/resource_clients/secrets_client.py
+

+

+ + + + + +
 
Classes
       
+
ai_api_client_sdk.resource_clients.base_client.BaseClient(builtins.object) +
+
+
SecretsClient +
+
+
+

+ + + + + + + +
 
class SecretsClient(ai_api_client_sdk.resource_clients.base_client.BaseClient)
   SecretsClient(rest_client: ai_api_client_sdk.helpers.rest_client.RestClient)
+ 
+SecretsClient is a class implemented for interacting with the secret related
+endpoints of the server. It implements the base class
+:class:`ai_api_client_sdk.resource_clients.base_client.BaseClient`
 
 
Method resolution order:
+
SecretsClient
+
ai_api_client_sdk.resource_clients.base_client.BaseClient
+
builtins.object
+
+
+Methods defined here:
+
create( + self, + name: str, + data: dict, + resource_group: str = None, + ai_tenant_scope=True +) -> ai_core_sdk.models.base_models.Message
Creates a secret.
+ 
+:param name: name of the secret
+:type name: str
+:param data: data of secret
+:type data: dict
+:param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
+    resource group in the :class:`ai_core_sdk.ai_core_v2_client.AICoreV2Client` should be specified,
+    defaults to None
+:type resource_group: str
+:param ai_tenant_scope: Specify whether the main tenant scope is to be used
+:type ai_tenant_scope: bool
+: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.AIAPIForbiddenException` if a 403 response is received from the
+    server
+:raises: class:`ai_api_client_sdk.exception.AIAPIConflictException` if a 409 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: A list of metadata of available secrets
+:rtype: class:`ai_core_sdk.models.base_models.Message`
+ +
delete(self, name: str, resource_group: str = None, ai_tenant_scope=True) -> ai_core_sdk.models.base_models.Message
Deletes the secret.
+ 
+:param name: name of the secret to be deleted
+:type name: str
+:param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
+    resource group in the :class:`ai_core_sdk.ai_core_v2_client.AICoreV2Client` should be specified,
+    defaults to None
+:type resource_group: str
+:param ai_tenant_scope: Specify whether the main tenant scope is to be used
+:type ai_tenant_scope: bool
+: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.AIAPIForbiddenException` if a 403 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: An object representing the response from the server
+:rtype: class:`ai_api_client_sdk.models.base_models.Message`
+ +
modify( + self, + name: str, + data: dict, + resource_group: str = None, + ai_tenant_scope=True +) -> ai_core_sdk.models.base_models.Message
Modifies the secret.
+ 
+:param name: name of the secret to be modified
+:type name: str
+:param data: data of secret
+:type data: dict
+:param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
+    resource group in the :class:`ai_core_sdk.ai_core_v2_client.AICoreV2Client` should be specified,
+    defaults to None
+:type resource_group: str
+:param ai_tenant_scope: Specify whether the main tenant scope is to be used
+:type ai_tenant_scope: bool
+: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.AIAPIForbiddenException` if a 403 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
+:return: An object representing the response from the server
+:rtype: class:`ai_api_client_sdk.models.base_models.Message`
+ +
query( + self, + top: int = None, + skip: int = None, + resource_group: str = None, + ai_tenant_scope: bool = True +) -> ai_core_sdk.models.secret_query_response.SecretQueryResponse
Returns the secrets.
+ 
+:param top: Number of secrets to be retrieved, defaults to None
+:type top: int, optional
+:param skip: Number of secrets to be skipped, from the list of the queried secrets, defaults to None
+:type skip: int, optional
+:param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
+    resource group in the :class:`ai_core_sdk.ai_core_v2_client.AICoreV2Client` should be specified,
+    defaults to None
+:type resource_group: str
+:param ai_tenant_scope: Specify whether the main tenant scope is to be used
+:type ai_tenant_scope: bool
+: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.AIAPIForbiddenException` if a 403 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: A list of secrets
+:rtype: class:`ai_core_sdk.models.secret_query_response.SecretQueryResponse`
+ +
+Methods inherited from ai_api_client_sdk.resource_clients.base_client.BaseClient:
+
__init__(self, rest_client: ai_api_client_sdk.helpers.rest_client.RestClient)
Initialize self.  See help(type(self)) for accurate signature.
+ +
bulk_modify(self, *args, **kwargs)
Modifies multiple instances of the relevant resource. Will be implemented by the respective resource clients
+ +
count(self, *args, **kwargs)
Counts the relevant resources. Will be implemented by the respective resource clients
+ +
get(self, *args, **kwargs)
Retrieves the relevant resource. Will be implemented by the respective resource clients
+ +
query_logs(self, *args, **kwargs)
Queries the relevant logs. Will be implemented by the respective resource clients
+ +
+Data descriptors inherited from ai_api_client_sdk.resource_clients.base_client.BaseClient:
+
__dict__
+
dictionary for instance variables
+
+
__weakref__
+
list of weak references to the object
+
+

+ \ No newline at end of file diff --git a/packages/core/docs/ai_core_sdk.tracking.html b/packages/core/docs/ai_core_sdk.tracking.html new file mode 100644 index 0000000..3f6932d --- /dev/null +++ b/packages/core/docs/ai_core_sdk.tracking.html @@ -0,0 +1,21 @@ + + + + +Python: package ai_core_sdk.tracking + + + + + +
 
ai_core_sdk.tracking		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/core/ai_core_sdk/tracking/__init__.py
+

# pylint: disable=C0114

+

+ + + + + +
 
Package Contents
       
tracking
+
+ \ No newline at end of file diff --git a/packages/core/docs/ai_core_sdk.tracking.tracking.html b/packages/core/docs/ai_core_sdk.tracking.tracking.html new file mode 100644 index 0000000..3bab3a2 --- /dev/null +++ b/packages/core/docs/ai_core_sdk.tracking.tracking.html @@ -0,0 +1,272 @@ + + + + +Python: module ai_core_sdk.tracking.tracking + + + + + +
 
ai_core_sdk.tracking.tracking		index
/home/runner/work/ai-sdk-python/ai-sdk-python/packages/core/ai_core_sdk/tracking/tracking.py
+

# pylint: disable=C0114

+

+ + + + + +
 
Modules
       
os
+

+ + + + + +
 
Classes
       
+
ai_core_sdk.resource_clients.metrics_client.MetricsCoreClient(ai_api_client_sdk.resource_clients.metrics_client.MetricsClient) +
+
+
Tracking +
+
+
+

+ + + + + + + +
 
class Tracking(ai_core_sdk.resource_clients.metrics_client.MetricsCoreClient)
   Tracking(
+    base_url: str = None,
+    auth_url: str = None,
+    client_id: str = None,
+    client_secret: str = None,
+    cert_str: str = None,
+    key_str: str = None,
+    cert_file_path: str = None,
+    key_file_path: str = None,
+    token_creator: Callable[[], str] = None,
+    resource_group: str = None
+)
+ 
+Tracking is a class implemented for interacting with the metrics related
+endpoints of the server. It is a wrapper around the base class
+:class:`ai_core_sdk.resource_clients.metrics_client.MetricsCoreClient`
+ 
+:param base_url: Base URL of the AI Core. Should include the base path as well. (i.e., "<base_url>/lm/scenarios"
+should work)
+:type base_url: str
+:param auth_url: URL of the authorization endpoint. Should be the full URL (including /oauth/token), defaults to
+    None
+:type auth_url: str, optional
+:param client_id: client id to be used for authorization, defaults to None
+:type client_id: str, optional
+:param client_secret: client secret to be used for authorization, defaults to None
+:type client_secret: str, optional
+:param cert_str: certificate file content, needs to be provided alongside the key_str parameter, defaults to None
+:type cert_str: str, optional
+:param key_str: key file content, needs to be provided alongside the cert_str parameter, defaults to None
+:type key_str: str, optional
+:param cert_file_path: path to the certificate file, needs to be provided alongside the key_file_path parameter,
+    defaults to None
+:type cert_file_path: str, optional
+:param key_file_path: path to the key file, needs to be provided alongside the cert_file_path parameter,
+    defaults to None
+:type key_file_path: str, optional
+:param token_creator: the function which returns the Bearer token, when called. Either this, or
+    auth_url & client_id & client_secret should be specified, defaults to None
+:type token_creator: Callable[[], str], optional
+:param resource_group: The default resource group which will be used while sending the requests to the server. If
+    not set, the resource_group should be specified with every request to the server, defaults to None
+:type resource_group: str, optional
 
 
Method resolution order:
+
Tracking
+
ai_core_sdk.resource_clients.metrics_client.MetricsCoreClient
+
ai_api_client_sdk.resource_clients.metrics_client.MetricsClient
+
ai_api_client_sdk.resource_clients.base_client.BaseClient
+
builtins.object
+
+
+Methods defined here:
+
__init__( + self, + base_url: str = None, + auth_url: str = None, + client_id: str = None, + client_secret: str = None, + cert_str: str = None, + key_str: str = None, + cert_file_path: str = None, + key_file_path: str = None, + token_creator: Callable[[], str] = None, + resource_group: str = None +)
Initialize self.  See help(type(self)) for accurate signature.
+ +
delete(self, execution_id: str, resource_group: str = None) -> None
Deletes the metrics.
+ 
+:param execution_id: ID of the execution, of which the metrics should be deleted.
+:type execution_id: str
+:param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
+    resource group in the :class:`ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client` should be specified,
+    defaults to None
+:type resource_group: str
+: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
+ +
log_metrics( + self, + metrics: List[ai_api_client_sdk.models.metric.Metric], + execution_id: str = '', + artifact_name: str = None, + resource_group: str = None +) -> None
Creates or updates the metrics for an execution.
+ 
+    :param metrics: List of the metrics related to the execution,
+    :type metrics: List[class:`ai_api_client_sdk.metric.Metric`]
+    :param execution_id: ID of the execution, of which the metrics should be modified.
+    :type execution_id: str
+    :param artifact_name: Name of the artifact to associate with a metric, defaults to None
+    :type artifact_name: str
+    :param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
+        resource group in the :class:`ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client` should be specified,
+        defaults to None
+    :type resource_group: str
+    :raises: class:`ai_api_client_sdk.exception.AIAPIInvalidRequestException` if a 400 response is received from the
+server
+    :raises: class:`ai_api_client_sdk.exception.AIAPIServerException` if a non-2XX response is received from the
+        server
+ +
modify( + self, + execution_id: str = '', + metrics: List[ai_api_client_sdk.models.metric.Metric] = None, + tags: List[ai_api_client_sdk.models.metric_tag.MetricTag] = None, + custom_info: List[ai_api_client_sdk.models.metric_custom_info.MetricCustomInfo] = None, + resource_group: str = None +) -> None
Creates or updates the metrics for an execution.
+ 
+    :param execution_id: ID of the execution, of which the metrics should be modified.
+    :type execution_id: str
+    :param metrics: List of the metrics related to the execution, defaults to None
+    :type metrics: List[class:`ai_api_client_sdk.metric.Metric`], optional
+    :param tags: List of the tags related to the execution, defaults to None
+    :type tags: List[class:'ai_api_client_sdk.models.metric_tag.MetricTag'], optional
+    :param custom_info: List of custom info related to the execution, defaults to None
+    :type custom_info: List[class:`ai_api_client_sdk.models.metric_custom_info.MetricCustomInfo`], optional
+    :param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
+        resource group in the :class:`ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client` should be specified,
+        defaults to None
+    :type resource_group: str
+    :raises: class:`ai_api_client_sdk.exception.AIAPIInvalidRequestException` if a 400 response is received from the
+server
+    :raises: class:`ai_api_client_sdk.exception.AIAPIServerException` if a non-2XX response is received from the
+        server
+ +
query( + self, + filter: str = None, + execution_ids: List[str] = None, + select: List[str] = None, + resource_group: str = None +) -> ai_api_client_sdk.models.metrics_query_response.MetricsQueryResponse
Creates or updates the metrics for an execution.
+ 
+:param filter: 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
+:type filter: str, optional
+:param execution_ids: IDs of the executions, of which the metrics should be retrieved, defaults to None
+:type execution_ids: List[str], optional
+:param select: 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
+:type select: List[str], optional
+:param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
+    resource group in the :class:`ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client` should be specified,
+    defaults to None
+:type resource_group: str
+: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
+:return: An object representing the response from the server
+:rtype: class:`ai_api_client_sdk.models.metrics_query_response.MetricsQueryResponse`
+ +
set_custom_info( + self, + custom_info: List[ai_api_client_sdk.models.metric_custom_info.MetricCustomInfo], + execution_id: str = '', + resource_group: str = None +) -> None
log custom info against the given execution
+    captures consumption semantics for the metrics or complex metric in JSON format.
+ 
+ 
+    :param custom_info: List of custom info related to the execution
+    :type custom_info: List[class:`ai_api_client_sdk.models.metric_custom_info.MetricCustomInfo`], optional
+    :param execution_id: ID of the execution, of which the metrics should be modified.
+    :type execution_id: str
+    :param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
+        resource group in the :class:`ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client` should be specified,
+        defaults to None
+    :type resource_group: str
+    :raises: class:`ai_api_client_sdk.exception.AIAPIInvalidRequestException` if a 400 response is received from the
+server
+    :raises: class:`ai_api_client_sdk.exception.AIAPIServerException` if a non-2XX response is received from the
+        server
+ +
set_tags( + self, + tags: List[ai_api_client_sdk.models.metric_tag.MetricTag], + execution_id: str = '', + resource_group: str = None +) -> None
log tags against the given execution
+ 
+    :param tags: List of the tags related to the execution, defaults to None
+    :type tags: List[class:'ai_api_client_sdk.models.metric_tag.MetricTag']
+    :param execution_id: ID of the execution, of which the metrics should be modified.
+    :type execution_id: str
+    :param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
+        resource group in the :class:`ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client` should be specified,
+        defaults to None
+    :type resource_group: str
+    :raises: class:`ai_api_client_sdk.exception.AIAPIInvalidRequestException` if a 400 response is received from the
+server
+    :raises: class:`ai_api_client_sdk.exception.AIAPIServerException` if a non-2XX response is received from the
+        server
+ +
+Methods inherited from ai_api_client_sdk.resource_clients.base_client.BaseClient:
+
bulk_modify(self, *args, **kwargs)
Modifies multiple instances of the relevant resource. Will be implemented by the respective resource clients
+ +
count(self, *args, **kwargs)
Counts the relevant resources. Will be implemented by the respective resource clients
+ +
create(self, *args, **kwargs)
Creates the relevant resource. Will be implemented by the respective resource clients
+ +
get(self, *args, **kwargs)
Retrieves the relevant resource. Will be implemented by the respective resource clients
+ +
query_logs(self, *args, **kwargs)
Queries the relevant logs. Will be implemented by the respective resource clients
+ +
+Data descriptors inherited from ai_api_client_sdk.resource_clients.base_client.BaseClient:
+
__dict__
+
dictionary for instance variables
+
+
__weakref__
+
list of weak references to the object
+
+

+ + + + + +
 
Data
       Callable = typing.Callable
+List = typing.List
+ \ No newline at end of file