Class: Telnyx::Models::AI::ConversationFlowReq::Node::Tool

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

Defined Under Namespace

Modules: Type

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(id:, shared_tool_id:, name: nil, position: nil, type: nil) ⇒ Object

Some parameter documentations has been truncated, see Telnyx::Models::AI::ConversationFlowReq::Node::Tool for more details.

A standalone tool step in a conversation flow, as supplied by clients.

Unlike a prompt node, a tool node has no instructions or model — it isn't an LLM turn. Reaching it deterministically runs one shared tool (arguments filled from matching dynamic variables by name), then routes on the result via outgoing tool_result edges.

Parameters:

  • id (String) —

    Caller-supplied unique identifier for this node within the flow.

  • shared_tool_id (String) —

    ID of the single shared (org-level) tool this node executes. When the flow reach

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

    Optional human-readable label, displayed in authoring UIs.

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

    Optional canvas coordinates used by authoring UIs to lay out the graph. Ignored

  • type (Symbol, Telnyx::Models::AI::ConversationFlowReq::Node::Tool::Type) (defaults to: nil) —

    Node kind discriminator. Always tool for a tool node.




# File 'lib/telnyx/models/ai/conversation_flow_req.rb', line 288

Instance Attribute Details

#id ⇒ String

Caller-supplied unique identifier for this node within the flow.

Parameters:

  • value (String)

Returns:

  • (String) 


255
 
# File 'lib/telnyx/models/ai/conversation_flow_req.rb', line 255

required :id, String

#name ⇒ String?

Optional human-readable label, displayed in authoring UIs.

Parameters:

  • (String)

Returns:

  • (String, nil) 


272
 
# File 'lib/telnyx/models/ai/conversation_flow_req.rb', line 272

optional :name, String

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

Optional canvas coordinates used by authoring UIs to lay out the graph. Ignored by the runtime; round-trips so frontends can persist graph layout across reloads.

Returns:



280
 
# File 'lib/telnyx/models/ai/conversation_flow_req.rb', line 280

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

#shared_tool_id ⇒ String

ID of the single shared (org-level) tool this node executes. When the flow reaches this node the tool runs as a deliberate step (no LLM turn); its outgoing tool_result edges then route on the outcome. Arguments are filled from the conversation's dynamic variables by name — a dynamic variable whose name matches one of the tool's parameters supplies that argument. Cross-validated against the org's shared tools on write.

Parameters:

  • value (String)

Returns:

  • (String) 


266
 
# File 'lib/telnyx/models/ai/conversation_flow_req.rb', line 266

required :shared_tool_id, String

#type ⇒ Symbol, ...

Node kind discriminator. Always tool for a tool node.

Returns:



286
 
# File 'lib/telnyx/models/ai/conversation_flow_req.rb', line 286

optional :type, enum: -> { Telnyx::AI::ConversationFlowReq::Node::Tool::Type }

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


225
 
# File 'sig/telnyx/models/ai/conversation_flow_req.rbs', line 225

def to_hash: -> {