onAskAiAssistant

Home > @gooddata/sdk-pluggable-application-model > IHostUiMountOptions > onAskAiAssistant

IHostUiMountOptions.onAskAiAssistant property

This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Requests the host to open its AI assistant chat seeded with a question.

Signature:

onAskAiAssistant?: (question: string, agentId?: string, userContext?: IGenAIUserContext, appendToChat?: boolean, replaceUserContext?: boolean) => void;

Remarks

Used by host UI affordances that hand a question to the assistant (e.g. the header semantic search "ask AI" action). userContext carries the user's current location when available.