Package org.springframework.ai.image

Class ImageResponse

java.lang.Object

org.springframework.ai.image.ImageResponse

All Implemented Interfaces:

ModelResponse<ImageGeneration>

public class ImageResponse
extends Object
implements ModelResponse<ImageGeneration>

The image completion (e.g. imageGeneration) response returned by an AI provider.

Author:

Mark Pollack, Christian Tzolov, Hyunjoon Choi

Constructor Summary

Constructors

Constructor	Description
ImageResponse(List<ImageGeneration> generations)	Construct a new ImageResponse instance without metadata.
ImageResponse(List<ImageGeneration> generations, ImageResponseMetadata imageResponseMetadata)	Construct a new ImageResponse instance.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
ImageResponseMetadata	getMetadata()	Retrieves the response metadata associated with the AI model's response.
ImageGeneration	getResult()	Retrieves the result of the AI model.
List<ImageGeneration>	getResults()	The List of generated outputs.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

ImageResponse

public ImageResponse(List<ImageGeneration> generations)

Construct a new ImageResponse instance without metadata.

Parameters:

generations - the List of ImageGeneration returned by the AI provider.

ImageResponse

public ImageResponse(List<ImageGeneration> generations,
 ImageResponseMetadata imageResponseMetadata)

Construct a new ImageResponse instance.

Parameters:

generations - the List of ImageGeneration returned by the AI provider.

imageResponseMetadata - ImageResponseMetadata containing information about the use of the AI provider's API.

Method Details

getResults

public List<ImageGeneration> getResults()

The List of generated outputs.

It is a List of lists because the Prompt could request multiple output generations.

Specified by:

getResults in interface ModelResponse<ImageGeneration>

Returns:

the List of generated outputs.

getResult

public ImageGeneration getResult()

Description copied from interface: ModelResponse

Retrieves the result of the AI model.

Specified by:

getResult in interface ModelResponse<ImageGeneration>

Returns:

Returns the first ImageGeneration in the generations list.

getMetadata

public ImageResponseMetadata getMetadata()

Description copied from interface: ModelResponse

Retrieves the response metadata associated with the AI model's response.

Specified by:

getMetadata in interface ModelResponse<ImageGeneration>

Returns:

Returns ImageResponseMetadata containing information about the use of the AI provider's API.

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