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

oci/ai_speech/models/realtime_message_result_transcription.py

@@ -0,0 +1,258 @@
+# 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 RealtimeMessageResultTranscription(object):
+    """
+    Transcription object.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new RealtimeMessageResultTranscription object with values from keyword arguments.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param transcription:
+            The value to assign to the transcription property of this RealtimeMessageResultTranscription.
+        :type transcription: str
+
+        :param is_final:
+            The value to assign to the is_final property of this RealtimeMessageResultTranscription.
+        :type is_final: bool
+
+        :param start_time_in_ms:
+            The value to assign to the start_time_in_ms property of this RealtimeMessageResultTranscription.
+        :type start_time_in_ms: int
+
+        :param end_time_in_ms:
+            The value to assign to the end_time_in_ms property of this RealtimeMessageResultTranscription.
+        :type end_time_in_ms: int
+
+        :param confidence:
+            The value to assign to the confidence property of this RealtimeMessageResultTranscription.
+        :type confidence: float
+
+        :param trailing_silence:
+            The value to assign to the trailing_silence property of this RealtimeMessageResultTranscription.
+        :type trailing_silence: int
+
+        :param tokens:
+            The value to assign to the tokens property of this RealtimeMessageResultTranscription.
+        :type tokens: list[oci.ai_speech.models.RealtimeMessageResultTranscriptionToken]
+
+        """
+        self.swagger_types = {
+            'transcription': 'str',
+            'is_final': 'bool',
+            'start_time_in_ms': 'int',
+            'end_time_in_ms': 'int',
+            'confidence': 'float',
+            'trailing_silence': 'int',
+            'tokens': 'list[RealtimeMessageResultTranscriptionToken]'
+        }
+
+        self.attribute_map = {
+            'transcription': 'transcription',
+            'is_final': 'isFinal',
+            'start_time_in_ms': 'startTimeInMs',
+            'end_time_in_ms': 'endTimeInMs',
+            'confidence': 'confidence',
+            'trailing_silence': 'trailingSilence',
+            'tokens': 'tokens'
+        }
+
+        self._transcription = None
+        self._is_final = None
+        self._start_time_in_ms = None
+        self._end_time_in_ms = None
+        self._confidence = None
+        self._trailing_silence = None
+        self._tokens = None
+
+    @property
+    def transcription(self):
+        """
+        **[Required]** Gets the transcription of this RealtimeMessageResultTranscription.
+        Transcription text.
+
+
+        :return: The transcription of this RealtimeMessageResultTranscription.
+        :rtype: str
+        """
+        return self._transcription
+
+    @transcription.setter
+    def transcription(self, transcription):
+        """
+        Sets the transcription of this RealtimeMessageResultTranscription.
+        Transcription text.
+
+
+        :param transcription: The transcription of this RealtimeMessageResultTranscription.
+        :type: str
+        """
+        self._transcription = transcription
+
+    @property
+    def is_final(self):
+        """
+        **[Required]** Gets the is_final of this RealtimeMessageResultTranscription.
+        Whether the transcription is final or partial.
+
+
+        :return: The is_final of this RealtimeMessageResultTranscription.
+        :rtype: bool
+        """
+        return self._is_final
+
+    @is_final.setter
+    def is_final(self, is_final):
+        """
+        Sets the is_final of this RealtimeMessageResultTranscription.
+        Whether the transcription is final or partial.
+
+
+        :param is_final: The is_final of this RealtimeMessageResultTranscription.
+        :type: bool
+        """
+        self._is_final = is_final
+
+    @property
+    def start_time_in_ms(self):
+        """
+        **[Required]** Gets the start_time_in_ms of this RealtimeMessageResultTranscription.
+        Start time in milliseconds for the transcription text.
+
+
+        :return: The start_time_in_ms of this RealtimeMessageResultTranscription.
+        :rtype: int
+        """
+        return self._start_time_in_ms
+
+    @start_time_in_ms.setter
+    def start_time_in_ms(self, start_time_in_ms):
+        """
+        Sets the start_time_in_ms of this RealtimeMessageResultTranscription.
+        Start time in milliseconds for the transcription text.
+
+
+        :param start_time_in_ms: The start_time_in_ms of this RealtimeMessageResultTranscription.
+        :type: int
+        """
+        self._start_time_in_ms = start_time_in_ms
+
+    @property
+    def end_time_in_ms(self):
+        """
+        **[Required]** Gets the end_time_in_ms of this RealtimeMessageResultTranscription.
+        End time in milliseconds for the transcription text.
+
+
+        :return: The end_time_in_ms of this RealtimeMessageResultTranscription.
+        :rtype: int
+        """
+        return self._end_time_in_ms
+
+    @end_time_in_ms.setter
+    def end_time_in_ms(self, end_time_in_ms):
+        """
+        Sets the end_time_in_ms of this RealtimeMessageResultTranscription.
+        End time in milliseconds for the transcription text.
+
+
+        :param end_time_in_ms: The end_time_in_ms of this RealtimeMessageResultTranscription.
+        :type: int
+        """
+        self._end_time_in_ms = end_time_in_ms
+
+    @property
+    def confidence(self):
+        """
+        **[Required]** Gets the confidence of this RealtimeMessageResultTranscription.
+        Confidence for the transcription text.
+
+
+        :return: The confidence of this RealtimeMessageResultTranscription.
+        :rtype: float
+        """
+        return self._confidence
+
+    @confidence.setter
+    def confidence(self, confidence):
+        """
+        Sets the confidence of this RealtimeMessageResultTranscription.
+        Confidence for the transcription text.
+
+
+        :param confidence: The confidence of this RealtimeMessageResultTranscription.
+        :type: float
+        """
+        self._confidence = confidence
+
+    @property
+    def trailing_silence(self):
+        """
+        **[Required]** Gets the trailing_silence of this RealtimeMessageResultTranscription.
+        Trailing silence after the transcription text.
+
+
+        :return: The trailing_silence of this RealtimeMessageResultTranscription.
+        :rtype: int
+        """
+        return self._trailing_silence
+
+    @trailing_silence.setter
+    def trailing_silence(self, trailing_silence):
+        """
+        Sets the trailing_silence of this RealtimeMessageResultTranscription.
+        Trailing silence after the transcription text.
+
+
+        :param trailing_silence: The trailing_silence of this RealtimeMessageResultTranscription.
+        :type: int
+        """
+        self._trailing_silence = trailing_silence
+
+    @property
+    def tokens(self):
+        """
+        **[Required]** Gets the tokens of this RealtimeMessageResultTranscription.
+        Array of individual transcription tokens.
+
+
+        :return: The tokens of this RealtimeMessageResultTranscription.
+        :rtype: list[oci.ai_speech.models.RealtimeMessageResultTranscriptionToken]
+        """
+        return self._tokens
+
+    @tokens.setter
+    def tokens(self, tokens):
+        """
+        Sets the tokens of this RealtimeMessageResultTranscription.
+        Array of individual transcription tokens.
+
+
+        :param tokens: The tokens of this RealtimeMessageResultTranscription.
+        :type: list[oci.ai_speech.models.RealtimeMessageResultTranscriptionToken]
+        """
+        self._tokens = tokens
+
+    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_transcription_token.py

@@ -0,0 +1,212 @@
+# 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 RealtimeMessageResultTranscriptionToken(object):
+    """
+    Individual transcription tokens.
+    """
+
+    #: A constant which can be used with the type property of a RealtimeMessageResultTranscriptionToken.
+    #: This constant has a value of "WORD"
+    TYPE_WORD = "WORD"
+
+    #: A constant which can be used with the type property of a RealtimeMessageResultTranscriptionToken.
+    #: This constant has a value of "PUNCTUATION"
+    TYPE_PUNCTUATION = "PUNCTUATION"
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new RealtimeMessageResultTranscriptionToken object with values from keyword arguments.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param token:
+            The value to assign to the token property of this RealtimeMessageResultTranscriptionToken.
+        :type token: str
+
+        :param start_time_in_ms:
+            The value to assign to the start_time_in_ms property of this RealtimeMessageResultTranscriptionToken.
+        :type start_time_in_ms: int
+
+        :param end_time_in_ms:
+            The value to assign to the end_time_in_ms property of this RealtimeMessageResultTranscriptionToken.
+        :type end_time_in_ms: int
+
+        :param confidence:
+            The value to assign to the confidence property of this RealtimeMessageResultTranscriptionToken.
+        :type confidence: float
+
+        :param type:
+            The value to assign to the type property of this RealtimeMessageResultTranscriptionToken.
+            Allowed values for this property are: "WORD", "PUNCTUATION"
+        :type type: str
+
+        """
+        self.swagger_types = {
+            'token': 'str',
+            'start_time_in_ms': 'int',
+            'end_time_in_ms': 'int',
+            'confidence': 'float',
+            'type': 'str'
+        }
+
+        self.attribute_map = {
+            'token': 'token',
+            'start_time_in_ms': 'startTimeInMs',
+            'end_time_in_ms': 'endTimeInMs',
+            'confidence': 'confidence',
+            'type': 'type'
+        }
+
+        self._token = None
+        self._start_time_in_ms = None
+        self._end_time_in_ms = None
+        self._confidence = None
+        self._type = None
+
+    @property
+    def token(self):
+        """
+        **[Required]** Gets the token of this RealtimeMessageResultTranscriptionToken.
+        Transcription token.
+
+
+        :return: The token of this RealtimeMessageResultTranscriptionToken.
+        :rtype: str
+        """
+        return self._token
+
+    @token.setter
+    def token(self, token):
+        """
+        Sets the token of this RealtimeMessageResultTranscriptionToken.
+        Transcription token.
+
+
+        :param token: The token of this RealtimeMessageResultTranscriptionToken.
+        :type: str
+        """
+        self._token = token
+
+    @property
+    def start_time_in_ms(self):
+        """
+        **[Required]** Gets the start_time_in_ms of this RealtimeMessageResultTranscriptionToken.
+        Start time in milliseconds for the transcription token.
+
+
+        :return: The start_time_in_ms of this RealtimeMessageResultTranscriptionToken.
+        :rtype: int
+        """
+        return self._start_time_in_ms
+
+    @start_time_in_ms.setter
+    def start_time_in_ms(self, start_time_in_ms):
+        """
+        Sets the start_time_in_ms of this RealtimeMessageResultTranscriptionToken.
+        Start time in milliseconds for the transcription token.
+
+
+        :param start_time_in_ms: The start_time_in_ms of this RealtimeMessageResultTranscriptionToken.
+        :type: int
+        """
+        self._start_time_in_ms = start_time_in_ms
+
+    @property
+    def end_time_in_ms(self):
+        """
+        **[Required]** Gets the end_time_in_ms of this RealtimeMessageResultTranscriptionToken.
+        End time in milliseconds for the transcription token.
+
+
+        :return: The end_time_in_ms of this RealtimeMessageResultTranscriptionToken.
+        :rtype: int
+        """
+        return self._end_time_in_ms
+
+    @end_time_in_ms.setter
+    def end_time_in_ms(self, end_time_in_ms):
+        """
+        Sets the end_time_in_ms of this RealtimeMessageResultTranscriptionToken.
+        End time in milliseconds for the transcription token.
+
+
+        :param end_time_in_ms: The end_time_in_ms of this RealtimeMessageResultTranscriptionToken.
+        :type: int
+        """
+        self._end_time_in_ms = end_time_in_ms
+
+    @property
+    def confidence(self):
+        """
+        **[Required]** Gets the confidence of this RealtimeMessageResultTranscriptionToken.
+        Confidence score for the transcription token.
+
+
+        :return: The confidence of this RealtimeMessageResultTranscriptionToken.
+        :rtype: float
+        """
+        return self._confidence
+
+    @confidence.setter
+    def confidence(self, confidence):
+        """
+        Sets the confidence of this RealtimeMessageResultTranscriptionToken.
+        Confidence score for the transcription token.
+
+
+        :param confidence: The confidence of this RealtimeMessageResultTranscriptionToken.
+        :type: float
+        """
+        self._confidence = confidence
+
+    @property
+    def type(self):
+        """
+        **[Required]** Gets the type of this RealtimeMessageResultTranscriptionToken.
+        Type of the transcription token.
+
+        Allowed values for this property are: "WORD", "PUNCTUATION"
+
+
+        :return: The type of this RealtimeMessageResultTranscriptionToken.
+        :rtype: str
+        """
+        return self._type
+
+    @type.setter
+    def type(self, type):
+        """
+        Sets the type of this RealtimeMessageResultTranscriptionToken.
+        Type of the transcription token.
+
+
+        :param type: The type of this RealtimeMessageResultTranscriptionToken.
+        :type: str
+        """
+        allowed_values = ["WORD", "PUNCTUATION"]
+        if not value_allowed_none_or_none_sentinel(type, allowed_values):
+            raise ValueError(
+                f"Invalid value for `type`, must be None or one of {allowed_values}"
+            )
+        self._type = type
+
+    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_send_final_result.py

@@ -0,0 +1,51 @@
+# 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_out import RealtimeMessageOut
+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 RealtimeMessageSendFinalResult(RealtimeMessageOut):
+    """
+    Tell service to send final result
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new RealtimeMessageSendFinalResult object with values from keyword arguments. The default value of the :py:attr:`~oci.ai_speech.models.RealtimeMessageSendFinalResult.event` attribute
+        of this class is ``SEND_FINAL_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 RealtimeMessageSendFinalResult.
+            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
+        self._event = 'SEND_FINAL_RESULT'
+
+    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_model_details.py

@@ -0,0 +1,139 @@
+# 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 RealtimeModelDetails(object):
+    """
+    Details of the ASR model used by the realtime speech service.
+    """
+
+    #: A constant which can be used with the domain property of a RealtimeModelDetails.
+    #: This constant has a value of "GENERIC"
+    DOMAIN_GENERIC = "GENERIC"
+
+    #: A constant which can be used with the domain property of a RealtimeModelDetails.
+    #: This constant has a value of "MEDICAL"
+    DOMAIN_MEDICAL = "MEDICAL"
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new RealtimeModelDetails object with values from keyword arguments.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param domain:
+            The value to assign to the domain property of this RealtimeModelDetails.
+            Allowed values for this property are: "GENERIC", "MEDICAL"
+        :type domain: str
+
+        :param language_code:
+            The value to assign to the language_code property of this RealtimeModelDetails.
+        :type language_code: str
+
+        """
+        self.swagger_types = {
+            'domain': 'str',
+            'language_code': 'str'
+        }
+
+        self.attribute_map = {
+            'domain': 'domain',
+            'language_code': 'languageCode'
+        }
+
+        self._domain = None
+        self._language_code = None
+
+    @property
+    def domain(self):
+        """
+        Gets the domain of this RealtimeModelDetails.
+        Model Domain.
+
+        Allowed values for this property are: "GENERIC", "MEDICAL"
+
+
+        :return: The domain of this RealtimeModelDetails.
+        :rtype: str
+        """
+        return self._domain
+
+    @domain.setter
+    def domain(self, domain):
+        """
+        Sets the domain of this RealtimeModelDetails.
+        Model Domain.
+
+
+        :param domain: The domain of this RealtimeModelDetails.
+        :type: str
+        """
+        allowed_values = ["GENERIC", "MEDICAL"]
+        if not value_allowed_none_or_none_sentinel(domain, allowed_values):
+            raise ValueError(
+                f"Invalid value for `domain`, must be None or one of {allowed_values}"
+            )
+        self._domain = domain
+
+    @property
+    def language_code(self):
+        """
+        Gets the language_code of this RealtimeModelDetails.
+        Locale value as per given in [https://datatracker.ietf.org/doc/html/rfc5646].
+        - en-US: English - United States
+        - es-ES: Spanish - Spain
+        - pt-BR: Portuguese - Brazil
+        - en-GB: English - Great Britain
+        - en-AU: English - Australia
+        - en-IN: English - India
+        - hi-IN: Hindi - India
+        - fr-FR: French - France
+        - de-DE: German - Germany
+        - it-IT: Italian - Italy
+
+
+        :return: The language_code of this RealtimeModelDetails.
+        :rtype: str
+        """
+        return self._language_code
+
+    @language_code.setter
+    def language_code(self, language_code):
+        """
+        Sets the language_code of this RealtimeModelDetails.
+        Locale value as per given in [https://datatracker.ietf.org/doc/html/rfc5646].
+        - en-US: English - United States
+        - es-ES: Spanish - Spain
+        - pt-BR: Portuguese - Brazil
+        - en-GB: English - Great Britain
+        - en-AU: English - Australia
+        - en-IN: English - India
+        - hi-IN: Hindi - India
+        - fr-FR: French - France
+        - de-DE: German - Germany
+        - it-IT: Italian - Italy
+
+
+        :param language_code: The language_code of this RealtimeModelDetails.
+        :type: str
+        """
+        self._language_code = language_code
+
+    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