algolia 3.45.0 → 3.46.1

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

@@ -0,0 +1,268 @@
+# 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
+    # Use `algolia_grouped_results`.
+    class AlgoliaGroupedResultsCompatToolConfig
+      attr_accessor :name
+
+      # When true, a successful tool invocation ends the agent graph (no further LLM turn). Use for chat experiences where the tool payload IS the final response. Leave false to let the main LLM produce a concluding assistant message after the tool runs.
+      attr_accessor :is_terminal
+
+      # Minimum number of result groups.
+      attr_accessor :min_groups
+
+      # Maximum number of result groups.
+      attr_accessor :max_groups
+
+      # Minimum hits per group.
+      attr_accessor :min_results_per_group
+
+      # Maximum hits per group.
+      attr_accessor :max_results_per_group
+
+      attr_accessor :type
+
+      # Attribute mapping from ruby-style variable name to JSON key.
+      def self.attribute_map
+        {
+          :name => :name,
+          :is_terminal => :isTerminal,
+          :min_groups => :minGroups,
+          :max_groups => :maxGroups,
+          :min_results_per_group => :minResultsPerGroup,
+          :max_results_per_group => :maxResultsPerGroup,
+          :type => :type
+        }
+      end
+
+      # Attribute type mapping.
+      def self.types_mapping
+        {
+          :name => :"String",
+          :is_terminal => :"Boolean",
+          :min_groups => :"Integer",
+          :max_groups => :"Integer",
+          :min_results_per_group => :"Integer",
+          :max_results_per_group => :"Integer",
+          :type => :"String"
+        }
+      end
+
+      # List of attributes with nullable: true
+      def self.openapi_nullable
+        Set.new(
+          []
+        )
+      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::AlgoliaGroupedResultsCompatToolConfig` 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::AlgoliaGroupedResultsCompatToolConfig`. 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?(:name)
+          self.name = attributes[:name]
+        end
+
+        if attributes.key?(:is_terminal)
+          self.is_terminal = attributes[:is_terminal]
+        end
+
+        if attributes.key?(:min_groups)
+          self.min_groups = attributes[:min_groups]
+        end
+
+        if attributes.key?(:max_groups)
+          self.max_groups = attributes[:max_groups]
+        end
+
+        if attributes.key?(:min_results_per_group)
+          self.min_results_per_group = attributes[:min_results_per_group]
+        end
+
+        if attributes.key?(:max_results_per_group)
+          self.max_results_per_group = attributes[:max_results_per_group]
+        end
+
+        if attributes.key?(:type)
+          self.type = attributes[:type]
+        else
+          self.type = nil
+        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 &&
+          name == other.name &&
+          is_terminal == other.is_terminal &&
+          min_groups == other.min_groups &&
+          max_groups == other.max_groups &&
+          min_results_per_group == other.min_results_per_group &&
+          max_results_per_group == other.max_results_per_group &&
+          type == other.type
+      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
+        [name, is_terminal, min_groups, max_groups, min_results_per_group, max_results_per_group, type].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/{algolia_display_results_tool_config.rb → algolia_grouped_results_tool_config.rb}

@@ -7,29 +7,37 @@ require "time"
 
 module Algolia
   module AgentStudio
-    # Configuration for the algolia_display_results tool.
-    class AlgoliaDisplayResultsToolConfig
+    # Configuration for the algolia_grouped_results tool.
+    class AlgoliaGroupedResultsToolConfig
       attr_accessor :name
 
-      attr_accessor :type
+      # When true, a successful tool invocation ends the agent graph (no further LLM turn). Use for chat experiences where the tool payload IS the final response. Leave false to let the main LLM produce a concluding assistant message after the tool runs.
+      attr_accessor :is_terminal
 
+      # Minimum number of result groups.
       attr_accessor :min_groups
 
+      # Maximum number of result groups.
       attr_accessor :max_groups
 
+      # Minimum hits per group.
       attr_accessor :min_results_per_group
 
+      # Maximum hits per group.
       attr_accessor :max_results_per_group
 
+      attr_accessor :type
+
       # Attribute mapping from ruby-style variable name to JSON key.
       def self.attribute_map
         {
           :name => :name,
-          :type => :type,
+          :is_terminal => :isTerminal,
           :min_groups => :minGroups,
           :max_groups => :maxGroups,
           :min_results_per_group => :minResultsPerGroup,
-          :max_results_per_group => :maxResultsPerGroup
+          :max_results_per_group => :maxResultsPerGroup,
+          :type => :type
         }
       end
 
@@ -37,11 +45,12 @@ module Algolia
       def self.types_mapping
         {
           :name => :"String",
-          :type => :"String",
+          :is_terminal => :"Boolean",
           :min_groups => :"Integer",
           :max_groups => :"Integer",
           :min_results_per_group => :"Integer",
-          :max_results_per_group => :"Integer"
+          :max_results_per_group => :"Integer",
+          :type => :"String"
         }
       end
 
@@ -58,7 +67,7 @@ module Algolia
         if (!attributes.is_a?(Hash))
           raise(
             ArgumentError,
-            "The input argument (attributes) must be a hash in `Algolia::AlgoliaDisplayResultsToolConfig` initialize method"
+            "The input argument (attributes) must be a hash in `Algolia::AlgoliaGroupedResultsToolConfig` initialize method"
           )
         end
 
@@ -67,7 +76,7 @@ module Algolia
           if (!self.class.attribute_map.key?(k.to_sym))
             raise(
               ArgumentError,
-              "`#{k}` is not a valid attribute in `Algolia::AlgoliaDisplayResultsToolConfig`. Please check the name to make sure it's valid. List of attributes: " +
+              "`#{k}` is not a valid attribute in `Algolia::AlgoliaGroupedResultsToolConfig`. Please check the name to make sure it's valid. List of attributes: " +
                 self.class.attribute_map.keys.inspect
             )
           end
@@ -79,10 +88,8 @@ module Algolia
           self.name = attributes[:name]
         end
 
-        if attributes.key?(:type)
-          self.type = attributes[:type]
-        else
-          self.type = nil
+        if attributes.key?(:is_terminal)
+          self.is_terminal = attributes[:is_terminal]
         end
 
         if attributes.key?(:min_groups)
@@ -100,6 +107,12 @@ module Algolia
         if attributes.key?(:max_results_per_group)
           self.max_results_per_group = attributes[:max_results_per_group]
         end
+
+        if attributes.key?(:type)
+          self.type = attributes[:type]
+        else
+          self.type = nil
+        end
       end
 
       # Checks equality by comparing each attribute.
@@ -108,11 +121,12 @@ module Algolia
         return true if self.equal?(other)
         self.class == other.class &&
           name == other.name &&
-          type == other.type &&
+          is_terminal == other.is_terminal &&
           min_groups == other.min_groups &&
           max_groups == other.max_groups &&
           min_results_per_group == other.min_results_per_group &&
-          max_results_per_group == other.max_results_per_group
+          max_results_per_group == other.max_results_per_group &&
+          type == other.type
       end
 
       # @see the `==` method
@@ -124,7 +138,7 @@ module Algolia
       # Calculates hash code according to all attributes.
       # @return [Integer] Hash code
       def hash
-        [name, type, min_groups, max_groups, min_results_per_group, max_results_per_group].hash
+        [name, is_terminal, min_groups, max_groups, min_results_per_group, max_results_per_group, type].hash
       end
 
       # Builds the object from hash

data/lib/algolia/models/agent-studio/{algolia_recommend_tool_config_input.rb → algolia_recommend_tool_config.rb}

@@ -8,7 +8,7 @@ require "time"
 module Algolia
   module AgentStudio
     # Configuration for the Algolia Recommend tool. Allows specifying recommend models and related parameters.
-    class AlgoliaRecommendToolConfigInput
+    class AlgoliaRecommendToolConfig
       attr_accessor :name
 
       attr_accessor :type
@@ -50,7 +50,7 @@ module Algolia
         if (!attributes.is_a?(Hash))
           raise(
             ArgumentError,
-            "The input argument (attributes) must be a hash in `Algolia::AlgoliaRecommendToolConfigInput` initialize method"
+            "The input argument (attributes) must be a hash in `Algolia::AlgoliaRecommendToolConfig` initialize method"
           )
         end
 
@@ -59,7 +59,7 @@ module Algolia
           if (!self.class.attribute_map.key?(k.to_sym))
             raise(
               ArgumentError,
-              "`#{k}` is not a valid attribute in `Algolia::AlgoliaRecommendToolConfigInput`. Please check the name to make sure it's valid. List of attributes: " +
+              "`#{k}` is not a valid attribute in `Algolia::AlgoliaRecommendToolConfig`. Please check the name to make sure it's valid. List of attributes: " +
                 self.class.attribute_map.keys.inspect
             )
           end

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

@@ -14,12 +14,18 @@ module Algolia
 
       attr_accessor :indices
 
+      attr_accessor :mode
+
+      attr_accessor :allow_unlisted_indices
+
       # Attribute mapping from ruby-style variable name to JSON key.
       def self.attribute_map
         {
           :name => :name,
           :type => :type,
-          :indices => :indices
+          :indices => :indices,
+          :mode => :mode,
+          :allow_unlisted_indices => :allowUnlistedIndices
         }
       end
 
@@ -28,7 +34,9 @@ module Algolia
         {
           :name => :"String",
           :type => :"String",
-          :indices => :"Array<AlgoliaSearchToolIndexConfig>"
+          :indices => :"Array<AlgoliaSearchToolIndexConfig>",
+          :mode => :"ModeEnum",
+          :allow_unlisted_indices => :"Boolean"
         }
       end
 
@@ -81,6 +89,14 @@ module Algolia
         else
           self.indices = nil
         end
+
+        if attributes.key?(:mode)
+          self.mode = attributes[:mode]
+        end
+
+        if attributes.key?(:allow_unlisted_indices)
+          self.allow_unlisted_indices = attributes[:allow_unlisted_indices]
+        end
       end
 
       # Checks equality by comparing each attribute.
@@ -90,7 +106,9 @@ module Algolia
         self.class == other.class &&
           name == other.name &&
           type == other.type &&
-          indices == other.indices
+          indices == other.indices &&
+          mode == other.mode &&
+          allow_unlisted_indices == other.allow_unlisted_indices
       end
 
       # @see the `==` method
@@ -102,7 +120,7 @@ module Algolia
       # Calculates hash code according to all attributes.
       # @return [Integer] Hash code
       def hash
-        [name, type, indices].hash
+        [name, type, indices, mode, allow_unlisted_indices].hash
       end
 
       # Builds the object from hash