trieve_ruby_client 0.5.7 → 0.6.0

data/lib/trieve_ruby_client/models/recommend_group_chunks_request.rb

@@ -0,0 +1,341 @@
+=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.6.0
+Contact: developers@trieve.ai
+Generated by: https://openapi-generator.tech
+Generator version: 7.4.0
+
+=end
+
+require 'date'
+require 'time'
+
+module TrieveRubyClient
+  class RecommendGroupChunksRequest
+    attr_accessor :filters
+
+    # The number of chunks to fetch for each group. This is the number of chunks which will be returned in the response for each group. The default is 3. 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 reduce latency due to content download and serialization.
+    attr_accessor :group_size
+
+    # The number of groups to return. This is the number of groups which will be returned in the response. The default is 10.
+    attr_accessor :limit
+
+    # The ids of the groups to be used as negative examples for the recommendation. The groups in this array will be used to filter out similar groups.
+    attr_accessor :negative_group_ids
+
+    # The ids of the groups to be used as negative examples for the recommendation. The groups in this array will be used to filter out similar groups.
+    attr_accessor :negative_group_tracking_ids
+
+    # The ids of the groups to be used as positive examples for the recommendation. The groups in this array will be used to find similar groups.
+    attr_accessor :positive_group_ids
+
+    # The ids of the groups to be used as positive examples for the recommendation. The groups in this array will be used to find similar groups.
+    attr_accessor :positive_group_tracking_ids
+
+    # 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.
+    attr_accessor :slim_chunks
+
+    # Strategy to use for recommendations, either \"average_vector\" or \"best_score\". The default is \"average_vector\". The \"average_vector\" strategy will construct a single average vector from the positive and negative samples then use it to perform a pseudo-search. The \"best_score\" strategy is more advanced and navigates the HNSW with a heuristic of picking edges where the point is closer to the positive samples than it is the negatives.
+    attr_accessor :strategy
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'filters' => :'filters',
+        :'group_size' => :'group_size',
+        :'limit' => :'limit',
+        :'negative_group_ids' => :'negative_group_ids',
+        :'negative_group_tracking_ids' => :'negative_group_tracking_ids',
+        :'positive_group_ids' => :'positive_group_ids',
+        :'positive_group_tracking_ids' => :'positive_group_tracking_ids',
+        :'slim_chunks' => :'slim_chunks',
+        :'strategy' => :'strategy'
+      }
+    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
+      {
+        :'filters' => :'ChunkFilter',
+        :'group_size' => :'Integer',
+        :'limit' => :'Integer',
+        :'negative_group_ids' => :'Array<String>',
+        :'negative_group_tracking_ids' => :'Array<String>',
+        :'positive_group_ids' => :'Array<String>',
+        :'positive_group_tracking_ids' => :'Array<String>',
+        :'slim_chunks' => :'Boolean',
+        :'strategy' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'filters',
+        :'group_size',
+        :'limit',
+        :'negative_group_ids',
+        :'negative_group_tracking_ids',
+        :'positive_group_ids',
+        :'positive_group_tracking_ids',
+        :'slim_chunks',
+        :'strategy'
+      ])
+    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::RecommendGroupChunksRequest` 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::RecommendGroupChunksRequest`. 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?(:'filters')
+        self.filters = attributes[:'filters']
+      end
+
+      if attributes.key?(:'group_size')
+        self.group_size = attributes[:'group_size']
+      end
+
+      if attributes.key?(:'limit')
+        self.limit = attributes[:'limit']
+      end
+
+      if attributes.key?(:'negative_group_ids')
+        if (value = attributes[:'negative_group_ids']).is_a?(Array)
+          self.negative_group_ids = value
+        end
+      end
+
+      if attributes.key?(:'negative_group_tracking_ids')
+        if (value = attributes[:'negative_group_tracking_ids']).is_a?(Array)
+          self.negative_group_tracking_ids = value
+        end
+      end
+
+      if attributes.key?(:'positive_group_ids')
+        if (value = attributes[:'positive_group_ids']).is_a?(Array)
+          self.positive_group_ids = value
+        end
+      end
+
+      if attributes.key?(:'positive_group_tracking_ids')
+        if (value = attributes[:'positive_group_tracking_ids']).is_a?(Array)
+          self.positive_group_tracking_ids = value
+        end
+      end
+
+      if attributes.key?(:'slim_chunks')
+        self.slim_chunks = attributes[:'slim_chunks']
+      end
+
+      if attributes.key?(:'strategy')
+        self.strategy = attributes[:'strategy']
+      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 !@group_size.nil? && @group_size < 0
+        invalid_properties.push('invalid value for "group_size", must be greater than or equal to 0.')
+      end
+
+      if !@limit.nil? && @limit < 0
+        invalid_properties.push('invalid value for "limit", must be greater than or equal to 0.')
+      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 !@group_size.nil? && @group_size < 0
+      return false if !@limit.nil? && @limit < 0
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] group_size Value to be assigned
+    def group_size=(group_size)
+      if !group_size.nil? && group_size < 0
+        fail ArgumentError, 'invalid value for "group_size", must be greater than or equal to 0.'
+      end
+
+      @group_size = group_size
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] limit Value to be assigned
+    def limit=(limit)
+      if !limit.nil? && limit < 0
+        fail ArgumentError, 'invalid value for "limit", must be greater than or equal to 0.'
+      end
+
+      @limit = limit
+    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 &&
+          filters == o.filters &&
+          group_size == o.group_size &&
+          limit == o.limit &&
+          negative_group_ids == o.negative_group_ids &&
+          negative_group_tracking_ids == o.negative_group_tracking_ids &&
+          positive_group_ids == o.positive_group_ids &&
+          positive_group_tracking_ids == o.positive_group_tracking_ids &&
+          slim_chunks == o.slim_chunks &&
+          strategy == o.strategy
+    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
+      [filters, group_size, limit, negative_group_ids, negative_group_tracking_ids, positive_group_ids, positive_group_tracking_ids, slim_chunks, strategy].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/regenerate_message_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.5.7
+The version of the OpenAPI document: 0.6.0
 Contact: developers@trieve.ai
 Generated by: https://openapi-generator.tech
 Generator version: 7.4.0

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

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

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

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.5.7
+The version of the OpenAPI document: 0.6.0
 Contact: developers@trieve.ai
 Generated by: https://openapi-generator.tech
 Generator version: 7.4.0
@@ -29,7 +29,7 @@ module TrieveRubyClient
     # Set highlight_results to true to highlight the results. If not specified, this defaults to true.
     attr_accessor :highlight_results
 
-    # Page of chunks to fetch. Each page is 10 chunks. Support for custom page size is coming soon.
+    # Page of chunks to fetch. Page is 1-indexed.
     attr_accessor :page
 
     # Page size is the number of chunks to fetch. This can be used to fetch more than 10 chunks at a time.
@@ -38,9 +38,6 @@ 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
 
-    # Turn on quote words and negated words to search for exact phrases and exclude words from the search results. Default is false.
-    attr_accessor :quote_negated_words
-
     # Set score_threshold to a float to filter out chunks with a score below the threshold.
     attr_accessor :score_threshold
 
@@ -64,7 +61,6 @@ module TrieveRubyClient
         :'page' => :'page',
         :'page_size' => :'page_size',
         :'query' => :'query',
-        :'quote_negated_words' => :'quote_negated_words',
         :'score_threshold' => :'score_threshold',
         :'search_type' => :'search_type',
         :'slim_chunks' => :'slim_chunks',
@@ -88,7 +84,6 @@ module TrieveRubyClient
         :'page' => :'Integer',
         :'page_size' => :'Integer',
         :'query' => :'String',
-        :'quote_negated_words' => :'Boolean',
         :'score_threshold' => :'Float',
         :'search_type' => :'String',
         :'slim_chunks' => :'Boolean',
@@ -106,7 +101,6 @@ module TrieveRubyClient
         :'highlight_results',
         :'page',
         :'page_size',
-        :'quote_negated_words',
         :'score_threshold',
         :'slim_chunks',
         :'use_weights'
@@ -164,10 +158,6 @@ module TrieveRubyClient
         self.query = nil
       end
 
-      if attributes.key?(:'quote_negated_words')
-        self.quote_negated_words = attributes[:'quote_negated_words']
-      end
-
       if attributes.key?(:'score_threshold')
         self.score_threshold = attributes[:'score_threshold']
       end
@@ -255,7 +245,6 @@ module TrieveRubyClient
           page == o.page &&
           page_size == o.page_size &&
           query == o.query &&
-          quote_negated_words == o.quote_negated_words &&
           score_threshold == o.score_threshold &&
           search_type == o.search_type &&
           slim_chunks == o.slim_chunks &&
@@ -271,7 +260,7 @@ module TrieveRubyClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [date_bias, filters, get_collisions, highlight_delimiters, highlight_results, page, page_size, query, quote_negated_words, score_threshold, search_type, slim_chunks, use_weights].hash
+      [date_bias, filters, get_collisions, highlight_delimiters, highlight_results, page, page_size, query, score_threshold, search_type, slim_chunks, 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.5.7
+The version of the OpenAPI document: 0.6.0
 Contact: developers@trieve.ai
 Generated by: https://openapi-generator.tech
 Generator version: 7.4.0

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

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

data/lib/trieve_ruby_client/models/search_groups_result.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.5.7
+The version of the OpenAPI document: 0.6.0
 Contact: developers@trieve.ai
 Generated by: https://openapi-generator.tech
 Generator version: 7.4.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.5.7
+The version of the OpenAPI document: 0.6.0
 Contact: developers@trieve.ai
 Generated by: https://openapi-generator.tech
 Generator version: 7.4.0
@@ -20,6 +20,7 @@ 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
 
+    # 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 [\"?\", \",\", \".\", \"!\"].
@@ -28,18 +29,15 @@ module TrieveRubyClient
     # Set highlight_results to true to highlight the results. If not specified, this defaults to true.
     attr_accessor :highlight_results
 
-    # Page of chunks to fetch. Each page is 10 chunks. Support for custom page size is coming soon.
+    # Page of group results to fetch. Page is 1-indexed.
     attr_accessor :page
 
-    # Page size is the number of chunks to fetch. This can be used to fetch more than 10 chunks at a time.
+    # Page size is the number of group results to fetch. The default is 10.
     attr_accessor :page_size
 
     # 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
 
-    # Turn on quote words and negated words to search for exact phrases and exclude words from the search results. Default is false.
-    attr_accessor :quote_negated_words
-
     # Set score_threshold to a float to filter out chunks with a score below the threshold.
     attr_accessor :score_threshold
 
@@ -60,7 +58,6 @@ module TrieveRubyClient
         :'page' => :'page',
         :'page_size' => :'page_size',
         :'query' => :'query',
-        :'quote_negated_words' => :'quote_negated_words',
         :'score_threshold' => :'score_threshold',
         :'search_type' => :'search_type',
         :'slim_chunks' => :'slim_chunks'
@@ -83,7 +80,6 @@ module TrieveRubyClient
         :'page' => :'Integer',
         :'page_size' => :'Integer',
         :'query' => :'String',
-        :'quote_negated_words' => :'Boolean',
         :'score_threshold' => :'Float',
         :'search_type' => :'String',
         :'slim_chunks' => :'Boolean'
@@ -100,7 +96,6 @@ module TrieveRubyClient
         :'highlight_results',
         :'page',
         :'page_size',
-        :'quote_negated_words',
         :'score_threshold',
         :'slim_chunks'
       ])
@@ -157,10 +152,6 @@ module TrieveRubyClient
         self.query = nil
       end
 
-      if attributes.key?(:'quote_negated_words')
-        self.quote_negated_words = attributes[:'quote_negated_words']
-      end
-
       if attributes.key?(:'score_threshold')
         self.score_threshold = attributes[:'score_threshold']
       end
@@ -259,7 +250,6 @@ module TrieveRubyClient
           page == o.page &&
           page_size == o.page_size &&
           query == o.query &&
-          quote_negated_words == o.quote_negated_words &&
           score_threshold == o.score_threshold &&
           search_type == o.search_type &&
           slim_chunks == o.slim_chunks
@@ -274,7 +264,7 @@ module TrieveRubyClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [filters, get_collisions, group_size, highlight_delimiters, highlight_results, page, page_size, query, quote_negated_words, score_threshold, search_type, slim_chunks].hash
+      [filters, get_collisions, group_size, highlight_delimiters, highlight_results, 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.5.7
+The version of the OpenAPI document: 0.6.0
 Contact: developers@trieve.ai
 Generated by: https://openapi-generator.tech
 Generator version: 7.4.0

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