zavudev 0.18.0 → 0.20.0

data/rbi/zavudev/models/senders/agent_create_params.rbi

@@ -74,6 +74,17 @@ module Zavudev
         sig { params(trigger_on_message_types: T::Array[String]).void }
         attr_writer :trigger_on_message_types
 
+        # Voice Agent configuration. Enable this to let the agent answer and place phone
+        # calls with Zavu's managed voice pipeline. Requires the Voice Agents feature to
+        # be enabled for your team.
+        sig { returns(T.nilable(Zavudev::Senders::AgentCreateParams::Voice)) }
+        attr_reader :voice
+
+        sig do
+          params(voice: Zavudev::Senders::AgentCreateParams::Voice::OrHash).void
+        end
+        attr_writer :voice
+
         sig do
           params(
             sender_id: String,
@@ -88,6 +99,7 @@ module Zavudev
             temperature: Float,
             trigger_on_channels: T::Array[String],
             trigger_on_message_types: T::Array[String],
+            voice: Zavudev::Senders::AgentCreateParams::Voice::OrHash,
             request_options: Zavudev::RequestOptions::OrHash
           ).returns(T.attached_class)
         end
@@ -106,6 +118,10 @@ module Zavudev
           temperature: nil,
           trigger_on_channels: nil,
           trigger_on_message_types: nil,
+          # Voice Agent configuration. Enable this to let the agent answer and place phone
+          # calls with Zavu's managed voice pipeline. Requires the Voice Agents feature to
+          # be enabled for your team.
+          voice: nil,
           request_options: {}
         )
         end
@@ -125,12 +141,300 @@ module Zavudev
               temperature: Float,
               trigger_on_channels: T::Array[String],
               trigger_on_message_types: T::Array[String],
+              voice: Zavudev::Senders::AgentCreateParams::Voice,
               request_options: Zavudev::RequestOptions
             }
           )
         end
         def to_hash
         end
+
+        class Voice < Zavudev::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Zavudev::Senders::AgentCreateParams::Voice,
+                Zavudev::Internal::AnyHash
+              )
+            end
+
+          # Whether the agent handles voice calls. When false, the sender's number is not
+          # answered by the voice agent and outbound calls are rejected.
+          sig { returns(T::Boolean) }
+          attr_accessor :enabled
+
+          # Opening line the agent speaks when the call connects. If omitted, the agent
+          # waits for the caller to speak first.
+          sig { returns(T.nilable(String)) }
+          attr_reader :greeting
+
+          sig { params(greeting: String).void }
+          attr_writer :greeting
+
+          # Greeting per language, keyed by language code. Used when the caller's language
+          # differs from the one `greeting` is written in.
+          sig { returns(T.nilable(T::Hash[Symbol, String])) }
+          attr_reader :greetings
+
+          sig { params(greetings: T::Hash[Symbol, String]).void }
+          attr_writer :greetings
+
+          # Whether the caller can interrupt the agent while it is speaking (barge-in). When
+          # true, the agent stops talking as soon as the caller starts.
+          sig { returns(T.nilable(T::Boolean)) }
+          attr_reader :interruptible
+
+          sig { params(interruptible: T::Boolean).void }
+          attr_writer :interruptible
+
+          # BCP-47 language code used for both speech recognition and speech synthesis (e.g.
+          # `en`, `es`, `pt-BR`). Auto-detected from the recipient when omitted.
+          sig { returns(T.nilable(String)) }
+          attr_reader :language
+
+          sig { params(language: String).void }
+          attr_writer :language
+
+          # Hard limit on call length in minutes. The call ends automatically when reached.
+          sig { returns(T.nilable(Integer)) }
+          attr_reader :max_call_duration_minutes
+
+          sig { params(max_call_duration_minutes: Integer).void }
+          attr_writer :max_call_duration_minutes
+
+          # How long the agent waits during silence before ending the call.
+          sig { returns(T.nilable(Integer)) }
+          attr_reader :max_idle_seconds
+
+          sig { params(max_idle_seconds: Integer).void }
+          attr_writer :max_idle_seconds
+
+          # Model that runs the conversation, co-located in the voice network for lowest
+          # latency. Independent of the model used for text messaging. Derived from the
+          # agent's text model when omitted.
+          sig { returns(T.nilable(String)) }
+          attr_reader :model
+
+          sig { params(model: String).void }
+          attr_writer :model
+
+          # Whether the call audio is recorded.
+          sig { returns(T.nilable(T::Boolean)) }
+          attr_reader :record_calls
+
+          sig { params(record_calls: T::Boolean).void }
+          attr_writer :record_calls
+
+          # Speech-recognition model. Uses the default when omitted.
+          sig { returns(T.nilable(String)) }
+          attr_reader :stt_model
+
+          sig { params(stt_model: String).void }
+          attr_writer :stt_model
+
+          # Speech-recognition provider. Uses the default when omitted.
+          sig { returns(T.nilable(String)) }
+          attr_reader :stt_provider
+
+          sig { params(stt_provider: String).void }
+          attr_writer :stt_provider
+
+          # E.164 phone number the agent can transfer the call to. When set, the agent is
+          # given a transfer tool it can use to hand the call to a human.
+          sig { returns(T.nilable(String)) }
+          attr_reader :transfer_phone_number
+
+          sig { params(transfer_phone_number: String).void }
+          attr_writer :transfer_phone_number
+
+          # Speech-synthesis provider. Uses the default when omitted.
+          sig { returns(T.nilable(String)) }
+          attr_reader :tts_provider
+
+          sig { params(tts_provider: String).void }
+          attr_writer :tts_provider
+
+          # Identifier of the synthesized voice that speaks. Choose from the voices
+          # available in the dashboard. Uses a neutral default when omitted.
+          sig { returns(T.nilable(String)) }
+          attr_reader :tts_voice_id
+
+          sig { params(tts_voice_id: String).void }
+          attr_writer :tts_voice_id
+
+          # What the agent does when an answering machine or voicemail is detected on an
+          # outbound call.
+          sig do
+            returns(
+              T.nilable(
+                Zavudev::Senders::AgentCreateParams::Voice::VoicemailAction::OrSymbol
+              )
+            )
+          end
+          attr_reader :voicemail_action
+
+          sig do
+            params(
+              voicemail_action:
+                Zavudev::Senders::AgentCreateParams::Voice::VoicemailAction::OrSymbol
+            ).void
+          end
+          attr_writer :voicemail_action
+
+          # Message spoken when `voicemailAction` is `leave_message`. Falls back to
+          # `greeting` when omitted.
+          sig { returns(T.nilable(String)) }
+          attr_reader :voicemail_message
+
+          sig { params(voicemail_message: String).void }
+          attr_writer :voicemail_message
+
+          # Speech rate. 1.0 is natural. Only honoured by voices that support rate control;
+          # ignored by the others.
+          sig { returns(T.nilable(Float)) }
+          attr_reader :voice_speed
+
+          sig { params(voice_speed: Float).void }
+          attr_writer :voice_speed
+
+          # Voice Agent configuration. Enable this to let the agent answer and place phone
+          # calls with Zavu's managed voice pipeline. Requires the Voice Agents feature to
+          # be enabled for your team.
+          sig do
+            params(
+              enabled: T::Boolean,
+              greeting: String,
+              greetings: T::Hash[Symbol, String],
+              interruptible: T::Boolean,
+              language: String,
+              max_call_duration_minutes: Integer,
+              max_idle_seconds: Integer,
+              model: String,
+              record_calls: T::Boolean,
+              stt_model: String,
+              stt_provider: String,
+              transfer_phone_number: String,
+              tts_provider: String,
+              tts_voice_id: String,
+              voicemail_action:
+                Zavudev::Senders::AgentCreateParams::Voice::VoicemailAction::OrSymbol,
+              voicemail_message: String,
+              voice_speed: Float
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # Whether the agent handles voice calls. When false, the sender's number is not
+            # answered by the voice agent and outbound calls are rejected.
+            enabled:,
+            # Opening line the agent speaks when the call connects. If omitted, the agent
+            # waits for the caller to speak first.
+            greeting: nil,
+            # Greeting per language, keyed by language code. Used when the caller's language
+            # differs from the one `greeting` is written in.
+            greetings: nil,
+            # Whether the caller can interrupt the agent while it is speaking (barge-in). When
+            # true, the agent stops talking as soon as the caller starts.
+            interruptible: nil,
+            # BCP-47 language code used for both speech recognition and speech synthesis (e.g.
+            # `en`, `es`, `pt-BR`). Auto-detected from the recipient when omitted.
+            language: nil,
+            # Hard limit on call length in minutes. The call ends automatically when reached.
+            max_call_duration_minutes: nil,
+            # How long the agent waits during silence before ending the call.
+            max_idle_seconds: nil,
+            # Model that runs the conversation, co-located in the voice network for lowest
+            # latency. Independent of the model used for text messaging. Derived from the
+            # agent's text model when omitted.
+            model: nil,
+            # Whether the call audio is recorded.
+            record_calls: nil,
+            # Speech-recognition model. Uses the default when omitted.
+            stt_model: nil,
+            # Speech-recognition provider. Uses the default when omitted.
+            stt_provider: nil,
+            # E.164 phone number the agent can transfer the call to. When set, the agent is
+            # given a transfer tool it can use to hand the call to a human.
+            transfer_phone_number: nil,
+            # Speech-synthesis provider. Uses the default when omitted.
+            tts_provider: nil,
+            # Identifier of the synthesized voice that speaks. Choose from the voices
+            # available in the dashboard. Uses a neutral default when omitted.
+            tts_voice_id: nil,
+            # What the agent does when an answering machine or voicemail is detected on an
+            # outbound call.
+            voicemail_action: nil,
+            # Message spoken when `voicemailAction` is `leave_message`. Falls back to
+            # `greeting` when omitted.
+            voicemail_message: nil,
+            # Speech rate. 1.0 is natural. Only honoured by voices that support rate control;
+            # ignored by the others.
+            voice_speed: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                enabled: T::Boolean,
+                greeting: String,
+                greetings: T::Hash[Symbol, String],
+                interruptible: T::Boolean,
+                language: String,
+                max_call_duration_minutes: Integer,
+                max_idle_seconds: Integer,
+                model: String,
+                record_calls: T::Boolean,
+                stt_model: String,
+                stt_provider: String,
+                transfer_phone_number: String,
+                tts_provider: String,
+                tts_voice_id: String,
+                voicemail_action:
+                  Zavudev::Senders::AgentCreateParams::Voice::VoicemailAction::OrSymbol,
+                voicemail_message: String,
+                voice_speed: Float
+              }
+            )
+          end
+          def to_hash
+          end
+
+          # What the agent does when an answering machine or voicemail is detected on an
+          # outbound call.
+          module VoicemailAction
+            extend Zavudev::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  Zavudev::Senders::AgentCreateParams::Voice::VoicemailAction
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            HANGUP =
+              T.let(
+                :hangup,
+                Zavudev::Senders::AgentCreateParams::Voice::VoicemailAction::TaggedSymbol
+              )
+            LEAVE_MESSAGE =
+              T.let(
+                :leave_message,
+                Zavudev::Senders::AgentCreateParams::Voice::VoicemailAction::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Zavudev::Senders::AgentCreateParams::Voice::VoicemailAction::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+        end
       end
     end
   end

data/rbi/zavudev/models/senders/agent_execution.rbi

@@ -44,12 +44,26 @@ module Zavudev
         sig { params(inbound_message_id: String).void }
         attr_writer :inbound_message_id
 
+        # Knowledge-base chunks retrieved for this answer. Zero on an agent that has
+        # documents attached means the reply was not grounded in them, which is otherwise
+        # indistinguishable from a correct answer in this record. Absent on executions
+        # recorded before this field existed, which is not the same as zero.
+        sig { returns(T.nilable(Integer)) }
+        attr_accessor :knowledge_chunks_used
+
         sig { returns(T.nilable(String)) }
         attr_accessor :response_message_id
 
         sig { returns(T.nilable(String)) }
         attr_accessor :response_text
 
+        # Tools the agent called while producing this reply. Zero on an agent that has
+        # tools configured means it answered without calling any — the case where a reply
+        # says it will look something up and nothing ever reaches your endpoint. Absent on
+        # executions recorded before this field existed, which is not the same as zero.
+        sig { returns(T.nilable(Integer)) }
+        attr_accessor :tool_calls
+
         sig do
           params(
             id: String,
@@ -62,8 +76,10 @@ module Zavudev
             status: Zavudev::Senders::AgentExecutionStatus::OrSymbol,
             error_message: T.nilable(String),
             inbound_message_id: String,
+            knowledge_chunks_used: T.nilable(Integer),
             response_message_id: T.nilable(String),
-            response_text: T.nilable(String)
+            response_text: T.nilable(String),
+            tool_calls: T.nilable(Integer)
           ).returns(T.attached_class)
         end
         def self.new(
@@ -79,8 +95,18 @@ module Zavudev
           status:,
           error_message: nil,
           inbound_message_id: nil,
+          # Knowledge-base chunks retrieved for this answer. Zero on an agent that has
+          # documents attached means the reply was not grounded in them, which is otherwise
+          # indistinguishable from a correct answer in this record. Absent on executions
+          # recorded before this field existed, which is not the same as zero.
+          knowledge_chunks_used: nil,
           response_message_id: nil,
-          response_text: nil
+          response_text: nil,
+          # Tools the agent called while producing this reply. Zero on an agent that has
+          # tools configured means it answered without calling any — the case where a reply
+          # says it will look something up and nothing ever reaches your endpoint. Absent on
+          # executions recorded before this field existed, which is not the same as zero.
+          tool_calls: nil
         )
         end
 
@@ -97,8 +123,10 @@ module Zavudev
               status: Zavudev::Senders::AgentExecutionStatus::TaggedSymbol,
               error_message: T.nilable(String),
               inbound_message_id: String,
+              knowledge_chunks_used: T.nilable(Integer),
               response_message_id: T.nilable(String),
-              response_text: T.nilable(String)
+              response_text: T.nilable(String),
+              tool_calls: T.nilable(Integer)
             }
           )
         end