3.5 KiB
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 %}
TemplateImagenModel class
Warning: This API is now obsolete.
All Imagen models are deprecated and will shut down as early as June 2026. As a replacement, you can migrate your apps to use Gemini Image models (the "Nano Banana" models).
Class for Imagen model APIs that execute on a server-side template.
This class should only be instantiated with getTemplateImagenModel().
Signature:
export declare class TemplateImagenModel
Constructors
| Constructor | Modifiers | Description |
|---|---|---|
| (constructor)(ai, requestOptions) | Constructs a new instance of the TemplateImagenModel class |
Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| requestOptions | RequestOptions | Additional options to use when making requests. |
Methods
| Method | Modifiers | Description |
|---|---|---|
| generateImages(templateId, templateVariables, singleRequestOptions) | (Public Preview) Makes a single call to the model and returns an object containing a single ImagenGenerationResponse. |
TemplateImagenModel.(constructor)
Constructs a new instance of the TemplateImagenModel class
Signature:
constructor(ai: AI, requestOptions?: RequestOptions);
Parameters
| Parameter | Type | Description |
|---|---|---|
| ai | AI | |
| requestOptions | RequestOptions |
TemplateImagenModel.requestOptions
Additional options to use when making requests.
Signature:
requestOptions?: RequestOptions;
TemplateImagenModel.generateImages()
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.
Makes a single call to the model and returns an object containing a single ImagenGenerationResponse.
Signature:
generateImages(templateId: string, templateVariables: object, singleRequestOptions?: SingleRequestOptions): Promise<ImagenGenerationResponse<ImagenInlineImage>>;
Parameters
| Parameter | Type | Description |
|---|---|---|
| templateId | string | The ID of the server-side template to execute. |
| templateVariables | object | A key-value map of variables to populate the template with. |
| singleRequestOptions | SingleRequestOptions |
Returns:
Promise<ImagenGenerationResponse<ImagenInlineImage>>