telnyx 5.91.0 → 5.92.0

data/rbi/telnyx/models/ai/assistants/update_assistant.rbi

@@ -50,17 +50,33 @@ module Telnyx
           end
           attr_writer :enabled_features
 
-          sig { returns(T.nilable(Telnyx::AI::ExternalLlmReq)) }
+          sig do
+            returns(
+              T.nilable(Telnyx::AI::Assistants::UpdateAssistant::ExternalLlm)
+            )
+          end
           attr_reader :external_llm
 
-          sig { params(external_llm: Telnyx::AI::ExternalLlmReq::OrHash).void }
+          sig do
+            params(
+              external_llm:
+                Telnyx::AI::Assistants::UpdateAssistant::ExternalLlm::OrHash
+            ).void
+          end
           attr_writer :external_llm
 
-          sig { returns(T.nilable(Telnyx::AI::FallbackConfigReq)) }
+          sig do
+            returns(
+              T.nilable(Telnyx::AI::Assistants::UpdateAssistant::FallbackConfig)
+            )
+          end
           attr_reader :fallback_config
 
           sig do
-            params(fallback_config: Telnyx::AI::FallbackConfigReq::OrHash).void
+            params(
+              fallback_config:
+                Telnyx::AI::Assistants::UpdateAssistant::FallbackConfig::OrHash
+            ).void
           end
           attr_writer :fallback_config
 
@@ -144,13 +160,19 @@ module Telnyx
           # can execute multiple parallel or sequential tools during this phase.
           # Telephony-control tools (e.g. hangup, transfer) are unavailable
           # post-conversation. Beta feature.
-          sig { returns(T.nilable(Telnyx::AI::PostConversationSettingsReq)) }
+          sig do
+            returns(
+              T.nilable(
+                Telnyx::AI::Assistants::UpdateAssistant::PostConversationSettings
+              )
+            )
+          end
           attr_reader :post_conversation_settings
 
           sig do
             params(
               post_conversation_settings:
-                Telnyx::AI::PostConversationSettingsReq::OrHash
+                Telnyx::AI::Assistants::UpdateAssistant::PostConversationSettings::OrHash
             ).void
           end
           attr_writer :post_conversation_settings
@@ -255,8 +277,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::ExternalLlmReq::OrHash,
-              fallback_config: Telnyx::AI::FallbackConfigReq::OrHash,
+              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,
@@ -266,7 +290,7 @@ module Telnyx
               name: String,
               observability_settings: Telnyx::AI::ObservabilityReq::OrHash,
               post_conversation_settings:
-                Telnyx::AI::PostConversationSettingsReq::OrHash,
+                Telnyx::AI::Assistants::UpdateAssistant::PostConversationSettings::OrHash,
               privacy_settings: Telnyx::AI::PrivacySettings::OrHash,
               telephony_settings: Telnyx::AI::TelephonySettings::OrHash,
               tool_ids: T::Array[String],
@@ -354,8 +378,10 @@ module Telnyx
                 dynamic_variables_webhook_url: String,
                 enabled_features:
                   T::Array[Telnyx::AI::EnabledFeatures::OrSymbol],
-                external_llm: Telnyx::AI::ExternalLlmReq,
-                fallback_config: Telnyx::AI::FallbackConfigReq,
+                external_llm:
+                  Telnyx::AI::Assistants::UpdateAssistant::ExternalLlm,
+                fallback_config:
+                  Telnyx::AI::Assistants::UpdateAssistant::FallbackConfig,
                 greeting: String,
                 insight_settings: Telnyx::AI::InsightSettings,
                 instructions: String,
@@ -365,7 +391,7 @@ module Telnyx
                 name: String,
                 observability_settings: Telnyx::AI::ObservabilityReq,
                 post_conversation_settings:
-                  Telnyx::AI::PostConversationSettingsReq,
+                  Telnyx::AI::Assistants::UpdateAssistant::PostConversationSettings,
                 privacy_settings: Telnyx::AI::PrivacySettings,
                 telephony_settings: Telnyx::AI::TelephonySettings,
                 tool_ids: T::Array[String],
@@ -392,6 +418,429 @@ module Telnyx
           end
           def to_hash
           end
+
+          class ExternalLlm < Telnyx::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Telnyx::AI::Assistants::UpdateAssistant::ExternalLlm,
+                  Telnyx::Internal::AnyHash
+                )
+              end
+
+            # Base URL for the external LLM endpoint.
+            sig { returns(String) }
+            attr_accessor :base_url
+
+            # Model identifier to use with the external LLM endpoint.
+            sig { returns(String) }
+            attr_accessor :model
+
+            # Authentication method used when connecting to the external LLM endpoint.
+            sig do
+              returns(
+                T.nilable(
+                  Telnyx::AI::Assistants::UpdateAssistant::ExternalLlm::AuthenticationMethod::OrSymbol
+                )
+              )
+            end
+            attr_reader :authentication_method
+
+            sig do
+              params(
+                authentication_method:
+                  Telnyx::AI::Assistants::UpdateAssistant::ExternalLlm::AuthenticationMethod::OrSymbol
+              ).void
+            end
+            attr_writer :authentication_method
+
+            # 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
+
+            # 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
+
+            sig do
+              params(
+                base_url: String,
+                model: String,
+                authentication_method:
+                  Telnyx::AI::Assistants::UpdateAssistant::ExternalLlm::AuthenticationMethod::OrSymbol,
+                certificate_ref: String,
+                forward_metadata: T::Boolean,
+                llm_api_key_ref: String,
+                token_retrieval_url: String
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              # Base URL for the external LLM endpoint.
+              base_url:,
+              # Model identifier to use with the external LLM endpoint.
+              model:,
+              # Authentication method used when connecting to the external LLM endpoint.
+              authentication_method: 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,
+              # URL used to retrieve an access token when certificate authentication is enabled.
+              token_retrieval_url: nil
+            )
+            end
+
+            sig do
+              override.returns(
+                {
+                  base_url: String,
+                  model: String,
+                  authentication_method:
+                    Telnyx::AI::Assistants::UpdateAssistant::ExternalLlm::AuthenticationMethod::OrSymbol,
+                  certificate_ref: String,
+                  forward_metadata: T::Boolean,
+                  llm_api_key_ref: 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::AI::Assistants::UpdateAssistant::ExternalLlm::AuthenticationMethod
+                  )
+                end
+              OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+              TOKEN =
+                T.let(
+                  :token,
+                  Telnyx::AI::Assistants::UpdateAssistant::ExternalLlm::AuthenticationMethod::TaggedSymbol
+                )
+              CERTIFICATE =
+                T.let(
+                  :certificate,
+                  Telnyx::AI::Assistants::UpdateAssistant::ExternalLlm::AuthenticationMethod::TaggedSymbol
+                )
+
+              sig do
+                override.returns(
+                  T::Array[
+                    Telnyx::AI::Assistants::UpdateAssistant::ExternalLlm::AuthenticationMethod::TaggedSymbol
+                  ]
+                )
+              end
+              def self.values
+              end
+            end
+          end
+
+          class FallbackConfig < Telnyx::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Telnyx::AI::Assistants::UpdateAssistant::FallbackConfig,
+                  Telnyx::Internal::AnyHash
+                )
+              end
+
+            sig do
+              returns(
+                T.nilable(
+                  Telnyx::AI::Assistants::UpdateAssistant::FallbackConfig::ExternalLlm
+                )
+              )
+            end
+            attr_reader :external_llm
+
+            sig do
+              params(
+                external_llm:
+                  Telnyx::AI::Assistants::UpdateAssistant::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
+
+            sig do
+              params(
+                external_llm:
+                  Telnyx::AI::Assistants::UpdateAssistant::FallbackConfig::ExternalLlm::OrHash,
+                llm_api_key_ref: String,
+                model: String
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              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::AI::Assistants::UpdateAssistant::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::AI::Assistants::UpdateAssistant::FallbackConfig::ExternalLlm,
+                    Telnyx::Internal::AnyHash
+                  )
+                end
+
+              # Base URL for the external LLM endpoint.
+              sig { returns(String) }
+              attr_accessor :base_url
+
+              # Model identifier to use with the external LLM endpoint.
+              sig { returns(String) }
+              attr_accessor :model
+
+              # Authentication method used when connecting to the external LLM endpoint.
+              sig do
+                returns(
+                  T.nilable(
+                    Telnyx::AI::Assistants::UpdateAssistant::FallbackConfig::ExternalLlm::AuthenticationMethod::OrSymbol
+                  )
+                )
+              end
+              attr_reader :authentication_method
+
+              sig do
+                params(
+                  authentication_method:
+                    Telnyx::AI::Assistants::UpdateAssistant::FallbackConfig::ExternalLlm::AuthenticationMethod::OrSymbol
+                ).void
+              end
+              attr_writer :authentication_method
+
+              # 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
+
+              # 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
+
+              sig do
+                params(
+                  base_url: String,
+                  model: String,
+                  authentication_method:
+                    Telnyx::AI::Assistants::UpdateAssistant::FallbackConfig::ExternalLlm::AuthenticationMethod::OrSymbol,
+                  certificate_ref: String,
+                  forward_metadata: T::Boolean,
+                  llm_api_key_ref: String,
+                  token_retrieval_url: String
+                ).returns(T.attached_class)
+              end
+              def self.new(
+                # Base URL for the external LLM endpoint.
+                base_url:,
+                # Model identifier to use with the external LLM endpoint.
+                model:,
+                # Authentication method used when connecting to the external LLM endpoint.
+                authentication_method: 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,
+                # URL used to retrieve an access token when certificate authentication is enabled.
+                token_retrieval_url: nil
+              )
+              end
+
+              sig do
+                override.returns(
+                  {
+                    base_url: String,
+                    model: String,
+                    authentication_method:
+                      Telnyx::AI::Assistants::UpdateAssistant::FallbackConfig::ExternalLlm::AuthenticationMethod::OrSymbol,
+                    certificate_ref: String,
+                    forward_metadata: T::Boolean,
+                    llm_api_key_ref: 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::AI::Assistants::UpdateAssistant::FallbackConfig::ExternalLlm::AuthenticationMethod
+                    )
+                  end
+                OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+                TOKEN =
+                  T.let(
+                    :token,
+                    Telnyx::AI::Assistants::UpdateAssistant::FallbackConfig::ExternalLlm::AuthenticationMethod::TaggedSymbol
+                  )
+                CERTIFICATE =
+                  T.let(
+                    :certificate,
+                    Telnyx::AI::Assistants::UpdateAssistant::FallbackConfig::ExternalLlm::AuthenticationMethod::TaggedSymbol
+                  )
+
+                sig do
+                  override.returns(
+                    T::Array[
+                      Telnyx::AI::Assistants::UpdateAssistant::FallbackConfig::ExternalLlm::AuthenticationMethod::TaggedSymbol
+                    ]
+                  )
+                end
+                def self.values
+                end
+              end
+            end
+          end
+
+          class PostConversationSettings < Telnyx::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Telnyx::AI::Assistants::UpdateAssistant::PostConversationSettings,
+                  Telnyx::Internal::AnyHash
+                )
+              end
+
+            # 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.
+            sig { returns(T.nilable(T::Boolean)) }
+            attr_reader :enabled
+
+            sig { params(enabled: T::Boolean).void }
+            attr_writer :enabled
+
+            # 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.
+            sig { params(enabled: T::Boolean).returns(T.attached_class) }
+            def self.new(
+              # 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.
+              enabled: nil
+            )
+            end
+
+            sig { override.returns({ enabled: T::Boolean }) }
+            def to_hash
+            end
+          end
         end
       end
     end