IAiAssistantContextChangedEvent

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

IAiAssistantContextChangedEvent 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 informing the host of the active application's current AI-assistant tag scope.

Signature:

export interface IAiAssistantContextChangedEvent extends IPluggableAppEvent 

Extends: IPluggableAppEvent

Remarks

A hosted application can constrain its catalog to objects tagged in a certain way (e.g. AD's includeObjectsWithTags route filter). Because the host owns the single chat instance on hosted routes, the application forwards its current tag scope through this event so the host assistant's object search/autocomplete stays within the same scope the rest of the application enforces. The host keeps the latest reported scope and clears it (empty arrays / omitted) when the application no longer constrains its catalog.

Properties

Property	Modifiers	Type	Description
payload	readonly	{ readonly includeTags?: string[]; readonly excludeTags?: string[]; }	(ALPHA)
type	readonly	"GDC.PLUGGABLE_APP/EVT.AI_ASSISTANT.CONTEXT_CHANGED"	(ALPHA)