algolia 3.45.0 → 3.46.1

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

@@ -16,7 +16,8 @@ module Algolia
             :"AzureOpenAIProviderInput",
             :"BaseProviderInput",
             :"OpenAICompatibleProviderInput",
-            :"OpenAIProviderInput"
+            :"OpenAIProviderInput",
+            :"XAIProviderInput"
           ]
         end
 

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

@@ -16,7 +16,8 @@ module Algolia
             :"AzureOpenAIProviderInput",
             :"BaseProviderInput",
             :"OpenAICompatibleProviderInput",
-            :"OpenAIProviderInput"
+            :"OpenAIProviderInput",
+            :"XAIProviderInput"
           ]
         end
 

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

@@ -13,10 +13,11 @@ module Algolia
       GOOGLE_GENAI = "google_genai".freeze
       DEEPSEEK = "deepseek".freeze
       OPENAI_COMPATIBLE = "openai_compatible".freeze
+      XAI = "xai".freeze
       ANTHROPIC = "anthropic".freeze
 
       def self.all_vars
-        @all_vars ||= [OPENAI, AZURE_OPENAI, GOOGLE_GENAI, DEEPSEEK, OPENAI_COMPATIBLE, ANTHROPIC].freeze
+        @all_vars ||= [OPENAI, AZURE_OPENAI, GOOGLE_GENAI, DEEPSEEK, OPENAI_COMPATIBLE, XAI, ANTHROPIC].freeze
       end
 
       # Builds the enum from string

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

@@ -0,0 +1,239 @@
+# 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 ReasoningMessageAGUI
+      attr_accessor :id
+
+      attr_accessor :role
+
+      attr_accessor :content
+
+      attr_accessor :encrypted_value
+
+      # Attribute mapping from ruby-style variable name to JSON key.
+      def self.attribute_map
+        {
+          :id => :id,
+          :role => :role,
+          :content => :content,
+          :encrypted_value => :encryptedValue
+        }
+      end
+
+      # Attribute type mapping.
+      def self.types_mapping
+        {
+          :id => :"String",
+          :role => :"String",
+          :content => :"String",
+          :encrypted_value => :"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::ReasoningMessageAGUI` 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::ReasoningMessageAGUI`. 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?(:id)
+          self.id = attributes[:id]
+        else
+          self.id = nil
+        end
+
+        if attributes.key?(:role)
+          self.role = attributes[:role]
+        else
+          self.role = nil
+        end
+
+        if attributes.key?(:content)
+          self.content = attributes[:content]
+        else
+          self.content = nil
+        end
+
+        if attributes.key?(:encrypted_value)
+          self.encrypted_value = attributes[:encrypted_value]
+        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 &&
+          id == other.id &&
+          role == other.role &&
+          content == other.content &&
+          encrypted_value == other.encrypted_value
+      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
+        [id, role, content, encrypted_value].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/reasoning_part_agui.rb

@@ -0,0 +1,228 @@
+# 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 ReasoningPartAGUI
+      attr_accessor :type
+
+      attr_accessor :content
+
+      attr_accessor :step_id
+
+      # Attribute mapping from ruby-style variable name to JSON key.
+      def self.attribute_map
+        {
+          :type => :type,
+          :content => :content,
+          :step_id => :stepId
+        }
+      end
+
+      # Attribute type mapping.
+      def self.types_mapping
+        {
+          :type => :"String",
+          :content => :"String",
+          :step_id => :"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::ReasoningPartAGUI` 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::ReasoningPartAGUI`. 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?(:type)
+          self.type = attributes[:type]
+        else
+          self.type = nil
+        end
+
+        if attributes.key?(:content)
+          self.content = attributes[:content]
+        else
+          self.content = nil
+        end
+
+        if attributes.key?(:step_id)
+          self.step_id = attributes[:step_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 &&
+          type == other.type &&
+          content == other.content &&
+          step_id == other.step_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
+        [type, content, step_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/search_parameters.rb

@@ -7,7 +7,7 @@ require "time"
 
 module Algolia
   module AgentStudio
-    # Algolia Search API parameters that can be predefined for the search tool. Reference: https://www.algolia.com/doc/api-reference/search-api-parameters/  The parameters that seemed irrelevant for the search tool have been commented out. Uses types from algoliasearch.search.models for better type safety.
+    # Algolia Search API parameters that can be predefined for the search tool. Reference: https://www.algolia.com/doc/api-reference/search-api-parameters/  The search tool supports the relevant subset of search parameters in the context of agentic interactions.
     class SearchParameters
       attr_accessor :query_type
 

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

@@ -25,6 +25,20 @@ module Algolia
 
       attr_accessor :optional_filters
 
+      attr_accessor :facet_filters
+
+      attr_accessor :around_lat_lng
+
+      attr_accessor :around_radius
+
+      attr_accessor :around_precision
+
+      attr_accessor :minimum_around_radius
+
+      attr_accessor :inside_bounding_box
+
+      attr_accessor :inside_polygon
+
       # Attribute mapping from ruby-style variable name to JSON key.
       def self.attribute_map
         {
@@ -35,7 +49,14 @@ module Algolia
           :user_token => :userToken,
           :enable_personalization => :enablePersonalization,
           :personalization_impact => :personalizationImpact,
-          :optional_filters => :optionalFilters
+          :optional_filters => :optionalFilters,
+          :facet_filters => :facetFilters,
+          :around_lat_lng => :aroundLatLng,
+          :around_radius => :aroundRadius,
+          :around_precision => :aroundPrecision,
+          :minimum_around_radius => :minimumAroundRadius,
+          :inside_bounding_box => :insideBoundingBox,
+          :inside_polygon => :insidePolygon
         }
       end
 
@@ -49,7 +70,14 @@ module Algolia
           :user_token => :"String",
           :enable_personalization => :"Boolean",
           :personalization_impact => :"Integer",
-          :optional_filters => :"OptionalFiltersUnion"
+          :optional_filters => :"OptionalFiltersUnion",
+          :facet_filters => :"FacetFiltersUnionSearchParametersOverrides",
+          :around_lat_lng => :"String",
+          :around_radius => :"AroundRadiusUnion",
+          :around_precision => :"AroundPrecisionUnion",
+          :minimum_around_radius => :"Integer",
+          :inside_bounding_box => :"InsideBoundingBoxUnion",
+          :inside_polygon => :"InsidePolygonUnion"
         }
       end
 
@@ -58,7 +86,12 @@ module Algolia
         Set.new(
           [
             :distinct,
-            :optional_filters
+            :optional_filters,
+            :facet_filters,
+            :around_radius,
+            :around_precision,
+            :inside_bounding_box,
+            :inside_polygon
           ]
         )
       end
@@ -121,6 +154,34 @@ module Algolia
         if attributes.key?(:optional_filters)
           self.optional_filters = attributes[:optional_filters]
         end
+
+        if attributes.key?(:facet_filters)
+          self.facet_filters = attributes[:facet_filters]
+        end
+
+        if attributes.key?(:around_lat_lng)
+          self.around_lat_lng = attributes[:around_lat_lng]
+        end
+
+        if attributes.key?(:around_radius)
+          self.around_radius = attributes[:around_radius]
+        end
+
+        if attributes.key?(:around_precision)
+          self.around_precision = attributes[:around_precision]
+        end
+
+        if attributes.key?(:minimum_around_radius)
+          self.minimum_around_radius = attributes[:minimum_around_radius]
+        end
+
+        if attributes.key?(:inside_bounding_box)
+          self.inside_bounding_box = attributes[:inside_bounding_box]
+        end
+
+        if attributes.key?(:inside_polygon)
+          self.inside_polygon = attributes[:inside_polygon]
+        end
       end
 
       # Checks equality by comparing each attribute.
@@ -135,7 +196,14 @@ module Algolia
           user_token == other.user_token &&
           enable_personalization == other.enable_personalization &&
           personalization_impact == other.personalization_impact &&
-          optional_filters == other.optional_filters
+          optional_filters == other.optional_filters &&
+          facet_filters == other.facet_filters &&
+          around_lat_lng == other.around_lat_lng &&
+          around_radius == other.around_radius &&
+          around_precision == other.around_precision &&
+          minimum_around_radius == other.minimum_around_radius &&
+          inside_bounding_box == other.inside_bounding_box &&
+          inside_polygon == other.inside_polygon
       end
 
       # @see the `==` method
@@ -155,7 +223,14 @@ module Algolia
           user_token,
           enable_personalization,
           personalization_impact,
-          optional_filters
+          optional_filters,
+          facet_filters,
+          around_lat_lng,
+          around_radius,
+          around_precision,
+          minimum_around_radius,
+          inside_bounding_box,
+          inside_polygon
         ].hash
       end
 

data/lib/algolia/models/agent-studio/status_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 StatusEnum
+      RESOLVED = "resolved".freeze
+      CANCELLED = "cancelled".freeze
+
+      def self.all_vars
+        @all_vars ||= [RESOLVED, CANCELLED].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 StatusEnum.all_vars.include?(value)
+        raise "Invalid ENUM value #{value} for class #StatusEnum"
+      end
+    end
+  end
+end