Package org.springframework.ai.image

Class ImageResponseMetadata

java.lang.Object

org.springframework.ai.model.MutableResponseMetadata

org.springframework.ai.image.ImageResponseMetadata

All Implemented Interfaces:

ResponseMetadata

Direct Known Subclasses:

OpenAiImageResponseMetadata

public class ImageResponseMetadata
extends MutableResponseMetadata

Represents metadata associated with an image response. It provides additional information about the generative response from an AI model, including the creation timestamp of the generated image.

Since:

1.0.0

Author:

Mark Pollack, Thomas Vitale

Constructor Summary

Constructors

Constructor	Description
ImageResponseMetadata()
ImageResponseMetadata(Long created)
ImageResponseMetadata(Long created, Usage usage)	Create a new ImageResponseMetadata.

Method Summary

Modifier and Type	Method	Description
Long	getCreated()
Usage	getUsage()	Return the token usage associated with the image response.
void	setUsage(Usage usage)	Set the token usage associated with the image response.

Methods inherited from class org.springframework.ai.model.MutableResponseMetadata

clear, computeIfAbsent, containsKey, entrySet, get, getOrDefault, getRawMap, getRequired, isEmpty, keySet, put, remove

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.ai.model.ResponseMetadata

getOrDefault

Constructor Details

ImageResponseMetadata

public ImageResponseMetadata()

ImageResponseMetadata

public ImageResponseMetadata(Long created)

ImageResponseMetadata

public ImageResponseMetadata(Long created,
 Usage usage)

Create a new ImageResponseMetadata.

Parameters:

created - the creation timestamp

usage - the token usage associated with the image response

Since:

2.0.1

Method Details

getCreated

public Long getCreated()

getUsage

public Usage getUsage()

Return the token usage associated with the image response.

Since:

2.0.1

setUsage

public void setUsage(Usage usage)

Set the token usage associated with the image response.

Since:

2.0.1