Reference documentation and code samples for the Dialogflow CX V3 API class Google::Cloud::Dialogflow::CX::V3::VoiceSelectionParams.
Description of which voice to use for speech synthesis.
Inherits
Object
Extended By
Google::Protobuf::MessageExts::ClassMethods
Includes
Google::Protobuf::MessageExts
Methods
#name
defname()->::String
Returns
(::String) — Optional. The name of the voice. If not set, the service will choose a
voice based on the other parameters such as language_code and
ssml_gender.
value (::String) — Optional. The name of the voice. If not set, the service will choose a
voice based on the other parameters such as language_code and
ssml_gender.
(::String) — Optional. The name of the voice. If not set, the service will choose a
voice based on the other parameters such as language_code and
ssml_gender.
(::Google::Cloud::Dialogflow::CX::V3::SsmlVoiceGender) — Optional. The preferred gender of the voice. If not set, the service will
choose a voice based on the other parameters such as language_code and
name. Note that
this is only a preference, not requirement. If a voice of the appropriate
gender is not available, the synthesizer substitutes a voice with a
different gender rather than failing the request.
value (::Google::Cloud::Dialogflow::CX::V3::SsmlVoiceGender) — Optional. The preferred gender of the voice. If not set, the service will
choose a voice based on the other parameters such as language_code and
name. Note that
this is only a preference, not requirement. If a voice of the appropriate
gender is not available, the synthesizer substitutes a voice with a
different gender rather than failing the request.
Returns
(::Google::Cloud::Dialogflow::CX::V3::SsmlVoiceGender) — Optional. The preferred gender of the voice. If not set, the service will
choose a voice based on the other parameters such as language_code and
name. Note that
this is only a preference, not requirement. If a voice of the appropriate
gender is not available, the synthesizer substitutes a voice with a
different gender rather than failing the request.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Dialogflow CX V3 API - Class Google::Cloud::Dialogflow::CX::V3::VoiceSelectionParams (v1.8.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.8.0 (latest)](/ruby/docs/reference/google-cloud-dialogflow-cx-v3/latest/Google-Cloud-Dialogflow-CX-V3-VoiceSelectionParams)\n- [1.7.0](/ruby/docs/reference/google-cloud-dialogflow-cx-v3/1.7.0/Google-Cloud-Dialogflow-CX-V3-VoiceSelectionParams)\n- [1.6.1](/ruby/docs/reference/google-cloud-dialogflow-cx-v3/1.6.1/Google-Cloud-Dialogflow-CX-V3-VoiceSelectionParams)\n- [1.5.0](/ruby/docs/reference/google-cloud-dialogflow-cx-v3/1.5.0/Google-Cloud-Dialogflow-CX-V3-VoiceSelectionParams)\n- [1.4.0](/ruby/docs/reference/google-cloud-dialogflow-cx-v3/1.4.0/Google-Cloud-Dialogflow-CX-V3-VoiceSelectionParams)\n- [1.3.0](/ruby/docs/reference/google-cloud-dialogflow-cx-v3/1.3.0/Google-Cloud-Dialogflow-CX-V3-VoiceSelectionParams)\n- [1.2.0](/ruby/docs/reference/google-cloud-dialogflow-cx-v3/1.2.0/Google-Cloud-Dialogflow-CX-V3-VoiceSelectionParams)\n- [1.1.1](/ruby/docs/reference/google-cloud-dialogflow-cx-v3/1.1.1/Google-Cloud-Dialogflow-CX-V3-VoiceSelectionParams)\n- [1.0.0](/ruby/docs/reference/google-cloud-dialogflow-cx-v3/1.0.0/Google-Cloud-Dialogflow-CX-V3-VoiceSelectionParams)\n- [0.26.0](/ruby/docs/reference/google-cloud-dialogflow-cx-v3/0.26.0/Google-Cloud-Dialogflow-CX-V3-VoiceSelectionParams)\n- [0.25.0](/ruby/docs/reference/google-cloud-dialogflow-cx-v3/0.25.0/Google-Cloud-Dialogflow-CX-V3-VoiceSelectionParams)\n- [0.24.2](/ruby/docs/reference/google-cloud-dialogflow-cx-v3/0.24.2/Google-Cloud-Dialogflow-CX-V3-VoiceSelectionParams)\n- [0.23.0](/ruby/docs/reference/google-cloud-dialogflow-cx-v3/0.23.0/Google-Cloud-Dialogflow-CX-V3-VoiceSelectionParams)\n- [0.22.0](/ruby/docs/reference/google-cloud-dialogflow-cx-v3/0.22.0/Google-Cloud-Dialogflow-CX-V3-VoiceSelectionParams)\n- [0.21.0](/ruby/docs/reference/google-cloud-dialogflow-cx-v3/0.21.0/Google-Cloud-Dialogflow-CX-V3-VoiceSelectionParams)\n- [0.20.0](/ruby/docs/reference/google-cloud-dialogflow-cx-v3/0.20.0/Google-Cloud-Dialogflow-CX-V3-VoiceSelectionParams)\n- [0.19.0](/ruby/docs/reference/google-cloud-dialogflow-cx-v3/0.19.0/Google-Cloud-Dialogflow-CX-V3-VoiceSelectionParams)\n- [0.18.0](/ruby/docs/reference/google-cloud-dialogflow-cx-v3/0.18.0/Google-Cloud-Dialogflow-CX-V3-VoiceSelectionParams)\n- [0.17.0](/ruby/docs/reference/google-cloud-dialogflow-cx-v3/0.17.0/Google-Cloud-Dialogflow-CX-V3-VoiceSelectionParams)\n- [0.16.0](/ruby/docs/reference/google-cloud-dialogflow-cx-v3/0.16.0/Google-Cloud-Dialogflow-CX-V3-VoiceSelectionParams)\n- [0.15.1](/ruby/docs/reference/google-cloud-dialogflow-cx-v3/0.15.1/Google-Cloud-Dialogflow-CX-V3-VoiceSelectionParams)\n- [0.14.0](/ruby/docs/reference/google-cloud-dialogflow-cx-v3/0.14.0/Google-Cloud-Dialogflow-CX-V3-VoiceSelectionParams)\n- [0.13.0](/ruby/docs/reference/google-cloud-dialogflow-cx-v3/0.13.0/Google-Cloud-Dialogflow-CX-V3-VoiceSelectionParams)\n- [0.12.0](/ruby/docs/reference/google-cloud-dialogflow-cx-v3/0.12.0/Google-Cloud-Dialogflow-CX-V3-VoiceSelectionParams)\n- [0.11.0](/ruby/docs/reference/google-cloud-dialogflow-cx-v3/0.11.0/Google-Cloud-Dialogflow-CX-V3-VoiceSelectionParams)\n- [0.10.2](/ruby/docs/reference/google-cloud-dialogflow-cx-v3/0.10.2/Google-Cloud-Dialogflow-CX-V3-VoiceSelectionParams)\n- [0.9.0](/ruby/docs/reference/google-cloud-dialogflow-cx-v3/0.9.0/Google-Cloud-Dialogflow-CX-V3-VoiceSelectionParams)\n- [0.8.1](/ruby/docs/reference/google-cloud-dialogflow-cx-v3/0.8.1/Google-Cloud-Dialogflow-CX-V3-VoiceSelectionParams)\n- [0.7.1](/ruby/docs/reference/google-cloud-dialogflow-cx-v3/0.7.1/Google-Cloud-Dialogflow-CX-V3-VoiceSelectionParams)\n- [0.6.0](/ruby/docs/reference/google-cloud-dialogflow-cx-v3/0.6.0/Google-Cloud-Dialogflow-CX-V3-VoiceSelectionParams)\n- [0.5.0](/ruby/docs/reference/google-cloud-dialogflow-cx-v3/0.5.0/Google-Cloud-Dialogflow-CX-V3-VoiceSelectionParams)\n- [0.4.0](/ruby/docs/reference/google-cloud-dialogflow-cx-v3/0.4.0/Google-Cloud-Dialogflow-CX-V3-VoiceSelectionParams) \nReference documentation and code samples for the Dialogflow CX V3 API class Google::Cloud::Dialogflow::CX::V3::VoiceSelectionParams.\n\nDescription of which voice to use for speech synthesis. \n\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #name\n\n def name() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Optional. The name of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and [ssml_gender](/ruby/docs/reference/google-cloud-dialogflow-cx-v3/latest/Google-Cloud-Dialogflow-CX-V3-VoiceSelectionParams#Google__Cloud__Dialogflow__CX__V3__VoiceSelectionParams_ssml_gender_instance_ \"Google::Cloud::Dialogflow::CX::V3::VoiceSelectionParams#ssml_gender (method)\").\n\n\n For the list of available voices, please refer to [Supported voices and\n languages](https://cloud.google.com/text-to-speech/docs/voices).\n\n### #name=\n\n def name=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Optional. The name of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and [ssml_gender](/ruby/docs/reference/google-cloud-dialogflow-cx-v3/latest/Google-Cloud-Dialogflow-CX-V3-VoiceSelectionParams#Google__Cloud__Dialogflow__CX__V3__VoiceSelectionParams_ssml_gender_instance_ \"Google::Cloud::Dialogflow::CX::V3::VoiceSelectionParams#ssml_gender (method)\").\n\n\n For the list of available voices, please refer to [Supported voices and\nlanguages](https://cloud.google.com/text-to-speech/docs/voices). \n**Returns**\n\n- (::String) --- Optional. The name of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and [ssml_gender](/ruby/docs/reference/google-cloud-dialogflow-cx-v3/latest/Google-Cloud-Dialogflow-CX-V3-VoiceSelectionParams#Google__Cloud__Dialogflow__CX__V3__VoiceSelectionParams_ssml_gender_instance_ \"Google::Cloud::Dialogflow::CX::V3::VoiceSelectionParams#ssml_gender (method)\").\n\n\n For the list of available voices, please refer to [Supported voices and\n languages](https://cloud.google.com/text-to-speech/docs/voices).\n\n### #ssml_gender\n\n def ssml_gender() -\u003e ::Google::Cloud::Dialogflow::CX::V3::SsmlVoiceGender\n\n**Returns**\n\n- ([::Google::Cloud::Dialogflow::CX::V3::SsmlVoiceGender](./Google-Cloud-Dialogflow-CX-V3-SsmlVoiceGender)) --- Optional. The preferred gender of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and [name](/ruby/docs/reference/google-cloud-dialogflow-cx-v3/latest/Google-Cloud-Dialogflow-CX-V3-VoiceSelectionParams#Google__Cloud__Dialogflow__CX__V3__VoiceSelectionParams_name_instance_ \"Google::Cloud::Dialogflow::CX::V3::VoiceSelectionParams#name (method)\"). Note that this is only a preference, not requirement. If a voice of the appropriate gender is not available, the synthesizer substitutes a voice with a different gender rather than failing the request.\n\n### #ssml_gender=\n\n def ssml_gender=(value) -\u003e ::Google::Cloud::Dialogflow::CX::V3::SsmlVoiceGender\n\n**Parameter**\n\n- **value** ([::Google::Cloud::Dialogflow::CX::V3::SsmlVoiceGender](./Google-Cloud-Dialogflow-CX-V3-SsmlVoiceGender)) --- Optional. The preferred gender of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and [name](/ruby/docs/reference/google-cloud-dialogflow-cx-v3/latest/Google-Cloud-Dialogflow-CX-V3-VoiceSelectionParams#Google__Cloud__Dialogflow__CX__V3__VoiceSelectionParams_name_instance_ \"Google::Cloud::Dialogflow::CX::V3::VoiceSelectionParams#name (method)\"). Note that this is only a preference, not requirement. If a voice of the appropriate gender is not available, the synthesizer substitutes a voice with a different gender rather than failing the request. \n**Returns**\n\n- ([::Google::Cloud::Dialogflow::CX::V3::SsmlVoiceGender](./Google-Cloud-Dialogflow-CX-V3-SsmlVoiceGender)) --- Optional. The preferred gender of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and [name](/ruby/docs/reference/google-cloud-dialogflow-cx-v3/latest/Google-Cloud-Dialogflow-CX-V3-VoiceSelectionParams#Google__Cloud__Dialogflow__CX__V3__VoiceSelectionParams_name_instance_ \"Google::Cloud::Dialogflow::CX::V3::VoiceSelectionParams#name (method)\"). Note that this is only a preference, not requirement. If a voice of the appropriate gender is not available, the synthesizer substitutes a voice with a different gender rather than failing the request."]]