You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .agents/skills/deepgram-js-audio-intelligence/SKILL.md
+25-48Lines changed: 25 additions & 48 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,16 +7,7 @@ description: Use when writing or reviewing JavaScript/TypeScript in this repo th
7
7
8
8
Analytics overlays applied to `/v1/listen`: summaries, topics, intents, sentiment, language detection, diarization, redaction, entities. Same client surface as STT; turn features on with parameters.
9
9
10
-
## When to use this product
11
-
12
-
- You have **audio** and want analytics returned alongside the transcript.
13
-
- REST is the primary path; the WebSocket path supports only a subset of intelligence features.
14
-
15
-
**Use a different skill when:**
16
-
- You just want transcript output → `deepgram-js-speech-to-text`.
17
-
- You already have text and want analytics on that text → `deepgram-js-text-intelligence`.
18
-
- You need Flux turn-taking → `deepgram-js-conversational-stt`.
19
-
- You need a full interactive voice agent → `deepgram-js-voice-agent`.
10
+
**Use a different skill when:** plain transcription → `deepgram-js-speech-to-text`; analytics on text → `deepgram-js-text-intelligence`; Flux turn-taking → `deepgram-js-conversational-stt`; full-duplex agent → `deepgram-js-voice-agent`.
1. **Select features** from the REST vs WSS table. WSS lacks `summarize`, `topics`, `intents`, `sentiment`, `detect_language`.
78
+
2. **Call** `transcribeUrl` / `transcribeFile` with chosen flags and `model:"nova-3"`.
79
+
3. **Validate response**: check `data.results?.summary`, `data.results?.topics?.segments`, `data.results?.sentiments?.segments`. Fields are absent (not errored) when the model/language combo does not support the feature.
80
+
4. **On missing results**: confirm the feature/model/language combination at https://developers.deepgram.com/docs/stt-intelligence-feature-overview, then retry with corrected params.
3. **Context7**: library ID `/llmstxt/developers_deepgram_llms_txt`
93
+
4. **Product docs**: https://developers.deepgram.com/docs/stt-intelligence-feature-overview (links to summarization, topic detection, intent recognition, sentiment, language detection, redaction, diarization).
109
94
110
95
## Gotchas
111
96
112
-
1.**`summarize` on `/v1/listen` is versioned, not plain boolean.** The generated REST surface and examples point at `"v2"`.
113
-
2.**Most intelligence flags are REST-only.** Current WSS connect args do not expose `topics`, `intents`, `sentiment`, `summarize`, or `detect_language`.
114
-
3.**`redact` typing is looser in practice than in the generated alias.** Examples pass arrays like `["pci", "ssn"]`, even though `ListenV1Redact` itself is just a string alias.
115
-
4.**Use `keyterm` for Nova-3 biasing.**`examples/22-transcription-advanced-options.ts` explicitly notes keywords are not supported for Nova-3.
116
-
5.**Model/feature support is product-side.**`nova-3` is the safest choice when mixing many overlays.
117
-
6.**Diarization quality depends on audio quality and duration.** Short or noisy clips churn speakers.
97
+
1. **`summarize` is `"v2"`, not boolean.** The generated REST surface and examples use the string value.
98
+
2. **`redact` accepts arrays** like `["pci", "ssn"]` despite `ListenV1Redact` being a string alias.
99
+
3. **Use `keyterm`, not `keywords`, for Nova-3 biasing.**
100
+
4. **Prefer `nova-3`** when mixing many overlays -- broadest feature support.
For cross-language Deepgram product knowledge — the consolidated API reference, documentation finder, focused runnable recipes, third-party integration examples, and MCP setup — install the central skills:
129
-
130
-
```bash
131
-
npx skills add deepgram/skills
132
-
```
133
-
134
-
This SDK ships language-idiomatic code skills; `deepgram/skills` ships cross-language product knowledge (see `api`, `docs`, `recipes`, `examples`, `starters`, `setup-mcp`).
111
+
For cross-language Deepgram product knowledge, install `npx skills add deepgram/skills`.
@@ -119,24 +115,8 @@ The current JS SDK does **not** expose persisted Voice Agent configuration CRUD
119
115
120
116
## Example files in this repo
121
117
122
-
-`examples/13-management-projects.ts`
123
-
-`examples/14-management-keys.ts`
124
-
-`examples/15-management-members.ts`
125
-
-`examples/16-management-invites.ts`
126
-
-`examples/17-management-usage.ts`
127
-
-`examples/18-management-billing.ts`
128
-
-`examples/19-management-models.ts`
129
-
-`examples/29-management-usage-breakdown.ts`
130
-
-`examples/30-management-billing-detailed.ts`
131
-
-`examples/31-management-member-permissions.ts`
132
-
-`examples/32-management-project-models.ts`
118
+
`examples/13-management-projects.ts` through `examples/19-management-models.ts`, plus `examples/29-32-*` for usage breakdown, billing details, member permissions, and project models.
133
119
134
120
## Central product skills
135
121
136
-
For cross-language Deepgram product knowledge — the consolidated API reference, documentation finder, focused runnable recipes, third-party integration examples, and MCP setup — install the central skills:
137
-
138
-
```bash
139
-
npx skills add deepgram/skills
140
-
```
141
-
142
-
This SDK ships language-idiomatic code skills; `deepgram/skills` ships cross-language product knowledge (see `api`, `docs`, `recipes`, `examples`, `starters`, `setup-mcp`).
122
+
For cross-language Deepgram product knowledge, install `npx skills add deepgram/skills`.
Copy file name to clipboardExpand all lines: .agents/skills/deepgram-js-text-intelligence/SKILL.md
+3-15Lines changed: 3 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,19 +1,13 @@
1
1
---
2
2
name: deepgram-js-text-intelligence
3
-
description: Use when writing or reviewing JavaScript/TypeScript in this repo that calls Deepgram Text Intelligence / Read (`/v1/read`) for sentiment, summarization, topic detection, and intent recognition on text input. Covers `client.read.v1.text.analyze(...)` with `body: { text }` or `body: { url }`. Use `deepgram-js-audio-intelligence` when the source is audio instead of text. Triggers include "read API", "text intelligence", "analyze text", "sentiment", "summarize text", "topics", "intents", and "read.v1".
3
+
description: "Use when writing or reviewing JavaScript/TypeScript in this repo that calls Deepgram Text Intelligence / Read (`/v1/read`) for sentiment, summarization, topic detection, and intent recognition on text input. Covers `client.read.v1.text.analyze(...)` with `body: { text }` or `body: { url }`. Use `deepgram-js-audio-intelligence` when the source is audio instead of text. Triggers: read API, text intelligence, analyze text, sentiment, summarize text, topics, intents, read.v1."
4
4
---
5
5
6
6
# Using Deepgram Text Intelligence (JavaScript / TypeScript SDK)
7
7
8
8
Analyze text or a hosted text URL for sentiment, summarization, topics, and intents via `/v1/read`.
9
9
10
-
## When to use this product
11
-
12
-
- You already have **text** (transcript, document, email, chat log) and want analytics.
13
-
- You want a single REST call; there is no streaming Read API in this SDK.
14
-
15
-
**Use a different skill when:**
16
-
- Your source is audio and you want the analytics applied during transcription → `deepgram-js-audio-intelligence`.
10
+
**Use a different skill when:** source is audio → `deepgram-js-audio-intelligence`. This API is REST-only; there is no streaming Read API in this SDK.
17
11
18
12
## Authentication
19
13
@@ -85,10 +79,4 @@ For broader coverage, `examples/28-text-intelligence-advanced.ts` also demonstra
85
79
86
80
## Central product skills
87
81
88
-
For cross-language Deepgram product knowledge — the consolidated API reference, documentation finder, focused runnable recipes, third-party integration examples, and MCP setup — install the central skills:
89
-
90
-
```bash
91
-
npx skills add deepgram/skills
92
-
```
93
-
94
-
This SDK ships language-idiomatic code skills; `deepgram/skills` ships cross-language product knowledge (see `api`, `docs`, `recipes`, `examples`, `starters`, `setup-mcp`).
82
+
For cross-language Deepgram product knowledge, install `npx skills add deepgram/skills`.
Copy file name to clipboardExpand all lines: .agents/skills/deepgram-js-text-to-speech/SKILL.md
+5-13Lines changed: 5 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,13 +7,9 @@ description: Use when writing or reviewing JavaScript/TypeScript in this repo th
7
7
8
8
Convert text to audio with one-shot REST generation or low-latency streaming synthesis via `/v1/speak`.
9
9
10
-
## When to use this product
10
+
Two modes: **REST** (`client.speak.v1.audio.generate`) for one-shot synthesis, **WebSocket** (`client.speak.v1.createConnection()`) for low-latency streaming.
11
11
12
-
-**REST (`client.speak.v1.audio.generate`)** — render finished text into an audio response. Best for downloadable files, pre-generated prompts, batch synthesis.
13
-
-**WebSocket (`client.speak.v1.createConnection()` / `connect()`)** — stream text in and receive audio out with lower latency. Best when an LLM is still producing tokens.
14
-
15
-
**Use a different skill when:**
16
-
- You need the agent to also listen, think, and handle barge-in → `deepgram-js-voice-agent`.
12
+
**Use a different skill when:** full-duplex agent with STT + LLM + TTS → `deepgram-js-voice-agent`.
**Error handling:** Listen for `Warning` events in the message handler. If the connection drops, create a new connection and re-register handlers; the SDK does not auto-reconnect.
@@ -111,10 +109,4 @@ Unlike the Python SDK, this repo does **not** include a hand-written `TextBuilde
111
109
112
110
## Central product skills
113
111
114
-
For cross-language Deepgram product knowledge — the consolidated API reference, documentation finder, focused runnable recipes, third-party integration examples, and MCP setup — install the central skills:
115
-
116
-
```bash
117
-
npx skills add deepgram/skills
118
-
```
119
-
120
-
This SDK ships language-idiomatic code skills; `deepgram/skills` ships cross-language product knowledge (see `api`, `docs`, `recipes`, `examples`, `starters`, `setup-mcp`).
112
+
For cross-language Deepgram product knowledge, install `npx skills add deepgram/skills`.
Copy file name to clipboardExpand all lines: .agents/skills/deepgram-js-voice-agent/SKILL.md
+13-17Lines changed: 13 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,16 +7,7 @@ description: Use when writing or reviewing JavaScript/TypeScript in this repo th
7
7
8
8
Full-duplex voice agent runtime over `wss://agent.deepgram.com/v1/agent/converse`: audio in, LLM orchestration, audio out, plus function calling and prompt/runtime updates.
9
9
10
-
## When to use this product
11
-
12
-
- You want an **interactive voice assistant** where the user speaks, the agent thinks, and the agent responds with speech.
13
-
- You need **function / tool calling** inside the conversation loop.
14
-
- You want Deepgram to host the STT + think + TTS orchestration.
15
-
16
-
**Use a different skill when:**
17
-
- You only need transcription → `deepgram-js-speech-to-text` or `deepgram-js-conversational-stt`.
18
-
- You only need synthesis → `deepgram-js-text-to-speech`.
19
-
- You want project keys, usage, models, or other admin APIs → `deepgram-js-management-api`.
10
+
**Use a different skill when:** transcription only → `deepgram-js-speech-to-text` or `deepgram-js-conversational-stt`; synthesis only → `deepgram-js-text-to-speech`; admin APIs → `deepgram-js-management-api`.
@@ -114,10 +116,4 @@ This SDK exposes the **live agent runtime** plus `settings.think.models.list()`,
114
116
115
117
## Central product skills
116
118
117
-
For cross-language Deepgram product knowledge — the consolidated API reference, documentation finder, focused runnable recipes, third-party integration examples, and MCP setup — install the central skills:
118
-
119
-
```bash
120
-
npx skills add deepgram/skills
121
-
```
122
-
123
-
This SDK ships language-idiomatic code skills; `deepgram/skills` ships cross-language product knowledge (see `api`, `docs`, `recipes`, `examples`, `starters`, `setup-mcp`).
119
+
For cross-language Deepgram product knowledge, install `npx skills add deepgram/skills`.
0 commit comments