ai_core_sdk.resource_clients.kpi_client module

class ai_core_sdk.resource_clients.kpi_client.KpiClient(rest_client: RestClient)

Bases: BaseClient

KpiClient is a class implemented for interacting with the analytics kpi endpoint of the server. It implements the base class ai_api_client_sdk.resource_clients.base_client.BaseClient

query() → 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

Returns:

The retrieved KPI data

Return type:

class:ai_core_sdk.models.kpi.Kpi