Class RealtimeConversationItemUserMessage
-
- All Implemented Interfaces:
public final class RealtimeConversationItemUserMessageA user message item in a Realtime conversation.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classRealtimeConversationItemUserMessage.BuilderA builder for RealtimeConversationItemUserMessage.
public final classRealtimeConversationItemUserMessage.Contentpublic final classRealtimeConversationItemUserMessage.ObjectIdentifier for the API object being returned - always
realtime.item. Optional when creating a new item.public final classRealtimeConversationItemUserMessage.StatusThe status of the item. Has no effect on the conversation.
-
Method Summary
Modifier and Type Method Description final List<RealtimeConversationItemUserMessage.Content>content()The content of the message. final JsonValue_role()The role of the message sender. final JsonValue_type()The type of the item. final Optional<String>id()The unique ID of the item. final Optional<RealtimeConversationItemUserMessage.Object>object_()Identifier for the API object being returned - always realtime.item.final Optional<RealtimeConversationItemUserMessage.Status>status()The status of the item. final JsonField<List<RealtimeConversationItemUserMessage.Content>>_content()Returns the raw JSON value of content. final JsonField<String>_id()Returns the raw JSON value of id. final JsonField<RealtimeConversationItemUserMessage.Object>_object_()Returns the raw JSON value of object_. final JsonField<RealtimeConversationItemUserMessage.Status>_status()Returns the raw JSON value of status. final Map<String, JsonValue>_additionalProperties()final RealtimeConversationItemUserMessage.BuildertoBuilder()final RealtimeConversationItemUserMessagevalidate()Validates that the types of all values in this object match their expected types recursively. final BooleanisValid()Booleanequals(Object other)IntegerhashCode()StringtoString()final static RealtimeConversationItemUserMessage.Builderbuilder()Returns a mutable builder for constructing an instance of RealtimeConversationItemUserMessage. -
-
Method Detail
-
content
final List<RealtimeConversationItemUserMessage.Content> content()
The content of the message.
-
_role
final JsonValue _role()
The role of the message sender. Always
user.Expected to always return the following:
JsonValue.from("user")However, this method can be useful for debugging and logging (e.g. if the server responded with an unexpected value).
-
_type
final JsonValue _type()
The type of the item. 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 Optional<String> id()
The unique ID of the item. This may be provided by the client or generated by the server.
-
object_
final Optional<RealtimeConversationItemUserMessage.Object> object_()
Identifier for the API object being returned - always
realtime.item. Optional when creating a new item.
-
status
final Optional<RealtimeConversationItemUserMessage.Status> status()
The status of the item. Has no effect on the conversation.
-
_content
final JsonField<List<RealtimeConversationItemUserMessage.Content>> _content()
Returns the raw JSON value of content.
Unlike content, this method doesn't throw if the JSON field has an unexpected type.
-
_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.
-
_object_
final JsonField<RealtimeConversationItemUserMessage.Object> _object_()
Returns the raw JSON value of object_.
Unlike object_, this method doesn't throw if the JSON field has an unexpected type.
-
_status
final JsonField<RealtimeConversationItemUserMessage.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()
-
toBuilder
final RealtimeConversationItemUserMessage.Builder toBuilder()
-
validate
final RealtimeConversationItemUserMessage 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 RealtimeConversationItemUserMessage.Builder builder()
Returns a mutable builder for constructing an instance of RealtimeConversationItemUserMessage.
The following fields are required:
.content()
-
-
-
-