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

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(id:, instructions:, external_llm: nil, instructions_mode: nil, llm_api_key_ref: nil, model: nil, name: nil, position: nil, shared_tool_ids: nil, tools: nil, tools_mode: nil, transcription: nil, type: nil, voice_settings: nil) ⇒ Object

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

One step in a conversation flow, as returned by the API.

Parameters:




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

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:



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

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

#id ⇒ String

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

Returns:

  • (String) 


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

required :id, String

#instructions ⇒ String

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

Returns:

  • (String) 


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

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:



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

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) 


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

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) 


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

optional :model, String

#name ⇒ String?

Optional human-readable label, displayed in authoring UIs.

Returns:

  • (String, nil) 


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

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:



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

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

#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) 


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

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:



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

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:



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

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

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

Per-node transcription override (response form).

Returns:



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

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

#type ⇒ Symbol, ...

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

Returns:



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

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

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

Per-node voice override (response form).

Returns:



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

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

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



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