Package org.springframework.ai.chat.metadata

Interface ChatGenerationMetadata

All Superinterfaces:

ResultMetadata

All Known Implementing Classes:

DefaultChatGenerationMetadata

public interface ChatGenerationMetadata
extends ResultMetadata

Represents the metadata associated with the generation of a chat response.

Since:

0.7.0

Author:

John Blum, Christian Tzolov

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ChatGenerationMetadata.Builder

Field Summary

Fields

Modifier and Type	Field	Description
static final ChatGenerationMetadata	NULL

Method Summary

Modifier and Type	Method	Description
static ChatGenerationMetadata.Builder	builder()
boolean	containsKey(String key)
Set<Map.Entry<String,Object>>	entrySet()
<T> T	get(String key)
Set<String>	getContentFilters()
String	getFinishReason()	Get the reason this choice completed for the generation.
<T> T	getOrDefault(String key, T defaultObject)
boolean	isEmpty()
Set<String>	keySet()

Field Details

NULL

static final ChatGenerationMetadata NULL

Method Details

getFinishReason

String getFinishReason()

Get the reason this choice completed for the generation.

Returns:

the reason this choice completed for the generation.

getContentFilters

Set<String> getContentFilters()

get

<T> T get(String key)

containsKey

boolean containsKey(String key)

getOrDefault

<T> T getOrDefault(String key,
 T defaultObject)

entrySet

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

keySet

Set<String> keySet()

isEmpty

boolean isEmpty()

builder

static ChatGenerationMetadata.Builder builder()