Class: Telnyx::Models::AI::FlowEdge::Target::Assistant

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/telnyx/models/ai/flow_edge.rb,
sig/telnyx/models/ai/flow_edge.rbs

Defined Under Namespace

Modules: VoiceMode

Instance Attribute Summary collapse

Instance Method Summary collapse

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_id:, position: nil, voice_mode: nil, type: :assistant) ⇒ Object

Some parameter documentations has been truncated, see Telnyx::Models::AI::FlowEdge::Target::Assistant for more details.

Edge target referencing a different assistant.

When the edge fires, the conversation hands off to assistant_id: the active assistant on the conversation row is rewritten and the new assistant's flow starts at its own start_node_id. The current turn's LLM response is delivered to the user as-is; subsequent turns route to the new assistant.

Parameters:

  • assistant_id (String) —

    ID of the assistant the conversation transitions to.

  • position (Telnyx::Models::AI::NodePosition) (defaults to: nil) —

    Optional canvas coordinates for rendering the target assistant as a node in auth

  • voice_mode (Symbol, Telnyx::Models::AI::FlowEdge::Target::Assistant::VoiceMode) (defaults to: nil) —

    Voice behavior when handing off to the target assistant, mirroring the handoff t

  • type (Symbol, :assistant) (defaults to: :assistant) 



# File 'lib/telnyx/models/ai/flow_edge.rb', line 242

Instance Attribute Details

#assistant_id ⇒ String

ID of the assistant the conversation transitions to.

Parameters:

  • value (String)

Returns:

  • (String) 


215
 
# File 'lib/telnyx/models/ai/flow_edge.rb', line 215

required :assistant_id, String

#position ⇒ Telnyx::Models::AI::NodePosition?

Optional canvas coordinates for rendering the target assistant as a node in authoring UIs. Pure presentation — the runtime ignores it; round-trips so frontends can persist graph layout across reloads. When multiple edges target the same assistant, each edge's position is independent (frontends typically use the first non-null one).

Returns:



230
 
# File 'lib/telnyx/models/ai/flow_edge.rb', line 230

optional :position, -> { Telnyx::AI::NodePosition }

#type ⇒ Symbol, :assistant

Parameters:

  • value (:assistant)

Returns:

  • (Symbol, :assistant) 


220
 
# File 'lib/telnyx/models/ai/flow_edge.rb', line 220

required :type, const: :assistant

#voice_mode ⇒ Symbol, ...

Voice behavior when handing off to the target assistant, mirroring the handoff tool's voice_mode. unified (default) keeps the current voice across the handoff; distinct lets the target assistant speak with its own configured voice. Only applies to assistant targets — node targets override voice via the node's own voice_settings.

Returns:



240
 
# File 'lib/telnyx/models/ai/flow_edge.rb', line 240

optional :voice_mode, enum: -> { Telnyx::AI::FlowEdge::Target::Assistant::VoiceMode }

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


131
 
# File 'sig/telnyx/models/ai/flow_edge.rbs', line 131

def to_hash: -> {