Class: Telnyx::Models::AI::InferenceEmbedding::ConversationFlow::Node::Tool

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/telnyx/models/ai/inference_embedding.rb

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, tool: nil, type: nil) ⇒ Object

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

A standalone tool step in a conversation flow, as returned by the API.

Parameters:




# File 'lib/telnyx/models/ai/inference_embedding.rb', line 588

Instance Attribute Details

#id ⇒ String

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

Returns:

  • (String) 


547
 
# File 'lib/telnyx/models/ai/inference_embedding.rb', line 547

required :id, String

#name ⇒ String?

Optional human-readable label, displayed in authoring UIs.

Returns:

  • (String, nil) 


564
 
# File 'lib/telnyx/models/ai/inference_embedding.rb', line 564

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:



572
 
# File 'lib/telnyx/models/ai/inference_embedding.rb', line 572

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.

Returns:

  • (String) 


558
 
# File 'lib/telnyx/models/ai/inference_embedding.rb', line 558

required :shared_tool_id, String

#tool ⇒ Array<Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams, Telnyx::Models::AI::RetrievalTool, Telnyx::Models::AI::AssistantTool::Handoff, Telnyx::Models::AI::HangupTool, Telnyx::Models::AI::AssistantTool::Transfer, Telnyx::Models::AI::AssistantTool::Invite, Telnyx::Models::AI::AssistantTool::Refer, Telnyx::Models::AI::AssistantTool::SendDtmf, Telnyx::Models::AI::AssistantTool::SendMessage, Telnyx::Models::AI::AssistantTool::SkipTurn>?

Full tool definition resolved from ‘shared_tool_id` server-side. Populated on responses so clients can render the node without a follow-up fetch. Ignored on input — set `shared_tool_id`.

Returns:



580
 
# File 'lib/telnyx/models/ai/inference_embedding.rb', line 580

optional :tool, -> { Telnyx::Internal::Type::ArrayOf[union: Telnyx::AI::AssistantTool] }

#type ⇒ Symbol, ...

Node kind discriminator. Always ‘tool` for a tool node.

Returns:



586
 
# File 'lib/telnyx/models/ai/inference_embedding.rb', line 586

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