Package com.microsoft.semantickernel.semanticfunctions

Class KernelFunctionFromPrompt<T>

java.lang.Object

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

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

Type Parameters:

T - the type of the return value of the function

public class KernelFunctionFromPrompt<T>
extends KernelFunction<T>

A KernelFunction implementation that is created from a prompt template.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	KernelFunctionFromPrompt.Builder<T>	A builder for creating a KernelFunction from a prompt template.

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

KernelFunction.FromPromptBuilder<T>

Method Summary

Modifier and Type	Method	Description
static <T> KernelFunctionFromPrompt.Builder<T>	builder()	Creates a new instance of KernelFunctionFromPrompt.Builder.
static <T> KernelFunctionFromPrompt.Builder<T>	builder(Class<T> returnType)	Creates a new instance of KernelFunctionFromPrompt.Builder.
reactor.core.publisher.Mono<FunctionResult<T>>	invokeAsync(Kernel kernel, KernelFunctionArguments arguments, ContextVariableType<T> variableType, InvocationContext invocationContext)	Invokes this 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

builder

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

Creates a new instance of KernelFunctionFromPrompt.Builder.

Type Parameters:

T - The type of the return value of the function

Returns:

a new instance of KernelFunctionFromPrompt.Builder

builder

public static <T> KernelFunctionFromPrompt.Builder<T> builder(Class<T> returnType)

Creates a new instance of KernelFunctionFromPrompt.Builder.

Type Parameters:

T - The type of the return value of the function

Parameters:

returnType - The type of the return value of the function

Returns:

a new instance of KernelFunctionFromPrompt.Builder

invokeAsync

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

Description copied from class: 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()