Type Alias MessageMetadata<StateType>

type MessageMetadata<StateType extends Record<string, unknown>> = {
    branch: string | undefined;
    branchOptions: string[] | undefined;
    firstSeenState: ThreadState<StateType> | undefined;
    messageId: string;
    streamMetadata: Record<string, unknown> | undefined;
}

Properties

branch: string | undefined

The branch of the message.

branchOptions: string[] | undefined

The list of branches this message is part of. This is useful for displaying branching controls.

firstSeenState: ThreadState<StateType> | undefined

The first thread state the message was seen in.

messageId: string

The ID of the message used.

streamMetadata: Record<string, unknown> | undefined

Metadata sent alongside the message during run streaming.

This metadata only exists temporarily in browser memory during streaming and is not persisted after completion.