|
- Method resolution order:
- ScenarioClient
- ai_api_client_sdk.resource_clients.base_client.BaseClient
- builtins.object
Methods defined here:
- get(self, scenario_id: str, resource_group: str = None) -> ai_api_client_sdk.models.scenario.Scenario
- Retrieves the scenario from the server.
:param scenario_id: ID of the scenario to be retrieved
:type scenario_id: str
:param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
resource group in the :class:`ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client` should be specified,
defaults to None
:type resource_group: str
: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
:return: The retrieved scenario
:rtype: class:`ai_api_client_sdk.models.scenario.Scenario`
- query(self, only_llm_scenarios: bool = False, resource_group: str = None) -> ai_api_client_sdk.models.scenario_query_response.ScenarioQueryResponse
- Queries the scenarios.
:param only_llm_scenarios: indicates whether to query for LLM scenarios only, defaults to False
:type only_llm_scenarios: bool, optional
:param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
resource group in the :class:`ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client` should be specified,
defaults to None
:type resource_group: str
: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
:return: An object representing the response from the server
:rtype: class:`ai_api_client_sdk.models.scenario_query_response.ScenarioQueryResponse`
- query_llm_scenarios(self, resource_group: str = None) -> ai_api_client_sdk.models.scenario_query_response.ScenarioQueryResponse
- Queries for the LLM scenarios.
:param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
resource group in the :class:`ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client` should be specified,
defaults to None
:type resource_group: str
: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
:raises: class:`ai_api_client_sdk.exception.AIAPIRequestException` if an unexpected exception occurs while
trying to send a request to the server
:return: An object representing the response from the server
:rtype: class:`ai_api_client_sdk.models.scenario_query_response.ScenarioQueryResponse`
- query_versions(self, scenario_id: str, label_selector: List[str] = None, resource_group: str = None) -> ai_api_client_sdk.models.version_query_response.VersionQueryResponse
- Queries the versions.
:param scenario_id: ID of the scenario, the versions should belong to
:type scenario_id: str
:param label_selector: list of the label selector strings in the form of "key=value" or "key!=value", to filter
the scenarios with respect to their labels, defaults to None
:type label_selector: List[str], optional
:param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
resource group in the :class:`ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client` should be specified,
defaults to None
:type resource_group: str
: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
:return: An object representing the response from the server
:rtype: class:`ai_api_client_sdk.models.scenario_query_response.ScenarioQueryResponse`
Methods inherited from ai_api_client_sdk.resource_clients.base_client.BaseClient:
- __init__(self, rest_client: ai_api_client_sdk.helpers.rest_client.RestClient)
- Initialize self. See help(type(self)) for accurate signature.
- bulk_modify(self, *args, **kwargs)
- Modifies multiple instances of the relevant resource. Will be implemented by the respective resource clients
- count(self, *args, **kwargs)
- Counts the relevant resources. Will be implemented by the respective resource clients
- create(self, *args, **kwargs)
- Creates the relevant resource. Will be implemented by the respective resource clients
- delete(self, *args, **kwargs)
- Deletes the relevant resource. Will be implemented by the respective resource clients
- modify(self, *args, **kwargs)
- Modifies the relevant resource. Will be implemented by the respective resource clients
- query_logs(self, *args, **kwargs)
- Queries the relevant logs. Will be implemented by the respective resource clients
Data descriptors inherited from ai_api_client_sdk.resource_clients.base_client.BaseClient:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
|