oci 2.132.0__py3-none-any.whl → 2.134.0__py3-none-any.whl

oci/ai_speech/models/tts_oracle_speech_settings.py

@@ -0,0 +1,246 @@
+# 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 TtsOracleSpeechSettings(object):
+    """
+    Settings to use for generating speech with a model from ORACLE family.
+    """
+
+    #: A constant which can be used with the text_type property of a TtsOracleSpeechSettings.
+    #: This constant has a value of "TEXT"
+    TEXT_TYPE_TEXT = "TEXT"
+
+    #: A constant which can be used with the text_type property of a TtsOracleSpeechSettings.
+    #: This constant has a value of "SSML"
+    TEXT_TYPE_SSML = "SSML"
+
+    #: A constant which can be used with the output_format property of a TtsOracleSpeechSettings.
+    #: This constant has a value of "MP3"
+    OUTPUT_FORMAT_MP3 = "MP3"
+
+    #: A constant which can be used with the output_format property of a TtsOracleSpeechSettings.
+    #: This constant has a value of "OGG"
+    OUTPUT_FORMAT_OGG = "OGG"
+
+    #: A constant which can be used with the output_format property of a TtsOracleSpeechSettings.
+    #: This constant has a value of "PCM"
+    OUTPUT_FORMAT_PCM = "PCM"
+
+    #: A constant which can be used with the output_format property of a TtsOracleSpeechSettings.
+    #: This constant has a value of "JSON"
+    OUTPUT_FORMAT_JSON = "JSON"
+
+    #: A constant which can be used with the speech_mark_types property of a TtsOracleSpeechSettings.
+    #: This constant has a value of "SENTENCE"
+    SPEECH_MARK_TYPES_SENTENCE = "SENTENCE"
+
+    #: A constant which can be used with the speech_mark_types property of a TtsOracleSpeechSettings.
+    #: This constant has a value of "WORD"
+    SPEECH_MARK_TYPES_WORD = "WORD"
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new TtsOracleSpeechSettings object with values from keyword arguments.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param text_type:
+            The value to assign to the text_type property of this TtsOracleSpeechSettings.
+            Allowed values for this property are: "TEXT", "SSML"
+        :type text_type: str
+
+        :param sample_rate_in_hz:
+            The value to assign to the sample_rate_in_hz property of this TtsOracleSpeechSettings.
+        :type sample_rate_in_hz: int
+
+        :param output_format:
+            The value to assign to the output_format property of this TtsOracleSpeechSettings.
+            Allowed values for this property are: "MP3", "OGG", "PCM", "JSON"
+        :type output_format: str
+
+        :param speech_mark_types:
+            The value to assign to the speech_mark_types property of this TtsOracleSpeechSettings.
+            Allowed values for items in this list are: "SENTENCE", "WORD"
+        :type speech_mark_types: list[str]
+
+        """
+        self.swagger_types = {
+            'text_type': 'str',
+            'sample_rate_in_hz': 'int',
+            'output_format': 'str',
+            'speech_mark_types': 'list[str]'
+        }
+
+        self.attribute_map = {
+            'text_type': 'textType',
+            'sample_rate_in_hz': 'sampleRateInHz',
+            'output_format': 'outputFormat',
+            'speech_mark_types': 'speechMarkTypes'
+        }
+
+        self._text_type = None
+        self._sample_rate_in_hz = None
+        self._output_format = None
+        self._speech_mark_types = None
+
+    @property
+    def text_type(self):
+        """
+        Gets the text_type of this TtsOracleSpeechSettings.
+        The format in which the input text has been supplied i.e., Text or SSML. The supported text types are:
+        - TEXT
+        - SSML
+
+        Allowed values for this property are: "TEXT", "SSML"
+
+
+        :return: The text_type of this TtsOracleSpeechSettings.
+        :rtype: str
+        """
+        return self._text_type
+
+    @text_type.setter
+    def text_type(self, text_type):
+        """
+        Sets the text_type of this TtsOracleSpeechSettings.
+        The format in which the input text has been supplied i.e., Text or SSML. The supported text types are:
+        - TEXT
+        - SSML
+
+
+        :param text_type: The text_type of this TtsOracleSpeechSettings.
+        :type: str
+        """
+        allowed_values = ["TEXT", "SSML"]
+        if not value_allowed_none_or_none_sentinel(text_type, allowed_values):
+            raise ValueError(
+                f"Invalid value for `text_type`, must be None or one of {allowed_values}"
+            )
+        self._text_type = text_type
+
+    @property
+    def sample_rate_in_hz(self):
+        """
+        Gets the sample_rate_in_hz of this TtsOracleSpeechSettings.
+        The sample rate of the generated audio. By default, the audio will be generated with speaker voice sample rate.
+
+
+        :return: The sample_rate_in_hz of this TtsOracleSpeechSettings.
+        :rtype: int
+        """
+        return self._sample_rate_in_hz
+
+    @sample_rate_in_hz.setter
+    def sample_rate_in_hz(self, sample_rate_in_hz):
+        """
+        Sets the sample_rate_in_hz of this TtsOracleSpeechSettings.
+        The sample rate of the generated audio. By default, the audio will be generated with speaker voice sample rate.
+
+
+        :param sample_rate_in_hz: The sample_rate_in_hz of this TtsOracleSpeechSettings.
+        :type: int
+        """
+        self._sample_rate_in_hz = sample_rate_in_hz
+
+    @property
+    def output_format(self):
+        """
+        Gets the output_format of this TtsOracleSpeechSettings.
+        The format of audio in which the user wants the audio to be in. The supported output formats are:
+        - MP3
+        - OGG
+        - PCM
+        - JSON
+
+        Allowed values for this property are: "MP3", "OGG", "PCM", "JSON"
+
+
+        :return: The output_format of this TtsOracleSpeechSettings.
+        :rtype: str
+        """
+        return self._output_format
+
+    @output_format.setter
+    def output_format(self, output_format):
+        """
+        Sets the output_format of this TtsOracleSpeechSettings.
+        The format of audio in which the user wants the audio to be in. The supported output formats are:
+        - MP3
+        - OGG
+        - PCM
+        - JSON
+
+
+        :param output_format: The output_format of this TtsOracleSpeechSettings.
+        :type: str
+        """
+        allowed_values = ["MP3", "OGG", "PCM", "JSON"]
+        if not value_allowed_none_or_none_sentinel(output_format, allowed_values):
+            raise ValueError(
+                f"Invalid value for `output_format`, must be None or one of {allowed_values}"
+            )
+        self._output_format = output_format
+
+    @property
+    def speech_mark_types(self):
+        """
+        Gets the speech_mark_types of this TtsOracleSpeechSettings.
+        The kind of time stamp markings the user wants for the audio.
+        This property should be provided if outputFormat is json, otherwise it will be ignored.
+        null value (i.e. no value is not specified) indicates no speech marking.
+        The supported speech mark types are:
+        - SENTENCE
+        - WORD
+
+        Allowed values for items in this list are: "SENTENCE", "WORD"
+
+
+        :return: The speech_mark_types of this TtsOracleSpeechSettings.
+        :rtype: list[str]
+        """
+        return self._speech_mark_types
+
+    @speech_mark_types.setter
+    def speech_mark_types(self, speech_mark_types):
+        """
+        Sets the speech_mark_types of this TtsOracleSpeechSettings.
+        The kind of time stamp markings the user wants for the audio.
+        This property should be provided if outputFormat is json, otherwise it will be ignored.
+        null value (i.e. no value is not specified) indicates no speech marking.
+        The supported speech mark types are:
+        - SENTENCE
+        - WORD
+
+
+        :param speech_mark_types: The speech_mark_types of this TtsOracleSpeechSettings.
+        :type: list[str]
+        """
+        allowed_values = ["SENTENCE", "WORD"]
+
+        if speech_mark_types and speech_mark_types is not NONE_SENTINEL:
+            for value in speech_mark_types:
+                if not value_allowed_none_or_none_sentinel(value, allowed_values):
+                    raise ValueError(
+                        f"Invalid value for `speech_mark_types`, must be None or one of {allowed_values}"
+                    )
+        self._speech_mark_types = speech_mark_types
+
+    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/tts_oracle_tts1_standard_model_details.py

@@ -0,0 +1,84 @@
+# 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 .tts_oracle_model_details import TtsOracleModelDetails
+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 TtsOracleTts1StandardModelDetails(TtsOracleModelDetails):
+    """
+    Use this schema for specifying properties of TTS_1_STANDARD model from Oracle model family.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new TtsOracleTts1StandardModelDetails object with values from keyword arguments. The default value of the :py:attr:`~oci.ai_speech.models.TtsOracleTts1StandardModelDetails.model_name` attribute
+        of this class is ``TTS_1_STANDARD`` and it should not be changed.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param model_name:
+            The value to assign to the model_name property of this TtsOracleTts1StandardModelDetails.
+            Allowed values for this property are: "TTS_1_STANDARD", "TTS_2_NATURAL"
+        :type model_name: str
+
+        :param voice_id:
+            The value to assign to the voice_id property of this TtsOracleTts1StandardModelDetails.
+        :type voice_id: str
+
+        """
+        self.swagger_types = {
+            'model_name': 'str',
+            'voice_id': 'str'
+        }
+
+        self.attribute_map = {
+            'model_name': 'modelName',
+            'voice_id': 'voiceId'
+        }
+
+        self._model_name = None
+        self._voice_id = None
+        self._model_name = 'TTS_1_STANDARD'
+
+    @property
+    def voice_id(self):
+        """
+        Gets the voice_id of this TtsOracleTts1StandardModelDetails.
+        Speaker in whose voice the user wants the output speech to be in.
+        The possible values for `voiceId` can be obtained by calling :func:`list_voices` api.
+
+
+        :return: The voice_id of this TtsOracleTts1StandardModelDetails.
+        :rtype: str
+        """
+        return self._voice_id
+
+    @voice_id.setter
+    def voice_id(self, voice_id):
+        """
+        Sets the voice_id of this TtsOracleTts1StandardModelDetails.
+        Speaker in whose voice the user wants the output speech to be in.
+        The possible values for `voiceId` can be obtained by calling :func:`list_voices` api.
+
+
+        :param voice_id: The voice_id of this TtsOracleTts1StandardModelDetails.
+        :type: str
+        """
+        self._voice_id = voice_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/tts_oracle_tts2_natural_model_details.py

@@ -0,0 +1,84 @@
+# 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 .tts_oracle_model_details import TtsOracleModelDetails
+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 TtsOracleTts2NaturalModelDetails(TtsOracleModelDetails):
+    """
+    Use this schema for specifying properties of TTS_2_NATURAL model from Oracle model family.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new TtsOracleTts2NaturalModelDetails object with values from keyword arguments. The default value of the :py:attr:`~oci.ai_speech.models.TtsOracleTts2NaturalModelDetails.model_name` attribute
+        of this class is ``TTS_2_NATURAL`` and it should not be changed.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param model_name:
+            The value to assign to the model_name property of this TtsOracleTts2NaturalModelDetails.
+            Allowed values for this property are: "TTS_1_STANDARD", "TTS_2_NATURAL"
+        :type model_name: str
+
+        :param voice_id:
+            The value to assign to the voice_id property of this TtsOracleTts2NaturalModelDetails.
+        :type voice_id: str
+
+        """
+        self.swagger_types = {
+            'model_name': 'str',
+            'voice_id': 'str'
+        }
+
+        self.attribute_map = {
+            'model_name': 'modelName',
+            'voice_id': 'voiceId'
+        }
+
+        self._model_name = None
+        self._voice_id = None
+        self._model_name = 'TTS_2_NATURAL'
+
+    @property
+    def voice_id(self):
+        """
+        Gets the voice_id of this TtsOracleTts2NaturalModelDetails.
+        Speaker in whose voice the user wants the output speech to be in.
+        The possible values for `voiceId` can be obtained by calling :func:`list_voices` api.
+
+
+        :return: The voice_id of this TtsOracleTts2NaturalModelDetails.
+        :rtype: str
+        """
+        return self._voice_id
+
+    @voice_id.setter
+    def voice_id(self, voice_id):
+        """
+        Sets the voice_id of this TtsOracleTts2NaturalModelDetails.
+        Speaker in whose voice the user wants the output speech to be in.
+        The possible values for `voiceId` can be obtained by calling :func:`list_voices` api.
+
+
+        :param voice_id: The voice_id of this TtsOracleTts2NaturalModelDetails.
+        :type: str
+        """
+        self._voice_id = voice_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/voice_collection.py

@@ -0,0 +1,72 @@
+# 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 VoiceCollection(object):
+    """
+    Results of the voices available as speaker Ids for given language code and voice type combination.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new VoiceCollection object with values from keyword arguments.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param items:
+            The value to assign to the items property of this VoiceCollection.
+        :type items: list[oci.ai_speech.models.VoiceSummary]
+
+        """
+        self.swagger_types = {
+            'items': 'list[VoiceSummary]'
+        }
+
+        self.attribute_map = {
+            'items': 'items'
+        }
+
+        self._items = None
+
+    @property
+    def items(self):
+        """
+        **[Required]** Gets the items of this VoiceCollection.
+        List of Voices available for user to select from.
+
+
+        :return: The items of this VoiceCollection.
+        :rtype: list[oci.ai_speech.models.VoiceSummary]
+        """
+        return self._items
+
+    @items.setter
+    def items(self, items):
+        """
+        Sets the items of this VoiceCollection.
+        List of Voices available for user to select from.
+
+
+        :param items: The items of this VoiceCollection.
+        :type: list[oci.ai_speech.models.VoiceSummary]
+        """
+        self._items = items
+
+    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