Package com.microsoft.semantickernel.semanticfunctions

Class KernelFunctionFromMethod<T>

java.lang.Object

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

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

Type Parameters:

T - the return type of the function

public class KernelFunctionFromMethod<T>
extends KernelFunction<T>

A KernelFunction that is created from a method. This class is used to create a KernelFunction from a method that is annotated with DefineKernelFunction and KernelFunctionParameter.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	KernelFunctionFromMethod.Builder<T>	A builder for KernelFunction.
static interface	KernelFunctionFromMethod.ImplementationFunc<T>	Concrete implementation of the abstract method in KernelFunction.

Nested classes/interfaces inherited from class com.microsoft.semantickernel.semanticfunctions.KernelFunction

KernelFunction.FromPromptBuilder<T>

Method Summary

Modifier and Type	Method	Description
static <T> KernelFunctionFromMethod.Builder<T>	builder()	A builder for KernelFunction.
static <T> KernelFunction<T>	create(Method method, Object target, String pluginName, String functionName, String description, List<InputVariable> parameters, OutputVariable<?> returnParameter)	Creates a new instance of KernelFunctionFromMethod from a method.
static List<String>	getEnumOptions(Class<?> type)
reactor.core.publisher.Mono<FunctionResult<T>>	invokeAsync(Kernel kernel, KernelFunctionArguments arguments, ContextVariableType<T> variableType, InvocationContext invocationContext)	Concrete implementation of the abstract method in KernelFunction.

Methods inherited from class com.microsoft.semantickernel.semanticfunctions.KernelFunction

createFromMethod, createFromPrompt, createFromPrompt, getDescription, getExecutionSettings, getMetadata, getName, getPluginName, invoke, invoke, invokeAsync, toEmbeddingString, toManualString

Methods inherited from class java.lang.Object

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

Method Detail

create

public static <T> KernelFunction<T> create(Method method,
                                           Object target,
                                           @Nullable
                                           String pluginName,
                                           @Nullable
                                           String functionName,
                                           @Nullable
                                           String description,
                                           @Nullable
                                           List<InputVariable> parameters,
                                           @Nullable
                                           OutputVariable<?> returnParameter)

Creates a new instance of KernelFunctionFromMethod from a method.

Type Parameters:

T - the return type of the function

Parameters:

method - the method to create the function from

target - the instance of the class that the method is a member of

pluginName - the name of the plugin which the function belongs to

functionName - the name of the function

description - the description of the function

parameters - the parameters of the function

returnParameter - the return parameter of the function

Returns:

a new instance of KernelFunctionFromMethod

getEnumOptions

@Nullable
public static List<String> getEnumOptions(Class<?> type)

builder

public static <T> KernelFunctionFromMethod.Builder<T> builder()

A builder for KernelFunction.

Type Parameters:

T - the return type of the function

Returns:

a new instance of KernelFunctionFromMethod.Builder

invokeAsync

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

Concrete implementation of the abstract method in KernelFunction. 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.

Specified by:

invokeAsync in class KernelFunction<T>

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()