telnyx 5.169.0 → 5.171.0

data/lib/telnyx/models/ai/assistants/update_assistant.rb

@@ -19,6 +19,13 @@ 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::AvatarSettingsRequest, nil]
+          optional :avatar_settings, -> { Telnyx::AI::AvatarSettingsRequest }, nil?: true
+
           # @!attribute conversation_flow
           #   Conversation flow as supplied by API clients (create / update).
           #
@@ -29,6 +36,18 @@ module Telnyx
           #   @return [Telnyx::Models::AI::ConversationFlowReq, nil]
           optional :conversation_flow, -> { Telnyx::AI::ConversationFlowReq }
 
+          # @!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]
@@ -230,8 +249,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.
@@ -239,14 +268,18 @@ module Telnyx
           #   @return [Telnyx::Models::AI::WidgetSettings, nil]
           optional :widget_settings, -> { Telnyx::AI::WidgetSettings }
 
-          # @!method initialize(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, insight_settings: nil, instructions: nil, integrations: nil, interruption_settings: nil, llm_api_key_ref: nil, mcp_servers: nil, messaging_settings: nil, model: nil, name: nil, observability_settings: nil, post_conversation_settings: nil, privacy_settings: nil, tags: nil, telephony_settings: nil, tool_ids: nil, tools: nil, transcription: nil, version_name: nil, voice_settings: nil, widget_settings: nil)
+          # @!method initialize(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, insight_settings: nil, instructions: nil, integrations: nil, interruption_settings: nil, llm_api_key_ref: nil, mcp_servers: nil, messaging_settings: nil, model: nil, name: nil, observability_settings: nil, post_conversation_settings: nil, privacy_settings: nil, tags: nil, telephony_settings: nil, tool_ids: nil, tools: nil, transcription: nil, version_name: nil, voice_settings: nil, websocket_settings: nil, widget_settings: nil)
           #   Some parameter documentations has been truncated, see
           #   {Telnyx::Models::AI::Assistants::UpdateAssistant} for more details.
           #
           #   @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::AvatarSettingsRequest, nil] **Beta:** Configuration for the Telnyx open-source avatar provider. The launch c
+          #
           #   @param conversation_flow [Telnyx::Models::AI::ConversationFlowReq] Conversation flow as supplied by API clients (create / update).
           #
+          #   @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 default values
@@ -299,7 +332,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

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

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AI
+      class AvatarSettingsRequest < Telnyx::Internal::Type::BaseModel
+        # @!attribute avatar_id
+        #   The Telnyx avatar to render.
+        #
+        #   @return [Symbol, Telnyx::Models::AI::AvatarSettingsRequest::AvatarID]
+        required :avatar_id, enum: -> { Telnyx::AI::AvatarSettingsRequest::AvatarID }
+
+        # @!attribute background_id
+        #   The background to render.
+        #
+        #   @return [Symbol, Telnyx::Models::AI::AvatarSettingsRequest::BackgroundID]
+        required :background_id, enum: -> { Telnyx::AI::AvatarSettingsRequest::BackgroundID }
+
+        # @!attribute model
+        #   Required avatar model identifier, separate from `avatar_id`. The supported value
+        #   is `foxtrot-1`. Omission, null, and unsupported model identifiers are rejected.
+        #
+        #   @return [Symbol, Telnyx::Models::AI::AvatarSettingsRequest::Model]
+        required :model, enum: -> { Telnyx::AI::AvatarSettingsRequest::Model }
+
+        # @!attribute provider
+        #   Selects the Telnyx open-source avatar provider.
+        #
+        #   @return [Symbol, :telnyx]
+        required :provider, const: :telnyx
+
+        # @!method initialize(avatar_id:, background_id:, model:, provider: :telnyx)
+        #   Some parameter documentations has been truncated, see
+        #   {Telnyx::Models::AI::AvatarSettingsRequest} for more details.
+        #
+        #   **Beta:** Configuration for the Telnyx open-source avatar provider. The launch
+        #   catalog supports six avatars and office, studio, or reception backgrounds.
+        #
+        #   @param avatar_id [Symbol, Telnyx::Models::AI::AvatarSettingsRequest::AvatarID] The Telnyx avatar to render.
+        #
+        #   @param background_id [Symbol, Telnyx::Models::AI::AvatarSettingsRequest::BackgroundID] The background to render.
+        #
+        #   @param model [Symbol, Telnyx::Models::AI::AvatarSettingsRequest::Model] Required avatar model identifier, separate from `avatar_id`. The supported value
+        #
+        #   @param provider [Symbol, :telnyx] Selects the Telnyx open-source avatar provider.
+
+        # The Telnyx avatar to render.
+        #
+        # @see Telnyx::Models::AI::AvatarSettingsRequest#avatar_id
+        module AvatarID
+          extend Telnyx::Internal::Type::Enum
+
+          ELENA = :elena
+          BEN = :ben
+          JORDAN = :jordan
+          LIN = :lin
+          AVERY = :avery
+          RAPHAEL = :raphael
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # The background to render.
+        #
+        # @see Telnyx::Models::AI::AvatarSettingsRequest#background_id
+        module BackgroundID
+          extend Telnyx::Internal::Type::Enum
+
+          OFFICE = :office
+          STUDIO = :studio
+          RECEPTION = :reception
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # Required avatar model identifier, separate from `avatar_id`. The supported value
+        # is `foxtrot-1`. Omission, null, and unsupported model identifiers are rejected.
+        #
+        # @see Telnyx::Models::AI::AvatarSettingsRequest#model
+        module Model
+          extend Telnyx::Internal::Type::Enum
+
+          FOXTROT_1 = :"foxtrot-1"
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

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

@@ -63,10 +63,29 @@ module Telnyx
         optional :logprobs, Telnyx::Internal::Type::Boolean
 
         # @!attribute max_tokens
-        #   Maximum number of completion tokens the model should generate.
+        #   Maximum number of completion (output) tokens, including reasoning and answer
+        #   tokens combined. An omitted or null limit defaults to 8192 unless the model is
+        #   excluded from that default; excluded models leave the limit to the serving
+        #   engine. Explicit values and applied defaults are clamped to the model's
+        #   max_completion_tokens metadata when that ceiling is set (see GET
+        #   /v2/ai/openai/models). An omitted limit on an excluded model remains unset even
+        #   when metadata declares a ceiling. Input and output together must fit the model's
+        #   context window. Set an explicit limit when a bounded generation budget is
+        #   required. For current Telnyx-hosted models, omitted or null limits default to
+        #   8192 for `zai-org/GLM-5.3`, `zai-org/GLM-5.3-Flash` and
+        #   `deepseek-ai/DeepSeek-V4.1-Flash`. The hosted exclusions are
+        #   `moonshotai/Kimi-K3`, `moonshotai/Kimi-K2.6`, `moonshotai/Kimi-K2.5`,
+        #   `zai-org/GLM-5.2`, `zai-org/GLM-5.1-FP8`, `MiniMaxAI/MiniMax-M3-MXFP8`,
+        #   `MiniMaxAI/MiniMax-M2.7`, `Qwen/Qwen3.8-27B`, `Qwen/Qwen3-235B-A22B`,
+        #   `deepseek-ai/DeepSeek-V4-Flash-0731`, `meta-llama/Llama-3.3-70B-Instruct`,
+        #   `meta-llama/Meta-Llama-3.1-70B-Instruct`,
+        #   `meta-llama/Meta-Llama-3.1-8B-Instruct` and `google/gemma-2b-it`. Legacy
+        #   external and fine-tuned model IDs can also bypass the default; model discovery
+        #   reports completion ceilings, not whether this default applies. Set an explicit
+        #   limit for predictable behavior across models.
         #
         #   @return [Integer, nil]
-        optional :max_tokens, Integer
+        optional :max_tokens, Integer, nil?: true
 
         # @!attribute min_p
         #   This is an alternative to `top_p` that
@@ -228,7 +247,7 @@ module Telnyx
         #
         #   @param logprobs [Boolean] Whether to return log probabilities of the output tokens or not. If true, return
         #
-        #   @param max_tokens [Integer] Maximum number of completion tokens the model should generate.
+        #   @param max_tokens [Integer, nil] Maximum number of completion (output) tokens, including reasoning and answer tok
         #
         #   @param min_p [Float] This is an alternative to `top_p` that [many prefer](https://github.com/huggingf
         #

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

@@ -38,8 +38,8 @@ module Telnyx
 
         # @!attribute sources
         #
-        #   @return [Array<Telnyx::Models::AI::Collections::Source>, nil]
-        optional :sources, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::AI::Collections::Source] }
+        #   @return [Array<Telnyx::Models::AI::Collections::CollectionsSource>, nil]
+        optional :sources, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::AI::Collections::CollectionsSource] }
 
         # @!attribute status
         #
@@ -69,7 +69,7 @@ module Telnyx
         #
         #   @param slug [String]
         #
-        #   @param sources [Array<Telnyx::Models::AI::Collections::Source>]
+        #   @param sources [Array<Telnyx::Models::AI::Collections::CollectionsSource>]
         #
         #   @param status [String]
         #

data/lib/telnyx/models/ai/collections/collections_source.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AI
+      module Collections
+        class CollectionsSource < Telnyx::Internal::Type::BaseModel
+          # @!attribute id
+          #
+          #   @return [String, nil]
+          optional :id, String
+
+          # @!attribute bucket_id
+          #   The Telnyx Storage bucket name. Present only for `bucket` sources.
+          #
+          #   @return [String, nil]
+          optional :bucket_id, String
+
+          # @!attribute collection_id
+          #
+          #   @return [String, nil]
+          optional :collection_id, String
+
+          # @!attribute record_type
+          #   Identifies the record type. Always `ai_collection_source`.
+          #
+          #   @return [String, nil]
+          optional :record_type, String
+
+          # @!attribute source_type
+          #   The type of Telnyx data attached as a source. `bucket` requires an additional
+          #   `bucket_id`. Only `voice` is searchable today; `meeting_bot`, `message`, and
+          #   `bucket` attach but are not yet searchable (Coming soon).
+          #
+          #   @return [Symbol, Telnyx::Models::AI::Collections::SourceType, nil]
+          optional :source_type, enum: -> { Telnyx::AI::Collections::SourceType }
+
+          # @!attribute status
+          #
+          #   @return [String, nil]
+          optional :status, String
+
+          # @!method initialize(id: nil, bucket_id: nil, collection_id: nil, record_type: nil, source_type: nil, status: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Telnyx::Models::AI::Collections::CollectionsSource} for more details.
+          #
+          #   @param id [String]
+          #
+          #   @param bucket_id [String] The Telnyx Storage bucket name. Present only for `bucket` sources.
+          #
+          #   @param collection_id [String]
+          #
+          #   @param record_type [String] Identifies the record type. Always `ai_collection_source`.
+          #
+          #   @param source_type [Symbol, Telnyx::Models::AI::Collections::SourceType] The type of Telnyx data attached as a source. `bucket` requires an additional `b
+          #
+          #   @param status [String]
+        end
+      end
+
+      CollectionsSource = Collections::CollectionsSource
+    end
+  end
+end

data/lib/telnyx/models/ai/collections/source.rb

@@ -6,55 +6,51 @@ module Telnyx
       module Collections
         class Source < Telnyx::Internal::Type::BaseModel
           # @!attribute id
+          #   Identifies one source within its profile: an ingested session, or one remembered
+          #   fact. Returned by `ingest` and `remember` when the write is accepted.
+          #   Re-ingesting a session keeps its source id.
           #
-          #   @return [String, nil]
-          optional :id, String
+          #   @return [String]
+          required :id, String
 
-          # @!attribute bucket_id
-          #   The Telnyx Storage bucket name. Present only for `bucket` sources.
+          # @!attribute memory_count
+          #   Memories extracted from this source. A memory derived from several sources is
+          #   not counted here.
           #
-          #   @return [String, nil]
-          optional :bucket_id, String
+          #   @return [Integer]
+          required :memory_count, Integer
 
-          # @!attribute collection_id
+          # @!attribute session_id
+          #   The session this source was ingested as. Null for a remembered fact.
           #
           #   @return [String, nil]
-          optional :collection_id, String
+          required :session_id, String, nil?: true
 
-          # @!attribute record_type
-          #   Identifies the record type. Always `ai_collection_source`.
+          # @!attribute created_at
+          #   When the source was first stored.
           #
           #   @return [String, nil]
-          optional :record_type, String
+          optional :created_at, String, nil?: true
 
-          # @!attribute source_type
-          #   The type of Telnyx data attached as a source. `bucket` requires an additional
-          #   `bucket_id`. Only `voice` is searchable today; `meeting_bot`, `message`, and
-          #   `bucket` attach but are not yet searchable (Coming soon).
-          #
-          #   @return [Symbol, Telnyx::Models::AI::Collections::SourceType, nil]
-          optional :source_type, enum: -> { Telnyx::AI::Collections::SourceType }
-
-          # @!attribute status
+          # @!attribute updated_at
+          #   When the source was last written; re-ingesting moves it.
           #
           #   @return [String, nil]
-          optional :status, String
+          optional :updated_at, String, nil?: true
 
-          # @!method initialize(id: nil, bucket_id: nil, collection_id: nil, record_type: nil, source_type: nil, status: nil)
+          # @!method initialize(id:, memory_count:, session_id:, created_at: nil, updated_at: nil)
           #   Some parameter documentations has been truncated, see
           #   {Telnyx::Models::AI::Collections::Source} for more details.
           #
-          #   @param id [String]
-          #
-          #   @param bucket_id [String] The Telnyx Storage bucket name. Present only for `bucket` sources.
+          #   @param id [String] Identifies one source within its profile: an ingested session, or one remembered
           #
-          #   @param collection_id [String]
+          #   @param memory_count [Integer] Memories extracted from this source. A memory derived from several sources is no
           #
-          #   @param record_type [String] Identifies the record type. Always `ai_collection_source`.
+          #   @param session_id [String, nil] The session this source was ingested as. Null for a remembered fact.
           #
-          #   @param source_type [Symbol, Telnyx::Models::AI::Collections::SourceType] The type of Telnyx data attached as a source. `bucket` requires an additional `b
+          #   @param created_at [String, nil] When the source was first stored.
           #
-          #   @param status [String]
+          #   @param updated_at [String, nil] When the source was last written; re-ingesting moves it.
         end
       end
     end

data/lib/telnyx/models/ai/collections/source_create_response.rb

@@ -8,13 +8,13 @@ module Telnyx
         class SourceCreateResponse < Telnyx::Internal::Type::BaseModel
           # @!attribute data
           #
-          #   @return [Telnyx::Models::AI::Collections::Source, nil]
-          optional :data, -> { Telnyx::AI::Collections::Source }
+          #   @return [Telnyx::Models::AI::Collections::CollectionsSource, nil]
+          optional :data, -> { Telnyx::AI::Collections::CollectionsSource }
 
           # @!method initialize(data: nil)
           #   Envelope containing a single collection source.
           #
-          #   @param data [Telnyx::Models::AI::Collections::Source]
+          #   @param data [Telnyx::Models::AI::Collections::CollectionsSource]
         end
       end
     end

data/lib/telnyx/models/ai/collections/source_list_response.rb

@@ -8,11 +8,11 @@ module Telnyx
         class SourceListResponse < Telnyx::Internal::Type::BaseModel
           # @!attribute data
           #
-          #   @return [Array<Telnyx::Models::AI::Collections::Source>, nil]
-          optional :data, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::AI::Collections::Source] }
+          #   @return [Array<Telnyx::Models::AI::Collections::CollectionsSource>, nil]
+          optional :data, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::AI::Collections::CollectionsSource] }
 
           # @!method initialize(data: nil)
-          #   @param data [Array<Telnyx::Models::AI::Collections::Source>]
+          #   @param data [Array<Telnyx::Models::AI::Collections::CollectionsSource>]
         end
       end
     end

data/lib/telnyx/models/ai/collections/source_replace_response.rb

@@ -8,8 +8,8 @@ module Telnyx
         class SourceReplaceResponse < Telnyx::Internal::Type::BaseModel
           # @!attribute data
           #
-          #   @return [Array<Telnyx::Models::AI::Collections::Source>, nil]
-          optional :data, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::AI::Collections::Source] }
+          #   @return [Array<Telnyx::Models::AI::Collections::CollectionsSource>, nil]
+          optional :data, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::AI::Collections::CollectionsSource] }
 
           # @!attribute meta
           #   Reports which source IDs were added, retained, and removed by a replace
@@ -22,7 +22,7 @@ module Telnyx
           #   Some parameter documentations has been truncated, see
           #   {Telnyx::Models::AI::Collections::SourceReplaceResponse} for more details.
           #
-          #   @param data [Array<Telnyx::Models::AI::Collections::Source>]
+          #   @param data [Array<Telnyx::Models::AI::Collections::CollectionsSource>]
           #
           #   @param meta [Telnyx::Models::AI::Collections::SourceReplaceResponse::Meta] Reports which source IDs were added, retained, and removed by a replace operatio
 

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

@@ -6,7 +6,7 @@ module Telnyx
       class ConversationFlowReq < Telnyx::Internal::Type::BaseModel
         # @!attribute nodes
         #   All nodes in the flow. Must contain `start_node_id`. Each node is a prompt node
-        #   (`type: prompt`) or a tool node (`type: tool`).
+        #   (`type: prompt`), a tool node (`type: tool`), or a speak node (`type: speak`).
         #
         #   @return [Array<Telnyx::Models::AI::FlowNodeReq, Telnyx::Models::AI::ToolNodeReq, Telnyx::Models::AI::SpeakNodeReq>]
         required :nodes, -> { Telnyx::Internal::Type::ArrayOf[union: Telnyx::AI::ConversationFlowReq::Node] }
@@ -59,7 +59,10 @@ module Telnyx
           # Unlike a prompt node, a tool node has no instructions or model — it
           # isn't an LLM turn. Reaching it deterministically runs one shared tool
           # (arguments filled from matching dynamic variables by name), then routes
-          # on the result via outgoing `tool_result` edges.
+          # via outgoing `llm` / `expression` edges, with exactly one `default`
+          # fallback edge required when the node has any outgoing edges (the
+          # tool's outcome is readable as `telnyx_last_tool_status_code` in
+          # `expression` conditions).
           variant :tool, -> { Telnyx::AI::ToolNodeReq }
 
           # A standalone scripted-message step in a flow, as supplied by clients.

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

@@ -38,6 +38,16 @@ module Telnyx
         #   @return [String, nil]
         optional :metadata_assistant_id, String
 
+        # @!attribute metadata_assistant_version_id
+        #   Filter by assistant version ID (e.g.,
+        #   `metadata->assistant_version_id=eq.20250812T114318034399`). The version that
+        #   handled the conversation is stored in metadata when the conversation starts;
+        #   conversations created before this field was tracked, or that never resolved a
+        #   version, have no `assistant_version_id` and do not match this filter.
+        #
+        #   @return [String, nil]
+        optional :metadata_assistant_version_id, String
+
         # @!attribute metadata_call_control_id
         #   Filter by call control ID (e.g., `metadata->call_control_id=eq.v3:123`)
         #
@@ -85,7 +95,7 @@ module Telnyx
         #   @return [String, nil]
         optional :order, String
 
-        # @!method initialize(id: nil, created_at: nil, last_message_at: nil, limit: nil, metadata_assistant_id: nil, metadata_call_control_id: nil, metadata_telnyx_agent_target: nil, metadata_telnyx_conversation_channel: nil, metadata_telnyx_end_user_target: nil, name: nil, or_: nil, order: nil, request_options: {})
+        # @!method initialize(id: nil, created_at: nil, last_message_at: nil, limit: nil, metadata_assistant_id: nil, metadata_assistant_version_id: nil, metadata_call_control_id: nil, metadata_telnyx_agent_target: nil, metadata_telnyx_conversation_channel: nil, metadata_telnyx_end_user_target: nil, name: nil, or_: nil, order: nil, request_options: {})
         #   Some parameter documentations has been truncated, see
         #   {Telnyx::Models::AI::ConversationListParams} for more details.
         #
@@ -99,6 +109,8 @@ module Telnyx
         #
         #   @param metadata_assistant_id [String] Filter by assistant ID (e.g., `metadata->assistant_id=eq.assistant-123`)
         #
+        #   @param metadata_assistant_version_id [String] Filter by assistant version ID (e.g., `metadata->assistant_version_id=eq.2025081
+        #
         #   @param metadata_call_control_id [String] Filter by call control ID (e.g., `metadata->call_control_id=eq.v3:123`)
         #
         #   @param metadata_telnyx_agent_target [String] Filter by the phone number, SIP URI, or other identifier for the agent (e.g., `m

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

@@ -0,0 +1,118 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AI
+      class DelegationSettings < Telnyx::Internal::Type::BaseModel
+        # @!attribute enabled
+        #   Whether the assistant delegates work to a backend model. Defaults to `true`: a
+        #   GPT-Live assistant with delegation disabled can hold a conversation but can
+        #   never look anything up or run a tool.
+        #
+        #   @return [Boolean, nil]
+        optional :enabled, Telnyx::Internal::Type::Boolean
+
+        # @!attribute external_llm
+        #   Run the backend on your own OpenAI-compatible endpoint instead of a
+        #   Telnyx-hosted model. As above, a raw `api_key` here is rejected — reference an
+        #   integration secret with `external_llm.llm_api_key_ref` instead.
+        #
+        #   @return [Telnyx::Models::AI::ExternalLlm, nil]
+        optional :external_llm, -> { Telnyx::AI::ExternalLlm }
+
+        # @!attribute instructions
+        #   Extra instructions for the backend model, in addition to the assistant's own.
+        #   Use this for the business rules the backend needs and the talking model does
+        #   not.
+        #
+        #   @return [String, nil]
+        optional :instructions, String
+
+        # @!attribute llm_api_key_ref
+        #   Integration secret identifier for the backend model's API key. Required for
+        #   models from providers other than Telnyx, OpenAI and Anthropic. A raw `api_key`
+        #   is rejected rather than ignored, so that no plaintext credential is stored on
+        #   the assistant.
+        #
+        #   @return [String, nil]
+        optional :llm_api_key_ref, String
+
+        # @!attribute mode
+        #   Who answers a delegation. `telnyx` runs the backend model on Telnyx with the
+        #   assistant's own tools, MCP servers and observability. `client` relays the
+        #   delegation to a server you host over the WebSocket configured in
+        #   `websocket_settings`: Telnyx sends a `session.delegation.created` frame and
+        #   waits for your `session.delegation.completed` answer. That answer is text only,
+        #   since the socket offers no tool vocabulary. If no socket is connected the
+        #   delegation is refused and the assistant tells the caller it cannot look things
+        #   up right now. Defaults to `telnyx`.
+        #
+        #   @return [Symbol, Telnyx::Models::AI::DelegationSettings::Mode, nil]
+        optional :mode, enum: -> { Telnyx::AI::DelegationSettings::Mode }
+
+        # @!attribute model
+        #   The backend model that answers delegations. Must be a model available for AI
+        #   Assistants. When enabling `telnyx` delegation, explicitly set this field or
+        #   `external_llm.model`; a configuration without either backend model is rejected.
+        #   Only applies when `mode` is `telnyx`.
+        #
+        #   @return [String, nil]
+        optional :model, String
+
+        # @!attribute speak_results
+        #   Whether the backend's answer is spoken to the caller. When `true` the result is
+        #   appended as commentary and paraphrased aloud; when `false` it is kept as silent
+        #   context that informs later answers without being read out. Defaults to `true`.
+        #
+        #   @return [Boolean, nil]
+        optional :speak_results, Telnyx::Internal::Type::Boolean
+
+        # @!method initialize(enabled: nil, external_llm: nil, instructions: nil, llm_api_key_ref: nil, mode: nil, model: nil, speak_results: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Telnyx::Models::AI::DelegationSettings} for more details.
+        #
+        #   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.
+        #
+        #   @param enabled [Boolean] Whether the assistant delegates work to a backend model. Defaults to `true`: a G
+        #
+        #   @param external_llm [Telnyx::Models::AI::ExternalLlm] Run the backend on your own OpenAI-compatible endpoint instead of a Telnyx-hoste
+        #
+        #   @param instructions [String] Extra instructions for the backend model, in addition to the assistant's own. Us
+        #
+        #   @param llm_api_key_ref [String] Integration secret identifier for the backend model's API key. Required for mode
+        #
+        #   @param mode [Symbol, Telnyx::Models::AI::DelegationSettings::Mode] Who answers a delegation. `telnyx` runs the backend model on Telnyx with the ass
+        #
+        #   @param model [String] The backend model that answers delegations. Must be a model available for AI Ass
+        #
+        #   @param speak_results [Boolean] Whether the backend's answer is spoken to the caller. When `true` the result is
+
+        # Who answers a delegation. `telnyx` runs the backend model on Telnyx with the
+        # assistant's own tools, MCP servers and observability. `client` relays the
+        # delegation to a server you host over the WebSocket configured in
+        # `websocket_settings`: Telnyx sends a `session.delegation.created` frame and
+        # waits for your `session.delegation.completed` answer. That answer is text only,
+        # since the socket offers no tool vocabulary. If no socket is connected the
+        # delegation is refused and the assistant tells the caller it cannot look things
+        # up right now. Defaults to `telnyx`.
+        #
+        # @see Telnyx::Models::AI::DelegationSettings#mode
+        module Mode
+          extend Telnyx::Internal::Type::Enum
+
+          TELNYX = :telnyx
+          CLIENT = :client
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end