@deepgram/sdk 5.0.0-alpha.1 → 5.0.0-alpha.3
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 +44 -1
- package/dist/browser/index.global.js +8821 -0
- package/dist/cjs/BaseClient.js +3 -0
- package/dist/cjs/CustomClient.d.ts +9 -1
- package/dist/cjs/CustomClient.js +232 -21
- package/dist/cjs/api/resources/agent/resources/v1/types/AgentV1Settings.d.ts +3 -43
- package/dist/cjs/api/resources/agent/resources/v1/types/AgentV1SettingsAgentListenProvider.d.ts +26 -0
- package/dist/cjs/api/resources/agent/resources/v1/types/AgentV1SettingsAgentListenProvider.js +3 -0
- package/dist/cjs/api/resources/agent/resources/v1/types/AgentV1SettingsAgentSpeakEndpointProvider.d.ts +28 -13
- package/dist/cjs/api/resources/agent/resources/v1/types/AgentV1SettingsAgentSpeakEndpointProvider.js +19 -17
- package/dist/cjs/api/resources/agent/resources/v1/types/AgentV1SettingsAgentSpeakOneItemProvider.d.ts +28 -13
- package/dist/cjs/api/resources/agent/resources/v1/types/AgentV1SettingsAgentSpeakOneItemProvider.js +19 -17
- package/dist/cjs/api/resources/agent/resources/v1/types/AgentV1SettingsAgentThinkProvider.d.ts +115 -0
- package/dist/cjs/api/resources/agent/resources/v1/types/AgentV1SettingsAgentThinkProvider.js +57 -0
- package/dist/cjs/api/resources/agent/resources/v1/types/AgentV1UpdateSpeakSpeakProvider.d.ts +18 -3
- package/dist/cjs/api/resources/agent/resources/v1/types/AgentV1UpdateSpeakSpeakProvider.js +2 -0
- package/dist/cjs/api/resources/agent/resources/v1/types/index.d.ts +2 -0
- package/dist/cjs/api/resources/agent/resources/v1/types/index.js +2 -0
- package/dist/cjs/api/resources/listen/resources/v1/types/ListenV1Results.d.ts +3 -3
- package/dist/cjs/api/types/SpeakV1SampleRate.d.ts +1 -1
- package/dist/cjs/api/types/SpeakV1SampleRate.js +1 -1
- package/dist/cjs/core/websocket/ws.d.ts +0 -1
- package/dist/cjs/core/websocket/ws.js +9 -47
- package/dist/cjs/version.d.ts +1 -0
- package/dist/cjs/version.js +4 -0
- package/dist/esm/BaseClient.mjs +3 -0
- package/dist/esm/CustomClient.d.mts +9 -1
- package/dist/esm/CustomClient.mjs +232 -21
- package/dist/esm/api/resources/agent/resources/v1/types/AgentV1Settings.d.mts +3 -43
- package/dist/esm/api/resources/agent/resources/v1/types/AgentV1SettingsAgentListenProvider.d.mts +26 -0
- package/dist/esm/api/resources/agent/resources/v1/types/AgentV1SettingsAgentListenProvider.mjs +2 -0
- package/dist/esm/api/resources/agent/resources/v1/types/AgentV1SettingsAgentSpeakEndpointProvider.d.mts +28 -13
- package/dist/esm/api/resources/agent/resources/v1/types/AgentV1SettingsAgentSpeakEndpointProvider.mjs +19 -17
- package/dist/esm/api/resources/agent/resources/v1/types/AgentV1SettingsAgentSpeakOneItemProvider.d.mts +28 -13
- package/dist/esm/api/resources/agent/resources/v1/types/AgentV1SettingsAgentSpeakOneItemProvider.mjs +19 -17
- package/dist/esm/api/resources/agent/resources/v1/types/AgentV1SettingsAgentThinkProvider.d.mts +115 -0
- package/dist/esm/api/resources/agent/resources/v1/types/AgentV1SettingsAgentThinkProvider.mjs +54 -0
- package/dist/esm/api/resources/agent/resources/v1/types/AgentV1UpdateSpeakSpeakProvider.d.mts +18 -3
- package/dist/esm/api/resources/agent/resources/v1/types/AgentV1UpdateSpeakSpeakProvider.mjs +2 -0
- package/dist/esm/api/resources/agent/resources/v1/types/index.d.mts +2 -0
- package/dist/esm/api/resources/agent/resources/v1/types/index.mjs +2 -0
- package/dist/esm/api/resources/listen/resources/v1/types/ListenV1Results.d.mts +3 -3
- package/dist/esm/api/types/SpeakV1SampleRate.d.mts +1 -1
- package/dist/esm/api/types/SpeakV1SampleRate.mjs +1 -1
- package/dist/esm/core/websocket/ws.d.mts +0 -1
- package/dist/esm/core/websocket/ws.mjs +9 -47
- package/dist/esm/version.d.mts +1 -0
- package/dist/esm/version.mjs +1 -0
- package/package.json +1 -28
package/README.md
CHANGED
|
@@ -283,7 +283,50 @@ The SDK works in modern browsers with some considerations:
|
|
|
283
283
|
</script>
|
|
284
284
|
```
|
|
285
285
|
|
|
286
|
-
#### Option 3:
|
|
286
|
+
#### Option 3: NPM Package (Browser Bundle)
|
|
287
|
+
|
|
288
|
+
After installing via `npm install @deepgram/sdk`, you can use the browser bundle:
|
|
289
|
+
|
|
290
|
+
**Method A: Copy the bundle to your public directory**
|
|
291
|
+
|
|
292
|
+
```bash
|
|
293
|
+
# Copy the browser bundle to your static assets folder
|
|
294
|
+
cp node_modules/@deepgram/sdk/dist/browser/index.global.js public/deepgram.js
|
|
295
|
+
```
|
|
296
|
+
|
|
297
|
+
Then include it in your HTML:
|
|
298
|
+
|
|
299
|
+
```html
|
|
300
|
+
<script src="/deepgram.js"></script>
|
|
301
|
+
<script>
|
|
302
|
+
const { DeepgramClient } = Deepgram;
|
|
303
|
+
const deepgramClient = new DeepgramClient({ apiKey: "YOUR_API_KEY" });
|
|
304
|
+
</script>
|
|
305
|
+
```
|
|
306
|
+
|
|
307
|
+
**Method B: Reference directly from node_modules (development only)**
|
|
308
|
+
|
|
309
|
+
If your dev server serves files from `node_modules`, you can reference it directly:
|
|
310
|
+
|
|
311
|
+
```html
|
|
312
|
+
<script src="/node_modules/@deepgram/sdk/dist/browser/index.global.js"></script>
|
|
313
|
+
<script>
|
|
314
|
+
const { DeepgramClient } = Deepgram;
|
|
315
|
+
const deepgramClient = new DeepgramClient({ apiKey: "YOUR_API_KEY" });
|
|
316
|
+
</script>
|
|
317
|
+
```
|
|
318
|
+
|
|
319
|
+
**Method C: Use a bundler (Webpack, Vite, etc.)**
|
|
320
|
+
|
|
321
|
+
Import the SDK in your JavaScript/TypeScript code and let your bundler handle it:
|
|
322
|
+
|
|
323
|
+
```js
|
|
324
|
+
import { DeepgramClient } from "@deepgram/sdk";
|
|
325
|
+
|
|
326
|
+
const deepgramClient = new DeepgramClient({ apiKey: "YOUR_API_KEY" });
|
|
327
|
+
```
|
|
328
|
+
|
|
329
|
+
#### Option 4: Proxy for REST APIs
|
|
287
330
|
|
|
288
331
|
See [proxy requests in the browser](#proxy-requests-in-the-browser) for REST API access.
|
|
289
332
|
|