Class: Telnyx::Models::AI::ConversationFlowReq::Node::Speak

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/telnyx/models/ai/conversation_flow_req.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:, message:, name: nil, position: nil, type: nil) ⇒ Object

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

A standalone scripted-message step in a flow, as supplied by clients.

Unlike a prompt node, a speak node has no instructions or model — it isn’t an LLM turn. Reaching it delivers ‘message` to the user verbatim (with `{variable}` interpolation), then routes via outgoing `llm` / `expression` edges.

Parameters:

  • id (String) —

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

  • message (String) —

    Message delivered to the user verbatim when the flow reaches this node. No LLM t

  • 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::Speak::Type) (defaults to: nil) —

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




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

Instance Attribute Details

#id ⇒ String

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

Returns:

  • (String) 


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

required :id, String

#message ⇒ String

Message delivered to the user verbatim when the flow reaches this node. No LLM turn — the text is spoken/sent exactly as written. ‘{variable}` placeholders are interpolated from the conversation’s dynamic variables; an unresolved placeholder renders as an empty string. After delivering, the flow routes via the node’s outgoing ‘llm` / `expression` edges (commonly a single unconditional edge).

Returns:

  • (String) 


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

required :message, String

#name ⇒ String?

Optional human-readable label, displayed in authoring UIs.

Returns:

  • (String, nil) 


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

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:



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

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

#type ⇒ Symbol, ...

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

Returns:



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

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