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<InputVariable> parameters, OutputVariable<T> returnParameterType)	Create a new instance of KernelFunctionMetadata.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
String	getDescription()	Get the description of the function.
String	getName()	Get the name of the function.
OutputVariable<T>	getOutputVariableType()	Get the return parameter of the function.
List<InputVariable>	getParameters()	Get the parameters of the function.
String	getPluginName()	Get the name of the plugin to which the function belongs
int	hashCode()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

KernelFunctionMetadata

public KernelFunctionMetadata(@Nullable
                              String pluginName,
                              String name,
                              @Nullable
                              String description,
                              @Nullable
                              List<InputVariable> parameters,
                              OutputVariable<T> returnParameterType)

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.

returnParameterType - The return parameter type 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<InputVariable> 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.

getOutputVariableType

public OutputVariable<T> getOutputVariableType()

Get the return parameter of the function.

Returns:

The return parameter of the function.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object