MethodDetails Class

Package:
com.microsoft.semantickernel.semanticfunctions
Maven Artifact:
com.microsoft.semantic-kernel:semantickernel-api:1.4.0
  • java.lang.Object
    • com.microsoft.semantickernel.semanticfunctions.MethodDetails

public class MethodDetails

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

Constructor Summary

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

Constructor.

Method Summary

Modifier and Type Method and Description
java.lang.String getDescription()

Get the description of the method.
ImplementationFunc<?> getFunction()

Get the function that implements the method.
java.lang.String getName()

Get the name of the method.
java.util.List<InputVariable> getParameters()

Get the parameters of the method.
OutputVariable<?> getReturnParameter()

Get the return parameter of the method.

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

MethodDetails

public MethodDetails(String name, String description, KernelFunctionFromMethod.ImplementationFunc function, List 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 Details

getDescription

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.

getName

public String getName()

Get the name of the method.

Returns:

The name of the method.

getParameters

public List 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.

Applies to