Immutable set of parameters for a single image generation request, built via ImageGenerationOptionsBuilder and passed to ImageGenerationManager.generateImage. Wraps the model to use together with the prompt and formatting choices, and is produced by app code and consumed by the matching ImageProvider.


Properties

PropertyReturnsDescription
countIntegerThe number of images to generate for this request.
modelImageModelThe image model this request is targeted at. The provider that owns this model is resolved from its provider name when the request is generated.
promptStringThe text description of the image or images to generate.
sizeStringThe requested dimensions of the generated images, for example "1024x1024". Valid values depend on the target model, see ImageModel.getSizes().
styleStringThe requested visual style of the generated images. Supported values are provider and model specific.
usageStringIdentifies who is making this request, typically the calling app name or task, for reporting and rate limiting purposes.

Methods

getModel()

Returns: ImageModel

The image model this request is targeted at. The provider that owns this model is resolved from its provider name when the request is generated.

getUsage()

Returns: String

Identifies who is making this request, typically the calling app name or task, for reporting and rate limiting purposes.

getPrompt()

Returns: String

The text description of the image or images to generate.

getCount()

Returns: Integer

The number of images to generate for this request.

getSize()

Returns: String

The requested dimensions of the generated images, for example "1024x1024". Valid values depend on the target model, see ImageModel.getSizes().

getStyle()

Returns: String

The requested visual style of the generated images. Supported values are provider and model specific.

To get full access to the Kademi Hub existing customers can login here, or new customers can register here.