deepgram-python-text-intelligence
Use when writing or reviewing Python code in this repo that calls Deepgram Text Intelligence / Read (`/v1/read`) for sentiment, summarization, topic detection,…
npx skills add https://github.com/deepgram/deepgram-python-sdk --skill deepgram-python-text-intelligenceUsing Deepgram Text Intelligence (Python SDK)
Analyze plain text (or a hosted text URL) for sentiment, summarization, topics, and intents via /v1/read.
When to use this product
- You have text already (a transcript, document, chat log, email) and want analytics.
- You want a quick one-shot analysis — REST only, no streaming.
Use a different skill when:
- The source is audio and you want analytics overlays →
deepgram-python-audio-intelligence(same analytics, applied at transcription time).
Authentication
from dotenv import load_dotenv
load_dotenv()
from deepgram import DeepgramClient
client = DeepgramClient()
Header: Authorization: Token <api_key>.
Quick start
response = client.read.v1.text.analyze(
request={"text": "Hello, world! This is a sample text for analysis."},
language="en",
sentiment=True,
summarize=True, # /v1/read is boolean-only (see gotchas)
topics=True,
intents=True,
)
if response.results.sentiments:
print("sentiment avg:", response.results.sentiments.average)
if response.results.summary:
print("summary:", response.results.summary.text)
if response.results.topics:
print("topics:", response.results.topics.segments)
if response.results.intents:
print("intents:", response.results.intents.segments)
Pass request={"text": "..."} for raw text OR request={"url": "https://..."} for a hosted plain-text document.
Async equivalent
from deepgram import AsyncDeepgramClient
client = AsyncDeepgramClient()
response = await client.read.v1.text.analyze(request={"text": "..."}, language="en", sentiment=True)
Key parameters
| Param | Type | Notes |
|---|---|---|
request | {"text": str} or {"url": str} | One of these is required |
language | str | Required for most analytics. English only today. |
sentiment | bool | Per-segment + average sentiment |
summarize | bool | /v1/read accepts boolean only. The SDK type alias TextAnalyzeRequestSummarize = typing.Union[typing.Literal["v2"], typing.Any] is shared with Listen and is broader than what Read actually supports — the analyze method docstring states: "For Read API, accepts boolean only." (Listen's summarize="v2" is a different product — see deepgram-python-audio-intelligence.) |
topics | bool | Topic detection per segment |
intents | bool | Intent recognition per segment |
custom_topic / custom_topic_mode | list[str] / str | User-defined topics |
custom_intent / custom_intent_mode | list[str] / str | User-defined intents |
callback, callback_method, tag | Async callback + metadata |
Response shape (abridged)
response.results.summary.text
response.results.sentiments.segments[]
response.results.sentiments.average
response.results.topics.segments[]
response.results.intents.segments[]
response.metadata
See reference.md → "Read V1 Text" for full shape. Request body model: ReadV1RequestParams.
API reference (layered)
- In-repo reference:
reference.md— "Read V1 Text". - OpenAPI (REST): https://developers.deepgram.com/openapi.yaml
- Context7: library ID
/llmstxt/developers_deepgram_llms_txt. - Product docs:
Gotchas
Tokenauth, notBearer.- English-only for sentiment / summarize / topics / intents today.
summarizeon/v1/readis boolean only. PassTrueorFalse. Do not pass"v2"on/v1/read— that's a Listen-only option (seedeepgram-python-audio-intelligence). The SDK typeUnion[Literal["v2"], Any]is shared with Listen and wider than Read actually accepts; theanalyzedocstring clarifies: "For Read API, accepts boolean only." The generated wire test passingsummarize="v2"against a mock server is a Fern artifact and does not indicate real/v1/readsupport.languageis required for the gated analytics features above.- Body is JSON
request=, not query parameters. Don't confuse with/v1/listenwhich takes audio as the body. - Custom topics/intents need a mode (
custom_topic_mode="extended","strict") or they are ignored.
Example files in this repo
examples/40-text-intelligence.pytests/wire/test_read_v1_text.py
Central product skills
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:
npx skills add deepgram/skills
This SDK ships language-idiomatic code skills; deepgram/skills ships cross-language product knowledge (see api, docs, recipes, examples, starters, setup-mcp).