Package org.springframework.ai.chat.metadata

Interface ChatResponseMetadata

All Superinterfaces:

ResponseMetadata

All Known Implementing Classes:

AzureOpenAiChatResponseMetadata, OpenAiChatResponseMetadata, VertexAiChatResponseMetadata

public interface ChatResponseMetadata
extends ResponseMetadata

Abstract Data Type (ADT) modeling common AI provider metadata returned in an AI response.

Since:

0.7.0

Author:

John Blum

Field Summary

Fields

Modifier and Type	Field	Description
static final ChatResponseMetadata	NULL

Method Summary

Modifier and Type	Method	Description
default PromptMetadata	getPromptMetadata()
default RateLimit	getRateLimit()	Returns AI provider specific metadata on rate limits.
default Usage	getUsage()	Returns AI provider specific metadata on API usage.

Field Details

NULL

static final ChatResponseMetadata NULL

Method Details

getRateLimit

default RateLimit getRateLimit()

Returns AI provider specific metadata on rate limits.

Returns:

AI provider specific metadata on rate limits.

See Also:

• RateLimit

getUsage

default Usage getUsage()

Returns AI provider specific metadata on API usage.

Returns:

AI provider specific metadata on API usage.

See Also:

• Usage

getPromptMetadata

default PromptMetadata getPromptMetadata()