Runtime Hooks

MessagePartRuntime

Hook for accessing message part state within parts.

useMessagePart

Access the message part state:

import { useMessagePart } from "@assistant-ui/react";

const part = useMessagePart();
const partState = useMessagePart.getState();

const status = useMessagePart((m) => m.status);
const statusAgain = useMessagePart.getState().status;
MessagePartState
partrequired: Readonly<MessagePartState>

The current message part.

statusrequired: MessageStatus

The current message part status.

MessageStatus
typerequired: 'running' | 'requires-action' | 'complete' | 'incomplete'

The status.

finish-reason?: 'stop' | 'cancelled' | 'length' | 'content-filter' | 'tool-calls' | 'other' | 'unknown'

The finish reason if the status is 'incomplete'.

error?: unknown

The error object if the status is 'error'.