Class: OpenApiOpenAIClient::CreateChatCompletionStreamResponseUsage

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

Overview

An optional field that will only be present when you set ‘stream_options: true` in your request. When present, it contains a null value except for the last chunk which contains the token usage statistics for the entire request.

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 = {}) ⇒ CreateChatCompletionStreamResponseUsage

Initializes the object

Parameters:

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

    Model attributes in the form of hash



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/openapi_openai/models/create_chat_completion_stream_response_usage.rb', line 64

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

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

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

Instance Attribute Details

#completion_tokens ⇒ Object

Number of tokens in the generated completion.



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

def completion_tokens
  @completion_tokens
end

#prompt_tokens ⇒ Object

Number of tokens in the prompt.



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

def prompt_tokens
  @prompt_tokens
end

#total_tokens ⇒ Object

Total number of tokens used in the request (prompt + completion).



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

def total_tokens
  @total_tokens
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



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

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



43
44
45
 
# File 'lib/openapi_openai/models/create_chat_completion_stream_response_usage.rb', line 43

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



29
30
31
32
33
34
35
 
# File 'lib/openapi_openai/models/create_chat_completion_stream_response_usage.rb', line 29

def self.attribute_map
  {
    :'completion_tokens' => :'completion_tokens',
    :'prompt_tokens' => :'prompt_tokens',
    :'total_tokens' => :'total_tokens'
  }
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



182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
 
# File 'lib/openapi_openai/models/create_chat_completion_stream_response_usage.rb', line 182

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



57
58
59
60
 
# File 'lib/openapi_openai/models/create_chat_completion_stream_response_usage.rb', line 57

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

.openapi_types ⇒ Object

Attribute type mapping.



48
49
50
51
52
53
54
 
# File 'lib/openapi_openai/models/create_chat_completion_stream_response_usage.rb', line 48

def self.openapi_types
  {
    :'completion_tokens' => :'Integer',
    :'prompt_tokens' => :'Integer',
    :'total_tokens' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



159
160
161
162
163
164
165
 
# File 'lib/openapi_openai/models/create_chat_completion_stream_response_usage.rb', line 159

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      completion_tokens == o.completion_tokens &&
      prompt_tokens == o.prompt_tokens &&
      total_tokens == o.total_tokens
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


169
170
171
 
# File 'lib/openapi_openai/models/create_chat_completion_stream_response_usage.rb', line 169

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



175
176
177
 
# File 'lib/openapi_openai/models/create_chat_completion_stream_response_usage.rb', line 175

def hash
  [completion_tokens, prompt_tokens, total_tokens].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



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/openapi_openai/models/create_chat_completion_stream_response_usage.rb', line 99

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

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

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



204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/openapi_openai/models/create_chat_completion_stream_response_usage.rb', line 204

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



119
120
121
122
123
124
125
 
# File 'lib/openapi_openai/models/create_chat_completion_stream_response_usage.rb', line 119

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @completion_tokens.nil?
  return false if @prompt_tokens.nil?
  return false if @total_tokens.nil?
  true
end