ai_api_client_sdk.ai_api_v2_client module

class ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client(base_url: str, auth_url: str = None, client_id: str = None, client_secret: str = None, cert_str: str = None, key_str: str = None, cert_file_path: str = None, key_file_path: str = None, token_creator: Callable[[], str] = None, resource_group: str = None, connect_timeout=60, num_request_retries=3, **kwargs)

Bases: object

The AIAPIV2Client is the class implemented to interact with the AI API server. The user can use its attributes corresponding to the resources, for interacting with endpoints related to that resource. (i.e., aiapiv2client.scenario)

Parameters:

  • base_url (str) – Base URL of the AI API server. Should include the base path as well. (i.e., “<base_url>/scenarios” should work)

  • auth_url (str, optional) – URL of the authorization endpoint. Should be the full URL (including /oauth/token), defaults to None

  • client_id (str, optional) – client id to be used for authorization, defaults to None

  • client_secret (str, optional) – client secret to be used for authorization, defaults to None

  • cert_str (str, optional) – certificate file content, needs to be provided alongside the key_str parameter, defaults to None

  • key_str (str, optional) – key file content, needs to be provided alongside the cert_str parameter, defaults to None

  • cert_file_path (str, optional) – path to the certificate file, needs to be provided alongside the key_file_path parameter, defaults to None

  • key_file_path (str, optional) – path to the key file, needs to be provided alongside the cert_file_path parameter, defaults to None

  • token_creator (Callable[[], str], optional) – the function which returns the Bearer token, when called. Either this, or auth_url & client_id & client_secret should be specified, defaults to None

  • resource_group (str, optional) – The default resource group which will be used while sending the requests to the server. If not set, the resource_group should be specified with every request to the server, defaults to None

  • read_timeout (int) – Read timeout for requests in seconds, defaults to 60s

  • connect_timeout (int) – Connect timeout for requests in seconds, defaults to 60s

  • num_request_retries (int) – Number of retries for failing requests with http status code 429, 500, 502, 503 or 504, defaults to 60s

  • client_type (str) – Client type header to be sent in the request, defaults to ‘AI API Python SDK’

__init__(base_url: str, auth_url: str = None, client_id: str = None, client_secret: str = None, cert_str: str = None, key_str: str = None, cert_file_path: str = None, key_file_path: str = None, token_creator: Callable[[], str] = None, resource_group: str = None, connect_timeout=60, num_request_retries=3, **kwargs)