Vertex AI V1 API - Class Google::Cloud::AIPlatform::V1::Candidate (v0.36.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

#citation_metadata

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

#content

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

#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

#index

def index() -> ::Integer
Returns
  • (::Integer) — Output only. Index of the candidate.

#safety_ratings

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