Package org.apache.flink.model.openai

Enum OpenAIChatModelFunction.ChatModelResponseFormat

java.lang.Object

java.lang.Enum<OpenAIChatModelFunction.ChatModelResponseFormat>

org.apache.flink.model.openai.OpenAIChatModelFunction.ChatModelResponseFormat

All Implemented Interfaces:

Serializable, Comparable<OpenAIChatModelFunction.ChatModelResponseFormat>

Enclosing class:

OpenAIChatModelFunction

public static enum OpenAIChatModelFunction.ChatModelResponseFormat
extends Enum<OpenAIChatModelFunction.ChatModelResponseFormat>

The response format for Chat model function. It's an Enum representation for ChatCompletionCreateParams.ResponseFormat.

Enum Constant Summary

Enum Constants

Enum Constant	Description
JSON_OBJECT
TEXT

Method Summary

Modifier and Type	Method	Description
abstract com.openai.models.chat.completions.ChatCompletionCreateParams.ResponseFormat	getResponseFormat()
String	toString()
static OpenAIChatModelFunction.ChatModelResponseFormat	valueOf(String name)	Returns the enum constant of this type with the specified name.
static OpenAIChatModelFunction.ChatModelResponseFormat[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

TEXT

public static final OpenAIChatModelFunction.ChatModelResponseFormat TEXT

JSON_OBJECT

public static final OpenAIChatModelFunction.ChatModelResponseFormat JSON_OBJECT

Method Detail

values

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

Returns:

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

valueOf

public static OpenAIChatModelFunction.ChatModelResponseFormat 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

getResponseFormat

public abstract com.openai.models.chat.completions.ChatCompletionCreateParams.ResponseFormat getResponseFormat()

toString

public String toString()

Overrides:

toString in class Enum<OpenAIChatModelFunction.ChatModelResponseFormat>