Class: OCI::GenerativeAiInference::Models::GeneratedText

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

Overview

The text generated during each run.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ GeneratedText

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/oci/generative_ai_inference/models/generated_text.rb', line 74

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

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

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

  self.finish_reason = attributes[:'finishReason'] if attributes[:'finishReason']

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

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

  self.token_likelihoods = attributes[:'tokenLikelihoods'] if attributes[:'tokenLikelihoods']

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

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

Instance Attribute Details

#finish_reason ⇒ String

The reason why the model stopped generating tokens.

A model stops generating tokens if the model hits a natural stop point or reaches a provided stop sequence.

Returns:

  • (String) 


31
32
33
 
# File 'lib/oci/generative_ai_inference/models/generated_text.rb', line 31

def finish_reason
  @finish_reason
end

#id ⇒ String

[Required] A unique identifier for this text generation.

Returns:

  • (String) 


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

def id
  @id
end

#likelihood ⇒ Float

[Required] The overall likelihood of the generated text.

When a large language model generates a new token for the output text, a likelihood is assigned to all tokens, where tokens with higher likelihoods are more likely to follow the current token. For example, it's more likely that the word favorite is followed by the word food or book rather than the word zebra. A lower likelihood means that it's less likely that token follows the current token.

Returns:

  • (Float) 


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

def likelihood
  @likelihood
end

#text ⇒ String

[Required] The generated text.

Returns:

  • (String) 


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

def text
  @text
end

#token_likelihoods ⇒ Array<OCI::GenerativeAiInference::Models::TokenLikelihood>

A collection of generated tokens and their corresponding likelihoods.

Returns:



35
36
37
 
# File 'lib/oci/generative_ai_inference/models/generated_text.rb', line 35

def token_likelihoods
  @token_likelihoods
end

Class Method Details

.attribute_map ⇒ Object

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



38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/oci/generative_ai_inference/models/generated_text.rb', line 38

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'text': :'text',
    'likelihood': :'likelihood',
    'finish_reason': :'finishReason',
    'token_likelihoods': :'tokenLikelihoods'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/oci/generative_ai_inference/models/generated_text.rb', line 51

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'text': :'String',
    'likelihood': :'Float',
    'finish_reason': :'String',
    'token_likelihoods': :'Array<OCI::GenerativeAiInference::Models::TokenLikelihood>'
    # 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



106
107
108
109
110
111
112
113
114
115
 
# File 'lib/oci/generative_ai_inference/models/generated_text.rb', line 106

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

  self.class == other.class &&
    id == other.id &&
    text == other.text &&
    likelihood == other.likelihood &&
    finish_reason == other.finish_reason &&
    token_likelihoods == other.token_likelihoods
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



140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
 
# File 'lib/oci/generative_ai_inference/models/generated_text.rb', line 140

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


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

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



129
130
131
 
# File 'lib/oci/generative_ai_inference/models/generated_text.rb', line 129

def hash
  [id, text, likelihood, finish_reason, token_likelihoods].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



173
174
175
176
177
178
179
180
181
182
 
# File 'lib/oci/generative_ai_inference/models/generated_text.rb', line 173

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



167
168
169
 
# File 'lib/oci/generative_ai_inference/models/generated_text.rb', line 167

def to_s
  to_hash.to_s
end