ai_api_client_sdk.resource_clients.metrics_client module

class ai_api_client_sdk.resource_clients.metrics_client.MetricsClient(rest_client: RestClient)

Bases: BaseClient

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

query(filter: str = None, execution_ids: List[str] = None, select: List[str] = None, resource_group: str = None) → MetricsQueryResponse

Queries the metrics.

Parameters:

  • filter (str, optional) – Deprecated. Use parameter execution_ids instead. A filter expression that filters the metric resources using execution IDs. User can only use in, eq operators in filter expression, defaults to None

  • execution_ids (List[str], optional) – IDs of the executions, of which the metrics should be retrieved, defaults to None

  • select (List[str], optional) – Values of select can be metrics,tags,customInfo or any of the combinations of these or *. Can be used to select(project) only the resources specified

  • resource_group (str) – Resource Group which the request should be sent on behalf. Either this or a default resource group in the ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client should be specified, defaults to None

Raises:

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

Raises:

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

Raises:

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

Returns:

An object representing the response from the server

Return type:

class:ai_api_client_sdk.models.metrics_query_response.MetricsQueryResponse

delete(execution_id: str, resource_group: str = None) → None

Deletes the metrics.

Parameters:

  • execution_id (str) – ID of the execution, of which the metrics should be deleted.

  • resource_group (str) – Resource Group which the request should be sent on behalf. Either this or a default resource group in the ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client should be specified, defaults to None

Raises:

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

Raises:

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

Raises:

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

Raises:

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