Class: OCI::GenerativeAiInference::Models::Usage

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/generative_ai_inference/models/usage.rb

Overview

Usage statistics for the completion request.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Usage

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
96
97
98
99
100
101
 
# File 'lib/oci/generative_ai_inference/models/usage.rb', line 66

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.completion_tokens = attributes[:'completionTokens'] if attributes[:'completionTokens']

  raise 'You cannot provide both :completionTokens and :completion_tokens' if attributes.key?(:'completionTokens') && attributes.key?(:'completion_tokens')

  self.completion_tokens = attributes[:'completion_tokens'] if attributes[:'completion_tokens']

  self.prompt_tokens = attributes[:'promptTokens'] if attributes[:'promptTokens']

  raise 'You cannot provide both :promptTokens and :prompt_tokens' if attributes.key?(:'promptTokens') && attributes.key?(:'prompt_tokens')

  self.prompt_tokens = attributes[:'prompt_tokens'] if attributes[:'prompt_tokens']

  self.total_tokens = attributes[:'totalTokens'] if attributes[:'totalTokens']

  raise 'You cannot provide both :totalTokens and :total_tokens' if attributes.key?(:'totalTokens') && attributes.key?(:'total_tokens')

  self.total_tokens = attributes[:'total_tokens'] if attributes[:'total_tokens']

  self.completion_tokens_details = attributes[:'completionTokensDetails'] if attributes[:'completionTokensDetails']

  raise 'You cannot provide both :completionTokensDetails and :completion_tokens_details' if attributes.key?(:'completionTokensDetails') && attributes.key?(:'completion_tokens_details')

  self.completion_tokens_details = attributes[:'completion_tokens_details'] if attributes[:'completion_tokens_details']

  self.prompt_tokens_details = attributes[:'promptTokensDetails'] if attributes[:'promptTokensDetails']

  raise 'You cannot provide both :promptTokensDetails and :prompt_tokens_details' if attributes.key?(:'promptTokensDetails') && attributes.key?(:'prompt_tokens_details')

  self.prompt_tokens_details = attributes[:'prompt_tokens_details'] if attributes[:'prompt_tokens_details']
end

Instance Attribute Details

#completion_tokens ⇒ Integer

Number of tokens in the generated completion.

Returns:

  • (Integer) 


13
14
15
 
# File 'lib/oci/generative_ai_inference/models/usage.rb', line 13

def completion_tokens
  @completion_tokens
end

#completion_tokens_details ⇒ OCI::GenerativeAiInference::Models::CompletionTokensDetails

Returns:



24
25
26
 
# File 'lib/oci/generative_ai_inference/models/usage.rb', line 24

def completion_tokens_details
  @completion_tokens_details
end

#prompt_tokens ⇒ Integer

Number of tokens in the prompt.

Returns:

  • (Integer) 


17
18
19
 
# File 'lib/oci/generative_ai_inference/models/usage.rb', line 17

def prompt_tokens
  @prompt_tokens
end

#prompt_tokens_details ⇒ OCI::GenerativeAiInference::Models::PromptTokensDetails

Returns:



27
28
29
 
# File 'lib/oci/generative_ai_inference/models/usage.rb', line 27

def prompt_tokens_details
  @prompt_tokens_details
end

#total_tokens ⇒ Integer

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

Returns:

  • (Integer) 


21
22
23
 
# File 'lib/oci/generative_ai_inference/models/usage.rb', line 21

def total_tokens
  @total_tokens
end

Class Method Details

.attribute_map ⇒ Object

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



30
31
32
33
34
35
36
37
38
39
40
 
# File 'lib/oci/generative_ai_inference/models/usage.rb', line 30

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'completion_tokens': :'completionTokens',
    'prompt_tokens': :'promptTokens',
    'total_tokens': :'totalTokens',
    'completion_tokens_details': :'completionTokensDetails',
    'prompt_tokens_details': :'promptTokensDetails'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/oci/generative_ai_inference/models/usage.rb', line 43

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'completion_tokens': :'Integer',
    'prompt_tokens': :'Integer',
    'total_tokens': :'Integer',
    'completion_tokens_details': :'OCI::GenerativeAiInference::Models::CompletionTokensDetails',
    'prompt_tokens_details': :'OCI::GenerativeAiInference::Models::PromptTokensDetails'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object) —

    the other object to be compared



110
111
112
113
114
115
116
117
118
119
 
# File 'lib/oci/generative_ai_inference/models/usage.rb', line 110

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    completion_tokens == other.completion_tokens &&
    prompt_tokens == other.prompt_tokens &&
    total_tokens == other.total_tokens &&
    completion_tokens_details == other.completion_tokens_details &&
    prompt_tokens_details == other.prompt_tokens_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



144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/oci/generative_ai_inference/models/usage.rb', line 144

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        public_method("#{key}=").call(
          attributes[self.class.attribute_map[key]]
            .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) }
        )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      public_method("#{key}=").call(
        OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]])
      )
    end
    # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


124
125
126
 
# File 'lib/oci/generative_ai_inference/models/usage.rb', line 124

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



133
134
135
 
# File 'lib/oci/generative_ai_inference/models/usage.rb', line 133

def hash
  [completion_tokens, prompt_tokens, total_tokens, completion_tokens_details, prompt_tokens_details].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



177
178
179
180
181
182
183
184
185
186
 
# File 'lib/oci/generative_ai_inference/models/usage.rb', line 177

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = public_method(attr).call
    next if value.nil? && !instance_variable_defined?("@#{attr}")

    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



171
172
173
 
# File 'lib/oci/generative_ai_inference/models/usage.rb', line 171

def to_s
  to_hash.to_s
end