Class ChatCompletion.Choice.FinishReason
-
- All Implemented Interfaces:
-
com.openai.core.Enum
public final class ChatCompletion.Choice.FinishReason implements EnumThe reason the model stopped generating tokens. This will be
stopif the model hit a natural stop point or a provided stop sequence,lengthif the maximum number of tokens specified in the request was reached,content_filterif content was omitted due to a flag from our content filters,tool_callsif the model called a tool, orfunction_call(deprecated) if the model called a function.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public enumChatCompletion.Choice.FinishReason.KnownAn enum containing FinishReason's known values.
public enumChatCompletion.Choice.FinishReason.ValueAn enum containing FinishReason's known values, as well as an _UNKNOWN member.
An instance of FinishReason 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 ChatCompletion.Choice.FinishReasonSTOPpublic final static ChatCompletion.Choice.FinishReasonLENGTHpublic final static ChatCompletion.Choice.FinishReasonTOOL_CALLSpublic final static ChatCompletion.Choice.FinishReasonCONTENT_FILTERpublic final static ChatCompletion.Choice.FinishReasonFUNCTION_CALL
-
Method Summary
Modifier and Type Method Description final JsonField<String>_value()Returns this class instance's raw value. final ChatCompletion.Choice.FinishReason.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 ChatCompletion.Choice.FinishReason.Knownknown()Returns an enum member corresponding to this class instance's value. final StringasString()Booleanequals(Object other)IntegerhashCode()StringtoString()final static ChatCompletion.Choice.FinishReasonof(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 ChatCompletion.Choice.FinishReason.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 ChatCompletion.Choice.FinishReason.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 ChatCompletion.Choice.FinishReason of(String value)
-
-
-
-