algolia 3.45.0 → 3.46.1

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

@@ -0,0 +1,280 @@
+# 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 official AG-UI assistant message or a TanStack ``UIMessage`` extension.  Standard AG-UI represents text through ``content`` and tool calls through ``toolCalls``. TanStack sends those fields alongside its authoritative ``parts`` array. A populated ``parts`` array takes precedence during conversion, preventing the redundant fields from duplicating history. Unknown vendor fields are intentionally ignored, matching the other AG-UI message variants; TanStack, for example, attaches its own ``metadata`` object.
+    class AssistantMessageAGUI
+      attr_accessor :id
+
+      attr_accessor :role
+
+      attr_accessor :content
+
+      attr_accessor :name
+
+      attr_accessor :tool_calls
+
+      attr_accessor :encrypted_content
+
+      attr_accessor :parts
+
+      attr_accessor :created_at
+
+      # Attribute mapping from ruby-style variable name to JSON key.
+      def self.attribute_map
+        {
+          :id => :id,
+          :role => :role,
+          :content => :content,
+          :name => :name,
+          :tool_calls => :toolCalls,
+          :encrypted_content => :encryptedContent,
+          :parts => :parts,
+          :created_at => :createdAt
+        }
+      end
+
+      # Attribute type mapping.
+      def self.types_mapping
+        {
+          :id => :"String",
+          :role => :"String",
+          :content => :"String",
+          :name => :"String",
+          :tool_calls => :"Array<ToolCallAGUI>",
+          :encrypted_content => :"String",
+          :parts => :"Array<MessagePartAssistantMessageAGUI>",
+          :created_at => :"String"
+        }
+      end
+
+      # List of attributes with nullable: true
+      def self.openapi_nullable
+        Set.new(
+          [
+            :tool_calls
+          ]
+        )
+      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::AssistantMessageAGUI` 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::AssistantMessageAGUI`. 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]
+        end
+
+        if attributes.key?(:name)
+          self.name = attributes[:name]
+        end
+
+        if attributes.key?(:tool_calls)
+          if (value = attributes[:tool_calls]).is_a?(Array)
+            self.tool_calls = value
+          end
+        end
+
+        if attributes.key?(:encrypted_content)
+          self.encrypted_content = attributes[:encrypted_content]
+        end
+
+        if attributes.key?(:parts)
+          if (value = attributes[:parts]).is_a?(Array)
+            self.parts = value
+          end
+        end
+
+        if attributes.key?(:created_at)
+          self.created_at = attributes[:created_at]
+        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 &&
+          name == other.name &&
+          tool_calls == other.tool_calls &&
+          encrypted_content == other.encrypted_content &&
+          parts == other.parts &&
+          created_at == other.created_at
+      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, name, tool_calls, encrypted_content, parts, created_at].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/assistant_message_v4.rb

@@ -44,6 +44,7 @@ module Algolia
       def self.openapi_nullable
         Set.new(
           [
+            :id,
             :tool_invocations
           ]
         )

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

@@ -35,7 +35,9 @@ module Algolia
       # List of attributes with nullable: true
       def self.openapi_nullable
         Set.new(
-          []
+          [
+            :id
+          ]
         )
       end
 

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

@@ -12,6 +12,8 @@ module Algolia
       # List of class defined in oneOf (OpenAPI v3)
         def openapi_one_of
           [
+            :"DataGuardrailViolationPartV5",
+            :"DataPartV5",
             :"ReasoningPartV5",
             :"StepStartPartV5",
             :"TextPartV5",

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

@@ -13,7 +13,7 @@ module Algolia
 
       attr_accessor :azure_endpoint
 
-      # Azure model deployment name is required.
+      # Azure model deployment name.
       attr_accessor :azure_deployment
 
       attr_accessor :api_version

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

@@ -0,0 +1,220 @@
+# 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
+    # A boolean search parameter with exposure control.
+    class BooleanParam
+      attr_accessor :exposed
+
+      attr_accessor :default
+
+      # Attribute mapping from ruby-style variable name to JSON key.
+      def self.attribute_map
+        {
+          :exposed => :exposed,
+          :default => :default
+        }
+      end
+
+      # Attribute type mapping.
+      def self.types_mapping
+        {
+          :exposed => :"Boolean",
+          :default => :"Boolean"
+        }
+      end
+
+      # List of attributes with nullable: true
+      def self.openapi_nullable
+        Set.new(
+          [
+            :default
+          ]
+        )
+      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::BooleanParam` 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::BooleanParam`. 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?(:exposed)
+          self.exposed = attributes[:exposed]
+        else
+          self.exposed = nil
+        end
+
+        if attributes.key?(:default)
+          self.default = attributes[:default]
+        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 &&
+          exposed == other.exposed &&
+          default == other.default
+      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
+        [exposed, default].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/client_side_tool_config.rb

@@ -16,13 +16,17 @@ module Algolia
 
       attr_accessor :input_schema
 
+      # Server-side declaration that this tool is display/render-only: a resolved result ends the turn and the model is not re-invoked on it (CR-11753). The client's terminal claim on a tool result is honored only when this agrees; leave false for data tools whose result the model must reason about.
+      attr_accessor :is_terminal
+
       # Attribute mapping from ruby-style variable name to JSON key.
       def self.attribute_map
         {
           :name => :name,
           :type => :type,
           :description => :description,
-          :input_schema => :inputSchema
+          :input_schema => :inputSchema,
+          :is_terminal => :isTerminal
         }
       end
 
@@ -32,7 +36,8 @@ module Algolia
           :name => :"String",
           :type => :"String",
           :description => :"String",
-          :input_schema => :"ClientToolsArgsSchema"
+          :input_schema => :"ClientToolsArgsSchema",
+          :is_terminal => :"Boolean"
         }
       end
 
@@ -89,6 +94,10 @@ module Algolia
         else
           self.input_schema = nil
         end
+
+        if attributes.key?(:is_terminal)
+          self.is_terminal = attributes[:is_terminal]
+        end
       end
 
       # Checks equality by comparing each attribute.
@@ -99,7 +108,8 @@ module Algolia
           name == other.name &&
           type == other.type &&
           description == other.description &&
-          input_schema == other.input_schema
+          input_schema == other.input_schema &&
+          is_terminal == other.is_terminal
       end
 
       # @see the `==` method
@@ -111,7 +121,7 @@ module Algolia
       # Calculates hash code according to all attributes.
       # @return [Integer] Hash code
       def hash
-        [name, type, description, input_schema].hash
+        [name, type, description, input_schema, is_terminal].hash
       end
 
       # Builds the object from hash