Package com.microsoft.semantickernel.semanticfunctions

Class KernelFunctionMetadata<T>

java.lang.Object

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

Type Parameters:

T - The type of the return value of the function.

public class KernelFunctionMetadata<T>
extends Object

Metadata about a kernel function.

Constructor Summary

Constructors

Constructor	Description
KernelFunctionMetadata(String pluginName, String name, String description, List<KernelParameterMetadata<?>> parameters, KernelReturnParameterMetadata<T> returnParameter)	Create a new instance of KernelFunctionMetadata.

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Get the description of the function.
String	getName()	Get the name of the function.
List<KernelParameterMetadata<?>>	getParameters()	Get the parameters of the function.
String	getPluginName()	Get the name of the plugin to which the function belongs
KernelReturnParameterMetadata<T>	getReturnParameter()	Get the return parameter of the function.

Methods inherited from class java.lang.Object

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

Constructor Detail

KernelFunctionMetadata

public KernelFunctionMetadata(@Nullable
                              String pluginName,
                              String name,
                              @Nullable
                              String description,
                              @Nullable
                              List<KernelParameterMetadata<?>> parameters,
                              KernelReturnParameterMetadata<T> returnParameter)

Create a new instance of KernelFunctionMetadata.

Parameters:

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

name - The name of the function.

description - The description of the function.

parameters - The parameters of the function.

returnParameter - The return parameter of the function.

Method Detail

getPluginName

@Nullable
public String getPluginName()

Get the name of the plugin to which the function belongs

Returns:

The name of the function.

getName

public String getName()

Get the name of the function.

Returns:

The name of the function.

getParameters

public List<KernelParameterMetadata<?>> getParameters()

Get the parameters of the function.

Returns:

The parameters of the function.

getDescription

@Nullable
public String getDescription()

Get the description of the function.

Returns:

The description of the function.

getReturnParameter

public KernelReturnParameterMetadata<T> getReturnParameter()

Get the return parameter of the function.

Returns:

The return parameter of the function.