telnyx 5.87.0 → 5.89.0

data/lib/telnyx/models/call_assistant_request.rb

@@ -24,14 +24,14 @@ module Telnyx
       # @!attribute external_llm
       #   External LLM configuration for bringing your own LLM endpoint.
       #
-      #   @return [Hash{Symbol=>Object}, nil]
-      optional :external_llm, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
+      #   @return [Telnyx::Models::CallAssistantRequest::ExternalLlm, nil]
+      optional :external_llm, -> { Telnyx::CallAssistantRequest::ExternalLlm }
 
       # @!attribute fallback_config
       #   Fallback LLM configuration used when the primary LLM provider is unavailable.
       #
-      #   @return [Hash{Symbol=>Object}, nil]
-      optional :fallback_config, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
+      #   @return [Telnyx::Models::CallAssistantRequest::FallbackConfig, nil]
+      optional :fallback_config, -> { Telnyx::CallAssistantRequest::FallbackConfig }
 
       # @!attribute greeting
       #   Initial greeting text spoken when the assistant starts. Can be plain text for
@@ -116,9 +116,9 @@ module Telnyx
       #
       #   @param dynamic_variables [Hash{Symbol=>String, Float, Boolean}] Map of dynamic variables and their default values. Dynamic variables can be refe
       #
-      #   @param external_llm [Hash{Symbol=>Object}] External LLM configuration for bringing your own LLM endpoint.
+      #   @param external_llm [Telnyx::Models::CallAssistantRequest::ExternalLlm] External LLM configuration for bringing your own LLM endpoint.
       #
-      #   @param fallback_config [Hash{Symbol=>Object}] Fallback LLM configuration used when the primary LLM provider is unavailable.
+      #   @param fallback_config [Telnyx::Models::CallAssistantRequest::FallbackConfig] Fallback LLM configuration used when the primary LLM provider is unavailable.
       #
       #   @param greeting [String] Initial greeting text spoken when the assistant starts. Can be plain text for an
       #
@@ -151,6 +151,209 @@ module Telnyx
         #   @return [Array(String, Float, Boolean)]
       end
 
+      # @see Telnyx::Models::CallAssistantRequest#external_llm
+      class ExternalLlm < Telnyx::Internal::Type::BaseModel
+        # @!attribute authentication_method
+        #   Authentication method used when connecting to the external LLM endpoint.
+        #
+        #   @return [Symbol, Telnyx::Models::CallAssistantRequest::ExternalLlm::AuthenticationMethod, nil]
+        optional :authentication_method,
+                 enum: -> { Telnyx::CallAssistantRequest::ExternalLlm::AuthenticationMethod }
+
+        # @!attribute base_url
+        #   Base URL for the external LLM endpoint.
+        #
+        #   @return [String, nil]
+        optional :base_url, String
+
+        # @!attribute certificate_ref
+        #   Integration secret identifier for the client certificate used with certificate
+        #   authentication.
+        #
+        #   @return [String, nil]
+        optional :certificate_ref, String
+
+        # @!attribute forward_metadata
+        #   When enabled, Telnyx forwards the assistant's dynamic variables to the external
+        #   LLM endpoint. Defaults to false. The chat completion request includes a
+        #   top-level `extra_metadata` object when dynamic variables are available. For
+        #   example:
+        #   `{"extra_metadata":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
+        #
+        #   @return [Boolean, nil]
+        optional :forward_metadata, Telnyx::Internal::Type::Boolean
+
+        # @!attribute llm_api_key_ref
+        #   Integration secret identifier for the external LLM API key.
+        #
+        #   @return [String, nil]
+        optional :llm_api_key_ref, String
+
+        # @!attribute model
+        #   Model identifier to use with the external LLM endpoint.
+        #
+        #   @return [String, nil]
+        optional :model, String
+
+        # @!attribute token_retrieval_url
+        #   URL used to retrieve an access token when certificate authentication is enabled.
+        #
+        #   @return [String, nil]
+        optional :token_retrieval_url, String
+
+        # @!method initialize(authentication_method: nil, base_url: nil, certificate_ref: nil, forward_metadata: nil, llm_api_key_ref: nil, model: nil, token_retrieval_url: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Telnyx::Models::CallAssistantRequest::ExternalLlm} for more details.
+        #
+        #   External LLM configuration for bringing your own LLM endpoint.
+        #
+        #   @param authentication_method [Symbol, Telnyx::Models::CallAssistantRequest::ExternalLlm::AuthenticationMethod] Authentication method used when connecting to the external LLM endpoint.
+        #
+        #   @param base_url [String] Base URL for the external LLM endpoint.
+        #
+        #   @param certificate_ref [String] Integration secret identifier for the client certificate used with certificate a
+        #
+        #   @param forward_metadata [Boolean] When enabled, Telnyx forwards the assistant's dynamic variables to the external
+        #
+        #   @param llm_api_key_ref [String] Integration secret identifier for the external LLM API key.
+        #
+        #   @param model [String] Model identifier to use with the external LLM endpoint.
+        #
+        #   @param token_retrieval_url [String] URL used to retrieve an access token when certificate authentication is enabled.
+
+        # Authentication method used when connecting to the external LLM endpoint.
+        #
+        # @see Telnyx::Models::CallAssistantRequest::ExternalLlm#authentication_method
+        module AuthenticationMethod
+          extend Telnyx::Internal::Type::Enum
+
+          TOKEN = :token
+          CERTIFICATE = :certificate
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+
+      # @see Telnyx::Models::CallAssistantRequest#fallback_config
+      class FallbackConfig < Telnyx::Internal::Type::BaseModel
+        # @!attribute external_llm
+        #   External LLM fallback configuration.
+        #
+        #   @return [Telnyx::Models::CallAssistantRequest::FallbackConfig::ExternalLlm, nil]
+        optional :external_llm, -> { Telnyx::CallAssistantRequest::FallbackConfig::ExternalLlm }
+
+        # @!attribute llm_api_key_ref
+        #   Integration secret identifier for the fallback model API key.
+        #
+        #   @return [String, nil]
+        optional :llm_api_key_ref, String
+
+        # @!attribute model
+        #   Fallback Telnyx-hosted model to use when the primary LLM provider is
+        #   unavailable.
+        #
+        #   @return [String, nil]
+        optional :model, String
+
+        # @!method initialize(external_llm: nil, llm_api_key_ref: nil, model: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Telnyx::Models::CallAssistantRequest::FallbackConfig} for more details.
+        #
+        #   Fallback LLM configuration used when the primary LLM provider is unavailable.
+        #
+        #   @param external_llm [Telnyx::Models::CallAssistantRequest::FallbackConfig::ExternalLlm] External LLM fallback configuration.
+        #
+        #   @param llm_api_key_ref [String] Integration secret identifier for the fallback model API key.
+        #
+        #   @param model [String] Fallback Telnyx-hosted model to use when the primary LLM provider is unavailable
+
+        # @see Telnyx::Models::CallAssistantRequest::FallbackConfig#external_llm
+        class ExternalLlm < Telnyx::Internal::Type::BaseModel
+          # @!attribute authentication_method
+          #   Authentication method used when connecting to the external LLM endpoint.
+          #
+          #   @return [Symbol, Telnyx::Models::CallAssistantRequest::FallbackConfig::ExternalLlm::AuthenticationMethod, nil]
+          optional :authentication_method,
+                   enum: -> { Telnyx::CallAssistantRequest::FallbackConfig::ExternalLlm::AuthenticationMethod }
+
+          # @!attribute base_url
+          #   Base URL for the external LLM endpoint.
+          #
+          #   @return [String, nil]
+          optional :base_url, String
+
+          # @!attribute certificate_ref
+          #   Integration secret identifier for the client certificate used with certificate
+          #   authentication.
+          #
+          #   @return [String, nil]
+          optional :certificate_ref, String
+
+          # @!attribute forward_metadata
+          #   When enabled, Telnyx forwards the assistant's dynamic variables to the external
+          #   LLM endpoint. Defaults to false. The chat completion request includes a
+          #   top-level `extra_metadata` object when dynamic variables are available. For
+          #   example:
+          #   `{"extra_metadata":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
+          #
+          #   @return [Boolean, nil]
+          optional :forward_metadata, Telnyx::Internal::Type::Boolean
+
+          # @!attribute llm_api_key_ref
+          #   Integration secret identifier for the external LLM API key.
+          #
+          #   @return [String, nil]
+          optional :llm_api_key_ref, String
+
+          # @!attribute model
+          #   Model identifier to use with the external LLM endpoint.
+          #
+          #   @return [String, nil]
+          optional :model, String
+
+          # @!attribute token_retrieval_url
+          #   URL used to retrieve an access token when certificate authentication is enabled.
+          #
+          #   @return [String, nil]
+          optional :token_retrieval_url, String
+
+          # @!method initialize(authentication_method: nil, base_url: nil, certificate_ref: nil, forward_metadata: nil, llm_api_key_ref: nil, model: nil, token_retrieval_url: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Telnyx::Models::CallAssistantRequest::FallbackConfig::ExternalLlm} for more
+          #   details.
+          #
+          #   External LLM fallback configuration.
+          #
+          #   @param authentication_method [Symbol, Telnyx::Models::CallAssistantRequest::FallbackConfig::ExternalLlm::AuthenticationMethod] Authentication method used when connecting to the external LLM endpoint.
+          #
+          #   @param base_url [String] Base URL for the external LLM endpoint.
+          #
+          #   @param certificate_ref [String] Integration secret identifier for the client certificate used with certificate a
+          #
+          #   @param forward_metadata [Boolean] When enabled, Telnyx forwards the assistant's dynamic variables to the external
+          #
+          #   @param llm_api_key_ref [String] Integration secret identifier for the external LLM API key.
+          #
+          #   @param model [String] Model identifier to use with the external LLM endpoint.
+          #
+          #   @param token_retrieval_url [String] URL used to retrieve an access token when certificate authentication is enabled.
+
+          # Authentication method used when connecting to the external LLM endpoint.
+          #
+          # @see Telnyx::Models::CallAssistantRequest::FallbackConfig::ExternalLlm#authentication_method
+          module AuthenticationMethod
+            extend Telnyx::Internal::Type::Enum
+
+            TOKEN = :token
+            CERTIFICATE = :certificate
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+      end
+
       module Tool
         extend Telnyx::Internal::Type::Union
 

data/lib/telnyx/resources/ai/assistants/versions.rb

@@ -43,7 +43,7 @@ module Telnyx
           # Updates the configuration of a specific assistant version. Can not update main
           # version
           #
-          # @overload update(version_id, assistant_id:, description: nil, dynamic_variables: nil, dynamic_variables_webhook_url: nil, enabled_features: nil, greeting: nil, insight_settings: nil, instructions: nil, llm_api_key_ref: nil, messaging_settings: nil, model: nil, name: nil, observability_settings: nil, post_conversation_settings: nil, privacy_settings: nil, telephony_settings: nil, tool_ids: nil, tools: nil, transcription: nil, voice_settings: nil, widget_settings: nil, request_options: {})
+          # @overload update(version_id, assistant_id:, description: nil, dynamic_variables: nil, dynamic_variables_webhook_url: nil, enabled_features: nil, external_llm: nil, fallback_config: nil, greeting: nil, insight_settings: nil, instructions: nil, llm_api_key_ref: nil, messaging_settings: nil, model: nil, name: nil, observability_settings: nil, post_conversation_settings: nil, privacy_settings: nil, telephony_settings: nil, tool_ids: nil, tools: nil, transcription: nil, voice_settings: nil, widget_settings: nil, request_options: {})
           #
           # @param version_id [String] Path param
           #
@@ -57,6 +57,10 @@ module Telnyx
           #
           # @param enabled_features [Array<Symbol, Telnyx::Models::AI::EnabledFeatures>] Body param
           #
+          # @param external_llm [Telnyx::Models::AI::Assistants::UpdateAssistant::ExternalLlm] Body param
+          #
+          # @param fallback_config [Telnyx::Models::AI::Assistants::UpdateAssistant::FallbackConfig] Body param
+          #
           # @param greeting [String] Body param: Text that the assistant will use to start the conversation. This may
           #
           # @param insight_settings [Telnyx::Models::AI::InsightSettings] Body param

data/lib/telnyx/resources/ai/assistants.rb

@@ -34,7 +34,7 @@ module Telnyx
         #
         # Create a new AI Assistant.
         #
-        # @overload create(instructions:, model:, name:, description: nil, dynamic_variables: nil, dynamic_variables_webhook_url: nil, enabled_features: nil, greeting: nil, insight_settings: nil, llm_api_key_ref: nil, messaging_settings: nil, observability_settings: nil, post_conversation_settings: nil, privacy_settings: nil, telephony_settings: nil, tool_ids: nil, tools: nil, transcription: nil, voice_settings: nil, widget_settings: nil, request_options: {})
+        # @overload create(instructions:, model:, name:, description: nil, dynamic_variables: nil, dynamic_variables_webhook_url: nil, enabled_features: nil, external_llm: nil, fallback_config: nil, greeting: nil, insight_settings: nil, llm_api_key_ref: nil, messaging_settings: nil, observability_settings: nil, post_conversation_settings: nil, privacy_settings: nil, telephony_settings: nil, tool_ids: nil, tools: nil, transcription: nil, voice_settings: nil, widget_settings: nil, request_options: {})
         #
         # @param instructions [String] System instructions for the assistant. These may be templated with [dynamic vari
         #
@@ -50,6 +50,10 @@ module Telnyx
         #
         # @param enabled_features [Array<Symbol, Telnyx::Models::AI::EnabledFeatures>]
         #
+        # @param external_llm [Telnyx::Models::AI::AssistantCreateParams::ExternalLlm]
+        #
+        # @param fallback_config [Telnyx::Models::AI::AssistantCreateParams::FallbackConfig]
+        #
         # @param greeting [String] Text that the assistant will use to start the conversation. This may be template
         #
         # @param insight_settings [Telnyx::Models::AI::InsightSettings]
@@ -123,7 +127,7 @@ module Telnyx
         #
         # Update an AI Assistant's attributes.
         #
-        # @overload update(assistant_id, description: nil, dynamic_variables: nil, dynamic_variables_webhook_url: nil, enabled_features: nil, greeting: nil, insight_settings: nil, instructions: nil, llm_api_key_ref: nil, messaging_settings: nil, model: nil, name: nil, observability_settings: nil, post_conversation_settings: nil, privacy_settings: nil, promote_to_main: nil, telephony_settings: nil, tool_ids: nil, tools: nil, transcription: nil, voice_settings: nil, widget_settings: nil, request_options: {})
+        # @overload update(assistant_id, description: nil, dynamic_variables: nil, dynamic_variables_webhook_url: nil, enabled_features: nil, external_llm: nil, fallback_config: nil, greeting: nil, insight_settings: nil, instructions: nil, llm_api_key_ref: nil, messaging_settings: nil, model: nil, name: nil, observability_settings: nil, post_conversation_settings: nil, privacy_settings: nil, promote_to_main: nil, telephony_settings: nil, tool_ids: nil, tools: nil, transcription: nil, voice_settings: nil, widget_settings: nil, request_options: {})
         #
         # @param assistant_id [String]
         #
@@ -135,6 +139,10 @@ module Telnyx
         #
         # @param enabled_features [Array<Symbol, Telnyx::Models::AI::EnabledFeatures>]
         #
+        # @param external_llm [Telnyx::Models::AI::AssistantUpdateParams::ExternalLlm]
+        #
+        # @param fallback_config [Telnyx::Models::AI::AssistantUpdateParams::FallbackConfig]
+        #
         # @param greeting [String] Text that the assistant will use to start the conversation. This may be template
         #
         # @param insight_settings [Telnyx::Models::AI::InsightSettings]

data/lib/telnyx/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Telnyx
-  VERSION = "5.87.0"
+  VERSION = "5.89.0"
 end