Package org.springframework.ai.openai.metadata

Class OpenAiChatResponseMetadata

java.lang.Object

org.springframework.ai.openai.metadata.OpenAiChatResponseMetadata

All Implemented Interfaces:

ChatResponseMetadata, ResponseMetadata

public class OpenAiChatResponseMetadata
extends Object
implements ChatResponseMetadata

ChatResponseMetadata implementation for OpenAI.

Since:

0.7.0

Author:

John Blum

See Also:

• ChatResponseMetadata
• RateLimit
• Usage

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	AI_METADATA_STRING

Fields inherited from interface org.springframework.ai.chat.metadata.ChatResponseMetadata

NULL

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	OpenAiChatResponseMetadata(String id, OpenAiUsage usage)
protected	OpenAiChatResponseMetadata(String id, OpenAiUsage usage, OpenAiRateLimit rateLimit)

Method Summary

Modifier and Type	Method	Description
static OpenAiChatResponseMetadata	from(OpenAiApi.ChatCompletion result)
String	getId()
RateLimit	getRateLimit()	Returns AI provider specific metadata on rate limits.
Usage	getUsage()	Returns AI provider specific metadata on API usage.
String	toString()
OpenAiChatResponseMetadata	withRateLimit(RateLimit rateLimit)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.ai.chat.metadata.ChatResponseMetadata

getPromptMetadata

Field Details

AI_METADATA_STRING

protected static final String AI_METADATA_STRING

See Also:

• Constant Field Values

Constructor Details

OpenAiChatResponseMetadata

protected OpenAiChatResponseMetadata(String id,
 OpenAiUsage usage)

OpenAiChatResponseMetadata

protected OpenAiChatResponseMetadata(String id,
 OpenAiUsage usage,
 @Nullable
 OpenAiRateLimit rateLimit)

Method Details

from

public static OpenAiChatResponseMetadata from(OpenAiApi.ChatCompletion result)

getId

public String getId()

getRateLimit

@Nullable
public RateLimit getRateLimit()

Description copied from interface: ChatResponseMetadata

Returns AI provider specific metadata on rate limits.

Specified by:

getRateLimit in interface ChatResponseMetadata

Returns:

AI provider specific metadata on rate limits.

See Also:

• RateLimit

getUsage

public Usage getUsage()

Description copied from interface: ChatResponseMetadata

Returns AI provider specific metadata on API usage.

Specified by:

getUsage in interface ChatResponseMetadata

Returns:

AI provider specific metadata on API usage.

See Also:

• Usage

withRateLimit

public OpenAiChatResponseMetadata withRateLimit(RateLimit rateLimit)

toString

public String toString()

Overrides:

toString in class Object