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

Inherits:

Internal::Type::BaseModel

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

Defined in:

lib/telnyx/models/calls/action_start_ai_assistant_params.rb

Instance Attribute Summary

• #id ⇒ String^?

  The identifier of the AI assistant to use.

• #instructions ⇒ String^?

  The system instructions that the voice assistant uses during the start assistant command.

• #openai_api_key_ref ⇒ String^?

  Reference to the OpenAI API key.

Instance Method Summary

• #initialize(assistant: nil, client_state: nil, command_id: nil, greeting: nil, interruption_settings: nil, transcription: nil, voice: nil, voice_settings: nil, request_options: {}) ⇒ Object constructor

  Some parameter documentations has been truncated, see Telnyx::Models::Calls::ActionStartAIAssistantParams 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(assistant: nil, client_state: nil, command_id: nil, greeting: nil, interruption_settings: nil, transcription: nil, voice: nil, voice_settings: nil, request_options: {}) ⇒ Object

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

Parameters:

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

  AI Assistant configuration

• 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

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

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

• 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) (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_ai_assistant_params.rb', line 109

class Assistant < Telnyx::Internal::Type::BaseModel
  # @!attribute id
  #   The identifier of the AI assistant to use
  #
  #   @return [String, nil]
  optional :id, String

  # @!attribute instructions
  #   The system instructions that the voice assistant uses during the start assistant
  #   command. This will overwrite the instructions set in the assistant
  #   configuration.
  #
  #   @return [String, nil]
  optional :instructions, String

  # @!attribute openai_api_key_ref
  #   Reference to the OpenAI API key. Required only when using OpenAI models
  #
  #   @return [String, nil]
  optional :openai_api_key_ref, String

  # @!method initialize(id: nil, instructions: nil, openai_api_key_ref: nil)
  #   Some parameter documentations has been truncated, see
  #   {Telnyx::Models::Calls::ActionStartAIAssistantParams::Assistant} for more
  #   details.
  #
  #   AI Assistant configuration
  #
  #   @param id [String] The identifier of the AI assistant to use
  #
  #   @param instructions [String] The system instructions that the voice assistant uses during the start assistant
  #
  #   @param openai_api_key_ref [String] Reference to the OpenAI API key. Required only when using OpenAI models
end

Instance Attribute Details

#id ⇒ String^?

The identifier of the AI assistant to use

Returns:

• (String, nil)

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

optional :id, String

#instructions ⇒ String^?

The system instructions that the voice assistant uses during the start assistant command. This will overwrite the instructions set in the assistant configuration.

Returns:

• (String, nil)

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

optional :instructions, String

#openai_api_key_ref ⇒ String^?

Reference to the OpenAI API key. Required only when using OpenAI models

Returns:

• (String, nil)

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

optional :openai_api_key_ref, String