Class RealtimeResponseCreateParams.Conversation
-
- All Implemented Interfaces:
-
com.openai.core.Enum
public final class RealtimeResponseCreateParams.Conversation implements Enum
Controls which conversation the response is added to. Currently supports
auto
andnone
, withauto
as the default value. Theauto
value means that the contents of the response will be added to the default conversation. Set this tonone
to create an out-of-band response which will not add items to default conversation.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public enum
RealtimeResponseCreateParams.Conversation.Known
An enum containing Conversation's known values.
public enum
RealtimeResponseCreateParams.Conversation.Value
An enum containing Conversation's known values, as well as an _UNKNOWN member.
An instance of Conversation 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 RealtimeResponseCreateParams.Conversation
AUTO
public final static RealtimeResponseCreateParams.Conversation
NONE
-
Method Summary
Modifier and Type Method Description final JsonField<String>
_value()
Returns this class instance's raw value. final RealtimeResponseCreateParams.Conversation.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 RealtimeResponseCreateParams.Conversation.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 RealtimeResponseCreateParams.Conversation
validate()
final Boolean
isValid()
Boolean
equals(Object other)
Integer
hashCode()
String
toString()
final static RealtimeResponseCreateParams.Conversation
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 RealtimeResponseCreateParams.Conversation.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 RealtimeResponseCreateParams.Conversation.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 RealtimeResponseCreateParams.Conversation validate()
-
of
final static RealtimeResponseCreateParams.Conversation of(String value)
-
-
-
-