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

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

Defined Under Namespace

Modules: InstructionsMode, ToolsMode, Type Classes: Position

Instance Attribute Summary collapse

Class Method 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(x:, y_:) ⇒ Object

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.

Parameters:

  • x (Float) —

    Horizontal coordinate in the authoring canvas.

  • y_ (Float) —

    Vertical coordinate in the authoring canvas.




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

Instance Attribute Details

#external_llm ⇒ Telnyx::Models::AI::ExternalLlm?

Override for ‘Assistant.external_llm` while this node is active. Use this to route a node’s turns to a different external LLM (different ‘model`, `base_url`, credentials). Part of the LLM bundle — see `model` for cascade semantics. Mutually exclusive with `model` on the node (a single LLM identity per node).

Returns:



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

optional :external_llm, -> { Telnyx::AI::ExternalLlm }

#id ⇒ String

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

Returns:

  • (String) 


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

required :id, String

#instructions ⇒ String

Prompt that drives the LLM while this node is active. Required.

Returns:

  • (String) 


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

required :instructions, String

#instructions_mode ⇒ Symbol, ...

How ‘instructions` combine with the assistant-level instructions. `replace` (default): the node’s instructions are used alone. ‘append`: the node’s instructions are concatenated after the assistant’s instructions.

Returns:



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

optional :instructions_mode,
enum: -> { Telnyx::AI::InferenceEmbedding::ConversationFlow::Node::Prompt::InstructionsMode }

#llm_api_key_ref ⇒ String?

Override for ‘Assistant.llm_api_key_ref` while this node is active. Part of the LLM bundle — see `model` for cascade semantics.

Returns:

  • (String, nil) 


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

optional :llm_api_key_ref, String

#model ⇒ String?

Override for ‘Assistant.model` while this node is active. Part of the LLM bundle (`model` + `llm_api_key_ref` + `external_llm`): when any of the three is set on the node, all three are taken from the node and the assistant-level LLM identity is not consulted. When none of the three is set, the assistant’s bundle cascades unchanged.

Returns:

  • (String, nil) 


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

optional :model, String

#name ⇒ String?

Optional human-readable label, displayed in authoring UIs.

Returns:

  • (String, nil) 


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

optional :name, String

#position ⇒ Telnyx::Models::AI::InferenceEmbedding::ConversationFlow::Node::Prompt::Position?

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:



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

optional :position, -> { Telnyx::AI::InferenceEmbedding::ConversationFlow::Node::Prompt::Position }

#shared_tool_ids ⇒ Array<String>?

IDs of shared (org-level) tools available at this node. Knowledge bases are attached the same way — via a shared retrieval tool. Tools not listed here are not callable while this node is active.

Returns:

  • (Array<String>, nil) 


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

optional :shared_tool_ids, Telnyx::Internal::Type::ArrayOf[String]

#tools ⇒ Array<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 definitions for this node, resolved from ‘shared_tool_ids` server-side. Populated on responses so clients can render the flow without a follow-up fetch per shared tool. Ignored on input — set `shared_tool_ids` to configure a node’s tools.

Returns:



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

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

#tools_mode ⇒ Symbol, ...

How ‘shared_tool_ids` combine with the assistant-level tool set. `replace` (default): only the node’s tools are callable. ‘append`: the node’s tools are added to the assistant’s tools. Ignored when ‘shared_tool_ids` is null.

Returns:



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

optional :tools_mode,
enum: -> { Telnyx::AI::InferenceEmbedding::ConversationFlow::Node::Prompt::ToolsMode }

#transcription ⇒ Telnyx::Models::AI::TranscriptionSettings?

Per-node transcription override (response form).

Returns:



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

optional :transcription, -> { Telnyx::AI::TranscriptionSettings }

#type ⇒ Symbol, ...

Node kind discriminator. ‘prompt` is an LLM-driven step.

Returns:



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

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

#voice_settings ⇒ Telnyx::Models::AI::VoiceSettings?

Per-node voice override (response form).

Returns:



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

optional :voice_settings, -> { Telnyx::AI::VoiceSettings }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



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