Class: OpenApiOpenAIClient::CreateChatCompletionStreamResponse

Inherits:
ApiModelBase
  • 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

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ CreateChatCompletionStreamResponse

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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
  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 `OpenApiOpenAIClient::CreateChatCompletionStreamResponse`. 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?(:'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?(:'service_tier')
    self.service_tier = attributes[:'service_tier']
  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

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

Instance Attribute Details

#choices ⇒ Object

A list of chat completion choices. Can contain more than one elements if n is greater than 1. Can also be empty for the last chunk if you set ‘stream_options: true`.



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.



38
39
40
 
# File 'lib/openapi_openai/models/create_chat_completion_stream_response.rb', line 38

def object
  @object
end

#service_tier ⇒ Object

The service tier used for processing the request. This field is only included if the service_tier parameter is specified in the request.



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

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



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

def system_fingerprint
  @system_fingerprint
end

#usage ⇒ Object

Returns the value of attribute usage.



40
41
42
 
# File 'lib/openapi_openai/models/create_chat_completion_stream_response.rb', line 40

def usage
  @usage
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



79
80
81
 
# File 'lib/openapi_openai/models/create_chat_completion_stream_response.rb', line 79

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



84
85
86
 
# File 'lib/openapi_openai/models/create_chat_completion_stream_response.rb', line 84

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/openapi_openai/models/create_chat_completion_stream_response.rb', line 65

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



305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
 
# File 'lib/openapi_openai/models/create_chat_completion_stream_response.rb', line 305

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



103
104
105
106
107
108
 
# File 'lib/openapi_openai/models/create_chat_completion_stream_response.rb', line 103

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

.openapi_types ⇒ Object

Attribute type mapping.



89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/openapi_openai/models/create_chat_completion_stream_response.rb', line 89

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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'lib/openapi_openai/models/create_chat_completion_stream_response.rb', line 277

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      choices == o.choices &&
      created == o.created &&
      model == o.model &&
      service_tier == o.service_tier &&
      system_fingerprint == o.system_fingerprint &&
      object == o.object &&
      usage == o.usage
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


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

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



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

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



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

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_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



327
328
329
330
331
332
333
334
335
336
337
338
339
 
# File 'lib/openapi_openai/models/create_chat_completion_stream_response.rb', line 327

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

#valid? ⇒ Boolean

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

Returns:

  • (Boolean) —

    true if the model is valid



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

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?
  service_tier_validator = EnumAttributeValidator.new('String', ["scale", "default"])
  return false unless service_tier_validator.valid?(@service_tier)
  return false if @object.nil?
  object_validator = EnumAttributeValidator.new('String', ["chat.completion.chunk"])
  return false unless object_validator.valid?(@object)
  true
end