trieve_ruby_client 0.10.7 → 0.11.0

data/lib/trieve_ruby_client/models/search_chunks_req_payload.rb

@@ -3,7 +3,7 @@
 
 #Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API.
 
-The version of the OpenAPI document: 0.10.7
+The version of the OpenAPI document: 0.11.0
 Contact: developers@trieve.ai
 Generated by: https://openapi-generator.tech
 Generator version: 7.4.0
@@ -20,9 +20,6 @@ module TrieveRubyClient
 
     attr_accessor :filters
 
-    # Set get_collisions to true to get the collisions for each chunk. This will only apply if environment variable COLLISIONS_ENABLED is set to true.
-    attr_accessor :get_collisions
-
     # Get total page count for the query accounting for the applied filters. Defaults to false, but can be set to true when the latency penalty is acceptable (typically 50-200ms).
     attr_accessor :get_total_pages
 
@@ -44,6 +41,8 @@ module TrieveRubyClient
     # Set highlight_window to a number to control the amount of words that are returned around the matched phrases. If not specified, this defaults to 0. This is useful for when you want to show more context around the matched words. When specified, window/2 whitespace separated words are added before and after each highlight in the response's highlights array. If an extended highlight overlaps with another highlight, the overlapping words are only included once.
     attr_accessor :highlight_window
 
+    attr_accessor :location_bias
+
     # Page of chunks to fetch. Page is 1-indexed.
     attr_accessor :page
 
@@ -56,10 +55,9 @@ module TrieveRubyClient
     # Recency Bias lets you determine how much of an effect the recency of chunks will have on the search results. If not specified, this defaults to 0.0. We recommend setting this to 1.0 for a gentle reranking of the results, >3.0 for a strong reranking of the results.
     attr_accessor :recency_bias
 
-    # Set score_threshold to a float to filter out chunks with a score below the threshold.
+    # Set score_threshold to a float to filter out chunks with a score below the threshold. This threshold applies before weight and bias modifications. If not specified, this defaults to 0.0.
     attr_accessor :score_threshold
 
-    # Can be either \"semantic\", \"fulltext\", or \"hybrid\". If specified as \"hybrid\", it will pull in one page (10 chunks) of both semantic and full-text results then re-rank them using BAAI/bge-reranker-large. \"semantic\" will pull in one page (10 chunks) of the nearest cosine distant vectors. \"fulltext\" will pull in one page (10 chunks) of full-text results based on SPLADE.
     attr_accessor :search_type
 
     # Set slim_chunks to true to avoid returning the content and chunk_html of the chunks. This is useful for when you want to reduce amount of data over the wire for latency improvement (typically 10-50ms). Default is false.
@@ -68,15 +66,39 @@ module TrieveRubyClient
     # Tag weights is a JSON object which can be used to boost the ranking of chunks with certain tags. This is useful for when you want to be able to bias towards chunks with a certain tag on the fly. The keys are the tag names and the values are the weights.
     attr_accessor :tag_weights
 
+    # If true, chunks will be reranked using scores from a cross encoder model. \"hybrid\" search will always use the reranker regardless of this setting.
+    attr_accessor :use_reranker
+
     # Set use_weights to true to use the weights of the chunks in the result set in order to sort them. If not specified, this defaults to true.
     attr_accessor :use_weights
 
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'content_only' => :'content_only',
         :'filters' => :'filters',
-        :'get_collisions' => :'get_collisions',
         :'get_total_pages' => :'get_total_pages',
         :'highlight_delimiters' => :'highlight_delimiters',
         :'highlight_max_length' => :'highlight_max_length',
@@ -84,6 +106,7 @@ module TrieveRubyClient
         :'highlight_results' => :'highlight_results',
         :'highlight_threshold' => :'highlight_threshold',
         :'highlight_window' => :'highlight_window',
+        :'location_bias' => :'location_bias',
         :'page' => :'page',
         :'page_size' => :'page_size',
         :'query' => :'query',
@@ -92,6 +115,7 @@ module TrieveRubyClient
         :'search_type' => :'search_type',
         :'slim_chunks' => :'slim_chunks',
         :'tag_weights' => :'tag_weights',
+        :'use_reranker' => :'use_reranker',
         :'use_weights' => :'use_weights'
       }
     end
@@ -106,7 +130,6 @@ module TrieveRubyClient
       {
         :'content_only' => :'Boolean',
         :'filters' => :'ChunkFilter',
-        :'get_collisions' => :'Boolean',
         :'get_total_pages' => :'Boolean',
         :'highlight_delimiters' => :'Array<String>',
         :'highlight_max_length' => :'Integer',
@@ -114,14 +137,16 @@ module TrieveRubyClient
         :'highlight_results' => :'Boolean',
         :'highlight_threshold' => :'Float',
         :'highlight_window' => :'Integer',
+        :'location_bias' => :'GeoInfoWithBias',
         :'page' => :'Integer',
         :'page_size' => :'Integer',
         :'query' => :'String',
         :'recency_bias' => :'Float',
         :'score_threshold' => :'Float',
-        :'search_type' => :'String',
+        :'search_type' => :'SearchMethod',
         :'slim_chunks' => :'Boolean',
         :'tag_weights' => :'Hash<String, Float>',
+        :'use_reranker' => :'Boolean',
         :'use_weights' => :'Boolean'
       }
     end
@@ -131,7 +156,6 @@ module TrieveRubyClient
       Set.new([
         :'content_only',
         :'filters',
-        :'get_collisions',
         :'get_total_pages',
         :'highlight_delimiters',
         :'highlight_max_length',
@@ -139,12 +163,14 @@ module TrieveRubyClient
         :'highlight_results',
         :'highlight_threshold',
         :'highlight_window',
+        :'location_bias',
         :'page',
         :'page_size',
         :'recency_bias',
         :'score_threshold',
         :'slim_chunks',
         :'tag_weights',
+        :'use_reranker',
         :'use_weights'
       ])
     end
@@ -172,10 +198,6 @@ module TrieveRubyClient
         self.filters = attributes[:'filters']
       end
 
-      if attributes.key?(:'get_collisions')
-        self.get_collisions = attributes[:'get_collisions']
-      end
-
       if attributes.key?(:'get_total_pages')
         self.get_total_pages = attributes[:'get_total_pages']
       end
@@ -206,6 +228,10 @@ module TrieveRubyClient
         self.highlight_window = attributes[:'highlight_window']
       end
 
+      if attributes.key?(:'location_bias')
+        self.location_bias = attributes[:'location_bias']
+      end
+
       if attributes.key?(:'page')
         self.page = attributes[:'page']
       end
@@ -244,6 +270,10 @@ module TrieveRubyClient
         end
       end
 
+      if attributes.key?(:'use_reranker')
+        self.use_reranker = attributes[:'use_reranker']
+      end
+
       if attributes.key?(:'use_weights')
         self.use_weights = attributes[:'use_weights']
       end
@@ -356,7 +386,6 @@ module TrieveRubyClient
       self.class == o.class &&
           content_only == o.content_only &&
           filters == o.filters &&
-          get_collisions == o.get_collisions &&
           get_total_pages == o.get_total_pages &&
           highlight_delimiters == o.highlight_delimiters &&
           highlight_max_length == o.highlight_max_length &&
@@ -364,6 +393,7 @@ module TrieveRubyClient
           highlight_results == o.highlight_results &&
           highlight_threshold == o.highlight_threshold &&
           highlight_window == o.highlight_window &&
+          location_bias == o.location_bias &&
           page == o.page &&
           page_size == o.page_size &&
           query == o.query &&
@@ -372,6 +402,7 @@ module TrieveRubyClient
           search_type == o.search_type &&
           slim_chunks == o.slim_chunks &&
           tag_weights == o.tag_weights &&
+          use_reranker == o.use_reranker &&
           use_weights == o.use_weights
     end
 
@@ -384,7 +415,7 @@ module TrieveRubyClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [content_only, filters, get_collisions, get_total_pages, highlight_delimiters, highlight_max_length, highlight_max_num, highlight_results, highlight_threshold, highlight_window, page, page_size, query, recency_bias, score_threshold, search_type, slim_chunks, tag_weights, use_weights].hash
+      [content_only, filters, get_total_pages, highlight_delimiters, highlight_max_length, highlight_max_num, highlight_results, highlight_threshold, highlight_window, location_bias, page, page_size, query, recency_bias, score_threshold, search_type, slim_chunks, tag_weights, use_reranker, use_weights].hash
     end
 
     # Builds the object from hash

data/lib/trieve_ruby_client/models/search_cluster_response.rb

@@ -0,0 +1,223 @@
+=begin
+#Trieve API
+
+#Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API.
+
+The version of the OpenAPI document: 0.11.0
+Contact: developers@trieve.ai
+Generated by: https://openapi-generator.tech
+Generator version: 7.4.0
+
+=end
+
+require 'date'
+require 'time'
+
+module TrieveRubyClient
+  class SearchClusterResponse
+    attr_accessor :clusters
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'clusters' => :'clusters'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'clusters' => :'Array<SearchClusterTopics>'
+      }
+    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))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `TrieveRubyClient::SearchClusterResponse` 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))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `TrieveRubyClient::SearchClusterResponse`. 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?(:'clusters')
+        if (value = attributes[:'clusters']).is_a?(Array)
+          self.clusters = value
+        end
+      else
+        self.clusters = nil
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      if @clusters.nil?
+        invalid_properties.push('invalid value for "clusters", clusters cannot be nil.')
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @clusters.nil?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          clusters == o.clusters
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [clusters].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 = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = 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}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _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
+      else # model
+        # models (e.g. Pet) or oneOf
+        klass = TrieveRubyClient.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
+
+    # 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 = self.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.compact.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