Class Reasoning.Summary
-
- All Implemented Interfaces:
-
com.openai.core.Enum
public final class Reasoning.Summary implements Enum
A summary of the reasoning performed by the model. This can be useful for debugging and understanding the model's reasoning process. One of
auto
,concise
, ordetailed
.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public enum
Reasoning.Summary.Known
An enum containing Summary's known values.
public enum
Reasoning.Summary.Value
An enum containing Summary's known values, as well as an _UNKNOWN member.
An instance of Summary 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 Reasoning.Summary
AUTO
public final static Reasoning.Summary
CONCISE
public final static Reasoning.Summary
DETAILED
-
Method Summary
Modifier and Type Method Description final JsonField<String>
_value()
Returns this class instance's raw value. final Reasoning.Summary.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. final Reasoning.Summary.Known
known()
Returns an enum member corresponding to this class instance's value. final String
asString()
Returns this class instance's primitive wire representation. final Reasoning.Summary
validate()
final Boolean
isValid()
Boolean
equals(Object other)
Integer
hashCode()
String
toString()
final static Reasoning.Summary
of(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 Reasoning.Summary.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 Reasoning.Summary.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.
-
asString
final String asString()
Returns this class instance's primitive wire representation.
This differs from the toString method because that method is primarily for debugging and generally doesn't throw.
-
validate
final Reasoning.Summary validate()
-
of
final static Reasoning.Summary of(String value)
-
-
-
-