Class: TrieveRubyClient::Message

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Message

Initializes the object

Parameters:

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

    Model attributes in the form of hash



89
90
91
92
93
94
95
96
97
98
99
100
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/message.rb', line 89

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#completion_tokens ⇒ Object

Returns the value of attribute completion_tokens.



18
19
20
 
# File 'lib/trieve_ruby_client/models/message.rb', line 18

def completion_tokens
  @completion_tokens
end

#content ⇒ Object

Returns the value of attribute content.



20
21
22
 
# File 'lib/trieve_ruby_client/models/message.rb', line 20

def content
  @content
end

#created_at ⇒ Object

Returns the value of attribute created_at.



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

def created_at
  @created_at
end

#dataset_id ⇒ Object

Returns the value of attribute dataset_id.



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

def dataset_id
  @dataset_id
end

#deleted ⇒ Object

Returns the value of attribute deleted.



26
27
28
 
# File 'lib/trieve_ruby_client/models/message.rb', line 26

def deleted
  @deleted
end

#id ⇒ Object

Returns the value of attribute id.



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

def id
  @id
end

#prompt_tokens ⇒ Object

Returns the value of attribute prompt_tokens.



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

def prompt_tokens
  @prompt_tokens
end

#role ⇒ Object

Returns the value of attribute role.



32
33
34
 
# File 'lib/trieve_ruby_client/models/message.rb', line 32

def role
  @role
end

#sort_order ⇒ Object

Returns the value of attribute sort_order.



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

def sort_order
  @sort_order
end

#topic_id ⇒ Object

Returns the value of attribute topic_id.



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

def topic_id
  @topic_id
end

#updated_at ⇒ Object

Returns the value of attribute updated_at.



38
39
40
 
# File 'lib/trieve_ruby_client/models/message.rb', line 38

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



282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
 
# File 'lib/trieve_ruby_client/models/message.rb', line 282

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



58
59
60
 
# File 'lib/trieve_ruby_client/models/message.rb', line 58

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/trieve_ruby_client/models/message.rb', line 41

def self.attribute_map
  {
    :'completion_tokens' => :'completion_tokens',
    :'content' => :'content',
    :'created_at' => :'created_at',
    :'dataset_id' => :'dataset_id',
    :'deleted' => :'deleted',
    :'id' => :'id',
    :'prompt_tokens' => :'prompt_tokens',
    :'role' => :'role',
    :'sort_order' => :'sort_order',
    :'topic_id' => :'topic_id',
    :'updated_at' => :'updated_at'
  }
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



258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
 
# File 'lib/trieve_ruby_client/models/message.rb', line 258

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



80
81
82
83
84
85
 
# File 'lib/trieve_ruby_client/models/message.rb', line 80

def self.openapi_nullable
  Set.new([
    :'completion_tokens',
    :'prompt_tokens',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/trieve_ruby_client/models/message.rb', line 63

def self.openapi_types
  {
    :'completion_tokens' => :'Integer',
    :'content' => :'String',
    :'created_at' => :'Time',
    :'dataset_id' => :'String',
    :'deleted' => :'Boolean',
    :'id' => :'String',
    :'prompt_tokens' => :'Integer',
    :'role' => :'String',
    :'sort_order' => :'Integer',
    :'topic_id' => :'String',
    :'updated_at' => :'Time'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/trieve_ruby_client/models/message.rb', line 227

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      completion_tokens == o.completion_tokens &&
      content == o.content &&
      created_at == o.created_at &&
      dataset_id == o.dataset_id &&
      deleted == o.deleted &&
      id == o.id &&
      prompt_tokens == o.prompt_tokens &&
      role == o.role &&
      sort_order == o.sort_order &&
      topic_id == o.topic_id &&
      updated_at == o.updated_at
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



353
354
355
356
357
358
359
360
361
362
363
364
365
 
# File 'lib/trieve_ruby_client/models/message.rb', line 353

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


245
246
247
 
# File 'lib/trieve_ruby_client/models/message.rb', line 245

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



251
252
253
 
# File 'lib/trieve_ruby_client/models/message.rb', line 251

def hash
  [completion_tokens, content, created_at, dataset_id, deleted, id, prompt_tokens, role, sort_order, topic_id, updated_at].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
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
 
# File 'lib/trieve_ruby_client/models/message.rb', line 167

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @content.nil?
    invalid_properties.push('invalid value for "content", content cannot be nil.')
  end

  if @created_at.nil?
    invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
  end

  if @dataset_id.nil?
    invalid_properties.push('invalid value for "dataset_id", dataset_id cannot be nil.')
  end

  if @deleted.nil?
    invalid_properties.push('invalid value for "deleted", deleted cannot be nil.')
  end

  if @id.nil?
    invalid_properties.push('invalid value for "id", id cannot be nil.')
  end

  if @role.nil?
    invalid_properties.push('invalid value for "role", role cannot be nil.')
  end

  if @sort_order.nil?
    invalid_properties.push('invalid value for "sort_order", sort_order cannot be nil.')
  end

  if @topic_id.nil?
    invalid_properties.push('invalid value for "topic_id", topic_id cannot be nil.')
  end

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



329
330
331
 
# File 'lib/trieve_ruby_client/models/message.rb', line 329

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



335
336
337
338
339
340
341
342
343
344
345
346
347
 
# File 'lib/trieve_ruby_client/models/message.rb', line 335

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



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

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



211
212
213
214
215
216
217
218
219
220
221
222
223
 
# File 'lib/trieve_ruby_client/models/message.rb', line 211

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @content.nil?
  return false if @created_at.nil?
  return false if @dataset_id.nil?
  return false if @deleted.nil?
  return false if @id.nil?
  return false if @role.nil?
  return false if @sort_order.nil?
  return false if @topic_id.nil?
  return false if @updated_at.nil?
  true
end