Package com.google.genkit.plugins.googlegenai

Class ImagenModel

java.lang.Object

com.google.genkit.plugins.googlegenai.ImagenModel

All Implemented Interfaces:

Model, Action<ModelRequest,ModelResponse,ModelResponseChunk>, Registerable

public class ImagenModel
extends Object
implements Model

Imagen model implementation for image generation using the official Google GenAI SDK.

Imagen is Google's text-to-image model that generates high-quality images from text prompts.

Configuration options (passed via request.config):

• numberOfImages - Number of images to generate (1-4)
• aspectRatio - Aspect ratio: "1:1", "3:4", "4:3", "9:16", "16:9"
• personGeneration - Control people generation: "dont_allow", "allow_adult", "allow_all"
• negativePrompt - Description of what to avoid in the generated images
• outputMimeType - MIME type of output: "image/png" or "image/jpeg"

Constructor Summary

Constructors

Constructor	Description
ImagenModel(String modelName, GoogleGenAIPluginOptions options)	Creates a new ImagenModel.

Method Summary

Modifier and Type	Method	Description
ModelInfo	getInfo()	Gets information about the model's capabilities.
String	getName()	Returns the name of the action.
ModelResponse	run(ActionContext context, ModelRequest request)	Generates a response from the given request.
ModelResponse	run(ActionContext context, ModelRequest request, Consumer<ModelResponseChunk> streamCallback)	Generates a streaming response from the given request.
boolean	supportsStreaming()	Returns whether this model supports streaming.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.google.genkit.ai.Model

getDesc, getInputSchema, getMetadata, getOutputSchema, getType, register, runJson, runJsonWithTelemetry

Constructor Details

ImagenModel

public ImagenModel(String modelName,
 GoogleGenAIPluginOptions options)

Creates a new ImagenModel.

Parameters:

modelName - the model name (e.g., "imagen-3.0-generate-002")

options - the plugin options

Method Details

getName

public String getName()

Description copied from interface: Action

Returns the name of the action.

Specified by:

getName in interface Action<ModelRequest,ModelResponse,ModelResponseChunk>

Returns:

the action name

getInfo

public ModelInfo getInfo()

Description copied from interface: Model

Gets information about the model's capabilities.

Specified by:

getInfo in interface Model

Returns:

the model info

supportsStreaming

public boolean supportsStreaming()

Description copied from interface: Model

Returns whether this model supports streaming.

Specified by:

supportsStreaming in interface Model

Returns:

true if streaming is supported

run

public ModelResponse run(ActionContext context,
 ModelRequest request)

Description copied from interface: Model

Generates a response from the given request.

Specified by:

run in interface Action<ModelRequest,ModelResponse,ModelResponseChunk>

Specified by:

run in interface Model

Parameters:

context - the action context

request - the model request

Returns:

the model response

run

public ModelResponse run(ActionContext context,
 ModelRequest request,
 Consumer<ModelResponseChunk> streamCallback)

Description copied from interface: Model

Generates a streaming response from the given request.

Specified by:

run in interface Action<ModelRequest,ModelResponse,ModelResponseChunk>

Specified by:

run in interface Model

Parameters:

context - the action context

request - the model request

streamCallback - callback for streaming chunks

Returns:

the final model response