Back to Firebase Js Sdk

GenerateContentCandidate interface

docs-devsite/ai.generatecontentcandidate.md

12.12.12.6 KB
Original Source

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<!-- -->.

<b>Signature:</b>

typescript
export interface GenerateContentCandidate 

Properties

PropertyTypeDescription
citationMetadataCitationMetadata
contentContent
finishMessagestring
finishReasonFinishReason
groundingMetadataGroundingMetadata
indexnumber
safetyRatingsSafetyRating<!-- -->[]
urlContextMetadataURLContextMetadata

GenerateContentCandidate.citationMetadata

<b>Signature:</b>

typescript
citationMetadata?: CitationMetadata;

GenerateContentCandidate.content

<b>Signature:</b>

typescript
content: Content;

GenerateContentCandidate.finishMessage

<b>Signature:</b>

typescript
finishMessage?: string;

GenerateContentCandidate.finishReason

<b>Signature:</b>

typescript
finishReason?: FinishReason;

GenerateContentCandidate.groundingMetadata

<b>Signature:</b>

typescript
groundingMetadata?: GroundingMetadata;

GenerateContentCandidate.index

<b>Signature:</b>

typescript
index: number;

GenerateContentCandidate.safetyRatings

<b>Signature:</b>

typescript
safetyRatings?: SafetyRating[];

GenerateContentCandidate.urlContextMetadata

<b>Signature:</b>

typescript
urlContextMetadata?: URLContextMetadata;