@onereach/step-voice 6.1.16-changegrammarstructure.0 → 6.1.17-test.0

package/dst/Choice.js

@@ -81,7 +81,7 @@ class Choice extends voice_1.default {
         const grammar = {
             id: this.currentStepId,
             choices,
-            asrSettings
+            asr: asrSettings
         };
         const command = {
             name: 'speak',
@@ -97,6 +97,19 @@ class Choice extends voice_1.default {
         // There's a specific need to do so. There might be ${variable} section
         this.triggers.local(`in/voice/${call.id}`, async (event) => {
             const reportingSettingsKey = this.rptsStarted ? 'transcriptRepromptResponse' : 'transcriptResponse';
+            const interruptionMetadata = event.params.interruptionMetadata ?? null;
+            if (interruptionMetadata) {
+                await this.transcript(call, {
+                    sections: speechSections,
+                    reprompt: {
+                        maxAttempts: repromptsList.length,
+                        attempt: 0
+                    },
+                    reportingSettingsKey: 'transcriptPrompt',
+                    action: 'Call Prompt',
+                    actionFromBot: true
+                }, interruptionMetadata);
+            }
             switch (event.params.type) {
                 case 'digit':
                 case 'digits': {
@@ -105,9 +118,11 @@ class Choice extends voice_1.default {
                     const exitId = params.exitId;
                     // On bargeIn, we should stop playback
                     if (exitExists(exitId)) {
+                        const exitStepLabel = this.getExitStepLabel(exitId) ?? '';
+                        const message = lodash_1.default.replace(exitStepLabel, /^(\d+\. )?(~ )?/, '');
                         await this.transcript(call, {
                             keyPress: digit,
-                            message: lodash_1.default.replace(this.getExitStepLabel(exitId) ?? '', /^(\d+\. )?(~ )?/, ''),
+                            message: message,
                             reportingSettingsKey,
                             action: 'Call DTMF',
                             actionFromBot: false
@@ -245,7 +260,7 @@ class Choice extends voice_1.default {
             }
         });
         this.triggers.otherwise(async () => {
-            await this.transcript(call, {
+            const eventId = await this.transcript(call, {
                 sections: speechSections,
                 reprompt: {
                     maxAttempts: repromptsList.length,
@@ -255,6 +270,7 @@ class Choice extends voice_1.default {
                 action: 'Call Prompt',
                 actionFromBot: true
             });
+            command.params.reporterTranscriptEventId = eventId;
             command.params.sections = speechSections;
             command.params.timeout = this.rptsTimeout({ noReplyDelay, repromptsList, initial: true });
             await this.pauseRecording(call, command, sensitiveData);

package/dst/Custom Voice Input.js

@@ -74,7 +74,7 @@ class CustomVoiceInput extends voice_1.default {
         const grammar = {
             id: this.currentStepId,
             choices,
-            asrSettings
+            asr: asrSettings
         };
         const command = {
             name: 'double-asr',

package/dst/Global Command.js

@@ -331,7 +331,7 @@ class GlobalCommand extends voice_1.default {
         return {
             id: this.currentStepId,
             choices,
-            asrSettings: asr.getSettings(call.asr)
+            asr: asr.getSettings(call.asr)
         };
     }
     acceptAck(eventParams) {

package/dst/Keypad Input.js

@@ -34,7 +34,7 @@ class KeypadInput extends voice_1.default {
         const asrSettings = asr.getSettings(call.asr);
         const grammar = {
             id: this.currentStepId,
-            asrSettings: {
+            asr: {
                 ...asrSettings,
                 config: {
                     version: 'v1beta',

package/dst/Say Message.js

@@ -8,7 +8,26 @@ class SayMessage extends voice_1.default {
     async runStep() {
         const { audio, textType, tts, sensitiveData } = this.data;
         const call = await this.fetchData();
+        const speechSections = lodash_1.default.map(audio, (section) => ({
+            text: section.voiceTextMsg,
+            url: section.audioUrl,
+            bargeInVoice: false,
+            bargeInKeypad: false,
+            textType,
+            provider: ttsSettings.provider,
+            ...ttsSettings
+        }));
+        const ttsSettings = tts.getSettings(call.tts);
         this.triggers.local(`in/voice/${call.id}`, async (event) => {
+            const interruptionMetadata = event.params.interruptionMetadata ?? null;
+            if (interruptionMetadata) {
+                await this.transcript(call, {
+                    action: 'Call Prompt',
+                    sections: speechSections,
+                    reportingSettingsKey: 'transcript',
+                    actionFromBot: true
+                }, interruptionMetadata);
+            }
             switch (event.params.type) {
                 case 'hangup':
                     await this.handleHangup(call);
@@ -26,19 +45,10 @@ class SayMessage extends voice_1.default {
             }
         });
         this.triggers.otherwise(async () => {
-            const ttsSettings = tts.getSettings(call.tts);
             const command = {
                 name: 'speak',
                 params: {
-                    sections: lodash_1.default.map(audio, (section) => ({
-                        text: section.voiceTextMsg,
-                        url: section.audioUrl,
-                        bargeInVoice: false,
-                        bargeInKeypad: false,
-                        textType,
-                        provider: ttsSettings.provider,
-                        ...ttsSettings
-                    }))
+                    sections: speechSections
                 }
             };
             await this.transcript(call, {

package/dst/voice.d.ts

@@ -42,10 +42,19 @@ export type VoicerError = Error & {
     date?: never;
     originateStatus?: never;
 };
+export interface VoiceInterruptionMetadata {
+    interruptionReason: 'keypad' | 'voice';
+    interruptionTime: number;
+    playedTime: number;
+    sectionIndex: number;
+    sectionDuration: number;
+    reporterTranscriptEventId: string;
+}
 export interface VoiceEvent {
     type: EventType;
     global?: boolean;
     error?: VoicerError;
+    interruptionMetadata: VoiceInterruptionMetadata;
 }
 export interface CallStartEvent extends VoiceEvent {
     channel: IVoiceCall;
@@ -61,14 +70,15 @@ export default class VoiceStep<TIn = unknown, TOut = unknown, TParams extends Vo
     sendCommands({ id, type, callback }: IVoiceCall, commands: TODO[]): Promise<void>;
     handleHeartbeat(call: IVoiceCall): Promise<void>;
     handleCancel(): void;
-    extractSectionMessages(sections: IPromtpSection[]): string;
+    extractSectionMessages(sections: IPromtpSection[], interruptionMetadata?: VoiceInterruptionMetadata): string;
+    extractPlayedSectionMessage(text: string, sectionDuration: number, playedTime: number): string;
     extractSectionFiles(sections: IPromtpSection[]): Array<{
         fileUrl: string;
         fileType: string;
     }>;
     pauseRecording(call: IVoiceCall, command: any, sensitiveData?: SensitiveData): Promise<void>;
     resumeRecording(call: IVoiceCall, sensitiveData?: SensitiveData): Promise<void>;
-    transcript(call: IVoiceCall, data?: Partial<IVoiceReporterTranscriptEventArgs>): Promise<string>;
+    transcript(call: IVoiceCall, data?: Partial<IVoiceReporterTranscriptEventArgs>, interruptionMetadata?: VoiceInterruptionMetadata): Promise<string>;
     throwError(error?: VoicerError): never;
     handleHangup(call: IVoiceCall): Promise<void>;
     buildSections({ sections, textType, ttsSettings, allowKeypadBargeIn }: TODO): TODO;

package/dst/voice.js

@@ -103,16 +103,33 @@ class VoiceStep extends step_1.default {
         else
             this.end();
     }
-    extractSectionMessages(sections) {
+    extractSectionMessages(sections, interruptionMetadata) {
         return lodash_1.default.chain(sections)
             .filter(s => Boolean(s.text))
-            .map(s => {
+            .map((s, index) => {
             // Should escape html, max length 4000 symbols
-            return s.text?.slice(0, 4000).replace(/(<[^>]+>|<\/[^>]+>)/gi, ' ');
+            let text = s.text?.slice(0, 4000).replace(/(<[^>]+>|<\/[^>]+>)/gi, ' ') ?? '';
+            // Extracts the portion of the section text that corresponds to the played time.
+            if (interruptionMetadata) {
+                const { playedTime, sectionDuration, sectionIndex } = interruptionMetadata;
+                if (sectionIndex === index) {
+                    text = this.extractPlayedSectionMessage(text, sectionDuration, playedTime);
+                }
+            }
+            return text;
         })
             .join(' ')
             .value();
     }
+    extractPlayedSectionMessage(text, sectionDuration, playedTime) {
+        const words = text.split(' ');
+        const totalWords = words.length;
+        const sectionDurationSec = sectionDuration / 1000;
+        const playedTimeSec = playedTime / 1000;
+        const wordsPerSecond = totalWords / sectionDurationSec;
+        const wordsPlayed = Math.floor(wordsPerSecond * playedTimeSec);
+        return words.slice(0, wordsPlayed).join(' ');
+    }
     extractSectionFiles(sections) {
         return lodash_1.default.chain(sections)
             .filter(s => Boolean(s.url))
@@ -151,7 +168,7 @@ class VoiceStep extends step_1.default {
                 }
             }]);
     }
-    async transcript(call, data = {}) {
+    async transcript(call, data = {}, interruptionMetadata) {
         const { previousTranscriptId = call.lastTranscriptId, action, keyPress, message, voiceProcessResult, reportingSettingsKey, sections, reprompt, recording, conferenceId, actionFromBot = false } = data;
         const eventId = (0, uuid_1.v4)();
         const fromIdentifier = actionFromBot ? call.botNumber : call.endUserNumber;
@@ -175,7 +192,7 @@ class VoiceStep extends step_1.default {
             eventId
         };
         if (sections != null) {
-            const allMessages = this.extractSectionMessages(sections);
+            const allMessages = this.extractSectionMessages(sections, interruptionMetadata);
             const allFiles = this.extractSectionFiles(sections);
             if (!lodash_1.default.isEmpty(allMessages))
                 reportingObject.message = allMessages;
@@ -195,7 +212,30 @@ class VoiceStep extends step_1.default {
             reportingObject.keyPress = keyPress;
         else if (voiceProcessResult)
             reportingObject.voiceProcessResult = voiceProcessResult;
-        await this.reporter.reportTranscriptEvent(reportingObject);
+        /**
+         * If we have the previous transcript event ID,
+         * which was returned from the interrupted message,
+         * try to update the reporting message.
+         */
+        if (interruptionMetadata?.reporterTranscriptEventId) {
+            if (this.process.cache.hitl) {
+                const updateReportingObject = {
+                    EventId: eventId,
+                    Timestamp: new Date().toISOString(),
+                    Event: 'Augment',
+                    EventValue: {
+                        eventId: interruptionMetadata.reporterTranscriptEventId,
+                        eventValue: {
+                            Message: reportingObject.message,
+                        }
+                    }
+                };
+                await this.process.cache.hitl.queueEvents([updateReportingObject]);
+            }
+        }
+        else {
+            await this.reporter.reportTranscriptEvent(reportingObject);
+        }
         call.lastTranscriptId = eventId;
         await this.updateData();
         return eventId;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@onereach/step-voice",
-  "version": "6.1.16-changegrammarstructure.0",
+  "version": "6.1.17-test.0",
   "author": "Roman Zolotarov <roman.zolotarov@onereach.com>",
   "contributors": [
     "Roman Zolotarov",