Member Junction
    Preparing search index...

    Type Alias ChatMessage<M>

    Defines the shape of an individual chat message.

    type ChatMessage<M = any> = {
        content: ChatMessageContent;
        metadata?: M;
        role: ChatMessageRole;
    }

    Type Parameters

    • M = any

      Optional metadata type. Use this to attach typed metadata to messages without coupling the core ChatMessage type to specific implementations.

    Hierarchy (View Summary)

    Index

    Properties

    content metadata? role

    Properties

    content

    content: ChatMessageContent

    Content of the message, can be any string or an array of content blocks.

    metadata?: M

    Optional metadata for the message. The type can be specified via the generic parameter. This allows different consumers to attach their own typed metadata without modifying the core ChatMessage type.

    role: ChatMessageRole

    Role of the message in the conversation.

    Settings

    Member Visibility

    On This Page

    Properties