trieve_ruby_client 0.8.2 → 0.11.0

data/lib/trieve_ruby_client/models/search_analytics_response.rb

@@ -0,0 +1,110 @@
+=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
+  module SearchAnalyticsResponse
+    class << self
+      # List of class defined in oneOf (OpenAPI v3)
+      def openapi_one_of
+        [
+          :'DatasetAnalytics',
+          :'HeadQueryResponse',
+          :'LatencyGraphResponse',
+          :'QueryCountResponse',
+          :'RPSGraphResponse',
+          :'SearchQueryEvent',
+          :'SearchQueryResponse'
+        ]
+      end
+
+      # Builds the object
+      # @param [Mixed] Data to be matched against the list of oneOf items
+      # @return [Object] Returns the model or the data itself
+      def build(data)
+        # Go through the list of oneOf items and attempt to identify the appropriate one.
+        # Note:
+        # - We do not attempt to check whether exactly one item matches.
+        # - No advanced validation of types in some cases (e.g. "x: { type: string }" will happily match { x: 123 })
+        #   due to the way the deserialization is made in the base_object template (it just casts without verifying).
+        # - TODO: scalar values are de facto behaving as if they were nullable.
+        # - TODO: logging when debugging is set.
+        openapi_one_of.each do |klass|
+          begin
+            next if klass == :AnyType # "nullable: true"
+            typed_data = find_and_cast_into_type(klass, data)
+            return typed_data if typed_data
+          rescue # rescue all errors so we keep iterating even if the current item lookup raises
+          end
+        end
+
+        openapi_one_of.include?(:AnyType) ? data : nil
+      end
+
+      private
+
+      SchemaMismatchError = Class.new(StandardError)
+
+      # Note: 'File' is missing here because in the regular case we get the data _after_ a call to JSON.parse.
+      def find_and_cast_into_type(klass, data)
+        return if data.nil?
+
+        case klass.to_s
+        when 'Boolean'
+          return data if data.instance_of?(TrueClass) || data.instance_of?(FalseClass)
+        when 'Float'
+          return data if data.instance_of?(Float)
+        when 'Integer'
+          return data if data.instance_of?(Integer)
+        when 'Time'
+          return Time.parse(data)
+        when 'Date'
+          return Date.parse(data)
+        when 'String'
+          return data if data.instance_of?(String)
+        when 'Object' # "type: object"
+          return data if data.instance_of?(Hash)
+        when /\AArray<(?<sub_type>.+)>\z/ # "type: array"
+          if data.instance_of?(Array)
+            sub_type = Regexp.last_match[:sub_type]
+            return data.map { |item| find_and_cast_into_type(sub_type, item) }
+          end
+        when /\AHash<String, (?<sub_type>.+)>\z/ # "type: object" with "additionalProperties: { ... }"
+          if data.instance_of?(Hash) && data.keys.all? { |k| k.instance_of?(Symbol) || k.instance_of?(String) }
+            sub_type = Regexp.last_match[:sub_type]
+            return data.each_with_object({}) { |(k, v), hsh| hsh[k] = find_and_cast_into_type(sub_type, v) }
+          end
+        else # model
+          const = TrieveRubyClient.const_get(klass)
+          if const
+            if const.respond_to?(:openapi_one_of) # nested oneOf model
+              model = const.build(data)
+              return model if model
+            else
+              # raise if data contains keys that are not known to the model
+              raise if const.respond_to?(:acceptable_attributes) && !(data.keys - const.acceptable_attributes).empty?
+              model = const.build_from_hash(data)
+              return model if model
+            end
+          end
+        end
+
+        raise # if no match by now, raise
+      rescue
+        raise SchemaMismatchError, "#{data} doesn't match the #{klass} type"
+      end
+    end
+  end
+
+end

data/lib/trieve_ruby_client/models/search_chunk_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.8.5
 Contact: developers@trieve.ai
 Generated by: https://openapi-generator.tech
 Generator version: 7.4.0
@@ -15,6 +15,9 @@ require 'time'
 
 module TrieveRubyClient
   class SearchChunkData
+    # Set content_only to true to only returning the 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.
+    attr_accessor :content_only
+
     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.
@@ -26,9 +29,12 @@ module TrieveRubyClient
     # Set highlight_delimiters to a list of strings to use as delimiters for highlighting. If not specified, this defaults to [\"?\", \",\", \".\", \"!\"].
     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_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.
     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
+
     # Page of chunks to fetch. Page is 1-indexed.
     attr_accessor :page
 
@@ -44,23 +50,28 @@ module TrieveRubyClient
     # Set score_threshold to a float to filter out chunks with a score below the threshold.
     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.
+    # 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 (typicall 10-50ms). 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 (typically 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
       {
+        :'content_only' => :'content_only',
         :'filters' => :'filters',
         :'get_collisions' => :'get_collisions',
         :'get_total_pages' => :'get_total_pages',
         :'highlight_delimiters' => :'highlight_delimiters',
         :'highlight_results' => :'highlight_results',
+        :'highlight_threshold' => :'highlight_threshold',
         :'page' => :'page',
         :'page_size' => :'page_size',
         :'query' => :'query',
@@ -68,6 +79,7 @@ module TrieveRubyClient
         :'score_threshold' => :'score_threshold',
         :'search_type' => :'search_type',
         :'slim_chunks' => :'slim_chunks',
+        :'tag_weights' => :'tag_weights',
         :'use_weights' => :'use_weights'
       }
     end
@@ -80,11 +92,13 @@ module TrieveRubyClient
     # Attribute type mapping.
     def self.openapi_types
       {
+        :'content_only' => :'Boolean',
         :'filters' => :'ChunkFilter',
         :'get_collisions' => :'Boolean',
         :'get_total_pages' => :'Boolean',
         :'highlight_delimiters' => :'Array<String>',
         :'highlight_results' => :'Boolean',
+        :'highlight_threshold' => :'Float',
         :'page' => :'Integer',
         :'page_size' => :'Integer',
         :'query' => :'String',
@@ -92,6 +106,7 @@ module TrieveRubyClient
         :'score_threshold' => :'Float',
         :'search_type' => :'String',
         :'slim_chunks' => :'Boolean',
+        :'tag_weights' => :'Hash<String, Float>',
         :'use_weights' => :'Boolean'
       }
     end
@@ -99,16 +114,19 @@ module TrieveRubyClient
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'content_only',
         :'filters',
         :'get_collisions',
         :'get_total_pages',
         :'highlight_delimiters',
         :'highlight_results',
+        :'highlight_threshold',
         :'page',
         :'page_size',
         :'recency_bias',
         :'score_threshold',
         :'slim_chunks',
+        :'tag_weights',
         :'use_weights'
       ])
     end
@@ -128,6 +146,10 @@ module TrieveRubyClient
         h[k.to_sym] = v
       }
 
+      if attributes.key?(:'content_only')
+        self.content_only = attributes[:'content_only']
+      end
+
       if attributes.key?(:'filters')
         self.filters = attributes[:'filters']
       end
@@ -150,6 +172,10 @@ module TrieveRubyClient
         self.highlight_results = attributes[:'highlight_results']
       end
 
+      if attributes.key?(:'highlight_threshold')
+        self.highlight_threshold = attributes[:'highlight_threshold']
+      end
+
       if attributes.key?(:'page')
         self.page = attributes[:'page']
       end
@@ -182,6 +208,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
@@ -247,11 +279,13 @@ module TrieveRubyClient
     def ==(o)
       return true if self.equal?(o)
       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_results == o.highlight_results &&
+          highlight_threshold == o.highlight_threshold &&
           page == o.page &&
           page_size == o.page_size &&
           query == o.query &&
@@ -259,6 +293,7 @@ module TrieveRubyClient
           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
 
@@ -271,7 +306,7 @@ module TrieveRubyClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [filters, get_collisions, get_total_pages, highlight_delimiters, highlight_results, page, page_size, query, recency_bias, score_threshold, search_type, slim_chunks, use_weights].hash
+      [content_only, filters, get_collisions, get_total_pages, highlight_delimiters, highlight_results, highlight_threshold, 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_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.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