Package com.microsoft.semantickernel.orchestration

Enum ResponseFormat

java.lang.Object

java.lang.Enum<ResponseFormat>

com.microsoft.semantickernel.orchestration.ResponseFormat

All Implemented Interfaces:

Serializable, Comparable<ResponseFormat>

public enum ResponseFormat
extends Enum<ResponseFormat>

Enum Constant Summary

Enum Constants

Enum Constant	Description
JSON_OBJECT	Only valid for openai chat completion, with GPT-4 and gpt-3.5-turbo-1106+ models.
TEXT

Method Summary

Modifier and Type	Method	Description
static ResponseFormat	valueOf(String name)	Returns the enum constant of this type with the specified name.
static ResponseFormat[]	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

JSON_OBJECT

public static final ResponseFormat JSON_OBJECT

Only valid for openai chat completion, with GPT-4 and gpt-3.5-turbo-1106+ models.

TEXT

public static final ResponseFormat TEXT

Method Detail

values

public static ResponseFormat[] 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 (ResponseFormat c : ResponseFormat.values())
    System.out.println(c);

Returns:

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

valueOf

public static ResponseFormat 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