Package com.microsoft.semantickernel.orchestration

Class FunctionResult<T>

java.lang.Object

com.microsoft.semantickernel.orchestration.FunctionResult<T>

Type Parameters:

T - The type of the result of the function invocation.

public class FunctionResult<T>
extends Object

The result of a function invocation.

This class is used to return the result of a function invocation. It contains the result of the function invocation and metadata about the result.

Constructor Summary

Constructors

Constructor	Description
FunctionResult(ContextVariable<T> result, FunctionResultMetadata metadata, Object unconvertedResult)	Create a new instance of FunctionResult.
FunctionResult(ContextVariable<T> of, Object unconvertedResult)	Create a new instance of FunctionResult with no metadata.

Method Summary

Modifier and Type	Method	Description
FunctionResultMetadata	getMetadata()	Get the metadata about the result of the function invocation.
T	getResult()	Get the result of the function invocation.
ContextVariable<T>	getResultVariable()	Get the result of the function invocation.
Object	getUnconvertedResult()	Get the result of the function invocation before it was converted to the expected type.

Methods inherited from class java.lang.Object

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

Constructor Detail

FunctionResult

public FunctionResult(ContextVariable<T> result,
                      @Nullable
                      FunctionResultMetadata metadata,
                      @Nullable
                      Object unconvertedResult)

Create a new instance of FunctionResult.

Parameters:

result - The result of the function invocation.

metadata - Metadata about the result of the function invocation.

unconvertedResult - The result of the function invocation before it was converted to the expected type.

FunctionResult

public FunctionResult(ContextVariable<T> of,
                      @Nullable
                      Object unconvertedResult)

Create a new instance of FunctionResult with no metadata.

Parameters:

of - The result of the function invocation.

unconvertedResult - The result of the function invocation before it was converted to the expected type.

Method Detail

getResult

@Nullable
public T getResult()

Get the result of the function invocation. NOTE: If you get a ClassCastException from this method, try adding a result type with FunctionInvocation.withResultType(ContextVariableType) )}

Returns:

The result of the function invocation.

Throws:

ClassCastException - If the result is not of the expected type.

getResultVariable

public ContextVariable<T> getResultVariable()

Get the result of the function invocation.

Returns:

The result of the function invocation.

getMetadata

public FunctionResultMetadata getMetadata()

Get the metadata about the result of the function invocation.

Returns:

The metadata about the result of the function invocation.

getUnconvertedResult

@Nullable
public Object getUnconvertedResult()

Get the result of the function invocation before it was converted to the expected type.

Returns:

The result of the function invocation before it was converted to the expected type.