trieve_ruby_client 0.6.0 → 0.6.7

data/lib/trieve_ruby_client/models/slim_chunk_metadata_with_score.rb

@@ -0,0 +1,345 @@
+=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.7
+Contact: developers@trieve.ai
+Generated by: https://openapi-generator.tech
+Generator version: 7.4.0
+
+=end
+
+require 'date'
+require 'time'
+
+module TrieveRubyClient
+  class SlimChunkMetadataWithScore
+    attr_accessor :created_at
+
+    attr_accessor :id
+
+    attr_accessor :link
+
+    attr_accessor :metadata
+
+    attr_accessor :qdrant_point_id
+
+    attr_accessor :score
+
+    attr_accessor :tag_set
+
+    attr_accessor :time_stamp
+
+    attr_accessor :tracking_id
+
+    attr_accessor :updated_at
+
+    attr_accessor :weight
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'created_at' => :'created_at',
+        :'id' => :'id',
+        :'link' => :'link',
+        :'metadata' => :'metadata',
+        :'qdrant_point_id' => :'qdrant_point_id',
+        :'score' => :'score',
+        :'tag_set' => :'tag_set',
+        :'time_stamp' => :'time_stamp',
+        :'tracking_id' => :'tracking_id',
+        :'updated_at' => :'updated_at',
+        :'weight' => :'weight'
+      }
+    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
+      {
+        :'created_at' => :'Time',
+        :'id' => :'String',
+        :'link' => :'String',
+        :'metadata' => :'Object',
+        :'qdrant_point_id' => :'String',
+        :'score' => :'Float',
+        :'tag_set' => :'String',
+        :'time_stamp' => :'Time',
+        :'tracking_id' => :'String',
+        :'updated_at' => :'Time',
+        :'weight' => :'Float'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'link',
+        :'metadata',
+        :'qdrant_point_id',
+        :'tag_set',
+        :'time_stamp',
+        :'tracking_id',
+      ])
+    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::SlimChunkMetadataWithScore` 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::SlimChunkMetadataWithScore`. 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?(:'created_at')
+        self.created_at = attributes[:'created_at']
+      else
+        self.created_at = nil
+      end
+
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
+      else
+        self.id = nil
+      end
+
+      if attributes.key?(:'link')
+        self.link = attributes[:'link']
+      end
+
+      if attributes.key?(:'metadata')
+        self.metadata = attributes[:'metadata']
+      end
+
+      if attributes.key?(:'qdrant_point_id')
+        self.qdrant_point_id = attributes[:'qdrant_point_id']
+      end
+
+      if attributes.key?(:'score')
+        self.score = attributes[:'score']
+      else
+        self.score = nil
+      end
+
+      if attributes.key?(:'tag_set')
+        self.tag_set = attributes[:'tag_set']
+      end
+
+      if attributes.key?(:'time_stamp')
+        self.time_stamp = attributes[:'time_stamp']
+      end
+
+      if attributes.key?(:'tracking_id')
+        self.tracking_id = attributes[:'tracking_id']
+      end
+
+      if attributes.key?(:'updated_at')
+        self.updated_at = attributes[:'updated_at']
+      else
+        self.updated_at = nil
+      end
+
+      if attributes.key?(:'weight')
+        self.weight = attributes[:'weight']
+      else
+        self.weight = 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 @created_at.nil?
+        invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
+      end
+
+      if @id.nil?
+        invalid_properties.push('invalid value for "id", id cannot be nil.')
+      end
+
+      if @score.nil?
+        invalid_properties.push('invalid value for "score", score cannot be nil.')
+      end
+
+      if @updated_at.nil?
+        invalid_properties.push('invalid value for "updated_at", updated_at cannot be nil.')
+      end
+
+      if @weight.nil?
+        invalid_properties.push('invalid value for "weight", weight 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 @created_at.nil?
+      return false if @id.nil?
+      return false if @score.nil?
+      return false if @updated_at.nil?
+      return false if @weight.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 &&
+          created_at == o.created_at &&
+          id == o.id &&
+          link == o.link &&
+          metadata == o.metadata &&
+          qdrant_point_id == o.qdrant_point_id &&
+          score == o.score &&
+          tag_set == o.tag_set &&
+          time_stamp == o.time_stamp &&
+          tracking_id == o.tracking_id &&
+          updated_at == o.updated_at &&
+          weight == o.weight
+    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
+      [created_at, id, link, metadata, qdrant_point_id, score, tag_set, time_stamp, tracking_id, updated_at, weight].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/slim_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.6.0
+The version of the OpenAPI document: 0.6.7
 Contact: developers@trieve.ai
 Generated by: https://openapi-generator.tech
 Generator version: 7.4.0

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

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

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

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

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

data/lib/trieve_ruby_client/models/update_chunk_by_tracking_id_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.6.0
+The version of the OpenAPI document: 0.6.7
 Contact: developers@trieve.ai
 Generated by: https://openapi-generator.tech
 Generator version: 7.4.0
@@ -18,6 +18,9 @@ module TrieveRubyClient
     # HTML content of the chunk you want to update. This can also be plaintext. The innerText of the HTML will be used to create the embedding vector. The point of using HTML is for convienience, as some users have applications where users submit HTML content. If no chunk_html is provided, the existing chunk_html will be used.
     attr_accessor :chunk_html
 
+    # Convert HTML to raw text before processing to avoid adding noise to the vector embeddings. By default this is true. If you are using HTML content that you want to be included in the vector embeddings, set this to false.
+    attr_accessor :convert_html_to_text
+
     # Group ids are the ids of the groups that the chunk should be placed into. This is useful for when you want to update a chunk and add it to a group or multiple groups in one request.
     attr_accessor :group_ids
 
@@ -43,6 +46,7 @@ module TrieveRubyClient
     def self.attribute_map
       {
         :'chunk_html' => :'chunk_html',
+        :'convert_html_to_text' => :'convert_html_to_text',
         :'group_ids' => :'group_ids',
         :'group_tracking_ids' => :'group_tracking_ids',
         :'link' => :'link',
@@ -62,6 +66,7 @@ module TrieveRubyClient
     def self.openapi_types
       {
         :'chunk_html' => :'String',
+        :'convert_html_to_text' => :'Boolean',
         :'group_ids' => :'Array<String>',
         :'group_tracking_ids' => :'Array<String>',
         :'link' => :'String',
@@ -76,6 +81,7 @@ module TrieveRubyClient
     def self.openapi_nullable
       Set.new([
         :'chunk_html',
+        :'convert_html_to_text',
         :'group_ids',
         :'group_tracking_ids',
         :'link',
@@ -104,6 +110,10 @@ module TrieveRubyClient
         self.chunk_html = attributes[:'chunk_html']
       end
 
+      if attributes.key?(:'convert_html_to_text')
+        self.convert_html_to_text = attributes[:'convert_html_to_text']
+      end
+
       if attributes.key?(:'group_ids')
         if (value = attributes[:'group_ids']).is_a?(Array)
           self.group_ids = value
@@ -165,6 +175,7 @@ module TrieveRubyClient
       return true if self.equal?(o)
       self.class == o.class &&
           chunk_html == o.chunk_html &&
+          convert_html_to_text == o.convert_html_to_text &&
           group_ids == o.group_ids &&
           group_tracking_ids == o.group_tracking_ids &&
           link == o.link &&
@@ -183,7 +194,7 @@ module TrieveRubyClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [chunk_html, group_ids, group_tracking_ids, link, metadata, time_stamp, tracking_id, weight].hash
+      [chunk_html, convert_html_to_text, group_ids, group_tracking_ids, link, metadata, time_stamp, tracking_id, weight].hash
     end
 
     # Builds the object from hash

data/lib/trieve_ruby_client/models/update_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.6.0
+The version of the OpenAPI document: 0.6.7
 Contact: developers@trieve.ai
 Generated by: https://openapi-generator.tech
 Generator version: 7.4.0
@@ -21,6 +21,9 @@ module TrieveRubyClient
     # Id of the chunk you want to update. You can provide either the chunk_id or the tracking_id. If both are provided, the chunk_id will be used.
     attr_accessor :chunk_id
 
+    # Convert HTML to raw text before processing to avoid adding noise to the vector embeddings. By default this is true. If you are using HTML content that you want to be included in the vector embeddings, set this to false.
+    attr_accessor :convert_html_to_text
+
     # Group ids are the ids of the groups that the chunk should be placed into. This is useful for when you want to update a chunk and add it to a group or multiple groups in one request.
     attr_accessor :group_ids
 
@@ -50,6 +53,7 @@ module TrieveRubyClient
       {
         :'chunk_html' => :'chunk_html',
         :'chunk_id' => :'chunk_id',
+        :'convert_html_to_text' => :'convert_html_to_text',
         :'group_ids' => :'group_ids',
         :'group_tracking_ids' => :'group_tracking_ids',
         :'link' => :'link',
@@ -71,6 +75,7 @@ module TrieveRubyClient
       {
         :'chunk_html' => :'String',
         :'chunk_id' => :'String',
+        :'convert_html_to_text' => :'Boolean',
         :'group_ids' => :'Array<String>',
         :'group_tracking_ids' => :'Array<String>',
         :'link' => :'String',
@@ -87,6 +92,7 @@ module TrieveRubyClient
       Set.new([
         :'chunk_html',
         :'chunk_id',
+        :'convert_html_to_text',
         :'group_ids',
         :'group_tracking_ids',
         :'link',
@@ -121,6 +127,10 @@ module TrieveRubyClient
         self.chunk_id = attributes[:'chunk_id']
       end
 
+      if attributes.key?(:'convert_html_to_text')
+        self.convert_html_to_text = attributes[:'convert_html_to_text']
+      end
+
       if attributes.key?(:'group_ids')
         if (value = attributes[:'group_ids']).is_a?(Array)
           self.group_ids = value
@@ -182,6 +192,7 @@ module TrieveRubyClient
       self.class == o.class &&
           chunk_html == o.chunk_html &&
           chunk_id == o.chunk_id &&
+          convert_html_to_text == o.convert_html_to_text &&
           group_ids == o.group_ids &&
           group_tracking_ids == o.group_tracking_ids &&
           link == o.link &&
@@ -201,7 +212,7 @@ module TrieveRubyClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [chunk_html, chunk_id, group_ids, group_tracking_ids, link, metadata, tag_set, time_stamp, tracking_id, weight].hash
+      [chunk_html, chunk_id, convert_html_to_text, group_ids, group_tracking_ids, link, metadata, tag_set, time_stamp, tracking_id, weight].hash
     end
 
     # Builds the object from hash

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

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

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

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

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

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