Tools

Tool Rendering

Register React renderers for assistant-ui tool calls, tool results, and model data parts.

API Reference

DataRenderers

const DataRenderers: () => ResourceElement<ClientOutput<"dataRenderers">, undefined>;

makeAssistantDataUI

type AssistantDataUIProps = {
  name: string;
  render: DataMessagePartComponent<T>;
};

const makeAssistantDataUI: <T = any>(dataUI: AssistantDataUIProps<T>) => AssistantDataUI;

makeAssistantToolUI

type AssistantToolUIProps = {
  toolName: string;
  render: ToolCallMessagePartComponent<TArgs, TResult>;
};

const makeAssistantToolUI: <TArgs, TResult>(tool: AssistantToolUIProps<TArgs, TResult>) => AssistantToolUI;

useAssistantDataUI

useAssistantDataUI
dataUI: AssistantDataUIProps<any> | null

name: string

render: DataMessagePartComponent<T>

useAssistantToolUI

useAssistantToolUI
tool: AssistantToolUIProps<any, any> | null

toolName: string

render: ToolCallMessagePartComponent<TArgs, TResult>