Class ChatEvent

java.lang.Object

io.quarkiverse.langchain4j.runtime.aiservice.ChatEvent

Direct Known Subclasses:

ChatEvent.AccumulatedResponseEvent, ChatEvent.BeforeToolExecutionEvent, ChatEvent.ChatCompletedEvent, ChatEvent.ContentFetchedEvent, ChatEvent.PartialResponseEvent, ChatEvent.PartialThinkingEvent, ChatEvent.ToolExecutedEvent

public class ChatEvent
extends Object

Base class for chat-related events that occur during AI service interactions. This class serves as the foundation for various event types that can be emitted during the lifecycle of a chat conversation, including tool executions, partial responses, and completion events.

Events are typically used for monitoring, logging, or reactive processing of AI service interactions.

See Also:

• ChatEvent.ChatCompletedEvent
• ChatEvent.ToolExecutedEvent
• ChatEvent.BeforeToolExecutionEvent
• ChatEvent.PartialResponseEvent
• ChatEvent.ContentFetchedEvent
• ChatEvent.AccumulatedResponseEvent
• ChatEvent.PartialThinkingEvent

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ChatEvent.AccumulatedResponseEvent	Event emitted when partial responses have been accumulated into a larget message.
static class	ChatEvent.BeforeToolExecutionEvent	Event emitted when a tool is about to be executed during a chat conversation.
static class	ChatEvent.ChatCompletedEvent	Event emitted when a chat conversation has been completed.
static enum	ChatEvent.ChatEventType	Enumeration of possible chat event types.
static class	ChatEvent.ContentFetchedEvent	Event emitted when content has been fetched from a retrieval-augmented generation (RAG) source.
static class	ChatEvent.PartialResponseEvent	Event emitted when a partial response chunk is received during streaming.
static class	ChatEvent.PartialThinkingEvent	Event emitted when a partial thinking/reasoning chunk is received during streaming.
static class	ChatEvent.ToolExecutedEvent	Event emitted when a tool has been executed during a chat conversation.

Constructor Summary

Constructors

Constructor	Description
ChatEvent(ChatEvent.ChatEventType eventType)	Constructs a new ChatEvent with the specified event type.

Method Summary

Modifier and Type	Method	Description
ChatEvent.ChatEventType	getEventType()	Returns the type of this chat event.

Methods inherited from class java.lang.Object

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

Constructor Details

ChatEvent

public ChatEvent(ChatEvent.ChatEventType eventType)

Constructs a new ChatEvent with the specified event type.

Parameters:

eventType - the type of chat event

Method Details

getEventType

public ChatEvent.ChatEventType getEventType()

Returns the type of this chat event.

Returns:

the event type