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 %}

GenerationConfig interface

Config options for content-related requests

Signature:

typescript

export interface GenerationConfig

Properties

Property	Type	Description
candidateCount	number
frequencyPenalty	number
maxOutputTokens	number
presencePenalty	number
responseJsonSchema	{ [key: string]: unknown; }	Output schema of the generated response. This is an alternative to <code>responseSchema</code> that accepts [JSON Schema](https://json-schema.org/).<!-- -->If set, <code>responseSchema</code> must be omitted, but <code>responseMimeType</code> is required and must be set to <code>application/json</code>.
responseMimeType	string	Output response MIME type of the generated candidate text. Supported MIME types are <code>text/plain</code> (default, text output), <code>application/json</code> (JSON response in the candidates), and <code>text/x.enum</code>.
responseModalities	ResponseModality<!-- -->[]	<b><i>(Public Preview)</i></b> Generation modalities to be returned in generation responses.
responseSchema	TypedSchema \| SchemaRequest	Output response schema of the generated candidate text. This value can be a class generated with a Schema static method like <code>Schema.string()</code> or <code>Schema.object()</code> or it can be a plain JS object matching the SchemaRequest interface.
Note: This only applies when the specified <code>responseMimeType</code> supports a schema; currently this is limited to <code>application/json</code> and <code>text/x.enum</code>.
stopSequences	string[]
temperature	number
thinkingConfig	ThinkingConfig	Configuration for "thinking" behavior of compatible Gemini models.
topK	number
topP	number

GenerationConfig.candidateCount

Signature:

typescript

candidateCount?: number;

GenerationConfig.frequencyPenalty

Signature:

typescript

frequencyPenalty?: number;

GenerationConfig.maxOutputTokens

Signature:

typescript

maxOutputTokens?: number;

GenerationConfig.presencePenalty

Signature:

typescript

presencePenalty?: number;

GenerationConfig.responseJsonSchema

Output schema of the generated response. This is an alternative to responseSchema that accepts [JSON Schema](https://json-schema.org/).

If set, responseSchema must be omitted, but responseMimeType is required and must be set to application/json.

Signature:

typescript

responseJsonSchema?: {
        [key: string]: unknown;
    };

GenerationConfig.responseMimeType

Output response MIME type of the generated candidate text. Supported MIME types are text/plain (default, text output), application/json (JSON response in the candidates), and text/x.enum.

Signature:

typescript

responseMimeType?: string;

GenerationConfig.responseModalities

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Generation modalities to be returned in generation responses.

Multimodal response generation is only supported by some Gemini models and versions; see model versions. - Only image generation (ResponseModality.IMAGE) is supported.

Signature:

typescript

responseModalities?: ResponseModality[];

GenerationConfig.responseSchema

Output response schema of the generated candidate text. This value can be a class generated with a Schema static method like Schema.string() or Schema.object() or it can be a plain JS object matching the SchemaRequest interface. Note: This only applies when the specified responseMimeType supports a schema; currently this is limited to application/json and text/x.enum.

Signature:

typescript

responseSchema?: TypedSchema | SchemaRequest;

GenerationConfig.stopSequences

Signature:

typescript

stopSequences?: string[];

GenerationConfig.temperature

Signature:

typescript

temperature?: number;

GenerationConfig.thinkingConfig

Configuration for "thinking" behavior of compatible Gemini models.

Signature:

typescript

thinkingConfig?: ThinkingConfig;

GenerationConfig.topK

Signature:

typescript

topK?: number;

GenerationConfig.topP

Signature:

typescript

topP?: number;