Model Context

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

API Reference

mergeModelContexts

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

ModelContextClient

const ModelContextClient: () => ResourceElement<ClientOutput<"modelContext">, undefined>;

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; }>

useThreadModelContext

Deprecated: Use useAuiState((s) => s.thread.modelContext) instead. See migration guide: https://assistant-ui.com/docs/migrations/v0-12

useThreadModelContext

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

optional?: false