Class: OCI::GenerativeAiInference::Models::Logprobs

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

Overview

Includes the logarithmic probabilities for the most likely output tokens and the chosen tokens.

For example, if the log probability is 5, the API returns a list of the 5 most likely tokens. The API returns the log probability of the sampled token, so there might be up to logprobs+1 elements in the response.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Logprobs

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :text_offset (Array<Integer>) —

    The value to assign to the #text_offset property

  • :token_logprobs (Array<Float>) —

    The value to assign to the #token_logprobs property

  • :tokens (Array<String>) —

    The value to assign to the #tokens property

  • :top_logprobs (Array<Hash<String, String>>) —

    The value to assign to the #top_logprobs property



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/oci/generative_ai_inference/models/logprobs.rb', line 64

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

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

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

  self.token_logprobs = attributes[:'tokenLogprobs'] if attributes[:'tokenLogprobs']

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

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

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

  self.top_logprobs = attributes[:'topLogprobs'] if attributes[:'topLogprobs']

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

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

Instance Attribute Details

#text_offset ⇒ Array<Integer>

The text offset.

Returns:

  • (Array<Integer>) 


16
17
18
 
# File 'lib/oci/generative_ai_inference/models/logprobs.rb', line 16

def text_offset
  @text_offset
end

#token_logprobs ⇒ Array<Float>

The logarithmic probabilites of the output token.

Returns:

  • (Array<Float>) 


20
21
22
 
# File 'lib/oci/generative_ai_inference/models/logprobs.rb', line 20

def token_logprobs
  @token_logprobs
end

#tokens ⇒ Array<String>

The list of output tokens.

Returns:

  • (Array<String>) 


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

def tokens
  @tokens
end

#top_logprobs ⇒ Array<Hash<String, String>>

The logarithmic probabilities of each of the top k tokens.

Returns:

  • (Array<Hash<String, String>>) 


28
29
30
 
# File 'lib/oci/generative_ai_inference/models/logprobs.rb', line 28

def top_logprobs
  @top_logprobs
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'text_offset': :'textOffset',
    'token_logprobs': :'tokenLogprobs',
    'tokens': :'tokens',
    'top_logprobs': :'topLogprobs'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'text_offset': :'Array<Integer>',
    'token_logprobs': :'Array<Float>',
    'tokens': :'Array<String>',
    'top_logprobs': :'Array<Hash<String, String>>'
    # 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



98
99
100
101
102
103
104
105
106
 
# File 'lib/oci/generative_ai_inference/models/logprobs.rb', line 98

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

  self.class == other.class &&
    text_offset == other.text_offset &&
    token_logprobs == other.token_logprobs &&
    tokens == other.tokens &&
    top_logprobs == other.top_logprobs
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



131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/oci/generative_ai_inference/models/logprobs.rb', line 131

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


111
112
113
 
# File 'lib/oci/generative_ai_inference/models/logprobs.rb', line 111

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



120
121
122
 
# File 'lib/oci/generative_ai_inference/models/logprobs.rb', line 120

def hash
  [text_offset, token_logprobs, tokens, top_logprobs].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



164
165
166
167
168
169
170
171
172
173
 
# File 'lib/oci/generative_ai_inference/models/logprobs.rb', line 164

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



158
159
160
 
# File 'lib/oci/generative_ai_inference/models/logprobs.rb', line 158

def to_s
  to_hash.to_s
end