oci 2.129.4__py3-none-any.whl → 2.131.0__py3-none-any.whl

oci/ai_speech/models/realtime_message_authentication_credentials.py

@@ -0,0 +1,89 @@
+# 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_authentication import RealtimeMessageAuthentication
+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 RealtimeMessageAuthenticationCredentials(RealtimeMessageAuthentication):
+    """
+    The payload for credential-based authentication.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new RealtimeMessageAuthenticationCredentials object with values from keyword arguments. The default value of the :py:attr:`~oci.ai_speech.models.RealtimeMessageAuthenticationCredentials.authentication_type` attribute
+        of this class is ``CREDENTIALS`` and it should not be changed.
+        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 RealtimeMessageAuthenticationCredentials.
+            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 RealtimeMessageAuthenticationCredentials.
+        :type compartment_id: str
+
+        :param headers:
+            The value to assign to the headers property of this RealtimeMessageAuthenticationCredentials.
+        :type headers: dict(str, str)
+
+        """
+        self.swagger_types = {
+            'authentication_type': 'str',
+            'compartment_id': 'str',
+            'headers': 'dict(str, str)'
+        }
+
+        self.attribute_map = {
+            'authentication_type': 'authenticationType',
+            'compartment_id': 'compartmentId',
+            'headers': 'headers'
+        }
+
+        self._authentication_type = None
+        self._compartment_id = None
+        self._headers = None
+        self._authentication_type = 'CREDENTIALS'
+
+    @property
+    def headers(self):
+        """
+        **[Required]** Gets the headers of this RealtimeMessageAuthenticationCredentials.
+        The signed request header object.
+
+
+        :return: The headers of this RealtimeMessageAuthenticationCredentials.
+        :rtype: dict(str, str)
+        """
+        return self._headers
+
+    @headers.setter
+    def headers(self, headers):
+        """
+        Sets the headers of this RealtimeMessageAuthenticationCredentials.
+        The signed request header object.
+
+
+        :param headers: The headers of this RealtimeMessageAuthenticationCredentials.
+        :type: dict(str, str)
+        """
+        self._headers = headers
+
+    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_token.py

@@ -0,0 +1,89 @@
+# 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_authentication import RealtimeMessageAuthentication
+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 RealtimeMessageAuthenticationToken(RealtimeMessageAuthentication):
+    """
+    The payload for JWT based authentication.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new RealtimeMessageAuthenticationToken object with values from keyword arguments. The default value of the :py:attr:`~oci.ai_speech.models.RealtimeMessageAuthenticationToken.authentication_type` attribute
+        of this class is ``TOKEN`` and it should not be changed.
+        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 RealtimeMessageAuthenticationToken.
+            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 RealtimeMessageAuthenticationToken.
+        :type compartment_id: str
+
+        :param token:
+            The value to assign to the token property of this RealtimeMessageAuthenticationToken.
+        :type token: str
+
+        """
+        self.swagger_types = {
+            'authentication_type': 'str',
+            'compartment_id': 'str',
+            'token': 'str'
+        }
+
+        self.attribute_map = {
+            'authentication_type': 'authenticationType',
+            'compartment_id': 'compartmentId',
+            'token': 'token'
+        }
+
+        self._authentication_type = None
+        self._compartment_id = None
+        self._token = None
+        self._authentication_type = 'TOKEN'
+
+    @property
+    def token(self):
+        """
+        **[Required]** Gets the token of this RealtimeMessageAuthenticationToken.
+        The token (JWT) obtained from the realtime transcription session endpoint.
+
+
+        :return: The token of this RealtimeMessageAuthenticationToken.
+        :rtype: str
+        """
+        return self._token
+
+    @token.setter
+    def token(self, token):
+        """
+        Sets the token of this RealtimeMessageAuthenticationToken.
+        The token (JWT) obtained from the realtime transcription session endpoint.
+
+
+        :param token: The token of this RealtimeMessageAuthenticationToken.
+        :type: str
+        """
+        self._token = token
+
+    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_connect.py

@@ -0,0 +1,58 @@
+# 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 RealtimeMessageConnect(RealtimeMessage):
+    """
+    The websocket connection message received from service.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new RealtimeMessageConnect object with values from keyword arguments. The default value of the :py:attr:`~oci.ai_speech.models.RealtimeMessageConnect.event` attribute
+        of this class is ``CONNECT`` 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 RealtimeMessageConnect.
+            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 RealtimeMessageConnect.
+        :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
+        self._event = 'CONNECT'
+
+    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_error.py

@@ -0,0 +1,120 @@
+# 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 RealtimeMessageError(RealtimeMessage):
+    """
+    The websocket error message received from service.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new RealtimeMessageError object with values from keyword arguments. The default value of the :py:attr:`~oci.ai_speech.models.RealtimeMessageError.event` attribute
+        of this class is ``ERROR`` 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 RealtimeMessageError.
+            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 RealtimeMessageError.
+        :type session_id: str
+
+        :param code:
+            The value to assign to the code property of this RealtimeMessageError.
+        :type code: int
+
+        :param message:
+            The value to assign to the message property of this RealtimeMessageError.
+        :type message: str
+
+        """
+        self.swagger_types = {
+            'event': 'str',
+            'session_id': 'str',
+            'code': 'int',
+            'message': 'str'
+        }
+
+        self.attribute_map = {
+            'event': 'event',
+            'session_id': 'sessionId',
+            'code': 'code',
+            'message': 'message'
+        }
+
+        self._event = None
+        self._session_id = None
+        self._code = None
+        self._message = None
+        self._event = 'ERROR'
+
+    @property
+    def code(self):
+        """
+        **[Required]** Gets the code of this RealtimeMessageError.
+        Error code.
+
+
+        :return: The code of this RealtimeMessageError.
+        :rtype: int
+        """
+        return self._code
+
+    @code.setter
+    def code(self, code):
+        """
+        Sets the code of this RealtimeMessageError.
+        Error code.
+
+
+        :param code: The code of this RealtimeMessageError.
+        :type: int
+        """
+        self._code = code
+
+    @property
+    def message(self):
+        """
+        **[Required]** Gets the message of this RealtimeMessageError.
+        Error message.
+
+
+        :return: The message of this RealtimeMessageError.
+        :rtype: str
+        """
+        return self._message
+
+    @message.setter
+    def message(self, message):
+        """
+        Sets the message of this RealtimeMessageError.
+        Error message.
+
+
+        :param message: The message of this RealtimeMessageError.
+        :type: str
+        """
+        self._message = message
+
+    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_out.py

@@ -0,0 +1,103 @@
+# 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 RealtimeMessageOut(object):
+    """
+    Websocket messages sent by client to the service.
+    """
+
+    #: A constant which can be used with the event property of a RealtimeMessageOut.
+    #: This constant has a value of "SEND_FINAL_RESULT"
+    EVENT_SEND_FINAL_RESULT = "SEND_FINAL_RESULT"
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new RealtimeMessageOut 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.RealtimeMessageSendFinalResult`
+
+        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 RealtimeMessageOut.
+            Allowed values for this property are: "SEND_FINAL_RESULT"
+        :type event: str
+
+        """
+        self.swagger_types = {
+            'event': 'str'
+        }
+
+        self.attribute_map = {
+            'event': 'event'
+        }
+
+        self._event = 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 == 'SEND_FINAL_RESULT':
+            return 'RealtimeMessageSendFinalResult'
+        else:
+            return 'RealtimeMessageOut'
+
+    @property
+    def event(self):
+        """
+        **[Required]** Gets the event of this RealtimeMessageOut.
+        Outgoing Types of message event sent from Client -> Service
+        - SEND_FINAL_RESULT - sendFinalResult
+
+        Allowed values for this property are: "SEND_FINAL_RESULT"
+
+
+        :return: The event of this RealtimeMessageOut.
+        :rtype: str
+        """
+        return self._event
+
+    @event.setter
+    def event(self, event):
+        """
+        Sets the event of this RealtimeMessageOut.
+        Outgoing Types of message event sent from Client -> Service
+        - SEND_FINAL_RESULT - sendFinalResult
+
+
+        :param event: The event of this RealtimeMessageOut.
+        :type: str
+        """
+        allowed_values = ["SEND_FINAL_RESULT"]
+        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
+
+    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_result.py

@@ -0,0 +1,89 @@
+# 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 RealtimeMessageResult(RealtimeMessage):
+    """
+    The websocket result message received from service.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new RealtimeMessageResult object with values from keyword arguments. The default value of the :py:attr:`~oci.ai_speech.models.RealtimeMessageResult.event` attribute
+        of this class is ``RESULT`` 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 RealtimeMessageResult.
+            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 RealtimeMessageResult.
+        :type session_id: str
+
+        :param transcriptions:
+            The value to assign to the transcriptions property of this RealtimeMessageResult.
+        :type transcriptions: list[oci.ai_speech.models.RealtimeMessageResultTranscription]
+
+        """
+        self.swagger_types = {
+            'event': 'str',
+            'session_id': 'str',
+            'transcriptions': 'list[RealtimeMessageResultTranscription]'
+        }
+
+        self.attribute_map = {
+            'event': 'event',
+            'session_id': 'sessionId',
+            'transcriptions': 'transcriptions'
+        }
+
+        self._event = None
+        self._session_id = None
+        self._transcriptions = None
+        self._event = 'RESULT'
+
+    @property
+    def transcriptions(self):
+        """
+        **[Required]** Gets the transcriptions of this RealtimeMessageResult.
+        List of transcription objects.
+
+
+        :return: The transcriptions of this RealtimeMessageResult.
+        :rtype: list[oci.ai_speech.models.RealtimeMessageResultTranscription]
+        """
+        return self._transcriptions
+
+    @transcriptions.setter
+    def transcriptions(self, transcriptions):
+        """
+        Sets the transcriptions of this RealtimeMessageResult.
+        List of transcription objects.
+
+
+        :param transcriptions: The transcriptions of this RealtimeMessageResult.
+        :type: list[oci.ai_speech.models.RealtimeMessageResultTranscription]
+        """
+        self._transcriptions = transcriptions
+
+    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