All Implemented Interfaces:: com.openai.core.Params

@Deprecated(message = "The Assistants API is deprecated in favor of the Responses API") 
public final class MessageCreateParams
 implements Params

Create a message.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public final class`	`MessageCreateParams.Builder`	A builder for MessageCreateParams.
`public final class`	`MessageCreateParams.Body`
`public final class`	`MessageCreateParams.Content`	The text contents of the message.
`public final class`	`MessageCreateParams.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.
`public final class`	`MessageCreateParams.Attachment`
`public final class`	`MessageCreateParams.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.

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final Optional<String>`	`threadId()`
`final MessageCreateParams.Content`	`content()`	The text contents of the message.
`final MessageCreateParams.Role`	`role()`	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>`	`_additionalBodyProperties()`
`final Headers`	`_additionalHeaders()`	Additional headers to send with the request.
`final QueryParams`	`_additionalQueryParams()`	Additional query param to send with the request.
`final MessageCreateParams.Builder`	`toBuilder()`
`final MessageCreateParams.Body`	`_body()`
`final String`	`_pathParam(Integer index)`
`Headers`	`_headers()`	The full set of headers in the parameters, including both fixed and additional headers.
`QueryParams`	`_queryParams()`	The full set of query params in the parameters, including both fixed and additional query params.
`Boolean`	`equals(Object other)`
`Integer`	`hashCode()`
`String`	`toString()`
`final static MessageCreateParams.Builder`	`builder()`	Returns a mutable builder for constructing an instance of MessageCreateParams.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
- Method Detail
  - threadId
```
 final Optional<String> threadId()
```
  - 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.
  - _additionalBodyProperties
```
 final Map<String, JsonValue> _additionalBodyProperties()
```
  - _additionalHeaders
```
 final Headers _additionalHeaders()
```
    Additional headers to send with the request.
  - _additionalQueryParams
```
 final QueryParams _additionalQueryParams()
```
    Additional query param to send with the request.
  - toBuilder
```
 final MessageCreateParams.Builder toBuilder()
```
  - _body
```
 final MessageCreateParams.Body _body()
```
  - _pathParam
```
 final String _pathParam(Integer index)
```
  - _headers
```
 Headers _headers()
```
    The full set of headers in the parameters, including both fixed and additional headers.
  - _queryParams
```
 QueryParams _queryParams()
```
    The full set of query params in the parameters, including both fixed and additional query params.
  - equals
```
 Boolean equals(Object other)
```
  - hashCode
```
 Integer hashCode()
```
  - toString
```
 String toString()
```
  - builder
```
 final static MessageCreateParams.Builder builder()
```
    Returns a mutable builder for constructing an instance of MessageCreateParams.
    The following fields are required:
    .content() .role()

Class MessageCreateParams

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

threadId

content

role

attachments

metadata

_content

_role

_attachments

_metadata

_additionalBodyProperties

_additionalHeaders

_additionalQueryParams

toBuilder

_body

_pathParam

_headers

_queryParams

equals

hashCode

toString

builder