algolia 3.45.0 → 3.46.1

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

@@ -0,0 +1,271 @@
+# 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
+    # Compaction-specific telemetry, returned only by ``/context/compact``.  ``compacted`` makes the short-conversation passthrough detectable: without it a caller cannot tell a no-op from a summary that happened to be short.
+    class CompactionStats
+      # Whether a summary was actually produced. `false` means the payload passed through untouched (nothing older than the kept tail, or no summarizable text).
+      attr_accessor :compacted
+
+      # Number of transcript chunks summarized in the map phase. 0 on passthrough, 1 when the transcript fit in a single summarizer call.
+      attr_accessor :chunks_processed
+
+      # Number of summarizer rounds. 1 for a direct summary; 2+ when chunk summaries had to be merged (map-reduce).
+      attr_accessor :passes
+
+      # Provider-reported input tokens summed across every summarizer call. Null when the provider reported no usage metadata.
+      attr_accessor :summarizer_prompt_tokens
+
+      # Provider-reported output tokens summed across every summarizer call. Null when the provider reported no usage metadata.
+      attr_accessor :summarizer_completion_tokens
+
+      # The requested output budget, echoed back when `targetTokensEstimate` was set.
+      attr_accessor :target_tokens_estimate
+
+      # Attribute mapping from ruby-style variable name to JSON key.
+      def self.attribute_map
+        {
+          :compacted => :compacted,
+          :chunks_processed => :chunksProcessed,
+          :passes => :passes,
+          :summarizer_prompt_tokens => :summarizerPromptTokens,
+          :summarizer_completion_tokens => :summarizerCompletionTokens,
+          :target_tokens_estimate => :targetTokensEstimate
+        }
+      end
+
+      # Attribute type mapping.
+      def self.types_mapping
+        {
+          :compacted => :"Boolean",
+          :chunks_processed => :"Integer",
+          :passes => :"Integer",
+          :summarizer_prompt_tokens => :"Integer",
+          :summarizer_completion_tokens => :"Integer",
+          :target_tokens_estimate => :"Integer"
+        }
+      end
+
+      # List of attributes with nullable: true
+      def self.openapi_nullable
+        Set.new(
+          [
+            :summarizer_prompt_tokens,
+            :summarizer_completion_tokens,
+            :target_tokens_estimate
+          ]
+        )
+      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::CompactionStats` 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::CompactionStats`. 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?(:compacted)
+          self.compacted = attributes[:compacted]
+        else
+          self.compacted = nil
+        end
+
+        if attributes.key?(:chunks_processed)
+          self.chunks_processed = attributes[:chunks_processed]
+        end
+
+        if attributes.key?(:passes)
+          self.passes = attributes[:passes]
+        end
+
+        if attributes.key?(:summarizer_prompt_tokens)
+          self.summarizer_prompt_tokens = attributes[:summarizer_prompt_tokens]
+        end
+
+        if attributes.key?(:summarizer_completion_tokens)
+          self.summarizer_completion_tokens = attributes[:summarizer_completion_tokens]
+        end
+
+        if attributes.key?(:target_tokens_estimate)
+          self.target_tokens_estimate = attributes[:target_tokens_estimate]
+        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 &&
+          compacted == other.compacted &&
+          chunks_processed == other.chunks_processed &&
+          passes == other.passes &&
+          summarizer_prompt_tokens == other.summarizer_prompt_tokens &&
+          summarizer_completion_tokens == other.summarizer_completion_tokens &&
+          target_tokens_estimate == other.target_tokens_estimate
+      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
+        [
+          compacted,
+          chunks_processed,
+          passes,
+          summarizer_prompt_tokens,
+          summarizer_completion_tokens,
+          target_tokens_estimate
+        ].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/compatibility_mode.rb

@@ -10,9 +10,10 @@ module Algolia
     class CompatibilityMode
       AI_SDK_4 = "ai-sdk-4".freeze
       AI_SDK_5 = "ai-sdk-5".freeze
+      AG_UI = "ag-ui".freeze
 
       def self.all_vars
-        @all_vars ||= [AI_SDK_4, AI_SDK_5].freeze
+        @all_vars ||= [AI_SDK_4, AI_SDK_5, AG_UI].freeze
       end
 
       # Builds the enum from string

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

@@ -0,0 +1,263 @@
+# 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
+    # LLM-summarization request.  Your provider runs the summary, so the provider adds the cost to your account.
+    class ContextCompactRequest
+      # Provider UUID for LLM credentials.
+      attr_accessor :provider_id
+
+      # Model name (e.g., gpt-4o-mini).
+      attr_accessor :model
+
+      attr_accessor :messages
+
+      # Number of trailing messages kept verbatim; everything older is summarized.
+      attr_accessor :keep_last_messages
+
+      # Extra guidance for the summarizer (e.g. 'keep every product reference'). Appended inside the server-owned prompt frame, so it steers the summary without the model echoing your wording back into it.
+      attr_accessor :instructions
+
+      # Desired size of the final summary, in tokens. Translated into word-count guidance for the summarizer (best-effort, not a hard cap). Omit to let the summarizer default to a concise summary.
+      attr_accessor :target_tokens_estimate
+
+      # Attribute mapping from ruby-style variable name to JSON key.
+      def self.attribute_map
+        {
+          :provider_id => :providerID,
+          :model => :model,
+          :messages => :messages,
+          :keep_last_messages => :keepLastMessages,
+          :instructions => :instructions,
+          :target_tokens_estimate => :targetTokensEstimate
+        }
+      end
+
+      # Attribute type mapping.
+      def self.types_mapping
+        {
+          :provider_id => :"String",
+          :model => :"String",
+          :messages => :"MessagesUnion",
+          :keep_last_messages => :"Integer",
+          :instructions => :"String",
+          :target_tokens_estimate => :"Integer"
+        }
+      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::ContextCompactRequest` 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::ContextCompactRequest`. 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?(:provider_id)
+          self.provider_id = attributes[:provider_id]
+        else
+          self.provider_id = nil
+        end
+
+        if attributes.key?(:model)
+          self.model = attributes[:model]
+        else
+          self.model = nil
+        end
+
+        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?(:instructions)
+          self.instructions = attributes[:instructions]
+        end
+
+        if attributes.key?(:target_tokens_estimate)
+          self.target_tokens_estimate = attributes[:target_tokens_estimate]
+        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 &&
+          provider_id == other.provider_id &&
+          model == other.model &&
+          messages == other.messages &&
+          keep_last_messages == other.keep_last_messages &&
+          instructions == other.instructions &&
+          target_tokens_estimate == other.target_tokens_estimate
+      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
+        [provider_id, model, messages, keep_last_messages, instructions, target_tokens_estimate].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