telnyx 5.170.0 → 5.173.0

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

@@ -0,0 +1,151 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AI
+      # @see Telnyx::Resources::AI::Avatars#list
+      class Avatar < Telnyx::Internal::Type::BaseModel
+        # @!attribute id
+        #   Stable identifier returned by the Avatars API. Discover available stock IDs with
+        #   GET /v2/ai/avatars and filter[avatar_type]=stock rather than maintaining a fixed
+        #   list. Custom avatar IDs use the `avatar_` prefix and must belong to the
+        #   authenticated organization. The service validates that the selected avatar is
+        #   available.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute avatar_type
+        #   Whether the avatar is provided by Telnyx or was uploaded by the authenticated
+        #   organization.
+        #
+        #   @return [Symbol, Telnyx::Models::AI::AvatarType]
+        required :avatar_type, enum: -> { Telnyx::AI::AvatarType }
+
+        # @!attribute hosted
+        #   Indicates that avatar rendering runs on Telnyx-operated infrastructure.
+        #
+        #   @return [Boolean, true]
+        required :hosted, const: true
+
+        # @!attribute image_url
+        #   HTTPS image URL suitable for an avatar selection thumbnail. If the URL expires,
+        #   list or retrieve the avatar again to refresh it.
+        #
+        #   @return [String]
+        required :image_url, String
+
+        # @!attribute name
+        #   Customer-facing avatar name.
+        #
+        #   @return [String]
+        required :name, String
+
+        # @!attribute provider
+        #   Avatar provider. The first release supports Telnyx avatars.
+        #
+        #   @return [Symbol, :telnyx]
+        required :provider, const: :telnyx
+
+        # @!attribute content_type
+        #   MIME type of a custom avatar image.
+        #
+        #   @return [Symbol, Telnyx::Models::AI::Avatar::ContentType, nil]
+        optional :content_type, enum: -> { Telnyx::AI::Avatar::ContentType }
+
+        # @!attribute created_at
+        #   Time when the custom avatar was created.
+        #
+        #   @return [Time, nil]
+        optional :created_at, Time
+
+        # @!attribute height_px
+        #   Decoded height of a custom avatar image.
+        #
+        #   @return [Integer, nil]
+        optional :height_px, Integer
+
+        # @!attribute image_url_expires_at
+        #   Expiration time of `image_url`. Omitted when the URL does not expire.
+        #
+        #   @return [Time, nil]
+        optional :image_url_expires_at, Time
+
+        # @!attribute size_bytes
+        #   Size of a custom avatar image in bytes.
+        #
+        #   @return [Integer, nil]
+        optional :size_bytes, Integer
+
+        # @!attribute updated_at
+        #   Time when the custom avatar was last updated.
+        #
+        #   @return [Time, nil]
+        optional :updated_at, Time
+
+        # @!attribute width_px
+        #   Decoded width of a custom avatar image.
+        #
+        #   @return [Integer, nil]
+        optional :width_px, Integer
+
+        response_only do
+          # @!attribute suggested_voice_id
+          #   Optional recommended Telnyx text-to-speech voice for this avatar. An omitted
+          #   field or empty string means no recommendation is available. Custom avatars have
+          #   no suggested voice. It is informational and selecting the avatar does not
+          #   automatically change the AI Assistant's configured voice.
+          #
+          #   @return [String, nil]
+          optional :suggested_voice_id, String
+        end
+
+        # @!method initialize(id:, avatar_type:, image_url:, name:, content_type: nil, created_at: nil, height_px: nil, image_url_expires_at: nil, size_bytes: nil, suggested_voice_id: nil, updated_at: nil, width_px: nil, hosted: true, provider: :telnyx)
+        #   Some parameter documentations has been truncated, see
+        #   {Telnyx::Models::AI::Avatar} for more details.
+        #
+        #   @param id [String] Stable identifier returned by the Avatars API. Discover available stock IDs with
+        #
+        #   @param avatar_type [Symbol, Telnyx::Models::AI::AvatarType] Whether the avatar is provided by Telnyx or was uploaded by the authenticated or
+        #
+        #   @param image_url [String] HTTPS image URL suitable for an avatar selection thumbnail. If the URL expires,
+        #
+        #   @param name [String] Customer-facing avatar name.
+        #
+        #   @param content_type [Symbol, Telnyx::Models::AI::Avatar::ContentType] MIME type of a custom avatar image.
+        #
+        #   @param created_at [Time] Time when the custom avatar was created.
+        #
+        #   @param height_px [Integer] Decoded height of a custom avatar image.
+        #
+        #   @param image_url_expires_at [Time] Expiration time of `image_url`. Omitted when the URL does not expire.
+        #
+        #   @param size_bytes [Integer] Size of a custom avatar image in bytes.
+        #
+        #   @param suggested_voice_id [String] Optional recommended Telnyx text-to-speech voice for this avatar. An omitted fie
+        #
+        #   @param updated_at [Time] Time when the custom avatar was last updated.
+        #
+        #   @param width_px [Integer] Decoded width of a custom avatar image.
+        #
+        #   @param hosted [Boolean, true] Indicates that avatar rendering runs on Telnyx-operated infrastructure.
+        #
+        #   @param provider [Symbol, :telnyx] Avatar provider. The first release supports Telnyx avatars.
+
+        # MIME type of a custom avatar image.
+        #
+        # @see Telnyx::Models::AI::Avatar#content_type
+        module ContentType
+          extend Telnyx::Internal::Type::Enum
+
+          IMAGE_JPEG = :"image/jpeg"
+          IMAGE_PNG = :"image/png"
+          IMAGE_WEBP = :"image/webp"
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AI
+      # @see Telnyx::Resources::AI::Avatars#create
+      class AvatarCreateParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        # @!attribute image_file
+        #   JPEG, PNG, or WebP image file. The maximum file size is 10 MiB.
+        #
+        #   @return [Pathname, StringIO, IO, String, Telnyx::FilePart]
+        required :image_file, Telnyx::Internal::Type::FileInput
+
+        # @!attribute name
+        #   Customer-facing name of the custom avatar.
+        #
+        #   @return [String]
+        required :name, String
+
+        # @!method initialize(image_file:, name:, request_options: {})
+        #   @param image_file [Pathname, StringIO, IO, String, Telnyx::FilePart] JPEG, PNG, or WebP image file. The maximum file size is 10 MiB.
+        #
+        #   @param name [String] Customer-facing name of the custom avatar.
+        #
+        #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/{sig/telnyx/models/ai/tool_delete_response.rbs → lib/telnyx/models/ai/avatar_id.rb}

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 module Telnyx
   module Models
     module AI
-      ToolDeleteResponse: Telnyx::Internal::Type::Converter
+      AvatarID = String
     end
   end
 end

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

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AI
+      # @see Telnyx::Resources::AI::Avatars#list
+      class AvatarListParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        # @!attribute filter_avatar_type
+        #   Return only stock or custom avatars.
+        #
+        #   @return [Symbol, Telnyx::Models::AI::AvatarType, nil]
+        optional :filter_avatar_type, enum: -> { Telnyx::AI::AvatarType }
+
+        # @!attribute filter_id
+        #   Return the avatar with this exact ID.
+        #
+        #   @return [String, nil]
+        optional :filter_id, String
+
+        # @!attribute filter_name
+        #   Return avatars whose names contain this value, using case-insensitive matching.
+        #
+        #   @return [String, nil]
+        optional :filter_name, String
+
+        # @!attribute page_number
+        #   Page number to retrieve, starting at 1.
+        #
+        #   @return [Integer, nil]
+        optional :page_number, Integer
+
+        # @!attribute page_size
+        #   Number of avatars to return per page.
+        #
+        #   @return [Integer, nil]
+        optional :page_size, Integer
+
+        # @!method initialize(filter_avatar_type: nil, filter_id: nil, filter_name: nil, page_number: nil, page_size: nil, request_options: {})
+        #   @param filter_avatar_type [Symbol, Telnyx::Models::AI::AvatarType] Return only stock or custom avatars.
+        #
+        #   @param filter_id [String] Return the avatar with this exact ID.
+        #
+        #   @param filter_name [String] Return avatars whose names contain this value, using case-insensitive matching.
+        #
+        #   @param page_number [Integer] Page number to retrieve, starting at 1.
+        #
+        #   @param page_size [Integer] Number of avatars to return per page.
+        #
+        #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AI
+      # @see Telnyx::Resources::AI::Avatars#create
+      class AvatarResponse < Telnyx::Internal::Type::BaseModel
+        # @!attribute data
+        #
+        #   @return [Telnyx::Models::AI::Avatar]
+        required :data, -> { Telnyx::AI::Avatar }
+
+        # @!method initialize(data:)
+        #   @param data [Telnyx::Models::AI::Avatar]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AI
+      # @see Telnyx::Resources::AI::Avatars#retrieve
+      class AvatarRetrieveParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        # @!attribute avatar_id
+        #   Stable identifier returned by the Avatars API. Discover available stock IDs with
+        #   GET /v2/ai/avatars and filter[avatar_type]=stock rather than maintaining a fixed
+        #   list. Custom avatar IDs use the `avatar_` prefix and must belong to the
+        #   authenticated organization. The service validates that the selected avatar is
+        #   available.
+        #
+        #   @return [String]
+        required :avatar_id, String
+
+        # @!method initialize(avatar_id:, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Telnyx::Models::AI::AvatarRetrieveParams} for more details.
+        #
+        #   @param avatar_id [String] Stable identifier returned by the Avatars API. Discover available stock IDs with
+        #
+        #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AI
+      class AvatarSettingsRequest < Telnyx::Internal::Type::BaseModel
+        # @!attribute avatar_id
+        #   The Telnyx stock avatar or organization-owned custom avatar to render.
+        #
+        #   @return [String]
+        required :avatar_id, String
+
+        # @!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. Use a stock
+        #   avatar or an organization-owned custom avatar returned by the Avatars API.
+        #   Discover the available stock catalog with GET /v2/ai/avatars and
+        #   filter[avatar_type]=stock; follow meta.total_pages to load every page.
+        #
+        #   @param avatar_id [String] The Telnyx stock avatar or organization-owned custom 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 background to render.
+        #
+        # @see Telnyx::Models::AI::AvatarSettingsRequest#background_id
+        module BackgroundID
+          extend Telnyx::Internal::Type::Enum
+
+          OFFICE = :office
+          STUDIO = :studio
+          RECEPTION = :reception
+          ILLUSTRATED_WORKSPACE = :illustrated_workspace
+
+          # @!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/avatar_type.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AI
+      # Whether the avatar is provided by Telnyx or was uploaded by the authenticated
+      # organization.
+      module AvatarType
+        extend Telnyx::Internal::Type::Enum
+
+        STOCK = :stock
+        CUSTOM = :custom
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AI
+      # @see Telnyx::Resources::AI::Avatars#update
+      class AvatarUpdateParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        # @!attribute avatar_id
+        #   Stable identifier returned by the Avatars API. Discover available stock IDs with
+        #   GET /v2/ai/avatars and filter[avatar_type]=stock rather than maintaining a fixed
+        #   list. Custom avatar IDs use the `avatar_` prefix and must belong to the
+        #   authenticated organization. The service validates that the selected avatar is
+        #   available.
+        #
+        #   @return [String]
+        required :avatar_id, String
+
+        # @!attribute name
+        #   New customer-facing name of the custom avatar.
+        #
+        #   @return [String]
+        required :name, String
+
+        # @!method initialize(avatar_id:, name:, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Telnyx::Models::AI::AvatarUpdateParams} for more details.
+        #
+        #   @param avatar_id [String] Stable identifier returned by the Avatars API. Discover available stock IDs with
+        #
+        #   @param name [String] New customer-facing name of the custom avatar.
+        #
+        #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+      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/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