IMPORTANT: In July 2025, we stopped releasing new versions of KTX modules, and we removed the KTX libraries from the Firebase Android BoM (v34.0.0). If you use KTX APIs from the previously released KTX modules, we recommend that you migrate your app to use KTX APIs from the main modules instead. For details, see the FAQ about this initiative.

Candidate

public final class Candidate

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

Summary

Public fields
`final CitationMetadata`	`citationMetadata` Metadata about the sources used to generate this content.
`final @NonNull Content`	`content` The actual content generated by the model.
`final FinishReason`	`finishReason` The reason the model stopped generating content, if it exist.
`final GroundingMetadata`	`groundingMetadata` Metadata returned to the client when the model grounds its response.
`final @NonNull List<@NonNull SafetyRating>`	`safetyRatings` A list of `SafetyRating`s describing the generated content.
`final UrlContextMetadata`	`@PublicPreviewAPI urlContextMetadata` Metadata returned to the client when the `UrlContext` tool is enabled.

Public fields

citationMetadata

public final CitationMetadata citationMetadata

Metadata about the sources used to generate this content.

content

public final @NonNull Content content

The actual content generated by the model.

finishReason

public final FinishReason finishReason

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

groundingMetadata

public final GroundingMetadata groundingMetadata

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

safetyRatings

public final @NonNull List<@NonNull SafetyRating> safetyRatings

A list of SafetyRatings describing the generated content.

urlContextMetadata

@PublicPreviewAPI
public final UrlContextMetadata urlContextMetadata

Metadata returned to the client when the UrlContext tool is enabled.