trieve_ruby_client 0.10.7 → 0.11.0

data/lib/trieve_ruby_client/models/search_metrics.rb

@@ -0,0 +1,265 @@
+=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 SearchMetrics
+    attr_accessor :filter
+
+    attr_accessor :type
+
+    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
+      {
+        :'filter' => :'filter',
+        :'type' => :'type'
+      }
+    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
+      {
+        :'filter' => :'SearchAnalyticsFilter',
+        :'type' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'filter',
+      ])
+    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::SearchMetrics` 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::SearchMetrics`. 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?(:'filter')
+        self.filter = attributes[:'filter']
+      end
+
+      if attributes.key?(:'type')
+        self.type = attributes[:'type']
+      else
+        self.type = 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 @type.nil?
+        invalid_properties.push('invalid value for "type", type 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 @type.nil?
+      type_validator = EnumAttributeValidator.new('String', ["search_metrics"])
+      return false unless type_validator.valid?(@type)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] type Object to be assigned
+    def type=(type)
+      validator = EnumAttributeValidator.new('String', ["search_metrics"])
+      unless validator.valid?(type)
+        fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
+      end
+      @type = type
+    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 &&
+          filter == o.filter &&
+          type == o.type
+    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
+      [filter, type].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

data/lib/trieve_ruby_client/models/search_over_groups_data.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
@@ -17,9 +17,6 @@ module TrieveRubyClient
   class SearchOverGroupsData
     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
 
@@ -53,20 +50,40 @@ module TrieveRubyClient
     # Query is the search query. This can be any string. The query will be used to create an embedding vector and/or SPLADE vector which will be used to find the result set.
     attr_accessor :query
 
-    # 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\". \"hybrid\" 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 (typicall 10-50ms). Default is false.
     attr_accessor :slim_chunks
 
+    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
       {
         :'filters' => :'filters',
-        :'get_collisions' => :'get_collisions',
         :'get_total_pages' => :'get_total_pages',
         :'group_size' => :'group_size',
         :'highlight_delimiters' => :'highlight_delimiters',
@@ -93,7 +110,6 @@ module TrieveRubyClient
     def self.openapi_types
       {
         :'filters' => :'ChunkFilter',
-        :'get_collisions' => :'Boolean',
         :'get_total_pages' => :'Boolean',
         :'group_size' => :'Integer',
         :'highlight_delimiters' => :'Array<String>',
@@ -106,7 +122,7 @@ module TrieveRubyClient
         :'page_size' => :'Integer',
         :'query' => :'String',
         :'score_threshold' => :'Float',
-        :'search_type' => :'String',
+        :'search_type' => :'SearchMethod',
         :'slim_chunks' => :'Boolean'
       }
     end
@@ -115,7 +131,6 @@ module TrieveRubyClient
     def self.openapi_nullable
       Set.new([
         :'filters',
-        :'get_collisions',
         :'get_total_pages',
         :'group_size',
         :'highlight_delimiters',
@@ -150,10 +165,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
@@ -338,7 +349,6 @@ module TrieveRubyClient
       return true if self.equal?(o)
       self.class == o.class &&
           filters == o.filters &&
-          get_collisions == o.get_collisions &&
           get_total_pages == o.get_total_pages &&
           group_size == o.group_size &&
           highlight_delimiters == o.highlight_delimiters &&
@@ -364,7 +374,7 @@ module TrieveRubyClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [filters, get_collisions, get_total_pages, group_size, highlight_delimiters, highlight_max_length, highlight_max_num, highlight_results, highlight_threshold, highlight_window, page, page_size, query, score_threshold, search_type, slim_chunks].hash
+      [filters, get_total_pages, group_size, highlight_delimiters, highlight_max_length, highlight_max_num, highlight_results, highlight_threshold, highlight_window, page, page_size, query, score_threshold, search_type, slim_chunks].hash
     end
 
     # Builds the object from hash

data/lib/trieve_ruby_client/models/search_over_groups_response_body.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.6.0
+The version of the OpenAPI document: 0.11.0
 Contact: developers@trieve.ai
 Generated by: https://openapi-generator.tech
 Generator version: 7.4.0
@@ -15,15 +15,15 @@ require 'time'
 
 module TrieveRubyClient
   class SearchOverGroupsResponseBody
-    attr_accessor :group_chunks
+    attr_accessor :results
 
-    attr_accessor :total_chunk_pages
+    attr_accessor :total_pages
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'group_chunks' => :'group_chunks',
-        :'total_chunk_pages' => :'total_chunk_pages'
+        :'results' => :'results',
+        :'total_pages' => :'total_pages'
       }
     end
 
@@ -35,8 +35,8 @@ module TrieveRubyClient
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'group_chunks' => :'Array<GroupScoreChunkDTO>',
-        :'total_chunk_pages' => :'Integer'
+        :'results' => :'Array<SearchOverGroupsResults>',
+        :'total_pages' => :'Integer'
       }
     end
 
@@ -61,18 +61,18 @@ module TrieveRubyClient
         h[k.to_sym] = v
       }
 
-      if attributes.key?(:'group_chunks')
-        if (value = attributes[:'group_chunks']).is_a?(Array)
-          self.group_chunks = value
+      if attributes.key?(:'results')
+        if (value = attributes[:'results']).is_a?(Array)
+          self.results = value
         end
       else
-        self.group_chunks = nil
+        self.results = nil
       end
 
-      if attributes.key?(:'total_chunk_pages')
-        self.total_chunk_pages = attributes[:'total_chunk_pages']
+      if attributes.key?(:'total_pages')
+        self.total_pages = attributes[:'total_pages']
       else
-        self.total_chunk_pages = nil
+        self.total_pages = nil
       end
     end
 
@@ -81,12 +81,12 @@ module TrieveRubyClient
     def list_invalid_properties
       warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
-      if @group_chunks.nil?
-        invalid_properties.push('invalid value for "group_chunks", group_chunks cannot be nil.')
+      if @results.nil?
+        invalid_properties.push('invalid value for "results", results cannot be nil.')
       end
 
-      if @total_chunk_pages.nil?
-        invalid_properties.push('invalid value for "total_chunk_pages", total_chunk_pages cannot be nil.')
+      if @total_pages.nil?
+        invalid_properties.push('invalid value for "total_pages", total_pages cannot be nil.')
       end
 
       invalid_properties
@@ -96,8 +96,8 @@ module TrieveRubyClient
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
-      return false if @group_chunks.nil?
-      return false if @total_chunk_pages.nil?
+      return false if @results.nil?
+      return false if @total_pages.nil?
       true
     end
 
@@ -106,8 +106,8 @@ module TrieveRubyClient
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          group_chunks == o.group_chunks &&
-          total_chunk_pages == o.total_chunk_pages
+          results == o.results &&
+          total_pages == o.total_pages
     end
 
     # @see the `==` method
@@ -119,7 +119,7 @@ module TrieveRubyClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [group_chunks, total_chunk_pages].hash
+      [results, total_pages].hash
     end
 
     # Builds the object from hash

data/lib/trieve_ruby_client/models/search_over_groups_response_types.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.6.0
+The version of the OpenAPI document: 0.11.0
 Contact: developers@trieve.ai
 Generated by: https://openapi-generator.tech
 Generator version: 7.4.0
@@ -19,8 +19,8 @@ module TrieveRubyClient
       # List of class defined in oneOf (OpenAPI v3)
       def openapi_one_of
         [
-          :'SearchOverGroupsResponseBody',
-          :'SearchOverGroupsSlimChunksResponseBody'
+          :'DeprecatedSearchOverGroupsResponseBody',
+          :'SearchOverGroupsResponseBody'
         ]
       end
 

data/lib/trieve_ruby_client/models/search_over_groups_results.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
@@ -15,15 +15,18 @@ require 'time'
 
 module TrieveRubyClient
   class SearchOverGroupsResults
-    attr_accessor :group_chunks
+    attr_accessor :chunks
 
-    attr_accessor :total_chunk_pages
+    attr_accessor :file_id
+
+    attr_accessor :group
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'group_chunks' => :'group_chunks',
-        :'total_chunk_pages' => :'total_chunk_pages'
+        :'chunks' => :'chunks',
+        :'file_id' => :'file_id',
+        :'group' => :'group'
       }
     end
 
@@ -35,14 +38,16 @@ module TrieveRubyClient
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'group_chunks' => :'Array<GroupScoreChunk>',
-        :'total_chunk_pages' => :'Integer'
+        :'chunks' => :'Array<ScoreChunk>',
+        :'file_id' => :'String',
+        :'group' => :'ChunkGroup'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'file_id',
       ])
     end
 
@@ -61,18 +66,22 @@ module TrieveRubyClient
         h[k.to_sym] = v
       }
 
-      if attributes.key?(:'group_chunks')
-        if (value = attributes[:'group_chunks']).is_a?(Array)
-          self.group_chunks = value
+      if attributes.key?(:'chunks')
+        if (value = attributes[:'chunks']).is_a?(Array)
+          self.chunks = value
         end
       else
-        self.group_chunks = nil
+        self.chunks = nil
+      end
+
+      if attributes.key?(:'file_id')
+        self.file_id = attributes[:'file_id']
       end
 
-      if attributes.key?(:'total_chunk_pages')
-        self.total_chunk_pages = attributes[:'total_chunk_pages']
+      if attributes.key?(:'group')
+        self.group = attributes[:'group']
       else
-        self.total_chunk_pages = nil
+        self.group = nil
       end
     end
 
@@ -81,12 +90,12 @@ module TrieveRubyClient
     def list_invalid_properties
       warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
-      if @group_chunks.nil?
-        invalid_properties.push('invalid value for "group_chunks", group_chunks cannot be nil.')
+      if @chunks.nil?
+        invalid_properties.push('invalid value for "chunks", chunks cannot be nil.')
       end
 
-      if @total_chunk_pages.nil?
-        invalid_properties.push('invalid value for "total_chunk_pages", total_chunk_pages cannot be nil.')
+      if @group.nil?
+        invalid_properties.push('invalid value for "group", group cannot be nil.')
       end
 
       invalid_properties
@@ -96,8 +105,8 @@ module TrieveRubyClient
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
-      return false if @group_chunks.nil?
-      return false if @total_chunk_pages.nil?
+      return false if @chunks.nil?
+      return false if @group.nil?
       true
     end
 
@@ -106,8 +115,9 @@ module TrieveRubyClient
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          group_chunks == o.group_chunks &&
-          total_chunk_pages == o.total_chunk_pages
+          chunks == o.chunks &&
+          file_id == o.file_id &&
+          group == o.group
     end
 
     # @see the `==` method
@@ -119,7 +129,7 @@ module TrieveRubyClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [group_chunks, total_chunk_pages].hash
+      [chunks, file_id, group].hash
     end
 
     # Builds the object from hash