Class Candidate (1.51.0)

Candidate(mapping=None, *, ignore_unknown_fields=False, **kwargs)

A response candidate generated from the model.

Attributes
Name	Description
`index`	`int` Output only. Index of the candidate.
`content`	`google.cloud.aiplatform_v1.types.Content` Output only. Content parts of the candidate.
`finish_reason`	`google.cloud.aiplatform_v1.types.Candidate.FinishReason` Output only. The reason why the model stopped generating tokens. If empty, the model has not stopped generating the tokens.
`safety_ratings`	`MutableSequence[google.cloud.aiplatform_v1.types.SafetyRating]` Output only. List of ratings for the safety of a response candidate. There is at most one rating per category.
`finish_message`	`str` Output only. Describes the reason the mode stopped generating tokens in more detail. This is only filled when `finish_reason` is set. This field is a member of `oneof`_ `_finish_message`.
`citation_metadata`	`google.cloud.aiplatform_v1.types.CitationMetadata` Output only. Source attribution of the generated content.
`grounding_metadata`	`google.cloud.aiplatform_v1.types.GroundingMetadata` Output only. Metadata specifies sources used to ground generated content.

Classes

FinishReason(value)

The reason why the model stopped generating tokens. If empty, the model has not stopped generating the tokens.

Candidate(mapping=None, *, ignore_unknown_fields=False, **kwargs)

A response candidate generated from the model.