Interface Message

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

Properties

attachments? content metadata? role

Properties

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.

content

content: string | MessageContentPartParam[]

The text contents of the message.

Optionalmetadata

metadata?: null | 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.

role

role: "assistant" | "user"

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.

Settings

Member Visibility

On This Page

Properties