algolia 3.45.0 → 3.46.1

data/lib/algolia/models/agent-studio/message_event.rb

@@ -0,0 +1,231 @@
+# frozen_string_literal: true
+
+# Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
+
+require "date"
+require "time"
+
+module Algolia
+  module AgentStudio
+    # An Insights event attributed to an assistant message.
+    class MessageEvent
+      attr_accessor :event_type
+
+      attr_accessor :event_name
+
+      attr_accessor :algolia_object_id
+
+      # Attribute mapping from ruby-style variable name to JSON key.
+      def self.attribute_map
+        {
+          :event_type => :eventType,
+          :event_name => :eventName,
+          :algolia_object_id => :objectId
+        }
+      end
+
+      # Attribute type mapping.
+      def self.types_mapping
+        {
+          :event_type => :"String",
+          :event_name => :"String",
+          :algolia_object_id => :"String"
+        }
+      end
+
+      # List of attributes with nullable: true
+      def self.openapi_nullable
+        Set.new(
+          [
+            :algolia_object_id
+          ]
+        )
+      end
+
+      # Initializes the object
+      # @param [Hash] attributes Model attributes in the form of hash
+      def initialize(attributes = {})
+        if (!attributes.is_a?(Hash))
+          raise(
+            ArgumentError,
+            "The input argument (attributes) must be a hash in `Algolia::MessageEvent` initialize method"
+          )
+        end
+
+        # check to see if the attribute exists and convert string to symbol for hash key
+        attributes = attributes.each_with_object({}) { |(k, v), h|
+          if (!self.class.attribute_map.key?(k.to_sym))
+            raise(
+              ArgumentError,
+              "`#{k}` is not a valid attribute in `Algolia::MessageEvent`. Please check the name to make sure it's valid. List of attributes: " +
+                self.class.attribute_map.keys.inspect
+            )
+          end
+
+          h[k.to_sym] = v
+        }
+
+        if attributes.key?(:event_type)
+          self.event_type = attributes[:event_type]
+        else
+          self.event_type = nil
+        end
+
+        if attributes.key?(:event_name)
+          self.event_name = attributes[:event_name]
+        else
+          self.event_name = nil
+        end
+
+        if attributes.key?(:algolia_object_id)
+          self.algolia_object_id = attributes[:algolia_object_id]
+        end
+      end
+
+      # Checks equality by comparing each attribute.
+      # @param [Object] Object to be compared
+      def ==(other)
+        return true if self.equal?(other)
+        self.class == other.class &&
+          event_type == other.event_type &&
+          event_name == other.event_name &&
+          algolia_object_id == other.algolia_object_id
+      end
+
+      # @see the `==` method
+      # @param [Object] Object to be compared
+      def eql?(other)
+        self == other
+      end
+
+      # Calculates hash code according to all attributes.
+      # @return [Integer] Hash code
+      def hash
+        [event_type, event_name, algolia_object_id].hash
+      end
+
+      # Builds the object from hash
+      # @param [Hash] attributes Model attributes in the form of hash
+      # @return [Object] Returns the model itself
+      def self.build_from_hash(attributes)
+        return nil unless attributes.is_a?(Hash)
+        attributes = attributes.transform_keys(&:to_sym)
+        transformed_hash = {}
+        types_mapping.each_pair do |key, type|
+          if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+            transformed_hash[key.to_sym] = nil
+          elsif type =~ /\AArray<(.*)>/i
+            # check to ensure the input is an array given that the attribute
+            # is documented as an array but the input is not
+            if attributes[attribute_map[key]].is_a?(Array)
+              transformed_hash[key.to_sym] = attributes[attribute_map[key]].map { |v|
+                _deserialize(::Regexp.last_match(1), v)
+              }
+            end
+          elsif !attributes[attribute_map[key]].nil?
+            transformed_hash[key.to_sym] = _deserialize(type, attributes[attribute_map[key]])
+          end
+        end
+
+        new(transformed_hash)
+      end
+
+      # Deserializes the data based on type
+      # @param string type Data type
+      # @param string value Value to be deserialized
+      # @return [Object] Deserialized data
+      def self._deserialize(type, value)
+        case type.to_sym
+        when :Time
+          Time.parse(value)
+        when :Date
+          Date.parse(value)
+        when :String
+          value.to_s
+        when :Integer
+          value.to_i
+        when :Float
+          value.to_f
+        when :Boolean
+          if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+            true
+          else
+            false
+          end
+
+        when :Object
+          # generic object (usually a Hash), return directly
+          value
+        when /\AArray<(?<inner_type>.+)>\z/
+          inner_type = Regexp.last_match[:inner_type]
+          value.map { |v| _deserialize(inner_type, v) }
+        when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+          k_type = Regexp.last_match[:k_type]
+          v_type = Regexp.last_match[:v_type]
+          {}.tap do |hash|
+            value.each do |k, v|
+              hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+            end
+          end
+          # model
+        else
+          # models (e.g. Pet) or oneOf
+          klass = Algolia::AgentStudio.const_get(type)
+          klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass
+            .build_from_hash(value)
+        end
+      end
+
+      # Returns the string representation of the object
+      # @return [String] String presentation of the object
+      def to_s
+        to_hash.to_s
+      end
+
+      # to_body is an alias to to_hash (backward compatibility)
+      # @return [Hash] Returns the object in the form of hash
+      def to_body
+        to_hash
+      end
+
+      def to_json(*_args)
+        to_hash.to_json
+      end
+
+      # Returns the object in the form of hash
+      # @return [Hash] Returns the object in the form of hash
+      def to_hash
+        hash = {}
+        self.class.attribute_map.each_pair do |attr, param|
+          value = send(attr)
+          if value.nil?
+            is_nullable = self.class.openapi_nullable.include?(attr)
+            next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+          end
+
+          hash[param] = _to_hash(value)
+        end
+
+        hash
+      end
+
+      # Outputs non-array value in the form of hash
+      # For object, use to_hash. Otherwise, just return the value
+      # @param [Object] value Any valid value
+      # @return [Hash] Returns the value in the form of hash
+      def _to_hash(value)
+        if value.is_a?(Array)
+          value.map { |v| _to_hash(v) }
+        elsif value.is_a?(Hash)
+          {}.tap do |hash|
+            value.each { |k, v| hash[k] = _to_hash(v) }
+          end
+        elsif value.respond_to?(:to_hash)
+          value.to_hash
+        else
+          value
+        end
+      end
+    end
+  end
+end

data/lib/algolia/models/agent-studio/message_part_assistant_message_agui.rb

@@ -0,0 +1,123 @@
+# frozen_string_literal: true
+
+# Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
+
+require "date"
+require "time"
+
+module Algolia
+  module AgentStudio
+    module MessagePartAssistantMessageAGUI
+      class << self
+      # List of class defined in oneOf (OpenAPI v3)
+        def openapi_one_of
+          [
+            :"ReasoningPartAGUI",
+            :"TextPartAGUI",
+            :"ToolCallPartAGUI",
+            :"ToolCallResultPartAGUI"
+          ]
+        end
+
+        # Builds the object
+        # @param [Mixed] Data to be matched against the list of oneOf items
+        # @return [Object] Returns the model or the data itself
+        def build(data)
+          # Go through the list of oneOf items and attempt to identify the appropriate one.
+          # Note:
+          # - We do not attempt to check whether exactly one item matches.
+          # - No advanced validation of types in some cases (e.g. "x: { type: string }" will happily match { x: 123 })
+          #   due to the way the deserialization is made in the base_object template (it just casts without verifying).
+          # - TODO: scalar values are de facto behaving as if they were nullable.
+          # - TODO: logging when debugging is set.
+          if data.is_a?(Hash) && data.key?("type")
+            case data["type"]
+            when "text"
+              return find_and_cast_into_type(:"TextPartAGUI", data)
+            when "thinking"
+              return find_and_cast_into_type(:"ReasoningPartAGUI", data)
+            when "tool-call"
+              return find_and_cast_into_type(:"ToolCallPartAGUI", data)
+            when "tool-result"
+              return find_and_cast_into_type(:"ToolCallResultPartAGUI", data)
+            end
+          end
+
+          openapi_one_of.each do |klass|
+            begin
+              # "nullable: true"
+              next if klass == :AnyType
+              typed_data = find_and_cast_into_type(klass, data)
+              return typed_data if typed_data
+              # rescue all errors so we keep iterating even if the current item lookup raises
+            rescue
+            end
+          end
+
+          openapi_one_of.include?(:AnyType) ? data : nil
+        end
+
+        private
+
+        SchemaMismatchError = Class.new(StandardError)
+
+        def find_and_cast_into_type(klass, data)
+          return if data.nil?
+
+          case klass.to_s
+          when "Boolean"
+            return data if data.instance_of?(TrueClass) || data.instance_of?(FalseClass)
+          when "Float"
+            return data if data.instance_of?(Float)
+          when "Integer"
+            return data if data.instance_of?(Integer)
+          when "Time"
+            return Time.parse(data)
+          when "Date"
+            return Date.parse(data)
+          when "String"
+            return data if data.instance_of?(String)
+            # "type: object"
+          when "Object"
+            return data if data.instance_of?(Hash)
+            # "type: array"
+          when /\AArray<(?<sub_type>.+)>\z/
+            if data.instance_of?(Array)
+              sub_type = Regexp.last_match[:sub_type]
+              return data.map { |item| find_and_cast_into_type(sub_type, item) }
+            end
+            # "type: object" with "additionalProperties: { ... }"
+          when /\AHash<String, (?<sub_type>.+)>\z/
+            if data.instance_of?(Hash) && data.keys.all? { |k| k.instance_of?(Symbol) || k.instance_of?(String) }
+              sub_type = Regexp.last_match[:sub_type]
+              return data.each_with_object({}) { |(k, v), hsh| hsh[k] = find_and_cast_into_type(sub_type, v) }
+            end
+            # model
+          else
+            const = Algolia::AgentStudio.const_get(klass)
+            if const
+              if const.respond_to?(:openapi_one_of)
+                # nested oneOf model
+                model = const.build(data)
+              elsif const.respond_to?(:discriminator_attributes)
+                if const.discriminator_attributes.all? { |attr| data.key?(attr) }
+                  model = const.build_from_hash(data)
+                end
+              else
+                # maybe it's an enum, or doens't have discriminators
+                model = const.build_from_hash(data)
+              end
+
+              return model if model
+            end
+          end
+
+          # if no match by now, raise
+          raise
+        rescue
+          raise SchemaMismatchError, "#{data} doesn't match the #{klass} type"
+        end
+      end
+    end
+  end
+end

data/lib/algolia/models/agent-studio/message_response.rb

@@ -27,8 +27,20 @@ module Algolia
 
       attr_accessor :output_tokens
 
+      attr_accessor :reasoning_tokens
+
+      attr_accessor :input_token_details
+
+      attr_accessor :output_token_details
+
+      attr_accessor :is_cache_hit
+
       attr_accessor :turn_context
 
+      attr_accessor :events
+
+      attr_accessor :guardrail
+
       # Attribute mapping from ruby-style variable name to JSON key.
       def self.attribute_map
         {
@@ -41,7 +53,13 @@ module Algolia
           :model => :model,
           :input_tokens => :inputTokens,
           :output_tokens => :outputTokens,
-          :turn_context => :turnContext
+          :reasoning_tokens => :reasoningTokens,
+          :input_token_details => :inputTokenDetails,
+          :output_token_details => :outputTokenDetails,
+          :is_cache_hit => :isCacheHit,
+          :turn_context => :turnContext,
+          :events => :events,
+          :guardrail => :guardrail
         }
       end
 
@@ -57,7 +75,13 @@ module Algolia
           :model => :"String",
           :input_tokens => :"Integer",
           :output_tokens => :"Integer",
-          :turn_context => :"Hash<String, String>"
+          :reasoning_tokens => :"Integer",
+          :input_token_details => :"Hash<String, Integer>",
+          :output_token_details => :"Hash<String, Integer>",
+          :is_cache_hit => :"Boolean",
+          :turn_context => :"Hash<String, Object>",
+          :events => :"Array<MessageEvent>",
+          :guardrail => :"GuardrailOutcome"
         }
       end
 
@@ -68,7 +92,12 @@ module Algolia
             :model,
             :input_tokens,
             :output_tokens,
-            :turn_context
+            :reasoning_tokens,
+            :input_token_details,
+            :output_token_details,
+            :is_cache_hit,
+            :turn_context,
+            :guardrail
           ]
         )
       end
@@ -146,11 +175,41 @@ module Algolia
           self.output_tokens = attributes[:output_tokens]
         end
 
+        if attributes.key?(:reasoning_tokens)
+          self.reasoning_tokens = attributes[:reasoning_tokens]
+        end
+
+        if attributes.key?(:input_token_details)
+          if (value = attributes[:input_token_details]).is_a?(Hash)
+            self.input_token_details = value
+          end
+        end
+
+        if attributes.key?(:output_token_details)
+          if (value = attributes[:output_token_details]).is_a?(Hash)
+            self.output_token_details = value
+          end
+        end
+
+        if attributes.key?(:is_cache_hit)
+          self.is_cache_hit = attributes[:is_cache_hit]
+        end
+
         if attributes.key?(:turn_context)
           if (value = attributes[:turn_context]).is_a?(Hash)
             self.turn_context = value
           end
         end
+
+        if attributes.key?(:events)
+          if (value = attributes[:events]).is_a?(Array)
+            self.events = value
+          end
+        end
+
+        if attributes.key?(:guardrail)
+          self.guardrail = attributes[:guardrail]
+        end
       end
 
       # Checks equality by comparing each attribute.
@@ -167,7 +226,13 @@ module Algolia
           model == other.model &&
           input_tokens == other.input_tokens &&
           output_tokens == other.output_tokens &&
-          turn_context == other.turn_context
+          reasoning_tokens == other.reasoning_tokens &&
+          input_token_details == other.input_token_details &&
+          output_token_details == other.output_token_details &&
+          is_cache_hit == other.is_cache_hit &&
+          turn_context == other.turn_context &&
+          events == other.events &&
+          guardrail == other.guardrail
       end
 
       # @see the `==` method
@@ -179,7 +244,24 @@ module Algolia
       # Calculates hash code according to all attributes.
       # @return [Integer] Hash code
       def hash
-        [id, conversation_id, role, parts, created_at, updated_at, model, input_tokens, output_tokens, turn_context].hash
+        [
+          id,
+          conversation_id,
+          role,
+          parts,
+          created_at,
+          updated_at,
+          model,
+          input_tokens,
+          output_tokens,
+          reasoning_tokens,
+          input_token_details,
+          output_token_details,
+          is_cache_hit,
+          turn_context,
+          events,
+          guardrail
+        ].hash
       end
 
       # Builds the object from hash

data/lib/algolia/models/agent-studio/mode_enum.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+# Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
+
+require "date"
+require "time"
+
+module Algolia
+  module AgentStudio
+    class ModeEnum
+      STATIC = "static".freeze
+      DYNAMIC = "dynamic".freeze
+
+      def self.all_vars
+        @all_vars ||= [STATIC, DYNAMIC].freeze
+      end
+
+      # Builds the enum from string
+      # @param [String] The enum value in the form of the string
+      # @return [String] The enum value
+      def self.build_from_hash(value)
+        new.build_from_hash(value)
+      end
+
+      # Builds the enum from string
+      # @param [String] The enum value in the form of the string
+      # @return [String] The enum value
+      def build_from_hash(value)
+        return value if ModeEnum.all_vars.include?(value)
+        raise "Invalid ENUM value #{value} for class #ModeEnum"
+      end
+    end
+  end
+end

data/lib/algolia/models/agent-studio/one_of_enum.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+# Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
+
+require "date"
+require "time"
+
+module Algolia
+  module AgentStudio
+    class OneOfEnum
+      INPUT = "input".freeze
+      OUTPUT = "output".freeze
+
+      def self.all_vars
+        @all_vars ||= [INPUT, OUTPUT].freeze
+      end
+
+      # Builds the enum from string
+      # @param [String] The enum value in the form of the string
+      # @return [String] The enum value
+      def self.build_from_hash(value)
+        new.build_from_hash(value)
+      end
+
+      # Builds the enum from string
+      # @param [String] The enum value in the form of the string
+      # @return [String] The enum value
+      def build_from_hash(value)
+        return value if OneOfEnum.all_vars.include?(value)
+        raise "Invalid ENUM value #{value} for class #OneOfEnum"
+      end
+    end
+  end
+end

data/lib/algolia/models/agent-studio/open_ai_compatible_provider_input.rb

@@ -7,7 +7,7 @@ require "time"
 
 module Algolia
   module AgentStudio
-    # OpenAI-compatible provider input. Contrary to the OpenAIProviderInput, the base_url is required. A model is required to verify connectivity and get saved as the default model. This can later be changed at the Agent level.
+    # Input for a provider with an OpenAI-compatible API.
     class OpenAICompatibleProviderInput
       attr_accessor :api_key
 

data/lib/algolia/models/agent-studio/paginated_conversations_response.rb

@@ -12,11 +12,14 @@ module Algolia
 
       attr_accessor :pagination
 
+      attr_accessor :analytics_degraded
+
       # Attribute mapping from ruby-style variable name to JSON key.
       def self.attribute_map
         {
           :data => :data,
-          :pagination => :pagination
+          :pagination => :pagination,
+          :analytics_degraded => :analyticsDegraded
         }
       end
 
@@ -24,7 +27,8 @@ module Algolia
       def self.types_mapping
         {
           :data => :"Array<ConversationBaseResponse>",
-          :pagination => :"PaginationMetadata"
+          :pagination => :"PaginationMetadata",
+          :analytics_degraded => :"Boolean"
         }
       end
 
@@ -71,6 +75,10 @@ module Algolia
         else
           self.pagination = nil
         end
+
+        if attributes.key?(:analytics_degraded)
+          self.analytics_degraded = attributes[:analytics_degraded]
+        end
       end
 
       # Checks equality by comparing each attribute.
@@ -79,7 +87,8 @@ module Algolia
         return true if self.equal?(other)
         self.class == other.class &&
           data == other.data &&
-          pagination == other.pagination
+          pagination == other.pagination &&
+          analytics_degraded == other.analytics_degraded
       end
 
       # @see the `==` method
@@ -91,7 +100,7 @@ module Algolia
       # Calculates hash code according to all attributes.
       # @return [Integer] Hash code
       def hash
-        [data, pagination].hash
+        [data, pagination, analytics_degraded].hash
       end
 
       # Builds the object from hash

data/lib/algolia/models/agent-studio/provider_authentication_response.rb

@@ -22,6 +22,8 @@ module Algolia
 
       attr_accessor :last_used_at
 
+      attr_accessor :is_algolia_managed
+
       # Attribute mapping from ruby-style variable name to JSON key.
       def self.attribute_map
         {
@@ -31,7 +33,8 @@ module Algolia
           :input => :input,
           :created_at => :createdAt,
           :updated_at => :updatedAt,
-          :last_used_at => :lastUsedAt
+          :last_used_at => :lastUsedAt,
+          :is_algolia_managed => :isAlgoliaManaged
         }
       end
 
@@ -41,10 +44,11 @@ module Algolia
           :id => :"String",
           :name => :"String",
           :provider_name => :"String",
-          :input => :"ProviderInput",
+          :input => :"InputUnion",
           :created_at => :"String",
           :updated_at => :"String",
-          :last_used_at => :"String"
+          :last_used_at => :"String",
+          :is_algolia_managed => :"Boolean"
         }
       end
 
@@ -119,6 +123,10 @@ module Algolia
         if attributes.key?(:last_used_at)
           self.last_used_at = attributes[:last_used_at]
         end
+
+        if attributes.key?(:is_algolia_managed)
+          self.is_algolia_managed = attributes[:is_algolia_managed]
+        end
       end
 
       # Checks equality by comparing each attribute.
@@ -132,7 +140,8 @@ module Algolia
           input == other.input &&
           created_at == other.created_at &&
           updated_at == other.updated_at &&
-          last_used_at == other.last_used_at
+          last_used_at == other.last_used_at &&
+          is_algolia_managed == other.is_algolia_managed
       end
 
       # @see the `==` method
@@ -144,7 +153,7 @@ module Algolia
       # Calculates hash code according to all attributes.
       # @return [Integer] Hash code
       def hash
-        [id, name, provider_name, input, created_at, updated_at, last_used_at].hash
+        [id, name, provider_name, input, created_at, updated_at, last_used_at, is_algolia_managed].hash
       end
 
       # Builds the object from hash