Class StructuredChatCompletionMessage
-
- All Implemented Interfaces:
public final class StructuredChatCompletionMessage<T extends Object>
A wrapper for ChatCompletionMessage that provides type-safe access to the content when using the Structured Outputs feature to deserialize a JSON response to an instance of an arbitrary class. See the SDK documentation for more details on Structured Outputs.
-
-
Field Summary
Fields Modifier and Type Field Description private final Class<T>
responseType
private final ChatCompletionMessage
rawMessage
-
Method Summary
Modifier and Type Method Description final Class<T>
responseType()
final ChatCompletionMessage
rawMessage()
final Optional<T>
content()
final Optional<String>
refusal()
final JsonValue
_role()
final Optional<List<ChatCompletionMessage.Annotation>>
annotations()
final Optional<ChatCompletionAudio>
audio()
final Optional<ChatCompletionMessage.FunctionCall>
functionCall()
final Optional<List<ChatCompletionMessageToolCall>>
toolCalls()
final JsonField<T>
_content()
final JsonField<String>
_refusal()
final JsonField<List<ChatCompletionMessage.Annotation>>
_annotations()
final JsonField<ChatCompletionAudio>
_audio()
final JsonField<ChatCompletionMessage.FunctionCall>
_functionCall()
final JsonField<List<ChatCompletionMessageToolCall>>
_toolCalls()
final Map<String, JsonValue>
_additionalProperties()
final ChatCompletionMessage
validate()
final Boolean
isValid()
Boolean
equals(Object other)
Integer
hashCode()
String
toString()
-
-
Method Detail
-
responseType
final Class<T> responseType()
-
rawMessage
final ChatCompletionMessage rawMessage()
-
annotations
final Optional<List<ChatCompletionMessage.Annotation>> annotations()
-
audio
final Optional<ChatCompletionAudio> audio()
-
functionCall
@Deprecated(message = "deprecated") final Optional<ChatCompletionMessage.FunctionCall> functionCall()
-
toolCalls
final Optional<List<ChatCompletionMessageToolCall>> toolCalls()
-
_annotations
final JsonField<List<ChatCompletionMessage.Annotation>> _annotations()
-
_audio
final JsonField<ChatCompletionAudio> _audio()
-
_functionCall
@Deprecated(message = "deprecated") final JsonField<ChatCompletionMessage.FunctionCall> _functionCall()
-
_toolCalls
final JsonField<List<ChatCompletionMessageToolCall>> _toolCalls()
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
validate
final ChatCompletionMessage validate()
-
-
-
-