Class: OpenApiOpenAIClient::RealtimeResponseUsage

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

Overview

Usage statistics for the Response, this will correspond to billing. A Realtime API session will maintain a conversation context and append new Items to the Conversation, thus output from previous turns (text and audio tokens) will become the input for later turns.

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/openapi_openai/models/realtime_response_usage.rb', line 72

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

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

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

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

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

Instance Attribute Details

#input_token_details ⇒ Object

Returns the value of attribute input_token_details.



28
29
30
 
# File 'lib/openapi_openai/models/realtime_response_usage.rb', line 28

def input_token_details
  @input_token_details
end

#input_tokens ⇒ Object

The number of input tokens used in the Response, including text and audio tokens.



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

def input_tokens
  @input_tokens
end

#output_token_details ⇒ Object

Returns the value of attribute output_token_details.



30
31
32
 
# File 'lib/openapi_openai/models/realtime_response_usage.rb', line 30

def output_token_details
  @output_token_details
end

#output_tokens ⇒ Object

The number of output tokens sent in the Response, including text and audio tokens.



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

def output_tokens
  @output_tokens
end

#total_tokens ⇒ Object

The total number of tokens in the Response including input and output text and audio tokens.



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

def total_tokens
  @total_tokens
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



44
45
46
 
# File 'lib/openapi_openai/models/realtime_response_usage.rb', line 44

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



49
50
51
 
# File 'lib/openapi_openai/models/realtime_response_usage.rb', line 49

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



33
34
35
36
37
38
39
40
41
 
# File 'lib/openapi_openai/models/realtime_response_usage.rb', line 33

def self.attribute_map
  {
    :'total_tokens' => :'total_tokens',
    :'input_tokens' => :'input_tokens',
    :'output_tokens' => :'output_tokens',
    :'input_token_details' => :'input_token_details',
    :'output_token_details' => :'output_token_details'
  }
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



149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
 
# File 'lib/openapi_openai/models/realtime_response_usage.rb', line 149

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



65
66
67
68
 
# File 'lib/openapi_openai/models/realtime_response_usage.rb', line 65

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

.openapi_types ⇒ Object

Attribute type mapping.



54
55
56
57
58
59
60
61
62
 
# File 'lib/openapi_openai/models/realtime_response_usage.rb', line 54

def self.openapi_types
  {
    :'total_tokens' => :'Integer',
    :'input_tokens' => :'Integer',
    :'output_tokens' => :'Integer',
    :'input_token_details' => :'RealtimeResponseUsageInputTokenDetails',
    :'output_token_details' => :'RealtimeResponseUsageOutputTokenDetails'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



124
125
126
127
128
129
130
131
132
 
# File 'lib/openapi_openai/models/realtime_response_usage.rb', line 124

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      total_tokens == o.total_tokens &&
      input_tokens == o.input_tokens &&
      output_tokens == o.output_tokens &&
      input_token_details == o.input_token_details &&
      output_token_details == o.output_token_details
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


136
137
138
 
# File 'lib/openapi_openai/models/realtime_response_usage.rb', line 136

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



142
143
144
 
# File 'lib/openapi_openai/models/realtime_response_usage.rb', line 142

def hash
  [total_tokens, input_tokens, output_tokens, input_token_details, output_token_details].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



109
110
111
112
113
 
# File 'lib/openapi_openai/models/realtime_response_usage.rb', line 109

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/openapi_openai/models/realtime_response_usage.rb', line 171

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



117
118
119
120
 
# File 'lib/openapi_openai/models/realtime_response_usage.rb', line 117

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  true
end