Class Run.IncompleteDetails.Reason
-
- All Implemented Interfaces:
-
com.openai.core.Enum
public final class Run.IncompleteDetails.Reason implements EnumThe reason why the run is incomplete. This will point to which specific token limit was reached over the course of the run.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public enumRun.IncompleteDetails.Reason.KnownAn enum containing Reason's known values.
public enumRun.IncompleteDetails.Reason.ValueAn enum containing Reason's known values, as well as an _UNKNOWN member.
An instance of Reason 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 Run.IncompleteDetails.ReasonMAX_COMPLETION_TOKENSpublic final static Run.IncompleteDetails.ReasonMAX_PROMPT_TOKENS
-
Method Summary
Modifier and Type Method Description final JsonField<String>_value()Returns this class instance's raw value. final Run.IncompleteDetails.Reason.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 Run.IncompleteDetails.Reason.Knownknown()Returns an enum member corresponding to this class instance's value. final StringasString()Booleanequals(Object other)IntegerhashCode()StringtoString()final static Run.IncompleteDetails.Reasonof(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 Run.IncompleteDetails.Reason.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 Run.IncompleteDetails.Reason.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 Run.IncompleteDetails.Reason of(String value)
-
-
-
-