sap-ai-sdk-core 2.9.9__py3-none-any.whl → 3.0.3__py3-none-any.whl

ai_core_sdk/resource_clients/__init__.py

@@ -0,0 +1,13 @@
+from ai_api_client_sdk.ai_api_v2_client import AIAPIV2Client
+from ai_api_client_sdk.helpers.rest_client import RestClient
+from ai_api_client_sdk.resource_clients.artifact_client import ArtifactClient
+from ai_api_client_sdk.resource_clients.base_client import BaseClient
+from ai_api_client_sdk.resource_clients.configuration_client import ConfigurationClient
+from ai_api_client_sdk.resource_clients.deployment_client import DeploymentClient
+from ai_api_client_sdk.resource_clients.executable_client import ExecutableClient
+from ai_api_client_sdk.resource_clients.execution_client import ExecutionClient
+from ai_api_client_sdk.resource_clients.meta_client import MetaClient
+from ai_api_client_sdk.resource_clients.metrics_client import MetricsClient
+from ai_api_client_sdk.resource_clients.model_client import ModelClient
+from ai_api_client_sdk.resource_clients.resource_groups_client import ResourceGroupsClient
+from ai_api_client_sdk.resource_clients.scenario_client import ScenarioClient

ai_core_sdk/resource_clients/applications_client.py

@@ -0,0 +1,173 @@
+from ai_core_sdk.exception import AICoreInvalidInputException
+from ai_core_sdk.models import BasicResponse
+from ai_core_sdk.models.application import Application
+from ai_core_sdk.models.application_query_response import ApplicationQueryResponse
+from ai_core_sdk.models.application_status import ApplicationStatus
+from ai_core_sdk.resource_clients import BaseClient
+
+
+class ApplicationsClient(BaseClient):
+    """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`
+    """
+
+    __PATH = '/admin/applications'
+
+    def create(self, revision: str, path: str, application_name: str = None, repository_name: str = None,
+               repository_url: str = None) -> 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`
+        """
+        if (repository_url and repository_name) or (not repository_name and not repository_url):
+            raise AICoreInvalidInputException('Either repository_url or repository_name must be provided, not both')
+        body = {'revision': revision, 'path': path}
+        if repository_name:
+            body['repository_name'] = repository_name
+        elif repository_url:
+            body['repository_url'] = repository_url
+        if application_name:
+            body['application_name'] = application_name
+        response_dict = self.rest_client.post(path=self.__PATH, body=body)
+        return BasicResponse.from_dict(response_dict)
+
+    def delete(self, application_name: str) -> 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`
+        """
+        response_dict = self.rest_client.delete(path=f'{self.__PATH}/{application_name}')
+        return BasicResponse.from_dict(response_dict)
+
+    def get(self, application_name: str) -> 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`
+        """
+        response_dict = self.rest_client.get(path=f'{self.__PATH}/{application_name}')
+        return Application.from_dict(response_dict)
+
+    def get_status(self, application_name: str) -> 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`
+        """
+        response_dict = self.rest_client.get(path=f'{self.__PATH}/{application_name}/status')
+        return ApplicationStatus.from_dict(response_dict)
+
+    def modify(self, application_name: str, repository_url: str, path: str, revision: str) -> 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`
+        """
+        body = {'path': path, 'revision': revision, 'repository_url': repository_url}
+        response_dict = self.rest_client.patch(path=f'{self.__PATH}/{application_name}', body=body)
+        return BasicResponse.from_dict(response_dict)
+
+    def query(self) -> 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`
+        """
+        response_dict = self.rest_client.get(path=self.__PATH)
+        return ApplicationQueryResponse.from_dict(response_dict)
+
+    def refresh(self, application_name: str) -> 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`
+        """
+        response_dict = self.rest_client.post(path=f'{self.__PATH}/{application_name}/refresh')
+        return BasicResponse.from_dict(response_dict)

ai_core_sdk/resource_clients/docker_registry_secrets_client.py

@@ -0,0 +1,117 @@
+from ai_core_sdk.helpers import form_top_skip_params
+from ai_core_sdk.models import BasicResponse
+from ai_core_sdk.models.base_models import Message
+from ai_core_sdk.models.docker_registry_secret import DockerRegistrySecret
+from ai_core_sdk.models.docker_registry_secret_query_response import DockerRegistrySecretQueryResponse
+from ai_core_sdk.resource_clients import BaseClient
+
+
+class DockerRegistrySecretsClient(BaseClient):
+    """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`
+    """
+    __PATH = '/admin/dockerRegistrySecrets'
+
+    def create(self, name: str, data: dict) -> 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`
+        """
+        body = {'name': name, 'data': data}
+        response_dict = self.rest_client.post(path=f'{self.__PATH}', body=body)
+        return Message.from_dict(response_dict)
+
+    def delete(self, name: str) -> 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`
+        """
+        response_dict = self.rest_client.delete(path=f'{self.__PATH}/{name}')
+        return BasicResponse.from_dict(response_dict)
+
+    def get(self, name: str) -> 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`
+        """
+        response_dict = self.rest_client.get(path=f'{self.__PATH}/{name}')
+        return DockerRegistrySecret.from_dict(response_dict)
+
+    def modify(self, name: str, data: dict) -> 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`
+        """
+        body = {'data': data}
+        response_dict = self.rest_client.patch(path=f'{self.__PATH}/{name}', body=body)
+        return BasicResponse.from_dict(response_dict)
+
+    def query(self, top: int = None, skip: int = None) -> 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`
+        """
+        params = form_top_skip_params(top, skip)
+        response_dict = self.rest_client.get(path=f'{self.__PATH}', params=params)
+        return DockerRegistrySecretQueryResponse.from_dict(response_dict)

ai_core_sdk/resource_clients/internal_rest_client.py

@@ -0,0 +1,52 @@
+import os
+from ai_api_client_sdk.ai_api_v2_client import RestClient
+
+from ai_core_sdk.exception import AICoreSDKException
+from ai_core_sdk.helpers import is_within_aicore
+
+
+class InternalRestClient(RestClient):
+    """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.
+    """
+
+    def __init__(
+        self,
+        base_url=None,
+        get_token=None,
+        resource_group=None,
+        *args,
+        **kwargs,
+    ):
+        # Disallows parameters set by this class. This way this class must not be adjusted as the signiture of its parent class changes.
+        if base_url or get_token or resource_group:
+            raise AICoreSDKException(
+                "InternalRestClient should must not be called with base_url, get_token or resource_group"
+            )
+
+        if not is_within_aicore():
+            raise AICoreSDKException(
+                "Attempted to skip authentication even though SDK is not used within aicore"
+            )
+
+        api_base_url = os.getenv("AICORE_TRACKING_ENDPOINT")
+
+        # framing the base url of tracking endpoint
+        base_url = f"{api_base_url}/api/v1"
+
+        # dummy token creator function to be passed to rest client
+        def dummy_token_creator():
+            return ""
+
+        token_creator = dummy_token_creator
+
+        # resource group will be auto detected from the request going to tracking api from the training pod.
+        # Hence not passing the resource group id
+        resource_group = ""
+
+        super().__init__(
+            base_url=base_url,
+            get_token=token_creator,
+            resource_group=resource_group,
+            *args,
+            **kwargs,
+        )

ai_core_sdk/resource_clients/kpi_client.py

@@ -0,0 +1,26 @@
+from ai_core_sdk.models.kpi import Kpi
+from ai_core_sdk.resource_clients import BaseClient
+
+
+class KpiClient(BaseClient):
+    """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`
+    """
+    __PATH = '/analytics/kpis'
+
+    def query(self) -> 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`
+        """
+        response_dict = self.rest_client.get(path=f'{self.__PATH}')
+        return Kpi.from_dict(response_dict)

ai_core_sdk/resource_clients/metrics_client.py

@@ -0,0 +1,131 @@
+from typing import List
+
+from ai_core_sdk.models import Metric, MetricCustomInfo, MetricTag, MetricLabel
+from ai_core_sdk.resource_clients import MetricsClient
+
+from ai_core_sdk.exception import AICoreSDKException
+class MetricsCoreClient(MetricsClient):
+    """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`
+    """
+
+    def __init__(self, rest_client, execution_id: str = None) -> None:
+        super().__init__(rest_client)
+        self.execution_id = execution_id
+        self.rest_client = rest_client
+        self.metrics_path = '/metrics'
+
+    def modify(self, execution_id: str = '', metrics: List[Metric] = None, tags: List[MetricTag] = None,
+               custom_info: List[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
+        """
+        body = {'execution_id':  self.execution_id if self.execution_id else execution_id}
+        if metrics:
+            body['metrics'] = [metric.to_dict() for metric in metrics]
+        if tags:
+            body['tags'] = [tag.__dict__ for tag in tags]
+        if custom_info:
+            body['custom_info'] = [c_info.__dict__ for c_info in custom_info]
+
+        self.rest_client.patch(path=self.metrics_path, body=body, resource_group=resource_group)
+
+    def log_metrics(self, metrics: List[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
+        """
+        body = {'execution_id':  self.execution_id if self.execution_id else execution_id}
+        if artifact_name is not None:
+            if not isinstance(artifact_name, str):
+                raise AICoreSDKException('Artifact name of type string is expected')
+
+            artifact_label = {
+                'name': "metrics.ai.sap.com/Artifact.name",
+                'value': artifact_name
+            }
+
+            for metric in metrics:
+                if not metric.labels:
+                    metric.labels = [MetricLabel.from_dict(artifact_label)]
+                else:
+                    metric.labels.append(MetricLabel.from_dict(artifact_label))
+        if metrics:
+            body['metrics'] = [metric.to_dict() for metric in metrics]
+        self.rest_client.patch(path=self.metrics_path, body=body, resource_group=resource_group)
+
+    def set_custom_info(self, custom_info: List[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
+        """
+        body = {'execution_id':  self.execution_id if self.execution_id else execution_id}
+        if custom_info:
+            body['custom_info'] = [c_info.__dict__ for c_info in custom_info]
+        self.rest_client.patch(path=self.metrics_path, body=body, resource_group=resource_group)
+
+    def set_tags(self, tags: List[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
+        """
+        body = {'execution_id':  self.execution_id if self.execution_id else execution_id}
+        if tags:
+            body['tags'] = [tag.__dict__ for tag in tags]
+        self.rest_client.patch(path=self.metrics_path, body=body, resource_group=resource_group)