algolia 3.45.0 → 3.46.1

data/lib/algolia/models/agent-studio/context_trim_request.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
+    # Deterministic trim request (no LLM calls).
+    class ContextTrimRequest
+      attr_accessor :messages
+
+      # Keep only the last N messages, dropping older ones. Applied before the token budget.
+      attr_accessor :keep_last_messages
+
+      # Drop oldest messages until the estimated token total fits this budget (heuristic).
+      attr_accessor :max_tokens_estimate
+
+      # Strip tool-invocation/result parts from the messages that are kept. Applied before the token budget, so the budget counts only surviving content.
+      attr_accessor :drop_tool_parts
+
+      # Attribute mapping from ruby-style variable name to JSON key.
+      def self.attribute_map
+        {
+          :messages => :messages,
+          :keep_last_messages => :keepLastMessages,
+          :max_tokens_estimate => :maxTokensEstimate,
+          :drop_tool_parts => :dropToolParts
+        }
+      end
+
+      # Attribute type mapping.
+      def self.types_mapping
+        {
+          :messages => :"MessagesUnion",
+          :keep_last_messages => :"Integer",
+          :max_tokens_estimate => :"Integer",
+          :drop_tool_parts => :"Boolean"
+        }
+      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::ContextTrimRequest` 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::ContextTrimRequest`. 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?(:messages)
+          self.messages = attributes[:messages]
+        else
+          self.messages = nil
+        end
+
+        if attributes.key?(:keep_last_messages)
+          self.keep_last_messages = attributes[:keep_last_messages]
+        end
+
+        if attributes.key?(:max_tokens_estimate)
+          self.max_tokens_estimate = attributes[:max_tokens_estimate]
+        end
+
+        if attributes.key?(:drop_tool_parts)
+          self.drop_tool_parts = attributes[:drop_tool_parts]
+        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 &&
+          messages == other.messages &&
+          keep_last_messages == other.keep_last_messages &&
+          max_tokens_estimate == other.max_tokens_estimate &&
+          drop_tool_parts == other.drop_tool_parts
+      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
+        [messages, keep_last_messages, max_tokens_estimate, drop_tool_parts].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/conversation_base_response.rb

@@ -37,6 +37,8 @@ module Algolia
 
       attr_accessor :feedback
 
+      attr_accessor :impact_analytics
+
       # Attribute mapping from ruby-style variable name to JSON key.
       def self.attribute_map
         {
@@ -53,7 +55,8 @@ module Algolia
           :total_output_tokens => :totalOutputTokens,
           :total_tokens => :totalTokens,
           :conversation_metadata => :conversationMetadata,
-          :feedback => :feedback
+          :feedback => :feedback,
+          :impact_analytics => :impactAnalytics
         }
       end
 
@@ -73,7 +76,8 @@ module Algolia
           :total_output_tokens => :"Integer",
           :total_tokens => :"Integer",
           :conversation_metadata => :"ConversationMetadata",
-          :feedback => :"Array<FeedbackResponse>"
+          :feedback => :"Array<FeedbackResponse>",
+          :impact_analytics => :"ImpactAnalytics"
         }
       end
 
@@ -85,7 +89,8 @@ module Algolia
             :last_activity_at,
             :user_token,
             :conversation_metadata,
-            :feedback
+            :feedback,
+            :impact_analytics
           ]
         )
       end
@@ -178,6 +183,10 @@ module Algolia
             self.feedback = value
           end
         end
+
+        if attributes.key?(:impact_analytics)
+          self.impact_analytics = attributes[:impact_analytics]
+        end
       end
 
       # Checks equality by comparing each attribute.
@@ -198,7 +207,8 @@ module Algolia
           total_output_tokens == other.total_output_tokens &&
           total_tokens == other.total_tokens &&
           conversation_metadata == other.conversation_metadata &&
-          feedback == other.feedback
+          feedback == other.feedback &&
+          impact_analytics == other.impact_analytics
       end
 
       # @see the `==` method
@@ -224,7 +234,8 @@ module Algolia
           total_output_tokens,
           total_tokens,
           conversation_metadata,
-          feedback
+          feedback,
+          impact_analytics
         ].hash
       end
 

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

@@ -37,8 +37,12 @@ module Algolia
 
       attr_accessor :feedback
 
+      attr_accessor :impact_analytics
+
       attr_accessor :messages
 
+      attr_accessor :analytics_degraded
+
       # Attribute mapping from ruby-style variable name to JSON key.
       def self.attribute_map
         {
@@ -56,7 +60,9 @@ module Algolia
           :total_tokens => :totalTokens,
           :conversation_metadata => :conversationMetadata,
           :feedback => :feedback,
-          :messages => :messages
+          :impact_analytics => :impactAnalytics,
+          :messages => :messages,
+          :analytics_degraded => :analyticsDegraded
         }
       end
 
@@ -77,7 +83,9 @@ module Algolia
           :total_tokens => :"Integer",
           :conversation_metadata => :"ConversationMetadata",
           :feedback => :"Array<FeedbackResponse>",
-          :messages => :"Array<MessageResponse>"
+          :impact_analytics => :"ImpactAnalytics",
+          :messages => :"Array<MessageResponse>",
+          :analytics_degraded => :"Boolean"
         }
       end
 
@@ -89,7 +97,8 @@ module Algolia
             :last_activity_at,
             :user_token,
             :conversation_metadata,
-            :feedback
+            :feedback,
+            :impact_analytics
           ]
         )
       end
@@ -183,6 +192,10 @@ module Algolia
           end
         end
 
+        if attributes.key?(:impact_analytics)
+          self.impact_analytics = attributes[:impact_analytics]
+        end
+
         if attributes.key?(:messages)
           if (value = attributes[:messages]).is_a?(Array)
             self.messages = value
@@ -190,6 +203,10 @@ module Algolia
         else
           self.messages = nil
         end
+
+        if attributes.key?(:analytics_degraded)
+          self.analytics_degraded = attributes[:analytics_degraded]
+        end
       end
 
       # Checks equality by comparing each attribute.
@@ -211,7 +228,9 @@ module Algolia
           total_tokens == other.total_tokens &&
           conversation_metadata == other.conversation_metadata &&
           feedback == other.feedback &&
-          messages == other.messages
+          impact_analytics == other.impact_analytics &&
+          messages == other.messages &&
+          analytics_degraded == other.analytics_degraded
       end
 
       # @see the `==` method
@@ -238,7 +257,9 @@ module Algolia
           total_tokens,
           conversation_metadata,
           feedback,
-          messages
+          impact_analytics,
+          messages,
+          analytics_degraded
         ].hash
       end
 

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

@@ -0,0 +1,218 @@
+# 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 ``data-guardrail-violation`` part that an AI SDK v5 client sends back.  Send this part to tell the completions endpoint that a guardrail blocked the previous turn.
+    class DataGuardrailViolationPartV5
+      attr_accessor :type
+
+      attr_accessor :data
+
+      # Attribute mapping from ruby-style variable name to JSON key.
+      def self.attribute_map
+        {
+          :type => :type,
+          :data => :data
+        }
+      end
+
+      # Attribute type mapping.
+      def self.types_mapping
+        {
+          :type => :"String",
+          :data => :"GuardrailViolationDataV5"
+        }
+      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::DataGuardrailViolationPartV5` 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::DataGuardrailViolationPartV5`. 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]
+        end
+
+        if attributes.key?(:data)
+          self.data = attributes[:data]
+        else
+          self.data = 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 &&
+          type == other.type &&
+          data == other.data
+      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, data].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