ai_api_client_sdk.resource_clients.model_client module

class ai_api_client_sdk.resource_clients.model_client.ModelClient(rest_client: RestClient)

Bases: BaseClient

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

DEFAULT_SCENARIO_ID = 'foundation-models'
query(resource_group: str = None) ModelQueryResponse

Queries the models.

Parameters:

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.executable_query_response.ModelQueryResponse