trieve_ruby_client 0.8.2 → 0.11.0

data/lib/trieve_ruby_client/models/chunk_req_payload.rb

@@ -0,0 +1,397 @@
+=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
+  class ChunkReqPayload
+    attr_accessor :boost_phrase
+
+    # HTML content of the chunk. 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.
+    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
+
+    attr_accessor :distance_phrase
+
+    # Group ids are the 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_ids
+
+    # 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
+
+    attr_accessor :location
+
+    # Metadata is a JSON object which can be used to filter chunks. This is useful for when you want to filter chunks by arbitrary metadata. Unlike with tag filtering, there is a performance hit for filtering on metadata.
+    attr_accessor :metadata
+
+    # Num value is an arbitrary numerical value that can be used to filter chunks. This is useful for when you want to filter chunks by numerical value. There is no performance hit for filtering on num_value.
+    attr_accessor :num_value
+
+    # Split avg is a boolean which tells the server to split the text in the chunk_html into smaller chunks and average their resulting vectors. This is useful for when you want to create a chunk from a large piece of text and want to split it into smaller chunks to create a more fuzzy average dense vector. The sparse vector will be generated normally with no averaging. By default this is false.
+    attr_accessor :split_avg
+
+    # Tag set is a list of tags. This can be used to filter chunks by tag. Unlike with metadata filtering, HNSW indices will exist for each tag such that there is not a performance hit for filtering on them.
+    attr_accessor :tag_set
+
+    # Time_stamp should be an ISO 8601 combined date and time without timezone. It is used for time window filtering and recency-biasing search results.
+    attr_accessor :time_stamp
+
+    # Tracking_id is a string which can be used to identify a chunk. This is useful for when you are coordinating with an external system and want to use the tracking_id to identify the chunk.
+    attr_accessor :tracking_id
+
+    # Upsert when a chunk with the same tracking_id exists. By default this is false, and the request will fail if a chunk with the same tracking_id exists. If this is true, the chunk will be updated if a chunk with the same tracking_id exists.
+    attr_accessor :upsert_by_tracking_id
+
+    # Weight is a float which can be used to bias search results. This is useful for when you want to bias search results for a chunk. The magnitude only matters relative to other chunks in the chunk's dataset dataset.
+    attr_accessor :weight
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'boost_phrase' => :'boost_phrase',
+        :'chunk_html' => :'chunk_html',
+        :'convert_html_to_text' => :'convert_html_to_text',
+        :'distance_phrase' => :'distance_phrase',
+        :'group_ids' => :'group_ids',
+        :'group_tracking_ids' => :'group_tracking_ids',
+        :'image_urls' => :'image_urls',
+        :'link' => :'link',
+        :'location' => :'location',
+        :'metadata' => :'metadata',
+        :'num_value' => :'num_value',
+        :'split_avg' => :'split_avg',
+        :'tag_set' => :'tag_set',
+        :'time_stamp' => :'time_stamp',
+        :'tracking_id' => :'tracking_id',
+        :'upsert_by_tracking_id' => :'upsert_by_tracking_id',
+        :'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
+      {
+        :'boost_phrase' => :'BoostPhrase',
+        :'chunk_html' => :'String',
+        :'convert_html_to_text' => :'Boolean',
+        :'distance_phrase' => :'DistancePhrase',
+        :'group_ids' => :'Array<String>',
+        :'group_tracking_ids' => :'Array<String>',
+        :'image_urls' => :'Array<String>',
+        :'link' => :'String',
+        :'location' => :'GeoInfo',
+        :'metadata' => :'Object',
+        :'num_value' => :'Float',
+        :'split_avg' => :'Boolean',
+        :'tag_set' => :'Array<String>',
+        :'time_stamp' => :'String',
+        :'tracking_id' => :'String',
+        :'upsert_by_tracking_id' => :'Boolean',
+        :'weight' => :'Float'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'boost_phrase',
+        :'chunk_html',
+        :'convert_html_to_text',
+        :'distance_phrase',
+        :'group_ids',
+        :'group_tracking_ids',
+        :'image_urls',
+        :'link',
+        :'location',
+        :'metadata',
+        :'num_value',
+        :'split_avg',
+        :'tag_set',
+        :'time_stamp',
+        :'tracking_id',
+        :'upsert_by_tracking_id',
+        :'weight'
+      ])
+    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::ChunkReqPayload` 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::ChunkReqPayload`. 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_phrase')
+        self.boost_phrase = attributes[:'boost_phrase']
+      end
+
+      if attributes.key?(:'chunk_html')
+        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?(:'distance_phrase')
+        self.distance_phrase = attributes[:'distance_phrase']
+      end
+
+      if attributes.key?(:'group_ids')
+        if (value = attributes[:'group_ids']).is_a?(Array)
+          self.group_ids = value
+        end
+      end
+
+      if attributes.key?(:'group_tracking_ids')
+        if (value = attributes[:'group_tracking_ids']).is_a?(Array)
+          self.group_tracking_ids = value
+        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
+
+      if attributes.key?(:'location')
+        self.location = attributes[:'location']
+      end
+
+      if attributes.key?(:'metadata')
+        self.metadata = attributes[:'metadata']
+      end
+
+      if attributes.key?(:'num_value')
+        self.num_value = attributes[:'num_value']
+      end
+
+      if attributes.key?(:'split_avg')
+        self.split_avg = attributes[:'split_avg']
+      end
+
+      if attributes.key?(:'tag_set')
+        if (value = attributes[:'tag_set']).is_a?(Array)
+          self.tag_set = value
+        end
+      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?(:'upsert_by_tracking_id')
+        self.upsert_by_tracking_id = attributes[:'upsert_by_tracking_id']
+      end
+
+      if attributes.key?(:'weight')
+        self.weight = attributes[:'weight']
+      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
+      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'
+      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_phrase == o.boost_phrase &&
+          chunk_html == o.chunk_html &&
+          convert_html_to_text == o.convert_html_to_text &&
+          distance_phrase == o.distance_phrase &&
+          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 &&
+          num_value == o.num_value &&
+          split_avg == o.split_avg &&
+          tag_set == o.tag_set &&
+          time_stamp == o.time_stamp &&
+          tracking_id == o.tracking_id &&
+          upsert_by_tracking_id == o.upsert_by_tracking_id &&
+          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
+      [boost_phrase, chunk_html, convert_html_to_text, distance_phrase, group_ids, group_tracking_ids, image_urls, link, location, metadata, num_value, split_avg, tag_set, time_stamp, tracking_id, upsert_by_tracking_id, 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/chunk_return_types.rb

@@ -0,0 +1,105 @@
+=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 ChunkReturnTypes
+    class << self
+      # List of class defined in oneOf (OpenAPI v3)
+      def openapi_one_of
+        [
+          :'ChunkMetadata',
+          :'ChunkMetadataStringTagSet'
+        ]
+      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/client_dataset_configuration.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
@@ -27,8 +27,6 @@ module TrieveRubyClient
 
     attr_accessor :frontmatter_vals
 
-    attr_accessor :image_metadata_key
-
     attr_accessor :image_range_end_key
 
     attr_accessor :image_range_start_key
@@ -48,7 +46,6 @@ module TrieveRubyClient
         :'file_name_key' => :'FILE_NAME_KEY',
         :'filter_items' => :'FILTER_ITEMS',
         :'frontmatter_vals' => :'FRONTMATTER_VALS',
-        :'image_metadata_key' => :'IMAGE_METADATA_KEY',
         :'image_range_end_key' => :'IMAGE_RANGE_END_KEY',
         :'image_range_start_key' => :'IMAGE_RANGE_START_KEY',
         :'lines_before_show_more' => :'LINES_BEFORE_SHOW_MORE',
@@ -71,7 +68,6 @@ module TrieveRubyClient
         :'file_name_key' => :'String',
         :'filter_items' => :'Object',
         :'frontmatter_vals' => :'String',
-        :'image_metadata_key' => :'String',
         :'image_range_end_key' => :'String',
         :'image_range_start_key' => :'String',
         :'lines_before_show_more' => :'Integer',
@@ -137,12 +133,6 @@ module TrieveRubyClient
         self.frontmatter_vals = attributes[:'frontmatter_vals']
       end
 
-      if attributes.key?(:'image_metadata_key')
-        self.image_metadata_key = attributes[:'image_metadata_key']
-      else
-        self.image_metadata_key = nil
-      end
-
       if attributes.key?(:'image_range_end_key')
         self.image_range_end_key = attributes[:'image_range_end_key']
       end
@@ -173,10 +163,6 @@ module TrieveRubyClient
         invalid_properties.push('invalid value for "file_name_key", file_name_key cannot be nil.')
       end
 
-      if @image_metadata_key.nil?
-        invalid_properties.push('invalid value for "image_metadata_key", image_metadata_key cannot be nil.')
-      end
-
       if !@lines_before_show_more.nil? && @lines_before_show_more < 0
         invalid_properties.push('invalid value for "lines_before_show_more", must be greater than or equal to 0.')
       end
@@ -189,7 +175,6 @@ module TrieveRubyClient
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
       return false if @file_name_key.nil?
-      return false if @image_metadata_key.nil?
       return false if !@lines_before_show_more.nil? && @lines_before_show_more < 0
       true
     end
@@ -215,7 +200,6 @@ module TrieveRubyClient
           file_name_key == o.file_name_key &&
           filter_items == o.filter_items &&
           frontmatter_vals == o.frontmatter_vals &&
-          image_metadata_key == o.image_metadata_key &&
           image_range_end_key == o.image_range_end_key &&
           image_range_start_key == o.image_range_start_key &&
           lines_before_show_more == o.lines_before_show_more &&
@@ -232,7 +216,7 @@ module TrieveRubyClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [create_chunk_feature, date_range_value, document_upload_feature, file_name_key, filter_items, frontmatter_vals, image_metadata_key, image_range_end_key, image_range_start_key, lines_before_show_more, search_queries, suggested_queries].hash
+      [create_chunk_feature, date_range_value, document_upload_feature, file_name_key, filter_items, frontmatter_vals, image_range_end_key, image_range_start_key, lines_before_show_more, search_queries, suggested_queries].hash
     end
 
     # Builds the object from hash

data/lib/trieve_ruby_client/models/cluster_analytics.rb

@@ -0,0 +1,43 @@
+=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 ClusterAnalytics
+    class << self
+      # List of class defined in oneOf (OpenAPI v3)
+      def openapi_one_of
+        [
+          :'ClusterQueries',
+          :'ClusterTopics'
+        ]
+      end
+
+      # Discriminator's property name (OpenAPI v3)
+      def openapi_discriminator_name
+        :'type'
+      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)
+        discriminator_value = data[openapi_discriminator_name]
+        return nil if discriminator_value.nil?
+        TrieveRubyClient.const_get(discriminator_value).build_from_hash(data)
+      end
+    end
+  end
+
+end