Message
Defined in: src/types/messages.ts:56
A message in a conversation between user and assistant. Each message has a role (user or assistant) and an array of content blocks.
Implements
Section titled “Implements”JSONSerializable<MessageData>
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new Message(data): Message;Defined in: src/types/messages.ts:77
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
data | { role: Role; content: ContentBlock[]; metadata?: MessageMetadata; } |
data.role | Role |
data.content | ContentBlock[] |
data.metadata? | MessageMetadata |
Returns
Section titled “Returns”Message
Properties
Section titled “Properties”readonly type: "message";Defined in: src/types/messages.ts:60
Discriminator for message type.
readonly role: Role;Defined in: src/types/messages.ts:65
The role of the message sender.
content
Section titled “content”readonly content: ContentBlock[];Defined in: src/types/messages.ts:70
Array of content blocks that make up this message.
metadata?
Section titled “metadata?”readonly optional metadata?: MessageMetadata;Defined in: src/types/messages.ts:75
Optional metadata, not sent to model providers.
Methods
Section titled “Methods”fromMessageData()
Section titled “fromMessageData()”static fromMessageData(data): Message;Defined in: src/types/messages.ts:88
Creates a Message instance from MessageData.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
data | MessageData |
Returns
Section titled “Returns”Message
toJSON()
Section titled “toJSON()”toJSON(): MessageData;Defined in: src/types/messages.ts:102
Serializes the Message to a JSON-compatible MessageData object. Called automatically by JSON.stringify().
Returns
Section titled “Returns”Implementation of
Section titled “Implementation of”JSONSerializable.toJSONfromJSON()
Section titled “fromJSON()”static fromJSON(data): Message;Defined in: src/types/messages.ts:117
Creates a Message instance from MessageData. Alias for fromMessageData for API consistency.
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
data | MessageData | MessageData to deserialize |
Returns
Section titled “Returns”Message
Message instance