Class: Telnyx::Models::Calls::ActionStartConversationRelayParams::Assistant

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Telnyx::Models::Calls::ActionStartConversationRelayParams::Assistant

Defined in:

lib/telnyx/models/calls/action_start_conversation_relay_params.rb

Instance Attribute Summary

• #dynamic_variables ⇒ Hash{Symbol=>String}^?

  Custom key-value parameters forwarded to the Conversation Relay session.

Instance Method Summary

• #initialize(call_control_id:, conversation_relay_url:, assistant: nil, client_state: nil, command_id: nil, conversation_relay_dtmf_detection: nil, greeting: nil, interruption_settings: nil, language: nil, languages: nil, participants: nil, send_message_history_updates: nil, transcription: nil, transcription_language: nil, tts_language: nil, user_response_timeout_ms: nil, voice: nil, voice_settings: nil, request_options: {}) ⇒ Object constructor

  Some parameter documentations has been truncated, see Telnyx::Models::Calls::ActionStartConversationRelayParams for more details.

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(call_control_id:, conversation_relay_url:, assistant: nil, client_state: nil, command_id: nil, conversation_relay_dtmf_detection: nil, greeting: nil, interruption_settings: nil, language: nil, languages: nil, participants: nil, send_message_history_updates: nil, transcription: nil, transcription_language: nil, tts_language: nil, user_response_timeout_ms: nil, voice: nil, voice_settings: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see Telnyx::Models::Calls::ActionStartConversationRelayParams for more details.

Parameters:

• call_control_id (String)
• conversation_relay_url (String) —

  WebSocket URL for your Conversation Relay server. Must start with ‘ws://` or `ws

• assistant (Telnyx::Models::Calls::ActionStartConversationRelayParams::Assistant) (defaults to: nil) —

  Custom parameters for the Conversation Relay session. Pass key-value data as ‘as

• client_state (String) (defaults to: nil) —

  Use this field to add state to subsequent webhooks. It must be a valid Base-64 e

• command_id (String) (defaults to: nil) —

  Use this field to avoid duplicate commands. Telnyx will ignore any command with

• conversation_relay_dtmf_detection (Boolean) (defaults to: nil) —

  Enable DTMF detection for the relay session.

• greeting (String) (defaults to: nil) —

  Text played when the relay session starts.

• interruption_settings (Telnyx::Models::Calls::ActionStartConversationRelayParams::InterruptionSettings) (defaults to: nil) —

  Settings for handling caller interruptions during Conversation Relay speech.

• language (String) (defaults to: nil) —

  Default language for the relay session. This value is used for both text-to-spee

• languages (Array<Telnyx::Models::Calls::ActionStartConversationRelayParams::Language>) (defaults to: nil) —

  Language-specific TTS and transcription settings. Use this when the relay sessio

• participants (Array<Telnyx::Models::Calls::ActionStartConversationRelayParams::Participant>) (defaults to: nil) —

  Participants to add to the conversation.

• send_message_history_updates (Boolean) (defaults to: nil) —

  When true, sends message history update webhooks.

• transcription (Telnyx::Models::Calls::ActionStartConversationRelayParams::Transcription) (defaults to: nil) —

  Speech-to-text settings for Conversation Relay.

• transcription_language (String) (defaults to: nil) —

  Language to use for speech recognition. Overrides ‘language` for transcription w

• tts_language (String) (defaults to: nil) —

  Language to use for text-to-speech. Overrides ‘language` for TTS when provided.

• user_response_timeout_ms (Integer) (defaults to: nil) —

  Time in milliseconds to wait for caller input before timing out.

• voice (String) (defaults to: nil) —

  The voice to be used by the voice assistant. Currently we support ElevenLabs, Te

• 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::Calls::ActionStartConversationRelayParams::VoiceSettings::Xai) (defaults to: nil) —

  The settings associated with the voice selected

• request_options (Telnyx::RequestOptions, Hash{Symbol=>Object}) (defaults to: {})

# File 'lib/telnyx/models/calls/action_start_conversation_relay_params.rb', line 196

class Assistant < Telnyx::Internal::Type::BaseModel
  # @!attribute dynamic_variables
  #   Custom key-value parameters forwarded to the Conversation Relay session.
  #
  #   @return [Hash{Symbol=>String}, nil]
  optional :dynamic_variables, Telnyx::Internal::Type::HashOf[String]

  # @!method initialize(dynamic_variables: nil)
  #   Custom parameters for the Conversation Relay session. Pass key-value data as
  #   `assistant.dynamic_variables` to make it available to the relay session.
  #
  #   @param dynamic_variables [Hash{Symbol=>String}] Custom key-value parameters forwarded to the Conversation Relay session.
end

Instance Attribute Details

#dynamic_variables ⇒ Hash{Symbol=>String}^?

Custom key-value parameters forwarded to the Conversation Relay session.

Returns:

• (Hash{Symbol=>String}, nil)

# File 'lib/telnyx/models/calls/action_start_conversation_relay_params.rb', line 201

optional :dynamic_variables, Telnyx::Internal::Type::HashOf[String]