Interface AiServiceStartedEvent

All Superinterfaces:

AiServiceEvent

All Known Implementing Classes:

DefaultAiServiceStartedEvent

public interface AiServiceStartedEvent
extends AiServiceEvent

Called when an LLM invocation has started.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	AiServiceStartedEvent.AiServiceStartedEventBuilder	Builder for DefaultAiServiceStartedEvent instances.

Nested classes/interfaces inherited from interface AiServiceEvent

AiServiceEvent.Builder<T>

Method Summary

Modifier and Type	Method	Description
static AiServiceStartedEvent.AiServiceStartedEventBuilder	builder()	Creates a new builder instance for constructing a AiServiceStartedEvent.
default Class<AiServiceStartedEvent>	eventClass()	Retrieves the class type of the event, representing the specific category of the AI Service invocation event.
Optional<SystemMessage>	systemMessage()	Retrieves an optional system message associated with the invocation.
default AiServiceStartedEvent.AiServiceStartedEventBuilder	toBuilder()	Creates a new builder instance initialized with the properties of this AiServiceEvent.
UserMessage	userMessage()	Retrieves the user message associated with the invocation.

Methods inherited from interface AiServiceEvent

invocationContext

Method Details

systemMessage

Optional<SystemMessage> systemMessage()

Retrieves an optional system message associated with the invocation. A system message typically provides instructions regarding the AI's behavior, actions, or response style.

userMessage

UserMessage userMessage()

Retrieves the user message associated with the invocation. The user message represents the content or input provided by the user during the AI Service invocation.

builder

static AiServiceStartedEvent.AiServiceStartedEventBuilder builder()

Creates a new builder instance for constructing a AiServiceStartedEvent.

eventClass

default Class<AiServiceStartedEvent> 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 AiServiceStartedEvent.AiServiceStartedEventBuilder 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