Interface Message

interface Message {
    content: string | MessageContentPartParam[];
    role: "user" | "assistant";
    attachments?: null | OpenAIClient.Beta.Threads.ThreadCreateParams.Message.Attachment[];
    metadata?: unknown;
}

Properties

content role attachments? metadata?

Properties

content

content: string | MessageContentPartParam[]

The text contents of the message.

role

role: "user" | "assistant"

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.

Optionalattachments

attachments?: null | OpenAIClient.Beta.Threads.ThreadCreateParams.Message.Attachment[]

A list of files attached to the message, and the tools they should be added to.

Optionalmetadata

metadata?: unknown

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 maxium of 512 characters long.

Settings

Member Visibility

On This Page

Properties