Package com.microsoft.semantickernel.hooks

Class KernelHooks.UnmodifiableKernelHooks

java.lang.Object

com.microsoft.semantickernel.hooks.KernelHooks

com.microsoft.semantickernel.hooks.KernelHooks.UnmodifiableKernelHooks

Enclosing class:

KernelHooks

public static class KernelHooks.UnmodifiableKernelHooks
extends KernelHooks

A wrapper for KernelHooks that disables mutating methods.

Nested Class Summary

Nested classes/interfaces inherited from class com.microsoft.semantickernel.hooks.KernelHooks

KernelHooks.UnmodifiableKernelHooks

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	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.
KernelHook<?>	removeHook(String hookName)	Remove a hook from the collection of hooks.

Methods inherited from class com.microsoft.semantickernel.hooks.KernelHooks

addPreToolCallHook, executeHooks, isEmpty, unmodifiableClone

Methods inherited from class java.lang.Object

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

Method Detail

addFunctionInvokingHook

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

Description copied from class: KernelHooks

Add a KernelHook.FunctionInvokingHook to the collection of hooks.

Overrides:

addFunctionInvokingHook in class KernelHooks

Parameters:

function - the function to add

Returns:

the key of the hook in the collection

addFunctionInvokedHook

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

Description copied from class: KernelHooks

Add a KernelHook.FunctionInvokedHook to the collection of hooks.

Overrides:

addFunctionInvokedHook in class KernelHooks

Parameters:

function - the function to add

Returns:

the key of the hook in the collection

addPreChatCompletionHook

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

Description copied from class: KernelHooks

Add a KernelHook.PreChatCompletionHook to the collection of hooks.

Overrides:

addPreChatCompletionHook in class KernelHooks

Parameters:

function - the function to add

Returns:

the key of the hook in the collection

addPostChatCompletionHook

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

Description copied from class: KernelHooks

Add a PostChatCompletionEvent to the collection of hooks.

Overrides:

addPostChatCompletionHook in class KernelHooks

Parameters:

function - the function to add

Returns:

the key of the hook in the collection

addPromptRenderedHook

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

Description copied from class: KernelHooks

Add a KernelHook.PromptRenderedHook to the collection of hooks.

Overrides:

addPromptRenderedHook in class KernelHooks

Parameters:

function - the function to add

Returns:

the key of the hook in the collection

addPromptRenderingHook

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

Description copied from class: KernelHooks

Add a KernelHook.PromptRenderingHook to the collection of hooks.

Overrides:

addPromptRenderingHook in class KernelHooks

Parameters:

function - the function to add

Returns:

the key of the hook in the collection

addHook

public String addHook(KernelHook<?> hook)

Description copied from class: KernelHooks

Add a KernelHook to the collection of hooks.

Overrides:

addHook in class KernelHooks

Parameters:

hook - the hook to add

Returns:

the key of the hook in the collection

addHook

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

Description copied from class: KernelHooks

Add a KernelHook to the collection of hooks.

Overrides:

addHook in class KernelHooks

Parameters:

hookName - the key of the hook in the collection

hook - the hook to add

Returns:

the key of the hook in the collection

addHooks

public KernelHooks addHooks(@Nullable
                            KernelHooks kernelHooks)

Description copied from class: KernelHooks

Appends the given hooks to this collection.

Overrides:

addHooks in class KernelHooks

Parameters:

kernelHooks - the hooks to append

Returns:

this instance of the KernelHooks class

removeHook

public KernelHook<?> removeHook(String hookName)

Description copied from class: KernelHooks

Remove a hook from the collection of hooks.

Overrides:

removeHook in class KernelHooks

Parameters:

hookName - the key of the hook in the collection

Returns:

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