SynthesizeSpeechDetails¶

class oci.ai_speech.models.SynthesizeSpeechDetails(**kwargs)¶

Bases: object

Input JSON to get audio inference from TTS Service.

Methods:

__init__(**kwargs)

Initializes a new SynthesizeSpeechDetails object with values from keyword arguments.

Attributes:

`audio_config`	Gets the audio_config of this SynthesizeSpeechDetails.
`compartment_id`	Gets the compartment_id of this SynthesizeSpeechDetails.
`configuration`	Gets the configuration of this SynthesizeSpeechDetails.
`is_stream_enabled`	Gets the is_stream_enabled of this SynthesizeSpeechDetails.
`text`	[Required] Gets the text of this SynthesizeSpeechDetails.

__init__(**kwargs)¶

Initializes a new SynthesizeSpeechDetails object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters

text (str) – The value to assign to the text property of this SynthesizeSpeechDetails.
is_stream_enabled (bool) – The value to assign to the is_stream_enabled property of this SynthesizeSpeechDetails.
compartment_id (str) – The value to assign to the compartment_id property of this SynthesizeSpeechDetails.
configuration (oci.ai_speech.models.TtsConfiguration) – The value to assign to the configuration property of this SynthesizeSpeechDetails.
audio_config (oci.ai_speech.models.TtsAudioConfig) – The value to assign to the audio_config property of this SynthesizeSpeechDetails.

property audio_config¶

Gets the audio_config of this SynthesizeSpeechDetails.

Returns: The audio_config of this SynthesizeSpeechDetails.
Return type: oci.ai_speech.models.TtsAudioConfig

property compartment_id¶

Gets the compartment_id of this SynthesizeSpeechDetails. The OCID of the compartment where the user has access to call SpeechSynthesize api. But default user access will be checked at tenancy level.

Returns: The compartment_id of this SynthesizeSpeechDetails.
Return type: str

property configuration¶

Gets the configuration of this SynthesizeSpeechDetails.

Returns: The configuration of this SynthesizeSpeechDetails.
Return type: oci.ai_speech.models.TtsConfiguration

property is_stream_enabled¶

Gets the is_stream_enabled of this SynthesizeSpeechDetails. If set to true, response will be sent in the chunked transfer-encoding and audio chunks are sent back as and when they are ready. If set to false, response will be sent only once the entire audio is generated.

Returns: The is_stream_enabled of this SynthesizeSpeechDetails.
Return type: bool

property text¶

[Required] Gets the text of this SynthesizeSpeechDetails. The text input to get the inference audio from TTS Service.

Returns: The text of this SynthesizeSpeechDetails.
Return type: str