oci 2.129.3__py3-none-any.whl → 2.130.0__py3-none-any.whl

oci/ai_speech/models/pronunciation.py

@@ -0,0 +1,99 @@
+# coding: utf-8
+# Copyright (c) 2016, 2024, Oracle and/or its affiliates.  All rights reserved.
+# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
+
+# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20220101
+
+
+from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel  # noqa: F401
+from oci.decorators import init_model_state_from_kwargs
+
+
+@init_model_state_from_kwargs
+class Pronunciation(object):
+    """
+    Pronunciation Object Reference
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new Pronunciation object with values from keyword arguments.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param sounds_like:
+            The value to assign to the sounds_like property of this Pronunciation.
+        :type sounds_like: str
+
+        :param audio:
+            The value to assign to the audio property of this Pronunciation.
+        :type audio: oci.ai_speech.models.LocationDetails
+
+        """
+        self.swagger_types = {
+            'sounds_like': 'str',
+            'audio': 'LocationDetails'
+        }
+
+        self.attribute_map = {
+            'sounds_like': 'soundsLike',
+            'audio': 'audio'
+        }
+
+        self._sounds_like = None
+        self._audio = None
+
+    @property
+    def sounds_like(self):
+        """
+        Gets the sounds_like of this Pronunciation.
+        Written phonetic representation of entity value
+
+
+        :return: The sounds_like of this Pronunciation.
+        :rtype: str
+        """
+        return self._sounds_like
+
+    @sounds_like.setter
+    def sounds_like(self, sounds_like):
+        """
+        Sets the sounds_like of this Pronunciation.
+        Written phonetic representation of entity value
+
+
+        :param sounds_like: The sounds_like of this Pronunciation.
+        :type: str
+        """
+        self._sounds_like = sounds_like
+
+    @property
+    def audio(self):
+        """
+        Gets the audio of this Pronunciation.
+
+        :return: The audio of this Pronunciation.
+        :rtype: oci.ai_speech.models.LocationDetails
+        """
+        return self._audio
+
+    @audio.setter
+    def audio(self, audio):
+        """
+        Sets the audio of this Pronunciation.
+
+        :param audio: The audio of this Pronunciation.
+        :type: oci.ai_speech.models.LocationDetails
+        """
+        self._audio = audio
+
+    def __repr__(self):
+        return formatted_flat_dict(self)
+
+    def __eq__(self, other):
+        if other is None:
+            return False
+
+        return self.__dict__ == other.__dict__
+
+    def __ne__(self, other):
+        return not self == other

oci/ai_speech/models/realtime_message.py

@@ -0,0 +1,168 @@
+# coding: utf-8
+# Copyright (c) 2016, 2024, Oracle and/or its affiliates.  All rights reserved.
+# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
+
+# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20220101
+
+
+from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel  # noqa: F401
+from oci.decorators import init_model_state_from_kwargs
+
+
+@init_model_state_from_kwargs
+class RealtimeMessage(object):
+    """
+    Websocket messages sent between client and service.
+    """
+
+    #: A constant which can be used with the event property of a RealtimeMessage.
+    #: This constant has a value of "RESULT"
+    EVENT_RESULT = "RESULT"
+
+    #: A constant which can be used with the event property of a RealtimeMessage.
+    #: This constant has a value of "ACKAUDIO"
+    EVENT_ACKAUDIO = "ACKAUDIO"
+
+    #: A constant which can be used with the event property of a RealtimeMessage.
+    #: This constant has a value of "ERROR"
+    EVENT_ERROR = "ERROR"
+
+    #: A constant which can be used with the event property of a RealtimeMessage.
+    #: This constant has a value of "CONNECT"
+    EVENT_CONNECT = "CONNECT"
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new RealtimeMessage object with values from keyword arguments. This class has the following subclasses and if you are using this class as input
+        to a service operations then you should favor using a subclass over the base class:
+
+        * :class:`~oci.ai_speech.models.RealtimeMessageError`
+        * :class:`~oci.ai_speech.models.RealtimeMessageAckAudio`
+        * :class:`~oci.ai_speech.models.RealtimeMessageConnect`
+        * :class:`~oci.ai_speech.models.RealtimeMessageResult`
+
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param event:
+            The value to assign to the event property of this RealtimeMessage.
+            Allowed values for this property are: "RESULT", "ACKAUDIO", "ERROR", "CONNECT"
+        :type event: str
+
+        :param session_id:
+            The value to assign to the session_id property of this RealtimeMessage.
+        :type session_id: str
+
+        """
+        self.swagger_types = {
+            'event': 'str',
+            'session_id': 'str'
+        }
+
+        self.attribute_map = {
+            'event': 'event',
+            'session_id': 'sessionId'
+        }
+
+        self._event = None
+        self._session_id = None
+
+    @staticmethod
+    def get_subtype(object_dictionary):
+        """
+        Given the hash representation of a subtype of this class,
+        use the info in the hash to return the class of the subtype.
+        """
+        type = object_dictionary['event']
+
+        if type == 'ERROR':
+            return 'RealtimeMessageError'
+
+        if type == 'ACKAUDIO':
+            return 'RealtimeMessageAckAudio'
+
+        if type == 'CONNECT':
+            return 'RealtimeMessageConnect'
+
+        if type == 'RESULT':
+            return 'RealtimeMessageResult'
+        else:
+            return 'RealtimeMessage'
+
+    @property
+    def event(self):
+        """
+        **[Required]** Gets the event of this RealtimeMessage.
+        Incoming Types of message event sent from Service -> Client
+        - RESULT - result
+        - ACKAUDIO - ackAudio
+        - ERROR - error
+        - CONNECT - connect
+        Outgoing Types of message event sent from Client -> Service
+        - SEND_FINAL_RESULT - sendFinalResult
+
+        Allowed values for this property are: "RESULT", "ACKAUDIO", "ERROR", "CONNECT"
+
+
+        :return: The event of this RealtimeMessage.
+        :rtype: str
+        """
+        return self._event
+
+    @event.setter
+    def event(self, event):
+        """
+        Sets the event of this RealtimeMessage.
+        Incoming Types of message event sent from Service -> Client
+        - RESULT - result
+        - ACKAUDIO - ackAudio
+        - ERROR - error
+        - CONNECT - connect
+        Outgoing Types of message event sent from Client -> Service
+        - SEND_FINAL_RESULT - sendFinalResult
+
+
+        :param event: The event of this RealtimeMessage.
+        :type: str
+        """
+        allowed_values = ["RESULT", "ACKAUDIO", "ERROR", "CONNECT"]
+        if not value_allowed_none_or_none_sentinel(event, allowed_values):
+            raise ValueError(
+                f"Invalid value for `event`, must be None or one of {allowed_values}"
+            )
+        self._event = event
+
+    @property
+    def session_id(self):
+        """
+        Gets the session_id of this RealtimeMessage.
+        Session ID for the connected session.
+
+
+        :return: The session_id of this RealtimeMessage.
+        :rtype: str
+        """
+        return self._session_id
+
+    @session_id.setter
+    def session_id(self, session_id):
+        """
+        Sets the session_id of this RealtimeMessage.
+        Session ID for the connected session.
+
+
+        :param session_id: The session_id of this RealtimeMessage.
+        :type: str
+        """
+        self._session_id = session_id
+
+    def __repr__(self):
+        return formatted_flat_dict(self)
+
+    def __eq__(self, other):
+        if other is None:
+            return False
+
+        return self.__dict__ == other.__dict__
+
+    def __ne__(self, other):
+        return not self == other

oci/ai_speech/models/realtime_message_ack_audio.py

@@ -0,0 +1,85 @@
+# coding: utf-8
+# Copyright (c) 2016, 2024, Oracle and/or its affiliates.  All rights reserved.
+# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
+
+# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20220101
+
+from .realtime_message import RealtimeMessage
+from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel  # noqa: F401
+from oci.decorators import init_model_state_from_kwargs
+
+
+@init_model_state_from_kwargs
+class RealtimeMessageAckAudio(RealtimeMessage):
+    """
+    The websocket ack message received from service.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new RealtimeMessageAckAudio object with values from keyword arguments. The default value of the :py:attr:`~oci.ai_speech.models.RealtimeMessageAckAudio.event` attribute
+        of this class is ``ACKAUDIO`` and it should not be changed.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param event:
+            The value to assign to the event property of this RealtimeMessageAckAudio.
+            Allowed values for this property are: "RESULT", "ACKAUDIO", "ERROR", "CONNECT"
+        :type event: str
+
+        :param session_id:
+            The value to assign to the session_id property of this RealtimeMessageAckAudio.
+        :type session_id: str
+
+        :param details:
+            The value to assign to the details property of this RealtimeMessageAckAudio.
+        :type details: oci.ai_speech.models.RealtimeMessageAckAudioDetails
+
+        """
+        self.swagger_types = {
+            'event': 'str',
+            'session_id': 'str',
+            'details': 'RealtimeMessageAckAudioDetails'
+        }
+
+        self.attribute_map = {
+            'event': 'event',
+            'session_id': 'sessionId',
+            'details': 'details'
+        }
+
+        self._event = None
+        self._session_id = None
+        self._details = None
+        self._event = 'ACKAUDIO'
+
+    @property
+    def details(self):
+        """
+        **[Required]** Gets the details of this RealtimeMessageAckAudio.
+
+        :return: The details of this RealtimeMessageAckAudio.
+        :rtype: oci.ai_speech.models.RealtimeMessageAckAudioDetails
+        """
+        return self._details
+
+    @details.setter
+    def details(self, details):
+        """
+        Sets the details of this RealtimeMessageAckAudio.
+
+        :param details: The details of this RealtimeMessageAckAudio.
+        :type: oci.ai_speech.models.RealtimeMessageAckAudioDetails
+        """
+        self._details = details
+
+    def __repr__(self):
+        return formatted_flat_dict(self)
+
+    def __eq__(self, other):
+        if other is None:
+            return False
+
+        return self.__dict__ == other.__dict__
+
+    def __ne__(self, other):
+        return not self == other

oci/ai_speech/models/realtime_message_ack_audio_details.py

@@ -0,0 +1,134 @@
+# coding: utf-8
+# Copyright (c) 2016, 2024, Oracle and/or its affiliates.  All rights reserved.
+# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
+
+# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20220101
+
+
+from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel  # noqa: F401
+from oci.decorators import init_model_state_from_kwargs
+
+
+@init_model_state_from_kwargs
+class RealtimeMessageAckAudioDetails(object):
+    """
+    Details object for the websocket ack message received from service.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new RealtimeMessageAckAudioDetails object with values from keyword arguments.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param number:
+            The value to assign to the number property of this RealtimeMessageAckAudioDetails.
+        :type number: int
+
+        :param offset:
+            The value to assign to the offset property of this RealtimeMessageAckAudioDetails.
+        :type offset: int
+
+        :param length:
+            The value to assign to the length property of this RealtimeMessageAckAudioDetails.
+        :type length: int
+
+        """
+        self.swagger_types = {
+            'number': 'int',
+            'offset': 'int',
+            'length': 'int'
+        }
+
+        self.attribute_map = {
+            'number': 'number',
+            'offset': 'offset',
+            'length': 'length'
+        }
+
+        self._number = None
+        self._offset = None
+        self._length = None
+
+    @property
+    def number(self):
+        """
+        **[Required]** Gets the number of this RealtimeMessageAckAudioDetails.
+        Sequence number of the acknowledged packet.
+
+
+        :return: The number of this RealtimeMessageAckAudioDetails.
+        :rtype: int
+        """
+        return self._number
+
+    @number.setter
+    def number(self, number):
+        """
+        Sets the number of this RealtimeMessageAckAudioDetails.
+        Sequence number of the acknowledged packet.
+
+
+        :param number: The number of this RealtimeMessageAckAudioDetails.
+        :type: int
+        """
+        self._number = number
+
+    @property
+    def offset(self):
+        """
+        **[Required]** Gets the offset of this RealtimeMessageAckAudioDetails.
+        Offset of the acknowledged packet.
+
+
+        :return: The offset of this RealtimeMessageAckAudioDetails.
+        :rtype: int
+        """
+        return self._offset
+
+    @offset.setter
+    def offset(self, offset):
+        """
+        Sets the offset of this RealtimeMessageAckAudioDetails.
+        Offset of the acknowledged packet.
+
+
+        :param offset: The offset of this RealtimeMessageAckAudioDetails.
+        :type: int
+        """
+        self._offset = offset
+
+    @property
+    def length(self):
+        """
+        **[Required]** Gets the length of this RealtimeMessageAckAudioDetails.
+        Length in bytes of the acknowledged packet.
+
+
+        :return: The length of this RealtimeMessageAckAudioDetails.
+        :rtype: int
+        """
+        return self._length
+
+    @length.setter
+    def length(self, length):
+        """
+        Sets the length of this RealtimeMessageAckAudioDetails.
+        Length in bytes of the acknowledged packet.
+
+
+        :param length: The length of this RealtimeMessageAckAudioDetails.
+        :type: int
+        """
+        self._length = length
+
+    def __repr__(self):
+        return formatted_flat_dict(self)
+
+    def __eq__(self, other):
+        if other is None:
+            return False
+
+        return self.__dict__ == other.__dict__
+
+    def __ne__(self, other):
+        return not self == other

oci/ai_speech/models/realtime_message_authentication.py

@@ -0,0 +1,140 @@
+# coding: utf-8
+# Copyright (c) 2016, 2024, Oracle and/or its affiliates.  All rights reserved.
+# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
+
+# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20220101
+
+
+from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel  # noqa: F401
+from oci.decorators import init_model_state_from_kwargs
+
+
+@init_model_state_from_kwargs
+class RealtimeMessageAuthentication(object):
+    """
+    The payload for authentication.
+    """
+
+    #: A constant which can be used with the authentication_type property of a RealtimeMessageAuthentication.
+    #: This constant has a value of "CREDENTIALS"
+    AUTHENTICATION_TYPE_CREDENTIALS = "CREDENTIALS"
+
+    #: A constant which can be used with the authentication_type property of a RealtimeMessageAuthentication.
+    #: This constant has a value of "TOKEN"
+    AUTHENTICATION_TYPE_TOKEN = "TOKEN"
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new RealtimeMessageAuthentication object with values from keyword arguments. This class has the following subclasses and if you are using this class as input
+        to a service operations then you should favor using a subclass over the base class:
+
+        * :class:`~oci.ai_speech.models.RealtimeMessageAuthenticationToken`
+        * :class:`~oci.ai_speech.models.RealtimeMessageAuthenticationCredentials`
+
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param authentication_type:
+            The value to assign to the authentication_type property of this RealtimeMessageAuthentication.
+            Allowed values for this property are: "CREDENTIALS", "TOKEN"
+        :type authentication_type: str
+
+        :param compartment_id:
+            The value to assign to the compartment_id property of this RealtimeMessageAuthentication.
+        :type compartment_id: str
+
+        """
+        self.swagger_types = {
+            'authentication_type': 'str',
+            'compartment_id': 'str'
+        }
+
+        self.attribute_map = {
+            'authentication_type': 'authenticationType',
+            'compartment_id': 'compartmentId'
+        }
+
+        self._authentication_type = None
+        self._compartment_id = None
+
+    @staticmethod
+    def get_subtype(object_dictionary):
+        """
+        Given the hash representation of a subtype of this class,
+        use the info in the hash to return the class of the subtype.
+        """
+        type = object_dictionary['authenticationType']
+
+        if type == 'TOKEN':
+            return 'RealtimeMessageAuthenticationToken'
+
+        if type == 'CREDENTIALS':
+            return 'RealtimeMessageAuthenticationCredentials'
+        else:
+            return 'RealtimeMessageAuthentication'
+
+    @property
+    def authentication_type(self):
+        """
+        **[Required]** Gets the authentication_type of this RealtimeMessageAuthentication.
+        Type of authentication method to be used.
+
+        Allowed values for this property are: "CREDENTIALS", "TOKEN"
+
+
+        :return: The authentication_type of this RealtimeMessageAuthentication.
+        :rtype: str
+        """
+        return self._authentication_type
+
+    @authentication_type.setter
+    def authentication_type(self, authentication_type):
+        """
+        Sets the authentication_type of this RealtimeMessageAuthentication.
+        Type of authentication method to be used.
+
+
+        :param authentication_type: The authentication_type of this RealtimeMessageAuthentication.
+        :type: str
+        """
+        allowed_values = ["CREDENTIALS", "TOKEN"]
+        if not value_allowed_none_or_none_sentinel(authentication_type, allowed_values):
+            raise ValueError(
+                f"Invalid value for `authentication_type`, must be None or one of {allowed_values}"
+            )
+        self._authentication_type = authentication_type
+
+    @property
+    def compartment_id(self):
+        """
+        **[Required]** Gets the compartment_id of this RealtimeMessageAuthentication.
+        Compartment ID to be used for authentication/authorization.
+
+
+        :return: The compartment_id of this RealtimeMessageAuthentication.
+        :rtype: str
+        """
+        return self._compartment_id
+
+    @compartment_id.setter
+    def compartment_id(self, compartment_id):
+        """
+        Sets the compartment_id of this RealtimeMessageAuthentication.
+        Compartment ID to be used for authentication/authorization.
+
+
+        :param compartment_id: The compartment_id of this RealtimeMessageAuthentication.
+        :type: str
+        """
+        self._compartment_id = compartment_id
+
+    def __repr__(self):
+        return formatted_flat_dict(self)
+
+    def __eq__(self, other):
+        if other is None:
+            return False
+
+        return self.__dict__ == other.__dict__
+
+    def __ne__(self, other):
+        return not self == other