Class ChatCompletionReasoningEffort
-
- All Implemented Interfaces:
-
com.openai.core.Enum
public final class ChatCompletionReasoningEffort implements Enumo1 models only
Constrains effort on reasoning for reasoning models. Currently supported values are
low,medium, andhigh. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public enumChatCompletionReasoningEffort.KnownAn enum containing ChatCompletionReasoningEffort's known values.
public enumChatCompletionReasoningEffort.ValueAn enum containing ChatCompletionReasoningEffort's known values, as well as an _UNKNOWN member.
An instance of ChatCompletionReasoningEffort can contain an unknown value in a couple of cases:
It was deserialized from data that doesn't match any known member. For example, if the SDK is on an older version than the API, then the API may respond with new members that the SDK is unaware of.
It was constructed with an arbitrary value using the of method.
-
Field Summary
Fields Modifier and Type Field Description public final static ChatCompletionReasoningEffortLOWpublic final static ChatCompletionReasoningEffortMEDIUMpublic final static ChatCompletionReasoningEffortHIGH
-
Method Summary
Modifier and Type Method Description final JsonField<String>_value()Returns this class instance's raw value. final ChatCompletionReasoningEffort.Valuevalue()Returns an enum member corresponding to this class instance's value, or Value._UNKNOWN if the class was instantiated with an unknown value. final ChatCompletionReasoningEffort.Knownknown()Returns an enum member corresponding to this class instance's value. final StringasString()Booleanequals(Object other)IntegerhashCode()StringtoString()final static ChatCompletionReasoningEffortof(String value)-
-
Method Detail
-
_value
final JsonField<String> _value()
Returns this class instance's raw value.
This is usually only useful if this instance was deserialized from data that doesn't match any known member, and you want to know that value. For example, if the SDK is on an older version than the API, then the API may respond with new members that the SDK is unaware of.
-
value
final ChatCompletionReasoningEffort.Value value()
Returns an enum member corresponding to this class instance's value, or Value._UNKNOWN if the class was instantiated with an unknown value.
Use the known method instead if you're certain the value is always known or if you want to throw for the unknown case.
-
known
final ChatCompletionReasoningEffort.Known known()
Returns an enum member corresponding to this class instance's value.
Use the value method instead if you're uncertain the value is always known and don't want to throw for the unknown case.
-
of
final static ChatCompletionReasoningEffort of(String value)
-
-
-
-