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.

Properties

CitationMetadata

CitationMetadata Firebase::AI::Candidate::CitationMetadata

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

Content

ModelContent Firebase::AI::Candidate::Content

The response’s content.

FinishReason

FinishReason Firebase::AI::Candidate::FinishReason

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

GroundingMetadata

GroundingMetadata Firebase::AI::Candidate::GroundingMetadata

Grounding metadata for the response, if any.

SafetyRatings

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

The safety rating of the response content.

UrlContextMetadata

UrlContextMetadata Firebase::AI::Candidate::UrlContextMetadata

Metadata related to the URLContext tool.