Package com.microsoft.semantickernel.orchestration

Enum InvocationReturnMode

java.lang.Object

java.lang.Enum<InvocationReturnMode>

com.microsoft.semantickernel.orchestration.InvocationReturnMode

All Implemented Interfaces:

Serializable, Comparable<InvocationReturnMode>

public enum InvocationReturnMode
extends Enum<InvocationReturnMode>

Enum Constant Summary

Enum Constants

Enum Constant	Description
FULL_HISTORY	Function invocations that build upon a history of previous invocations, such as Chat Completions, will return the full history of messages.
LAST_MESSAGE_ONLY	Function invocations that build upon a history of previous invocations, such as Chat Completions, will return only the last message generated by the given invocation.
NEW_MESSAGES_ONLY	Function invocations that build upon a history of previous invocations, such as Chat Completions, will return only new messages generated by the given invocation.

Method Summary

Modifier and Type	Method	Description
static InvocationReturnMode	valueOf(String name)	Returns the enum constant of this type with the specified name.
static InvocationReturnMode[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

FULL_HISTORY

public static final InvocationReturnMode FULL_HISTORY

Function invocations that build upon a history of previous invocations, such as Chat Completions, will return the full history of messages.

NEW_MESSAGES_ONLY

public static final InvocationReturnMode NEW_MESSAGES_ONLY

Function invocations that build upon a history of previous invocations, such as Chat Completions, will return only new messages generated by the given invocation.

This is the expected default behavior for most use cases.

LAST_MESSAGE_ONLY

public static final InvocationReturnMode LAST_MESSAGE_ONLY

Function invocations that build upon a history of previous invocations, such as Chat Completions, will return only the last message generated by the given invocation.

Method Detail

values

public static InvocationReturnMode[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (InvocationReturnMode c : InvocationReturnMode.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static InvocationReturnMode valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null