HUME-4611: Add pause/resume messages (#207)

Author: jacobhume

examples/next-app/components/ExampleComponent.tsx

@@ -3,7 +3,7 @@
 import type { EmotionScores } from '@humeai/voice';
 import { useVoice } from '@humeai/voice-react';
 import { SelectItem } from '@radix-ui/react-select';
-import { useMemo, useState } from 'react';
+import { useCallback, useMemo, useState } from 'react';
 import { match } from 'ts-pattern';
 
 import {
@@ -38,12 +38,26 @@ export const ExampleComponent = () => {
     callDurationTimestamp,
     sendUserInput,
     sendAssistantInput,
+    sendResumeAssistantMessage,
+    sendPauseAssistantMessage,
   } = useVoice();
 
   const [textValue, setTextValue] = useState('');
   const [textInputType, setTextInputType] = useState<'user' | 'assistant'>(
     'user',
   );
+  const [paused, setPaused] = useState(false);
+
+  const togglePaused = useCallback(() => {
+    if (paused) {
+      sendResumeAssistantMessage();
+      setPaused(false);
+    } else {
+      sendPauseAssistantMessage();
+      setPaused(true);
+    }
+  }, [paused]);
+  const pausedText = paused ? 'Resume' : 'Pause';
 
   const assistantMessages = useMemo(() => {
     return messages
@@ -165,6 +179,13 @@ export const ExampleComponent = () => {
                   >
                     Send text input message
                   </button>
+
+                  <button
+                    className="border border-black p-2"
+                    onClick={togglePaused}
+                  >
+                    {pausedText}
+                  </button>
                 </div>
 
                 <div>

packages/core/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@humeai/voice",
-  "version": "0.1.6-beta.1",
+  "version": "0.1.6-beta.2",
   "description": "",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",

packages/core/src/lib/client.ts

@@ -243,4 +243,42 @@ export class VoiceClient {
   get readyState() {
     return this.socket.readyState;
   }
+
+  /**
+   * @name sendPauseAssistantMessage
+   * @description
+   * Send pause assistant message to the websocket. This pauses responses from EVI. Chat history is still saved and sent after resuming.
+   */
+  sendPauseAssistantMessage() {
+    if (!this.socket) {
+      throw new Error('Socket is not connected.');
+    }
+
+    if (this.socket.readyState !== WebSocket.OPEN) {
+      throw new Error('Socket is not open.');
+    }
+
+    const json = JSON.stringify({ type: 'pause_assistant_message' });
+
+    this.socket.send(json);
+  }
+
+  /**
+   * @name sendResumeAssistantMessage
+   * @description
+   * Send resume assistant message to the websocket. This resumes responses from EVI. Chat history sent while paused will now be sent.
+   */
+  sendResumeAssistantMessage() {
+    if (!this.socket) {
+      throw new Error('Socket is not connected.');
+    }
+
+    if (this.socket.readyState !== WebSocket.OPEN) {
+      throw new Error('Socket is not open.');
+    }
+
+    const json = JSON.stringify({ type: 'resume_assistant_message' });
+
+    this.socket.send(json);
+  }
 }

packages/core/src/models/pause-assistant-message.ts

@@ -0,0 +1,7 @@
+import z from 'zod';
+
+export const PauseAssistantMessageSchema = z.object({
+  type: z.literal('pause_assistant_message'),
+});
+
+export type PauseAssistantMessage = z.infer<typeof PauseAssistantMessageSchema>;

packages/core/src/models/resume-assistant-message.ts

@@ -0,0 +1,9 @@
+import z from 'zod';
+
+export const ResumeAssistantMessageSchema = z.object({
+  type: z.literal('resume_assistant_message'),
+});
+
+export type ResumeAssistantMessage = z.infer<
+  typeof ResumeAssistantMessageSchema
+>;

packages/embed-react/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@humeai/voice-embed-react",
-  "version": "0.1.6-beta.1",
+  "version": "0.1.6-beta.2",
   "description": "",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",

packages/embed/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@humeai/voice-embed",
-  "version": "0.1.6-beta.1",
+  "version": "0.1.6-beta.2",
   "description": "",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",

packages/react/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@humeai/voice-react",
-  "version": "0.1.6-beta.1",
+  "version": "0.1.6-beta.2",
   "description": "",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",

packages/react/src/lib/VoiceProvider.tsx

@@ -82,6 +82,8 @@ export type VoiceContextType = {
   sendAssistantInput: VoiceClient['sendAssistantInput'];
   sendSessionSettings: VoiceClient['sendSessionSettings'];
   sendToolMessage: VoiceClient['sendToolMessage'];
+  sendPauseAssistantMessage: VoiceClient['sendPauseAssistantMessage'];
+  sendResumeAssistantMessage: VoiceClient['sendResumeAssistantMessage'];
   status: VoiceStatus;
   micFft: number[];
   error: VoiceError | null;
@@ -379,6 +381,8 @@ export const VoiceProvider: FC<VoiceProviderProps> = ({
         sendAssistantInput: client.sendAssistantInput,
         sendSessionSettings: client.sendSessionSettings,
         sendToolMessage: client.sendToolMessage,
+        sendPauseAssistantMessage: client.sendPauseAssistantMessage,
+        sendResumeAssistantMessage: client.sendResumeAssistantMessage,
         status,
         unmute: mic.unmute,
         error,
@@ -407,6 +411,8 @@ export const VoiceProvider: FC<VoiceProviderProps> = ({
       client.sendAssistantInput,
       client.sendSessionSettings,
       client.sendToolMessage,
+      client.sendPauseAssistantMessage,
+      client.sendResumeAssistantMessage,
       status,
       error,
       isAudioError,

packages/react/src/lib/useVoiceClient.ts

@@ -205,6 +205,12 @@ export const useVoiceClient = (props: {
     },
     [],
   );
+  const sendPauseAssistantMessage = useCallback(() => {
+    client.current?.sendPauseAssistantMessage();
+  }, []);
+  const sendResumeAssistantMessage = useCallback(() => {
+    client.current?.sendResumeAssistantMessage();
+  }, []);
 
   return {
     readyState,
@@ -215,5 +221,7 @@ export const useVoiceClient = (props: {
     sendUserInput,
     sendAssistantInput,
     sendToolMessage,
+    sendPauseAssistantMessage,
+    sendResumeAssistantMessage,
   };
 };