Class: AzureOpenaiClient::CompletionsCreate200ResponseUsage

Inherits:
Object
  • Object
show all
Defined in:
lib/azure_openai_client/models/completions_create200_response_usage.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CompletionsCreate200ResponseUsage

Initializes the object

Parameters:

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

    Model attributes in the form of hash



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/azure_openai_client/models/completions_create200_response_usage.rb', line 55

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

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

Instance Attribute Details

#completion_tokens ⇒ Object

Returns the value of attribute completion_tokens.



18
19
20
 
# File 'lib/azure_openai_client/models/completions_create200_response_usage.rb', line 18

def completion_tokens
  @completion_tokens
end

#prompt_tokens ⇒ Object

Returns the value of attribute prompt_tokens.



20
21
22
 
# File 'lib/azure_openai_client/models/completions_create200_response_usage.rb', line 20

def prompt_tokens
  @prompt_tokens
end

#total_tokens ⇒ Object

Returns the value of attribute total_tokens.



22
23
24
 
# File 'lib/azure_openai_client/models/completions_create200_response_usage.rb', line 22

def total_tokens
  @total_tokens
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



34
35
36
 
# File 'lib/azure_openai_client/models/completions_create200_response_usage.rb', line 34

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



25
26
27
28
29
30
31
 
# File 'lib/azure_openai_client/models/completions_create200_response_usage.rb', line 25

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



134
135
136
 
# File 'lib/azure_openai_client/models/completions_create200_response_usage.rb', line 134

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



48
49
50
51
 
# File 'lib/azure_openai_client/models/completions_create200_response_usage.rb', line 48

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

.openapi_types ⇒ Object

Attribute type mapping.



39
40
41
42
43
44
45
 
# File 'lib/azure_openai_client/models/completions_create200_response_usage.rb', line 39

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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



111
112
113
114
115
116
117
 
# File 'lib/azure_openai_client/models/completions_create200_response_usage.rb', line 111

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

#_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



165
166
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
 
# File 'lib/azure_openai_client/models/completions_create200_response_usage.rb', line 165

def _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 = AzureOpenaiClient.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
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



236
237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'lib/azure_openai_client/models/completions_create200_response_usage.rb', line 236

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

#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



141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/azure_openai_client/models/completions_create200_response_usage.rb', line 141

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{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[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


121
122
123
 
# File 'lib/azure_openai_client/models/completions_create200_response_usage.rb', line 121

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



127
128
129
 
# File 'lib/azure_openai_client/models/completions_create200_response_usage.rb', line 127

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



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/azure_openai_client/models/completions_create200_response_usage.rb', line 83

def list_invalid_properties
  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_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



212
213
214
 
# File 'lib/azure_openai_client/models/completions_create200_response_usage.rb', line 212

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



218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/azure_openai_client/models/completions_create200_response_usage.rb', line 218

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



206
207
208
 
# File 'lib/azure_openai_client/models/completions_create200_response_usage.rb', line 206

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



102
103
104
105
106
107
 
# File 'lib/azure_openai_client/models/completions_create200_response_usage.rb', line 102

def valid?
  return false if @completion_tokens.nil?
  return false if @prompt_tokens.nil?
  return false if @total_tokens.nil?
  true
end