Class MessageCreateParams.Body
-
- All Implemented Interfaces:
public final class MessageCreateParams.Body
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classMessageCreateParams.Body.BuilderA builder for Body.
-
Method Summary
Modifier and Type Method Description final MessageCreateParams.Contentcontent()The text contents of the message. final MessageCreateParams.Rolerole()The role of the entity that is creating the message. final Optional<List<MessageCreateParams.Attachment>>attachments()A list of files attached to the message, and the tools they should be added to. final Optional<MessageCreateParams.Metadata>metadata()Set of 16 key-value pairs that can be attached to an object. final JsonField<MessageCreateParams.Content>_content()Returns the raw JSON value of content. final JsonField<MessageCreateParams.Role>_role()Returns the raw JSON value of role. final JsonField<List<MessageCreateParams.Attachment>>_attachments()Returns the raw JSON value of attachments. final JsonField<MessageCreateParams.Metadata>_metadata()Returns the raw JSON value of metadata. final Map<String, JsonValue>_additionalProperties()final MessageCreateParams.Body.BuildertoBuilder()final MessageCreateParams.Bodyvalidate()final BooleanisValid()Booleanequals(Object other)IntegerhashCode()StringtoString()final static MessageCreateParams.Body.Builderbuilder()Returns a mutable builder for constructing an instance of Body. -
-
Method Detail
-
content
final MessageCreateParams.Content content()
The text contents of the message.
-
role
final MessageCreateParams.Role role()
The role of the entity that is creating the message. Allowed values include:
user: Indicates the message is sent by an actual user and should be used in most cases to represent user-generated messages.assistant: Indicates the message is generated by the assistant. Use this value to insert messages from the assistant into the conversation.
-
attachments
final Optional<List<MessageCreateParams.Attachment>> attachments()
A list of files attached to the message, and the tools they should be added to.
-
metadata
final Optional<MessageCreateParams.Metadata> metadata()
Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard.
Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters.
-
_content
final JsonField<MessageCreateParams.Content> _content()
Returns the raw JSON value of content.
Unlike content, this method doesn't throw if the JSON field has an unexpected type.
-
_role
final JsonField<MessageCreateParams.Role> _role()
Returns the raw JSON value of role.
Unlike role, this method doesn't throw if the JSON field has an unexpected type.
-
_attachments
final JsonField<List<MessageCreateParams.Attachment>> _attachments()
Returns the raw JSON value of attachments.
Unlike attachments, this method doesn't throw if the JSON field has an unexpected type.
-
_metadata
final JsonField<MessageCreateParams.Metadata> _metadata()
Returns the raw JSON value of metadata.
Unlike metadata, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
toBuilder
final MessageCreateParams.Body.Builder toBuilder()
-
validate
final MessageCreateParams.Body validate()
-
builder
final static MessageCreateParams.Body.Builder builder()
Returns a mutable builder for constructing an instance of Body.
The following fields are required:
.content() .role()
-
-
-
-