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

class Candidate

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

Summary

Public properties
`CitationMetadata?`	`citationMetadata` Metadata about the sources used to generate this content.
`Content`	`content` The actual content generated by the model.
`String?`	`finishMessage` The optional message associated with the finish reason, providing more details.
`FinishReason?`	`finishReason` The reason the model stopped generating content, if it exists.
`GroundingMetadata?`	`groundingMetadata` Metadata returned to the client when the model grounds its response.
`List<SafetyRating>`	`safetyRatings` A list of `SafetyRating`s describing the generated content.
`UrlContextMetadata?`	`urlContextMetadata` Metadata returned to the client when the `UrlContext` tool is enabled.

Public properties

citationMetadata

val citationMetadata: CitationMetadata?

Metadata about the sources used to generate this content.

content

val content: Content

The actual content generated by the model.

finishMessage

val finishMessage: String?

The optional message associated with the finish reason, providing more details.

finishReason

val finishReason: FinishReason?

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

groundingMetadata

val groundingMetadata: GroundingMetadata?

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

safetyRatings

val safetyRatings: List<SafetyRating>

A list of SafetyRatings describing the generated content.

urlContextMetadata

val urlContextMetadata: UrlContextMetadata?

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