Class: Telnyx::Models::AI::ConversationFlowReq

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

Defined Under Namespace

Modules: Node

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(nodes:, start_node_id:, edges: nil) ⇒ Object

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

Conversation flow as supplied by API clients (create / update).

A directed graph of ‘FlowNodeReq` connected by `FlowEdge`s. Validation enforces unique node/edge IDs, that `start_node_id` references a real node, and that every edge’s endpoints reference real nodes.

Parameters:




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

Instance Attribute Details

#edges ⇒ Array<Telnyx::Models::AI::FlowEdge>?

Directed transitions between nodes. May be empty for a single-node flow.

Returns:



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

optional :edges, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::AI::FlowEdge] }

#nodes ⇒ Array<Telnyx::Models::AI::ConversationFlowReq::Node::Prompt, Telnyx::Models::AI::ConversationFlowReq::Node::Tool, Telnyx::Models::AI::ConversationFlowReq::Node::Speak>

All nodes in the flow. Must contain ‘start_node_id`. Each node is a prompt node (`type: prompt`) or a tool node (`type: tool`).

Returns:



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

required :nodes, -> { Telnyx::Internal::Type::ArrayOf[union: Telnyx::AI::ConversationFlowReq::Node] }

#start_node_id ⇒ String

ID of the node where the conversation begins.

Returns:

  • (String) 


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

required :start_node_id, String