All Implemented Interfaces:


public final class Message

Represents a message within a thread.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public final class`	`Message.Builder`
`public final class`	`Message.Attachment`
`public final class`	`Message.IncompleteDetails`	On an incomplete message, details about why the message is incomplete.
`public final class`	`Message.Object`	The object type, which is always `thread.message`.
`public final class`	`Message.Role`	The entity that produced the message. One of `user` or `assistant`.
`public final class`	`Message.Status`	The status of the message, which can be either `in_progress`, `incomplete`, or `completed`.

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 String`	`id()`	The identifier, which can be referenced in API endpoints.
`final Optional<String>`	`assistantId()`	If applicable, the ID of the assistant that authored this message.
`final Optional<List<Message.Attachment>>`	`attachments()`	A list of files attached to the message, and the tools they were added to.
`final Optional<Long>`	`completedAt()`	The Unix timestamp (in seconds) for when the message was completed.
`final List<MessageContent>`	`content()`	The content of the message in array of text and/or images.
`final Long`	`createdAt()`	The Unix timestamp (in seconds) for when the message was created.
`final Optional<Long>`	`incompleteAt()`	The Unix timestamp (in seconds) for when the message was marked as incomplete.
`final Optional<Message.IncompleteDetails>`	`incompleteDetails()`	On an incomplete message, details about why the message is incomplete.
`final JsonValue`	`_metadata()`	Set of 16 key-value pairs that can be attached to an object.
`final Message.Object`	`object_()`	The object type, which is always `thread.message`.
`final Message.Role`	`role()`	The entity that produced the message.
`final Optional<String>`	`runId()`	The ID of the run associated with the creation of this message.
`final Message.Status`	`status()`	The status of the message, which can be either `in_progress`, `incomplete`, or `completed`.
`final String`	`threadId()`	The thread ID that this message belongs to.
`final JsonField<String>`	`_id()`	The identifier, which can be referenced in API endpoints.
`final JsonField<String>`	`_assistantId()`	If applicable, the ID of the assistant that authored this message.
`final JsonField<List<Message.Attachment>>`	`_attachments()`	A list of files attached to the message, and the tools they were added to.
`final JsonField<Long>`	`_completedAt()`	The Unix timestamp (in seconds) for when the message was completed.
`final JsonField<List<MessageContent>>`	`_content()`	The content of the message in array of text and/or images.
`final JsonField<Long>`	`_createdAt()`	The Unix timestamp (in seconds) for when the message was created.
`final JsonField<Long>`	`_incompleteAt()`	The Unix timestamp (in seconds) for when the message was marked as incomplete.
`final JsonField<Message.IncompleteDetails>`	`_incompleteDetails()`	On an incomplete message, details about why the message is incomplete.
`final JsonField<Message.Object>`	`_object_()`	The object type, which is always `thread.message`.
`final JsonField<Message.Role>`	`_role()`	The entity that produced the message.
`final JsonField<String>`	`_runId()`	The ID of the run associated with the creation of this message.
`final JsonField<Message.Status>`	`_status()`	The status of the message, which can be either `in_progress`, `incomplete`, or `completed`.
`final JsonField<String>`	`_threadId()`	The thread ID that this message belongs to.
`final Map<String, JsonValue>`	`_additionalProperties()`
`final Message`	`validate()`
`final Message.Builder`	`toBuilder()`
`Boolean`	`equals(Object other)`
`Integer`	`hashCode()`
`String`	`toString()`
`final static Message.Builder`	`builder()`

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

- Constructor Detail
- Method Detail
  - id
```
 final String id()
```
    The identifier, which can be referenced in API endpoints.
  - assistantId
```
 final Optional<String> assistantId()
```
    If applicable, the ID of the assistant that authored this message.
  - attachments
```
 final Optional<List<Message.Attachment>> attachments()
```
    A list of files attached to the message, and the tools they were added to.
  - completedAt
```
 final Optional<Long> completedAt()
```
    The Unix timestamp (in seconds) for when the message was completed.
  - content
```
 final List<MessageContent> content()
```
    The content of the message in array of text and/or images.
  - createdAt
```
 final Long createdAt()
```
    The Unix timestamp (in seconds) for when the message was created.
  - incompleteAt
```
 final Optional<Long> incompleteAt()
```
    The Unix timestamp (in seconds) for when the message was marked as incomplete.
  - incompleteDetails
```
 final Optional<Message.IncompleteDetails> incompleteDetails()
```
    On an incomplete message, details about why the message is incomplete.
  - _metadata
```
 final JsonValue _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. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long.
  - object_
```
 final Message.Object object_()
```
    The object type, which is always thread.message.
  - role
```
 final Message.Role role()
```
    The entity that produced the message. One of user or assistant.
  - runId
```
 final Optional<String> runId()
```
    The ID of the run associated with the creation of this message. Value is null when messages are created manually using the create message or create thread endpoints.
  - status
```
 final Message.Status status()
```
    The status of the message, which can be either in_progress, incomplete, or completed.
  - threadId
```
 final String threadId()
```
    The thread ID that this message belongs to.
  - _id
```
 final JsonField<String> _id()
```
    The identifier, which can be referenced in API endpoints.
  - _assistantId
```
 final JsonField<String> _assistantId()
```
    If applicable, the ID of the assistant that authored this message.
  - _attachments
```
 final JsonField<List<Message.Attachment>> _attachments()
```
    A list of files attached to the message, and the tools they were added to.
  - _completedAt
```
 final JsonField<Long> _completedAt()
```
    The Unix timestamp (in seconds) for when the message was completed.
  - _content
```
 final JsonField<List<MessageContent>> _content()
```
    The content of the message in array of text and/or images.
  - _createdAt
```
 final JsonField<Long> _createdAt()
```
    The Unix timestamp (in seconds) for when the message was created.
  - _incompleteAt
```
 final JsonField<Long> _incompleteAt()
```
    The Unix timestamp (in seconds) for when the message was marked as incomplete.
  - _incompleteDetails
```
 final JsonField<Message.IncompleteDetails> _incompleteDetails()
```
    On an incomplete message, details about why the message is incomplete.
  - _object_
```
 final JsonField<Message.Object> _object_()
```
    The object type, which is always thread.message.
  - _role
```
 final JsonField<Message.Role> _role()
```
    The entity that produced the message. One of user or assistant.
  - _runId
```
 final JsonField<String> _runId()
```
    The ID of the run associated with the creation of this message. Value is null when messages are created manually using the create message or create thread endpoints.
  - _status
```
 final JsonField<Message.Status> _status()
```
    The status of the message, which can be either in_progress, incomplete, or completed.
  - _threadId
```
 final JsonField<String> _threadId()
```
    The thread ID that this message belongs to.
  - _additionalProperties
```
 final Map<String, JsonValue> _additionalProperties()
```
  - validate
```
 final Message validate()
```
  - toBuilder
```
 final Message.Builder toBuilder()
```
  - equals
```
 Boolean equals(Object other)
```
  - hashCode
```
 Integer hashCode()
```
  - toString
```
 String toString()
```
  - builder
```
 final static Message.Builder builder()
```

Class Message

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

id

assistantId

attachments

completedAt

content

createdAt

incompleteAt

incompleteDetails

_metadata

object_

role

runId

status

threadId

_id

_assistantId

_attachments

_completedAt

_content

_createdAt

_incompleteAt

_incompleteDetails

_object_

_role

_runId

_status

_threadId

_additionalProperties

validate

toBuilder

equals

hashCode

toString

builder