IOpenAiAssistantRequestedEvent

Home > @gooddata/sdk-pluggable-application-model > IOpenAiAssistantRequestedEvent

IOpenAiAssistantRequestedEvent interface

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.

Event requesting the host to open its AI assistant chat.

Signature:

export interface IOpenAiAssistantRequestedEvent extends IPluggableAppEvent 

Extends: IPluggableAppEvent

Remarks

The host shell owns the AI assistant on hosted-application routes — a pluggable application must not render its own chat dialog there (two assistants would overlay each other and a duplicate could auto-open from the shared open-state, see LX-2544). Instead, its in-content entry points (e.g. a "Summarize" action) emit this event and the host opens its chat, optionally seeded with a question and the user's location context. Tag scoping for the assistant's object search is carried separately via IAiAssistantContextChangedEvent, which reflects the app's current view.

Properties

Property	Modifiers	Type	Description
payload	readonly	{ readonly question?: string; readonly userContext?: IGenAIUserContext; }	(ALPHA)
type	readonly	"GDC.PLUGGABLE_APP/EVT.AI_ASSISTANT.OPEN_REQUESTED"	(ALPHA)