type-alias
Source: events.ts ↗
ChatDefinitionReceivedEvent
An event emitted when a definition is received in a live assistant response or replayed from chat history.
export type ChatDefinitionReceivedEvent = BaseEvent & {
type: "onDefinitionReceived";
definitionType: "dashboard" | "visualization" | "publisherDocument" | "publisherDocumentV2" | "alert";
itemId: string;
conversationId: string;
interactionId?: string;
dashboard?: IDashboard;
insights?: IInsight[];
visualization?: NonNullable<IChatConversationVisualisationContent["visualization"]>;
alertProposal?: IAlertProposal;
} & Partial<IAiAssistantPublisherDocumentDefinition> & Partial<Pick<IAiAssistantPublisherDocumentDefinitionV2, "publisherDocumentV2">>;
References: BaseEvent, IDashboard, IInsight
Remarks
The payload fields depend on definitionType; not every optional field is populated for every event. Publisher document payloads and their metadata (documentRef, refines, reworksOpenDocument, and baseDocumentId) are inherited from IAiAssistantPublisherDocumentDefinition. The v2 payload is inherited from IAiAssistantPublisherDocumentDefinitionV2.publisherDocumentV2.