@unith-ai/core-client 2.0.5 → 2.0.61

package/README.md

@@ -70,8 +70,10 @@ const conversation = await Conversation.startDigitalHuman({
 - **language** - Language code for the conversation (default: browser language)
 - **allowWakeLock** - Prevent screen from sleeping during conversation (default: true)
 - **microphoneProvider** - Provider for the microphone - `"azure" | "eleven_labs"`
+- **voiceInterruptions** - Flag to enable response interruption when voice signal is recognized. - `boolean` (default: `false`)
 - **microphoneOptions** - Callbacks for microphone events
   - **onMicrophoneSpeechRecognitionResult ({ transcript: string })** - Called when microphone recognizes your user's speech. This returns a transcript. Ideal behavior is to call the `.sendMessage` method with your transcript as microphone doesn't automatically commit / send users text to our AI.
+  - **onMicrophonePartialSpeechRecognitionResult ()** - Called when microphone recognizes that the user is trying to speak. This **doesn't** returns a transcript. Ideal behavior is to check if digital human is currently responding (`speaking`) and trigger the stop response method (`.stopResponse`).
   - **onMicrophoneStatusChange ({status})** Called when microphone status changes
     - **status** `"ON" | "OFF" | "PROCESSING"` Shows current status of microphone.
   - **onMicrophoneError ({ message: string })** - Called when microphone has an error with the error message.
@@ -81,6 +83,7 @@ const conversation = await Conversation.startDigitalHuman({
   - **vadThreshold `Number`**
   - **minSpeechDurationMs `Number`**
   - **minSilenceDurationMs `Number`**
+  - **disableDynamicSpeechRecognition `Boolean`** - This disables ElevenLabs dynamic speech recognition language detection and uses the language specified during digital human creation.
 
 #### Callbacks
 
@@ -111,6 +114,8 @@ Register callbacks to handle various events:
 - **onTimeoutWarning** - Called before the session times out. This event warns you that the customers session is going to end in a bit. You can call the `keepSession` method to extend the customers session.
 - **onKeepSession** - Called when a keep-alive request is processed
 - **onError** - Called when an error occurs
+- **onStoppingStart** - Called immediately when a stop request is initiated
+- **onStoppingEnd** - Called once the current response stops playing
 
 ### Getting Background Video
 
@@ -186,6 +191,17 @@ Get the current user's ID:
 const userId = conversation.getUserId();
 ```
 
+#### stopResponse()
+
+Stops the ongoing response and notifies you via two callbacks:
+
+- `onStoppingStart()` - Called immediately when stop is initiated.
+- `onStoppingEnd()` - Called once the current response is stopped.
+
+```js
+await conversation.stopResponse();
+```
+
 #### endSession()
 
 End the conversation session and clean up resources: