@unith-ai/core-client 2.0.4 → 2.0.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +11 -1
- package/dist/lib.js +1 -1
- package/dist/lib.js.map +1 -1
- package/dist/lib.module.js +1 -1
- package/dist/lib.module.js.map +1 -1
- package/dist/lib.web.js +16 -24205
- package/dist/lib.web.js.map +1 -1
- package/dist/modules/microphone.d.ts +0 -1
- package/dist/modules/microphone.d.ts.map +1 -1
- package/package.json +15 -7
package/README.md
CHANGED
|
@@ -18,6 +18,16 @@ yarn add @unith-ai/core-client
|
|
|
18
18
|
pnpm install @unith-ai/core-client
|
|
19
19
|
```
|
|
20
20
|
|
|
21
|
+
### Azure Speech SDK (Optional)
|
|
22
|
+
|
|
23
|
+
If using `microphoneProvider: "azure"`, install the Azure Speech SDK:
|
|
24
|
+
|
|
25
|
+
```shell
|
|
26
|
+
npm install microsoft-cognitiveservices-speech-sdk
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
The SDK is dynamically imported only when the Azure provider is used, so it won't affect bundle size if you use a different provider like `eleven_labs`.
|
|
30
|
+
|
|
21
31
|
## Usage
|
|
22
32
|
|
|
23
33
|
This library is designed for use in plain JavaScript applications or to serve as a foundation for framework-specific implementations. Before integrating it, verify if a dedicated library exists for your particular framework. That said, it's compatible with any project built on JavaScript.
|
|
@@ -135,7 +145,7 @@ conversation.sendMessage("Hello, how are you?");
|
|
|
135
145
|
|
|
136
146
|
#### toggleMicrophone()
|
|
137
147
|
|
|
138
|
-
|
|
148
|
+
Toggles microphone status between ON/OFF.
|
|
139
149
|
|
|
140
150
|
```js
|
|
141
151
|
conversation.toggleMicrophone();
|