Class: OCI::GenerativeAiInference::Models::CompletionTokensDetails

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

Overview

Breakdown of tokens used in a completion.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CompletionTokensDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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

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.accepted_prediction_tokens = attributes[:'acceptedPredictionTokens'] if attributes[:'acceptedPredictionTokens']

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

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

  self.reasoning_tokens = attributes[:'reasoningTokens'] if attributes[:'reasoningTokens']

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

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

  self.rejected_prediction_tokens = attributes[:'rejectedPredictionTokens'] if attributes[:'rejectedPredictionTokens']

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

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

Instance Attribute Details

#accepted_prediction_tokens ⇒ Integer

When using Predicted Outputs, the number of tokens in the prediction that appeared in the completion.

Returns:

  • (Integer) 


14
15
16
 
# File 'lib/oci/generative_ai_inference/models/completion_tokens_details.rb', line 14

def accepted_prediction_tokens
  @accepted_prediction_tokens
end

#reasoning_tokens ⇒ Integer

Tokens generated by the model for reasoning.

Returns:

  • (Integer) 


18
19
20
 
# File 'lib/oci/generative_ai_inference/models/completion_tokens_details.rb', line 18

def reasoning_tokens
  @reasoning_tokens
end

#rejected_prediction_tokens ⇒ Integer

When using Predicted Outputs, the number of tokens in the prediction that did not appear in the completion. However, like reasoning tokens, these tokens are still counted in the total completion tokens for purposes of billing, output, and context window limits.

Returns:

  • (Integer) 


22
23
24
 
# File 'lib/oci/generative_ai_inference/models/completion_tokens_details.rb', line 22

def rejected_prediction_tokens
  @rejected_prediction_tokens
end

Class Method Details

.attribute_map ⇒ Object

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



25
26
27
28
29
30
31
32
33
 
# File 'lib/oci/generative_ai_inference/models/completion_tokens_details.rb', line 25

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'accepted_prediction_tokens': :'acceptedPredictionTokens',
    'reasoning_tokens': :'reasoningTokens',
    'rejected_prediction_tokens': :'rejectedPredictionTokens'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



36
37
38
39
40
41
42
43
44
 
# File 'lib/oci/generative_ai_inference/models/completion_tokens_details.rb', line 36

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'accepted_prediction_tokens': :'Integer',
    'reasoning_tokens': :'Integer',
    'rejected_prediction_tokens': :'Integer'
    # 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



87
88
89
90
91
92
93
94
 
# File 'lib/oci/generative_ai_inference/models/completion_tokens_details.rb', line 87

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

  self.class == other.class &&
    accepted_prediction_tokens == other.accepted_prediction_tokens &&
    reasoning_tokens == other.reasoning_tokens &&
    rejected_prediction_tokens == other.rejected_prediction_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



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/oci/generative_ai_inference/models/completion_tokens_details.rb', line 119

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


99
100
101
 
# File 'lib/oci/generative_ai_inference/models/completion_tokens_details.rb', line 99

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



108
109
110
 
# File 'lib/oci/generative_ai_inference/models/completion_tokens_details.rb', line 108

def hash
  [accepted_prediction_tokens, reasoning_tokens, rejected_prediction_tokens].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



152
153
154
155
156
157
158
159
160
161
 
# File 'lib/oci/generative_ai_inference/models/completion_tokens_details.rb', line 152

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



146
147
148
 
# File 'lib/oci/generative_ai_inference/models/completion_tokens_details.rb', line 146

def to_s
  to_hash.to_s
end