Chatoyant - v0.2.1
    Preparing search index...

    Class Message

    Message class representing a single message in a conversation.

    // Create messages
    const system = Message.system("You are helpful");
    const user = Message.user("Hello!");
    const assistant = Message.assistant("Hi there!");

    // Or use constructor
    const msg = new Message("user", "Hello!");

    // Serialize
    const json = msg.toJSON();
    const restored = Message.fromJSON(json);
    Index

    Constructors

    constructor

    Properties

    role content name? toolCallId? metadata?

    Methods

    toJSON fromJSON system user assistant tool withContent withMetadata isSystem isUser isAssistant isTool

    Constructors

    • Create a new Message.

      Parameters

      • role: MessageRole

        The message role

      • content: string

        The message content

      • Optionaloptions: { name?: string; toolCallId?: string; metadata?: Record<string, unknown> }

        Optional name, toolCallId, metadata

      Returns Message

    Properties

    role: MessageRole

    Message role

    Readonlycontent

    content: string

    Message content

    name?: string

    Optional name (for multi-agent scenarios)

    toolCallId?: string

    Tool call ID (for tool responses)

    metadata?: Record<string, unknown>

    Optional metadata for extensions

    Methods

    • Create a system message.

      Parameters

      • content: string
      • Optionalmetadata: Record<string, unknown>

      Returns Message

    • Create a user message.

      Parameters

      • content: string
      • Optionalmetadata: Record<string, unknown>

      Returns Message

    • Create an assistant message.

      Parameters

      • content: string
      • Optionalmetadata: Record<string, unknown>

      Returns Message

    • Create a tool response message.

      Parameters

      • content: string
      • toolCallId: string
      • Optionalmetadata: Record<string, unknown>

      Returns Message

    • Create a copy with additional metadata.

      Parameters

      • metadata: Record<string, unknown>

      Returns Message

    • Check if this is a system message.

      Returns boolean

    • Check if this is a user message.

      Returns boolean

    • Check if this is an assistant message.

      Returns boolean

    • Check if this is a tool message.

      Returns boolean

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods