Package com.microsoft.semantickernel.hooks

Class KernelHooks

java.lang.Object

com.microsoft.semantickernel.hooks.KernelHooks

Direct Known Subclasses:

KernelHooks.UnmodifiableKernelHooks

public class KernelHooks
extends Object

Represents a collection of hooks that can be used to intercept and modify events in the kernel.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	KernelHooks.UnmodifiableKernelHooks	A wrapper for KernelHooks that disables mutating methods.

Constructor Summary

Constructors

Constructor	Description
KernelHooks()	Creates a new instance of the KernelHooks class.
KernelHooks(KernelHooks kernelHooks)	Creates a copy of the KernelHooks.
KernelHooks(Map<String,KernelHook<?>> hooks)	Creates a new instance of the KernelHooks class from the given hooks.

Method Summary

Modifier and Type	Method	Description
String	addFunctionInvokedHook(Function<FunctionInvokedEvent<?>,FunctionInvokedEvent<?>> function)	Add a KernelHook.FunctionInvokedHook to the collection of hooks.
String	addFunctionInvokingHook(Function<FunctionInvokingEvent<?>,FunctionInvokingEvent<?>> function)	Add a KernelHook.FunctionInvokingHook to the collection of hooks.
String	addHook(KernelHook<?> hook)	Add a KernelHook to the collection of hooks.
String	addHook(String hookName, KernelHook<?> hook)	Add a KernelHook to the collection of hooks.
KernelHooks	addHooks(KernelHooks kernelHooks)	Appends the given hooks to this collection.
String	addPostChatCompletionHook(Function<PostChatCompletionEvent,PostChatCompletionEvent> function)	Add a PostChatCompletionEvent to the collection of hooks.
String	addPreChatCompletionHook(Function<PreChatCompletionEvent,PreChatCompletionEvent> function)	Add a KernelHook.PreChatCompletionHook to the collection of hooks.
String	addPreToolCallHook(Function<PreToolCallEvent,PreToolCallEvent> function)	Add a KernelHook.PreToolCallHook to the collection of hooks.
String	addPromptRenderedHook(Function<PromptRenderedEvent,PromptRenderedEvent> function)	Add a KernelHook.PromptRenderedHook to the collection of hooks.
String	addPromptRenderingHook(Function<PromptRenderingEvent,PromptRenderingEvent> function)	Add a KernelHook.PromptRenderingHook to the collection of hooks.
<T extends KernelHookEvent> T	executeHooks(T event)	Executes the hooks in this collection that accept the event.
boolean	isEmpty()	Determines if this collection of hooks is empty.
static KernelHooks	merge(KernelHooks a, KernelHooks b)	Builds the list of hooks to be invoked for the given context, by merging the hooks in this collection with the hooks in the context.
KernelHook<?>	removeHook(String hookName)	Remove a hook from the collection of hooks.
KernelHooks.UnmodifiableKernelHooks	unmodifiableClone()	Creates an unmodifiable copy of this KernelHooks.

Methods inherited from class java.lang.Object

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

Constructor Detail

KernelHooks

public KernelHooks()

Creates a new instance of the KernelHooks class.

KernelHooks

public KernelHooks(@Nullable
                   KernelHooks kernelHooks)

Creates a copy of the KernelHooks.

Parameters:

kernelHooks - the hooks to copy

KernelHooks

public KernelHooks(Map<String,KernelHook<?>> hooks)

Creates a new instance of the KernelHooks class from the given hooks.

Parameters:

hooks - the hooks to add

Method Detail

unmodifiableClone

public KernelHooks.UnmodifiableKernelHooks unmodifiableClone()

Creates an unmodifiable copy of this KernelHooks.

Returns:

an unmodifiable copy of this KernelHooks

addFunctionInvokingHook

public String addFunctionInvokingHook(Function<FunctionInvokingEvent<?>,FunctionInvokingEvent<?>> function)

Add a KernelHook.FunctionInvokingHook to the collection of hooks.

Parameters:

function - the function to add

Returns:

the key of the hook in the collection

addFunctionInvokedHook

public String addFunctionInvokedHook(Function<FunctionInvokedEvent<?>,FunctionInvokedEvent<?>> function)

Add a KernelHook.FunctionInvokedHook to the collection of hooks.

Parameters:

function - the function to add

Returns:

the key of the hook in the collection

addPreChatCompletionHook

public String addPreChatCompletionHook(Function<PreChatCompletionEvent,PreChatCompletionEvent> function)

Add a KernelHook.PreChatCompletionHook to the collection of hooks.

Parameters:

function - the function to add

Returns:

the key of the hook in the collection

addPreToolCallHook

public String addPreToolCallHook(Function<PreToolCallEvent,PreToolCallEvent> function)

Add a KernelHook.PreToolCallHook to the collection of hooks.

Parameters:

function - the function to add

Returns:

the key of the hook in the collection

addPostChatCompletionHook

public String addPostChatCompletionHook(Function<PostChatCompletionEvent,PostChatCompletionEvent> function)

Add a PostChatCompletionEvent to the collection of hooks.

Parameters:

function - the function to add

Returns:

the key of the hook in the collection

addPromptRenderedHook

public String addPromptRenderedHook(Function<PromptRenderedEvent,PromptRenderedEvent> function)

Add a KernelHook.PromptRenderedHook to the collection of hooks.

Parameters:

function - the function to add

Returns:

the key of the hook in the collection

addPromptRenderingHook

public String addPromptRenderingHook(Function<PromptRenderingEvent,PromptRenderingEvent> function)

Add a KernelHook.PromptRenderingHook to the collection of hooks.

Parameters:

function - the function to add

Returns:

the key of the hook in the collection

executeHooks

public <T extends KernelHookEvent> T executeHooks(T event)

Executes the hooks in this collection that accept the event.

Type Parameters:

T - the type of the event

Parameters:

event - the event to execute the hooks on

Returns:

the event after the hooks have been executed

addHook

public String addHook(KernelHook<?> hook)

Add a KernelHook to the collection of hooks.

Parameters:

hook - the hook to add

Returns:

the key of the hook in the collection

addHook

public String addHook(String hookName,
                      KernelHook<?> hook)

Add a KernelHook to the collection of hooks.

Parameters:

hookName - the key of the hook in the collection

hook - the hook to add

Returns:

the key of the hook in the collection

removeHook

public KernelHook<?> removeHook(String hookName)

Remove a hook from the collection of hooks.

Parameters:

hookName - the key of the hook in the collection

Returns:

the removed hook, or null if the hook was not found

addHooks

public KernelHooks addHooks(@Nullable
                            KernelHooks kernelHooks)

Appends the given hooks to this collection.

Parameters:

kernelHooks - the hooks to append

Returns:

this instance of the KernelHooks class

isEmpty

public boolean isEmpty()

Determines if this collection of hooks is empty.

Returns:

true if the collection is empty, otherwise false

merge

public static KernelHooks merge(@Nullable
                                KernelHooks a,
                                @Nullable
                                KernelHooks b)

Builds the list of hooks to be invoked for the given context, by merging the hooks in this collection with the hooks in the context. Duplicate hooks in b will override hooks in a.

Parameters:

a - hooks to merge

b - hooks to merge

Returns:

the list of hooks to be invoked