Module mailslurp_client.models.ai_message_usage

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 AIMessageUsage (tokens=None, candidates_evaluated=None, complete=None, reserved_tokens=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.

AIMessageUsage - a model defined in OpenAPI

Expand source code

class AIMessageUsage(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 = {
        'tokens': 'int',
        'candidates_evaluated': 'int',
        'complete': 'bool',
        'reserved_tokens': 'int'
    }

    attribute_map = {
        'tokens': 'tokens',
        'candidates_evaluated': 'candidatesEvaluated',
        'complete': 'complete',
        'reserved_tokens': 'reservedTokens'
    }

    def __init__(self, tokens=None, candidates_evaluated=None, complete=None, reserved_tokens=None, local_vars_configuration=None):  # noqa: E501
        """AIMessageUsage - 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._tokens = None
        self._candidates_evaluated = None
        self._complete = None
        self._reserved_tokens = None
        self.discriminator = None

        self.tokens = tokens
        self.candidates_evaluated = candidates_evaluated
        self.complete = complete
        self.reserved_tokens = reserved_tokens

    @property
    def tokens(self):
        """Gets the tokens of this AIMessageUsage.  # noqa: E501

        Consumed MailSlurp AI tokens after applying the model multiplier. These are not raw provider tokens.  # noqa: E501

        :return: The tokens of this AIMessageUsage.  # noqa: E501
        :rtype: int
        """
        return self._tokens

    @tokens.setter
    def tokens(self, tokens):
        """Sets the tokens of this AIMessageUsage.

        Consumed MailSlurp AI tokens after applying the model multiplier. These are not raw provider tokens.  # noqa: E501

        :param tokens: The tokens of this AIMessageUsage.  # noqa: E501
        :type: int
        """
        if self.local_vars_configuration.client_side_validation and tokens is None:  # noqa: E501
            raise ValueError("Invalid value for `tokens`, must not be `None`")  # noqa: E501

        self._tokens = tokens

    @property
    def candidates_evaluated(self):
        """Gets the candidates_evaluated of this AIMessageUsage.  # noqa: E501


        :return: The candidates_evaluated of this AIMessageUsage.  # noqa: E501
        :rtype: int
        """
        return self._candidates_evaluated

    @candidates_evaluated.setter
    def candidates_evaluated(self, candidates_evaluated):
        """Sets the candidates_evaluated of this AIMessageUsage.


        :param candidates_evaluated: The candidates_evaluated of this AIMessageUsage.  # noqa: E501
        :type: int
        """
        if self.local_vars_configuration.client_side_validation and candidates_evaluated is None:  # noqa: E501
            raise ValueError("Invalid value for `candidates_evaluated`, must not be `None`")  # noqa: E501

        self._candidates_evaluated = candidates_evaluated

    @property
    def complete(self):
        """Gets the complete of this AIMessageUsage.  # noqa: E501

        False when a timed-out provider invocation is still settling. The reservation remains held and actual usage is settled when it finishes.  # noqa: E501

        :return: The complete of this AIMessageUsage.  # noqa: E501
        :rtype: bool
        """
        return self._complete

    @complete.setter
    def complete(self, complete):
        """Sets the complete of this AIMessageUsage.

        False when a timed-out provider invocation is still settling. The reservation remains held and actual usage is settled when it finishes.  # noqa: E501

        :param complete: The complete of this AIMessageUsage.  # noqa: E501
        :type: bool
        """
        if self.local_vars_configuration.client_side_validation and complete is None:  # noqa: E501
            raise ValueError("Invalid value for `complete`, must not be `None`")  # noqa: E501

        self._complete = complete

    @property
    def reserved_tokens(self):
        """Gets the reserved_tokens of this AIMessageUsage.  # noqa: E501

        AI tokens held for provider attempts with unknown usage. Excluded from tokens; complete remains false until reconciliation.  # noqa: E501

        :return: The reserved_tokens of this AIMessageUsage.  # noqa: E501
        :rtype: int
        """
        return self._reserved_tokens

    @reserved_tokens.setter
    def reserved_tokens(self, reserved_tokens):
        """Sets the reserved_tokens of this AIMessageUsage.

        AI tokens held for provider attempts with unknown usage. Excluded from tokens; complete remains false until reconciliation.  # noqa: E501

        :param reserved_tokens: The reserved_tokens of this AIMessageUsage.  # noqa: E501
        :type: int
        """
        if self.local_vars_configuration.client_side_validation and reserved_tokens is None:  # noqa: E501
            raise ValueError("Invalid value for `reserved_tokens`, must not be `None`")  # noqa: E501

        self._reserved_tokens = reserved_tokens

    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, AIMessageUsage):
            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, AIMessageUsage):
            return True

        return self.to_dict() != other.to_dict()

Class variables

var attribute_map

var openapi_types

Instance variables

prop candidates_evaluated

Gets the candidates_evaluated of this AIMessageUsage. # noqa: E501

:return: The candidates_evaluated of this AIMessageUsage. # noqa: E501 :rtype: int

Expand source code

@property
def candidates_evaluated(self):
    """Gets the candidates_evaluated of this AIMessageUsage.  # noqa: E501


    :return: The candidates_evaluated of this AIMessageUsage.  # noqa: E501
    :rtype: int
    """
    return self._candidates_evaluated

prop complete

Gets the complete of this AIMessageUsage. # noqa: E501

False when a timed-out provider invocation is still settling. The reservation remains held and actual usage is settled when it finishes. # noqa: E501

:return: The complete of this AIMessageUsage. # noqa: E501 :rtype: bool

Expand source code

@property
def complete(self):
    """Gets the complete of this AIMessageUsage.  # noqa: E501

    False when a timed-out provider invocation is still settling. The reservation remains held and actual usage is settled when it finishes.  # noqa: E501

    :return: The complete of this AIMessageUsage.  # noqa: E501
    :rtype: bool
    """
    return self._complete

prop reserved_tokens

Gets the reserved_tokens of this AIMessageUsage. # noqa: E501

AI tokens held for provider attempts with unknown usage. Excluded from tokens; complete remains false until reconciliation. # noqa: E501

:return: The reserved_tokens of this AIMessageUsage. # noqa: E501 :rtype: int

Expand source code

@property
def reserved_tokens(self):
    """Gets the reserved_tokens of this AIMessageUsage.  # noqa: E501

    AI tokens held for provider attempts with unknown usage. Excluded from tokens; complete remains false until reconciliation.  # noqa: E501

    :return: The reserved_tokens of this AIMessageUsage.  # noqa: E501
    :rtype: int
    """
    return self._reserved_tokens

prop tokens

Gets the tokens of this AIMessageUsage. # noqa: E501

Consumed MailSlurp AI tokens after applying the model multiplier. These are not raw provider tokens. # noqa: E501

:return: The tokens of this AIMessageUsage. # noqa: E501 :rtype: int

Expand source code

@property
def tokens(self):
    """Gets the tokens of this AIMessageUsage.  # noqa: E501

    Consumed MailSlurp AI tokens after applying the model multiplier. These are not raw provider tokens.  # noqa: E501

    :return: The tokens of this AIMessageUsage.  # noqa: E501
    :rtype: int
    """
    return self._tokens

Methods

def to_dict(self)

Returns the model properties as a dict

def to_str(self)

Returns the string representation of the model