Candidate

classCandidate


ACandidate represents a single response generated by the model for a given request.

Summary

Public properties

CitationMetadata?

Metadata about the sources used to generate this content.

Content

The actual content generated by the model.

FinishReason?

The reason the model stopped generating content, if it exist.

GroundingMetadata?

Metadata returned to the client when the model grounds its response.

List<SafetyRating>

A list ofSafetyRatings describing the generated content.

UrlContextMetadata?

Metadata returned to the client when theUrlContext tool is enabled.

Public properties

citationMetadata

val citationMetadataCitationMetadata?

Metadata about the sources used to generate this content.

content

val contentContent

The actual content generated by the model.

finishReason

val finishReasonFinishReason?

The reason the model stopped generating content, if it exist.

groundingMetadata

val groundingMetadataGroundingMetadata?

Metadata returned to the client when the model grounds its response.

safetyRatings

val safetyRatingsList<SafetyRating>

A list ofSafetyRatings describing the generated content.

urlContextMetadata

@PublicPreviewAPI
val urlContextMetadataUrlContextMetadata?

Metadata returned to the client when theUrlContext tool is enabled.

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-10-09 UTC.