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

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/telnyx/models/ai/assistant_update_params.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/assistant_update_params.rb', line 461

Instance Attribute Details

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

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:



381
 
# File 'lib/telnyx/models/ai/assistant_update_params.rb', line 381

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

#id ⇒ String

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

Returns:

  • (String) 


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

required :id, String

#instructions ⇒ String

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

Returns:

  • (String) 


372
 
# File 'lib/telnyx/models/ai/assistant_update_params.rb', line 372

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:



389
390
 
# File 'lib/telnyx/models/ai/assistant_update_params.rb', line 389

optional :instructions_mode,
enum: -> { Telnyx::AI::AssistantUpdateParams::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) 


397
 
# File 'lib/telnyx/models/ai/assistant_update_params.rb', line 397

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) 


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

optional :model, String

#name ⇒ String?

Optional human-readable label, displayed in authoring UIs.

Returns:

  • (String, nil) 


413
 
# File 'lib/telnyx/models/ai/assistant_update_params.rb', line 413

optional :name, String

#position ⇒ Telnyx::Models::AI::AssistantUpdateParams::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:



421
 
# File 'lib/telnyx/models/ai/assistant_update_params.rb', line 421

optional :position, -> { Telnyx::AI::AssistantUpdateParams::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) 


429
 
# File 'lib/telnyx/models/ai/assistant_update_params.rb', line 429

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

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



437
438
 
# File 'lib/telnyx/models/ai/assistant_update_params.rb', line 437

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

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

Per-node transcription override (model/language/region). Unset fields cascade from the assistant-level transcription.

Returns:



445
 
# File 'lib/telnyx/models/ai/assistant_update_params.rb', line 445

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

#type ⇒ Symbol, ...

Node kind discriminator. ‘prompt` (default) is an LLM-driven step; `tool` is a standalone tool execution (see `ToolNodeReq`).

Returns:



452
 
# File 'lib/telnyx/models/ai/assistant_update_params.rb', line 452

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

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

Per-node voice override. Only fields set here override the assistant-level voice settings; unset fields cascade.

Returns:



459
 
# File 'lib/telnyx/models/ai/assistant_update_params.rb', line 459

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

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



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