telnyx 5.111.0 → 5.112.0

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

@@ -112,8 +112,9 @@ module Telnyx
         #   `/ai/integrations/connections`. Each item references a catalog integration by
         #   `integration_id`.
         #
-        #   @return [Array<Telnyx::Models::AI::AssistantIntegration>, nil]
-        optional :integrations, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::AI::AssistantIntegration] }
+        #   @return [Array<Telnyx::Models::AI::InferenceEmbedding::Integration>, nil]
+        optional :integrations,
+                 -> { Telnyx::Internal::Type::ArrayOf[Telnyx::AI::InferenceEmbedding::Integration] }
 
         # @!attribute interruption_settings
         #   Settings for interruptions and how the assistant decides the user has finished
@@ -123,8 +124,8 @@ module Telnyx
         #   `transcription.settings` (`eot_threshold`, `eot_timeout_ms`,
         #   `eager_eot_threshold`).
         #
-        #   @return [Telnyx::Models::AI::InferenceEmbeddingInterruptionSettings, nil]
-        optional :interruption_settings, -> { Telnyx::AI::InferenceEmbeddingInterruptionSettings }
+        #   @return [Telnyx::Models::AI::InferenceEmbedding::InterruptionSettings, nil]
+        optional :interruption_settings, -> { Telnyx::AI::InferenceEmbedding::InterruptionSettings }
 
         # @!attribute llm_api_key_ref
         #   This is only needed when using third-party inference providers selected by
@@ -141,8 +142,8 @@ module Telnyx
         #   MCP servers attached to the assistant. Create MCP servers with
         #   `/ai/mcp_servers`, then reference them by `id` here.
         #
-        #   @return [Array<Telnyx::Models::AI::AssistantMcpServer>, nil]
-        optional :mcp_servers, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::AI::AssistantMcpServer] }
+        #   @return [Array<Telnyx::Models::AI::InferenceEmbedding::McpServer>, nil]
+        optional :mcp_servers, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::AI::InferenceEmbedding::McpServer] }
 
         # @!attribute messaging_settings
         #
@@ -265,13 +266,13 @@ module Telnyx
         #
         #   @param insight_settings [Telnyx::Models::AI::InsightSettings]
         #
-        #   @param integrations [Array<Telnyx::Models::AI::AssistantIntegration>] Connected integrations attached to the assistant. The catalog of available integ
+        #   @param integrations [Array<Telnyx::Models::AI::InferenceEmbedding::Integration>] Connected integrations attached to the assistant. The catalog of available integ
         #
-        #   @param interruption_settings [Telnyx::Models::AI::InferenceEmbeddingInterruptionSettings] Settings for interruptions and how the assistant decides the user has finished s
+        #   @param interruption_settings [Telnyx::Models::AI::InferenceEmbedding::InterruptionSettings] Settings for interruptions and how the assistant decides the user has finished s
         #
         #   @param llm_api_key_ref [String] This is only needed when using third-party inference providers selected by `mode
         #
-        #   @param mcp_servers [Array<Telnyx::Models::AI::AssistantMcpServer>] MCP servers attached to the assistant. Create MCP servers with `/ai/mcp_servers`
+        #   @param mcp_servers [Array<Telnyx::Models::AI::InferenceEmbedding::McpServer>] MCP servers attached to the assistant. Create MCP servers with `/ai/mcp_servers`
         #
         #   @param messaging_settings [Telnyx::Models::AI::MessagingSettings]
         #
@@ -300,6 +301,173 @@ module Telnyx
         #   @param voice_settings [Telnyx::Models::AI::VoiceSettings]
         #
         #   @param widget_settings [Telnyx::Models::AI::WidgetSettings] Configuration settings for the assistant's web widget.
+
+        class Integration < Telnyx::Internal::Type::BaseModel
+          # @!attribute integration_id
+          #   Catalog integration ID to attach. This is the `id` from the integrations catalog
+          #   at `/ai/integrations` (the same value also appears as `integration_id` on
+          #   entries returned by `/ai/integrations/connections`). It is **not** the
+          #   connection-level `id` from `/ai/integrations/connections`.
+          #
+          #   @return [String]
+          required :integration_id, String
+
+          # @!attribute allowed_list
+          #   Optional per-assistant allowlist of integration tool names. When omitted or
+          #   empty, all tools allowed by the connected integration are available to the
+          #   assistant.
+          #
+          #   @return [Array<String>, nil]
+          optional :allowed_list, Telnyx::Internal::Type::ArrayOf[String]
+
+          # @!method initialize(integration_id:, allowed_list: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Telnyx::Models::AI::InferenceEmbedding::Integration} for more details.
+          #
+          #   Reference to a connected integration attached to an assistant. Discover
+          #   available integrations with `/ai/integrations` and connected integrations with
+          #   `/ai/integrations/connections`.
+          #
+          #   @param integration_id [String] Catalog integration ID to attach. This is the `id` from the integrations catalog
+          #
+          #   @param allowed_list [Array<String>] Optional per-assistant allowlist of integration tool names. When omitted or empt
+        end
+
+        # @see Telnyx::Models::AI::InferenceEmbedding#interruption_settings
+        class InterruptionSettings < Telnyx::Internal::Type::BaseModel
+          # @!attribute disable_greeting_interruption
+          #   When true, disables user interruptions while the assistant greeting is playing.
+          #
+          #   @return [Boolean, nil]
+          optional :disable_greeting_interruption, Telnyx::Internal::Type::Boolean
+
+          # @!attribute enable
+          #   Whether users can interrupt the assistant while it is speaking.
+          #
+          #   @return [Boolean, nil]
+          optional :enable, Telnyx::Internal::Type::Boolean
+
+          # @!attribute start_speaking_plan
+          #   Controls when the assistant starts speaking after the user stops. These
+          #   thresholds primarily apply to non turn-taking transcription models. For
+          #   turn-taking models like `deepgram/flux`, end-of-turn detection is driven by the
+          #   transcription end-of-turn settings under `transcription.settings` instead.
+          #
+          #   @return [Telnyx::Models::AI::InferenceEmbedding::InterruptionSettings::StartSpeakingPlan, nil]
+          optional :start_speaking_plan,
+                   -> { Telnyx::AI::InferenceEmbedding::InterruptionSettings::StartSpeakingPlan }
+
+          # @!method initialize(disable_greeting_interruption: nil, enable: nil, start_speaking_plan: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Telnyx::Models::AI::InferenceEmbedding::InterruptionSettings} for more details.
+          #
+          #   Settings for interruptions and how the assistant decides the user has finished
+          #   speaking. These timings are most relevant when using non turn-taking
+          #   transcription models. For turn-taking models like `deepgram/flux`, end-of-turn
+          #   behavior is controlled by the transcription end-of-turn settings under
+          #   `transcription.settings` (`eot_threshold`, `eot_timeout_ms`,
+          #   `eager_eot_threshold`).
+          #
+          #   @param disable_greeting_interruption [Boolean] When true, disables user interruptions while the assistant greeting is playing.
+          #
+          #   @param enable [Boolean] Whether users can interrupt the assistant while it is speaking.
+          #
+          #   @param start_speaking_plan [Telnyx::Models::AI::InferenceEmbedding::InterruptionSettings::StartSpeakingPlan] Controls when the assistant starts speaking after the user stops. These threshol
+
+          # @see Telnyx::Models::AI::InferenceEmbedding::InterruptionSettings#start_speaking_plan
+          class StartSpeakingPlan < Telnyx::Internal::Type::BaseModel
+            # @!attribute transcription_endpointing_plan
+            #   Endpointing thresholds used to decide when the user has finished speaking.
+            #   Applies to non turn-taking transcription models. For `deepgram/flux`, use
+            #   `transcription.settings.eot_threshold` / `eot_timeout_ms` /
+            #   `eager_eot_threshold`.
+            #
+            #   @return [Telnyx::Models::AI::InferenceEmbedding::InterruptionSettings::StartSpeakingPlan::TranscriptionEndpointingPlan, nil]
+            optional :transcription_endpointing_plan,
+                     -> { Telnyx::AI::InferenceEmbedding::InterruptionSettings::StartSpeakingPlan::TranscriptionEndpointingPlan }
+
+            # @!attribute wait_seconds
+            #   Minimum seconds to wait before the assistant starts speaking.
+            #
+            #   @return [Float, nil]
+            optional :wait_seconds, Float
+
+            # @!method initialize(transcription_endpointing_plan: nil, wait_seconds: nil)
+            #   Some parameter documentations has been truncated, see
+            #   {Telnyx::Models::AI::InferenceEmbedding::InterruptionSettings::StartSpeakingPlan}
+            #   for more details.
+            #
+            #   Controls when the assistant starts speaking after the user stops. These
+            #   thresholds primarily apply to non turn-taking transcription models. For
+            #   turn-taking models like `deepgram/flux`, end-of-turn detection is driven by the
+            #   transcription end-of-turn settings under `transcription.settings` instead.
+            #
+            #   @param transcription_endpointing_plan [Telnyx::Models::AI::InferenceEmbedding::InterruptionSettings::StartSpeakingPlan::TranscriptionEndpointingPlan] Endpointing thresholds used to decide when the user has finished speaking. Appli
+            #
+            #   @param wait_seconds [Float] Minimum seconds to wait before the assistant starts speaking.
+
+            # @see Telnyx::Models::AI::InferenceEmbedding::InterruptionSettings::StartSpeakingPlan#transcription_endpointing_plan
+            class TranscriptionEndpointingPlan < Telnyx::Internal::Type::BaseModel
+              # @!attribute on_no_punctuation_seconds
+              #   Seconds to wait after the transcript ends without punctuation.
+              #
+              #   @return [Float, nil]
+              optional :on_no_punctuation_seconds, Float
+
+              # @!attribute on_number_seconds
+              #   Seconds to wait after the transcript ends with a number.
+              #
+              #   @return [Float, nil]
+              optional :on_number_seconds, Float
+
+              # @!attribute on_punctuation_seconds
+              #   Seconds to wait after the transcript ends with punctuation.
+              #
+              #   @return [Float, nil]
+              optional :on_punctuation_seconds, Float
+
+              # @!method initialize(on_no_punctuation_seconds: nil, on_number_seconds: nil, on_punctuation_seconds: nil)
+              #   Endpointing thresholds used to decide when the user has finished speaking.
+              #   Applies to non turn-taking transcription models. For `deepgram/flux`, use
+              #   `transcription.settings.eot_threshold` / `eot_timeout_ms` /
+              #   `eager_eot_threshold`.
+              #
+              #   @param on_no_punctuation_seconds [Float] Seconds to wait after the transcript ends without punctuation.
+              #
+              #   @param on_number_seconds [Float] Seconds to wait after the transcript ends with a number.
+              #
+              #   @param on_punctuation_seconds [Float] Seconds to wait after the transcript ends with punctuation.
+            end
+          end
+        end
+
+        class McpServer < Telnyx::Internal::Type::BaseModel
+          # @!attribute id
+          #   ID of the MCP server to attach. This must be the `id` of an MCP server returned
+          #   by the `/ai/mcp_servers` endpoints.
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute allowed_tools
+          #   Optional per-assistant allowlist of MCP tool names. When omitted, the assistant
+          #   uses the MCP server's configured `allowed_tools`.
+          #
+          #   @return [Array<String>, nil]
+          optional :allowed_tools, Telnyx::Internal::Type::ArrayOf[String]
+
+          # @!method initialize(id:, allowed_tools: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Telnyx::Models::AI::InferenceEmbedding::McpServer} for more details.
+          #
+          #   Reference to an MCP server attached to an assistant. Create and manage MCP
+          #   servers with the `/ai/mcp_servers` endpoints, then attach them to assistants by
+          #   ID.
+          #
+          #   @param id [String] ID of the MCP server to attach. This must be the `id` of an MCP server returned
+          #
+          #   @param allowed_tools [Array<String>] Optional per-assistant allowlist of MCP tool names. When omitted, the assistant
+        end
       end
     end
   end

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

@@ -7,8 +7,8 @@ module Telnyx
       class OpenAIListModelsResponse < Telnyx::Internal::Type::BaseModel
         # @!attribute data
         #
-        #   @return [Array<Telnyx::Models::ModelMetadata>]
-        required :data, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::ModelMetadata] }
+        #   @return [Array<Telnyx::Models::AI::OpenAIListModelsResponse::Data>]
+        required :data, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::Models::AI::OpenAIListModelsResponse::Data] }
 
         # @!attribute object
         #
@@ -16,8 +16,215 @@ module Telnyx
         optional :object, String
 
         # @!method initialize(data:, object: nil)
-        #   @param data [Array<Telnyx::Models::ModelMetadata>]
+        #   @param data [Array<Telnyx::Models::AI::OpenAIListModelsResponse::Data>]
         #   @param object [String]
+
+        class Data < Telnyx::Internal::Type::BaseModel
+          # @!attribute id
+          #   Model identifier. For open-source models, follows the
+          #   `{organization}/{model_name}` convention from Hugging Face (e.g.
+          #   `moonshotai/Kimi-K2.6`).
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute context_length
+          #   Maximum total tokens (prompt + completion) supported by the model in a single
+          #   request.
+          #
+          #   @return [Integer]
+          required :context_length, Integer
+
+          # @!attribute created
+          #   Timestamp at which the model was registered on Telnyx Inference (ISO 8601).
+          #
+          #   @return [Time]
+          required :created, Time
+
+          # @!attribute languages
+          #   ISO language codes the model supports (e.g. `en`, `es`).
+          #
+          #   @return [Array<String>]
+          required :languages, Telnyx::Internal::Type::ArrayOf[String]
+
+          # @!attribute license
+          #   License the model is distributed under, e.g. `Apache 2.0`, `MIT`,
+          #   `Llama 3 Community License`.
+          #
+          #   @return [String]
+          required :license, String
+
+          # @!attribute organization
+          #   Organization that originally published the model, matching the prefix of `id`
+          #   for open-source models.
+          #
+          #   @return [String]
+          required :organization, String
+
+          # @!attribute owned_by
+          #   Owner of the model. `Telnyx` for Telnyx-hosted open-source models, the upstream
+          #   provider name for proxied models, or the Telnyx organization id for fine-tuned
+          #   models.
+          #
+          #   @return [String]
+          required :owned_by, String
+
+          # @!attribute parameters
+          #   Total parameter count of the model.
+          #
+          #   @return [Integer]
+          required :parameters, Integer
+
+          # @!attribute tier
+          #   Billing tier the model belongs to. Used together with `pricing` to determine
+          #   cost per 1M tokens.
+          #
+          #   @return [Symbol, Telnyx::Models::AI::OpenAIListModelsResponse::Data::Tier]
+          required :tier, enum: -> { Telnyx::Models::AI::OpenAIListModelsResponse::Data::Tier }
+
+          # @!attribute base_model
+          #   Base model the fine-tuned model was trained from. Only set for fine-tuned
+          #   models.
+          #
+          #   @return [String, nil]
+          optional :base_model, String, nil?: true
+
+          # @!attribute description
+          #   Short, human-readable summary of what the model is best suited for.
+          #
+          #   @return [String, nil]
+          optional :description, String, nil?: true
+
+          # @!attribute is_fine_tunable
+          #   Whether the model can be used as a base for a fine-tuning job via
+          #   `POST /v2/ai/fine_tuning/jobs`.
+          #
+          #   @return [Boolean, nil]
+          optional :is_fine_tunable, Telnyx::Internal::Type::Boolean
+
+          # @!attribute is_vision_supported
+          #   Whether the model accepts image inputs in chat completions (multimodal vision
+          #   support).
+          #
+          #   @return [Boolean, nil]
+          optional :is_vision_supported, Telnyx::Internal::Type::Boolean
+
+          # @!attribute max_completion_tokens
+          #   Maximum number of completion (output) tokens the model will generate per
+          #   request. `null` if unconstrained beyond `context_length`.
+          #
+          #   @return [Integer, nil]
+          optional :max_completion_tokens, Integer, nil?: true
+
+          # @!attribute object
+          #   Object type. Always `model`.
+          #
+          #   @return [String, nil]
+          optional :object, String
+
+          # @!attribute parameters_str
+          #   Human-readable parameter count, e.g. `1.0T`, `753.9B`, `8B`.
+          #
+          #   @return [String, nil]
+          optional :parameters_str, String, nil?: true
+
+          # @!attribute pricing
+          #   Mapping of token kind to price, as strings to preserve precision. Typical keys
+          #   are `prompt`, `cached_prompt`, and `completion`. When pricing is available the
+          #   block also includes `currency` (ISO 4217 code matching the account's configured
+          #   billing currency) and `unit` (the denomination the prices are quoted in,
+          #   currently always `1M_tokens` for token-priced models).
+          #
+          #   @return [Hash{Symbol=>String}, nil]
+          optional :pricing, Telnyx::Internal::Type::HashOf[String]
+
+          # @!attribute recommended_for_assistants
+          #   Whether Telnyx currently recommends this model as the LLM powering a Telnyx AI
+          #   Assistant.
+          #
+          #   @return [Boolean, nil]
+          optional :recommended_for_assistants, Telnyx::Internal::Type::Boolean
+
+          # @!attribute regions
+          #   Public region names where the model is currently deployed (e.g. `us-central-1`,
+          #   `eu-central-1`).
+          #
+          #   @return [Array<String>, nil]
+          optional :regions, Telnyx::Internal::Type::ArrayOf[String]
+
+          # @!attribute task
+          #   Primary task the model is intended for, e.g. `text-generation`,
+          #   `audio-text-to-text`, `feature-extraction` (embeddings).
+          #
+          #   @return [String, nil]
+          optional :task, String
+
+          # @!method initialize(id:, context_length:, created:, languages:, license:, organization:, owned_by:, parameters:, tier:, base_model: nil, description: nil, is_fine_tunable: nil, is_vision_supported: nil, max_completion_tokens: nil, object: nil, parameters_str: nil, pricing: nil, recommended_for_assistants: nil, regions: nil, task: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Telnyx::Models::AI::OpenAIListModelsResponse::Data} for more details.
+          #
+          #   Metadata for a model available on Telnyx Inference. Returned by
+          #   `GET /v2/ai/openai/models` (and the deprecated `GET /v2/ai/models`). Open-source
+          #   models live under their Hugging Face organization (e.g. `moonshotai/Kimi-K2.6`,
+          #   `zai-org/GLM-5.1-FP8`, `MiniMaxAI/MiniMax-M2.7`); fine-tuned models are owned by
+          #   the Telnyx organization that trained them.
+          #
+          #   @param id [String] Model identifier. For open-source models, follows the `{organization}/{model_nam
+          #
+          #   @param context_length [Integer] Maximum total tokens (prompt + completion) supported by the model in a single re
+          #
+          #   @param created [Time] Timestamp at which the model was registered on Telnyx Inference (ISO 8601).
+          #
+          #   @param languages [Array<String>] ISO language codes the model supports (e.g. `en`, `es`).
+          #
+          #   @param license [String] License the model is distributed under, e.g. `Apache 2.0`, `MIT`, `Llama 3 Commu
+          #
+          #   @param organization [String] Organization that originally published the model, matching the prefix of `id` fo
+          #
+          #   @param owned_by [String] Owner of the model. `Telnyx` for Telnyx-hosted open-source models, the upstream
+          #
+          #   @param parameters [Integer] Total parameter count of the model.
+          #
+          #   @param tier [Symbol, Telnyx::Models::AI::OpenAIListModelsResponse::Data::Tier] Billing tier the model belongs to. Used together with `pricing` to determine cos
+          #
+          #   @param base_model [String, nil] Base model the fine-tuned model was trained from. Only set for fine-tuned models
+          #
+          #   @param description [String, nil] Short, human-readable summary of what the model is best suited for.
+          #
+          #   @param is_fine_tunable [Boolean] Whether the model can be used as a base for a fine-tuning job via `POST /v2/ai/f
+          #
+          #   @param is_vision_supported [Boolean] Whether the model accepts image inputs in chat completions (multimodal vision su
+          #
+          #   @param max_completion_tokens [Integer, nil] Maximum number of completion (output) tokens the model will generate per request
+          #
+          #   @param object [String] Object type. Always `model`.
+          #
+          #   @param parameters_str [String, nil] Human-readable parameter count, e.g. `1.0T`, `753.9B`, `8B`.
+          #
+          #   @param pricing [Hash{Symbol=>String}] Mapping of token kind to price, as strings to preserve precision. Typical keys a
+          #
+          #   @param recommended_for_assistants [Boolean] Whether Telnyx currently recommends this model as the LLM powering a Telnyx AI A
+          #
+          #   @param regions [Array<String>] Public region names where the model is currently deployed (e.g. `us-central-1`,
+          #
+          #   @param task [String] Primary task the model is intended for, e.g. `text-generation`, `audio-text-to-t
+
+          # Billing tier the model belongs to. Used together with `pricing` to determine
+          # cost per 1M tokens.
+          #
+          # @see Telnyx::Models::AI::OpenAIListModelsResponse::Data#tier
+          module Tier
+            extend Telnyx::Internal::Type::Enum
+
+            SMALL = :small
+            MEDIUM = :medium
+            LARGE = :large
+            UNLISTED = :unlisted
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
       end
     end
   end

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

@@ -32,7 +32,7 @@ module Telnyx
           #   variable string like `{{ targets }}` where `targets` is returned by the dynamic
           #   variables webhook and resolves to an array of target objects at runtime.
           #
-          #   @return [Array<Telnyx::Models::AI::TransferTool::Transfer::Targets::TargetsList>, String]
+          #   @return [Array<Telnyx::Models::AI::TransferTool::Transfer::Targets::UnionMember0>, String]
           required :targets, union: -> { Telnyx::AI::TransferTool::Transfer::Targets }
 
           # @!method initialize(from:, targets:)
@@ -41,7 +41,7 @@ module Telnyx
           #
           #   @param from [String] Number or SIP URI placing the call.
           #
-          #   @param targets [Array<Telnyx::Models::AI::TransferTool::Transfer::Targets::TargetsList>, String] The different possible targets of the transfer. The assistant will be able to ch
+          #   @param targets [Array<Telnyx::Models::AI::TransferTool::Transfer::Targets::UnionMember0>, String] The different possible targets of the transfer. The assistant will be able to ch
 
           # The different possible targets of the transfer. The assistant will be able to
           # choose one of the targets to transfer the call to. This can also be a dynamic
@@ -52,12 +52,12 @@ module Telnyx
           module Targets
             extend Telnyx::Internal::Type::Union
 
-            variant -> { Telnyx::Models::AI::TransferTool::Transfer::Targets::TargetsListArray }
+            variant -> { Telnyx::Models::AI::TransferTool::Transfer::Targets::UnionMember0Array }
 
             # A dynamic variable string like `{{ targets }}` where `targets` is returned by the dynamic variables webhook and resolves to an array of target objects at runtime.
             variant String
 
-            class TargetsList < Telnyx::Internal::Type::BaseModel
+            class UnionMember0 < Telnyx::Internal::Type::BaseModel
               # @!attribute to
               #   The destination number or SIP URI of the call.
               #
@@ -77,11 +77,13 @@ module Telnyx
             end
 
             # @!method self.variants
-            #   @return [Array(Array<Telnyx::Models::AI::TransferTool::Transfer::Targets::TargetsList>, String)]
+            #   @return [Array(Array<Telnyx::Models::AI::TransferTool::Transfer::Targets::UnionMember0>, String)]
 
             # @type [Telnyx::Internal::Type::Converter]
-            TargetsListArray =
-              Telnyx::Internal::Type::ArrayOf[-> { Telnyx::AI::TransferTool::Transfer::Targets::TargetsList }]
+            UnionMember0Array =
+              Telnyx::Internal::Type::ArrayOf[-> {
+                Telnyx::AI::TransferTool::Transfer::Targets::UnionMember0
+              }]
           end
         end