Interface AiServiceCancelledEvent

All Superinterfaces:

AiServiceEvent

All Known Implementing Classes:

DefaultAiServiceCancelledEvent

@Experimental
public interface AiServiceCancelledEvent
extends AiServiceEvent

Invoked when an AI Service invocation is cancelled before it completes, for example when the Flow.Publisher subscription is cancelled, the returned CompletableFuture is cancelled, or StreamingHandle.cancel() is called from a TokenStream callback that receives a context, such as onPartialResponseWithContext. It means that cancellation was requested: the model provider or a tool may still finish work that was already running. A cancelled invocation fires neither AiServiceCompletedEvent nor AiServiceErrorEvent. Events of work that was already running when the invocation was cancelled (for example a ToolExecutedEvent) can still arrive after this event.

Since:

1.23.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	AiServiceCancelledEvent.AiServiceCancelledEventBuilder	Builder for AiServiceCancelledEvent instances.

Nested classes/interfaces inherited from interface AiServiceEvent

AiServiceEvent.Builder<T>

Method Summary

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

Methods inherited from interface AiServiceEvent

invocationContext

Method Details

eventClass

default Class<AiServiceCancelledEvent> 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 AiServiceCancelledEvent.AiServiceCancelledEventBuilder 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 AiServiceCancelledEvent.AiServiceCancelledEventBuilder builder()