VoiceSummary¶
- class oci.ai_speech.models.VoiceSummary(**kwargs)¶
Bases:
objectDetails related to the voice available for the given language code and voice type.
Attributes:
A constant which can be used with the gender property of a VoiceSummary.
A constant which can be used with the gender property of a VoiceSummary.
Gets the description of this VoiceSummary.
[Required] Gets the display_name of this VoiceSummary.
[Required] Gets the gender of this VoiceSummary.
Gets the is_default_voice of this VoiceSummary.
Gets the language_code of this VoiceSummary.
Gets the language_description of this VoiceSummary.
[Required] Gets the sample_rate_in_hertz of this VoiceSummary.
Gets the supported_models of this VoiceSummary.
[Required] Gets the voice_id of this VoiceSummary.
[Required] Gets the words_per_minute of this VoiceSummary.
Methods:
__init__(**kwargs)Initializes a new VoiceSummary object with values from keyword arguments.
- GENDER_FEMALE = 'FEMALE'¶
A constant which can be used with the gender property of a VoiceSummary. This constant has a value of “FEMALE”
- GENDER_MALE = 'MALE'¶
A constant which can be used with the gender property of a VoiceSummary. This constant has a value of “MALE”
- __init__(**kwargs)¶
Initializes a new VoiceSummary object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):
- Parameters
voice_id (str) – The value to assign to the voice_id property of this VoiceSummary.
display_name (str) – The value to assign to the display_name property of this VoiceSummary.
description (str) – The value to assign to the description property of this VoiceSummary.
gender (str) – The value to assign to the gender property of this VoiceSummary. Allowed values for this property are: “MALE”, “FEMALE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
supported_models (list[str]) – The value to assign to the supported_models property of this VoiceSummary.
language_code (str) – The value to assign to the language_code property of this VoiceSummary.
language_description (str) – The value to assign to the language_description property of this VoiceSummary.
sample_rate_in_hertz (int) – The value to assign to the sample_rate_in_hertz property of this VoiceSummary.
words_per_minute (int) – The value to assign to the words_per_minute property of this VoiceSummary.
is_default_voice (bool) – The value to assign to the is_default_voice property of this VoiceSummary.
- property description¶
Gets the description of this VoiceSummary. A small description of the voice like its language and voice type.
- Returns
The description of this VoiceSummary.
- Return type
str
- property display_name¶
[Required] Gets the display_name of this VoiceSummary. A user-friendly display name of the language for the user.
- Returns
The display_name of this VoiceSummary.
- Return type
str
- property gender¶
[Required] Gets the gender of this VoiceSummary. Gender of the speaker.
Allowed values for this property are: “MALE”, “FEMALE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The gender of this VoiceSummary.
- Return type
str
- property is_default_voice¶
Gets the is_default_voice of this VoiceSummary. Whether this voice id is default voice used for inference.
- Returns
The is_default_voice of this VoiceSummary.
- Return type
bool
- property language_code¶
Gets the language_code of this VoiceSummary. An abbreviated notation of region to which the language and accent of the speaker belongs to.
- Returns
The language_code of this VoiceSummary.
- Return type
str
- property language_description¶
Gets the language_description of this VoiceSummary. A description of region to which the language and accent of the speaker belongs to.
- Returns
The language_description of this VoiceSummary.
- Return type
str
- property sample_rate_in_hertz¶
[Required] Gets the sample_rate_in_hertz of this VoiceSummary. The sample rate of the speaker in Hertz.
- Returns
The sample_rate_in_hertz of this VoiceSummary.
- Return type
int
- property supported_models¶
Gets the supported_models of this VoiceSummary. Models the particular speaker is aligned to.
- Returns
The supported_models of this VoiceSummary.
- Return type
list[str]
- property voice_id¶
[Required] Gets the voice_id of this VoiceSummary. Unique Id of the voice.
- Returns
The voice_id of this VoiceSummary.
- Return type
str
- property words_per_minute¶
[Required] Gets the words_per_minute of this VoiceSummary. The number of words the speaker can narrate per minute. It signifies the speed of the speech produced by the speaker.
- Returns
The words_per_minute of this VoiceSummary.
- Return type
int