ai_api_client_sdk.resource_clients.healthz_client module

class ai_api_client_sdk.resource_clients.healthz_client.HealthzClient(rest_client: RestClient)

Bases: BaseClient

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

get() 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

Returns:

The health status of the server

Return type:

class:ai_api_client_sdk.models.healthz_status.HealthzStatus