trieve_ruby_client 0.8.2 → 0.11.0

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.8.2
+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,21 +17,30 @@ 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
 
     # Group_size is the number of chunks to fetch for each group. The default is 3. If a group has less than group_size chunks, all chunks will be returned. If this is set to a large number, we recommend setting slim_chunks to true to avoid returning the content and chunk_html of the chunks so as to lower the amount of time required for content download and serialization.
     attr_accessor :group_size
 
-    # Set highlight_delimiters to a list of strings to use as delimiters for highlighting. If not specified, this defaults to [\"?\", \",\", \".\", \"!\"].
+    # Set highlight_delimiters to a list of strings to use as delimiters for highlighting. If not specified, this defaults to [\"?\", \",\", \".\", \"!\"]. These are the characters that will be used to split the chunk_html into splits for highlighting.
     attr_accessor :highlight_delimiters
 
-    # Set highlight_results to false for a slight latency improvement (1-10ms). If not specified, this defaults to true. This will add <b><mark> tags to the chunk_html of the chunks to highlight matching sub-sentences.
+    # Set highlight_max_length to control the maximum number of tokens (typically whitespace separated strings, but sometimes also word stems) which can be present within a single highlight. If not specified, this defaults to 8. This is useful to shorten large splits which may have low scores due to length compared to the query. Set to something very large like 100 to highlight entire splits.
+    attr_accessor :highlight_max_length
+
+    # Set highlight_max_num to control the maximum number of highlights per chunk. If not specified, this defaults to 3. It may be less than 3 if no snippets score above the highlight_threshold.
+    attr_accessor :highlight_max_num
+
+    # Set highlight_results to false for a slight latency improvement (1-10ms). If not specified, this defaults to true. This will add `<b><mark>` tags to the chunk_html of the chunks to highlight matching splits and return the highlights on each scored chunk in the response.
     attr_accessor :highlight_results
 
+    # Set highlight_threshold to a lower or higher value to adjust the sensitivity of the highlights applied to the chunk html. If not specified, this defaults to 0.8. The range is 0.0 to 1.0.
+    attr_accessor :highlight_threshold
+
+    # 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
+
     # Page of group results to fetch. Page is 1-indexed.
     attr_accessor :page
 
@@ -41,24 +50,48 @@ 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',
+        :'highlight_max_length' => :'highlight_max_length',
+        :'highlight_max_num' => :'highlight_max_num',
         :'highlight_results' => :'highlight_results',
+        :'highlight_threshold' => :'highlight_threshold',
+        :'highlight_window' => :'highlight_window',
         :'page' => :'page',
         :'page_size' => :'page_size',
         :'query' => :'query',
@@ -77,16 +110,19 @@ module TrieveRubyClient
     def self.openapi_types
       {
         :'filters' => :'ChunkFilter',
-        :'get_collisions' => :'Boolean',
         :'get_total_pages' => :'Boolean',
         :'group_size' => :'Integer',
         :'highlight_delimiters' => :'Array<String>',
+        :'highlight_max_length' => :'Integer',
+        :'highlight_max_num' => :'Integer',
         :'highlight_results' => :'Boolean',
+        :'highlight_threshold' => :'Float',
+        :'highlight_window' => :'Integer',
         :'page' => :'Integer',
         :'page_size' => :'Integer',
         :'query' => :'String',
         :'score_threshold' => :'Float',
-        :'search_type' => :'String',
+        :'search_type' => :'SearchMethod',
         :'slim_chunks' => :'Boolean'
       }
     end
@@ -95,11 +131,14 @@ module TrieveRubyClient
     def self.openapi_nullable
       Set.new([
         :'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',
         :'score_threshold',
@@ -126,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
@@ -144,10 +179,26 @@ module TrieveRubyClient
         end
       end
 
+      if attributes.key?(:'highlight_max_length')
+        self.highlight_max_length = attributes[:'highlight_max_length']
+      end
+
+      if attributes.key?(:'highlight_max_num')
+        self.highlight_max_num = attributes[:'highlight_max_num']
+      end
+
       if attributes.key?(:'highlight_results')
         self.highlight_results = attributes[:'highlight_results']
       end
 
+      if attributes.key?(:'highlight_threshold')
+        self.highlight_threshold = attributes[:'highlight_threshold']
+      end
+
+      if attributes.key?(:'highlight_window')
+        self.highlight_window = attributes[:'highlight_window']
+      end
+
       if attributes.key?(:'page')
         self.page = attributes[:'page']
       end
@@ -186,6 +237,18 @@ module TrieveRubyClient
         invalid_properties.push('invalid value for "group_size", must be greater than or equal to 0.')
       end
 
+      if !@highlight_max_length.nil? && @highlight_max_length < 0
+        invalid_properties.push('invalid value for "highlight_max_length", must be greater than or equal to 0.')
+      end
+
+      if !@highlight_max_num.nil? && @highlight_max_num < 0
+        invalid_properties.push('invalid value for "highlight_max_num", must be greater than or equal to 0.')
+      end
+
+      if !@highlight_window.nil? && @highlight_window < 0
+        invalid_properties.push('invalid value for "highlight_window", must be greater than or equal to 0.')
+      end
+
       if !@page.nil? && @page < 0
         invalid_properties.push('invalid value for "page", must be greater than or equal to 0.')
       end
@@ -210,6 +273,9 @@ module TrieveRubyClient
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
       return false if !@group_size.nil? && @group_size < 0
+      return false if !@highlight_max_length.nil? && @highlight_max_length < 0
+      return false if !@highlight_max_num.nil? && @highlight_max_num < 0
+      return false if !@highlight_window.nil? && @highlight_window < 0
       return false if !@page.nil? && @page < 0
       return false if !@page_size.nil? && @page_size < 0
       return false if @query.nil?
@@ -227,6 +293,36 @@ module TrieveRubyClient
       @group_size = group_size
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] highlight_max_length Value to be assigned
+    def highlight_max_length=(highlight_max_length)
+      if !highlight_max_length.nil? && highlight_max_length < 0
+        fail ArgumentError, 'invalid value for "highlight_max_length", must be greater than or equal to 0.'
+      end
+
+      @highlight_max_length = highlight_max_length
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] highlight_max_num Value to be assigned
+    def highlight_max_num=(highlight_max_num)
+      if !highlight_max_num.nil? && highlight_max_num < 0
+        fail ArgumentError, 'invalid value for "highlight_max_num", must be greater than or equal to 0.'
+      end
+
+      @highlight_max_num = highlight_max_num
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] highlight_window Value to be assigned
+    def highlight_window=(highlight_window)
+      if !highlight_window.nil? && highlight_window < 0
+        fail ArgumentError, 'invalid value for "highlight_window", must be greater than or equal to 0.'
+      end
+
+      @highlight_window = highlight_window
+    end
+
     # Custom attribute writer method with validation
     # @param [Object] page Value to be assigned
     def page=(page)
@@ -253,11 +349,14 @@ 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 &&
+          highlight_max_length == o.highlight_max_length &&
+          highlight_max_num == o.highlight_max_num &&
           highlight_results == o.highlight_results &&
+          highlight_threshold == o.highlight_threshold &&
+          highlight_window == o.highlight_window &&
           page == o.page &&
           page_size == o.page_size &&
           query == o.query &&
@@ -275,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_results, 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.8.2
+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