trieve_ruby_client 0.8.2 → 0.10.7

data/lib/trieve_ruby_client/models/upload_file_req_payload.rb

@@ -0,0 +1,368 @@
+=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.10.7
+Contact: developers@trieve.ai
+Generated by: https://openapi-generator.tech
+Generator version: 7.4.0
+
+=end
+
+require 'date'
+require 'time'
+
+module TrieveRubyClient
+  class UploadFileReqPayload
+    # Base64 encoded file. This is the standard base64url encoding.
+    attr_accessor :base64_file
+
+    # Create chunks is a boolean which determines whether or not to create chunks from the file. If false, you can manually chunk the file and send the chunks to the create_chunk endpoint with the file_id to associate chunks with the file. Meant mostly for advanced users.
+    attr_accessor :create_chunks
+
+    # Description is an optional convience field so you do not have to remember what the file contains or is about. It will be included on the group resulting from the file which will hold its chunk.
+    attr_accessor :description
+
+    # Name of the file being uploaded, including the extension.
+    attr_accessor :file_name
+
+    # Group tracking id is an optional field which allows you to specify the tracking id of the group that is created from the file. Chunks created will be created with the tracking id of `group_tracking_id|<index of chunk>`
+    attr_accessor :group_tracking_id
+
+    # Link to the file. This can also be any string. This can be used to filter when searching for the file's resulting chunks. The link value will not affect embedding creation.
+    attr_accessor :link
+
+    # 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. Will be passed down to the file's chunks.
+    attr_accessor :metadata
+
+    # Rebalance chunks is an optional field which allows you to specify whether or not to rebalance the chunks created from the file. If not specified, the default true is used. If true, Trieve will evenly distribute remainder splits across chunks such that 66 splits with a `target_splits_per_chunk` of 20 will result in 3 chunks with 22 splits each.
+    attr_accessor :rebalance_chunks
+
+    # Split delimiters is an optional field which allows you to specify the delimiters to use when splitting the file before chunking the text. If not specified, the default [.!?\\n] are used to split into sentences. However, you may want to use spaces or other delimiters.
+    attr_accessor :split_delimiters
+
+    # Tag set is a comma separated list of tags which will be passed down to the chunks made from the file. Tags are used to filter chunks when searching. HNSW indices are created for each tag such that there is no performance loss when filtering on them.
+    attr_accessor :tag_set
+
+    # Target splits per chunk. This is an optional field which allows you to specify the number of splits you want per chunk. If not specified, the default 20 is used. However, you may want to use a different number.
+    attr_accessor :target_splits_per_chunk
+
+    # Time stamp should be an ISO 8601 combined date and time without timezone. Time_stamp is used for time window filtering and recency-biasing search results. Will be passed down to the file's chunks.
+    attr_accessor :time_stamp
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'base64_file' => :'base64_file',
+        :'create_chunks' => :'create_chunks',
+        :'description' => :'description',
+        :'file_name' => :'file_name',
+        :'group_tracking_id' => :'group_tracking_id',
+        :'link' => :'link',
+        :'metadata' => :'metadata',
+        :'rebalance_chunks' => :'rebalance_chunks',
+        :'split_delimiters' => :'split_delimiters',
+        :'tag_set' => :'tag_set',
+        :'target_splits_per_chunk' => :'target_splits_per_chunk',
+        :'time_stamp' => :'time_stamp'
+      }
+    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
+      {
+        :'base64_file' => :'String',
+        :'create_chunks' => :'Boolean',
+        :'description' => :'String',
+        :'file_name' => :'String',
+        :'group_tracking_id' => :'String',
+        :'link' => :'String',
+        :'metadata' => :'Object',
+        :'rebalance_chunks' => :'Boolean',
+        :'split_delimiters' => :'Array<String>',
+        :'tag_set' => :'Array<String>',
+        :'target_splits_per_chunk' => :'Integer',
+        :'time_stamp' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'create_chunks',
+        :'description',
+        :'group_tracking_id',
+        :'link',
+        :'metadata',
+        :'rebalance_chunks',
+        :'split_delimiters',
+        :'tag_set',
+        :'target_splits_per_chunk',
+        :'time_stamp'
+      ])
+    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::UploadFileReqPayload` 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::UploadFileReqPayload`. 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?(:'base64_file')
+        self.base64_file = attributes[:'base64_file']
+      else
+        self.base64_file = nil
+      end
+
+      if attributes.key?(:'create_chunks')
+        self.create_chunks = attributes[:'create_chunks']
+      end
+
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      end
+
+      if attributes.key?(:'file_name')
+        self.file_name = attributes[:'file_name']
+      else
+        self.file_name = nil
+      end
+
+      if attributes.key?(:'group_tracking_id')
+        self.group_tracking_id = attributes[:'group_tracking_id']
+      end
+
+      if attributes.key?(:'link')
+        self.link = attributes[:'link']
+      end
+
+      if attributes.key?(:'metadata')
+        self.metadata = attributes[:'metadata']
+      end
+
+      if attributes.key?(:'rebalance_chunks')
+        self.rebalance_chunks = attributes[:'rebalance_chunks']
+      end
+
+      if attributes.key?(:'split_delimiters')
+        if (value = attributes[:'split_delimiters']).is_a?(Array)
+          self.split_delimiters = value
+        end
+      end
+
+      if attributes.key?(:'tag_set')
+        if (value = attributes[:'tag_set']).is_a?(Array)
+          self.tag_set = value
+        end
+      end
+
+      if attributes.key?(:'target_splits_per_chunk')
+        self.target_splits_per_chunk = attributes[:'target_splits_per_chunk']
+      end
+
+      if attributes.key?(:'time_stamp')
+        self.time_stamp = attributes[:'time_stamp']
+      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 @base64_file.nil?
+        invalid_properties.push('invalid value for "base64_file", base64_file cannot be nil.')
+      end
+
+      if @file_name.nil?
+        invalid_properties.push('invalid value for "file_name", file_name cannot be nil.')
+      end
+
+      if !@target_splits_per_chunk.nil? && @target_splits_per_chunk < 0
+        invalid_properties.push('invalid value for "target_splits_per_chunk", 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 @base64_file.nil?
+      return false if @file_name.nil?
+      return false if !@target_splits_per_chunk.nil? && @target_splits_per_chunk < 0
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] target_splits_per_chunk Value to be assigned
+    def target_splits_per_chunk=(target_splits_per_chunk)
+      if !target_splits_per_chunk.nil? && target_splits_per_chunk < 0
+        fail ArgumentError, 'invalid value for "target_splits_per_chunk", must be greater than or equal to 0.'
+      end
+
+      @target_splits_per_chunk = target_splits_per_chunk
+    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 &&
+          base64_file == o.base64_file &&
+          create_chunks == o.create_chunks &&
+          description == o.description &&
+          file_name == o.file_name &&
+          group_tracking_id == o.group_tracking_id &&
+          link == o.link &&
+          metadata == o.metadata &&
+          rebalance_chunks == o.rebalance_chunks &&
+          split_delimiters == o.split_delimiters &&
+          tag_set == o.tag_set &&
+          target_splits_per_chunk == o.target_splits_per_chunk &&
+          time_stamp == o.time_stamp
+    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
+      [base64_file, create_chunks, description, file_name, group_tracking_id, link, metadata, rebalance_chunks, split_delimiters, tag_set, target_splits_per_chunk, time_stamp].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/upload_file_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.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

data/lib/trieve_ruby_client/models/user_organization.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

data/lib/trieve_ruby_client/version.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
@@ -11,5 +11,5 @@ Generator version: 7.4.0
 =end
 
 module TrieveRubyClient
-  VERSION = '0.8.2'
+  VERSION = '0.10.7'
 end

data/lib/trieve_ruby_client.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
@@ -18,32 +18,39 @@ require 'trieve_ruby_client/configuration'
 
 # Models
 require 'trieve_ruby_client/models/add_chunk_to_group_data'
-require 'trieve_ruby_client/models/api_key_dto'
+require 'trieve_ruby_client/models/api_key_resp_body'
 require 'trieve_ruby_client/models/auth_query'
+require 'trieve_ruby_client/models/autocomplete_req_payload'
 require 'trieve_ruby_client/models/batch_queued_chunk_response'
 require 'trieve_ruby_client/models/bookmark_data'
 require 'trieve_ruby_client/models/bookmark_group_result'
+require 'trieve_ruby_client/models/boost_phrase'
 require 'trieve_ruby_client/models/chat_message_proxy'
-require 'trieve_ruby_client/models/chunk_data'
 require 'trieve_ruby_client/models/chunk_filter'
 require 'trieve_ruby_client/models/chunk_group'
 require 'trieve_ruby_client/models/chunk_group_and_file'
 require 'trieve_ruby_client/models/chunk_metadata'
+require 'trieve_ruby_client/models/chunk_metadata_string_tag_set'
+require 'trieve_ruby_client/models/chunk_metadata_types'
 require 'trieve_ruby_client/models/chunk_metadata_with_score'
+require 'trieve_ruby_client/models/chunk_req_payload'
 require 'trieve_ruby_client/models/client_dataset_configuration'
-require 'trieve_ruby_client/models/create_chunk_data'
-require 'trieve_ruby_client/models/create_chunk_group_data'
+require 'trieve_ruby_client/models/condition_type'
+require 'trieve_ruby_client/models/content_chunk_metadata'
+require 'trieve_ruby_client/models/create_chunk_group_req_payload'
+require 'trieve_ruby_client/models/create_chunk_req_payload_enum'
 require 'trieve_ruby_client/models/create_dataset_request'
-require 'trieve_ruby_client/models/create_message_data'
+require 'trieve_ruby_client/models/create_message_req_payload'
 require 'trieve_ruby_client/models/create_organization_data'
-require 'trieve_ruby_client/models/create_topic_data'
+require 'trieve_ruby_client/models/create_topic_req_payload'
 require 'trieve_ruby_client/models/dataset'
 require 'trieve_ruby_client/models/dataset_and_usage'
 require 'trieve_ruby_client/models/dataset_dto'
 require 'trieve_ruby_client/models/dataset_usage_count'
+require 'trieve_ruby_client/models/date_range'
 require 'trieve_ruby_client/models/delete_topic_data'
 require 'trieve_ruby_client/models/delete_user_api_key_request'
-require 'trieve_ruby_client/models/edit_message_data'
+require 'trieve_ruby_client/models/edit_message_req_payload'
 require 'trieve_ruby_client/models/error_response_body'
 require 'trieve_ruby_client/models/event'
 require 'trieve_ruby_client/models/event_return'
@@ -54,12 +61,13 @@ require 'trieve_ruby_client/models/generate_chunks_request'
 require 'trieve_ruby_client/models/geo_info'
 require 'trieve_ruby_client/models/geo_types'
 require 'trieve_ruby_client/models/get_chunks_data'
+require 'trieve_ruby_client/models/get_datasets_pagination'
 require 'trieve_ruby_client/models/get_events_data'
 require 'trieve_ruby_client/models/get_groups_for_chunks_data'
 require 'trieve_ruby_client/models/get_tracking_chunks_data'
 require 'trieve_ruby_client/models/group_data'
 require 'trieve_ruby_client/models/group_score_chunk'
-require 'trieve_ruby_client/models/group_score_slim_chunks'
+require 'trieve_ruby_client/models/has_id_condition'
 require 'trieve_ruby_client/models/invitation_data'
 require 'trieve_ruby_client/models/location_bounding_box'
 require 'trieve_ruby_client/models/location_polygon'
@@ -72,19 +80,16 @@ require 'trieve_ruby_client/models/range'
 require 'trieve_ruby_client/models/range_condition'
 require 'trieve_ruby_client/models/recommend_chunks_request'
 require 'trieve_ruby_client/models/recommend_group_chunks_request'
-require 'trieve_ruby_client/models/regenerate_message_data'
+require 'trieve_ruby_client/models/regenerate_message_req_payload'
+require 'trieve_ruby_client/models/remove_chunk_from_group_req_payload'
 require 'trieve_ruby_client/models/return_queued_chunk'
 require 'trieve_ruby_client/models/score_chunk_dto'
-require 'trieve_ruby_client/models/score_slim_chunks'
-require 'trieve_ruby_client/models/search_chunk_data'
 require 'trieve_ruby_client/models/search_chunk_query_response_body'
+require 'trieve_ruby_client/models/search_chunks_req_payload'
 require 'trieve_ruby_client/models/search_over_groups_data'
 require 'trieve_ruby_client/models/search_over_groups_results'
-require 'trieve_ruby_client/models/search_over_groups_slim_results'
-require 'trieve_ruby_client/models/search_slim_chunk_query_response_body'
 require 'trieve_ruby_client/models/search_within_group_data'
 require 'trieve_ruby_client/models/search_within_group_results'
-require 'trieve_ruby_client/models/search_within_group_slim_results'
 require 'trieve_ruby_client/models/set_user_api_key_request'
 require 'trieve_ruby_client/models/set_user_api_key_response'
 require 'trieve_ruby_client/models/single_queued_chunk_response'
@@ -93,18 +98,18 @@ require 'trieve_ruby_client/models/slim_chunk_metadata_with_score'
 require 'trieve_ruby_client/models/slim_group'
 require 'trieve_ruby_client/models/slim_user'
 require 'trieve_ruby_client/models/stripe_plan'
-require 'trieve_ruby_client/models/suggested_queries_request'
+require 'trieve_ruby_client/models/suggested_queries_req_payload'
 require 'trieve_ruby_client/models/suggested_queries_response'
 require 'trieve_ruby_client/models/topic'
 require 'trieve_ruby_client/models/update_chunk_by_tracking_id_data'
-require 'trieve_ruby_client/models/update_chunk_data'
 require 'trieve_ruby_client/models/update_chunk_group_data'
+require 'trieve_ruby_client/models/update_chunk_req_payload'
 require 'trieve_ruby_client/models/update_dataset_request'
-require 'trieve_ruby_client/models/update_group_by_tracking_id_data'
+require 'trieve_ruby_client/models/update_group_by_tracking_id_req_payload'
 require 'trieve_ruby_client/models/update_organization_data'
-require 'trieve_ruby_client/models/update_topic_data'
+require 'trieve_ruby_client/models/update_topic_req_payload'
 require 'trieve_ruby_client/models/update_user_org_role_data'
-require 'trieve_ruby_client/models/upload_file_data'
+require 'trieve_ruby_client/models/upload_file_req_payload'
 require 'trieve_ruby_client/models/upload_file_result'
 require 'trieve_ruby_client/models/user_organization'
 

data/openapi-generator.yaml

@@ -5,5 +5,5 @@ gemHomepage: "https://trieve.ai"
 gemLicense: "MIT"
 gemName: "trieve_ruby_client"
 gemSummary: "Trieve Ruby API client"
-gemVersion: "0.8.2"
+gemVersion: "0.10.7"
 moduleName: "TrieveRubyClient"