Class: TrieveRubyClient::RegenerateMessageReqPayload

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ RegenerateMessageReqPayload

Initializes the object

Parameters:

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

    Model attributes in the form of hash



158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'lib/trieve_ruby_client/models/regenerate_message_req_payload.rb', line 158

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

  if attributes.key?(:'concat_user_messages_query')
    self.concat_user_messages_query = attributes[:'concat_user_messages_query']
  end

  if attributes.key?(:'filters')
    self.filters = attributes[:'filters']
  end

  if attributes.key?(:'frequency_penalty')
    self.frequency_penalty = attributes[:'frequency_penalty']
  end

  if attributes.key?(:'highlight_citations')
    self.highlight_citations = attributes[:'highlight_citations']
  end

  if attributes.key?(:'highlight_delimiters')
    if (value = attributes[:'highlight_delimiters']).is_a?(Array)
      self.highlight_delimiters = value
    end
  end

  if attributes.key?(:'max_tokens')
    self.max_tokens = attributes[:'max_tokens']
  end

  if attributes.key?(:'page_size')
    self.page_size = attributes[:'page_size']
  end

  if attributes.key?(:'presence_penalty')
    self.presence_penalty = attributes[:'presence_penalty']
  end

  if attributes.key?(:'score_threshold')
    self.score_threshold = attributes[:'score_threshold']
  end

  if attributes.key?(:'search_query')
    self.search_query = attributes[:'search_query']
  end

  if attributes.key?(:'search_type')
    self.search_type = attributes[:'search_type']
  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

  if attributes.key?(:'topic_id')
    self.topic_id = attributes[:'topic_id']
  else
    self.topic_id = nil
  end
end

Instance Attribute Details

#completion_first ⇒ Object

Completion first decides whether the stream should contain the stream of the completion response or the chunks first. Default is false. Keep in mind that || is used to separate the chunks from the completion response. If || is in the completion then you may want to split on ||{ instead.



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

def completion_first
  @completion_first
end

#concat_user_messages_query ⇒ Object

If concat user messages query is set to true, all of the user messages in the topic will be concatenated together and used as the search query. If not specified, this defaults to false. Default is false.



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

def concat_user_messages_query
  @concat_user_messages_query
end

#filters ⇒ Object

Returns the value of attribute filters.



24
25
26
 
# File 'lib/trieve_ruby_client/models/regenerate_message_req_payload.rb', line 24

def filters
  @filters
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.



27
28
29
 
# File 'lib/trieve_ruby_client/models/regenerate_message_req_payload.rb', line 27

def frequency_penalty
  @frequency_penalty
end

#highlight_citations ⇒ Object

Whether or not to highlight the citations in the response. If this is set to true or not included, the citations will be highlighted. If this is set to false, the citations will not be highlighted. Default is true.



30
31
32
 
# File 'lib/trieve_ruby_client/models/regenerate_message_req_payload.rb', line 30

def highlight_citations
  @highlight_citations
end

#highlight_delimiters ⇒ Object

The delimiters to use for highlighting the citations. If this is not included, the default delimiters will be used. Default is ‘[".", "!", "?", "\n", "\t", ","]`.



33
34
35
 
# File 'lib/trieve_ruby_client/models/regenerate_message_req_payload.rb', line 33

def highlight_delimiters
  @highlight_delimiters
end

#max_tokens ⇒ Object

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



36
37
38
 
# File 'lib/trieve_ruby_client/models/regenerate_message_req_payload.rb', line 36

def max_tokens
  @max_tokens
end

#page_size ⇒ Object

Page size is the number of chunks to fetch during RAG. If 0, then no search will be performed. If specified, this will override the N retrievals to include in the dataset configuration. Default is None.



39
40
41
 
# File 'lib/trieve_ruby_client/models/regenerate_message_req_payload.rb', line 39

def page_size
  @page_size
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.



42
43
44
 
# File 'lib/trieve_ruby_client/models/regenerate_message_req_payload.rb', line 42

def presence_penalty
  @presence_penalty
end

#score_threshold ⇒ Object

Set score_threshold to a float to filter out chunks with a score below the threshold. This threshold applies before weight and bias modifications. If not specified, this defaults to 0.0.



45
46
47
 
# File 'lib/trieve_ruby_client/models/regenerate_message_req_payload.rb', line 45

def score_threshold
  @score_threshold
end

#search_query ⇒ Object

Query is the search query. This can be any string. The search_query will be used to create a dense embedding vector and/or sparse vector which will be used to find the result set. If not specified, will default to the last user message or HyDE if HyDE is enabled in the dataset configuration. Default is None.



48
49
50
 
# File 'lib/trieve_ruby_client/models/regenerate_message_req_payload.rb', line 48

def search_query
  @search_query
end

#search_type ⇒ Object

Returns the value of attribute search_type.



50
51
52
 
# File 'lib/trieve_ruby_client/models/regenerate_message_req_payload.rb', line 50

def search_type
  @search_type
end

#stop_tokens ⇒ Object

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



53
54
55
 
# File 'lib/trieve_ruby_client/models/regenerate_message_req_payload.rb', line 53

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.



56
57
58
 
# File 'lib/trieve_ruby_client/models/regenerate_message_req_payload.rb', line 56

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.7.



59
60
61
 
# File 'lib/trieve_ruby_client/models/regenerate_message_req_payload.rb', line 59

def temperature
  @temperature
end

#topic_id ⇒ Object

The id of the topic to regenerate the last message for.



62
63
64
 
# File 'lib/trieve_ruby_client/models/regenerate_message_req_payload.rb', line 62

def topic_id
  @topic_id
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



354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
 
# File 'lib/trieve_ruby_client/models/regenerate_message_req_payload.rb', line 354

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



109
110
111
 
# File 'lib/trieve_ruby_client/models/regenerate_message_req_payload.rb', line 109

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/trieve_ruby_client/models/regenerate_message_req_payload.rb', line 87

def self.attribute_map
  {
    :'completion_first' => :'completion_first',
    :'concat_user_messages_query' => :'concat_user_messages_query',
    :'filters' => :'filters',
    :'frequency_penalty' => :'frequency_penalty',
    :'highlight_citations' => :'highlight_citations',
    :'highlight_delimiters' => :'highlight_delimiters',
    :'max_tokens' => :'max_tokens',
    :'page_size' => :'page_size',
    :'presence_penalty' => :'presence_penalty',
    :'score_threshold' => :'score_threshold',
    :'search_query' => :'search_query',
    :'search_type' => :'search_type',
    :'stop_tokens' => :'stop_tokens',
    :'stream_response' => :'stream_response',
    :'temperature' => :'temperature',
    :'topic_id' => :'topic_id'
  }
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



330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
 
# File 'lib/trieve_ruby_client/models/regenerate_message_req_payload.rb', line 330

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



136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/trieve_ruby_client/models/regenerate_message_req_payload.rb', line 136

def self.openapi_nullable
  Set.new([
    :'completion_first',
    :'concat_user_messages_query',
    :'filters',
    :'frequency_penalty',
    :'highlight_citations',
    :'highlight_delimiters',
    :'max_tokens',
    :'page_size',
    :'presence_penalty',
    :'score_threshold',
    :'search_query',
    :'search_type',
    :'stop_tokens',
    :'stream_response',
    :'temperature',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/trieve_ruby_client/models/regenerate_message_req_payload.rb', line 114

def self.openapi_types
  {
    :'completion_first' => :'Boolean',
    :'concat_user_messages_query' => :'Boolean',
    :'filters' => :'ChunkFilter',
    :'frequency_penalty' => :'Float',
    :'highlight_citations' => :'Boolean',
    :'highlight_delimiters' => :'Array<String>',
    :'max_tokens' => :'Integer',
    :'page_size' => :'Integer',
    :'presence_penalty' => :'Float',
    :'score_threshold' => :'Float',
    :'search_query' => :'String',
    :'search_type' => :'SearchMethod',
    :'stop_tokens' => :'Array<String>',
    :'stream_response' => :'Boolean',
    :'temperature' => :'Float',
    :'topic_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
 
# File 'lib/trieve_ruby_client/models/regenerate_message_req_payload.rb', line 294

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      completion_first == o.completion_first &&
      concat_user_messages_query == o.concat_user_messages_query &&
      filters == o.filters &&
      frequency_penalty == o.frequency_penalty &&
      highlight_citations == o.highlight_citations &&
      highlight_delimiters == o.highlight_delimiters &&
      max_tokens == o.max_tokens &&
      page_size == o.page_size &&
      presence_penalty == o.presence_penalty &&
      score_threshold == o.score_threshold &&
      search_query == o.search_query &&
      search_type == o.search_type &&
      stop_tokens == o.stop_tokens &&
      stream_response == o.stream_response &&
      temperature == o.temperature &&
      topic_id == o.topic_id
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



425
426
427
428
429
430
431
432
433
434
435
436
437
 
# File 'lib/trieve_ruby_client/models/regenerate_message_req_payload.rb', line 425

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


317
318
319
 
# File 'lib/trieve_ruby_client/models/regenerate_message_req_payload.rb', line 317

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



323
324
325
 
# File 'lib/trieve_ruby_client/models/regenerate_message_req_payload.rb', line 323

def hash
  [completion_first, concat_user_messages_query, filters, frequency_penalty, highlight_citations, highlight_delimiters, max_tokens, page_size, presence_penalty, score_threshold, search_query, search_type, stop_tokens, stream_response, temperature, topic_id].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



244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
 
# File 'lib/trieve_ruby_client/models/regenerate_message_req_payload.rb', line 244

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  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 !@page_size.nil? && @page_size < 0
    invalid_properties.push('invalid value for "page_size", must be greater than or equal to 0.')
  end

  if @topic_id.nil?
    invalid_properties.push('invalid value for "topic_id", topic_id 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



401
402
403
 
# File 'lib/trieve_ruby_client/models/regenerate_message_req_payload.rb', line 401

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



407
408
409
410
411
412
413
414
415
416
417
418
419
 
# File 'lib/trieve_ruby_client/models/regenerate_message_req_payload.rb', line 407

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



395
396
397
 
# File 'lib/trieve_ruby_client/models/regenerate_message_req_payload.rb', line 395

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



264
265
266
267
268
269
270
 
# File 'lib/trieve_ruby_client/models/regenerate_message_req_payload.rb', line 264

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if !@max_tokens.nil? && @max_tokens < 0
  return false if !@page_size.nil? && @page_size < 0
  return false if @topic_id.nil?
  true
end