Class: TrieveRubyClient::GenerateChunksRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/trieve_ruby_client/models/generate_chunks_request.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ GenerateChunksRequest

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/trieve_ruby_client/models/generate_chunks_request.rb', line 101

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `TrieveRubyClient::GenerateChunksRequest` 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::GenerateChunksRequest`. 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?(:'chunk_ids')
    if (value = attributes[:'chunk_ids']).is_a?(Array)
      self.chunk_ids = value
    end
  else
    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
    end
  else
    self.prev_messages = nil
  end

  if attributes.key?(:'prompt')
    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

Instance Attribute Details

#chunk_ids ⇒ Object

The ids of the chunks to be retrieved and injected into the context window for RAG.



19
20
21
 
# File 'lib/trieve_ruby_client/models/generate_chunks_request.rb', line 19

def chunk_ids
  @chunk_ids
end

#frequency_penalty ⇒ Object

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.



22
23
24
 
# File 'lib/trieve_ruby_client/models/generate_chunks_request.rb', line 22

def frequency_penalty
  @frequency_penalty
end

#highlight_results ⇒ Object

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.



25
26
27
 
# File 'lib/trieve_ruby_client/models/generate_chunks_request.rb', line 25

def highlight_results
  @highlight_results
end

#max_tokens ⇒ Object

The maximum number of tokens to generate in the chat completion. Default is None.



28
29
30
 
# File 'lib/trieve_ruby_client/models/generate_chunks_request.rb', line 28

def max_tokens
  @max_tokens
end

#presence_penalty ⇒ Object

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.



31
32
33
 
# File 'lib/trieve_ruby_client/models/generate_chunks_request.rb', line 31

def presence_penalty
  @presence_penalty
end

#prev_messages ⇒ Object

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.



34
35
36
 
# File 'lib/trieve_ruby_client/models/generate_chunks_request.rb', line 34

def prev_messages
  @prev_messages
end

#prompt ⇒ Object

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.



37
38
39
 
# File 'lib/trieve_ruby_client/models/generate_chunks_request.rb', line 37

def prompt
  @prompt
end

#stop_tokens ⇒ Object

Stop tokens are up to 4 sequences where the API will stop generating further tokens. Default is None.



40
41
42
 
# File 'lib/trieve_ruby_client/models/generate_chunks_request.rb', line 40

def stop_tokens
  @stop_tokens
end

#stream_response ⇒ Object

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.



43
44
45
 
# File 'lib/trieve_ruby_client/models/generate_chunks_request.rb', line 43

def stream_response
  @stream_response
end

#temperature ⇒ Object

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.



46
47
48
 
# File 'lib/trieve_ruby_client/models/generate_chunks_request.rb', line 46

def temperature
  @temperature
end

Class Method Details

._deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
 
# File 'lib/trieve_ruby_client/models/generate_chunks_request.rb', line 261

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

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



65
66
67
 
# File 'lib/trieve_ruby_client/models/generate_chunks_request.rb', line 65

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



49
50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/trieve_ruby_client/models/generate_chunks_request.rb', line 49

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',
    :'stop_tokens' => :'stop_tokens',
    :'stream_response' => :'stream_response',
    :'temperature' => :'temperature'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/trieve_ruby_client/models/generate_chunks_request.rb', line 237

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/trieve_ruby_client/models/generate_chunks_request.rb', line 86

def self.openapi_nullable
  Set.new([
    :'frequency_penalty',
    :'highlight_results',
    :'max_tokens',
    :'presence_penalty',
    :'prompt',
    :'stop_tokens',
    :'stream_response',
    :'temperature'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/trieve_ruby_client/models/generate_chunks_request.rb', line 70

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',
    :'stop_tokens' => :'Array<String>',
    :'stream_response' => :'Boolean',
    :'temperature' => :'Float'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/trieve_ruby_client/models/generate_chunks_request.rb', line 207

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 &&
      stop_tokens == o.stop_tokens &&
      stream_response == o.stream_response &&
      temperature == o.temperature
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



332
333
334
335
336
337
338
339
340
341
342
343
344
 
# File 'lib/trieve_ruby_client/models/generate_chunks_request.rb', line 332

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


224
225
226
 
# File 'lib/trieve_ruby_client/models/generate_chunks_request.rb', line 224

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



230
231
232
 
# File 'lib/trieve_ruby_client/models/generate_chunks_request.rb', line 230

def hash
  [chunk_ids, frequency_penalty, highlight_results, max_tokens, presence_penalty, prev_messages, prompt, stop_tokens, stream_response, temperature].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/trieve_ruby_client/models/generate_chunks_request.rb', line 167

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @chunk_ids.nil?
    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

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



308
309
310
 
# File 'lib/trieve_ruby_client/models/generate_chunks_request.rb', line 308

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



314
315
316
317
318
319
320
321
322
323
324
325
326
 
# File 'lib/trieve_ruby_client/models/generate_chunks_request.rb', line 314

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

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



302
303
304
 
# File 'lib/trieve_ruby_client/models/generate_chunks_request.rb', line 302

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



187
188
189
190
191
192
193
 
# File 'lib/trieve_ruby_client/models/generate_chunks_request.rb', line 187

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