Package org.springframework.ai.model

Class AbstractResponseMetadata

java.lang.Object

org.springframework.ai.model.AbstractResponseMetadata

Direct Known Subclasses:

ChatResponseMetadata, EmbeddingResponseMetadata, ModerationResponseMetadata

public class AbstractResponseMetadata
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	AI_METADATA_STRING	AI metadata string format.
protected final Map<String,Object>	map	Metadata map.

Constructor Summary

Constructors

Constructor	Description
AbstractResponseMetadata()	Create a new AbstractResponseMetadata instance.

Method Summary

Modifier and Type	Method	Description
boolean	containsKey(Object key)	Checks if context contains a key.
Set<Map.Entry<String,Object>>	entrySet()
<T> T	get(String key)	Gets an entry from the context.
<T> T	getOrDefault(Object key, T defaultObject)	Returns an element or default if not present.
<T> T	getRequired(Object key)	Gets an entry from the context.
boolean	isEmpty()
Set<String>	keySet()

Methods inherited from class java.lang.Object

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

Field Details

AI_METADATA_STRING

protected static final String AI_METADATA_STRING

AI metadata string format.

See Also:

• Constant Field Values

map

protected final Map<String,Object> map

Metadata map.

Constructor Details

AbstractResponseMetadata

public AbstractResponseMetadata()

Create a new AbstractResponseMetadata instance.

Method Details

get

@Nullable
public <T> T get(String key)

Gets an entry from the context. Returns null when entry is not present.

Type Parameters:

T - value type

Parameters:

key - key

Returns:

entry or null if not present

getRequired

@NonNull
public <T> T getRequired(Object key)

Gets an entry from the context. Throws exception when entry is not present.

Type Parameters:

T - value type

Parameters:

key - key

Returns:

entry

Throws:

IllegalArgumentException - if not present

containsKey

public boolean containsKey(Object key)

Checks if context contains a key.

Parameters:

key - key

Returns:

true when the context contains the entry with the given key

getOrDefault

public <T> T getOrDefault(Object key,
 T defaultObject)

Returns an element or default if not present.

Type Parameters:

T - value type

Parameters:

key - key

defaultObject - default object to return

Returns:

object or default if not present

entrySet

public Set<Map.Entry<String,Object>> entrySet()

keySet

public Set<String> keySet()

isEmpty

public boolean isEmpty()