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>

Constructor Summary

Constructors

Constructor	Description
ImageResponse(List<ImageGeneration> generations)
ImageResponse(List<ImageGeneration> generations, ImageResponseMetadata imageResponseMetadata)

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()	Retrieves the list of generated outputs by the AI model.
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)

ImageResponse

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

Method Details

getResult

public ImageGeneration getResult()

Description copied from interface: ModelResponse

Retrieves the result of the AI model.

Specified by:

getResult in interface ModelResponse<ImageGeneration>

Returns:

the result generated by the AI model

getResults

public List<ImageGeneration> getResults()

Description copied from interface: ModelResponse

Retrieves the list of generated outputs by the AI model.

Specified by:

getResults in interface ModelResponse<ImageGeneration>

Returns:

the list of generated outputs

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:

the response metadata

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