Class ChatCompletionMessage
-
- All Implemented Interfaces:
public final class ChatCompletionMessage
A chat completion message generated by the model.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final class
ChatCompletionMessage.Builder
public final class
ChatCompletionMessage.Role
The role of the author of this message.
public final class
ChatCompletionMessage.FunctionCall
Deprecated and replaced by
tool_calls
. The name and arguments of a function that should be called, as generated by the model.
-
Method Summary
Modifier and Type Method Description final Optional<String>
content()
The contents of the message. final Optional<String>
refusal()
The refusal message generated by the model. final ChatCompletionMessage.Role
role()
The role of the author of this message. final Optional<ChatCompletionAudio>
audio()
If the audio output modality is requested, this object contains data about the audio response from the model. final Optional<ChatCompletionMessage.FunctionCall>
functionCall()
Deprecated and replaced by tool_calls
.final Optional<List<ChatCompletionMessageToolCall>>
toolCalls()
The tool calls generated by the model, such as function calls. final JsonField<String>
_content()
The contents of the message. final JsonField<String>
_refusal()
The refusal message generated by the model. final JsonField<ChatCompletionMessage.Role>
_role()
The role of the author of this message. final JsonField<ChatCompletionAudio>
_audio()
If the audio output modality is requested, this object contains data about the audio response from the model. final JsonField<ChatCompletionMessage.FunctionCall>
_functionCall()
Deprecated and replaced by tool_calls
.final JsonField<List<ChatCompletionMessageToolCall>>
_toolCalls()
The tool calls generated by the model, such as function calls. final Map<String, JsonValue>
_additionalProperties()
final ChatCompletionMessage
validate()
final ChatCompletionMessage.Builder
toBuilder()
Boolean
equals(Object other)
Integer
hashCode()
String
toString()
final static ChatCompletionMessage.Builder
builder()
-
-
Method Detail
-
role
final ChatCompletionMessage.Role role()
The role of the author of this message.
-
audio
final Optional<ChatCompletionAudio> audio()
If the audio output modality is requested, this object contains data about the audio response from the model. Learn more.
-
functionCall
@Deprecated(message = "deprecated") final Optional<ChatCompletionMessage.FunctionCall> functionCall()
Deprecated and replaced by
tool_calls
. The name and arguments of a function that should be called, as generated by the model.
-
toolCalls
final Optional<List<ChatCompletionMessageToolCall>> toolCalls()
The tool calls generated by the model, such as function calls.
-
_role
final JsonField<ChatCompletionMessage.Role> _role()
The role of the author of this message.
-
_audio
final JsonField<ChatCompletionAudio> _audio()
If the audio output modality is requested, this object contains data about the audio response from the model. Learn more.
-
_functionCall
@Deprecated(message = "deprecated") final JsonField<ChatCompletionMessage.FunctionCall> _functionCall()
Deprecated and replaced by
tool_calls
. The name and arguments of a function that should be called, as generated by the model.
-
_toolCalls
final JsonField<List<ChatCompletionMessageToolCall>> _toolCalls()
The tool calls generated by the model, such as function calls.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
validate
final ChatCompletionMessage validate()
-
toBuilder
final ChatCompletionMessage.Builder toBuilder()
-
builder
final static ChatCompletionMessage.Builder builder()
-
-
-
-