Interface IOutlineMessage

Interface representing a message in the outline system. Used to structure messages stored in the outline history, typically for user, assistant, or system interactions. IOutlineMessage

interface IOutlineMessage {
    content: string;
    images?: string[] | Uint8Array[];
    role: "user" | "tool" | "assistant" | "system";
    tool_call_id?: string;
    tool_calls?: IToolCall[];
}

Properties

content: string

The content of the message. Contains the raw text or param of the message, used in history storage or processing.

images?: string[] | Uint8Array[]

Optional array of images associated with the message, represented as binary data or base64 strings. Likely used for messages involving visual content (e.g., user-uploaded images or tool-generated visuals). Supports Uint8Array for raw binary data or string for encoded formats (e.g., base64). Undefined if no images are included in the message.

role: "user" | "tool" | "assistant" | "system"

The role of the message sender, either user, assistant, or system. Determines the context or source of the message in the outline history.

tool_call_id?: string

Optional ID of the tool call associated with the message. Used to link the message to a specific tool execution request.

tool_calls?: IToolCall[]

The name of the agent associated with the message. Allow to attach tool call request to specific message