@unith-ai/core-client 2.0.4-beta.3 → 2.0.4-beta.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 CHANGED
@@ -18,25 +18,15 @@ yarn add @unith-ai/core-client
18
18
  pnpm install @unith-ai/core-client
19
19
  ```
20
20
 
21
- ### Azure Speech SDK (when using `microphoneProvider: "azure"`)
21
+ ### Azure Speech SDK (Optional)
22
22
 
23
- If you plan to use the built-in Azure microphone provider you must provide the Azure Speech SDK at runtime. This library declares the SDK as a peer dependency so your application should install it or include the browser bundle.
24
-
25
- Install locally:
23
+ If using `microphoneProvider: "azure"`, install the Azure Speech SDK:
26
24
 
27
25
  ```shell
28
26
  npm install microsoft-cognitiveservices-speech-sdk
29
- # or
30
- pnpm add microsoft-cognitiveservices-speech-sdk
31
- ```
32
-
33
- Or include the browser bundle via CDN in your HTML before initializing the SDK:
34
-
35
- ```html
36
- <script src="https://aka.ms/csspeech/jsbrowserpackageraw"></script>
37
27
  ```
38
28
 
39
- If the SDK isn't available at runtime the Azure microphone will not initialize and you'll see errors referencing missing `SpeechConfig`.
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`.
40
30
 
41
31
  ## Usage
42
32
 
@@ -155,7 +145,7 @@ conversation.sendMessage("Hello, how are you?");
155
145
 
156
146
  #### toggleMicrophone()
157
147
 
158
- Toogles microphone status between ON/OFF.
148
+ Toggles microphone status between ON/OFF.
159
149
 
160
150
  ```js
161
151
  conversation.toggleMicrophone();