Model Context

Provide model instructions, contextual state, and inline renderers to assistant-ui runtimes.

API Reference

makeAssistantVisible

const makeAssistantVisible: <T extends ComponentType<any>>(Component: T, config?: { clickable?: boolean | undefined; editable?: boolean | undefined; }) => T;

mergeModelContexts

const mergeModelContexts: (configSet: Set<ModelContextProvider>) => ModelContext;

ModelContextClient

const ModelContextClient: Resource<ClientOutput<"modelContext">, []>;

ModelContextProvider

ModelContextProvider

getModelContext : () => ModelContext
subscribe ?: (callback: () => void) => Unsubscribe

useAssistantContext

useAssistantContext

config : AssistantContextConfig

getContext : () => string
disabled ?: boolean

useAssistantInstructions

useAssistantInstructions

config : string | AssistantInstructionsConfig

useInlineRender

useInlineRender

toolUI : FC<ToolCallMessagePart<ReadonlyJSONObject, unknown> & { readonly status: MessagePartStatus | ToolCallMessagePartStatus; } & ToolCallMessagePart<TArgs, TResult> & { addResult: (result: TResult | ToolResponse<TResult>) => void; resume: (payload: unknown) => void; respondToApproval: (response: ToolApprovalResponse) => void; }>

useThreadModelContext

Deprecated. Use useAuiState: useAuiState((s) => s.thread.modelContext). See the migration guide.

useThreadModelContext

options ?: { optional?: false | undefined; }

optional ?: false