telnyx 5.90.0 → 5.91.0

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

@@ -62,13 +62,13 @@ module Telnyx
 
         # @!attribute external_llm
         #
-        #   @return [Telnyx::Models::AI::InferenceEmbedding::ExternalLlm, nil]
-        optional :external_llm, -> { Telnyx::AI::InferenceEmbedding::ExternalLlm }
+        #   @return [Telnyx::Models::AI::ExternalLlm, nil]
+        optional :external_llm, -> { Telnyx::AI::ExternalLlm }
 
         # @!attribute fallback_config
         #
-        #   @return [Telnyx::Models::AI::InferenceEmbedding::FallbackConfig, nil]
-        optional :fallback_config, -> { Telnyx::AI::InferenceEmbedding::FallbackConfig }
+        #   @return [Telnyx::Models::AI::FallbackConfig, nil]
+        optional :fallback_config, -> { Telnyx::AI::FallbackConfig }
 
         # @!attribute greeting
         #   Text that the assistant will use to start the conversation. This may be
@@ -119,8 +119,8 @@ module Telnyx
         #   Telephony-control tools (e.g. hangup, transfer) are unavailable
         #   post-conversation. Beta feature.
         #
-        #   @return [Telnyx::Models::AI::InferenceEmbedding::PostConversationSettings, nil]
-        optional :post_conversation_settings, -> { Telnyx::AI::InferenceEmbedding::PostConversationSettings }
+        #   @return [Telnyx::Models::AI::PostConversationSettings, nil]
+        optional :post_conversation_settings, -> { Telnyx::AI::PostConversationSettings }
 
         # @!attribute privacy_settings
         #
@@ -177,9 +177,9 @@ module Telnyx
         #
         #   @param enabled_features [Array<Symbol, Telnyx::Models::AI::EnabledFeatures>]
         #
-        #   @param external_llm [Telnyx::Models::AI::InferenceEmbedding::ExternalLlm]
+        #   @param external_llm [Telnyx::Models::AI::ExternalLlm]
         #
-        #   @param fallback_config [Telnyx::Models::AI::InferenceEmbedding::FallbackConfig]
+        #   @param fallback_config [Telnyx::Models::AI::FallbackConfig]
         #
         #   @param greeting [String] Text that the assistant will use to start the conversation. This may be template
         #
@@ -193,7 +193,7 @@ module Telnyx
         #
         #   @param observability_settings [Telnyx::Models::AI::Observability]
         #
-        #   @param post_conversation_settings [Telnyx::Models::AI::InferenceEmbedding::PostConversationSettings] Configuration for post-conversation processing. When enabled, the assistant rece
+        #   @param post_conversation_settings [Telnyx::Models::AI::PostConversationSettings] Configuration for post-conversation processing. When enabled, the assistant rece
         #
         #   @param privacy_settings [Telnyx::Models::AI::PrivacySettings]
         #
@@ -206,227 +206,6 @@ module Telnyx
         #   @param voice_settings [Telnyx::Models::AI::VoiceSettings]
         #
         #   @param widget_settings [Telnyx::Models::AI::WidgetSettings] Configuration settings for the assistant's web widget.
-
-        # @see Telnyx::Models::AI::InferenceEmbedding#external_llm
-        class ExternalLlm < Telnyx::Internal::Type::BaseModel
-          # @!attribute base_url
-          #   Base URL for the external LLM endpoint.
-          #
-          #   @return [String]
-          required :base_url, String
-
-          # @!attribute model
-          #   Model identifier to use with the external LLM endpoint.
-          #
-          #   @return [String]
-          required :model, String
-
-          # @!attribute authentication_method
-          #   Authentication method used when connecting to the external LLM endpoint.
-          #
-          #   @return [Symbol, Telnyx::Models::AI::InferenceEmbedding::ExternalLlm::AuthenticationMethod, nil]
-          optional :authentication_method,
-                   enum: -> { Telnyx::AI::InferenceEmbedding::ExternalLlm::AuthenticationMethod }
-
-          # @!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 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(base_url:, model:, authentication_method: nil, certificate_ref: nil, forward_metadata: nil, llm_api_key_ref: nil, token_retrieval_url: nil)
-          #   Some parameter documentations has been truncated, see
-          #   {Telnyx::Models::AI::InferenceEmbedding::ExternalLlm} for more details.
-          #
-          #   @param base_url [String] Base URL for the external LLM endpoint.
-          #
-          #   @param model [String] Model identifier to use with the external LLM endpoint.
-          #
-          #   @param authentication_method [Symbol, Telnyx::Models::AI::InferenceEmbedding::ExternalLlm::AuthenticationMethod] Authentication method used when connecting to 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 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::AI::InferenceEmbedding::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::AI::InferenceEmbedding#fallback_config
-        class FallbackConfig < Telnyx::Internal::Type::BaseModel
-          # @!attribute external_llm
-          #
-          #   @return [Telnyx::Models::AI::InferenceEmbedding::FallbackConfig::ExternalLlm, nil]
-          optional :external_llm, -> { Telnyx::AI::InferenceEmbedding::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::AI::InferenceEmbedding::FallbackConfig} for more details.
-          #
-          #   @param external_llm [Telnyx::Models::AI::InferenceEmbedding::FallbackConfig::ExternalLlm]
-          #
-          #   @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::AI::InferenceEmbedding::FallbackConfig#external_llm
-          class ExternalLlm < Telnyx::Internal::Type::BaseModel
-            # @!attribute base_url
-            #   Base URL for the external LLM endpoint.
-            #
-            #   @return [String]
-            required :base_url, String
-
-            # @!attribute model
-            #   Model identifier to use with the external LLM endpoint.
-            #
-            #   @return [String]
-            required :model, String
-
-            # @!attribute authentication_method
-            #   Authentication method used when connecting to the external LLM endpoint.
-            #
-            #   @return [Symbol, Telnyx::Models::AI::InferenceEmbedding::FallbackConfig::ExternalLlm::AuthenticationMethod, nil]
-            optional :authentication_method,
-                     enum: -> { Telnyx::AI::InferenceEmbedding::FallbackConfig::ExternalLlm::AuthenticationMethod }
-
-            # @!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 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(base_url:, model:, authentication_method: nil, certificate_ref: nil, forward_metadata: nil, llm_api_key_ref: nil, token_retrieval_url: nil)
-            #   Some parameter documentations has been truncated, see
-            #   {Telnyx::Models::AI::InferenceEmbedding::FallbackConfig::ExternalLlm} for more
-            #   details.
-            #
-            #   @param base_url [String] Base URL for the external LLM endpoint.
-            #
-            #   @param model [String] Model identifier to use with the external LLM endpoint.
-            #
-            #   @param authentication_method [Symbol, Telnyx::Models::AI::InferenceEmbedding::FallbackConfig::ExternalLlm::AuthenticationMethod] Authentication method used when connecting to 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 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::AI::InferenceEmbedding::FallbackConfig::ExternalLlm#authentication_method
-            module AuthenticationMethod
-              extend Telnyx::Internal::Type::Enum
-
-              TOKEN = :token
-              CERTIFICATE = :certificate
-
-              # @!method self.values
-              #   @return [Array<Symbol>]
-            end
-          end
-        end
-
-        # @see Telnyx::Models::AI::InferenceEmbedding#post_conversation_settings
-        class PostConversationSettings < Telnyx::Internal::Type::BaseModel
-          # @!attribute enabled
-          #   Whether post-conversation processing is enabled. When true, the assistant will
-          #   be invoked after the conversation ends to perform any final tool calls. Defaults
-          #   to false.
-          #
-          #   @return [Boolean, nil]
-          optional :enabled, Telnyx::Internal::Type::Boolean
-
-          # @!method initialize(enabled: nil)
-          #   Some parameter documentations has been truncated, see
-          #   {Telnyx::Models::AI::InferenceEmbedding::PostConversationSettings} for more
-          #   details.
-          #
-          #   Configuration for post-conversation processing. When enabled, the assistant
-          #   receives one additional LLM turn after the conversation ends, allowing it to
-          #   execute tool calls such as logging to a CRM or sending a summary. The assistant
-          #   can execute multiple parallel or sequential tools during this phase.
-          #   Telephony-control tools (e.g. hangup, transfer) are unavailable
-          #   post-conversation. Beta feature.
-          #
-          #   @param enabled [Boolean] Whether post-conversation processing is enabled. When true, the assistant will b
-        end
       end
     end
   end

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

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AI
+      class PostConversationSettings < Telnyx::Internal::Type::BaseModel
+        # @!attribute enabled
+        #   Whether post-conversation processing is enabled. When true, the assistant will
+        #   be invoked after the conversation ends to perform any final tool calls. Defaults
+        #   to false.
+        #
+        #   @return [Boolean, nil]
+        optional :enabled, Telnyx::Internal::Type::Boolean
+
+        # @!method initialize(enabled: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Telnyx::Models::AI::PostConversationSettings} for more details.
+        #
+        #   Configuration for post-conversation processing. When enabled, the assistant
+        #   receives one additional LLM turn after the conversation ends, allowing it to
+        #   execute tool calls such as logging to a CRM or sending a summary. The assistant
+        #   can execute multiple parallel or sequential tools during this phase.
+        #   Telephony-control tools (e.g. hangup, transfer) are unavailable
+        #   post-conversation. Beta feature.
+        #
+        #   @param enabled [Boolean] Whether post-conversation processing is enabled. When true, the assistant will b
+      end
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AI
+      class PostConversationSettingsReq < Telnyx::Internal::Type::BaseModel
+        # @!attribute enabled
+        #   Whether post-conversation processing is enabled. When true, the assistant will
+        #   be invoked after the conversation ends to perform any final tool calls. Defaults
+        #   to false.
+        #
+        #   @return [Boolean, nil]
+        optional :enabled, Telnyx::Internal::Type::Boolean
+
+        # @!method initialize(enabled: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Telnyx::Models::AI::PostConversationSettingsReq} for more details.
+        #
+        #   Configuration for post-conversation processing. When enabled, the assistant
+        #   receives one additional LLM turn after the conversation ends, allowing it to
+        #   execute tool calls such as logging to a CRM or sending a summary. The assistant
+        #   can execute multiple parallel or sequential tools during this phase.
+        #   Telephony-control tools (e.g. hangup, transfer) are unavailable
+        #   post-conversation. Beta feature.
+        #
+        #   @param enabled [Boolean] Whether post-conversation processing is enabled. When true, the assistant will b
+      end
+    end
+  end
+end

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

@@ -57,9 +57,9 @@ 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 external_llm [Telnyx::Models::AI::ExternalLlmReq] Body param
           #
-          # @param fallback_config [Telnyx::Models::AI::Assistants::UpdateAssistant::FallbackConfig] Body param
+          # @param fallback_config [Telnyx::Models::AI::FallbackConfigReq] Body param
           #
           # @param greeting [String] Body param: Text that the assistant will use to start the conversation. This may
           #
@@ -77,7 +77,7 @@ module Telnyx
           #
           # @param observability_settings [Telnyx::Models::AI::ObservabilityReq] Body param
           #
-          # @param post_conversation_settings [Telnyx::Models::AI::Assistants::UpdateAssistant::PostConversationSettings] Body param: Configuration for post-conversation processing. When enabled, the as
+          # @param post_conversation_settings [Telnyx::Models::AI::PostConversationSettingsReq] Body param: Configuration for post-conversation processing. When enabled, the as
           #
           # @param privacy_settings [Telnyx::Models::AI::PrivacySettings] Body param
           #

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

@@ -50,9 +50,9 @@ module Telnyx
         #
         # @param enabled_features [Array<Symbol, Telnyx::Models::AI::EnabledFeatures>]
         #
-        # @param external_llm [Telnyx::Models::AI::AssistantCreateParams::ExternalLlm]
+        # @param external_llm [Telnyx::Models::AI::ExternalLlmReq]
         #
-        # @param fallback_config [Telnyx::Models::AI::AssistantCreateParams::FallbackConfig]
+        # @param fallback_config [Telnyx::Models::AI::FallbackConfigReq]
         #
         # @param greeting [String] Text that the assistant will use to start the conversation. This may be template
         #
@@ -64,7 +64,7 @@ module Telnyx
         #
         # @param observability_settings [Telnyx::Models::AI::ObservabilityReq]
         #
-        # @param post_conversation_settings [Telnyx::Models::AI::AssistantCreateParams::PostConversationSettings] Configuration for post-conversation processing. When enabled, the assistant rece
+        # @param post_conversation_settings [Telnyx::Models::AI::PostConversationSettingsReq] Configuration for post-conversation processing. When enabled, the assistant rece
         #
         # @param privacy_settings [Telnyx::Models::AI::PrivacySettings]
         #
@@ -139,9 +139,9 @@ module Telnyx
         #
         # @param enabled_features [Array<Symbol, Telnyx::Models::AI::EnabledFeatures>]
         #
-        # @param external_llm [Telnyx::Models::AI::AssistantUpdateParams::ExternalLlm]
+        # @param external_llm [Telnyx::Models::AI::ExternalLlmReq]
         #
-        # @param fallback_config [Telnyx::Models::AI::AssistantUpdateParams::FallbackConfig]
+        # @param fallback_config [Telnyx::Models::AI::FallbackConfigReq]
         #
         # @param greeting [String] Text that the assistant will use to start the conversation. This may be template
         #
@@ -159,7 +159,7 @@ module Telnyx
         #
         # @param observability_settings [Telnyx::Models::AI::ObservabilityReq]
         #
-        # @param post_conversation_settings [Telnyx::Models::AI::AssistantUpdateParams::PostConversationSettings] Configuration for post-conversation processing. When enabled, the assistant rece
+        # @param post_conversation_settings [Telnyx::Models::AI::PostConversationSettingsReq] Configuration for post-conversation processing. When enabled, the assistant rece
         #
         # @param privacy_settings [Telnyx::Models::AI::PrivacySettings]
         #

data/lib/telnyx/version.rb

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

data/lib/telnyx.rb

@@ -256,6 +256,10 @@ require_relative "telnyx/models/ai/embedding_similarity_search_params"
 require_relative "telnyx/models/ai/embedding_similarity_search_response"
 require_relative "telnyx/models/ai/embedding_url_params"
 require_relative "telnyx/models/ai/enabled_features"
+require_relative "telnyx/models/ai/external_llm"
+require_relative "telnyx/models/ai/external_llm_req"
+require_relative "telnyx/models/ai/fallback_config"
+require_relative "telnyx/models/ai/fallback_config_req"
 require_relative "telnyx/models/ai/fine_tuning/fine_tuning_job"
 require_relative "telnyx/models/ai/fine_tuning/job_cancel_params"
 require_relative "telnyx/models/ai/fine_tuning/job_create_params"
@@ -371,6 +375,8 @@ require_relative "telnyx/models/ai/openai/embedding_create_embeddings_params"
 require_relative "telnyx/models/ai/openai/embedding_create_embeddings_response"
 require_relative "telnyx/models/ai/openai/embedding_list_embedding_models_params"
 require_relative "telnyx/models/ai/openai/embedding_list_embedding_models_response"
+require_relative "telnyx/models/ai/post_conversation_settings"
+require_relative "telnyx/models/ai/post_conversation_settings_req"
 require_relative "telnyx/models/ai/privacy_settings"
 require_relative "telnyx/models/ai/recursive_cluster"
 require_relative "telnyx/models/ai/retrieval_tool"