telnyx 5.87.0 → 5.89.0

data/rbi/telnyx/models/call_assistant_request.rbi

@@ -42,17 +42,25 @@ module Telnyx
       attr_writer :dynamic_variables
 
       # External LLM configuration for bringing your own LLM endpoint.
-      sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+      sig { returns(T.nilable(Telnyx::CallAssistantRequest::ExternalLlm)) }
       attr_reader :external_llm
 
-      sig { params(external_llm: T::Hash[Symbol, T.anything]).void }
+      sig do
+        params(
+          external_llm: Telnyx::CallAssistantRequest::ExternalLlm::OrHash
+        ).void
+      end
       attr_writer :external_llm
 
       # Fallback LLM configuration used when the primary LLM provider is unavailable.
-      sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+      sig { returns(T.nilable(Telnyx::CallAssistantRequest::FallbackConfig)) }
       attr_reader :fallback_config
 
-      sig { params(fallback_config: T::Hash[Symbol, T.anything]).void }
+      sig do
+        params(
+          fallback_config: Telnyx::CallAssistantRequest::FallbackConfig::OrHash
+        ).void
+      end
       attr_writer :fallback_config
 
       # Initial greeting text spoken when the assistant starts. Can be plain text for
@@ -172,8 +180,8 @@ module Telnyx
               Symbol,
               Telnyx::CallAssistantRequest::DynamicVariable::Variants
             ],
-          external_llm: T::Hash[Symbol, T.anything],
-          fallback_config: T::Hash[Symbol, T.anything],
+          external_llm: Telnyx::CallAssistantRequest::ExternalLlm::OrHash,
+          fallback_config: Telnyx::CallAssistantRequest::FallbackConfig::OrHash,
           greeting: String,
           instructions: String,
           llm_api_key_ref: String,
@@ -253,8 +261,8 @@ module Telnyx
                 Symbol,
                 Telnyx::CallAssistantRequest::DynamicVariable::Variants
               ],
-            external_llm: T::Hash[Symbol, T.anything],
-            fallback_config: T::Hash[Symbol, T.anything],
+            external_llm: Telnyx::CallAssistantRequest::ExternalLlm,
+            fallback_config: Telnyx::CallAssistantRequest::FallbackConfig,
             greeting: String,
             instructions: String,
             llm_api_key_ref: String,
@@ -294,6 +302,406 @@ module Telnyx
         end
       end
 
+      class ExternalLlm < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::CallAssistantRequest::ExternalLlm,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        # Authentication method used when connecting to the external LLM endpoint.
+        sig do
+          returns(
+            T.nilable(
+              Telnyx::CallAssistantRequest::ExternalLlm::AuthenticationMethod::OrSymbol
+            )
+          )
+        end
+        attr_reader :authentication_method
+
+        sig do
+          params(
+            authentication_method:
+              Telnyx::CallAssistantRequest::ExternalLlm::AuthenticationMethod::OrSymbol
+          ).void
+        end
+        attr_writer :authentication_method
+
+        # Base URL for the external LLM endpoint.
+        sig { returns(T.nilable(String)) }
+        attr_reader :base_url
+
+        sig { params(base_url: String).void }
+        attr_writer :base_url
+
+        # Integration secret identifier for the client certificate used with certificate
+        # authentication.
+        sig { returns(T.nilable(String)) }
+        attr_reader :certificate_ref
+
+        sig { params(certificate_ref: String).void }
+        attr_writer :certificate_ref
+
+        # 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"}}`.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :forward_metadata
+
+        sig { params(forward_metadata: T::Boolean).void }
+        attr_writer :forward_metadata
+
+        # Integration secret identifier for the external LLM API key.
+        sig { returns(T.nilable(String)) }
+        attr_reader :llm_api_key_ref
+
+        sig { params(llm_api_key_ref: String).void }
+        attr_writer :llm_api_key_ref
+
+        # Model identifier to use with the external LLM endpoint.
+        sig { returns(T.nilable(String)) }
+        attr_reader :model
+
+        sig { params(model: String).void }
+        attr_writer :model
+
+        # URL used to retrieve an access token when certificate authentication is enabled.
+        sig { returns(T.nilable(String)) }
+        attr_reader :token_retrieval_url
+
+        sig { params(token_retrieval_url: String).void }
+        attr_writer :token_retrieval_url
+
+        # External LLM configuration for bringing your own LLM endpoint.
+        sig do
+          params(
+            authentication_method:
+              Telnyx::CallAssistantRequest::ExternalLlm::AuthenticationMethod::OrSymbol,
+            base_url: String,
+            certificate_ref: String,
+            forward_metadata: T::Boolean,
+            llm_api_key_ref: String,
+            model: String,
+            token_retrieval_url: String
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Authentication method used when connecting to the external LLM endpoint.
+          authentication_method: nil,
+          # Base URL for the external LLM endpoint.
+          base_url: nil,
+          # Integration secret identifier for the client certificate used with certificate
+          # authentication.
+          certificate_ref: nil,
+          # 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"}}`.
+          forward_metadata: nil,
+          # Integration secret identifier for the external LLM API key.
+          llm_api_key_ref: nil,
+          # Model identifier to use with the external LLM endpoint.
+          model: nil,
+          # URL used to retrieve an access token when certificate authentication is enabled.
+          token_retrieval_url: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              authentication_method:
+                Telnyx::CallAssistantRequest::ExternalLlm::AuthenticationMethod::OrSymbol,
+              base_url: String,
+              certificate_ref: String,
+              forward_metadata: T::Boolean,
+              llm_api_key_ref: String,
+              model: String,
+              token_retrieval_url: String
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # Authentication method used when connecting to the external LLM endpoint.
+        module AuthenticationMethod
+          extend Telnyx::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                Telnyx::CallAssistantRequest::ExternalLlm::AuthenticationMethod
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          TOKEN =
+            T.let(
+              :token,
+              Telnyx::CallAssistantRequest::ExternalLlm::AuthenticationMethod::TaggedSymbol
+            )
+          CERTIFICATE =
+            T.let(
+              :certificate,
+              Telnyx::CallAssistantRequest::ExternalLlm::AuthenticationMethod::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Telnyx::CallAssistantRequest::ExternalLlm::AuthenticationMethod::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+
+      class FallbackConfig < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::CallAssistantRequest::FallbackConfig,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        # External LLM fallback configuration.
+        sig do
+          returns(
+            T.nilable(Telnyx::CallAssistantRequest::FallbackConfig::ExternalLlm)
+          )
+        end
+        attr_reader :external_llm
+
+        sig do
+          params(
+            external_llm:
+              Telnyx::CallAssistantRequest::FallbackConfig::ExternalLlm::OrHash
+          ).void
+        end
+        attr_writer :external_llm
+
+        # Integration secret identifier for the fallback model API key.
+        sig { returns(T.nilable(String)) }
+        attr_reader :llm_api_key_ref
+
+        sig { params(llm_api_key_ref: String).void }
+        attr_writer :llm_api_key_ref
+
+        # Fallback Telnyx-hosted model to use when the primary LLM provider is
+        # unavailable.
+        sig { returns(T.nilable(String)) }
+        attr_reader :model
+
+        sig { params(model: String).void }
+        attr_writer :model
+
+        # Fallback LLM configuration used when the primary LLM provider is unavailable.
+        sig do
+          params(
+            external_llm:
+              Telnyx::CallAssistantRequest::FallbackConfig::ExternalLlm::OrHash,
+            llm_api_key_ref: String,
+            model: String
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # External LLM fallback configuration.
+          external_llm: nil,
+          # Integration secret identifier for the fallback model API key.
+          llm_api_key_ref: nil,
+          # Fallback Telnyx-hosted model to use when the primary LLM provider is
+          # unavailable.
+          model: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              external_llm:
+                Telnyx::CallAssistantRequest::FallbackConfig::ExternalLlm,
+              llm_api_key_ref: String,
+              model: String
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class ExternalLlm < Telnyx::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Telnyx::CallAssistantRequest::FallbackConfig::ExternalLlm,
+                Telnyx::Internal::AnyHash
+              )
+            end
+
+          # Authentication method used when connecting to the external LLM endpoint.
+          sig do
+            returns(
+              T.nilable(
+                Telnyx::CallAssistantRequest::FallbackConfig::ExternalLlm::AuthenticationMethod::OrSymbol
+              )
+            )
+          end
+          attr_reader :authentication_method
+
+          sig do
+            params(
+              authentication_method:
+                Telnyx::CallAssistantRequest::FallbackConfig::ExternalLlm::AuthenticationMethod::OrSymbol
+            ).void
+          end
+          attr_writer :authentication_method
+
+          # Base URL for the external LLM endpoint.
+          sig { returns(T.nilable(String)) }
+          attr_reader :base_url
+
+          sig { params(base_url: String).void }
+          attr_writer :base_url
+
+          # Integration secret identifier for the client certificate used with certificate
+          # authentication.
+          sig { returns(T.nilable(String)) }
+          attr_reader :certificate_ref
+
+          sig { params(certificate_ref: String).void }
+          attr_writer :certificate_ref
+
+          # 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"}}`.
+          sig { returns(T.nilable(T::Boolean)) }
+          attr_reader :forward_metadata
+
+          sig { params(forward_metadata: T::Boolean).void }
+          attr_writer :forward_metadata
+
+          # Integration secret identifier for the external LLM API key.
+          sig { returns(T.nilable(String)) }
+          attr_reader :llm_api_key_ref
+
+          sig { params(llm_api_key_ref: String).void }
+          attr_writer :llm_api_key_ref
+
+          # Model identifier to use with the external LLM endpoint.
+          sig { returns(T.nilable(String)) }
+          attr_reader :model
+
+          sig { params(model: String).void }
+          attr_writer :model
+
+          # URL used to retrieve an access token when certificate authentication is enabled.
+          sig { returns(T.nilable(String)) }
+          attr_reader :token_retrieval_url
+
+          sig { params(token_retrieval_url: String).void }
+          attr_writer :token_retrieval_url
+
+          # External LLM fallback configuration.
+          sig do
+            params(
+              authentication_method:
+                Telnyx::CallAssistantRequest::FallbackConfig::ExternalLlm::AuthenticationMethod::OrSymbol,
+              base_url: String,
+              certificate_ref: String,
+              forward_metadata: T::Boolean,
+              llm_api_key_ref: String,
+              model: String,
+              token_retrieval_url: String
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # Authentication method used when connecting to the external LLM endpoint.
+            authentication_method: nil,
+            # Base URL for the external LLM endpoint.
+            base_url: nil,
+            # Integration secret identifier for the client certificate used with certificate
+            # authentication.
+            certificate_ref: nil,
+            # 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"}}`.
+            forward_metadata: nil,
+            # Integration secret identifier for the external LLM API key.
+            llm_api_key_ref: nil,
+            # Model identifier to use with the external LLM endpoint.
+            model: nil,
+            # URL used to retrieve an access token when certificate authentication is enabled.
+            token_retrieval_url: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                authentication_method:
+                  Telnyx::CallAssistantRequest::FallbackConfig::ExternalLlm::AuthenticationMethod::OrSymbol,
+                base_url: String,
+                certificate_ref: String,
+                forward_metadata: T::Boolean,
+                llm_api_key_ref: String,
+                model: String,
+                token_retrieval_url: String
+              }
+            )
+          end
+          def to_hash
+          end
+
+          # Authentication method used when connecting to the external LLM endpoint.
+          module AuthenticationMethod
+            extend Telnyx::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  Telnyx::CallAssistantRequest::FallbackConfig::ExternalLlm::AuthenticationMethod
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            TOKEN =
+              T.let(
+                :token,
+                Telnyx::CallAssistantRequest::FallbackConfig::ExternalLlm::AuthenticationMethod::TaggedSymbol
+              )
+            CERTIFICATE =
+              T.let(
+                :certificate,
+                Telnyx::CallAssistantRequest::FallbackConfig::ExternalLlm::AuthenticationMethod::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Telnyx::CallAssistantRequest::FallbackConfig::ExternalLlm::AuthenticationMethod::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+        end
+      end
+
       module Tool
         extend Telnyx::Internal::Type::Union
 

data/rbi/telnyx/resources/ai/assistants/versions.rbi

@@ -36,6 +36,10 @@ module Telnyx
               dynamic_variables: T::Hash[Symbol, T.anything],
               dynamic_variables_webhook_url: String,
               enabled_features: T::Array[Telnyx::AI::EnabledFeatures::OrSymbol],
+              external_llm:
+                Telnyx::AI::Assistants::UpdateAssistant::ExternalLlm::OrHash,
+              fallback_config:
+                Telnyx::AI::Assistants::UpdateAssistant::FallbackConfig::OrHash,
               greeting: String,
               insight_settings: Telnyx::AI::InsightSettings::OrHash,
               instructions: String,
@@ -86,6 +90,10 @@ module Telnyx
             dynamic_variables_webhook_url: nil,
             # Body param
             enabled_features: nil,
+            # Body param
+            external_llm: nil,
+            # Body param
+            fallback_config: nil,
             # Body param: Text that the assistant will use to start the conversation. This may
             # be templated with
             # [dynamic variables](https://developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables).

data/rbi/telnyx/resources/ai/assistants.rbi

@@ -39,6 +39,10 @@ module Telnyx
             dynamic_variables: T::Hash[Symbol, T.anything],
             dynamic_variables_webhook_url: String,
             enabled_features: T::Array[Telnyx::AI::EnabledFeatures::OrSymbol],
+            external_llm:
+              Telnyx::AI::AssistantCreateParams::ExternalLlm::OrHash,
+            fallback_config:
+              Telnyx::AI::AssistantCreateParams::FallbackConfig::OrHash,
             greeting: String,
             insight_settings: Telnyx::AI::InsightSettings::OrHash,
             llm_api_key_ref: String,
@@ -88,6 +92,8 @@ module Telnyx
           # for more information.
           dynamic_variables_webhook_url: nil,
           enabled_features: nil,
+          external_llm: nil,
+          fallback_config: nil,
           # Text that the assistant will use to start the conversation. This may be
           # templated with
           # [dynamic variables](https://developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables).
@@ -154,6 +160,10 @@ module Telnyx
             dynamic_variables: T::Hash[Symbol, T.anything],
             dynamic_variables_webhook_url: String,
             enabled_features: T::Array[Telnyx::AI::EnabledFeatures::OrSymbol],
+            external_llm:
+              Telnyx::AI::AssistantUpdateParams::ExternalLlm::OrHash,
+            fallback_config:
+              Telnyx::AI::AssistantUpdateParams::FallbackConfig::OrHash,
             greeting: String,
             insight_settings: Telnyx::AI::InsightSettings::OrHash,
             instructions: String,
@@ -200,6 +210,8 @@ module Telnyx
           # for more information.
           dynamic_variables_webhook_url: nil,
           enabled_features: nil,
+          external_llm: nil,
+          fallback_config: nil,
           # Text that the assistant will use to start the conversation. This may be
           # templated with
           # [dynamic variables](https://developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables).