Class: OpenApiOpenAIClient::CreateChatCompletionStreamResponse

Inherits:
Object
  • Object
show all
Defined in:
lib/openapi_openai/models/create_chat_completion_stream_response.rb

Overview

Represents a streamed chunk of a chat completion response returned by model, based on the provided input.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateChatCompletionStreamResponse

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/openapi_openai/models/create_chat_completion_stream_response.rb', line 96

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

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

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

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

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

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

Instance Attribute Details

#choices ⇒ Object

A list of chat completion choices. Can be more than one if ‘n` is greater than 1.



23
24
25
 
# File 'lib/openapi_openai/models/create_chat_completion_stream_response.rb', line 23

def choices
  @choices
end

#created ⇒ Object

The Unix timestamp (in seconds) of when the chat completion was created. Each chunk has the same timestamp.



26
27
28
 
# File 'lib/openapi_openai/models/create_chat_completion_stream_response.rb', line 26

def created
  @created
end

#id ⇒ Object

A unique identifier for the chat completion. Each chunk has the same ID.



20
21
22
 
# File 'lib/openapi_openai/models/create_chat_completion_stream_response.rb', line 20

def id
  @id
end

#model ⇒ Object

The model to generate the completion.



29
30
31
 
# File 'lib/openapi_openai/models/create_chat_completion_stream_response.rb', line 29

def model
  @model
end

#object ⇒ Object

The object type, which is always ‘chat.completion.chunk`.



35
36
37
 
# File 'lib/openapi_openai/models/create_chat_completion_stream_response.rb', line 35

def object
  @object
end

#system_fingerprint ⇒ Object

This fingerprint represents the backend configuration that the model runs with. Can be used in conjunction with the ‘seed` request parameter to understand when backend changes have been made that might impact determinism.



32
33
34
 
# File 'lib/openapi_openai/models/create_chat_completion_stream_response.rb', line 32

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



250
251
252
253
254
255
256
257
258
259
260
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
 
# File 'lib/openapi_openai/models/create_chat_completion_stream_response.rb', line 250

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



72
73
74
 
# File 'lib/openapi_openai/models/create_chat_completion_stream_response.rb', line 72

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



60
61
62
63
64
65
66
67
68
69
 
# File 'lib/openapi_openai/models/create_chat_completion_stream_response.rb', line 60

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



226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/openapi_openai/models/create_chat_completion_stream_response.rb', line 226

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



89
90
91
92
 
# File 'lib/openapi_openai/models/create_chat_completion_stream_response.rb', line 89

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



77
78
79
80
81
82
83
84
85
86
 
# File 'lib/openapi_openai/models/create_chat_completion_stream_response.rb', line 77

def self.openapi_types
  {
    :'id' => :'String',
    :'choices' => :'Array<CreateChatCompletionStreamResponseChoicesInner>',
    :'created' => :'Integer',
    :'model' => :'String',
    :'system_fingerprint' => :'String',
    :'object' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

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



321
322
323
324
325
326
327
328
329
330
331
332
333
 
# File 'lib/openapi_openai/models/create_chat_completion_stream_response.rb', line 321

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


213
214
215
 
# File 'lib/openapi_openai/models/create_chat_completion_stream_response.rb', line 213

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



219
220
221
 
# File 'lib/openapi_openai/models/create_chat_completion_stream_response.rb', line 219

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



148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/openapi_openai/models/create_chat_completion_stream_response.rb', line 148

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

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

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

  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



297
298
299
 
# File 'lib/openapi_openai/models/create_chat_completion_stream_response.rb', line 297

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



303
304
305
306
307
308
309
310
311
312
313
314
315
 
# File 'lib/openapi_openai/models/create_chat_completion_stream_response.rb', line 303

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



291
292
293
 
# File 'lib/openapi_openai/models/create_chat_completion_stream_response.rb', line 291

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



176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/openapi_openai/models/create_chat_completion_stream_response.rb', line 176

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