trieve_ruby_client 0.8.2 → 0.11.0

data/lib/trieve_ruby_client/models/field_condition.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,8 @@ require 'time'
 
 module TrieveRubyClient
   class FieldCondition
+    attr_accessor :date_range
+
     # Field is the name of the field to filter on. The field value will be used to check for an exact substring match on the metadata values for each existing chunk. This is useful for when you want to filter chunks by arbitrary metadata. To access fields inside of the metadata that you provide with the card, prefix the field name with `metadata.`.
     attr_accessor :field
 
@@ -32,6 +34,7 @@ module TrieveRubyClient
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'date_range' => :'date_range',
         :'field' => :'field',
         :'geo_bounding_box' => :'geo_bounding_box',
         :'geo_polygon' => :'geo_polygon',
@@ -49,6 +52,7 @@ module TrieveRubyClient
     # Attribute type mapping.
     def self.openapi_types
       {
+        :'date_range' => :'DateRange',
         :'field' => :'String',
         :'geo_bounding_box' => :'LocationBoundingBox',
         :'geo_polygon' => :'LocationPolygon',
@@ -61,6 +65,7 @@ module TrieveRubyClient
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'date_range',
         :'geo_bounding_box',
         :'geo_polygon',
         :'geo_radius',
@@ -84,6 +89,10 @@ module TrieveRubyClient
         h[k.to_sym] = v
       }
 
+      if attributes.key?(:'date_range')
+        self.date_range = attributes[:'date_range']
+      end
+
       if attributes.key?(:'field')
         self.field = attributes[:'field']
       else
@@ -138,6 +147,7 @@ module TrieveRubyClient
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          date_range == o.date_range &&
           field == o.field &&
           geo_bounding_box == o.geo_bounding_box &&
           geo_polygon == o.geo_polygon &&
@@ -155,7 +165,7 @@ module TrieveRubyClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [field, geo_bounding_box, geo_polygon, geo_radius, match, range].hash
+      [date_range, field, geo_bounding_box, geo_polygon, geo_radius, match, range].hash
     end
 
     # Builds the object from hash

data/lib/trieve_ruby_client/models/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.11.0
 Contact: developers@trieve.ai
 Generated by: https://openapi-generator.tech
 Generator version: 7.4.0
@@ -66,7 +66,7 @@ module TrieveRubyClient
         :'link' => :'String',
         :'metadata' => :'Object',
         :'size' => :'Integer',
-        :'tag_set' => :'String',
+        :'tag_set' => :'Array<String>',
         :'time_stamp' => :'Time',
         :'updated_at' => :'Time'
       }
@@ -136,7 +136,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?(:'time_stamp')

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

data/lib/trieve_ruby_client/models/generate_chunks_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.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
@@ -18,22 +18,46 @@ module TrieveRubyClient
     # The ids of the chunks to be retrieved and injected into the context window for RAG.
     attr_accessor :chunk_ids
 
+    # Frequency penalty is a number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim. Default is 0.7.
+    attr_accessor :frequency_penalty
+
+    # Set highlight_results to false for a slight latency improvement (1-10ms). If not specified, this defaults to true. This will add `<b><mark>`` tags to the chunk_html of the chunks to highlight matching splits.
+    attr_accessor :highlight_results
+
+    # The maximum number of tokens to generate in the chat completion. Default is None.
+    attr_accessor :max_tokens
+
+    # Presence penalty is a number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics. Default is 0.7.
+    attr_accessor :presence_penalty
+
     # The previous messages to be placed into the chat history. The last message in this array will be the prompt for the model to inference on. The length of this array must be at least 1.
     attr_accessor :prev_messages
 
     # Prompt for the last message in the prev_messages array. This will be used to generate the next message in the chat. The default is 'Respond to the instruction and include the doc numbers that you used in square brackets at the end of the sentences that you used the docs for:'. You can also specify an empty string to leave the final message alone such that your user's final message can be used as the prompt. See docs.trieve.ai or contact us for more information.
     attr_accessor :prompt
 
+    # Stop tokens are up to 4 sequences where the API will stop generating further tokens. Default is None.
+    attr_accessor :stop_tokens
+
     # Whether or not to stream the response. If this is set to true or not included, the response will be a stream. If this is set to false, the response will be a normal JSON response. Default is true.
     attr_accessor :stream_response
 
+    # What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. Default is 0.5.
+    attr_accessor :temperature
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'chunk_ids' => :'chunk_ids',
+        :'frequency_penalty' => :'frequency_penalty',
+        :'highlight_results' => :'highlight_results',
+        :'max_tokens' => :'max_tokens',
+        :'presence_penalty' => :'presence_penalty',
         :'prev_messages' => :'prev_messages',
         :'prompt' => :'prompt',
-        :'stream_response' => :'stream_response'
+        :'stop_tokens' => :'stop_tokens',
+        :'stream_response' => :'stream_response',
+        :'temperature' => :'temperature'
       }
     end
 
@@ -46,17 +70,29 @@ module TrieveRubyClient
     def self.openapi_types
       {
         :'chunk_ids' => :'Array<String>',
+        :'frequency_penalty' => :'Float',
+        :'highlight_results' => :'Boolean',
+        :'max_tokens' => :'Integer',
+        :'presence_penalty' => :'Float',
         :'prev_messages' => :'Array<ChatMessageProxy>',
         :'prompt' => :'String',
-        :'stream_response' => :'Boolean'
+        :'stop_tokens' => :'Array<String>',
+        :'stream_response' => :'Boolean',
+        :'temperature' => :'Float'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'frequency_penalty',
+        :'highlight_results',
+        :'max_tokens',
+        :'presence_penalty',
         :'prompt',
-        :'stream_response'
+        :'stop_tokens',
+        :'stream_response',
+        :'temperature'
       ])
     end
 
@@ -83,6 +119,22 @@ module TrieveRubyClient
         self.chunk_ids = nil
       end
 
+      if attributes.key?(:'frequency_penalty')
+        self.frequency_penalty = attributes[:'frequency_penalty']
+      end
+
+      if attributes.key?(:'highlight_results')
+        self.highlight_results = attributes[:'highlight_results']
+      end
+
+      if attributes.key?(:'max_tokens')
+        self.max_tokens = attributes[:'max_tokens']
+      end
+
+      if attributes.key?(:'presence_penalty')
+        self.presence_penalty = attributes[:'presence_penalty']
+      end
+
       if attributes.key?(:'prev_messages')
         if (value = attributes[:'prev_messages']).is_a?(Array)
           self.prev_messages = value
@@ -95,9 +147,19 @@ module TrieveRubyClient
         self.prompt = attributes[:'prompt']
       end
 
+      if attributes.key?(:'stop_tokens')
+        if (value = attributes[:'stop_tokens']).is_a?(Array)
+          self.stop_tokens = value
+        end
+      end
+
       if attributes.key?(:'stream_response')
         self.stream_response = attributes[:'stream_response']
       end
+
+      if attributes.key?(:'temperature')
+        self.temperature = attributes[:'temperature']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -109,6 +171,10 @@ module TrieveRubyClient
         invalid_properties.push('invalid value for "chunk_ids", chunk_ids cannot be nil.')
       end
 
+      if !@max_tokens.nil? && @max_tokens < 0
+        invalid_properties.push('invalid value for "max_tokens", must be greater than or equal to 0.')
+      end
+
       if @prev_messages.nil?
         invalid_properties.push('invalid value for "prev_messages", prev_messages cannot be nil.')
       end
@@ -121,19 +187,36 @@ module TrieveRubyClient
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
       return false if @chunk_ids.nil?
+      return false if !@max_tokens.nil? && @max_tokens < 0
       return false if @prev_messages.nil?
       true
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] max_tokens Value to be assigned
+    def max_tokens=(max_tokens)
+      if !max_tokens.nil? && max_tokens < 0
+        fail ArgumentError, 'invalid value for "max_tokens", must be greater than or equal to 0.'
+      end
+
+      @max_tokens = max_tokens
+    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 &&
           chunk_ids == o.chunk_ids &&
+          frequency_penalty == o.frequency_penalty &&
+          highlight_results == o.highlight_results &&
+          max_tokens == o.max_tokens &&
+          presence_penalty == o.presence_penalty &&
           prev_messages == o.prev_messages &&
           prompt == o.prompt &&
-          stream_response == o.stream_response
+          stop_tokens == o.stop_tokens &&
+          stream_response == o.stream_response &&
+          temperature == o.temperature
     end
 
     # @see the `==` method
@@ -145,7 +228,7 @@ module TrieveRubyClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [chunk_ids, prev_messages, prompt, stream_response].hash
+      [chunk_ids, frequency_penalty, highlight_results, max_tokens, presence_penalty, prev_messages, prompt, stop_tokens, stream_response, temperature].hash
     end
 
     # Builds the object from hash

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

data/lib/trieve_ruby_client/models/geo_info_with_bias.rb

@@ -0,0 +1,237 @@
+=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 GeoInfoWithBias
+    attr_accessor :bias
+
+    attr_accessor :location
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'bias' => :'bias',
+        :'location' => :'location'
+      }
+    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
+      {
+        :'bias' => :'Float',
+        :'location' => :'GeoInfo'
+      }
+    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::GeoInfoWithBias` 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::GeoInfoWithBias`. 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?(:'bias')
+        self.bias = attributes[:'bias']
+      else
+        self.bias = nil
+      end
+
+      if attributes.key?(:'location')
+        self.location = attributes[:'location']
+      else
+        self.location = 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 @bias.nil?
+        invalid_properties.push('invalid value for "bias", bias cannot be nil.')
+      end
+
+      if @location.nil?
+        invalid_properties.push('invalid value for "location", location 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 @bias.nil?
+      return false if @location.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 &&
+          bias == o.bias &&
+          location == o.location
+    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
+      [bias, location].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/geo_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.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

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