Class: Google::Apis::AiplatformV1::GoogleCloudAiplatformV1LogprobsResultCandidate

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/aiplatform_v1/classes.rb,
lib/google/apis/aiplatform_v1/representations.rb,
lib/google/apis/aiplatform_v1/representations.rb

Overview

A single token and its associated log probability.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudAiplatformV1LogprobsResultCandidate

Returns a new instance of GoogleCloudAiplatformV1LogprobsResultCandidate.



23499
23500
23501
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 23499

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#log_probability ⇒ Float

The log probability of this token. A higher value indicates that the model was more confident in this token. The log probability can be used to assess the relative likelihood of different tokens and to identify when the model is uncertain. Corresponds to the JSON property logProbability

Returns:

  • (Float) 


23484
23485
23486
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 23484

def log_probability
  @log_probability
end

#token ⇒ String

The token's string representation. Corresponds to the JSON property token

Returns:

  • (String) 


23489
23490
23491
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 23489

def token
  @token
end

#token_id ⇒ Fixnum

The token's numerical ID. While the token field provides the string representation of the token, the token_id is the numerical representation that the model uses internally. This can be useful for developers who want to build custom logic based on the model's vocabulary. Corresponds to the JSON property tokenId

Returns:

  • (Fixnum) 


23497
23498
23499
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 23497

def token_id
  @token_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



23504
23505
23506
23507
23508
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 23504

def update!(**args)
  @log_probability = args[:log_probability] if args.key?(:log_probability)
  @token = args[:token] if args.key?(:token)
  @token_id = args[:token_id] if args.key?(:token_id)
end