telnyx 5.112.0 → 5.113.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +17 -0
- data/README.md +1 -1
- data/lib/telnyx/models/ai/assistant_create_params.rb +9 -178
- data/lib/telnyx/models/ai/assistant_integration.rb +38 -0
- data/lib/telnyx/models/ai/assistant_mcp_server.rb +35 -0
- data/lib/telnyx/models/ai/assistant_tool.rb +14 -14
- data/lib/telnyx/models/ai/assistant_update_params.rb +9 -178
- data/lib/telnyx/models/ai/assistants/canary_deploy.rb +3 -123
- data/lib/telnyx/models/ai/assistants/canary_deploy_response.rb +3 -125
- data/lib/telnyx/models/ai/assistants/clause.rb +54 -0
- data/lib/telnyx/models/ai/assistants/rollout_slot.rb +27 -0
- data/lib/telnyx/models/ai/assistants/rule_input.rb +40 -0
- data/lib/telnyx/models/ai/assistants/rule_output.rb +40 -0
- data/lib/telnyx/models/ai/assistants/serve.rb +33 -0
- data/lib/telnyx/models/ai/assistants/update_assistant.rb +9 -179
- data/lib/telnyx/models/ai/inference_embedding.rb +9 -177
- data/lib/telnyx/models/ai/inference_embedding_interruption_settings.rb +47 -0
- data/lib/telnyx/models/ai/openai_create_response_params.rb +3 -3
- data/lib/telnyx/models/ai/openai_list_models_response.rb +3 -210
- data/lib/telnyx/models/ai/start_speaking_plan.rb +37 -0
- data/lib/telnyx/models/ai/transcription_endpointing_plan.rb +39 -0
- data/lib/telnyx/models/ai/transfer_tool.rb +7 -9
- data/lib/telnyx/models/ai_create_response_params.rb +4 -4
- data/lib/telnyx/models/ai_retrieve_models_response.rb +3 -210
- data/lib/telnyx/models/call_conversation_ended.rb +13 -1
- data/lib/telnyx/models/calls/action_gather_using_ai_params.rb +4 -23
- data/lib/telnyx/models/calls/action_gather_using_speak_params.rb +4 -23
- data/lib/telnyx/models/calls/action_speak_params.rb +4 -23
- data/lib/telnyx/models/calls/action_start_ai_assistant_params.rb +4 -23
- data/lib/telnyx/models/calls/action_start_conversation_relay_params.rb +169 -118
- data/lib/telnyx/models/calls/transcription_engine_assemblyai_config.rb +64 -0
- data/lib/telnyx/models/calls/transcription_engine_speechmatics_config.rb +100 -0
- data/lib/telnyx/models/calls/transcription_engine_xai_config.rb +108 -0
- data/lib/telnyx/models/calls/transcription_start_request.rb +8 -167
- data/lib/telnyx/models/conferences/action_speak_params.rb +4 -23
- data/lib/telnyx/models/fax.rb +7 -5
- data/lib/telnyx/models/fax_create_params.rb +7 -5
- data/lib/telnyx/models/fax_delivered.rb +3 -2
- data/lib/telnyx/models/fax_failed.rb +3 -2
- data/lib/telnyx/models/fax_media_processed.rb +3 -2
- data/lib/telnyx/models/fax_queued.rb +3 -2
- data/lib/telnyx/models/fax_sending_started.rb +3 -2
- data/lib/telnyx/models/model_metadata.rb +212 -0
- data/lib/telnyx/models/network_list_interfaces_response.rb +112 -2
- data/lib/telnyx/models/public_internet_gateway_create_response.rb +3 -8
- data/lib/telnyx/models/public_internet_gateway_delete_response.rb +3 -8
- data/lib/telnyx/models/public_internet_gateway_read.rb +83 -0
- data/lib/telnyx/models/public_internet_gateway_retrieve_response.rb +3 -8
- data/lib/telnyx/models/texml/accounts/call_calls_params.rb +62 -12
- data/lib/telnyx/models/texml_initiate_ai_call_params.rb +18 -4
- data/lib/telnyx/models/text_to_speech_generate_params.rb +6 -6
- data/lib/telnyx/models/uac_connection.rb +412 -0
- data/lib/telnyx/models/uac_connection_create_params.rb +9 -255
- data/lib/telnyx/models/uac_connection_create_response.rb +3 -878
- data/lib/telnyx/models/uac_connection_delete_response.rb +3 -878
- data/lib/telnyx/models/uac_connection_retrieve_response.rb +3 -879
- data/lib/telnyx/models/uac_connection_update_params.rb +9 -255
- data/lib/telnyx/models/uac_connection_update_response.rb +3 -878
- data/lib/telnyx/models/uac_external_settings.rb +101 -0
- data/lib/telnyx/models/uac_inbound.rb +210 -0
- data/lib/telnyx/models/uac_internal_settings.rb +25 -0
- data/lib/telnyx/models/uac_outbound.rb +131 -0
- data/lib/telnyx/models/virtual_cross_connect_combined.rb +212 -0
- data/lib/telnyx/models/virtual_cross_connect_create_response.rb +3 -8
- data/lib/telnyx/models/virtual_cross_connect_delete_response.rb +3 -8
- data/lib/telnyx/models/virtual_cross_connect_retrieve_response.rb +3 -8
- data/lib/telnyx/models/virtual_cross_connect_update_response.rb +3 -8
- data/lib/telnyx/models/wireguard_interface_create_response.rb +3 -8
- data/lib/telnyx/models/wireguard_interface_delete_response.rb +3 -8
- data/lib/telnyx/models/wireguard_interface_read.rb +136 -0
- data/lib/telnyx/models/wireguard_interface_retrieve_response.rb +3 -8
- data/lib/telnyx/models/xai_voice_settings.rb +36 -0
- data/lib/telnyx/models.rb +20 -0
- data/lib/telnyx/resources/ai/assistants/canary_deploys.rb +2 -2
- data/lib/telnyx/resources/ai/assistants/versions.rb +3 -3
- data/lib/telnyx/resources/ai/assistants.rb +6 -6
- data/lib/telnyx/resources/ai/openai.rb +1 -1
- data/lib/telnyx/resources/ai.rb +3 -3
- data/lib/telnyx/resources/calls/actions.rb +15 -17
- data/lib/telnyx/resources/conferences/actions.rb +1 -1
- data/lib/telnyx/resources/faxes.rb +13 -1
- data/lib/telnyx/resources/public_internet_gateways.rb +2 -2
- data/lib/telnyx/resources/texml.rb +4 -2
- data/lib/telnyx/resources/uac_connections.rb +8 -8
- data/lib/telnyx/resources/virtual_cross_connects.rb +2 -2
- data/lib/telnyx/resources/wireguard_interfaces.rb +2 -2
- data/lib/telnyx/version.rb +1 -1
- data/lib/telnyx.rb +23 -4
- data/rbi/telnyx/models/ai/assistant_create_params.rbi +12 -352
- data/rbi/telnyx/models/ai/assistant_integration.rbi +60 -0
- data/rbi/telnyx/models/ai/assistant_mcp_server.rbi +51 -0
- data/rbi/telnyx/models/ai/assistant_tool.rbi +10 -10
- data/rbi/telnyx/models/ai/assistant_update_params.rbi +12 -352
- data/rbi/telnyx/models/ai/assistants/canary_deploy.rbi +4 -290
- data/rbi/telnyx/models/ai/assistants/canary_deploy_response.rbi +3 -301
- data/rbi/telnyx/models/ai/assistants/clause.rbi +91 -0
- data/rbi/telnyx/models/ai/assistants/rollout_slot.rbi +36 -0
- data/rbi/telnyx/models/ai/assistants/rule_input.rbi +73 -0
- data/rbi/telnyx/models/ai/assistants/rule_output.rbi +73 -0
- data/rbi/telnyx/models/ai/assistants/serve.rbi +61 -0
- data/rbi/telnyx/models/ai/assistants/update_assistant.rbi +12 -366
- data/rbi/telnyx/models/ai/inference_embedding.rbi +12 -351
- data/rbi/telnyx/models/ai/inference_embedding_interruption_settings.rbi +83 -0
- data/rbi/telnyx/models/ai/openai_create_response_params.rbi +4 -4
- data/rbi/telnyx/models/ai/openai_list_models_response.rbi +3 -315
- data/rbi/telnyx/models/ai/start_speaking_plan.rbi +70 -0
- data/rbi/telnyx/models/ai/transcription_endpointing_plan.rbi +71 -0
- data/rbi/telnyx/models/ai/transfer_tool.rbi +5 -5
- data/rbi/telnyx/models/ai_create_response_params.rbi +4 -4
- data/rbi/telnyx/models/ai_retrieve_models_response.rbi +3 -310
- data/rbi/telnyx/models/call_conversation_ended.rbi +10 -0
- data/rbi/telnyx/models/calls/action_gather_using_ai_params.rbi +5 -41
- data/rbi/telnyx/models/calls/action_gather_using_speak_params.rbi +5 -41
- data/rbi/telnyx/models/calls/action_speak_params.rbi +5 -41
- data/rbi/telnyx/models/calls/action_start_ai_assistant_params.rbi +5 -41
- data/rbi/telnyx/models/calls/action_start_conversation_relay_params.rbi +371 -254
- data/rbi/telnyx/models/calls/transcription_engine_assemblyai_config.rbi +155 -0
- data/rbi/telnyx/models/calls/transcription_engine_speechmatics_config.rbi +289 -0
- data/rbi/telnyx/models/calls/transcription_engine_xai_config.rbi +329 -0
- data/rbi/telnyx/models/calls/transcription_start_request.rbi +20 -480
- data/rbi/telnyx/models/conferences/action_speak_params.rbi +5 -41
- data/rbi/telnyx/models/fax.rbi +12 -8
- data/rbi/telnyx/models/fax_create_params.rbi +12 -8
- data/rbi/telnyx/models/fax_delivered.rbi +6 -4
- data/rbi/telnyx/models/fax_failed.rbi +6 -4
- data/rbi/telnyx/models/fax_media_processed.rbi +6 -4
- data/rbi/telnyx/models/fax_queued.rbi +6 -4
- data/rbi/telnyx/models/fax_sending_started.rbi +6 -4
- data/rbi/telnyx/models/model_metadata.rbi +272 -0
- data/rbi/telnyx/models/network_list_interfaces_response.rbi +181 -4
- data/rbi/telnyx/models/public_internet_gateway_create_response.rbi +6 -38
- data/rbi/telnyx/models/public_internet_gateway_delete_response.rbi +6 -38
- data/rbi/telnyx/models/public_internet_gateway_read.rbi +128 -0
- data/rbi/telnyx/models/public_internet_gateway_retrieve_response.rbi +6 -38
- data/rbi/telnyx/models/texml/accounts/call_calls_params.rbi +81 -9
- data/rbi/telnyx/models/texml_initiate_ai_call_params.rbi +27 -3
- data/rbi/telnyx/models/text_to_speech_generate_params.rbi +6 -6
- data/rbi/telnyx/models/uac_connection.rbi +684 -0
- data/rbi/telnyx/models/uac_connection_create_params.rbi +12 -516
- data/rbi/telnyx/models/uac_connection_create_response.rbi +4 -1756
- data/rbi/telnyx/models/uac_connection_delete_response.rbi +4 -1756
- data/rbi/telnyx/models/uac_connection_retrieve_response.rbi +4 -1756
- data/rbi/telnyx/models/uac_connection_update_params.rbi +12 -516
- data/rbi/telnyx/models/uac_connection_update_response.rbi +4 -1756
- data/rbi/telnyx/models/uac_external_settings.rbi +146 -0
- data/rbi/telnyx/models/uac_inbound.rbi +410 -0
- data/rbi/telnyx/models/uac_internal_settings.rbi +39 -0
- data/rbi/telnyx/models/uac_outbound.rbi +224 -0
- data/rbi/telnyx/models/virtual_cross_connect_combined.rbi +345 -0
- data/rbi/telnyx/models/virtual_cross_connect_create_response.rbi +6 -36
- data/rbi/telnyx/models/virtual_cross_connect_delete_response.rbi +6 -36
- data/rbi/telnyx/models/virtual_cross_connect_retrieve_response.rbi +6 -38
- data/rbi/telnyx/models/virtual_cross_connect_update_response.rbi +6 -36
- data/rbi/telnyx/models/wireguard_interface_create_response.rbi +6 -36
- data/rbi/telnyx/models/wireguard_interface_delete_response.rbi +6 -36
- data/rbi/telnyx/models/wireguard_interface_read.rbi +213 -0
- data/rbi/telnyx/models/wireguard_interface_retrieve_response.rbi +6 -36
- data/rbi/telnyx/models/xai_voice_settings.rbi +64 -0
- data/rbi/telnyx/models.rbi +20 -0
- data/rbi/telnyx/resources/ai/assistants/canary_deploys.rbi +2 -4
- data/rbi/telnyx/resources/ai/assistants/versions.rbi +3 -9
- data/rbi/telnyx/resources/ai/assistants.rbi +6 -10
- data/rbi/telnyx/resources/ai/openai.rbi +1 -1
- data/rbi/telnyx/resources/ai.rbi +2 -2
- data/rbi/telnyx/resources/calls/actions.rbi +24 -24
- data/rbi/telnyx/resources/conferences/actions.rbi +1 -1
- data/rbi/telnyx/resources/faxes.rbi +18 -4
- data/rbi/telnyx/resources/public_internet_gateways.rbi +1 -1
- data/rbi/telnyx/resources/texml.rbi +7 -1
- data/rbi/telnyx/resources/uac_connections.rbi +7 -13
- data/rbi/telnyx/resources/virtual_cross_connects.rbi +1 -1
- data/rbi/telnyx/resources/wireguard_interfaces.rbi +1 -1
- data/sig/telnyx/models/ai/assistant_create_params.rbs +18 -149
- data/sig/telnyx/models/ai/assistant_integration.rbs +26 -0
- data/sig/telnyx/models/ai/assistant_mcp_server.rbs +19 -0
- data/sig/telnyx/models/ai/assistant_tool.rbs +8 -8
- data/sig/telnyx/models/ai/assistant_update_params.rbs +18 -149
- data/sig/telnyx/models/ai/assistants/canary_deploy.rbs +6 -113
- data/sig/telnyx/models/ai/assistants/canary_deploy_response.rbs +4 -109
- data/sig/telnyx/models/ai/assistants/clause.rbs +46 -0
- data/sig/telnyx/models/ai/assistants/rollout_slot.rbs +19 -0
- data/sig/telnyx/models/ai/assistants/rule_input.rbs +33 -0
- data/sig/telnyx/models/ai/assistants/rule_output.rbs +33 -0
- data/sig/telnyx/models/ai/assistants/serve.rbs +35 -0
- data/sig/telnyx/models/ai/assistants/update_assistant.rbs +18 -152
- data/sig/telnyx/models/ai/inference_embedding.rbs +18 -149
- data/sig/telnyx/models/ai/inference_embedding_interruption_settings.rbs +40 -0
- data/sig/telnyx/models/ai/openai_create_response_params.rbs +5 -5
- data/sig/telnyx/models/ai/openai_list_models_response.rbs +4 -149
- data/sig/telnyx/models/ai/start_speaking_plan.rbs +33 -0
- data/sig/telnyx/models/ai/transcription_endpointing_plan.rbs +38 -0
- data/sig/telnyx/models/ai/transfer_tool.rbs +4 -4
- data/sig/telnyx/models/ai_create_response_params.rbs +5 -4
- data/sig/telnyx/models/ai_retrieve_models_response.rbs +4 -149
- data/sig/telnyx/models/call_conversation_ended.rbs +5 -0
- data/sig/telnyx/models/calls/action_gather_using_ai_params.rbs +1 -15
- data/sig/telnyx/models/calls/action_gather_using_speak_params.rbs +1 -15
- data/sig/telnyx/models/calls/action_speak_params.rbs +1 -15
- data/sig/telnyx/models/calls/action_start_ai_assistant_params.rbs +1 -15
- data/sig/telnyx/models/calls/action_start_conversation_relay_params.rbs +141 -102
- data/sig/telnyx/models/calls/transcription_engine_assemblyai_config.rbs +62 -0
- data/sig/telnyx/models/calls/transcription_engine_speechmatics_config.rbs +114 -0
- data/sig/telnyx/models/calls/transcription_engine_xai_config.rbs +130 -0
- data/sig/telnyx/models/calls/transcription_start_request.rbs +13 -185
- data/sig/telnyx/models/conferences/action_speak_params.rbs +1 -15
- data/sig/telnyx/models/model_metadata.rbs +142 -0
- data/sig/telnyx/models/network_list_interfaces_response.rbs +106 -4
- data/sig/telnyx/models/public_internet_gateway_create_response.rbs +6 -18
- data/sig/telnyx/models/public_internet_gateway_delete_response.rbs +6 -18
- data/sig/telnyx/models/public_internet_gateway_read.rbs +80 -0
- data/sig/telnyx/models/public_internet_gateway_retrieve_response.rbs +6 -18
- data/sig/telnyx/models/texml/accounts/call_calls_params.rbs +27 -3
- data/sig/telnyx/models/texml_initiate_ai_call_params.rbs +9 -1
- data/sig/telnyx/models/text_to_speech_generate_params.rbs +6 -6
- data/sig/telnyx/models/uac_connection.rbs +338 -0
- data/sig/telnyx/models/uac_connection_create_params.rbs +17 -211
- data/sig/telnyx/models/uac_connection_create_response.rbs +5 -731
- data/sig/telnyx/models/uac_connection_delete_response.rbs +5 -731
- data/sig/telnyx/models/uac_connection_retrieve_response.rbs +5 -731
- data/sig/telnyx/models/uac_connection_update_params.rbs +17 -211
- data/sig/telnyx/models/uac_connection_update_response.rbs +5 -731
- data/sig/telnyx/models/uac_external_settings.rbs +73 -0
- data/sig/telnyx/models/uac_inbound.rbs +190 -0
- data/sig/telnyx/models/uac_internal_settings.rbs +15 -0
- data/sig/telnyx/models/uac_outbound.rbs +113 -0
- data/sig/telnyx/models/virtual_cross_connect_combined.rbs +190 -0
- data/sig/telnyx/models/virtual_cross_connect_create_response.rbs +6 -18
- data/sig/telnyx/models/virtual_cross_connect_delete_response.rbs +6 -18
- data/sig/telnyx/models/virtual_cross_connect_retrieve_response.rbs +6 -18
- data/sig/telnyx/models/virtual_cross_connect_update_response.rbs +6 -18
- data/sig/telnyx/models/wireguard_interface_create_response.rbs +6 -18
- data/sig/telnyx/models/wireguard_interface_delete_response.rbs +6 -18
- data/sig/telnyx/models/wireguard_interface_read.rbs +127 -0
- data/sig/telnyx/models/wireguard_interface_retrieve_response.rbs +6 -18
- data/sig/telnyx/models/xai_voice_settings.rbs +34 -0
- data/sig/telnyx/models.rbs +20 -0
- data/sig/telnyx/resources/ai/assistants/canary_deploys.rbs +2 -2
- data/sig/telnyx/resources/ai/assistants/versions.rbs +3 -3
- data/sig/telnyx/resources/ai/assistants.rbs +6 -6
- data/sig/telnyx/resources/ai/openai.rbs +1 -1
- data/sig/telnyx/resources/ai.rbs +1 -1
- data/sig/telnyx/resources/calls/actions.rbs +2 -4
- data/sig/telnyx/resources/public_internet_gateways.rbs +1 -1
- data/sig/telnyx/resources/texml.rbs +1 -0
- data/sig/telnyx/resources/uac_connections.rbs +7 -7
- data/sig/telnyx/resources/virtual_cross_connects.rbs +1 -1
- data/sig/telnyx/resources/wireguard_interfaces.rbs +1 -1
- metadata +71 -14
- data/lib/telnyx/models/public_internet_gateway_list_response.rb +0 -10
- data/lib/telnyx/models/uac_connection_list_response.rb +0 -876
- data/lib/telnyx/models/virtual_cross_connect_list_response.rb +0 -10
- data/lib/telnyx/models/wireguard_interface_list_response.rb +0 -10
- data/rbi/telnyx/models/public_internet_gateway_list_response.rbi +0 -23
- data/rbi/telnyx/models/uac_connection_list_response.rbi +0 -1727
- data/rbi/telnyx/models/virtual_cross_connect_list_response.rbi +0 -23
- data/rbi/telnyx/models/wireguard_interface_list_response.rbi +0 -23
- data/sig/telnyx/models/public_internet_gateway_list_response.rbs +0 -11
- data/sig/telnyx/models/uac_connection_list_response.rbs +0 -722
- data/sig/telnyx/models/virtual_cross_connect_list_response.rbs +0 -11
- data/sig/telnyx/models/wireguard_interface_list_response.rbs +0 -11
|
@@ -144,7 +144,7 @@ module Telnyx
|
|
|
144
144
|
# @!attribute voice_settings
|
|
145
145
|
# The settings associated with the voice selected
|
|
146
146
|
#
|
|
147
|
-
# @return [Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::AzureVoiceSettings, Telnyx::Models::RimeVoiceSettings, Telnyx::Models::ResembleVoiceSettings, Telnyx::Models::
|
|
147
|
+
# @return [Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::AzureVoiceSettings, Telnyx::Models::RimeVoiceSettings, Telnyx::Models::ResembleVoiceSettings, Telnyx::Models::XaiVoiceSettings, nil]
|
|
148
148
|
optional :voice_settings, union: -> { Telnyx::Calls::ActionGatherUsingAIParams::VoiceSettings }
|
|
149
149
|
|
|
150
150
|
# @!method initialize(call_control_id:, parameters:, assistant: nil, client_state: nil, command_id: nil, gather_ended_speech: nil, greeting: nil, interruption_settings: nil, language: nil, message_history: nil, send_message_history_updates: nil, send_partial_results: nil, transcription: nil, user_response_timeout_ms: nil, voice: nil, voice_settings: nil, request_options: {})
|
|
@@ -181,7 +181,7 @@ module Telnyx
|
|
|
181
181
|
#
|
|
182
182
|
# @param voice [String] The voice to be used by the voice assistant. Currently we support ElevenLabs, Te
|
|
183
183
|
#
|
|
184
|
-
# @param voice_settings [Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::AzureVoiceSettings, Telnyx::Models::RimeVoiceSettings, Telnyx::Models::ResembleVoiceSettings, Telnyx::Models::
|
|
184
|
+
# @param voice_settings [Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::AzureVoiceSettings, Telnyx::Models::RimeVoiceSettings, Telnyx::Models::ResembleVoiceSettings, Telnyx::Models::XaiVoiceSettings] The settings associated with the voice selected
|
|
185
185
|
#
|
|
186
186
|
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
|
|
187
187
|
|
|
@@ -235,29 +235,10 @@ module Telnyx
|
|
|
235
235
|
|
|
236
236
|
variant :resemble, -> { Telnyx::ResembleVoiceSettings }
|
|
237
237
|
|
|
238
|
-
variant :xai, -> { Telnyx::
|
|
239
|
-
|
|
240
|
-
class Xai < Telnyx::Internal::Type::BaseModel
|
|
241
|
-
# @!attribute type
|
|
242
|
-
# Voice settings provider type
|
|
243
|
-
#
|
|
244
|
-
# @return [Symbol, :xai]
|
|
245
|
-
required :type, const: :xai
|
|
246
|
-
|
|
247
|
-
# @!attribute language
|
|
248
|
-
# Language code, or `auto` to detect automatically.
|
|
249
|
-
#
|
|
250
|
-
# @return [String, nil]
|
|
251
|
-
optional :language, String
|
|
252
|
-
|
|
253
|
-
# @!method initialize(language: nil, type: :xai)
|
|
254
|
-
# @param language [String] Language code, or `auto` to detect automatically.
|
|
255
|
-
#
|
|
256
|
-
# @param type [Symbol, :xai] Voice settings provider type
|
|
257
|
-
end
|
|
238
|
+
variant :xai, -> { Telnyx::XaiVoiceSettings }
|
|
258
239
|
|
|
259
240
|
# @!method self.variants
|
|
260
|
-
# @return [Array(Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::AzureVoiceSettings, Telnyx::Models::RimeVoiceSettings, Telnyx::Models::ResembleVoiceSettings, Telnyx::Models::
|
|
241
|
+
# @return [Array(Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::AzureVoiceSettings, Telnyx::Models::RimeVoiceSettings, Telnyx::Models::ResembleVoiceSettings, Telnyx::Models::XaiVoiceSettings)]
|
|
261
242
|
end
|
|
262
243
|
end
|
|
263
244
|
end
|
|
@@ -160,7 +160,7 @@ module Telnyx
|
|
|
160
160
|
# @!attribute voice_settings
|
|
161
161
|
# The settings associated with the voice selected
|
|
162
162
|
#
|
|
163
|
-
# @return [Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::MinimaxVoiceSettings, Telnyx::Models::AzureVoiceSettings, Telnyx::Models::RimeVoiceSettings, Telnyx::Models::ResembleVoiceSettings, Telnyx::Models::Calls::ActionGatherUsingSpeakParams::VoiceSettings::Inworld, Telnyx::Models::
|
|
163
|
+
# @return [Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::MinimaxVoiceSettings, Telnyx::Models::AzureVoiceSettings, Telnyx::Models::RimeVoiceSettings, Telnyx::Models::ResembleVoiceSettings, Telnyx::Models::Calls::ActionGatherUsingSpeakParams::VoiceSettings::Inworld, Telnyx::Models::XaiVoiceSettings, nil]
|
|
164
164
|
optional :voice_settings, union: -> { Telnyx::Calls::ActionGatherUsingSpeakParams::VoiceSettings }
|
|
165
165
|
|
|
166
166
|
# @!method initialize(call_control_id:, payload:, voice:, client_state: nil, command_id: nil, inter_digit_timeout_millis: nil, invalid_payload: nil, language: nil, maximum_digits: nil, maximum_tries: nil, minimum_digits: nil, payload_type: nil, service_level: nil, terminating_digit: nil, timeout_millis: nil, valid_digits: nil, voice_settings: nil, request_options: {})
|
|
@@ -200,7 +200,7 @@ module Telnyx
|
|
|
200
200
|
#
|
|
201
201
|
# @param valid_digits [String] A list of all digits accepted as valid.
|
|
202
202
|
#
|
|
203
|
-
# @param voice_settings [Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::MinimaxVoiceSettings, Telnyx::Models::AzureVoiceSettings, Telnyx::Models::RimeVoiceSettings, Telnyx::Models::ResembleVoiceSettings, Telnyx::Models::Calls::ActionGatherUsingSpeakParams::VoiceSettings::Inworld, Telnyx::Models::
|
|
203
|
+
# @param voice_settings [Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::MinimaxVoiceSettings, Telnyx::Models::AzureVoiceSettings, Telnyx::Models::RimeVoiceSettings, Telnyx::Models::ResembleVoiceSettings, Telnyx::Models::Calls::ActionGatherUsingSpeakParams::VoiceSettings::Inworld, Telnyx::Models::XaiVoiceSettings] The settings associated with the voice selected
|
|
204
204
|
#
|
|
205
205
|
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
|
|
206
206
|
|
|
@@ -289,7 +289,7 @@ module Telnyx
|
|
|
289
289
|
|
|
290
290
|
variant :inworld, -> { Telnyx::Calls::ActionGatherUsingSpeakParams::VoiceSettings::Inworld }
|
|
291
291
|
|
|
292
|
-
variant :xai, -> { Telnyx::
|
|
292
|
+
variant :xai, -> { Telnyx::XaiVoiceSettings }
|
|
293
293
|
|
|
294
294
|
class Inworld < Telnyx::Internal::Type::BaseModel
|
|
295
295
|
# @!attribute type
|
|
@@ -302,27 +302,8 @@ module Telnyx
|
|
|
302
302
|
# @param type [Symbol, :inworld] Voice settings provider type
|
|
303
303
|
end
|
|
304
304
|
|
|
305
|
-
class Xai < Telnyx::Internal::Type::BaseModel
|
|
306
|
-
# @!attribute type
|
|
307
|
-
# Voice settings provider type
|
|
308
|
-
#
|
|
309
|
-
# @return [Symbol, :xai]
|
|
310
|
-
required :type, const: :xai
|
|
311
|
-
|
|
312
|
-
# @!attribute language
|
|
313
|
-
# Language code, or `auto` to detect automatically.
|
|
314
|
-
#
|
|
315
|
-
# @return [String, nil]
|
|
316
|
-
optional :language, String
|
|
317
|
-
|
|
318
|
-
# @!method initialize(language: nil, type: :xai)
|
|
319
|
-
# @param language [String] Language code, or `auto` to detect automatically.
|
|
320
|
-
#
|
|
321
|
-
# @param type [Symbol, :xai] Voice settings provider type
|
|
322
|
-
end
|
|
323
|
-
|
|
324
305
|
# @!method self.variants
|
|
325
|
-
# @return [Array(Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::MinimaxVoiceSettings, Telnyx::Models::AzureVoiceSettings, Telnyx::Models::RimeVoiceSettings, Telnyx::Models::ResembleVoiceSettings, Telnyx::Models::Calls::ActionGatherUsingSpeakParams::VoiceSettings::Inworld, Telnyx::Models::
|
|
306
|
+
# @return [Array(Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::MinimaxVoiceSettings, Telnyx::Models::AzureVoiceSettings, Telnyx::Models::RimeVoiceSettings, Telnyx::Models::ResembleVoiceSettings, Telnyx::Models::Calls::ActionGatherUsingSpeakParams::VoiceSettings::Inworld, Telnyx::Models::XaiVoiceSettings)]
|
|
326
307
|
end
|
|
327
308
|
end
|
|
328
309
|
end
|
|
@@ -128,7 +128,7 @@ module Telnyx
|
|
|
128
128
|
# @!attribute voice_settings
|
|
129
129
|
# The settings associated with the voice selected
|
|
130
130
|
#
|
|
131
|
-
# @return [Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::MinimaxVoiceSettings, Telnyx::Models::AzureVoiceSettings, Telnyx::Models::RimeVoiceSettings, Telnyx::Models::ResembleVoiceSettings, Telnyx::Models::Calls::ActionSpeakParams::VoiceSettings::Inworld, Telnyx::Models::
|
|
131
|
+
# @return [Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::MinimaxVoiceSettings, Telnyx::Models::AzureVoiceSettings, Telnyx::Models::RimeVoiceSettings, Telnyx::Models::ResembleVoiceSettings, Telnyx::Models::Calls::ActionSpeakParams::VoiceSettings::Inworld, Telnyx::Models::XaiVoiceSettings, nil]
|
|
132
132
|
optional :voice_settings, union: -> { Telnyx::Calls::ActionSpeakParams::VoiceSettings }
|
|
133
133
|
|
|
134
134
|
# @!method initialize(call_control_id:, payload:, voice:, client_state: nil, command_id: nil, language: nil, loop_: nil, payload_type: nil, service_level: nil, stop: nil, target_legs: nil, voice_settings: nil, request_options: {})
|
|
@@ -157,7 +157,7 @@ module Telnyx
|
|
|
157
157
|
#
|
|
158
158
|
# @param target_legs [Symbol, Telnyx::Models::Calls::ActionSpeakParams::TargetLegs] Specifies which legs of the call should receive the spoken audio.
|
|
159
159
|
#
|
|
160
|
-
# @param voice_settings [Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::MinimaxVoiceSettings, Telnyx::Models::AzureVoiceSettings, Telnyx::Models::RimeVoiceSettings, Telnyx::Models::ResembleVoiceSettings, Telnyx::Models::Calls::ActionSpeakParams::VoiceSettings::Inworld, Telnyx::Models::
|
|
160
|
+
# @param voice_settings [Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::MinimaxVoiceSettings, Telnyx::Models::AzureVoiceSettings, Telnyx::Models::RimeVoiceSettings, Telnyx::Models::ResembleVoiceSettings, Telnyx::Models::Calls::ActionSpeakParams::VoiceSettings::Inworld, Telnyx::Models::XaiVoiceSettings] The settings associated with the voice selected
|
|
161
161
|
#
|
|
162
162
|
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
|
|
163
163
|
|
|
@@ -258,7 +258,7 @@ module Telnyx
|
|
|
258
258
|
|
|
259
259
|
variant :inworld, -> { Telnyx::Calls::ActionSpeakParams::VoiceSettings::Inworld }
|
|
260
260
|
|
|
261
|
-
variant :xai, -> { Telnyx::
|
|
261
|
+
variant :xai, -> { Telnyx::XaiVoiceSettings }
|
|
262
262
|
|
|
263
263
|
class Inworld < Telnyx::Internal::Type::BaseModel
|
|
264
264
|
# @!attribute type
|
|
@@ -271,27 +271,8 @@ module Telnyx
|
|
|
271
271
|
# @param type [Symbol, :inworld] Voice settings provider type
|
|
272
272
|
end
|
|
273
273
|
|
|
274
|
-
class Xai < Telnyx::Internal::Type::BaseModel
|
|
275
|
-
# @!attribute type
|
|
276
|
-
# Voice settings provider type
|
|
277
|
-
#
|
|
278
|
-
# @return [Symbol, :xai]
|
|
279
|
-
required :type, const: :xai
|
|
280
|
-
|
|
281
|
-
# @!attribute language
|
|
282
|
-
# Language code, or `auto` to detect automatically.
|
|
283
|
-
#
|
|
284
|
-
# @return [String, nil]
|
|
285
|
-
optional :language, String
|
|
286
|
-
|
|
287
|
-
# @!method initialize(language: nil, type: :xai)
|
|
288
|
-
# @param language [String] Language code, or `auto` to detect automatically.
|
|
289
|
-
#
|
|
290
|
-
# @param type [Symbol, :xai] Voice settings provider type
|
|
291
|
-
end
|
|
292
|
-
|
|
293
274
|
# @!method self.variants
|
|
294
|
-
# @return [Array(Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::MinimaxVoiceSettings, Telnyx::Models::AzureVoiceSettings, Telnyx::Models::RimeVoiceSettings, Telnyx::Models::ResembleVoiceSettings, Telnyx::Models::Calls::ActionSpeakParams::VoiceSettings::Inworld, Telnyx::Models::
|
|
275
|
+
# @return [Array(Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::MinimaxVoiceSettings, Telnyx::Models::AzureVoiceSettings, Telnyx::Models::RimeVoiceSettings, Telnyx::Models::ResembleVoiceSettings, Telnyx::Models::Calls::ActionSpeakParams::VoiceSettings::Inworld, Telnyx::Models::XaiVoiceSettings)]
|
|
295
276
|
end
|
|
296
277
|
end
|
|
297
278
|
end
|
|
@@ -114,7 +114,7 @@ module Telnyx
|
|
|
114
114
|
# @!attribute voice_settings
|
|
115
115
|
# The settings associated with the voice selected
|
|
116
116
|
#
|
|
117
|
-
# @return [Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::AzureVoiceSettings, Telnyx::Models::RimeVoiceSettings, Telnyx::Models::ResembleVoiceSettings, Telnyx::Models::
|
|
117
|
+
# @return [Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::AzureVoiceSettings, Telnyx::Models::RimeVoiceSettings, Telnyx::Models::ResembleVoiceSettings, Telnyx::Models::XaiVoiceSettings, nil]
|
|
118
118
|
optional :voice_settings, union: -> { Telnyx::Calls::ActionStartAIAssistantParams::VoiceSettings }
|
|
119
119
|
|
|
120
120
|
# @!method initialize(call_control_id:, assistant: nil, client_state: nil, command_id: nil, greeting: nil, interruption_settings: nil, message_history: nil, participants: nil, send_message_history_updates: nil, transcription: nil, voice: nil, voice_settings: nil, request_options: {})
|
|
@@ -143,7 +143,7 @@ module Telnyx
|
|
|
143
143
|
#
|
|
144
144
|
# @param voice [String] The voice to be used by the voice assistant. Currently we support ElevenLabs, Te
|
|
145
145
|
#
|
|
146
|
-
# @param voice_settings [Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::AzureVoiceSettings, Telnyx::Models::RimeVoiceSettings, Telnyx::Models::ResembleVoiceSettings, Telnyx::Models::
|
|
146
|
+
# @param voice_settings [Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::AzureVoiceSettings, Telnyx::Models::RimeVoiceSettings, Telnyx::Models::ResembleVoiceSettings, Telnyx::Models::XaiVoiceSettings] The settings associated with the voice selected
|
|
147
147
|
#
|
|
148
148
|
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
|
|
149
149
|
|
|
@@ -468,29 +468,10 @@ module Telnyx
|
|
|
468
468
|
|
|
469
469
|
variant :resemble, -> { Telnyx::ResembleVoiceSettings }
|
|
470
470
|
|
|
471
|
-
variant :xai, -> { Telnyx::
|
|
472
|
-
|
|
473
|
-
class Xai < Telnyx::Internal::Type::BaseModel
|
|
474
|
-
# @!attribute type
|
|
475
|
-
# Voice settings provider type
|
|
476
|
-
#
|
|
477
|
-
# @return [Symbol, :xai]
|
|
478
|
-
required :type, const: :xai
|
|
479
|
-
|
|
480
|
-
# @!attribute language
|
|
481
|
-
# Language code, or `auto` to detect automatically.
|
|
482
|
-
#
|
|
483
|
-
# @return [String, nil]
|
|
484
|
-
optional :language, String
|
|
485
|
-
|
|
486
|
-
# @!method initialize(language: nil, type: :xai)
|
|
487
|
-
# @param language [String] Language code, or `auto` to detect automatically.
|
|
488
|
-
#
|
|
489
|
-
# @param type [Symbol, :xai] Voice settings provider type
|
|
490
|
-
end
|
|
471
|
+
variant :xai, -> { Telnyx::XaiVoiceSettings }
|
|
491
472
|
|
|
492
473
|
# @!method self.variants
|
|
493
|
-
# @return [Array(Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::AzureVoiceSettings, Telnyx::Models::RimeVoiceSettings, Telnyx::Models::ResembleVoiceSettings, Telnyx::Models::
|
|
474
|
+
# @return [Array(Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::AzureVoiceSettings, Telnyx::Models::RimeVoiceSettings, Telnyx::Models::ResembleVoiceSettings, Telnyx::Models::XaiVoiceSettings)]
|
|
494
475
|
end
|
|
495
476
|
end
|
|
496
477
|
end
|
|
@@ -13,13 +13,6 @@ module Telnyx
|
|
|
13
13
|
# @return [String]
|
|
14
14
|
required :call_control_id, String
|
|
15
15
|
|
|
16
|
-
# @!attribute conversation_relay_url
|
|
17
|
-
# WebSocket URL for your Conversation Relay server. Must start with `ws://` or
|
|
18
|
-
# `wss://`.
|
|
19
|
-
#
|
|
20
|
-
# @return [String]
|
|
21
|
-
required :conversation_relay_url, String
|
|
22
|
-
|
|
23
16
|
# @!attribute assistant
|
|
24
17
|
# Custom parameters for the Conversation Relay session. Pass key-value data as
|
|
25
18
|
# `assistant.dynamic_variables` to make it available to the relay session.
|
|
@@ -47,6 +40,25 @@ module Telnyx
|
|
|
47
40
|
# @return [Boolean, nil]
|
|
48
41
|
optional :conversation_relay_dtmf_detection, Telnyx::Internal::Type::Boolean
|
|
49
42
|
|
|
43
|
+
# @!attribute conversation_relay_settings
|
|
44
|
+
# Conversation Relay connection settings. This object is used by TeXML Call
|
|
45
|
+
# Scripting's `<ConversationRelay>` verb. The `interruptible` and
|
|
46
|
+
# `interruptible_greeting` fields are shorthand for
|
|
47
|
+
# `interruption_settings.interruptible` and
|
|
48
|
+
# `interruption_settings.interruptible_greeting`; use top-level
|
|
49
|
+
# `interruption_settings` for the full interruption settings shape.
|
|
50
|
+
#
|
|
51
|
+
# @return [Telnyx::Models::Calls::ActionStartConversationRelayParams::ConversationRelaySettings, nil]
|
|
52
|
+
optional :conversation_relay_settings,
|
|
53
|
+
-> { Telnyx::Calls::ActionStartConversationRelayParams::ConversationRelaySettings }
|
|
54
|
+
|
|
55
|
+
# @!attribute conversation_relay_url
|
|
56
|
+
# WebSocket URL for your Conversation Relay server. Must start with `ws://` or
|
|
57
|
+
# `wss://`.
|
|
58
|
+
#
|
|
59
|
+
# @return [String, nil]
|
|
60
|
+
optional :conversation_relay_url, String
|
|
61
|
+
|
|
50
62
|
# @!attribute greeting
|
|
51
63
|
# Text played when the relay session starts.
|
|
52
64
|
#
|
|
@@ -76,19 +88,6 @@ module Telnyx
|
|
|
76
88
|
optional :languages,
|
|
77
89
|
-> { Telnyx::Internal::Type::ArrayOf[Telnyx::Calls::ActionStartConversationRelayParams::Language] }
|
|
78
90
|
|
|
79
|
-
# @!attribute participants
|
|
80
|
-
# Participants to add to the conversation.
|
|
81
|
-
#
|
|
82
|
-
# @return [Array<Telnyx::Models::Calls::ActionStartConversationRelayParams::Participant>, nil]
|
|
83
|
-
optional :participants,
|
|
84
|
-
-> { Telnyx::Internal::Type::ArrayOf[Telnyx::Calls::ActionStartConversationRelayParams::Participant] }
|
|
85
|
-
|
|
86
|
-
# @!attribute send_message_history_updates
|
|
87
|
-
# When true, sends message history update webhooks.
|
|
88
|
-
#
|
|
89
|
-
# @return [Boolean, nil]
|
|
90
|
-
optional :send_message_history_updates, Telnyx::Internal::Type::Boolean
|
|
91
|
-
|
|
92
91
|
# @!attribute transcription
|
|
93
92
|
# Speech-to-text settings for Conversation Relay.
|
|
94
93
|
#
|
|
@@ -108,12 +107,6 @@ module Telnyx
|
|
|
108
107
|
# @return [String, nil]
|
|
109
108
|
optional :tts_language, String
|
|
110
109
|
|
|
111
|
-
# @!attribute user_response_timeout_ms
|
|
112
|
-
# Time in milliseconds to wait for caller input before timing out.
|
|
113
|
-
#
|
|
114
|
-
# @return [Integer, nil]
|
|
115
|
-
optional :user_response_timeout_ms, Integer
|
|
116
|
-
|
|
117
110
|
# @!attribute voice
|
|
118
111
|
# The voice to be used by the voice assistant. Currently we support ElevenLabs,
|
|
119
112
|
# Telnyx and AWS voices.
|
|
@@ -148,17 +141,15 @@ module Telnyx
|
|
|
148
141
|
# @!attribute voice_settings
|
|
149
142
|
# The settings associated with the voice selected
|
|
150
143
|
#
|
|
151
|
-
# @return [Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::AzureVoiceSettings, Telnyx::Models::RimeVoiceSettings, Telnyx::Models::ResembleVoiceSettings, Telnyx::Models::
|
|
144
|
+
# @return [Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::AzureVoiceSettings, Telnyx::Models::RimeVoiceSettings, Telnyx::Models::ResembleVoiceSettings, Telnyx::Models::XaiVoiceSettings, nil]
|
|
152
145
|
optional :voice_settings, union: -> { Telnyx::Calls::ActionStartConversationRelayParams::VoiceSettings }
|
|
153
146
|
|
|
154
|
-
# @!method initialize(call_control_id:,
|
|
147
|
+
# @!method initialize(call_control_id:, assistant: nil, client_state: nil, command_id: nil, conversation_relay_dtmf_detection: nil, conversation_relay_settings: nil, conversation_relay_url: nil, greeting: nil, interruption_settings: nil, language: nil, languages: nil, transcription: nil, transcription_language: nil, tts_language: nil, voice: nil, voice_settings: nil, request_options: {})
|
|
155
148
|
# Some parameter documentations has been truncated, see
|
|
156
149
|
# {Telnyx::Models::Calls::ActionStartConversationRelayParams} for more details.
|
|
157
150
|
#
|
|
158
151
|
# @param call_control_id [String]
|
|
159
152
|
#
|
|
160
|
-
# @param conversation_relay_url [String] WebSocket URL for your Conversation Relay server. Must start with `ws://` or `ws
|
|
161
|
-
#
|
|
162
153
|
# @param assistant [Telnyx::Models::Calls::ActionStartConversationRelayParams::Assistant] Custom parameters for the Conversation Relay session. Pass key-value data as `as
|
|
163
154
|
#
|
|
164
155
|
# @param client_state [String] Use this field to add state to subsequent webhooks. It must be a valid Base-64 e
|
|
@@ -167,6 +158,10 @@ module Telnyx
|
|
|
167
158
|
#
|
|
168
159
|
# @param conversation_relay_dtmf_detection [Boolean] Enable DTMF detection for the relay session.
|
|
169
160
|
#
|
|
161
|
+
# @param conversation_relay_settings [Telnyx::Models::Calls::ActionStartConversationRelayParams::ConversationRelaySettings] Conversation Relay connection settings. This object is used by TeXML Call Script
|
|
162
|
+
#
|
|
163
|
+
# @param conversation_relay_url [String] WebSocket URL for your Conversation Relay server. Must start with `ws://` or `ws
|
|
164
|
+
#
|
|
170
165
|
# @param greeting [String] Text played when the relay session starts.
|
|
171
166
|
#
|
|
172
167
|
# @param interruption_settings [Telnyx::Models::Calls::ActionStartConversationRelayParams::InterruptionSettings] Settings for handling caller interruptions during Conversation Relay speech.
|
|
@@ -175,21 +170,15 @@ module Telnyx
|
|
|
175
170
|
#
|
|
176
171
|
# @param languages [Array<Telnyx::Models::Calls::ActionStartConversationRelayParams::Language>] Language-specific TTS and transcription settings. Use this when the relay sessio
|
|
177
172
|
#
|
|
178
|
-
# @param participants [Array<Telnyx::Models::Calls::ActionStartConversationRelayParams::Participant>] Participants to add to the conversation.
|
|
179
|
-
#
|
|
180
|
-
# @param send_message_history_updates [Boolean] When true, sends message history update webhooks.
|
|
181
|
-
#
|
|
182
173
|
# @param transcription [Telnyx::Models::Calls::ActionStartConversationRelayParams::Transcription] Speech-to-text settings for Conversation Relay.
|
|
183
174
|
#
|
|
184
175
|
# @param transcription_language [String] Language to use for speech recognition. Overrides `language` for transcription w
|
|
185
176
|
#
|
|
186
177
|
# @param tts_language [String] Language to use for text-to-speech. Overrides `language` for TTS when provided.
|
|
187
178
|
#
|
|
188
|
-
# @param user_response_timeout_ms [Integer] Time in milliseconds to wait for caller input before timing out.
|
|
189
|
-
#
|
|
190
179
|
# @param voice [String] The voice to be used by the voice assistant. Currently we support ElevenLabs, Te
|
|
191
180
|
#
|
|
192
|
-
# @param voice_settings [Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::AzureVoiceSettings, Telnyx::Models::RimeVoiceSettings, Telnyx::Models::ResembleVoiceSettings, Telnyx::Models::
|
|
181
|
+
# @param voice_settings [Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::AzureVoiceSettings, Telnyx::Models::RimeVoiceSettings, Telnyx::Models::ResembleVoiceSettings, Telnyx::Models::XaiVoiceSettings] The settings associated with the voice selected
|
|
193
182
|
#
|
|
194
183
|
# @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
|
|
195
184
|
|
|
@@ -207,6 +196,147 @@ module Telnyx
|
|
|
207
196
|
# @param dynamic_variables [Hash{Symbol=>String}] Custom key-value parameters forwarded to the Conversation Relay session.
|
|
208
197
|
end
|
|
209
198
|
|
|
199
|
+
class ConversationRelaySettings < Telnyx::Internal::Type::BaseModel
|
|
200
|
+
# @!attribute url
|
|
201
|
+
# WebSocket URL for your Conversation Relay server. Must start with `ws://` or
|
|
202
|
+
# `wss://`.
|
|
203
|
+
#
|
|
204
|
+
# @return [String]
|
|
205
|
+
required :url, String
|
|
206
|
+
|
|
207
|
+
# @!attribute dtmf_detection
|
|
208
|
+
# Whether to enable DTMF detection during the relay session.
|
|
209
|
+
#
|
|
210
|
+
# @return [Boolean, nil]
|
|
211
|
+
optional :dtmf_detection, Telnyx::Internal::Type::Boolean
|
|
212
|
+
|
|
213
|
+
# @!attribute interruptible
|
|
214
|
+
# Controls when caller input can interrupt assistant speech. `any` allows speech
|
|
215
|
+
# or DTMF interruptions; `none` disables interruptions; `speech` allows speech
|
|
216
|
+
# only; `dtmf` allows DTMF only.
|
|
217
|
+
#
|
|
218
|
+
# @return [Symbol, Telnyx::Models::Calls::ActionStartConversationRelayParams::ConversationRelaySettings::Interruptible, nil]
|
|
219
|
+
optional :interruptible,
|
|
220
|
+
enum: -> { Telnyx::Calls::ActionStartConversationRelayParams::ConversationRelaySettings::Interruptible }
|
|
221
|
+
|
|
222
|
+
# @!attribute interruptible_greeting
|
|
223
|
+
# Controls when caller input can interrupt assistant speech. `any` allows speech
|
|
224
|
+
# or DTMF interruptions; `none` disables interruptions; `speech` allows speech
|
|
225
|
+
# only; `dtmf` allows DTMF only.
|
|
226
|
+
#
|
|
227
|
+
# @return [Symbol, Telnyx::Models::Calls::ActionStartConversationRelayParams::ConversationRelaySettings::InterruptibleGreeting, nil]
|
|
228
|
+
optional :interruptible_greeting,
|
|
229
|
+
enum: -> { Telnyx::Calls::ActionStartConversationRelayParams::ConversationRelaySettings::InterruptibleGreeting }
|
|
230
|
+
|
|
231
|
+
# @!attribute languages
|
|
232
|
+
# Language-specific TTS and transcription settings.
|
|
233
|
+
#
|
|
234
|
+
# @return [Array<Telnyx::Models::Calls::ActionStartConversationRelayParams::ConversationRelaySettings::Language>, nil]
|
|
235
|
+
optional :languages,
|
|
236
|
+
-> { Telnyx::Internal::Type::ArrayOf[Telnyx::Calls::ActionStartConversationRelayParams::ConversationRelaySettings::Language] }
|
|
237
|
+
|
|
238
|
+
# @!method initialize(url:, dtmf_detection: nil, interruptible: nil, interruptible_greeting: nil, languages: nil)
|
|
239
|
+
# Some parameter documentations has been truncated, see
|
|
240
|
+
# {Telnyx::Models::Calls::ActionStartConversationRelayParams::ConversationRelaySettings}
|
|
241
|
+
# for more details.
|
|
242
|
+
#
|
|
243
|
+
# Conversation Relay connection settings. This object is used by TeXML Call
|
|
244
|
+
# Scripting's `<ConversationRelay>` verb. The `interruptible` and
|
|
245
|
+
# `interruptible_greeting` fields are shorthand for
|
|
246
|
+
# `interruption_settings.interruptible` and
|
|
247
|
+
# `interruption_settings.interruptible_greeting`; use top-level
|
|
248
|
+
# `interruption_settings` for the full interruption settings shape.
|
|
249
|
+
#
|
|
250
|
+
# @param url [String] WebSocket URL for your Conversation Relay server. Must start with `ws://` or `ws
|
|
251
|
+
#
|
|
252
|
+
# @param dtmf_detection [Boolean] Whether to enable DTMF detection during the relay session.
|
|
253
|
+
#
|
|
254
|
+
# @param interruptible [Symbol, Telnyx::Models::Calls::ActionStartConversationRelayParams::ConversationRelaySettings::Interruptible] Controls when caller input can interrupt assistant speech. `any` allows speech o
|
|
255
|
+
#
|
|
256
|
+
# @param interruptible_greeting [Symbol, Telnyx::Models::Calls::ActionStartConversationRelayParams::ConversationRelaySettings::InterruptibleGreeting] Controls when caller input can interrupt assistant speech. `any` allows speech o
|
|
257
|
+
#
|
|
258
|
+
# @param languages [Array<Telnyx::Models::Calls::ActionStartConversationRelayParams::ConversationRelaySettings::Language>] Language-specific TTS and transcription settings.
|
|
259
|
+
|
|
260
|
+
# Controls when caller input can interrupt assistant speech. `any` allows speech
|
|
261
|
+
# or DTMF interruptions; `none` disables interruptions; `speech` allows speech
|
|
262
|
+
# only; `dtmf` allows DTMF only.
|
|
263
|
+
#
|
|
264
|
+
# @see Telnyx::Models::Calls::ActionStartConversationRelayParams::ConversationRelaySettings#interruptible
|
|
265
|
+
module Interruptible
|
|
266
|
+
extend Telnyx::Internal::Type::Enum
|
|
267
|
+
|
|
268
|
+
NONE = :none
|
|
269
|
+
ANY = :any
|
|
270
|
+
SPEECH = :speech
|
|
271
|
+
DTMF = :dtmf
|
|
272
|
+
|
|
273
|
+
# @!method self.values
|
|
274
|
+
# @return [Array<Symbol>]
|
|
275
|
+
end
|
|
276
|
+
|
|
277
|
+
# Controls when caller input can interrupt assistant speech. `any` allows speech
|
|
278
|
+
# or DTMF interruptions; `none` disables interruptions; `speech` allows speech
|
|
279
|
+
# only; `dtmf` allows DTMF only.
|
|
280
|
+
#
|
|
281
|
+
# @see Telnyx::Models::Calls::ActionStartConversationRelayParams::ConversationRelaySettings#interruptible_greeting
|
|
282
|
+
module InterruptibleGreeting
|
|
283
|
+
extend Telnyx::Internal::Type::Enum
|
|
284
|
+
|
|
285
|
+
NONE = :none
|
|
286
|
+
ANY = :any
|
|
287
|
+
SPEECH = :speech
|
|
288
|
+
DTMF = :dtmf
|
|
289
|
+
|
|
290
|
+
# @!method self.values
|
|
291
|
+
# @return [Array<Symbol>]
|
|
292
|
+
end
|
|
293
|
+
|
|
294
|
+
class Language < Telnyx::Internal::Type::BaseModel
|
|
295
|
+
# @!attribute code
|
|
296
|
+
# BCP 47 language code.
|
|
297
|
+
#
|
|
298
|
+
# @return [String, nil]
|
|
299
|
+
optional :code, String
|
|
300
|
+
|
|
301
|
+
# @!attribute speech_model
|
|
302
|
+
# Speech recognition model for this language.
|
|
303
|
+
#
|
|
304
|
+
# @return [String, nil]
|
|
305
|
+
optional :speech_model, String
|
|
306
|
+
|
|
307
|
+
# @!attribute transcription_provider
|
|
308
|
+
# Speech-to-text provider for this language.
|
|
309
|
+
#
|
|
310
|
+
# @return [String, nil]
|
|
311
|
+
optional :transcription_provider, String
|
|
312
|
+
|
|
313
|
+
# @!attribute tts_provider
|
|
314
|
+
# Text-to-speech provider for this language.
|
|
315
|
+
#
|
|
316
|
+
# @return [String, nil]
|
|
317
|
+
optional :tts_provider, String
|
|
318
|
+
|
|
319
|
+
# @!attribute voice
|
|
320
|
+
# Voice identifier for this language.
|
|
321
|
+
#
|
|
322
|
+
# @return [String, nil]
|
|
323
|
+
optional :voice, String
|
|
324
|
+
|
|
325
|
+
# @!method initialize(code: nil, speech_model: nil, transcription_provider: nil, tts_provider: nil, voice: nil)
|
|
326
|
+
# Language-specific speech and transcription settings for Conversation Relay.
|
|
327
|
+
#
|
|
328
|
+
# @param code [String] BCP 47 language code.
|
|
329
|
+
#
|
|
330
|
+
# @param speech_model [String] Speech recognition model for this language.
|
|
331
|
+
#
|
|
332
|
+
# @param transcription_provider [String] Speech-to-text provider for this language.
|
|
333
|
+
#
|
|
334
|
+
# @param tts_provider [String] Text-to-speech provider for this language.
|
|
335
|
+
#
|
|
336
|
+
# @param voice [String] Voice identifier for this language.
|
|
337
|
+
end
|
|
338
|
+
end
|
|
339
|
+
|
|
210
340
|
class InterruptionSettings < Telnyx::Internal::Type::BaseModel
|
|
211
341
|
# @!attribute enable
|
|
212
342
|
# Legacy boolean form. `true` is equivalent to `interruptible=any`; `false` is
|
|
@@ -354,66 +484,6 @@ module Telnyx
|
|
|
354
484
|
# @param voice [String] Voice identifier for this language.
|
|
355
485
|
end
|
|
356
486
|
|
|
357
|
-
class Participant < Telnyx::Internal::Type::BaseModel
|
|
358
|
-
# @!attribute id
|
|
359
|
-
# The call_control_id of the participant to add to the conversation.
|
|
360
|
-
#
|
|
361
|
-
# @return [String]
|
|
362
|
-
required :id, String
|
|
363
|
-
|
|
364
|
-
# @!attribute role
|
|
365
|
-
# The role of the participant in the conversation.
|
|
366
|
-
#
|
|
367
|
-
# @return [Symbol, Telnyx::Models::Calls::ActionStartConversationRelayParams::Participant::Role]
|
|
368
|
-
required :role, enum: -> { Telnyx::Calls::ActionStartConversationRelayParams::Participant::Role }
|
|
369
|
-
|
|
370
|
-
# @!attribute name
|
|
371
|
-
# Display name for the participant.
|
|
372
|
-
#
|
|
373
|
-
# @return [String, nil]
|
|
374
|
-
optional :name, String
|
|
375
|
-
|
|
376
|
-
# @!attribute on_hangup
|
|
377
|
-
# Determines what happens to the conversation when this participant hangs up.
|
|
378
|
-
#
|
|
379
|
-
# @return [Symbol, Telnyx::Models::Calls::ActionStartConversationRelayParams::Participant::OnHangup, nil]
|
|
380
|
-
optional :on_hangup, enum: -> { Telnyx::Calls::ActionStartConversationRelayParams::Participant::OnHangup }
|
|
381
|
-
|
|
382
|
-
# @!method initialize(id:, role:, name: nil, on_hangup: nil)
|
|
383
|
-
# @param id [String] The call_control_id of the participant to add to the conversation.
|
|
384
|
-
#
|
|
385
|
-
# @param role [Symbol, Telnyx::Models::Calls::ActionStartConversationRelayParams::Participant::Role] The role of the participant in the conversation.
|
|
386
|
-
#
|
|
387
|
-
# @param name [String] Display name for the participant.
|
|
388
|
-
#
|
|
389
|
-
# @param on_hangup [Symbol, Telnyx::Models::Calls::ActionStartConversationRelayParams::Participant::OnHangup] Determines what happens to the conversation when this participant hangs up.
|
|
390
|
-
|
|
391
|
-
# The role of the participant in the conversation.
|
|
392
|
-
#
|
|
393
|
-
# @see Telnyx::Models::Calls::ActionStartConversationRelayParams::Participant#role
|
|
394
|
-
module Role
|
|
395
|
-
extend Telnyx::Internal::Type::Enum
|
|
396
|
-
|
|
397
|
-
USER = :user
|
|
398
|
-
|
|
399
|
-
# @!method self.values
|
|
400
|
-
# @return [Array<Symbol>]
|
|
401
|
-
end
|
|
402
|
-
|
|
403
|
-
# Determines what happens to the conversation when this participant hangs up.
|
|
404
|
-
#
|
|
405
|
-
# @see Telnyx::Models::Calls::ActionStartConversationRelayParams::Participant#on_hangup
|
|
406
|
-
module OnHangup
|
|
407
|
-
extend Telnyx::Internal::Type::Enum
|
|
408
|
-
|
|
409
|
-
CONTINUE_CONVERSATION = :continue_conversation
|
|
410
|
-
END_CONVERSATION = :end_conversation
|
|
411
|
-
|
|
412
|
-
# @!method self.values
|
|
413
|
-
# @return [Array<Symbol>]
|
|
414
|
-
end
|
|
415
|
-
end
|
|
416
|
-
|
|
417
487
|
class Transcription < Telnyx::Internal::Type::BaseModel
|
|
418
488
|
# @!attribute language
|
|
419
489
|
# Transcription language.
|
|
@@ -461,29 +531,10 @@ module Telnyx
|
|
|
461
531
|
|
|
462
532
|
variant :resemble, -> { Telnyx::ResembleVoiceSettings }
|
|
463
533
|
|
|
464
|
-
variant :xai, -> { Telnyx::
|
|
465
|
-
|
|
466
|
-
class Xai < Telnyx::Internal::Type::BaseModel
|
|
467
|
-
# @!attribute type
|
|
468
|
-
# Voice settings provider type
|
|
469
|
-
#
|
|
470
|
-
# @return [Symbol, :xai]
|
|
471
|
-
required :type, const: :xai
|
|
472
|
-
|
|
473
|
-
# @!attribute language
|
|
474
|
-
# Language code, or `auto` to detect automatically.
|
|
475
|
-
#
|
|
476
|
-
# @return [String, nil]
|
|
477
|
-
optional :language, String
|
|
478
|
-
|
|
479
|
-
# @!method initialize(language: nil, type: :xai)
|
|
480
|
-
# @param language [String] Language code, or `auto` to detect automatically.
|
|
481
|
-
#
|
|
482
|
-
# @param type [Symbol, :xai] Voice settings provider type
|
|
483
|
-
end
|
|
534
|
+
variant :xai, -> { Telnyx::XaiVoiceSettings }
|
|
484
535
|
|
|
485
536
|
# @!method self.variants
|
|
486
|
-
# @return [Array(Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::AzureVoiceSettings, Telnyx::Models::RimeVoiceSettings, Telnyx::Models::ResembleVoiceSettings, Telnyx::Models::
|
|
537
|
+
# @return [Array(Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, Telnyx::Models::AzureVoiceSettings, Telnyx::Models::RimeVoiceSettings, Telnyx::Models::ResembleVoiceSettings, Telnyx::Models::XaiVoiceSettings)]
|
|
487
538
|
end
|
|
488
539
|
end
|
|
489
540
|
end
|
|
@@ -0,0 +1,64 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Telnyx
|
|
4
|
+
module Models
|
|
5
|
+
module Calls
|
|
6
|
+
class TranscriptionEngineAssemblyaiConfig < Telnyx::Internal::Type::BaseModel
|
|
7
|
+
# @!attribute interim_results
|
|
8
|
+
# Whether to send also interim results. If set to false, only final results will
|
|
9
|
+
# be sent.
|
|
10
|
+
#
|
|
11
|
+
# @return [Boolean, nil]
|
|
12
|
+
optional :interim_results, Telnyx::Internal::Type::Boolean
|
|
13
|
+
|
|
14
|
+
# @!attribute transcription_engine
|
|
15
|
+
# Engine identifier for AssemblyAI transcription service
|
|
16
|
+
#
|
|
17
|
+
# @return [Symbol, Telnyx::Models::Calls::TranscriptionEngineAssemblyaiConfig::TranscriptionEngine, nil]
|
|
18
|
+
optional :transcription_engine,
|
|
19
|
+
enum: -> { Telnyx::Calls::TranscriptionEngineAssemblyaiConfig::TranscriptionEngine }
|
|
20
|
+
|
|
21
|
+
# @!attribute transcription_model
|
|
22
|
+
# The model to use for transcription.
|
|
23
|
+
#
|
|
24
|
+
# @return [Symbol, Telnyx::Models::Calls::TranscriptionEngineAssemblyaiConfig::TranscriptionModel, nil]
|
|
25
|
+
optional :transcription_model,
|
|
26
|
+
enum: -> { Telnyx::Calls::TranscriptionEngineAssemblyaiConfig::TranscriptionModel }
|
|
27
|
+
|
|
28
|
+
# @!method initialize(interim_results: nil, transcription_engine: nil, transcription_model: nil)
|
|
29
|
+
# Some parameter documentations has been truncated, see
|
|
30
|
+
# {Telnyx::Models::Calls::TranscriptionEngineAssemblyaiConfig} for more details.
|
|
31
|
+
#
|
|
32
|
+
# @param interim_results [Boolean] Whether to send also interim results. If set to false, only final results will b
|
|
33
|
+
#
|
|
34
|
+
# @param transcription_engine [Symbol, Telnyx::Models::Calls::TranscriptionEngineAssemblyaiConfig::TranscriptionEngine] Engine identifier for AssemblyAI transcription service
|
|
35
|
+
#
|
|
36
|
+
# @param transcription_model [Symbol, Telnyx::Models::Calls::TranscriptionEngineAssemblyaiConfig::TranscriptionModel] The model to use for transcription.
|
|
37
|
+
|
|
38
|
+
# Engine identifier for AssemblyAI transcription service
|
|
39
|
+
#
|
|
40
|
+
# @see Telnyx::Models::Calls::TranscriptionEngineAssemblyaiConfig#transcription_engine
|
|
41
|
+
module TranscriptionEngine
|
|
42
|
+
extend Telnyx::Internal::Type::Enum
|
|
43
|
+
|
|
44
|
+
ASSEMBLY_AI = :AssemblyAI
|
|
45
|
+
|
|
46
|
+
# @!method self.values
|
|
47
|
+
# @return [Array<Symbol>]
|
|
48
|
+
end
|
|
49
|
+
|
|
50
|
+
# The model to use for transcription.
|
|
51
|
+
#
|
|
52
|
+
# @see Telnyx::Models::Calls::TranscriptionEngineAssemblyaiConfig#transcription_model
|
|
53
|
+
module TranscriptionModel
|
|
54
|
+
extend Telnyx::Internal::Type::Enum
|
|
55
|
+
|
|
56
|
+
ASSEMBLYAI_UNIVERSAL_STREAMING = :"assemblyai/universal-streaming"
|
|
57
|
+
|
|
58
|
+
# @!method self.values
|
|
59
|
+
# @return [Array<Symbol>]
|
|
60
|
+
end
|
|
61
|
+
end
|
|
62
|
+
end
|
|
63
|
+
end
|
|
64
|
+
end
|