firebase-js-sdk/docs-devsite/ai.generatecontentcandidate.md

Project: /docs/reference/js/_project.yaml Book: /docs/reference/_book.yaml page_type: reference

{% comment %} DO NOT EDIT THIS FILE! This is generated by the JS SDK team, and any local changes will be overwritten. Changes should be made in the source code at https://github.com/firebase/firebase-js-sdk {% endcomment %}

GenerateContentCandidate interface

A candidate returned as part of a GenerateContentResponse.

Signature:

export interface GenerateContentCandidate 

Properties

Property	Type	Description
citationMetadata	CitationMetadata
content	Content
finishMessage	string
finishReason	FinishReason
groundingMetadata	GroundingMetadata
index	number
safetyRatings	SafetyRating[]
urlContextMetadata	URLContextMetadata

GenerateContentCandidate.citationMetadata

Signature:

citationMetadata?: CitationMetadata;

GenerateContentCandidate.content

Signature:

content: Content;

GenerateContentCandidate.finishMessage

Signature:

finishMessage?: string;

GenerateContentCandidate.finishReason

Signature:

finishReason?: FinishReason;

GenerateContentCandidate.groundingMetadata

Signature:

groundingMetadata?: GroundingMetadata;

GenerateContentCandidate.index

Signature:

index: number;

GenerateContentCandidate.safetyRatings

Signature:

safetyRatings?: SafetyRating[];

GenerateContentCandidate.urlContextMetadata

Signature:

urlContextMetadata?: URLContextMetadata;