public final class GenerateImageRequest

  1. Object
  2. GenerateImageRequest
Request payload for ImageGenerator.generate(GenerateImageRequest). Mutable image-generation request shared by the supported providers. Provider-specific values that are unsupported may be ignored or rejected by the selected ImageGenerator.

Constructors

public GenerateImageRequest(String prompt)Creates a request with required prompt text.

Methods

public String getPrompt()
public String getModel()
public GenerateImageRequest setModel(String model)
public String getSize()
public GenerateImageRequest setSize(String size)"1024x1024", "1024x1792", "1792x1024" for DALL-E 3. Default is "1024x1024".
public String getStyle()
public GenerateImageRequest setStyle(String style)
public String getQuality()
public GenerateImageRequest setQuality(String quality)
public int getCount()
public GenerateImageRequest setCount(int count)Number of images to generate (DALL-E 3 supports 1; older models up to 10).
public Long getSeed()
public GenerateImageRequest setSeed(Long seed)

Inherited methods

From Object

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

Constructor details

GenerateImageRequest

public GenerateImageRequest(String prompt)
Creates a request with required prompt text.

Parameters

prompt String
description of the image to generate

Method details

getPrompt

public String getPrompt()

Returns

image description sent to the provider

getModel

public String getModel()

Returns

requested model id, or null for generator default

setModel

public GenerateImageRequest setModel(String model)

Parameters

model String
provider model id, or null for generator default

Returns

this request

getSize

public String getSize()

Returns

requested dimensions such as 1024x1024

setSize

public GenerateImageRequest setSize(String size)
"1024x1024", "1024x1792", "1792x1024" for DALL-E 3. Default is "1024x1024".

getStyle

public String getStyle()

Returns

provider style value, or null when unspecified

setStyle

public GenerateImageRequest setStyle(String style)

Parameters

style String
provider-specific rendering style, or null

Returns

this request

getQuality

public String getQuality()

Returns

provider quality tier, or null when unspecified

setQuality

public GenerateImageRequest setQuality(String quality)

Parameters

quality String
provider-specific quality tier, or null

Returns

this request

getCount

public int getCount()

Returns

requested image count

setCount

public GenerateImageRequest setCount(int count)
Number of images to generate (DALL-E 3 supports 1; older models up to 10).

getSeed

public Long getSeed()

Returns

deterministic seed, or null when unspecified

setSeed

public GenerateImageRequest setSeed(Long seed)

Parameters

seed Long
deterministic seed where supported, or null

Returns

this request