trieve_ruby_client 0.8.0 → 0.10.7

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.0
+The version of the OpenAPI document: 0.10.7
 Contact: developers@trieve.ai
 Generated by: https://openapi-generator.tech
 Generator version: 7.4.0
@@ -20,18 +20,30 @@ module TrieveRubyClient
     # 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 true, but can be set to false to reduce latency in edge cases performance.
+    # 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 true to highlight the results. If not specified, this defaults to true.
+    # 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
 
@@ -47,7 +59,7 @@ module TrieveRubyClient
     # 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. Default is false.
+    # 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
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -58,7 +70,11 @@ module TrieveRubyClient
         :'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',
@@ -81,7 +97,11 @@ module TrieveRubyClient
         :'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',
@@ -99,7 +119,11 @@ module TrieveRubyClient
         :'get_total_pages',
         :'group_size',
         :'highlight_delimiters',
+        :'highlight_max_length',
+        :'highlight_max_num',
         :'highlight_results',
+        :'highlight_threshold',
+        :'highlight_window',
         :'page',
         :'page_size',
         :'score_threshold',
@@ -144,10 +168,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 +226,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 +262,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 +282,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)
@@ -257,7 +342,11 @@ module TrieveRubyClient
           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 +364,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_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
     end
 
     # Builds the object from hash

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.0
+The version of the OpenAPI document: 0.10.7
 Contact: developers@trieve.ai
 Generated by: https://openapi-generator.tech
 Generator version: 7.4.0

data/lib/trieve_ruby_client/models/search_over_groups_slim_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.0
+The version of the OpenAPI document: 0.8.2
 Contact: developers@trieve.ai
 Generated by: https://openapi-generator.tech
 Generator version: 7.4.0

data/lib/trieve_ruby_client/models/search_slim_chunk_query_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.8.0
+The version of the OpenAPI document: 0.8.2
 Contact: developers@trieve.ai
 Generated by: https://openapi-generator.tech
 Generator version: 7.4.0

data/lib/trieve_ruby_client/models/search_within_group_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.0
+The version of the OpenAPI document: 0.10.7
 Contact: developers@trieve.ai
 Generated by: https://openapi-generator.tech
 Generator version: 7.4.0
@@ -15,12 +15,9 @@ require 'time'
 
 module TrieveRubyClient
   class SearchWithinGroupData
-    # Set date_bias to true to bias search results towards more recent chunks. This will work best in hybrid search mode.
-    attr_accessor :date_bias
-
     attr_accessor :filters
 
-    # Get total page count for the query accounting for the applied filters. Defaults to true, but can be set to false to reduce latency in edge cases performance.
+    # 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 specifies the group to search within. Results will only consist of chunks which are bookmarks within the specified group.
@@ -29,12 +26,24 @@ module TrieveRubyClient
     # Group_tracking_id specifies the group to search within by tracking id. Results will only consist of chunks which are bookmarks within the specified group. If both group_id and group_tracking_id are provided, group_id will be used.
     attr_accessor :group_tracking_id
 
-    # 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 true to highlight the results. If not specified, this defaults to true.
+    # 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
+
     # The page of chunks to fetch. Page is 1-indexed.
     attr_accessor :page
 
@@ -44,34 +53,45 @@ module TrieveRubyClient
     # The 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
 
+    # 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.
+    attr_accessor :recency_bias
+
     # Set score_threshold to a float to filter out chunks with a score below the threshold.
     attr_accessor :score_threshold
 
     # Search_type 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. Default is false.
+    # 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
 
+    # 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
+
     # 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
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'date_bias' => :'date_bias',
         :'filters' => :'filters',
         :'get_total_pages' => :'get_total_pages',
         :'group_id' => :'group_id',
         :'group_tracking_id' => :'group_tracking_id',
         :'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',
+        :'recency_bias' => :'recency_bias',
         :'score_threshold' => :'score_threshold',
         :'search_type' => :'search_type',
         :'slim_chunks' => :'slim_chunks',
+        :'tag_weights' => :'tag_weights',
         :'use_weights' => :'use_weights'
       }
     end
@@ -84,19 +104,24 @@ module TrieveRubyClient
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'date_bias' => :'Boolean',
         :'filters' => :'ChunkFilter',
         :'get_total_pages' => :'Boolean',
         :'group_id' => :'String',
         :'group_tracking_id' => :'String',
         :'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',
+        :'recency_bias' => :'Float',
         :'score_threshold' => :'Float',
         :'search_type' => :'String',
         :'slim_chunks' => :'Boolean',
+        :'tag_weights' => :'Hash<String, Float>',
         :'use_weights' => :'Boolean'
       }
     end
@@ -104,17 +129,22 @@ module TrieveRubyClient
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'date_bias',
         :'filters',
         :'get_total_pages',
         :'group_id',
         :'group_tracking_id',
         :'highlight_delimiters',
+        :'highlight_max_length',
+        :'highlight_max_num',
         :'highlight_results',
+        :'highlight_threshold',
+        :'highlight_window',
         :'page',
         :'page_size',
+        :'recency_bias',
         :'score_threshold',
         :'slim_chunks',
+        :'tag_weights',
         :'use_weights'
       ])
     end
@@ -134,10 +164,6 @@ module TrieveRubyClient
         h[k.to_sym] = v
       }
 
-      if attributes.key?(:'date_bias')
-        self.date_bias = attributes[:'date_bias']
-      end
-
       if attributes.key?(:'filters')
         self.filters = attributes[:'filters']
       end
@@ -160,10 +186,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
@@ -178,6 +220,10 @@ module TrieveRubyClient
         self.query = nil
       end
 
+      if attributes.key?(:'recency_bias')
+        self.recency_bias = attributes[:'recency_bias']
+      end
+
       if attributes.key?(:'score_threshold')
         self.score_threshold = attributes[:'score_threshold']
       end
@@ -192,6 +238,12 @@ module TrieveRubyClient
         self.slim_chunks = attributes[:'slim_chunks']
       end
 
+      if attributes.key?(:'tag_weights')
+        if (value = attributes[:'tag_weights']).is_a?(Hash)
+          self.tag_weights = value
+        end
+      end
+
       if attributes.key?(:'use_weights')
         self.use_weights = attributes[:'use_weights']
       end
@@ -202,6 +254,18 @@ module TrieveRubyClient
     def list_invalid_properties
       warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
+      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
@@ -225,6 +289,9 @@ module TrieveRubyClient
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
+      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?
@@ -232,6 +299,36 @@ module TrieveRubyClient
       true
     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)
@@ -257,19 +354,24 @@ module TrieveRubyClient
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          date_bias == o.date_bias &&
           filters == o.filters &&
           get_total_pages == o.get_total_pages &&
           group_id == o.group_id &&
           group_tracking_id == o.group_tracking_id &&
           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 &&
+          recency_bias == o.recency_bias &&
           score_threshold == o.score_threshold &&
           search_type == o.search_type &&
           slim_chunks == o.slim_chunks &&
+          tag_weights == o.tag_weights &&
           use_weights == o.use_weights
     end
 
@@ -282,7 +384,7 @@ module TrieveRubyClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [date_bias, filters, get_total_pages, group_id, group_tracking_id, highlight_delimiters, highlight_results, page, page_size, query, score_threshold, search_type, slim_chunks, use_weights].hash
+      [filters, get_total_pages, group_id, group_tracking_id, 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
     end
 
     # Builds the object from hash

data/lib/trieve_ruby_client/models/search_within_group_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.0
+The version of the OpenAPI document: 0.10.7
 Contact: developers@trieve.ai
 Generated by: https://openapi-generator.tech
 Generator version: 7.4.0

data/lib/trieve_ruby_client/models/search_within_group_slim_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.0
+The version of the OpenAPI document: 0.8.2
 Contact: developers@trieve.ai
 Generated by: https://openapi-generator.tech
 Generator version: 7.4.0

data/lib/trieve_ruby_client/models/set_user_api_key_request.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.0
+The version of the OpenAPI document: 0.10.7
 Contact: developers@trieve.ai
 Generated by: https://openapi-generator.tech
 Generator version: 7.4.0
@@ -15,16 +15,24 @@ require 'time'
 
 module TrieveRubyClient
   class SetUserApiKeyRequest
+    # The dataset ids which the api key will have access to. If not provided or empty, the api key will have access to all datasets the auth'ed user has access to. If both dataset_ids and organization_ids are provided, the api key will have access to the intersection of the datasets and organizations.
+    attr_accessor :dataset_ids
+
     # The name which will be assigned to the new api key.
     attr_accessor :name
 
+    # The organization ids which the api key will have access to. If not provided or empty, the api key will have access to all organizations the auth'ed user has access to.
+    attr_accessor :organization_ids
+
     # The role which will be assigned to the new api key. Either 0 (read), 1 (read and write at the level of the currently auth'ed user). The auth'ed user must have a role greater than or equal to the role being assigned which means they must be an admin (1) or owner (2) of the organization to assign write permissions with a role of 1.
     attr_accessor :role
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'dataset_ids' => :'dataset_ids',
         :'name' => :'name',
+        :'organization_ids' => :'organization_ids',
         :'role' => :'role'
       }
     end
@@ -37,7 +45,9 @@ module TrieveRubyClient
     # Attribute type mapping.
     def self.openapi_types
       {
+        :'dataset_ids' => :'Array<String>',
         :'name' => :'String',
+        :'organization_ids' => :'Array<String>',
         :'role' => :'Integer'
       }
     end
@@ -45,6 +55,8 @@ module TrieveRubyClient
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'dataset_ids',
+        :'organization_ids',
       ])
     end
 
@@ -63,12 +75,24 @@ module TrieveRubyClient
         h[k.to_sym] = v
       }
 
+      if attributes.key?(:'dataset_ids')
+        if (value = attributes[:'dataset_ids']).is_a?(Array)
+          self.dataset_ids = value
+        end
+      end
+
       if attributes.key?(:'name')
         self.name = attributes[:'name']
       else
         self.name = nil
       end
 
+      if attributes.key?(:'organization_ids')
+        if (value = attributes[:'organization_ids']).is_a?(Array)
+          self.organization_ids = value
+        end
+      end
+
       if attributes.key?(:'role')
         self.role = attributes[:'role']
       else
@@ -106,7 +130,9 @@ module TrieveRubyClient
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          dataset_ids == o.dataset_ids &&
           name == o.name &&
+          organization_ids == o.organization_ids &&
           role == o.role
     end
 
@@ -119,7 +145,7 @@ module TrieveRubyClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [name, role].hash
+      [dataset_ids, name, organization_ids, role].hash
     end
 
     # Builds the object from hash

data/lib/trieve_ruby_client/models/set_user_api_key_response.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.0
+The version of the OpenAPI document: 0.10.7
 Contact: developers@trieve.ai
 Generated by: https://openapi-generator.tech
 Generator version: 7.4.0