From Bright Pattern Documentation
< 5.19:AgentDesktop-client-side-javascript-api-specification
Revision as of 01:30, 26 February 2026 by Wyler.metge (talk | contribs) (Updated via BpClonePage extension. Source page: draft:AgentDesktop-client-side-javascript-api-specification/onSummaryGenerationStarted)
• 5.19
onSummaryGenerationStarted
Subscribes to the event triggered when AI summary generation begins. This event indicates the application should monitor for the summaryGenerationCompleted event. Requires Real Time AI Summary / Notes to be enabled for the associated service.
Request
on('ON_SUMMARY_GENERATION_STARTED', handler: OnSummaryGenerationStarted): void
type OnSummaryGenerationStarted = (interactionId: string) => void
Parameters
| Parameter | Parameter Values | Data Type | Optional/Required | Description |
| interactionId | String | Required | ID of the interaction for which this Summary is generated |
Example Request
function summaryGenerationStartedCallback(interactionId: string) {
console.log("Summary generation started for interaction:", interactionId);
}
adApi.on("ON_SUMMARY_GENERATION_STARTED", summaryGenerationStartedCallback);
Return Value
void