Package com.microsoft.semantickernel.semanticfunctions

Class MethodDetails

java.lang.Object

com.microsoft.semantickernel.semanticfunctions.MethodDetails

public class MethodDetails
extends Object

Metadata for a method that can be used as a kernel function.

Constructor Summary

Constructors

Constructor	Description
MethodDetails(String name, String description, KernelFunctionFromMethod.ImplementationFunc<?> function, List<InputVariable> parameters, OutputVariable<?> returnParameter)	Constructor.

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Get the description of the method.
KernelFunctionFromMethod.ImplementationFunc<?>	getFunction()	Get the function that implements the method.
String	getName()	Get the name of the method.
List<InputVariable>	getParameters()	Get the parameters of the method.
OutputVariable<?>	getReturnParameter()	Get the return parameter of the method.

Methods inherited from class java.lang.Object

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

Constructor Detail

MethodDetails

public MethodDetails(String name,
                     @Nullable
                     String description,
                     KernelFunctionFromMethod.ImplementationFunc<?> function,
                     List<InputVariable> parameters,
                     OutputVariable<?> returnParameter)

Constructor.

Parameters:

name - The name of the method.

description - The description of the method.

function - The function that implements the method.

parameters - The parameters of the method.

returnParameter - The return parameter of the method.

Method Detail

getName

public String getName()

Get the name of the method.

Returns:

The name of the method.

getDescription

@Nullable
public String getDescription()

Get the description of the method.

Returns:

The description of the method.

getFunction

public KernelFunctionFromMethod.ImplementationFunc<?> getFunction()

Get the function that implements the method. This is an internal detail.

Returns:

The function that implements the method.

getParameters

public List<InputVariable> getParameters()

Get the parameters of the method.

Returns:

The parameters of the method.

getReturnParameter

public OutputVariable<?> getReturnParameter()

Get the return parameter of the method.

Returns:

The return parameter of the method.