telnyx 5.169.0 → 5.171.0

data/lib/telnyx/models/ai/flow_edge.rb

@@ -37,9 +37,14 @@ module Telnyx
         #   Directed transition from one node to a target, gated by a condition.
         #
         #   The target is either another node in the same flow (`NodeTarget`) or a different
-        #   assistant (`AssistantTarget`). Multiple edges may share a `start_node_id`; the
-        #   runtime evaluates them in the order they're declared and takes the first whose
-        #   condition is true.
+        #   assistant (`AssistantTarget`). Multiple edges may share a `start_node_id`. On
+        #   calls, `expression` conditions are evaluated before the model turn and take
+        #   precedence over `llm` conditions regardless of declaration order, while `llm`
+        #   conditions are offered to the assistant's model as transition tools and fire
+        #   when the model selects one. On chat channels, an `expression` condition that is
+        #   true when the turn begins routes before the reply is generated; all conditioned
+        #   edges that remain are considered together in declaration order after the reply,
+        #   and the first true one wins.
         #
         #   @param id [String] Caller-supplied unique identifier for this edge within the flow.
         #
@@ -58,11 +63,18 @@ module Telnyx
 
           discriminator :type
 
-          # Edge condition evaluated by the LLM from a natural-language prompt.
+          # Edge condition routed by the assistant's LLM from a natural-language
+          # prompt.
           #
-          # The model is asked to judge the prompt against conversation context and
-          # returns true/false. Use this for fuzzy intents that aren't expressible as
-          # a deterministic expression (e.g. 'user wants to escalate to a human').
+          # How the edge is decided depends on the channel. On calls, each outgoing
+          # `llm` condition is offered to the assistant's model as a transition tool
+          # alongside the assistant's tools, and the edge fires when the model
+          # selects it; the platform does not evaluate the prompt itself, and
+          # instructions that forbid or discourage tool calls can stop these edges
+          # from firing. On chat channels, the edge prompts are evaluated in a
+          # separate model call after the reply, which does not use the assistant's
+          # instructions. Use this for fuzzy intents that aren't expressible as a
+          # deterministic expression (e.g. 'user wants to escalate to a human').
           variant :llm, -> { Telnyx::AI::FlowEdge::Condition::Llm }
 
           # Edge condition evaluated as a deterministic expression AST.
@@ -85,7 +97,9 @@ module Telnyx
 
           class Llm < Telnyx::Internal::Type::BaseModel
             # @!attribute prompt
-            #   Natural-language criterion the LLM judges as true/false.
+            #   Natural-language criterion the model routes on. On calls this is offered to the
+            #   model as the transition tool's description; on chat channels it is judged as a
+            #   statement in the post-reply evaluation call.
             #
             #   @return [String]
             required :prompt, String
@@ -96,13 +110,21 @@ module Telnyx
             required :type, const: :llm
 
             # @!method initialize(prompt:, type: :llm)
-            #   Edge condition evaluated by the LLM from a natural-language prompt.
+            #   Some parameter documentations has been truncated, see
+            #   {Telnyx::Models::AI::FlowEdge::Condition::Llm} for more details.
+            #
+            #   Edge condition routed by the assistant's LLM from a natural-language prompt.
             #
-            #   The model is asked to judge the prompt against conversation context and returns
-            #   true/false. Use this for fuzzy intents that aren't expressible as a
-            #   deterministic expression (e.g. 'user wants to escalate to a human').
+            #   How the edge is decided depends on the channel. On calls, each outgoing `llm`
+            #   condition is offered to the assistant's model as a transition tool alongside the
+            #   assistant's tools, and the edge fires when the model selects it; the platform
+            #   does not evaluate the prompt itself, and instructions that forbid or discourage
+            #   tool calls can stop these edges from firing. On chat channels, the edge prompts
+            #   are evaluated in a separate model call after the reply, which does not use the
+            #   assistant's instructions. Use this for fuzzy intents that aren't expressible as
+            #   a deterministic expression (e.g. 'user wants to escalate to a human').
             #
-            #   @param prompt [String] Natural-language criterion the LLM judges as true/false.
+            #   @param prompt [String] Natural-language criterion the model routes on. On calls this is offered to the
             #
             #   @param type [Symbol, :llm]
           end

data/lib/telnyx/models/ai/flow_node.rb

@@ -105,8 +105,8 @@ module Telnyx
         # @!attribute voice_settings
         #   Per-node voice override (response form).
         #
-        #   @return [Telnyx::Models::AI::VoiceSettings, nil]
-        optional :voice_settings, -> { Telnyx::AI::VoiceSettings }
+        #   @return [Telnyx::Models::AI::InferenceEmbeddingVoiceSettings, nil]
+        optional :voice_settings, -> { Telnyx::AI::InferenceEmbeddingVoiceSettings }
 
         # @!method 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)
         #   Some parameter documentations has been truncated, see
@@ -140,7 +140,7 @@ module Telnyx
         #
         #   @param type [Symbol, Telnyx::Models::AI::FlowNode::Type] Node kind discriminator. `prompt` is an LLM-driven step.
         #
-        #   @param voice_settings [Telnyx::Models::AI::VoiceSettings] Per-node voice override (response form).
+        #   @param voice_settings [Telnyx::Models::AI::InferenceEmbeddingVoiceSettings] Per-node voice override (response form).
 
         # How `instructions` combine with the assistant-level instructions. `replace`
         # (default): the node's instructions are used alone. `append`: the node's

data/lib/telnyx/models/ai/flow_node_req.rb

@@ -82,14 +82,19 @@ module Telnyx
 
         # @!attribute transcription
         #   Per-node transcription override (model/language/region). Unset fields cascade
-        #   from the assistant-level transcription.
+        #   from the assistant-level transcription. A node that sets `model`,
+        #   `fallback_models`, or `challenger` doesn't inherit the assistant's
+        #   `fallback_models` or `challenger`; it uses only the ones it sets. Otherwise it
+        #   inherits them, and they must fit the model and language the node runs; a change
+        #   they no longer fit is rejected.
         #
         #   @return [Telnyx::Models::AI::TranscriptionSettings, nil]
         optional :transcription, -> { Telnyx::AI::TranscriptionSettings }
 
         # @!attribute type
         #   Node kind discriminator. `prompt` (default) is an LLM-driven step; `tool` is a
-        #   standalone tool execution (see `ToolNodeReq`).
+        #   standalone tool execution and `speak` a scripted message (see `ToolNodeReq` /
+        #   `SpeakNodeReq`).
         #
         #   @return [Symbol, Telnyx::Models::AI::FlowNodeReq::Type, nil]
         optional :type, enum: -> { Telnyx::AI::FlowNodeReq::Type }
@@ -98,8 +103,8 @@ module Telnyx
         #   Per-node voice override. Only fields set here override the assistant-level voice
         #   settings; unset fields cascade.
         #
-        #   @return [Telnyx::Models::AI::VoiceSettings, nil]
-        optional :voice_settings, -> { Telnyx::AI::VoiceSettings }
+        #   @return [Telnyx::Models::AI::InferenceEmbeddingVoiceSettings, nil]
+        optional :voice_settings, -> { Telnyx::AI::InferenceEmbeddingVoiceSettings }
 
         # @!method 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_mode: nil, transcription: nil, type: nil, voice_settings: nil)
         #   Some parameter documentations has been truncated, see
@@ -134,7 +139,7 @@ module Telnyx
         #
         #   @param type [Symbol, Telnyx::Models::AI::FlowNodeReq::Type] Node kind discriminator. `prompt` (default) is an LLM-driven step; `tool` is a s
         #
-        #   @param voice_settings [Telnyx::Models::AI::VoiceSettings] Per-node voice override. Only fields set here override the assistant-level voice
+        #   @param voice_settings [Telnyx::Models::AI::InferenceEmbeddingVoiceSettings] Per-node voice override. Only fields set here override the assistant-level voice
 
         # How `instructions` combine with the assistant-level instructions. `replace`
         # (default): the node's instructions are used alone. `append`: the node's
@@ -167,7 +172,8 @@ module Telnyx
         end
 
         # Node kind discriminator. `prompt` (default) is an LLM-driven step; `tool` is a
-        # standalone tool execution (see `ToolNodeReq`).
+        # standalone tool execution and `speak` a scripted message (see `ToolNodeReq` /
+        # `SpeakNodeReq`).
         #
         # @see Telnyx::Models::AI::FlowNodeReq#type
         module Type

data/lib/telnyx/models/ai/inference_embedding.rb

@@ -50,12 +50,31 @@ module Telnyx
         #   @return [Array<Telnyx::Models::AI::AssistantA2AAgent>, nil]
         optional :a2a_agents, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::AI::AssistantA2AAgent] }
 
+        # @!attribute avatar_settings
+        #   **Beta:** Configuration for the Telnyx open-source avatar provider. The launch
+        #   catalog supports six avatars and office, studio, or reception backgrounds.
+        #
+        #   @return [Telnyx::Models::AI::TelnyxAvatarSettings, nil]
+        optional :avatar_settings, -> { Telnyx::AI::TelnyxAvatarSettings }, nil?: true
+
         # @!attribute conversation_flow
         #   Conversation flow as returned by the API.
         #
         #   @return [Telnyx::Models::AI::ConversationFlow, nil]
         optional :conversation_flow, -> { Telnyx::AI::ConversationFlow }
 
+        # @!attribute delegation_settings
+        #   Splits the conversation between a frontend model that talks to the caller and a
+        #   backend model that does the work. On the GPT-Live route the frontend model
+        #   cannot call tools at all — when it needs something done it raises a delegation
+        #   and waits. On the chat completion route the frontend keeps a single `delegate`
+        #   tool that returns immediately, so the conversation carries on while the backend
+        #   works. Either way the backend's answer is spoken as commentary or kept as silent
+        #   context, depending on `speak_results`. Beta feature.
+        #
+        #   @return [Telnyx::Models::AI::DelegationSettings, nil]
+        optional :delegation_settings, -> { Telnyx::AI::DelegationSettings }
+
         # @!attribute description
         #
         #   @return [String, nil]
@@ -244,8 +263,18 @@ module Telnyx
 
         # @!attribute voice_settings
         #
-        #   @return [Telnyx::Models::AI::VoiceSettings, nil]
-        optional :voice_settings, -> { Telnyx::AI::VoiceSettings }
+        #   @return [Telnyx::Models::AI::InferenceEmbeddingVoiceSettings, nil]
+        optional :voice_settings, -> { Telnyx::AI::InferenceEmbeddingVoiceSettings }
+
+        # @!attribute websocket_settings
+        #   Streams conversation and telephony events to a WebSocket server you host, and
+        #   accepts messages injected back into the conversation. Telnyx opens the
+        #   connection as a client, once per conversation. Delivery is best effort
+        #   throughout: while the connection is down events are dropped rather than queued,
+        #   and no socket failure is ever allowed to affect the call. Beta feature.
+        #
+        #   @return [Telnyx::Models::AI::WebsocketSettings, nil]
+        optional :websocket_settings, -> { Telnyx::AI::WebsocketSettings }
 
         # @!attribute widget_settings
         #   Configuration settings for the assistant's web widget.
@@ -253,7 +282,7 @@ module Telnyx
         #   @return [Telnyx::Models::AI::WidgetSettings, nil]
         optional :widget_settings, -> { Telnyx::AI::WidgetSettings }
 
-        # @!method initialize(id:, created_at:, instructions:, model:, name:, a2a_agents: nil, conversation_flow: nil, description: nil, dynamic_variables: nil, dynamic_variables_webhook_timeout_ms: nil, dynamic_variables_webhook_url: nil, enabled_features: nil, external_llm: nil, fallback_config: nil, greeting: nil, import_metadata: nil, insight_settings: nil, integrations: nil, interruption_settings: nil, llm_api_key_ref: nil, mcp_servers: nil, messaging_settings: nil, observability_settings: nil, post_conversation_settings: nil, privacy_settings: nil, related_mission_ids: nil, tags: nil, telephony_settings: nil, tools: nil, transcription: nil, version_created_at: nil, version_id: nil, version_name: nil, voice_settings: nil, widget_settings: nil)
+        # @!method initialize(id:, created_at:, instructions:, model:, name:, a2a_agents: nil, avatar_settings: nil, conversation_flow: nil, delegation_settings: nil, description: nil, dynamic_variables: nil, dynamic_variables_webhook_timeout_ms: nil, dynamic_variables_webhook_url: nil, enabled_features: nil, external_llm: nil, fallback_config: nil, greeting: nil, import_metadata: nil, insight_settings: nil, integrations: nil, interruption_settings: nil, llm_api_key_ref: nil, mcp_servers: nil, messaging_settings: nil, observability_settings: nil, post_conversation_settings: nil, privacy_settings: nil, related_mission_ids: nil, tags: nil, telephony_settings: nil, tools: nil, transcription: nil, version_created_at: nil, version_id: nil, version_name: nil, voice_settings: nil, websocket_settings: nil, widget_settings: nil)
         #   Some parameter documentations has been truncated, see
         #   {Telnyx::Models::AI::InferenceEmbedding} for more details.
         #
@@ -269,8 +298,12 @@ module Telnyx
         #
         #   @param a2a_agents [Array<Telnyx::Models::AI::AssistantA2AAgent>] A2A agents this assistant can delegate to. Tools are not stored here: at the sta
         #
+        #   @param avatar_settings [Telnyx::Models::AI::TelnyxAvatarSettings, nil] **Beta:** Configuration for the Telnyx open-source avatar provider. The launch c
+        #
         #   @param conversation_flow [Telnyx::Models::AI::ConversationFlow] Conversation flow as returned by the API.
         #
+        #   @param delegation_settings [Telnyx::Models::AI::DelegationSettings] Splits the conversation between a frontend model that talks to the caller and a
+        #
         #   @param description [String]
         #
         #   @param dynamic_variables [Hash{Symbol=>Object}] Map of dynamic variables and their values
@@ -323,7 +356,9 @@ module Telnyx
         #
         #   @param version_name [String] Human-readable name for the assistant version.
         #
-        #   @param voice_settings [Telnyx::Models::AI::VoiceSettings]
+        #   @param voice_settings [Telnyx::Models::AI::InferenceEmbeddingVoiceSettings]
+        #
+        #   @param websocket_settings [Telnyx::Models::AI::WebsocketSettings] Streams conversation and telephony events to a WebSocket server you host, and ac
         #
         #   @param widget_settings [Telnyx::Models::AI::WidgetSettings] Configuration settings for the assistant's web widget.
       end