telnyx 5.169.0 → 5.171.0

data/rbi/telnyx/models/ai/flow_edge.rbi

@@ -45,9 +45,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.
         sig do
           params(
             id: String,
@@ -124,23 +129,32 @@ module Telnyx
                 )
               end
 
-            # 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.
             sig { returns(String) }
             attr_accessor :prompt
 
             sig { returns(Symbol) }
             attr_accessor :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').
             sig do
               params(prompt: String, type: Symbol).returns(T.attached_class)
             end
             def self.new(
-              # 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.
               prompt:,
               type: :llm
             )

data/rbi/telnyx/models/ai/flow_node.rbi

@@ -156,10 +156,14 @@ module Telnyx
         attr_writer :type
 
         # Per-node voice override (response form).
-        sig { returns(T.nilable(Telnyx::AI::VoiceSettings)) }
+        sig { returns(T.nilable(Telnyx::AI::InferenceEmbeddingVoiceSettings)) }
         attr_reader :voice_settings
 
-        sig { params(voice_settings: Telnyx::AI::VoiceSettings::OrHash).void }
+        sig do
+          params(
+            voice_settings: Telnyx::AI::InferenceEmbeddingVoiceSettings::OrHash
+          ).void
+        end
         attr_writer :voice_settings
 
         # One step in a conversation flow, as returned by the API.
@@ -198,7 +202,7 @@ module Telnyx
             tools_mode: Telnyx::AI::FlowNode::ToolsMode::OrSymbol,
             transcription: Telnyx::AI::TranscriptionSettings::OrHash,
             type: Telnyx::AI::FlowNode::Type::OrSymbol,
-            voice_settings: Telnyx::AI::VoiceSettings::OrHash
+            voice_settings: Telnyx::AI::InferenceEmbeddingVoiceSettings::OrHash
           ).returns(T.attached_class)
         end
         def self.new(
@@ -269,7 +273,7 @@ module Telnyx
               tools_mode: Telnyx::AI::FlowNode::ToolsMode::TaggedSymbol,
               transcription: Telnyx::AI::TranscriptionSettings,
               type: Telnyx::AI::FlowNode::Type::TaggedSymbol,
-              voice_settings: Telnyx::AI::VoiceSettings
+              voice_settings: Telnyx::AI::InferenceEmbeddingVoiceSettings
             }
           )
         end

data/rbi/telnyx/models/ai/flow_node_req.rbi

@@ -101,7 +101,11 @@ module Telnyx
         attr_writer :tools_mode
 
         # 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.
         sig { returns(T.nilable(Telnyx::AI::TranscriptionSettings)) }
         attr_reader :transcription
 
@@ -111,7 +115,8 @@ module Telnyx
         attr_writer :transcription
 
         # 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`).
         sig { returns(T.nilable(Telnyx::AI::FlowNodeReq::Type::OrSymbol)) }
         attr_reader :type
 
@@ -120,10 +125,14 @@ module Telnyx
 
         # Per-node voice override. Only fields set here override the assistant-level voice
         # settings; unset fields cascade.
-        sig { returns(T.nilable(Telnyx::AI::VoiceSettings)) }
+        sig { returns(T.nilable(Telnyx::AI::InferenceEmbeddingVoiceSettings)) }
         attr_reader :voice_settings
 
-        sig { params(voice_settings: Telnyx::AI::VoiceSettings::OrHash).void }
+        sig do
+          params(
+            voice_settings: Telnyx::AI::InferenceEmbeddingVoiceSettings::OrHash
+          ).void
+        end
         attr_writer :voice_settings
 
         # One step in a conversation flow, as supplied by API clients.
@@ -145,7 +154,7 @@ module Telnyx
             tools_mode: Telnyx::AI::FlowNodeReq::ToolsMode::OrSymbol,
             transcription: Telnyx::AI::TranscriptionSettings::OrHash,
             type: Telnyx::AI::FlowNodeReq::Type::OrSymbol,
-            voice_settings: Telnyx::AI::VoiceSettings::OrHash
+            voice_settings: Telnyx::AI::InferenceEmbeddingVoiceSettings::OrHash
           ).returns(T.attached_class)
         end
         def self.new(
@@ -186,10 +195,15 @@ module Telnyx
           # added to the assistant's tools. Ignored when `shared_tool_ids` is null.
           tools_mode: nil,
           # 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.
           transcription: nil,
           # 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`).
           type: nil,
           # Per-node voice override. Only fields set here override the assistant-level voice
           # settings; unset fields cascade.
@@ -213,7 +227,7 @@ module Telnyx
               tools_mode: Telnyx::AI::FlowNodeReq::ToolsMode::OrSymbol,
               transcription: Telnyx::AI::TranscriptionSettings,
               type: Telnyx::AI::FlowNodeReq::Type::OrSymbol,
-              voice_settings: Telnyx::AI::VoiceSettings
+              voice_settings: Telnyx::AI::InferenceEmbeddingVoiceSettings
             }
           )
         end
@@ -277,7 +291,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`).
         module Type
           extend Telnyx::Internal::Type::Enum
 

data/rbi/telnyx/models/ai/inference_embedding.rbi

@@ -49,6 +49,18 @@ module Telnyx
         end
         attr_writer :a2a_agents
 
+        # **Beta:** Configuration for the Telnyx open-source avatar provider. The launch
+        # catalog supports six avatars and office, studio, or reception backgrounds.
+        sig { returns(T.nilable(Telnyx::AI::TelnyxAvatarSettings)) }
+        attr_reader :avatar_settings
+
+        sig do
+          params(
+            avatar_settings: T.nilable(Telnyx::AI::TelnyxAvatarSettings::OrHash)
+          ).void
+        end
+        attr_writer :avatar_settings
+
         # Conversation flow as returned by the API.
         sig { returns(T.nilable(Telnyx::AI::ConversationFlow)) }
         attr_reader :conversation_flow
@@ -58,6 +70,23 @@ module Telnyx
         end
         attr_writer :conversation_flow
 
+        # 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.
+        sig { returns(T.nilable(Telnyx::AI::DelegationSettings)) }
+        attr_reader :delegation_settings
+
+        sig do
+          params(
+            delegation_settings: Telnyx::AI::DelegationSettings::OrHash
+          ).void
+        end
+        attr_writer :delegation_settings
+
         sig { returns(T.nilable(String)) }
         attr_reader :description
 
@@ -334,12 +363,29 @@ module Telnyx
         sig { params(version_name: String).void }
         attr_writer :version_name
 
-        sig { returns(T.nilable(Telnyx::AI::VoiceSettings)) }
+        sig { returns(T.nilable(Telnyx::AI::InferenceEmbeddingVoiceSettings)) }
         attr_reader :voice_settings
 
-        sig { params(voice_settings: Telnyx::AI::VoiceSettings::OrHash).void }
+        sig do
+          params(
+            voice_settings: Telnyx::AI::InferenceEmbeddingVoiceSettings::OrHash
+          ).void
+        end
         attr_writer :voice_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.
+        sig { returns(T.nilable(Telnyx::AI::WebsocketSettings)) }
+        attr_reader :websocket_settings
+
+        sig do
+          params(websocket_settings: Telnyx::AI::WebsocketSettings::OrHash).void
+        end
+        attr_writer :websocket_settings
+
         # Configuration settings for the assistant's web widget.
         sig { returns(T.nilable(Telnyx::AI::WidgetSettings)) }
         attr_reader :widget_settings
@@ -355,7 +401,10 @@ module Telnyx
             model: String,
             name: String,
             a2a_agents: T::Array[Telnyx::AI::AssistantA2AAgent::OrHash],
+            avatar_settings:
+              T.nilable(Telnyx::AI::TelnyxAvatarSettings::OrHash),
             conversation_flow: Telnyx::AI::ConversationFlow::OrHash,
+            delegation_settings: Telnyx::AI::DelegationSettings::OrHash,
             description: String,
             dynamic_variables: T::Hash[Symbol, T.anything],
             dynamic_variables_webhook_timeout_ms: Integer,
@@ -402,7 +451,8 @@ module Telnyx
             version_created_at: Time,
             version_id: String,
             version_name: String,
-            voice_settings: Telnyx::AI::VoiceSettings::OrHash,
+            voice_settings: Telnyx::AI::InferenceEmbeddingVoiceSettings::OrHash,
+            websocket_settings: Telnyx::AI::WebsocketSettings::OrHash,
             widget_settings: Telnyx::AI::WidgetSettings::OrHash
           ).returns(T.attached_class)
         end
@@ -428,8 +478,19 @@ module Telnyx
           # fetches combined. An agent whose card cannot be fetched costs the assistant that
           # capability for the conversation; it does not fail the call.
           a2a_agents: nil,
+          # **Beta:** Configuration for the Telnyx open-source avatar provider. The launch
+          # catalog supports six avatars and office, studio, or reception backgrounds.
+          avatar_settings: nil,
           # Conversation flow as returned by the API.
           conversation_flow: nil,
+          # 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.
+          delegation_settings: nil,
           description: nil,
           # Map of dynamic variables and their values
           dynamic_variables: nil,
@@ -513,6 +574,12 @@ module Telnyx
           # Human-readable name for the assistant version.
           version_name: nil,
           voice_settings: nil,
+          # 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.
+          websocket_settings: nil,
           # Configuration settings for the assistant's web widget.
           widget_settings: nil
         )
@@ -527,7 +594,9 @@ module Telnyx
               model: String,
               name: String,
               a2a_agents: T::Array[Telnyx::AI::AssistantA2AAgent],
+              avatar_settings: T.nilable(Telnyx::AI::TelnyxAvatarSettings),
               conversation_flow: Telnyx::AI::ConversationFlow,
+              delegation_settings: Telnyx::AI::DelegationSettings,
               description: String,
               dynamic_variables: T::Hash[Symbol, T.anything],
               dynamic_variables_webhook_timeout_ms: Integer,
@@ -556,7 +625,8 @@ module Telnyx
               version_created_at: Time,
               version_id: String,
               version_name: String,
-              voice_settings: Telnyx::AI::VoiceSettings,
+              voice_settings: Telnyx::AI::InferenceEmbeddingVoiceSettings,
+              websocket_settings: Telnyx::AI::WebsocketSettings,
               widget_settings: Telnyx::AI::WidgetSettings
             }
           )