Firebase.AI.Candidate

A struct representing a possible reply to a content generation prompt.

Summary

Each content generation prompt may produce multiple candidate responses.

Properties
`CitationMetadata`	`CitationMetadata` Cited works in the model’s response content, if it exists.
`Content`	`ModelContent` The response’s content.
`FinishReason`	`FinishReason` The reason the model stopped generating content, if it exists; for example, if the model generated a predefined stop sequence.
`GroundingMetadata`	`GroundingMetadata` Grounding metadata for the response, if any.
`SafetyRatings`	`IReadOnlyList<SafetyRating >` The safety rating of the response content.
`UrlContextMetadata`	`UrlContextMetadata` Metadata related to the`URLContext` tool.

CitationMetadataFirebase::AI::Candidate::CitationMetadata

Cited works in the model’s response content, if it exists.

ModelContentFirebase::AI::Candidate::Content

The response’s content.

FinishReasonFirebase::AI::Candidate::FinishReason

The reason the model stopped generating content, if it exists; for example, if the model generated a predefined stop sequence.

GroundingMetadataFirebase::AI::Candidate::GroundingMetadata

Grounding metadata for the response, if any.

IReadOnlyList<SafetyRating>Firebase::AI::Candidate::SafetyRatings

The safety rating of the response content.

UrlContextMetadataFirebase::AI::Candidate::UrlContextMetadata

Metadata related to theURLContext tool.

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-16 UTC.