Module mailslurp_client.models.ai_message_result
MailSlurp API
MailSlurp is an API for sending and receiving emails and SMS from dynamically allocated email addresses and phone numbers. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - Homepage - Get an API KEY - Generated SDK Clients - Examples repository # noqa: E501
The version of the OpenAPI document: 6.5.2 Contact: contact@mailslurp.dev Generated by: https://openapi-generator.tech
Classes
class AIMessageResult (evaluation_id=None, status=None, summary=None, model=None, usage=None, elapsed_ms=None, message=None, email=None, sms=None, match=None, assertion_status=None, assertions=None, data=None, extraction_evidence=None, candidates=None, extraction_reason=None, successful=None, failed_assertion_ids=None, local_vars_configuration=None)-
NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
AIMessageResult - a model defined in OpenAPI
Expand source code
class AIMessageResult(object): """NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech Do not edit the class manually. """ """ Attributes: openapi_types (dict): The key is attribute name and the value is attribute type. attribute_map (dict): The key is attribute name and the value is json key in definition. """ openapi_types = { 'evaluation_id': 'str', 'status': 'str', 'summary': 'str', 'model': 'AIMessageModelDto', 'usage': 'AIMessageUsage', 'elapsed_ms': 'int', 'message': 'AIMessageReference', 'email': 'Email', 'sms': 'SmsDto', 'match': 'AIMessageMatchResult', 'assertion_status': 'str', 'assertions': 'list[AIMessageAssertionResult]', 'data': 'object', 'extraction_evidence': 'dict(str, list[AIMessageEvidence])', 'candidates': 'list[AIMessageCandidateResult]', 'extraction_reason': 'str', 'successful': 'bool', 'failed_assertion_ids': 'list[str]' } attribute_map = { 'evaluation_id': 'evaluationId', 'status': 'status', 'summary': 'summary', 'model': 'model', 'usage': 'usage', 'elapsed_ms': 'elapsedMs', 'message': 'message', 'email': 'email', 'sms': 'sms', 'match': 'match', 'assertion_status': 'assertionStatus', 'assertions': 'assertions', 'data': 'data', 'extraction_evidence': 'extractionEvidence', 'candidates': 'candidates', 'extraction_reason': 'extractionReason', 'successful': 'successful', 'failed_assertion_ids': 'failedAssertionIds' } def __init__(self, evaluation_id=None, status=None, summary=None, model=None, usage=None, elapsed_ms=None, message=None, email=None, sms=None, match=None, assertion_status=None, assertions=None, data=None, extraction_evidence=None, candidates=None, extraction_reason=None, successful=None, failed_assertion_ids=None, local_vars_configuration=None): # noqa: E501 """AIMessageResult - a model defined in OpenAPI""" # noqa: E501 if local_vars_configuration is None: local_vars_configuration = Configuration() self.local_vars_configuration = local_vars_configuration self._evaluation_id = None self._status = None self._summary = None self._model = None self._usage = None self._elapsed_ms = None self._message = None self._email = None self._sms = None self._match = None self._assertion_status = None self._assertions = None self._data = None self._extraction_evidence = None self._candidates = None self._extraction_reason = None self._successful = None self._failed_assertion_ids = None self.discriminator = None self.evaluation_id = evaluation_id self.status = status self.summary = summary self.model = model self.usage = usage self.elapsed_ms = elapsed_ms self.message = message self.email = email self.sms = sms self.match = match self.assertion_status = assertion_status self.assertions = assertions self.data = data self.extraction_evidence = extraction_evidence self.candidates = candidates self.extraction_reason = extraction_reason self.successful = successful self.failed_assertion_ids = failed_assertion_ids @property def evaluation_id(self): """Gets the evaluation_id of this AIMessageResult. # noqa: E501 :return: The evaluation_id of this AIMessageResult. # noqa: E501 :rtype: str """ return self._evaluation_id @evaluation_id.setter def evaluation_id(self, evaluation_id): """Sets the evaluation_id of this AIMessageResult. :param evaluation_id: The evaluation_id of this AIMessageResult. # noqa: E501 :type: str """ if self.local_vars_configuration.client_side_validation and evaluation_id is None: # noqa: E501 raise ValueError("Invalid value for `evaluation_id`, must not be `None`") # noqa: E501 self._evaluation_id = evaluation_id @property def status(self): """Gets the status of this AIMessageResult. # noqa: E501 :return: The status of this AIMessageResult. # noqa: E501 :rtype: str """ return self._status @status.setter def status(self, status): """Sets the status of this AIMessageResult. :param status: The status of this AIMessageResult. # noqa: E501 :type: str """ if self.local_vars_configuration.client_side_validation and status is None: # noqa: E501 raise ValueError("Invalid value for `status`, must not be `None`") # noqa: E501 allowed_values = ["MATCHED", "PASS", "FAIL", "EXTRACTED", "INCONCLUSIVE", "TIMED_OUT", "TOKEN_LIMIT", "CANDIDATE_LIMIT", "PROVIDER_ERROR", "PROVIDER_TIMEOUT", "INVALID_OUTPUT"] # noqa: E501 if self.local_vars_configuration.client_side_validation and status not in allowed_values: # noqa: E501 raise ValueError( "Invalid value for `status` ({0}), must be one of {1}" # noqa: E501 .format(status, allowed_values) ) self._status = status @property def summary(self): """Gets the summary of this AIMessageResult. # noqa: E501 :return: The summary of this AIMessageResult. # noqa: E501 :rtype: str """ return self._summary @summary.setter def summary(self, summary): """Sets the summary of this AIMessageResult. :param summary: The summary of this AIMessageResult. # noqa: E501 :type: str """ if self.local_vars_configuration.client_side_validation and summary is None: # noqa: E501 raise ValueError("Invalid value for `summary`, must not be `None`") # noqa: E501 self._summary = summary @property def model(self): """Gets the model of this AIMessageResult. # noqa: E501 :return: The model of this AIMessageResult. # noqa: E501 :rtype: AIMessageModelDto """ return self._model @model.setter def model(self, model): """Sets the model of this AIMessageResult. :param model: The model of this AIMessageResult. # noqa: E501 :type: AIMessageModelDto """ if self.local_vars_configuration.client_side_validation and model is None: # noqa: E501 raise ValueError("Invalid value for `model`, must not be `None`") # noqa: E501 self._model = model @property def usage(self): """Gets the usage of this AIMessageResult. # noqa: E501 :return: The usage of this AIMessageResult. # noqa: E501 :rtype: AIMessageUsage """ return self._usage @usage.setter def usage(self, usage): """Sets the usage of this AIMessageResult. :param usage: The usage of this AIMessageResult. # noqa: E501 :type: AIMessageUsage """ if self.local_vars_configuration.client_side_validation and usage is None: # noqa: E501 raise ValueError("Invalid value for `usage`, must not be `None`") # noqa: E501 self._usage = usage @property def elapsed_ms(self): """Gets the elapsed_ms of this AIMessageResult. # noqa: E501 :return: The elapsed_ms of this AIMessageResult. # noqa: E501 :rtype: int """ return self._elapsed_ms @elapsed_ms.setter def elapsed_ms(self, elapsed_ms): """Sets the elapsed_ms of this AIMessageResult. :param elapsed_ms: The elapsed_ms of this AIMessageResult. # noqa: E501 :type: int """ if self.local_vars_configuration.client_side_validation and elapsed_ms is None: # noqa: E501 raise ValueError("Invalid value for `elapsed_ms`, must not be `None`") # noqa: E501 self._elapsed_ms = elapsed_ms @property def message(self): """Gets the message of this AIMessageResult. # noqa: E501 :return: The message of this AIMessageResult. # noqa: E501 :rtype: AIMessageReference """ return self._message @message.setter def message(self, message): """Sets the message of this AIMessageResult. :param message: The message of this AIMessageResult. # noqa: E501 :type: AIMessageReference """ self._message = message @property def email(self): """Gets the email of this AIMessageResult. # noqa: E501 :return: The email of this AIMessageResult. # noqa: E501 :rtype: Email """ return self._email @email.setter def email(self, email): """Sets the email of this AIMessageResult. :param email: The email of this AIMessageResult. # noqa: E501 :type: Email """ self._email = email @property def sms(self): """Gets the sms of this AIMessageResult. # noqa: E501 :return: The sms of this AIMessageResult. # noqa: E501 :rtype: SmsDto """ return self._sms @sms.setter def sms(self, sms): """Sets the sms of this AIMessageResult. :param sms: The sms of this AIMessageResult. # noqa: E501 :type: SmsDto """ self._sms = sms @property def match(self): """Gets the match of this AIMessageResult. # noqa: E501 :return: The match of this AIMessageResult. # noqa: E501 :rtype: AIMessageMatchResult """ return self._match @match.setter def match(self, match): """Sets the match of this AIMessageResult. :param match: The match of this AIMessageResult. # noqa: E501 :type: AIMessageMatchResult """ self._match = match @property def assertion_status(self): """Gets the assertion_status of this AIMessageResult. # noqa: E501 :return: The assertion_status of this AIMessageResult. # noqa: E501 :rtype: str """ return self._assertion_status @assertion_status.setter def assertion_status(self, assertion_status): """Sets the assertion_status of this AIMessageResult. :param assertion_status: The assertion_status of this AIMessageResult. # noqa: E501 :type: str """ allowed_values = [None,"PASS", "FAIL", "INCONCLUSIVE"] # noqa: E501 if self.local_vars_configuration.client_side_validation and assertion_status not in allowed_values: # noqa: E501 raise ValueError( "Invalid value for `assertion_status` ({0}), must be one of {1}" # noqa: E501 .format(assertion_status, allowed_values) ) self._assertion_status = assertion_status @property def assertions(self): """Gets the assertions of this AIMessageResult. # noqa: E501 :return: The assertions of this AIMessageResult. # noqa: E501 :rtype: list[AIMessageAssertionResult] """ return self._assertions @assertions.setter def assertions(self, assertions): """Sets the assertions of this AIMessageResult. :param assertions: The assertions of this AIMessageResult. # noqa: E501 :type: list[AIMessageAssertionResult] """ if self.local_vars_configuration.client_side_validation and assertions is None: # noqa: E501 raise ValueError("Invalid value for `assertions`, must not be `None`") # noqa: E501 self._assertions = assertions @property def data(self): """Gets the data of this AIMessageResult. # noqa: E501 Extracted JSON value conforming to the requested schema or extraction preset. Null when extraction is inconclusive or unavailable. # noqa: E501 :return: The data of this AIMessageResult. # noqa: E501 :rtype: object """ return self._data @data.setter def data(self, data): """Sets the data of this AIMessageResult. Extracted JSON value conforming to the requested schema or extraction preset. Null when extraction is inconclusive or unavailable. # noqa: E501 :param data: The data of this AIMessageResult. # noqa: E501 :type: object """ self._data = data @property def extraction_evidence(self): """Gets the extraction_evidence of this AIMessageResult. # noqa: E501 :return: The extraction_evidence of this AIMessageResult. # noqa: E501 :rtype: dict(str, list[AIMessageEvidence]) """ return self._extraction_evidence @extraction_evidence.setter def extraction_evidence(self, extraction_evidence): """Sets the extraction_evidence of this AIMessageResult. :param extraction_evidence: The extraction_evidence of this AIMessageResult. # noqa: E501 :type: dict(str, list[AIMessageEvidence]) """ if self.local_vars_configuration.client_side_validation and extraction_evidence is None: # noqa: E501 raise ValueError("Invalid value for `extraction_evidence`, must not be `None`") # noqa: E501 self._extraction_evidence = extraction_evidence @property def candidates(self): """Gets the candidates of this AIMessageResult. # noqa: E501 :return: The candidates of this AIMessageResult. # noqa: E501 :rtype: list[AIMessageCandidateResult] """ return self._candidates @candidates.setter def candidates(self, candidates): """Sets the candidates of this AIMessageResult. :param candidates: The candidates of this AIMessageResult. # noqa: E501 :type: list[AIMessageCandidateResult] """ if self.local_vars_configuration.client_side_validation and candidates is None: # noqa: E501 raise ValueError("Invalid value for `candidates`, must not be `None`") # noqa: E501 self._candidates = candidates @property def extraction_reason(self): """Gets the extraction_reason of this AIMessageResult. # noqa: E501 Explanation when extraction is inconclusive. May contain a model-reported explanation of missing or ambiguous fields, or a server evidence-validation failure. Diagnostic text, not a stable machine-readable status. # noqa: E501 :return: The extraction_reason of this AIMessageResult. # noqa: E501 :rtype: str """ return self._extraction_reason @extraction_reason.setter def extraction_reason(self, extraction_reason): """Sets the extraction_reason of this AIMessageResult. Explanation when extraction is inconclusive. May contain a model-reported explanation of missing or ambiguous fields, or a server evidence-validation failure. Diagnostic text, not a stable machine-readable status. # noqa: E501 :param extraction_reason: The extraction_reason of this AIMessageResult. # noqa: E501 :type: str """ self._extraction_reason = extraction_reason @property def successful(self): """Gets the successful of this AIMessageResult. # noqa: E501 True only when all requested work succeeded. Assert this in tests and use summary as the assertion failure message. # noqa: E501 :return: The successful of this AIMessageResult. # noqa: E501 :rtype: bool """ return self._successful @successful.setter def successful(self, successful): """Sets the successful of this AIMessageResult. True only when all requested work succeeded. Assert this in tests and use summary as the assertion failure message. # noqa: E501 :param successful: The successful of this AIMessageResult. # noqa: E501 :type: bool """ if self.local_vars_configuration.client_side_validation and successful is None: # noqa: E501 raise ValueError("Invalid value for `successful`, must not be `None`") # noqa: E501 self._successful = successful @property def failed_assertion_ids(self): """Gets the failed_assertion_ids of this AIMessageResult. # noqa: E501 :return: The failed_assertion_ids of this AIMessageResult. # noqa: E501 :rtype: list[str] """ return self._failed_assertion_ids @failed_assertion_ids.setter def failed_assertion_ids(self, failed_assertion_ids): """Sets the failed_assertion_ids of this AIMessageResult. :param failed_assertion_ids: The failed_assertion_ids of this AIMessageResult. # noqa: E501 :type: list[str] """ if self.local_vars_configuration.client_side_validation and failed_assertion_ids is None: # noqa: E501 raise ValueError("Invalid value for `failed_assertion_ids`, must not be `None`") # noqa: E501 self._failed_assertion_ids = failed_assertion_ids def to_dict(self): """Returns the model properties as a dict""" result = {} for attr, _ in six.iteritems(self.openapi_types): value = getattr(self, attr) if isinstance(value, list): result[attr] = list(map( lambda x: x.to_dict() if hasattr(x, "to_dict") else x, value )) elif hasattr(value, "to_dict"): result[attr] = value.to_dict() elif isinstance(value, dict): result[attr] = dict(map( lambda item: (item[0], item[1].to_dict()) if hasattr(item[1], "to_dict") else item, value.items() )) else: result[attr] = value return result def to_str(self): """Returns the string representation of the model""" return pprint.pformat(self.to_dict()) def __repr__(self): """For `print` and `pprint`""" return self.to_str() def __eq__(self, other): """Returns true if both objects are equal""" if not isinstance(other, AIMessageResult): return False return self.to_dict() == other.to_dict() def __ne__(self, other): """Returns true if both objects are not equal""" if not isinstance(other, AIMessageResult): return True return self.to_dict() != other.to_dict()Class variables
var attribute_mapvar openapi_types
Instance variables
prop assertion_status-
Gets the assertion_status of this AIMessageResult. # noqa: E501
:return: The assertion_status of this AIMessageResult. # noqa: E501 :rtype: str
Expand source code
@property def assertion_status(self): """Gets the assertion_status of this AIMessageResult. # noqa: E501 :return: The assertion_status of this AIMessageResult. # noqa: E501 :rtype: str """ return self._assertion_status prop assertions-
Gets the assertions of this AIMessageResult. # noqa: E501
:return: The assertions of this AIMessageResult. # noqa: E501 :rtype: list[AIMessageAssertionResult]
Expand source code
@property def assertions(self): """Gets the assertions of this AIMessageResult. # noqa: E501 :return: The assertions of this AIMessageResult. # noqa: E501 :rtype: list[AIMessageAssertionResult] """ return self._assertions prop candidates-
Gets the candidates of this AIMessageResult. # noqa: E501
:return: The candidates of this AIMessageResult. # noqa: E501 :rtype: list[AIMessageCandidateResult]
Expand source code
@property def candidates(self): """Gets the candidates of this AIMessageResult. # noqa: E501 :return: The candidates of this AIMessageResult. # noqa: E501 :rtype: list[AIMessageCandidateResult] """ return self._candidates prop data-
Gets the data of this AIMessageResult. # noqa: E501
Extracted JSON value conforming to the requested schema or extraction preset. Null when extraction is inconclusive or unavailable. # noqa: E501
:return: The data of this AIMessageResult. # noqa: E501 :rtype: object
Expand source code
@property def data(self): """Gets the data of this AIMessageResult. # noqa: E501 Extracted JSON value conforming to the requested schema or extraction preset. Null when extraction is inconclusive or unavailable. # noqa: E501 :return: The data of this AIMessageResult. # noqa: E501 :rtype: object """ return self._data prop elapsed_ms-
Gets the elapsed_ms of this AIMessageResult. # noqa: E501
:return: The elapsed_ms of this AIMessageResult. # noqa: E501 :rtype: int
Expand source code
@property def elapsed_ms(self): """Gets the elapsed_ms of this AIMessageResult. # noqa: E501 :return: The elapsed_ms of this AIMessageResult. # noqa: E501 :rtype: int """ return self._elapsed_ms prop email-
Gets the email of this AIMessageResult. # noqa: E501
:return: The email of this AIMessageResult. # noqa: E501 :rtype: Email
Expand source code
@property def email(self): """Gets the email of this AIMessageResult. # noqa: E501 :return: The email of this AIMessageResult. # noqa: E501 :rtype: Email """ return self._email prop evaluation_id-
Gets the evaluation_id of this AIMessageResult. # noqa: E501
:return: The evaluation_id of this AIMessageResult. # noqa: E501 :rtype: str
Expand source code
@property def evaluation_id(self): """Gets the evaluation_id of this AIMessageResult. # noqa: E501 :return: The evaluation_id of this AIMessageResult. # noqa: E501 :rtype: str """ return self._evaluation_id prop extraction_evidence-
Gets the extraction_evidence of this AIMessageResult. # noqa: E501
:return: The extraction_evidence of this AIMessageResult. # noqa: E501 :rtype: dict(str, list[AIMessageEvidence])
Expand source code
@property def extraction_evidence(self): """Gets the extraction_evidence of this AIMessageResult. # noqa: E501 :return: The extraction_evidence of this AIMessageResult. # noqa: E501 :rtype: dict(str, list[AIMessageEvidence]) """ return self._extraction_evidence prop extraction_reason-
Gets the extraction_reason of this AIMessageResult. # noqa: E501
Explanation when extraction is inconclusive. May contain a model-reported explanation of missing or ambiguous fields, or a server evidence-validation failure. Diagnostic text, not a stable machine-readable status. # noqa: E501
:return: The extraction_reason of this AIMessageResult. # noqa: E501 :rtype: str
Expand source code
@property def extraction_reason(self): """Gets the extraction_reason of this AIMessageResult. # noqa: E501 Explanation when extraction is inconclusive. May contain a model-reported explanation of missing or ambiguous fields, or a server evidence-validation failure. Diagnostic text, not a stable machine-readable status. # noqa: E501 :return: The extraction_reason of this AIMessageResult. # noqa: E501 :rtype: str """ return self._extraction_reason prop failed_assertion_ids-
Gets the failed_assertion_ids of this AIMessageResult. # noqa: E501
:return: The failed_assertion_ids of this AIMessageResult. # noqa: E501 :rtype: list[str]
Expand source code
@property def failed_assertion_ids(self): """Gets the failed_assertion_ids of this AIMessageResult. # noqa: E501 :return: The failed_assertion_ids of this AIMessageResult. # noqa: E501 :rtype: list[str] """ return self._failed_assertion_ids prop match-
Gets the match of this AIMessageResult. # noqa: E501
:return: The match of this AIMessageResult. # noqa: E501 :rtype: AIMessageMatchResult
Expand source code
@property def match(self): """Gets the match of this AIMessageResult. # noqa: E501 :return: The match of this AIMessageResult. # noqa: E501 :rtype: AIMessageMatchResult """ return self._match prop message-
Gets the message of this AIMessageResult. # noqa: E501
:return: The message of this AIMessageResult. # noqa: E501 :rtype: AIMessageReference
Expand source code
@property def message(self): """Gets the message of this AIMessageResult. # noqa: E501 :return: The message of this AIMessageResult. # noqa: E501 :rtype: AIMessageReference """ return self._message prop model-
Gets the model of this AIMessageResult. # noqa: E501
:return: The model of this AIMessageResult. # noqa: E501 :rtype: AIMessageModelDto
Expand source code
@property def model(self): """Gets the model of this AIMessageResult. # noqa: E501 :return: The model of this AIMessageResult. # noqa: E501 :rtype: AIMessageModelDto """ return self._model prop sms-
Gets the sms of this AIMessageResult. # noqa: E501
:return: The sms of this AIMessageResult. # noqa: E501 :rtype: SmsDto
Expand source code
@property def sms(self): """Gets the sms of this AIMessageResult. # noqa: E501 :return: The sms of this AIMessageResult. # noqa: E501 :rtype: SmsDto """ return self._sms prop status-
Gets the status of this AIMessageResult. # noqa: E501
:return: The status of this AIMessageResult. # noqa: E501 :rtype: str
Expand source code
@property def status(self): """Gets the status of this AIMessageResult. # noqa: E501 :return: The status of this AIMessageResult. # noqa: E501 :rtype: str """ return self._status prop successful-
Gets the successful of this AIMessageResult. # noqa: E501
True only when all requested work succeeded. Assert this in tests and use summary as the assertion failure message. # noqa: E501
:return: The successful of this AIMessageResult. # noqa: E501 :rtype: bool
Expand source code
@property def successful(self): """Gets the successful of this AIMessageResult. # noqa: E501 True only when all requested work succeeded. Assert this in tests and use summary as the assertion failure message. # noqa: E501 :return: The successful of this AIMessageResult. # noqa: E501 :rtype: bool """ return self._successful prop summary-
Gets the summary of this AIMessageResult. # noqa: E501
:return: The summary of this AIMessageResult. # noqa: E501 :rtype: str
Expand source code
@property def summary(self): """Gets the summary of this AIMessageResult. # noqa: E501 :return: The summary of this AIMessageResult. # noqa: E501 :rtype: str """ return self._summary prop usage-
Gets the usage of this AIMessageResult. # noqa: E501
:return: The usage of this AIMessageResult. # noqa: E501 :rtype: AIMessageUsage
Expand source code
@property def usage(self): """Gets the usage of this AIMessageResult. # noqa: E501 :return: The usage of this AIMessageResult. # noqa: E501 :rtype: AIMessageUsage """ return self._usage
Methods
def to_dict(self)-
Returns the model properties as a dict
def to_str(self)-
Returns the string representation of the model