Class ResponseOutputMessage
-
- All Implemented Interfaces:
public final class ResponseOutputMessage
An output message from the model.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final class
ResponseOutputMessage.Builder
A builder for ResponseOutputMessage.
public final class
ResponseOutputMessage.Content
A text output from the model.
public final class
ResponseOutputMessage.Status
The status of the message input. One of
in_progress
,completed
, orincomplete
. Populated when input items are returned via API.
-
Method Summary
Modifier and Type Method Description final String
id()
The unique ID of the output message. final List<ResponseOutputMessage.Content>
content()
The content of the output message. final JsonValue
_role()
The role of the output message. final ResponseOutputMessage.Status
status()
The status of the message input. final JsonValue
_type()
The type of the output message. final JsonField<String>
_id()
Returns the raw JSON value of id. final JsonField<List<ResponseOutputMessage.Content>>
_content()
Returns the raw JSON value of content. final JsonField<ResponseOutputMessage.Status>
_status()
Returns the raw JSON value of status. final Map<String, JsonValue>
_additionalProperties()
final ResponseOutputMessage
validate()
final ResponseOutputMessage.Builder
toBuilder()
Boolean
equals(Object other)
Integer
hashCode()
String
toString()
final static ResponseOutputMessage.Builder
builder()
Returns a mutable builder for constructing an instance of ResponseOutputMessage. -
-
Method Detail
-
content
final List<ResponseOutputMessage.Content> content()
The content of the output message.
-
_role
final JsonValue _role()
The role of the output message. Always
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).
-
status
final ResponseOutputMessage.Status status()
The status of the message input. One of
in_progress
,completed
, orincomplete
. Populated when input items are returned via API.
-
_type
final JsonValue _type()
The type of the output message. Always
message
.Expected to always return the following:
JsonValue.from("message")
However, this method can be useful for debugging and logging (e.g. if the server responded with an unexpected value).
-
_id
final JsonField<String> _id()
Returns the raw JSON value of id.
Unlike id, this method doesn't throw if the JSON field has an unexpected type.
-
_content
final JsonField<List<ResponseOutputMessage.Content>> _content()
Returns the raw JSON value of content.
Unlike content, this method doesn't throw if the JSON field has an unexpected type.
-
_status
final JsonField<ResponseOutputMessage.Status> _status()
Returns the raw JSON value of status.
Unlike status, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
validate
final ResponseOutputMessage validate()
-
toBuilder
final ResponseOutputMessage.Builder toBuilder()
-
builder
final static ResponseOutputMessage.Builder builder()
Returns a mutable builder for constructing an instance of ResponseOutputMessage.
The following fields are required:
.id() .content() .status()
-
-
-
-