Class: VeniceClient::CreateChatCompletion200Response

Inherits:
Object
  • Object
show all
Defined in:
lib/venice_client/models/create_chat_completion200_response.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateChatCompletion200Response

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
164
165
166
167
 
# File 'lib/venice_client/models/create_chat_completion200_response.rb', line 108

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `VeniceClient::CreateChatCompletion200Response` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `VeniceClient::CreateChatCompletion200Response`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

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

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

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

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

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

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

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

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

Instance Attribute Details

#choices ⇒ Object

A list of chat completion choices. Can be more than one if n is greater than 1. Certain models may not return this field under certain conditions.



19
20
21
 
# File 'lib/venice_client/models/create_chat_completion200_response.rb', line 19

def choices
  @choices
end

#created ⇒ Object

The time at which the request was created.



22
23
24
 
# File 'lib/venice_client/models/create_chat_completion200_response.rb', line 22

def created
  @created
end

#id ⇒ Object

The ID of the request.



25
26
27
 
# File 'lib/venice_client/models/create_chat_completion200_response.rb', line 25

def id
  @id
end

#model ⇒ Object

The model id used for the request.



28
29
30
 
# File 'lib/venice_client/models/create_chat_completion200_response.rb', line 28

def model
  @model
end

#object ⇒ Object

The type of the object returned.



31
32
33
 
# File 'lib/venice_client/models/create_chat_completion200_response.rb', line 31

def object
  @object
end

#prompt_logprobs ⇒ Object

Returns the value of attribute prompt_logprobs.



33
34
35
 
# File 'lib/venice_client/models/create_chat_completion200_response.rb', line 33

def prompt_logprobs
  @prompt_logprobs
end

#usage ⇒ Object

Returns the value of attribute usage.



35
36
37
 
# File 'lib/venice_client/models/create_chat_completion200_response.rb', line 35

def usage
  @usage
end

#venice_parameters ⇒ Object

Returns the value of attribute venice_parameters.



37
38
39
 
# File 'lib/venice_client/models/create_chat_completion200_response.rb', line 37

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



315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
 
# File 'lib/venice_client/models/create_chat_completion200_response.rb', line 315

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 = VeniceClient.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_attribute_map ⇒ Object

Returns attribute mapping this model knows about



76
77
78
 
# File 'lib/venice_client/models/create_chat_completion200_response.rb', line 76

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



81
82
83
 
# File 'lib/venice_client/models/create_chat_completion200_response.rb', line 81

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/venice_client/models/create_chat_completion200_response.rb', line 62

def self.attribute_map
  {
    :'choices' => :'choices',
    :'created' => :'created',
    :'id' => :'id',
    :'model' => :'model',
    :'object' => :'object',
    :'prompt_logprobs' => :'prompt_logprobs',
    :'usage' => :'usage',
    :'venice_parameters' => :'venice_parameters'
  }
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



291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
 
# File 'lib/venice_client/models/create_chat_completion200_response.rb', line 291

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



100
101
102
103
104
 
# File 'lib/venice_client/models/create_chat_completion200_response.rb', line 100

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'choices' => :'Array<CreateChatCompletion200ResponseChoicesInner>',
    :'created' => :'Integer',
    :'id' => :'String',
    :'model' => :'String',
    :'object' => :'String',
    :'prompt_logprobs' => :'Hash<String, Object>',
    :'usage' => :'CreateChatCompletion200ResponseUsage',
    :'venice_parameters' => :'CreateChatCompletion200ResponseVeniceParameters'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/venice_client/models/create_chat_completion200_response.rb', line 263

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      choices == o.choices &&
      created == o.created &&
      id == o.id &&
      model == o.model &&
      object == o.object &&
      prompt_logprobs == o.prompt_logprobs &&
      usage == o.usage &&
      venice_parameters == o.venice_parameters
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



386
387
388
389
390
391
392
393
394
395
396
397
398
 
# File 'lib/venice_client/models/create_chat_completion200_response.rb', line 386

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


278
279
280
 
# File 'lib/venice_client/models/create_chat_completion200_response.rb', line 278

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



284
285
286
 
# File 'lib/venice_client/models/create_chat_completion200_response.rb', line 284

def hash
  [choices, created, id, model, object, prompt_logprobs, usage, venice_parameters].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



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
 
# File 'lib/venice_client/models/create_chat_completion200_response.rb', line 171

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

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

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

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

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



362
363
364
 
# File 'lib/venice_client/models/create_chat_completion200_response.rb', line 362

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



368
369
370
371
372
373
374
375
376
377
378
379
380
 
# File 'lib/venice_client/models/create_chat_completion200_response.rb', line 368

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



356
357
358
 
# File 'lib/venice_client/models/create_chat_completion200_response.rb', line 356

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



199
200
201
202
203
204
205
206
207
208
209
 
# File 'lib/venice_client/models/create_chat_completion200_response.rb', line 199

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @created.nil?
  return false if @id.nil?
  return false if @model.nil?
  return false if @object.nil?
  object_validator = EnumAttributeValidator.new('String', ["chat.completion"])
  return false unless object_validator.valid?(@object)
  return false if @usage.nil?
  true
end