Package com.microsoft.semantickernel.semanticfunctions

Class KernelFunction<T>

java.lang.Object

com.microsoft.semantickernel.semanticfunctions.KernelFunction<T>

Type Parameters:

T - The type of the result of the function

Direct Known Subclasses:

KernelFunctionFromMethod, KernelFunctionFromPrompt

public abstract class KernelFunction<T>
extends Object

Semantic Kernel callable function interface. The Semantic Kernel creates KernelFunctions from prompts, templates, or plugin methods.

See Also:

com.microsoft.semantickernel.semanticfunctions, com.microsoft.semantickernel.plugin, com.microsoft.semantickernel.semanticfunctions.annotations

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	KernelFunction.FromPromptBuilder<T>	Builder for creating a KernelFunction from a prompt.

Method Summary

Modifier and Type	Method	Description
static <T> KernelFunctionFromMethod.Builder<T>	createFromMethod(Method method, Object target)	Creates a KernelFunction instance for a method, specified via a Method instance
static <T> KernelFunction.FromPromptBuilder<T>	createFromPrompt(PromptTemplateConfig promptTemplateConfiguration)	Builder for creating a KernelFunction instance for a given PromptTemplateConfig.
static <T> KernelFunction.FromPromptBuilder<T>	createFromPrompt(String prompt)	Creates a KernelFunction instance based on a given prompt
String	getDescription()
Map<String,PromptExecutionSettings>	getExecutionSettings()	Get an unmodifiable map of the execution settings for the function.
KernelFunctionMetadata<?>	getMetadata()	Get the metadata for the function.
String	getName()
String	getPluginName()
FunctionResult<T>	invoke(Kernel kernel)	Invokes this KernelFunction.
FunctionResult<T>	invoke(Kernel kernel, KernelFunctionArguments arguments, ContextVariableType<T> variableType, InvocationContext invocationContext)	Invokes this KernelFunction.
FunctionInvocation<T>	invokeAsync(Kernel kernel)	Invokes this KernelFunction.
abstract reactor.core.publisher.Mono<FunctionResult<T>>	invokeAsync(Kernel kernel, KernelFunctionArguments arguments, ContextVariableType<T> variableType, InvocationContext invocationContext)	Invokes this KernelFunction.
String	toEmbeddingString()	Create a string for generating an embedding for a function.
String	toManualString(boolean includeOutputs)	Create a manual-friendly string for a function.

Methods inherited from class java.lang.Object

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

Method Detail

createFromMethod

public static <T> KernelFunctionFromMethod.Builder<T> createFromMethod(Method method,
                                                                       Object target)

Creates a KernelFunction instance for a method, specified via a Method instance

Type Parameters:

T - The return type of the method.

Parameters:

method - The method to be represented via the created KernelFunction.

target - The target object for the method if it represents an instance method. This should be null if and only if method is a static method.

Returns:

The created KernelFunction wrapper for method.

createFromPrompt

public static <T> KernelFunction.FromPromptBuilder<T> createFromPrompt(String prompt)

Creates a KernelFunction instance based on a given prompt

Type Parameters:

T - The return type of the method

Parameters:

prompt - The prompt to be used for the created KernelFunction.

Returns:

The builder for creating a KernelFunction instance.

createFromPrompt

public static <T> KernelFunction.FromPromptBuilder<T> createFromPrompt(PromptTemplateConfig promptTemplateConfiguration)

Builder for creating a KernelFunction instance for a given PromptTemplateConfig.

Type Parameters:

T - The return type of the method

Parameters:

promptTemplateConfiguration - The configuration for the prompt template.

Returns:

The builder for creating a KernelFunction instance.

getPluginName

@Nullable
public String getPluginName()

Returns:

The name of the plugin that this function is within

getName

public String getName()

Returns:

The name of this function

getDescription

@Nullable
public String getDescription()

Returns:

A description of the function

toEmbeddingString

public String toEmbeddingString()

Create a string for generating an embedding for a function.

Returns:

A string for generating an embedding for a function.

toManualString

public String toManualString(boolean includeOutputs)

Create a manual-friendly string for a function.

Parameters:

includeOutputs - Whether to include function outputs in the string.

Returns:

A manual-friendly string for a function.

getExecutionSettings

public Map<String,PromptExecutionSettings> getExecutionSettings()

Get an unmodifiable map of the execution settings for the function.

Returns:

An unmodifiable map of the execution settings for the function

getMetadata

public KernelFunctionMetadata<?> getMetadata()

Get the metadata for the function.

Returns:

The metadata for the function

invokeAsync

public abstract reactor.core.publisher.Mono<FunctionResult<T>> invokeAsync(Kernel kernel,
                                                                           @Nullable
                                                                           KernelFunctionArguments arguments,
                                                                           @Nullable
                                                                           ContextVariableType<T> variableType,
                                                                           @Nullable
                                                                           InvocationContext invocationContext)

Invokes this KernelFunction.

If the variableType parameter is provided, the ContextVariableType is used to convert the result of the function to the appropriate FunctionResult. The variableType is not required for converting well-known types such as String and Integer which have pre-defined ContextVariableTypes.

The InvocationContext allows for customization of the behavior of function, including the ability to pass in KernelHooks PromptExecutionSettings, and ToolCallBehavior.

The difference between calling the KernelFunction.invokeAsync method directly and calling the Kernel.invokeAsync method is that the latter adds the global KernelHooks (if any) to the InvocationContext. Calling KernelFunction.invokeAsync directly does not add the global hooks.

Parameters:

kernel - The Kernel containing services, plugins, and other state for use throughout the operation.

arguments - The arguments to pass to the function's invocation

variableType - The type of the ContextVariable returned in the FunctionResult

invocationContext - The arguments to pass to the function's invocation

Returns:

The result of the function's execution.

See Also:

FunctionResult.getResultVariable()

invoke

public FunctionResult<T> invoke(Kernel kernel,
                                @Nullable
                                KernelFunctionArguments arguments,
                                @Nullable
                                ContextVariableType<T> variableType,
                                @Nullable
                                InvocationContext invocationContext)

Invokes this KernelFunction.

If the variableType parameter is provided, the ContextVariableType is used to convert the result of the function to the appropriate FunctionResult. The variableType is not required for converting well-known types such as String and Integer which have pre-defined ContextVariableTypes.

The InvocationContext allows for customization of the behavior of function, including the ability to pass in KernelHooks PromptExecutionSettings, and ToolCallBehavior.

The difference between calling the KernelFunction.invokeAsync method directly and calling the Kernel.invokeAsync method is that the latter adds the global KernelHooks (if any) to the InvocationContext. Calling KernelFunction.invokeAsync directly does not add the global hooks.

Parameters:

kernel - The Kernel containing services, plugins, and other state for use throughout the operation.

arguments - The arguments to pass to the function's invocation

variableType - The type of the ContextVariable returned in the FunctionResult

invocationContext - The arguments to pass to the function's invocation

Returns:

The result of the function's execution.

See Also:

FunctionResult.getResultVariable()

invokeAsync

public FunctionInvocation<T> invokeAsync(Kernel kernel)

Invokes this KernelFunction.

Parameters:

kernel - The Kernel containing services, plugins, and other state for use throughout the operation.

Returns:

The result of the function's execution.

invoke

public FunctionResult<T> invoke(Kernel kernel)

Invokes this KernelFunction.

Parameters:

kernel - The Kernel containing services, plugins, and other state for use throughout the operation.

Returns:

The result of the function's execution.