Share via

KernelFunctionMetadata<T> Class

Package:
com.microsoft.semantickernel.semanticfunctions
Maven Artifact:
com.microsoft.semantic-kernel:semantickernel-api:1.4.0
  • 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>

Metadata about a kernel function.

Constructor Summary

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 and Description
boolean equals(Object obj)
java.lang.String getDescription()

Get the description of the function.
java.lang.String getName()

Get the name of the function.
OutputVariable<T> getOutputVariableType()

Get the return parameter of the function.
java.util.List<InputVariable> getParameters()

Get the parameters of the function.
java.lang.String getPluginName()

Get the name of the plugin to which the function belongs
int hashCode()

Methods inherited from java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.toString java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

Constructor Details

KernelFunctionMetadata

public KernelFunctionMetadata(String pluginName, String name, String description, List parameters, OutputVariable 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 Details

equals

public boolean equals(Object obj)

Overrides:

KernelFunctionMetadata<T>.equals(Object obj)

Parameters:

obj

getDescription

public String getDescription()

Get the description of the function.

Returns:

The description of the function.

getName

public String getName()

Get the name of the function.

Returns:

The name of the function.

getOutputVariableType

public OutputVariable getOutputVariableType()

Get the return parameter of the function.

Returns:

The return parameter of the function.

getParameters

public List getParameters()

Get the parameters of the function.

Returns:

The parameters of the function.

getPluginName

public String getPluginName()

Get the name of the plugin to which the function belongs

Returns:

The name of the function.

hashCode

public int hashCode()

Overrides:

KernelFunctionMetadata<T>.hashCode()

Applies to