Interface AiServiceResponseReceivedEvent

All Superinterfaces:

AiServiceEvent

All Known Implementing Classes:

DefaultAiServiceResponseReceivedEvent

public interface AiServiceResponseReceivedEvent
extends AiServiceEvent

Invoked when response from a ChatModel is received. It is important to note that this can be invoked multiple times during a single AI Service invocation when tools or guardrails exist.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	AiServiceResponseReceivedEvent.AiServiceResponseReceivedEventBuilder	Builder for DefaultAiServiceResponseReceivedEvent instances.

Nested classes/interfaces inherited from interface AiServiceEvent

AiServiceEvent.Builder<T>

Method Summary

Modifier and Type	Method	Description
static AiServiceResponseReceivedEvent.AiServiceResponseReceivedEventBuilder	builder()
default Class<AiServiceResponseReceivedEvent>	eventClass()	Retrieves the class type of the event, representing the specific category of the AI Service invocation event.
ChatResponse	response()	Retrieves the chat response from the AI Service invocation event.
default AiServiceResponseReceivedEvent.AiServiceResponseReceivedEventBuilder	toBuilder()	Creates a new builder instance initialized with the properties of this AiServiceEvent.

Methods inherited from interface AiServiceEvent

invocationContext

Method Details

response

ChatResponse response()

Retrieves the chat response from the AI Service invocation event.

Returns:

the ChatResponse object containing the AI-generated message and related metadata.

eventClass

default Class<AiServiceResponseReceivedEvent> eventClass()

Description copied from interface: AiServiceEvent

Retrieves the class type of the event, representing the specific category of the AI Service invocation event.

Specified by:

eventClass in interface AiServiceEvent

toBuilder

default AiServiceResponseReceivedEvent.AiServiceResponseReceivedEventBuilder toBuilder()

Description copied from interface: AiServiceEvent

Creates a new builder instance initialized with the properties of this AiServiceEvent. This allows modification of the existing properties and reconstruction of the event.

Specified by:

toBuilder in interface AiServiceEvent

builder

static AiServiceResponseReceivedEvent.AiServiceResponseReceivedEventBuilder builder()