trieve_ruby_client 0.8.2 → 0.11.0

data/lib/trieve_ruby_client/models/boost_phrase.rb

@@ -0,0 +1,240 @@
+=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
+  # Boost is useful for when you want to boost certain phrases in the fulltext search results for official listings. I.e. making sure that the listing for AirBNB itself ranks higher than companies who make software for AirBNB hosts by boosting the AirBNB token for its official listing.
+  class BoostPhrase
+    # Amount to multiplicatevly increase the frequency of the tokens in the phrase by
+    attr_accessor :boost_factor
+
+    # The phrase to boost in the fulltext document frequency index
+    attr_accessor :phrase
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'boost_factor' => :'boost_factor',
+        :'phrase' => :'phrase'
+      }
+    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
+      {
+        :'boost_factor' => :'Float',
+        :'phrase' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    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::BoostPhrase` 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::BoostPhrase`. 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?(:'boost_factor')
+        self.boost_factor = attributes[:'boost_factor']
+      else
+        self.boost_factor = nil
+      end
+
+      if attributes.key?(:'phrase')
+        self.phrase = attributes[:'phrase']
+      else
+        self.phrase = 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 @boost_factor.nil?
+        invalid_properties.push('invalid value for "boost_factor", boost_factor cannot be nil.')
+      end
+
+      if @phrase.nil?
+        invalid_properties.push('invalid value for "phrase", phrase 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 @boost_factor.nil?
+      return false if @phrase.nil?
+      true
+    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 &&
+          boost_factor == o.boost_factor &&
+          phrase == o.phrase
+    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
+      [boost_factor, phrase].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/chat_message_proxy.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
@@ -19,6 +19,28 @@ module TrieveRubyClient
 
     attr_accessor :role
 
+    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
       {
@@ -36,7 +58,7 @@ module TrieveRubyClient
     def self.openapi_types
       {
         :'content' => :'String',
-        :'role' => :'String'
+        :'role' => :'RoleProxy'
       }
     end
 

data/lib/trieve_ruby_client/models/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
@@ -30,6 +30,9 @@ module TrieveRubyClient
     # Group tracking_ids are the tracking_ids of the groups that the chunk should be placed into. This is useful for when you want to create a chunk and add it to a group or multiple groups in one request. Necessary because this route queues the chunk for ingestion and the chunk may not exist yet immediately after response.
     attr_accessor :group_tracking_ids
 
+    # Image urls are a list of urls to images that are associated with the chunk. This is useful for when you want to associate images with a chunk.
+    attr_accessor :image_urls
+
     # Link to the chunk. This can also be any string. Frequently, this is a link to the source of the chunk. The link value will not affect the embedding creation.
     attr_accessor :link
 
@@ -64,6 +67,7 @@ module TrieveRubyClient
         :'convert_html_to_text' => :'convert_html_to_text',
         :'group_ids' => :'group_ids',
         :'group_tracking_ids' => :'group_tracking_ids',
+        :'image_urls' => :'image_urls',
         :'link' => :'link',
         :'location' => :'location',
         :'metadata' => :'metadata',
@@ -89,6 +93,7 @@ module TrieveRubyClient
         :'convert_html_to_text' => :'Boolean',
         :'group_ids' => :'Array<String>',
         :'group_tracking_ids' => :'Array<String>',
+        :'image_urls' => :'Array<String>',
         :'link' => :'String',
         :'location' => :'GeoInfo',
         :'metadata' => :'Object',
@@ -104,10 +109,12 @@ module TrieveRubyClient
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'chunk_html',
         :'chunk_vector',
         :'convert_html_to_text',
         :'group_ids',
         :'group_tracking_ids',
+        :'image_urls',
         :'link',
         :'location',
         :'metadata',
@@ -137,8 +144,6 @@ module TrieveRubyClient
 
       if attributes.key?(:'chunk_html')
         self.chunk_html = attributes[:'chunk_html']
-      else
-        self.chunk_html = nil
       end
 
       if attributes.key?(:'chunk_vector')
@@ -163,6 +168,12 @@ module TrieveRubyClient
         end
       end
 
+      if attributes.key?(:'image_urls')
+        if (value = attributes[:'image_urls']).is_a?(Array)
+          self.image_urls = value
+        end
+      end
+
       if attributes.key?(:'link')
         self.link = attributes[:'link']
       end
@@ -207,10 +218,6 @@ module TrieveRubyClient
     def list_invalid_properties
       warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
-      if @chunk_html.nil?
-        invalid_properties.push('invalid value for "chunk_html", chunk_html cannot be nil.')
-      end
-
       invalid_properties
     end
 
@@ -218,7 +225,6 @@ module TrieveRubyClient
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
-      return false if @chunk_html.nil?
       true
     end
 
@@ -232,6 +238,7 @@ module TrieveRubyClient
           convert_html_to_text == o.convert_html_to_text &&
           group_ids == o.group_ids &&
           group_tracking_ids == o.group_tracking_ids &&
+          image_urls == o.image_urls &&
           link == o.link &&
           location == o.location &&
           metadata == o.metadata &&
@@ -252,7 +259,7 @@ module TrieveRubyClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [chunk_html, chunk_vector, convert_html_to_text, group_ids, group_tracking_ids, link, location, metadata, split_avg, tag_set, time_stamp, tracking_id, upsert_by_tracking_id, weight].hash
+      [chunk_html, chunk_vector, convert_html_to_text, group_ids, group_tracking_ids, image_urls, link, location, metadata, split_avg, tag_set, time_stamp, tracking_id, upsert_by_tracking_id, weight].hash
     end
 
     # Builds the object from hash

data/lib/trieve_ruby_client/models/chunk_filter.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,6 +15,9 @@ require 'time'
 
 module TrieveRubyClient
   class ChunkFilter
+    # JOSNB prefilter tells the server to perform a full scan over the metadata JSONB column instead of using the filtered HNSW. Datasets on the enterprise plan with custom metadata indices will perform better with the filtered HNSW instead. When false, the server will use the filtered HNSW index to filter chunks. When true, the server will perform a full scan over the metadata JSONB column to filter chunks. Default is true.
+    attr_accessor :jsonb_prefilter
+
     # All of these field conditions have to match for the chunk to be included in the result set.
     attr_accessor :must
 
@@ -27,6 +30,7 @@ module TrieveRubyClient
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'jsonb_prefilter' => :'jsonb_prefilter',
         :'must' => :'must',
         :'must_not' => :'must_not',
         :'should' => :'should'
@@ -41,15 +45,17 @@ module TrieveRubyClient
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'must' => :'Array<FieldCondition>',
-        :'must_not' => :'Array<FieldCondition>',
-        :'should' => :'Array<FieldCondition>'
+        :'jsonb_prefilter' => :'Boolean',
+        :'must' => :'Array<ConditionType>',
+        :'must_not' => :'Array<ConditionType>',
+        :'should' => :'Array<ConditionType>'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'jsonb_prefilter',
         :'must',
         :'must_not',
         :'should'
@@ -71,6 +77,10 @@ module TrieveRubyClient
         h[k.to_sym] = v
       }
 
+      if attributes.key?(:'jsonb_prefilter')
+        self.jsonb_prefilter = attributes[:'jsonb_prefilter']
+      end
+
       if attributes.key?(:'must')
         if (value = attributes[:'must']).is_a?(Array)
           self.must = value
@@ -110,6 +120,7 @@ module TrieveRubyClient
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          jsonb_prefilter == o.jsonb_prefilter &&
           must == o.must &&
           must_not == o.must_not &&
           should == o.should
@@ -124,7 +135,7 @@ module TrieveRubyClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [must, must_not, should].hash
+      [jsonb_prefilter, must, must_not, should].hash
     end
 
     # Builds the object from hash

data/lib/trieve_ruby_client/models/chunk_group.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
@@ -62,7 +62,7 @@ module TrieveRubyClient
         :'id' => :'String',
         :'metadata' => :'Object',
         :'name' => :'String',
-        :'tag_set' => :'String',
+        :'tag_set' => :'Array<String>',
         :'tracking_id' => :'String',
         :'updated_at' => :'Time'
       }
@@ -127,7 +127,9 @@ module TrieveRubyClient
       end
 
       if attributes.key?(:'tag_set')
-        self.tag_set = attributes[:'tag_set']
+        if (value = attributes[:'tag_set']).is_a?(Array)
+          self.tag_set = value
+        end
       end
 
       if attributes.key?(:'tracking_id')

data/lib/trieve_ruby_client/models/chunk_group_and_file.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.10.7
 Contact: developers@trieve.ai
 Generated by: https://openapi-generator.tech
 Generator version: 7.4.0