Vertex AI V1 API - Class Google::Cloud::AIPlatform::V1::Candidate (v0.61.0)

Version latest

• 0.61.0 (latest)
• 0.60.0
• 0.59.0
• 0.58.0
• 0.57.0
• 0.56.0
• 0.55.0
• 0.54.0
• 0.53.0
• 0.52.0
• 0.51.0
• 0.50.0
• 0.49.0
• 0.48.0
• 0.47.0
• 0.46.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.42.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.38.0
• 0.37.0
• 0.36.0
• 0.35.0
• 0.34.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.21.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.1
• 0.8.0
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.0

Reference documentation and code samples for the Vertex AI V1 API class Google::Cloud::AIPlatform::V1::Candidate.

A response candidate generated from the model.

Inherits

• Object

Extended By

• Google::Protobuf::MessageExts::ClassMethods

Includes

• Google::Protobuf::MessageExts

Methods

#avg_logprobs

def avg_logprobs() -> ::Float

Returns

• (::Float) — Output only. Average log probability score of the candidate.

#citation_metadata

def citation_metadata() -> ::Google::Cloud::AIPlatform::V1::CitationMetadata

Returns

• (::Google::Cloud::AIPlatform::V1::CitationMetadata) — Output only. Source attribution of the generated content.

#content

def content() -> ::Google::Cloud::AIPlatform::V1::Content

Returns

• (::Google::Cloud::AIPlatform::V1::Content) — Output only. Content parts of the candidate.

#finish_message

def finish_message() -> ::String

Returns

• (::String) — Output only. Describes the reason the mode stopped generating tokens in more detail. This is only filled when finish_reason is set.

#finish_reason

def finish_reason() -> ::Google::Cloud::AIPlatform::V1::Candidate::FinishReason

Returns

• (::Google::Cloud::AIPlatform::V1::Candidate::FinishReason) — Output only. The reason why the model stopped generating tokens. If empty, the model has not stopped generating the tokens.

#grounding_metadata

def grounding_metadata() -> ::Google::Cloud::AIPlatform::V1::GroundingMetadata

Returns

• (::Google::Cloud::AIPlatform::V1::GroundingMetadata) — Output only. Metadata specifies sources used to ground generated content.

#index

def index() -> ::Integer

Returns

• (::Integer) — Output only. Index of the candidate.

#logprobs_result

def logprobs_result() -> ::Google::Cloud::AIPlatform::V1::LogprobsResult

Returns

• (::Google::Cloud::AIPlatform::V1::LogprobsResult) — Output only. Log-likelihood scores for the response tokens and top tokens

#safety_ratings

def safety_ratings() -> ::Array<::Google::Cloud::AIPlatform::V1::SafetyRating>

Returns

• (::Array<::Google::Cloud::AIPlatform::V1::SafetyRating>) — Output only. List of ratings for the safety of a response candidate.

  There is at most one rating per category.

#score

def score() -> ::Float

Returns

• (::Float) — Output only. Confidence score of the candidate.