Class: Telnyx::Models::Calls::ActionGatherUsingAIParams

Inherits:

Internal::Type::BaseModel

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

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/telnyx/models/calls/action_gather_using_ai_params.rb

Overview

See Also:

• Resources::Calls::Actions#gather_using_ai

Defined Under Namespace

Modules: VoiceSettings Classes: MessageHistory

Instance Attribute Summary

• #assistant ⇒ Telnyx::Models::AI::Assistant^?

  Assistant configuration including choice of LLM, custom instructions, and tools.

• #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 gathering starts, if none then nothing will be played when the gathering starts.

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

  Settings for handling user interruptions during assistant speech.

• #language ⇒ Symbol, ...

  Language to use for speech recognition.

• #message_history ⇒ Array<Telnyx::Models::Calls::ActionGatherUsingAIParams::MessageHistory>^?

  The message history you want the voice assistant to be aware of, this can be useful to keep the context of the conversation, or to pass additional information to the voice assistant.

• #parameters ⇒ Hash{Symbol=>Object}

  The parameters described as a JSON Schema object that needs to be gathered by the voice assistant.

• #send_message_history_updates ⇒ Boolean^?

  Default is ‘false`.

• #send_partial_results ⇒ Boolean^?

  Default is ‘false`.

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

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

• #user_response_timeout_ms ⇒ Integer^?

  The number of milliseconds to wait for a user response before the voice assistant times out and check if the user is still there.

• #voice ⇒ String^?

  The voice to be used by the voice assistant.

• #voice_settings ⇒ Telnyx::Models::Calls::ElevenLabsVoiceSettings, ...

  The settings associated with the voice selected.

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary

• .values ⇒ Array<Symbol>

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, #initialize, 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

This class inherits a constructor from Telnyx::Internal::Type::BaseModel

Instance Attribute Details

#assistant ⇒ Telnyx::Models::AI::Assistant^?

Assistant configuration including choice of LLM, custom instructions, and tools.

Returns:

• (Telnyx::Models::AI::Assistant, nil)

# File 'lib/telnyx/models/calls/action_gather_using_ai_params.rb', line 24

optional :assistant, -> { Telnyx::AI::Assistant }

#client_state ⇒ String^?

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

Returns:

• (String, nil)

# File 'lib/telnyx/models/calls/action_gather_using_ai_params.rb', line 31

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`.

Returns:

• (String, nil)

# File 'lib/telnyx/models/calls/action_gather_using_ai_params.rb', line 38

optional :command_id, String

#greeting ⇒ String^?

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

Returns:

• (String, nil)

# File 'lib/telnyx/models/calls/action_gather_using_ai_params.rb', line 46

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_gather_using_ai_params.rb', line 52

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

#language ⇒ Symbol, ...

Language to use for speech recognition

Returns:

• (Symbol, Telnyx::Models::Calls::GoogleTranscriptionLanguage, nil)

# File 'lib/telnyx/models/calls/action_gather_using_ai_params.rb', line 58

optional :language, enum: -> { Telnyx::Calls::GoogleTranscriptionLanguage }

#message_history ⇒ Array<Telnyx::Models::Calls::ActionGatherUsingAIParams::MessageHistory>^?

The message history you want the voice assistant to be aware of, this can be useful to keep the context of the conversation, or to pass additional information to the voice assistant.

Returns:

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

# File 'lib/telnyx/models/calls/action_gather_using_ai_params.rb', line 66

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

#parameters ⇒ Hash{Symbol=>Object}

The parameters described as a JSON Schema object that needs to be gathered by the voice assistant. See the [JSON Schema reference](json-schema.org/understanding-json-schema) for documentation about the format

Returns:

• (Hash{Symbol=>Object})

# File 'lib/telnyx/models/calls/action_gather_using_ai_params.rb', line 18

required :parameters, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]

#send_message_history_updates ⇒ Boolean^?

Default is ‘false`. If set to `true`, the voice assistant will send updates to the message history via the `call.ai_gather.message_history_updated` callback in real time as the message history is updated.

Returns:

• (Boolean, nil)

# File 'lib/telnyx/models/calls/action_gather_using_ai_params.rb', line 75

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

#send_partial_results ⇒ Boolean^?

Default is ‘false`. If set to `true`, the voice assistant will send partial results via the `call.ai_gather.partial_results` callback in real time as individual fields are gathered. If set to `false`, the voice assistant will only send the final result via the `call.ai_gather.ended` callback.

Returns:

• (Boolean, nil)

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

optional :send_partial_results, 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_gather_using_ai_params.rb', line 93

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

#user_response_timeout_ms ⇒ Integer^?

The number of milliseconds to wait for a user response before the voice assistant times out and check if the user is still there.

Returns:

• (Integer, nil)

# File 'lib/telnyx/models/calls/action_gather_using_ai_params.rb', line 100

optional :user_response_timeout_ms, Integer

#voice ⇒ String^?

The voice to be used by the voice assistant. Currently we support ElevenLabs, Telnyx and AWS voices.

**Supported Providers:**

• AWS: Use ‘AWS.Polly.<VoiceId>` (e.g., `AWS.Polly.Joanna`). For neural voices, which provide more realistic, human-like speech, append `-Neural` to the `VoiceId` (e.g., `AWS.Polly.Joanna-Neural`). Check the [available voices](docs.aws.amazon.com/polly/latest/dg/available-voices.html) for compatibility.

• Azure: Use ‘Azure.<VoiceId>. (e.g. Azure.en-CA-ClaraNeural, Azure.en-CA-LiamNeural, Azure.en-US-BrianMultilingualNeural, Azure.en-US-Ava:DragonHDLatestNeural. For a complete list of voices, go to [Azure Voice Gallery](speech.microsoft.com/portal/voicegallery).)

• ElevenLabs: Use ‘ElevenLabs.<ModelId>.<VoiceId>` (e.g., `ElevenLabs.BaseModel.John`). The `ModelId` part is optional. To use ElevenLabs, you must provide your ElevenLabs API key as an integration secret under `“voice_settings”: “<secret_id>”`. See [integration secrets documentation](developers.telnyx.com/api/secrets-manager/integration-secrets/create-integration-secret) for details. Check [available voices](elevenlabs.io/docs/api-reference/get-voices).

• Telnyx: Use ‘Telnyx.<model_id>.<voice_id>`

Returns:

• (String, nil)

# File 'lib/telnyx/models/calls/action_gather_using_ai_params.rb', line 127

optional :voice, String

#voice_settings ⇒ Telnyx::Models::Calls::ElevenLabsVoiceSettings, ...

The settings associated with the voice selected

Returns:

• (Telnyx::Models::Calls::ElevenLabsVoiceSettings, Telnyx::Models::Calls::TelnyxVoiceSettings, Telnyx::Models::Calls::AwsVoiceSettings, nil)

# File 'lib/telnyx/models/calls/action_gather_using_ai_params.rb', line 133

optional :voice_settings, union: -> { Telnyx::Calls::ActionGatherUsingAIParams::VoiceSettings }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

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