Class ChatCompletionAssistantMessageParam
-
- All Implemented Interfaces:
public final class ChatCompletionAssistantMessageParamMessages sent by the model in response to user messages.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classChatCompletionAssistantMessageParam.BuilderA builder for ChatCompletionAssistantMessageParam.
public final classChatCompletionAssistantMessageParam.AudioData about a previous audio response from the model. Learn more.
public final classChatCompletionAssistantMessageParam.ContentThe contents of the assistant message. Required unless
tool_callsorfunction_callis specified.public final classChatCompletionAssistantMessageParam.FunctionCallDeprecated 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 JsonValue_role()The role of the messages author, in this case assistant.final Optional<ChatCompletionAssistantMessageParam.Audio>audio()Data about a previous audio response from the model. final Optional<ChatCompletionAssistantMessageParam.Content>content()The contents of the assistant message. final Optional<ChatCompletionAssistantMessageParam.FunctionCall>functionCall()Deprecated and replaced by tool_calls.final Optional<String>name()An optional name for the participant. final Optional<String>refusal()The refusal message by the assistant. final Optional<List<ChatCompletionMessageToolCall>>toolCalls()The tool calls generated by the model, such as function calls. final JsonField<ChatCompletionAssistantMessageParam.Audio>_audio()Returns the raw JSON value of audio. final JsonField<ChatCompletionAssistantMessageParam.Content>_content()Returns the raw JSON value of content. final JsonField<ChatCompletionAssistantMessageParam.FunctionCall>_functionCall()Returns the raw JSON value of functionCall. final JsonField<String>_name()Returns the raw JSON value of name. final JsonField<String>_refusal()Returns the raw JSON value of refusal. final JsonField<List<ChatCompletionMessageToolCall>>_toolCalls()Returns the raw JSON value of toolCalls. final Map<String, JsonValue>_additionalProperties()final ChatCompletionAssistantMessageParam.BuildertoBuilder()final ChatCompletionAssistantMessageParamvalidate()Validates that the types of all values in this object match their expected types recursively. final BooleanisValid()Booleanequals(Object other)IntegerhashCode()StringtoString()final static ChatCompletionAssistantMessageParam.Builderbuilder()Returns a mutable builder for constructing an instance of ChatCompletionAssistantMessageParam. -
-
Method Detail
-
_role
final JsonValue _role()
The role of the messages author, in this case
assistant.Expected to always return the following:
JsonValue.from("assistant")However, this method can be useful for debugging and logging (e.g. if the server responded with an unexpected value).
-
audio
final Optional<ChatCompletionAssistantMessageParam.Audio> audio()
Data about a previous audio response from the model. Learn more.
-
content
final Optional<ChatCompletionAssistantMessageParam.Content> content()
The contents of the assistant message. Required unless
tool_callsorfunction_callis specified.
-
functionCall
@Deprecated(message = "deprecated") final Optional<ChatCompletionAssistantMessageParam.FunctionCall> functionCall()
Deprecated and replaced by
tool_calls. The name and arguments of a function that should be called, as generated by the model.
-
name
final Optional<String> name()
An optional name for the participant. Provides the model information to differentiate between participants of the same role.
-
toolCalls
final Optional<List<ChatCompletionMessageToolCall>> toolCalls()
The tool calls generated by the model, such as function calls.
-
_audio
final JsonField<ChatCompletionAssistantMessageParam.Audio> _audio()
Returns the raw JSON value of audio.
Unlike audio, this method doesn't throw if the JSON field has an unexpected type.
-
_content
final JsonField<ChatCompletionAssistantMessageParam.Content> _content()
Returns the raw JSON value of content.
Unlike content, this method doesn't throw if the JSON field has an unexpected type.
-
_functionCall
@Deprecated(message = "deprecated") final JsonField<ChatCompletionAssistantMessageParam.FunctionCall> _functionCall()
Returns the raw JSON value of functionCall.
Unlike functionCall, this method doesn't throw if the JSON field has an unexpected type.
-
_name
final JsonField<String> _name()
Returns the raw JSON value of name.
Unlike name, this method doesn't throw if the JSON field has an unexpected type.
-
_refusal
final JsonField<String> _refusal()
Returns the raw JSON value of refusal.
Unlike refusal, this method doesn't throw if the JSON field has an unexpected type.
-
_toolCalls
final JsonField<List<ChatCompletionMessageToolCall>> _toolCalls()
Returns the raw JSON value of toolCalls.
Unlike toolCalls, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
toBuilder
final ChatCompletionAssistantMessageParam.Builder toBuilder()
-
validate
final ChatCompletionAssistantMessageParam validate()
Validates that the types of all values in this object match their expected types recursively.
This method is not forwards compatible with new types from the API for existing fields.
-
builder
final static ChatCompletionAssistantMessageParam.Builder builder()
Returns a mutable builder for constructing an instance of ChatCompletionAssistantMessageParam.
-
-
-
-