Class ChatResponseMetadata

java.lang.Object

dev.langchain4j.model.chat.response.ChatResponseMetadata

Direct Known Subclasses:

OpenAiChatResponseMetadata, OpenAiOfficialChatResponseMetadata, WatsonxChatResponseMetadata

public class ChatResponseMetadata
extends Object

Represents common chat response metadata supported by most LLM providers. Specific LLM provider integrations can extend this interface to add provider-specific metadata.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ChatResponseMetadata.Builder<T extends ChatResponseMetadata.Builder<T>>

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ChatResponseMetadata(ChatResponseMetadata.Builder<?> builder)

Method Summary

Modifier and Type	Method	Description
static ChatResponseMetadata.Builder<?>	builder()
boolean	equals(Object o)
FinishReason	finishReason()
int	hashCode()
String	id()
String	modelName()
ChatResponseMetadata.Builder<?>	toBuilder()
protected ChatResponseMetadata.Builder<?>	toBuilder(ChatResponseMetadata.Builder<?> builder)
TokenUsage	tokenUsage()
String	toString()

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

ChatResponseMetadata

protected ChatResponseMetadata(ChatResponseMetadata.Builder<?> builder)

Method Details

id

public String id()

modelName

public String modelName()

tokenUsage

public TokenUsage tokenUsage()

finishReason

public FinishReason finishReason()

toBuilder

public ChatResponseMetadata.Builder<?> toBuilder()

toBuilder

protected ChatResponseMetadata.Builder<?> toBuilder(ChatResponseMetadata.Builder<?> builder)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

builder

public static ChatResponseMetadata.Builder<?> builder()