Enum Class OpenAIModelId

java.lang.Object

java.lang.Enum<OpenAIModelId>

ai.singlr.openai.OpenAIModelId

All Implemented Interfaces:

Serializable, Comparable<OpenAIModelId>, Constable

public enum OpenAIModelId
extends Enum<OpenAIModelId>

Supported OpenAI model identifiers.

Each enum constant maps to a specific model available through the Responses API.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	OpenAIModelId.EffortSupport	The reasoning.effort value range a model accepts on the Responses API.

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
GPT_4_1
GPT_4_1_MINI
GPT_4_1_NANO
GPT_4O
GPT_4O_MINI
GPT_5_4
GPT_5_4_MINI
GPT_5_4_NANO
GPT_5_5
GPT_5_6
GPT_5_6_LUNA
GPT_5_6_SOL
GPT_5_6_TERRA
O3
O4_MINI

Method Summary

Modifier and Type	Method	Description
int	contextWindow()	Returns the context window size in tokens.
OpenAIModelId.EffortSupport	effortSupport()	The reasoning.effort range this model accepts.
static OpenAIModelId	fromId(String id)	Finds an OpenAIModelId by its string identifier.
String	id()	Returns the API model identifier string.
static boolean	isSupported(String id)	Checks if the given model ID is supported.
int	maxOutputTokens()	Returns the maximum output tokens this model can generate in a single response.
boolean	supportsXhighEffort()	Deprecated. use effortSupport(); the boolean cannot express the gpt-5.6 family's none/max support
static OpenAIModelId	valueOf(String name)	Returns the enum constant of this class with the specified name.
static OpenAIModelId[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class Enum

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

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

GPT_5_6

public static final OpenAIModelId GPT_5_6

GPT_5_6_SOL

public static final OpenAIModelId GPT_5_6_SOL

GPT_5_6_TERRA

public static final OpenAIModelId GPT_5_6_TERRA

GPT_5_6_LUNA

public static final OpenAIModelId GPT_5_6_LUNA

GPT_5_5

public static final OpenAIModelId GPT_5_5

GPT_5_4

public static final OpenAIModelId GPT_5_4

GPT_5_4_MINI

public static final OpenAIModelId GPT_5_4_MINI

GPT_5_4_NANO

public static final OpenAIModelId GPT_5_4_NANO

GPT_4_1

public static final OpenAIModelId GPT_4_1

GPT_4_1_MINI

public static final OpenAIModelId GPT_4_1_MINI

GPT_4_1_NANO

public static final OpenAIModelId GPT_4_1_NANO

GPT_4O

public static final OpenAIModelId GPT_4O

GPT_4O_MINI

public static final OpenAIModelId GPT_4O_MINI

O3

public static final OpenAIModelId O3

O4_MINI

public static final OpenAIModelId O4_MINI

Method Details

values

public static OpenAIModelId[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static OpenAIModelId valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

effortSupport

public OpenAIModelId.EffortSupport effortSupport()

The reasoning.effort range this model accepts. Drives the ThinkingLevel → wire mapping in OpenAIModel: tiers above the model's ceiling clamp down so requests stay valid.

Returns:

the effort-support tier

supportsXhighEffort

@Deprecated(since="2.8.0")
public boolean supportsXhighEffort()

Deprecated.

use effortSupport(); the boolean cannot express the gpt-5.6 family's none/max support

Whether this model accepts reasoning.effort=xhigh.

Returns:

true for OpenAIModelId.EffortSupport.EXTENDED and OpenAIModelId.EffortSupport.FULL models

id

public String id()

Returns the API model identifier string.

Returns:

the model ID used in API requests

contextWindow

public int contextWindow()

Returns the context window size in tokens.

Returns:

the context window size

maxOutputTokens

public int maxOutputTokens()

Returns the maximum output tokens this model can generate in a single response. Used as the fallback when ModelConfig.maxOutputTokens() is unset.

Returns:

the per-model output ceiling

fromId

public static OpenAIModelId fromId(String id)

Finds an OpenAIModelId by its string identifier.

Parameters:

id - the model identifier string

Returns:

the matching OpenAIModelId, or null if not found

isSupported

public static boolean isSupported(String id)

Checks if the given model ID is supported.

Parameters:

id - the model identifier string

Returns:

true if the model is supported