Class: OCI::GenerativeAiInference::Models::LogProbability

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

Overview

The log probabilities of the generated tokens.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ LogProbability

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :token_ids (Array<Integer>) —

    The value to assign to the #token_ids property

  • :text (String) —

    The value to assign to the #text property

  • :log_probabilities (Array<Float>) —

    The value to assign to the #log_probabilities property



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/oci/generative_ai_inference/models/log_probability.rb', line 54

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

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

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

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

  self.log_probabilities = attributes[:'logProbabilities'] if attributes[:'logProbabilities']

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

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

Instance Attribute Details

#log_probabilities ⇒ Array<Float>

The log probability of each token used to construct the text chunk.

Returns:

  • (Array<Float>) 


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

def log_probabilities
  @log_probabilities
end

#text ⇒ String

The text chunk for which the log probabilities was calculated.

Returns:

  • (String) 


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

def text
  @text
end

#token_ids ⇒ Array<Integer>

The token ids of each token used to construct the text chunk.

Returns:

  • (Array<Integer>) 


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

def token_ids
  @token_ids
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'token_ids': :'tokenIds',
    'text': :'text',
    'log_probabilities': :'logProbabilities'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'token_ids': :'Array<Integer>',
    'text': :'String',
    'log_probabilities': :'Array<Float>'
    # 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



82
83
84
85
86
87
88
89
 
# File 'lib/oci/generative_ai_inference/models/log_probability.rb', line 82

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

  self.class == other.class &&
    token_ids == other.token_ids &&
    text == other.text &&
    log_probabilities == other.log_probabilities
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



114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/oci/generative_ai_inference/models/log_probability.rb', line 114

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


94
95
96
 
# File 'lib/oci/generative_ai_inference/models/log_probability.rb', line 94

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



103
104
105
 
# File 'lib/oci/generative_ai_inference/models/log_probability.rb', line 103

def hash
  [token_ids, text, log_probabilities].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



147
148
149
150
151
152
153
154
155
156
 
# File 'lib/oci/generative_ai_inference/models/log_probability.rb', line 147

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



141
142
143
 
# File 'lib/oci/generative_ai_inference/models/log_probability.rb', line 141

def to_s
  to_hash.to_s
end