ai_api_client_sdk.models.scenario module

class ai_api_client_sdk.models.scenario.Scenario(id: str, created_at: datetime, modified_at: datetime, name: str, description: str = None, labels: List[Label] = None, **kwargs)

Bases: object

The Scenario object defines a scenario :param id: ID of the scenario :type id: str :param created_at: Time when the scenario was created :type created_at: datetime :param modified_at: Time when the scenario was last modified :type modified_at: datetime :param name: Name of the scenario :type name: str :param description: Description of the scenario, defaults to None :type description: str, optional :param labels: List of the labels of the scenario, defaults to None :type labels: List[class:ai_api_client_sdk.models.label.Label] :param **kwargs: The keyword arguments are there in case there are additional attributes returned from server

__init__(id: str, created_at: datetime, modified_at: datetime, name: str, description: str = None, labels: List[Label] = None, **kwargs)

static from_dict(scenario_dict: Dict[str, Any])

Returns a ai_api_client_sdk.models.scenario.Scenario object, created from the values in the dict provided as parameter

Parameters:

scenario_dict (Dict[str, Any]) – Dict which includes the necessary values to create the object

Returns:

An object, created from the values provided

Return type:

class:ai_api_client_sdk.models.scenario.Scenario

is_llm_scenario()

Returns if the scenario is a LLM scenario or not

Returns:

True if scenario is llm scenario, False otherwise

Return type:

bool