Class ChatMessage

constructor

• new ChatMessage(params): ChatMessage

• Parameters

  • params: {
        content: string | ChatContent[];
        createdAt?: number;
        extra?: Record<string, unknown>;
        id?: string;
        interrupted?: boolean;
        metrics?: MetricsReport;
        role: ChatRole;
        transcriptConfidence?: number;
    }

    • content: string | ChatContent[]

    • Optional createdAt?: number

    • Optional extra?: Record<string, unknown>

    • Optional id?: string

    • Optional interrupted?: boolean

    • Optional metrics?: MetricsReport

    • role: ChatRole

    • Optional transcriptConfidence?: number

  Returns ChatMessage

content

createdAt

extra

Optional hash

Readonly id

interrupted

metrics

Readonly role

Optional transcriptConfidence

Readonly type

rawTextContent

• get rawTextContent(): undefined | string

• Returns a single string with all text parts of the message joined by new lines, exactly as generated. Assistant messages may contain expressive <expr/> tags.

  Returns undefined | string

textContent

• get textContent(): undefined | string

• Returns a single string with all text parts of the message joined by new lines, with LiveKit's expressive <expr/> tags removed from assistant messages. If no string content is present, returns undefined.

  Returns undefined | string

toJSON

• toJSON(excludeTimestamp?): JSONValue

• Parameters

  • excludeTimestamp: boolean = false

  Returns JSONValue

toJSONContent

• toJSONContent(): JSONValue[]

• Returns JSONValue[]

Static create

• create(params): ChatMessage

• Parameters

  • params: {
        content: string | ChatContent[];
        createdAt?: number;
        extra?: Record<string, unknown>;
        id?: string;
        interrupted?: boolean;
        metrics?: MetricsReport;
        role: ChatRole;
        transcriptConfidence?: number;
    }

    • content: string | ChatContent[]

    • Optional createdAt?: number

    • Optional extra?: Record<string, unknown>

    • Optional id?: string

    • Optional interrupted?: boolean

    • Optional metrics?: MetricsReport

    • role: ChatRole

    • Optional transcriptConfidence?: number

  Returns ChatMessage