Package org.springframework.ai.image

Class ImagePrompt

java.lang.Object

org.springframework.ai.image.ImagePrompt

All Implemented Interfaces:

ModelRequest<List<ImageMessage>>

public class ImagePrompt
extends Object
implements ModelRequest<List<ImageMessage>>

Constructor Summary

Constructors

Constructor	Description
ImagePrompt(String instructions)
ImagePrompt(String instructions, ImageOptions imageOptions)
ImagePrompt(List<ImageMessage> messages)
ImagePrompt(List<ImageMessage> messages, ImageOptions imageModelOptions)
ImagePrompt(ImageMessage imageMessage, ImageOptions imageOptions)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
List<ImageMessage>	getInstructions()	Retrieves the instructions or input required by the AI model.
ImageOptions	getOptions()	Retrieves the customizable options for AI model interactions.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

ImagePrompt

public ImagePrompt(List<ImageMessage> messages)

ImagePrompt

public ImagePrompt(List<ImageMessage> messages,
 ImageOptions imageModelOptions)

ImagePrompt

public ImagePrompt(ImageMessage imageMessage,
 ImageOptions imageOptions)

ImagePrompt

public ImagePrompt(String instructions,
 ImageOptions imageOptions)

ImagePrompt

public ImagePrompt(String instructions)

Method Details

getInstructions

public List<ImageMessage> getInstructions()

Description copied from interface: ModelRequest

Retrieves the instructions or input required by the AI model.

Specified by:

getInstructions in interface ModelRequest<List<ImageMessage>>

Returns:

the instructions or input required by the AI model

getOptions

public ImageOptions getOptions()

Description copied from interface: ModelRequest

Retrieves the customizable options for AI model interactions.

Specified by:

getOptions in interface ModelRequest<List<ImageMessage>>

Returns:

the customizable options for AI model interactions

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object