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

oci/ai_speech/models/tts_audio_config.py

@@ -0,0 +1,106 @@
+# 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 TtsAudioConfig(object):
+    """
+    Use this schema to specify handling of audio response.
+    If audioConfig is not provided, raw response is handed over for the user to handle.
+    """
+
+    #: A constant which can be used with the config_type property of a TtsAudioConfig.
+    #: This constant has a value of "BASE_AUDIO_CONFIG"
+    CONFIG_TYPE_BASE_AUDIO_CONFIG = "BASE_AUDIO_CONFIG"
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new TtsAudioConfig 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.TtsBaseAudioConfig`
+
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param config_type:
+            The value to assign to the config_type property of this TtsAudioConfig.
+            Allowed values for this property are: "BASE_AUDIO_CONFIG"
+        :type config_type: str
+
+        """
+        self.swagger_types = {
+            'config_type': 'str'
+        }
+
+        self.attribute_map = {
+            'config_type': 'configType'
+        }
+
+        self._config_type = 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['configType']
+
+        if type == 'BASE_AUDIO_CONFIG':
+            return 'TtsBaseAudioConfig'
+        else:
+            return 'TtsAudioConfig'
+
+    @property
+    def config_type(self):
+        """
+        **[Required]** Gets the config_type of this TtsAudioConfig.
+        The audio config type to use for handling the audio output.
+        Supported config types are:
+        - BASE_AUDIO_CONFIG
+
+        Allowed values for this property are: "BASE_AUDIO_CONFIG"
+
+
+        :return: The config_type of this TtsAudioConfig.
+        :rtype: str
+        """
+        return self._config_type
+
+    @config_type.setter
+    def config_type(self, config_type):
+        """
+        Sets the config_type of this TtsAudioConfig.
+        The audio config type to use for handling the audio output.
+        Supported config types are:
+        - BASE_AUDIO_CONFIG
+
+
+        :param config_type: The config_type of this TtsAudioConfig.
+        :type: str
+        """
+        allowed_values = ["BASE_AUDIO_CONFIG"]
+        if not value_allowed_none_or_none_sentinel(config_type, allowed_values):
+            raise ValueError(
+                f"Invalid value for `config_type`, must be None or one of {allowed_values}"
+            )
+        self._config_type = config_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/tts_base_audio_config.py

@@ -0,0 +1,82 @@
+# 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_audio_config import TtsAudioConfig
+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 TtsBaseAudioConfig(TtsAudioConfig):
+    """
+    Use this audio config for saving the audio response at specified path.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new TtsBaseAudioConfig object with values from keyword arguments. The default value of the :py:attr:`~oci.ai_speech.models.TtsBaseAudioConfig.config_type` attribute
+        of this class is ``BASE_AUDIO_CONFIG`` and it should not be changed.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param config_type:
+            The value to assign to the config_type property of this TtsBaseAudioConfig.
+            Allowed values for this property are: "BASE_AUDIO_CONFIG"
+        :type config_type: str
+
+        :param save_path:
+            The value to assign to the save_path property of this TtsBaseAudioConfig.
+        :type save_path: str
+
+        """
+        self.swagger_types = {
+            'config_type': 'str',
+            'save_path': 'str'
+        }
+
+        self.attribute_map = {
+            'config_type': 'configType',
+            'save_path': 'savePath'
+        }
+
+        self._config_type = None
+        self._save_path = None
+        self._config_type = 'BASE_AUDIO_CONFIG'
+
+    @property
+    def save_path(self):
+        """
+        **[Required]** Gets the save_path of this TtsBaseAudioConfig.
+        Specify the path where you want to save the audio response.
+
+
+        :return: The save_path of this TtsBaseAudioConfig.
+        :rtype: str
+        """
+        return self._save_path
+
+    @save_path.setter
+    def save_path(self, save_path):
+        """
+        Sets the save_path of this TtsBaseAudioConfig.
+        Specify the path where you want to save the audio response.
+
+
+        :param save_path: The save_path of this TtsBaseAudioConfig.
+        :type: str
+        """
+        self._save_path = save_path
+
+    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_configuration.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 TtsConfiguration(object):
+    """
+    Speech configuration for TTS API.
+    """
+
+    #: A constant which can be used with the model_family property of a TtsConfiguration.
+    #: This constant has a value of "ORACLE"
+    MODEL_FAMILY_ORACLE = "ORACLE"
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new TtsConfiguration 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.TtsOracleConfiguration`
+
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param model_family:
+            The value to assign to the model_family property of this TtsConfiguration.
+            Allowed values for this property are: "ORACLE"
+        :type model_family: str
+
+        """
+        self.swagger_types = {
+            'model_family': 'str'
+        }
+
+        self.attribute_map = {
+            'model_family': 'modelFamily'
+        }
+
+        self._model_family = 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['modelFamily']
+
+        if type == 'ORACLE':
+            return 'TtsOracleConfiguration'
+        else:
+            return 'TtsConfiguration'
+
+    @property
+    def model_family(self):
+        """
+        **[Required]** Gets the model_family of this TtsConfiguration.
+        The class of models to use for speech generation. The available model families are:
+        - ORACLE
+
+        Allowed values for this property are: "ORACLE"
+
+
+        :return: The model_family of this TtsConfiguration.
+        :rtype: str
+        """
+        return self._model_family
+
+    @model_family.setter
+    def model_family(self, model_family):
+        """
+        Sets the model_family of this TtsConfiguration.
+        The class of models to use for speech generation. The available model families are:
+        - ORACLE
+
+
+        :param model_family: The model_family of this TtsConfiguration.
+        :type: str
+        """
+        allowed_values = ["ORACLE"]
+        if not value_allowed_none_or_none_sentinel(model_family, allowed_values):
+            raise ValueError(
+                f"Invalid value for `model_family`, must be None or one of {allowed_values}"
+            )
+        self._model_family = model_family
+
+    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_configuration.py

@@ -0,0 +1,105 @@
+# 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_configuration import TtsConfiguration
+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 TtsOracleConfiguration(TtsConfiguration):
+    """
+    Use this configuration for selecting a model from Oracle model family.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new TtsOracleConfiguration object with values from keyword arguments. The default value of the :py:attr:`~oci.ai_speech.models.TtsOracleConfiguration.model_family` attribute
+        of this class is ``ORACLE`` and it should not be changed.
+        The following keyword arguments are supported (corresponding to the getters/setters of this class):
+
+        :param model_family:
+            The value to assign to the model_family property of this TtsOracleConfiguration.
+            Allowed values for this property are: "ORACLE"
+        :type model_family: str
+
+        :param model_details:
+            The value to assign to the model_details property of this TtsOracleConfiguration.
+        :type model_details: oci.ai_speech.models.TtsOracleModelDetails
+
+        :param speech_settings:
+            The value to assign to the speech_settings property of this TtsOracleConfiguration.
+        :type speech_settings: oci.ai_speech.models.TtsOracleSpeechSettings
+
+        """
+        self.swagger_types = {
+            'model_family': 'str',
+            'model_details': 'TtsOracleModelDetails',
+            'speech_settings': 'TtsOracleSpeechSettings'
+        }
+
+        self.attribute_map = {
+            'model_family': 'modelFamily',
+            'model_details': 'modelDetails',
+            'speech_settings': 'speechSettings'
+        }
+
+        self._model_family = None
+        self._model_details = None
+        self._speech_settings = None
+        self._model_family = 'ORACLE'
+
+    @property
+    def model_details(self):
+        """
+        Gets the model_details of this TtsOracleConfiguration.
+
+        :return: The model_details of this TtsOracleConfiguration.
+        :rtype: oci.ai_speech.models.TtsOracleModelDetails
+        """
+        return self._model_details
+
+    @model_details.setter
+    def model_details(self, model_details):
+        """
+        Sets the model_details of this TtsOracleConfiguration.
+
+        :param model_details: The model_details of this TtsOracleConfiguration.
+        :type: oci.ai_speech.models.TtsOracleModelDetails
+        """
+        self._model_details = model_details
+
+    @property
+    def speech_settings(self):
+        """
+        Gets the speech_settings of this TtsOracleConfiguration.
+
+        :return: The speech_settings of this TtsOracleConfiguration.
+        :rtype: oci.ai_speech.models.TtsOracleSpeechSettings
+        """
+        return self._speech_settings
+
+    @speech_settings.setter
+    def speech_settings(self, speech_settings):
+        """
+        Sets the speech_settings of this TtsOracleConfiguration.
+
+        :param speech_settings: The speech_settings of this TtsOracleConfiguration.
+        :type: oci.ai_speech.models.TtsOracleSpeechSettings
+        """
+        self._speech_settings = speech_settings
+
+    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_model_details.py

@@ -0,0 +1,113 @@
+# 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 TtsOracleModelDetails(object):
+    """
+    Model specific properties to use with Oracle model for TTS.
+    """
+
+    #: A constant which can be used with the model_name property of a TtsOracleModelDetails.
+    #: This constant has a value of "TTS_1_STANDARD"
+    MODEL_NAME_TTS_1_STANDARD = "TTS_1_STANDARD"
+
+    #: A constant which can be used with the model_name property of a TtsOracleModelDetails.
+    #: This constant has a value of "TTS_2_NATURAL"
+    MODEL_NAME_TTS_2_NATURAL = "TTS_2_NATURAL"
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new TtsOracleModelDetails 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.TtsOracleTts2NaturalModelDetails`
+        * :class:`~oci.ai_speech.models.TtsOracleTts1StandardModelDetails`
+
+        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 TtsOracleModelDetails.
+            Allowed values for this property are: "TTS_1_STANDARD", "TTS_2_NATURAL"
+        :type model_name: str
+
+        """
+        self.swagger_types = {
+            'model_name': 'str'
+        }
+
+        self.attribute_map = {
+            'model_name': 'modelName'
+        }
+
+        self._model_name = 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['modelName']
+
+        if type == 'TTS_2_NATURAL':
+            return 'TtsOracleTts2NaturalModelDetails'
+
+        if type == 'TTS_1_STANDARD':
+            return 'TtsOracleTts1StandardModelDetails'
+        else:
+            return 'TtsOracleModelDetails'
+
+    @property
+    def model_name(self):
+        """
+        **[Required]** Gets the model_name of this TtsOracleModelDetails.
+        The fully qualified name of model to use for speech generation. The available models are:
+        - TTS_1_STANDARD
+        - TTS_2_NATURAL
+
+        Allowed values for this property are: "TTS_1_STANDARD", "TTS_2_NATURAL"
+
+
+        :return: The model_name of this TtsOracleModelDetails.
+        :rtype: str
+        """
+        return self._model_name
+
+    @model_name.setter
+    def model_name(self, model_name):
+        """
+        Sets the model_name of this TtsOracleModelDetails.
+        The fully qualified name of model to use for speech generation. The available models are:
+        - TTS_1_STANDARD
+        - TTS_2_NATURAL
+
+
+        :param model_name: The model_name of this TtsOracleModelDetails.
+        :type: str
+        """
+        allowed_values = ["TTS_1_STANDARD", "TTS_2_NATURAL"]
+        if not value_allowed_none_or_none_sentinel(model_name, allowed_values):
+            raise ValueError(
+                f"Invalid value for `model_name`, must be None or one of {allowed_values}"
+            )
+        self._model_name = model_name
+
+    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