telnyx 5.0.0 → 5.1.0

data/rbi/telnyx/models/ai/assistant.rbi

@@ -45,7 +45,7 @@ module Telnyx
                   Telnyx::AI::WebhookTool,
                   Telnyx::AI::HangupTool,
                   Telnyx::AI::TransferTool,
-                  Telnyx::AI::RetrievalTool
+                  Telnyx::AI::Assistant::Tool::Retrieval
                 )
               ]
             )
@@ -63,7 +63,7 @@ module Telnyx
                   Telnyx::AI::WebhookTool::OrHash,
                   Telnyx::AI::HangupTool::OrHash,
                   Telnyx::AI::TransferTool::OrHash,
-                  Telnyx::AI::RetrievalTool::OrHash
+                  Telnyx::AI::Assistant::Tool::Retrieval::OrHash
                 )
               ]
           ).void
@@ -84,7 +84,7 @@ module Telnyx
                   Telnyx::AI::WebhookTool::OrHash,
                   Telnyx::AI::HangupTool::OrHash,
                   Telnyx::AI::TransferTool::OrHash,
-                  Telnyx::AI::RetrievalTool::OrHash
+                  Telnyx::AI::Assistant::Tool::Retrieval::OrHash
                 )
               ]
           ).returns(T.attached_class)
@@ -119,7 +119,7 @@ module Telnyx
                     Telnyx::AI::WebhookTool,
                     Telnyx::AI::HangupTool,
                     Telnyx::AI::TransferTool,
-                    Telnyx::AI::RetrievalTool
+                    Telnyx::AI::Assistant::Tool::Retrieval
                   )
                 ]
             }
@@ -139,7 +139,7 @@ module Telnyx
                 Telnyx::AI::WebhookTool,
                 Telnyx::AI::HangupTool,
                 Telnyx::AI::TransferTool,
-                Telnyx::AI::RetrievalTool
+                Telnyx::AI::Assistant::Tool::Retrieval
               )
             end
 
@@ -371,6 +371,92 @@ module Telnyx
             end
           end
 
+          class Retrieval < Telnyx::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Telnyx::AI::Assistant::Tool::Retrieval,
+                  Telnyx::Internal::AnyHash
+                )
+              end
+
+            sig { returns(Telnyx::AI::Assistant::Tool::Retrieval::Retrieval) }
+            attr_reader :retrieval
+
+            sig do
+              params(
+                retrieval:
+                  Telnyx::AI::Assistant::Tool::Retrieval::Retrieval::OrHash
+              ).void
+            end
+            attr_writer :retrieval
+
+            sig { returns(Symbol) }
+            attr_accessor :type
+
+            sig do
+              params(
+                retrieval:
+                  Telnyx::AI::Assistant::Tool::Retrieval::Retrieval::OrHash,
+                type: Symbol
+              ).returns(T.attached_class)
+            end
+            def self.new(retrieval:, type: :retrieval)
+            end
+
+            sig do
+              override.returns(
+                {
+                  retrieval: Telnyx::AI::Assistant::Tool::Retrieval::Retrieval,
+                  type: Symbol
+                }
+              )
+            end
+            def to_hash
+            end
+
+            class Retrieval < Telnyx::Internal::Type::BaseModel
+              OrHash =
+                T.type_alias do
+                  T.any(
+                    Telnyx::AI::Assistant::Tool::Retrieval::Retrieval,
+                    Telnyx::Internal::AnyHash
+                  )
+                end
+
+              sig { returns(T::Array[String]) }
+              attr_accessor :bucket_ids
+
+              # The maximum number of results to retrieve as context for the language model.
+              sig { returns(T.nilable(Integer)) }
+              attr_reader :max_num_results
+
+              sig { params(max_num_results: Integer).void }
+              attr_writer :max_num_results
+
+              sig do
+                params(
+                  bucket_ids: T::Array[String],
+                  max_num_results: Integer
+                ).returns(T.attached_class)
+              end
+              def self.new(
+                bucket_ids:,
+                # The maximum number of results to retrieve as context for the language model.
+                max_num_results: nil
+              )
+              end
+
+              sig do
+                override.returns(
+                  { bucket_ids: T::Array[String], max_num_results: Integer }
+                )
+              end
+              def to_hash
+              end
+            end
+          end
+
           sig do
             override.returns(T::Array[Telnyx::AI::Assistant::Tool::Variants])
           end

data/rbi/telnyx/models/ai/assistant_create_params.rbi

@@ -18,7 +18,7 @@ module Telnyx
         attr_accessor :instructions
 
         # ID of the model to use. You can use the
-        # [Get models API](https://developers.telnyx.com/api/inference/inference-embedding/get-models-public-models-get)
+        # [Get models API](https://developers.telnyx.com/api-reference/chat/get-available-models)
         # to see all of your available models,
         sig { returns(String) }
         attr_accessor :model
@@ -63,7 +63,10 @@ module Telnyx
 
         # 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)
+        # [dynamic variables](https://developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables).
+        # Use an empty string to have the assistant wait for the user to speak first. Use
+        # the special value `<assistant-speaks-first-with-model-generated-message>` to
+        # have the assistant generate the greeting based on the system instructions.
         sig { returns(T.nilable(String)) }
         attr_reader :greeting
 
@@ -80,7 +83,7 @@ module Telnyx
 
         # This is only needed when using third-party inference providers. The `identifier`
         # for an integration secret
-        # [/v2/integration_secrets](https://developers.telnyx.com/api/secrets-manager/integration-secrets/create-integration-secret)
+        # [/v2/integration_secrets](https://developers.telnyx.com/api-reference/integration-secrets/create-a-secret)
         # that refers to your LLM provider's API key. Warning: Free plans are unlikely to
         # work with this integration.
         sig { returns(T.nilable(String)) }
@@ -120,11 +123,11 @@ module Telnyx
             T.nilable(
               T::Array[
                 T.any(
-                  Telnyx::AI::WebhookTool,
+                  Telnyx::AI::AssistantTool::Webhook,
                   Telnyx::AI::RetrievalTool,
                   Telnyx::AI::AssistantTool::Handoff,
                   Telnyx::AI::HangupTool,
-                  Telnyx::AI::TransferTool,
+                  Telnyx::AI::AssistantTool::Transfer,
                   Telnyx::AI::AssistantTool::Refer,
                   Telnyx::AI::AssistantTool::SendDtmf,
                   Telnyx::AI::AssistantTool::SendMessage
@@ -140,11 +143,11 @@ module Telnyx
             tools:
               T::Array[
                 T.any(
-                  Telnyx::AI::WebhookTool::OrHash,
+                  Telnyx::AI::AssistantTool::Webhook::OrHash,
                   Telnyx::AI::RetrievalTool::OrHash,
                   Telnyx::AI::AssistantTool::Handoff::OrHash,
                   Telnyx::AI::HangupTool::OrHash,
-                  Telnyx::AI::TransferTool::OrHash,
+                  Telnyx::AI::AssistantTool::Transfer::OrHash,
                   Telnyx::AI::AssistantTool::Refer::OrHash,
                   Telnyx::AI::AssistantTool::SendDtmf::OrHash,
                   Telnyx::AI::AssistantTool::SendMessage::OrHash
@@ -168,6 +171,20 @@ module Telnyx
         sig { params(voice_settings: Telnyx::AI::VoiceSettings::OrHash).void }
         attr_writer :voice_settings
 
+        # Configuration settings for the assistant's web widget.
+        sig do
+          returns(T.nilable(Telnyx::AI::AssistantCreateParams::WidgetSettings))
+        end
+        attr_reader :widget_settings
+
+        sig do
+          params(
+            widget_settings:
+              Telnyx::AI::AssistantCreateParams::WidgetSettings::OrHash
+          ).void
+        end
+        attr_writer :widget_settings
+
         sig do
           params(
             instructions: String,
@@ -186,11 +203,11 @@ module Telnyx
             tools:
               T::Array[
                 T.any(
-                  Telnyx::AI::WebhookTool::OrHash,
+                  Telnyx::AI::AssistantTool::Webhook::OrHash,
                   Telnyx::AI::RetrievalTool::OrHash,
                   Telnyx::AI::AssistantTool::Handoff::OrHash,
                   Telnyx::AI::HangupTool::OrHash,
-                  Telnyx::AI::TransferTool::OrHash,
+                  Telnyx::AI::AssistantTool::Transfer::OrHash,
                   Telnyx::AI::AssistantTool::Refer::OrHash,
                   Telnyx::AI::AssistantTool::SendDtmf::OrHash,
                   Telnyx::AI::AssistantTool::SendMessage::OrHash
@@ -198,6 +215,8 @@ module Telnyx
               ],
             transcription: Telnyx::AI::TranscriptionSettings::OrHash,
             voice_settings: Telnyx::AI::VoiceSettings::OrHash,
+            widget_settings:
+              Telnyx::AI::AssistantCreateParams::WidgetSettings::OrHash,
             request_options: Telnyx::RequestOptions::OrHash
           ).returns(T.attached_class)
         end
@@ -206,7 +225,7 @@ module Telnyx
           # [dynamic variables](https://developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables)
           instructions:,
           # ID of the model to use. You can use the
-          # [Get models API](https://developers.telnyx.com/api/inference/inference-embedding/get-models-public-models-get)
+          # [Get models API](https://developers.telnyx.com/api-reference/chat/get-available-models)
           # to see all of your available models,
           model:,
           name:,
@@ -221,12 +240,15 @@ module Telnyx
           enabled_features: 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)
+          # [dynamic variables](https://developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables).
+          # Use an empty string to have the assistant wait for the user to speak first. Use
+          # the special value `<assistant-speaks-first-with-model-generated-message>` to
+          # have the assistant generate the greeting based on the system instructions.
           greeting: nil,
           insight_settings: nil,
           # This is only needed when using third-party inference providers. The `identifier`
           # for an integration secret
-          # [/v2/integration_secrets](https://developers.telnyx.com/api/secrets-manager/integration-secrets/create-integration-secret)
+          # [/v2/integration_secrets](https://developers.telnyx.com/api-reference/integration-secrets/create-a-secret)
           # that refers to your LLM provider's API key. Warning: Free plans are unlikely to
           # work with this integration.
           llm_api_key_ref: nil,
@@ -238,6 +260,8 @@ module Telnyx
           tools: nil,
           transcription: nil,
           voice_settings: nil,
+          # Configuration settings for the assistant's web widget.
+          widget_settings: nil,
           request_options: {}
         )
         end
@@ -261,11 +285,11 @@ module Telnyx
               tools:
                 T::Array[
                   T.any(
-                    Telnyx::AI::WebhookTool,
+                    Telnyx::AI::AssistantTool::Webhook,
                     Telnyx::AI::RetrievalTool,
                     Telnyx::AI::AssistantTool::Handoff,
                     Telnyx::AI::HangupTool,
-                    Telnyx::AI::TransferTool,
+                    Telnyx::AI::AssistantTool::Transfer,
                     Telnyx::AI::AssistantTool::Refer,
                     Telnyx::AI::AssistantTool::SendDtmf,
                     Telnyx::AI::AssistantTool::SendMessage
@@ -273,12 +297,423 @@ module Telnyx
                 ],
               transcription: Telnyx::AI::TranscriptionSettings,
               voice_settings: Telnyx::AI::VoiceSettings,
+              widget_settings:
+                Telnyx::AI::AssistantCreateParams::WidgetSettings,
               request_options: Telnyx::RequestOptions
             }
           )
         end
         def to_hash
         end
+
+        class WidgetSettings < Telnyx::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Telnyx::AI::AssistantCreateParams::WidgetSettings,
+                Telnyx::Internal::AnyHash
+              )
+            end
+
+          # Text displayed while the agent is processing.
+          sig { returns(T.nilable(String)) }
+          attr_reader :agent_thinking_text
+
+          sig { params(agent_thinking_text: String).void }
+          attr_writer :agent_thinking_text
+
+          sig do
+            returns(
+              T.nilable(
+                Telnyx::AI::AssistantCreateParams::WidgetSettings::AudioVisualizerConfig
+              )
+            )
+          end
+          attr_reader :audio_visualizer_config
+
+          sig do
+            params(
+              audio_visualizer_config:
+                Telnyx::AI::AssistantCreateParams::WidgetSettings::AudioVisualizerConfig::OrHash
+            ).void
+          end
+          attr_writer :audio_visualizer_config
+
+          # The default state of the widget.
+          sig do
+            returns(
+              T.nilable(
+                Telnyx::AI::AssistantCreateParams::WidgetSettings::DefaultState::OrSymbol
+              )
+            )
+          end
+          attr_reader :default_state
+
+          sig do
+            params(
+              default_state:
+                Telnyx::AI::AssistantCreateParams::WidgetSettings::DefaultState::OrSymbol
+            ).void
+          end
+          attr_writer :default_state
+
+          # URL for users to give feedback.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :give_feedback_url
+
+          # URL to a custom logo icon for the widget.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :logo_icon_url
+
+          # The positioning style for the widget.
+          sig do
+            returns(
+              T.nilable(
+                Telnyx::AI::AssistantCreateParams::WidgetSettings::Position::OrSymbol
+              )
+            )
+          end
+          attr_reader :position
+
+          sig do
+            params(
+              position:
+                Telnyx::AI::AssistantCreateParams::WidgetSettings::Position::OrSymbol
+            ).void
+          end
+          attr_writer :position
+
+          # URL for users to report issues.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :report_issue_url
+
+          # Text prompting users to speak to interrupt.
+          sig { returns(T.nilable(String)) }
+          attr_reader :speak_to_interrupt_text
+
+          sig { params(speak_to_interrupt_text: String).void }
+          attr_writer :speak_to_interrupt_text
+
+          # Custom text displayed on the start call button.
+          sig { returns(T.nilable(String)) }
+          attr_reader :start_call_text
+
+          sig { params(start_call_text: String).void }
+          attr_writer :start_call_text
+
+          # The visual theme for the widget.
+          sig do
+            returns(
+              T.nilable(
+                Telnyx::AI::AssistantCreateParams::WidgetSettings::Theme::OrSymbol
+              )
+            )
+          end
+          attr_reader :theme
+
+          sig do
+            params(
+              theme:
+                Telnyx::AI::AssistantCreateParams::WidgetSettings::Theme::OrSymbol
+            ).void
+          end
+          attr_writer :theme
+
+          # URL to view conversation history.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :view_history_url
+
+          # Configuration settings for the assistant's web widget.
+          sig do
+            params(
+              agent_thinking_text: String,
+              audio_visualizer_config:
+                Telnyx::AI::AssistantCreateParams::WidgetSettings::AudioVisualizerConfig::OrHash,
+              default_state:
+                Telnyx::AI::AssistantCreateParams::WidgetSettings::DefaultState::OrSymbol,
+              give_feedback_url: T.nilable(String),
+              logo_icon_url: T.nilable(String),
+              position:
+                Telnyx::AI::AssistantCreateParams::WidgetSettings::Position::OrSymbol,
+              report_issue_url: T.nilable(String),
+              speak_to_interrupt_text: String,
+              start_call_text: String,
+              theme:
+                Telnyx::AI::AssistantCreateParams::WidgetSettings::Theme::OrSymbol,
+              view_history_url: T.nilable(String)
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # Text displayed while the agent is processing.
+            agent_thinking_text: nil,
+            audio_visualizer_config: nil,
+            # The default state of the widget.
+            default_state: nil,
+            # URL for users to give feedback.
+            give_feedback_url: nil,
+            # URL to a custom logo icon for the widget.
+            logo_icon_url: nil,
+            # The positioning style for the widget.
+            position: nil,
+            # URL for users to report issues.
+            report_issue_url: nil,
+            # Text prompting users to speak to interrupt.
+            speak_to_interrupt_text: nil,
+            # Custom text displayed on the start call button.
+            start_call_text: nil,
+            # The visual theme for the widget.
+            theme: nil,
+            # URL to view conversation history.
+            view_history_url: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                agent_thinking_text: String,
+                audio_visualizer_config:
+                  Telnyx::AI::AssistantCreateParams::WidgetSettings::AudioVisualizerConfig,
+                default_state:
+                  Telnyx::AI::AssistantCreateParams::WidgetSettings::DefaultState::OrSymbol,
+                give_feedback_url: T.nilable(String),
+                logo_icon_url: T.nilable(String),
+                position:
+                  Telnyx::AI::AssistantCreateParams::WidgetSettings::Position::OrSymbol,
+                report_issue_url: T.nilable(String),
+                speak_to_interrupt_text: String,
+                start_call_text: String,
+                theme:
+                  Telnyx::AI::AssistantCreateParams::WidgetSettings::Theme::OrSymbol,
+                view_history_url: T.nilable(String)
+              }
+            )
+          end
+          def to_hash
+          end
+
+          class AudioVisualizerConfig < Telnyx::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Telnyx::AI::AssistantCreateParams::WidgetSettings::AudioVisualizerConfig,
+                  Telnyx::Internal::AnyHash
+                )
+              end
+
+            # The color theme for the audio visualizer.
+            sig do
+              returns(
+                T.nilable(
+                  Telnyx::AI::AssistantCreateParams::WidgetSettings::AudioVisualizerConfig::Color::OrSymbol
+                )
+              )
+            end
+            attr_reader :color
+
+            sig do
+              params(
+                color:
+                  Telnyx::AI::AssistantCreateParams::WidgetSettings::AudioVisualizerConfig::Color::OrSymbol
+              ).void
+            end
+            attr_writer :color
+
+            # The preset style for the audio visualizer.
+            sig { returns(T.nilable(String)) }
+            attr_reader :preset
+
+            sig { params(preset: String).void }
+            attr_writer :preset
+
+            sig do
+              params(
+                color:
+                  Telnyx::AI::AssistantCreateParams::WidgetSettings::AudioVisualizerConfig::Color::OrSymbol,
+                preset: String
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              # The color theme for the audio visualizer.
+              color: nil,
+              # The preset style for the audio visualizer.
+              preset: nil
+            )
+            end
+
+            sig do
+              override.returns(
+                {
+                  color:
+                    Telnyx::AI::AssistantCreateParams::WidgetSettings::AudioVisualizerConfig::Color::OrSymbol,
+                  preset: String
+                }
+              )
+            end
+            def to_hash
+            end
+
+            # The color theme for the audio visualizer.
+            module Color
+              extend Telnyx::Internal::Type::Enum
+
+              TaggedSymbol =
+                T.type_alias do
+                  T.all(
+                    Symbol,
+                    Telnyx::AI::AssistantCreateParams::WidgetSettings::AudioVisualizerConfig::Color
+                  )
+                end
+              OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+              VERDANT =
+                T.let(
+                  :verdant,
+                  Telnyx::AI::AssistantCreateParams::WidgetSettings::AudioVisualizerConfig::Color::TaggedSymbol
+                )
+              TWILIGHT =
+                T.let(
+                  :twilight,
+                  Telnyx::AI::AssistantCreateParams::WidgetSettings::AudioVisualizerConfig::Color::TaggedSymbol
+                )
+              BLOOM =
+                T.let(
+                  :bloom,
+                  Telnyx::AI::AssistantCreateParams::WidgetSettings::AudioVisualizerConfig::Color::TaggedSymbol
+                )
+              MYSTIC =
+                T.let(
+                  :mystic,
+                  Telnyx::AI::AssistantCreateParams::WidgetSettings::AudioVisualizerConfig::Color::TaggedSymbol
+                )
+              FLARE =
+                T.let(
+                  :flare,
+                  Telnyx::AI::AssistantCreateParams::WidgetSettings::AudioVisualizerConfig::Color::TaggedSymbol
+                )
+              GLACIER =
+                T.let(
+                  :glacier,
+                  Telnyx::AI::AssistantCreateParams::WidgetSettings::AudioVisualizerConfig::Color::TaggedSymbol
+                )
+
+              sig do
+                override.returns(
+                  T::Array[
+                    Telnyx::AI::AssistantCreateParams::WidgetSettings::AudioVisualizerConfig::Color::TaggedSymbol
+                  ]
+                )
+              end
+              def self.values
+              end
+            end
+          end
+
+          # The default state of the widget.
+          module DefaultState
+            extend Telnyx::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  Telnyx::AI::AssistantCreateParams::WidgetSettings::DefaultState
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            EXPANDED =
+              T.let(
+                :expanded,
+                Telnyx::AI::AssistantCreateParams::WidgetSettings::DefaultState::TaggedSymbol
+              )
+            COLLAPSED =
+              T.let(
+                :collapsed,
+                Telnyx::AI::AssistantCreateParams::WidgetSettings::DefaultState::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Telnyx::AI::AssistantCreateParams::WidgetSettings::DefaultState::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+
+          # The positioning style for the widget.
+          module Position
+            extend Telnyx::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  Telnyx::AI::AssistantCreateParams::WidgetSettings::Position
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            FIXED =
+              T.let(
+                :fixed,
+                Telnyx::AI::AssistantCreateParams::WidgetSettings::Position::TaggedSymbol
+              )
+            STATIC =
+              T.let(
+                :static,
+                Telnyx::AI::AssistantCreateParams::WidgetSettings::Position::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Telnyx::AI::AssistantCreateParams::WidgetSettings::Position::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+
+          # The visual theme for the widget.
+          module Theme
+            extend Telnyx::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  Telnyx::AI::AssistantCreateParams::WidgetSettings::Theme
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            LIGHT =
+              T.let(
+                :light,
+                Telnyx::AI::AssistantCreateParams::WidgetSettings::Theme::TaggedSymbol
+              )
+            DARK =
+              T.let(
+                :dark,
+                Telnyx::AI::AssistantCreateParams::WidgetSettings::Theme::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Telnyx::AI::AssistantCreateParams::WidgetSettings::Theme::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+        end
       end
     end
   end