Class: Telnyx::Models::Calls::ActionStartAIAssistantParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Telnyx::Models::Calls::ActionStartAIAssistantParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/telnyx/models/calls/action_start_ai_assistant_params.rb,
sig/telnyx/models/calls/action_start_ai_assistant_params.rbs

Overview

See Also:

• Telnyx::Resources::Calls::Actions#start_ai_assistant

Defined Under Namespace

Modules: MessageHistory

Constant Summary

Telnyx =

Returns:

• (:CallAssistantRequest)

Instance Attribute Summary

• #assistant ⇒ Telnyx::Models::CallAssistantRequest^?

  AI Assistant configuration.

• #call_control_id ⇒ String
• #client_state ⇒ String^?

  Use this field to add state to every subsequent webhook.

• #command_id ⇒ String^?

  Use this field to avoid duplicate commands.

• #greeting ⇒ String^?

  Text that will be played when the assistant starts, if none then nothing will be played when the assistant starts.

• #interruption_settings ⇒ Telnyx::Models::Calls::InterruptionSettings^?

  Settings for handling user interruptions during assistant speech.

• #message_history ⇒ Array<Telnyx::Models::Calls::UserMessage, Telnyx::Models::Calls::AssistantMessage, Telnyx::Models::Calls::ToolMessage, Telnyx::Models::Calls::SystemMessage, Telnyx::Models::Calls::DeveloperMessage>^?

  A list of messages to seed the conversation history before the assistant starts.

• #participants ⇒ Array<Telnyx::Models::Calls::AIAssistantJoinParticipant>^?

  A list of participants to add to the conversation when it starts.

• #send_message_history_updates ⇒ Boolean^?

  When true, a call.ai_gather.message_history_updated webhook carrying the full message history is sent each time the conversation message history is updated.

• #transcription ⇒ Telnyx::Models::Calls::TranscriptionConfig^?

  The settings associated with speech to text for the voice assistant.

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #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, request_options: {}) ⇒ Object constructor

  Some parameter documentations has been truncated, see ActionStartAIAssistantParams for more details.

• #to_hash ⇒ {

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

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:, 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, request_options: {}) ⇒ Object

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

Parameters:

• call_control_id (String)
• assistant (Telnyx::Models::CallAssistantRequest) (defaults to: nil) —

  AI Assistant configuration. All fields except id are optional — the assistant'

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

  Use this field to add state to every subsequent webhook. It must be a valid Base

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

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

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

  Text that will be played when the assistant starts, if none then nothing will be

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

  Settings for handling user interruptions during assistant speech

• message_history (Array<Telnyx::Models::Calls::UserMessage, Telnyx::Models::Calls::AssistantMessage, Telnyx::Models::Calls::ToolMessage, Telnyx::Models::Calls::SystemMessage, Telnyx::Models::Calls::DeveloperMessage>) (defaults to: nil) —

  A list of messages to seed the conversation history before the assistant starts.

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

  A list of participants to add to the conversation when it starts.

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

  When true, a call.ai_gather.message_history_updated webhook carrying the ful

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

  The settings associated with speech to text for the voice assistant. This is onl

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

# File 'lib/telnyx/models/calls/action_start_ai_assistant_params.rb', line 84

Instance Attribute Details

#assistant ⇒ Telnyx::Models::CallAssistantRequest^?

AI Assistant configuration. All fields except id are optional — the assistant's stored configuration will be used as fallback for any omitted fields.

Returns:

• (Telnyx::Models::CallAssistantRequest, nil)

# File 'lib/telnyx/models/calls/action_start_ai_assistant_params.rb', line 22

optional :assistant, -> { Telnyx::CallAssistantRequest }

#call_control_id ⇒ String

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/telnyx/models/calls/action_start_ai_assistant_params.rb', line 14

required :call_control_id, String

#client_state ⇒ String^?

Use this field to add state to every subsequent webhook. It must be a valid Base-64 encoded string.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/telnyx/models/calls/action_start_ai_assistant_params.rb', line 29

optional :client_state, String

#command_id ⇒ String^?

Use this field to avoid duplicate commands. Telnyx will ignore any command with the same command_id for the same call_control_id.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/telnyx/models/calls/action_start_ai_assistant_params.rb', line 36

optional :command_id, String

#greeting ⇒ String^?

Text that will be played when the assistant starts, if none then nothing will be played when the assistant starts. The greeting can be text for any voice or SSML for AWS.Polly.<voice_id> voices. There is a 3,000 character limit.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/telnyx/models/calls/action_start_ai_assistant_params.rb', line 44

optional :greeting, String

#interruption_settings ⇒ Telnyx::Models::Calls::InterruptionSettings^?

Settings for handling user interruptions during assistant speech

Returns:

• (Telnyx::Models::Calls::InterruptionSettings, nil)

# File 'lib/telnyx/models/calls/action_start_ai_assistant_params.rb', line 50

optional :interruption_settings, -> { Telnyx::Calls::InterruptionSettings }

#message_history ⇒ Array<Telnyx::Models::Calls::UserMessage, Telnyx::Models::Calls::AssistantMessage, Telnyx::Models::Calls::ToolMessage, Telnyx::Models::Calls::SystemMessage, Telnyx::Models::Calls::DeveloperMessage>^?

A list of messages to seed the conversation history before the assistant starts. Follows the same message format as the ai_assistant_add_messages command.

Returns:

• (Array<Telnyx::Models::Calls::UserMessage, Telnyx::Models::Calls::AssistantMessage, Telnyx::Models::Calls::ToolMessage, Telnyx::Models::Calls::SystemMessage, Telnyx::Models::Calls::DeveloperMessage>, nil)

# File 'lib/telnyx/models/calls/action_start_ai_assistant_params.rb', line 57

optional :message_history,
-> { Telnyx::Internal::Type::ArrayOf[union: Telnyx::Calls::ActionStartAIAssistantParams::MessageHistory] }

#participants ⇒ Array<Telnyx::Models::Calls::AIAssistantJoinParticipant>^?

A list of participants to add to the conversation when it starts.

Returns:

• (Array<Telnyx::Models::Calls::AIAssistantJoinParticipant>, nil)

# File 'lib/telnyx/models/calls/action_start_ai_assistant_params.rb', line 64

optional :participants, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::Calls::AIAssistantJoinParticipant] }

#send_message_history_updates ⇒ Boolean^?

When true, a call.ai_gather.message_history_updated webhook carrying the full message history is sent each time the conversation message history is updated. The assistant's own telephony_settings.send_message_history_updates overrides this value when it is set.

Parameters:

• (Boolean)

Returns:

• (Boolean, nil)

# File 'lib/telnyx/models/calls/action_start_ai_assistant_params.rb', line 73

optional :send_message_history_updates, Telnyx::Internal::Type::Boolean

#transcription ⇒ Telnyx::Models::Calls::TranscriptionConfig^?

The settings associated with speech to text for the voice assistant. This is only relevant if the assistant uses a text-to-text language model. Any assistant using a model with native audio support (e.g. fixie-ai/ultravox-v0_4) will ignore this field.

Returns:

• (Telnyx::Models::Calls::TranscriptionConfig, nil)

# File 'lib/telnyx/models/calls/action_start_ai_assistant_params.rb', line 82

optional :transcription, -> { Telnyx::Calls::TranscriptionConfig }

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/telnyx/models/calls/action_start_ai_assistant_params.rbs', line 85

def to_hash: -> {