docs(pulse-stt): rename SDK response field transcription → text

[abhishekmishragithub]

Summary

• SDK-only rename of the Pulse STT 200 response field via Fern's x-fern-property-name. Wire format is unchanged — server keeps emitting transcription, only generated SDKs expose .text.
• Aligns with the OpenAI Whisper convention and the Vercel AI SDK's experimental_transcribe shape ({ text, segments, durationInSeconds }).
• Two doc samples that demonstrate the smallestai Python SDK updated; raw HTTP samples kept as-is since they read the wire format.

Why now (closes task #39 + #40 docs-side)

• PRs chore(docs): chuck legacy lightning-asr WebSocket reference #110, chore(docs): chuck legacy Lightning STT + lightning-large TTS orphans #112, chore(docs): mark Lightning v2 as deprecated across docs #113 (legacy lightning-asr/lightning-large/lightning-v2 chucks) all merged on May 4 — the gating condition for the SDK clean-cut is now satisfied.
• A previous attempt at this rename (598a6f1, May 3) was reverted minutes later because the legacy chucks hadn't merged yet. That gate is now cleared.
• Vercel SDK is hand-written and not affected. Python + JS/TS SDKs are auto-generated from Fern; this rename flows through both on the next regenerate.

Scope (kept tight)

• Spec override: fern/apis/waves/openapi/pulse-stt-openapi-overrides.yaml — adds x-fern-property-name: text on transcription.
• v4 docs render override: unchanged — API reference still shows transcription in the response (matches HTTP wire reality, verified on preview).
• Doc samples updated (Pulse SDK callers only):
  • speech-to-text/benchmarks/evaluation-walkthrough.mdx (+ versions/ mirror) — response.text
  • speech-to-text/pre-recorded/code-examples.mdx (+ versions/ mirror) — response.get('text', ...)
• Doc samples kept (raw HTTP / wire format): every requests.post(...).json()["transcription"] and data.transcription after fetch() stays as-is.
• Changelog: 2026-05-07-pulse-stt-sdk-text-rename.mdx flagging the BREAKING SDK change.

Verification

• fern check — 0 errors
• python3 scripts/spec-live-tests/spec_drift_check.py — 0 drift
• python3 scripts/spec-live-tests/v4_mirror_check.py — pages/ ↔ versions/ in sync
• Live API: server keeps emitting transcription over HTTP (wire format preserved)
• Preview render verified — REST API ref shows wire transcription (24 mentions); SDK sample pages show response.text; the <Note> warning callers about the SDK transition still renders.

Handoff for SDK release (#40)

After merge, the SDK team can regenerate Python + JS/TS SDKs:

• result.transcription → result.text (this PR)
• legacy method names (asr_*, lightning_large_*, lightning_v2_*) drop out naturally because the underlying spec was deleted in chore(docs): chuck legacy lightning-asr WebSocket reference #110/chore(docs): chuck legacy Lightning STT + lightning-large TTS orphans #112/chore(docs): mark Lightning v2 as deprecated across docs #113
• bump major version (semver-breaking)
• release notes can link the changelog entry: 2026-05-07-pulse-stt-sdk-text-rename.mdx

Vercel SDK is unaffected.

[github-actions]

🌿 Preview your docs: https://smallest-ai-preview-9ad1740e-8eb6-4491-842a-0c9ef6e90a4c.docs.buildwithfern.com

[entelligence-ai-pr-reviews]

EntelligenceAI PR Summary

Renames the Pulse STT SDK response accessor from transcription to text to align with Vercel AI SDK and OpenAI Whisper conventions; REST wire format is unaffected.

• Added Fern OpenAPI override in pulse-stt-openapi-overrides.yaml to remap wire field transcription → SDK property text
• Added changelog entry (2026-05-07-pulse-stt-sdk-text-rename.mdx) documenting the breaking SDK change with Python and JS/TS migration examples
• Updated evaluation-walkthrough.mdx (both pages/ and versions/ paths) to replace response.transcription and "transcription" key with response.text / "text" in three locations each
• Updated code-examples.mdx (both pages/ and versions/ paths) to change process_results response key from 'transcription' to 'text'

---

Confidence Score: 5/5 - Safe to Merge

Safe to merge — this PR is a documentation and SDK configuration change that renames the Pulse STT response accessor from transcription to text via a Fern OpenAPI override in pulse-stt-openapi-overrides.yaml, with no changes to the REST wire format. The changelog entry in 2026-05-07-pulse-stt-sdk-text-rename.mdx appropriately documents this as a breaking SDK change with concrete Python and JS/TS migration examples, and the evaluation walkthrough in evaluation-walkthrough.mdx is updated consistently across both pages/ paths. No review comments were generated and no logic, runtime, or security concerns are present in this purely documentation/config PR.

Key Findings:

• The Fern OpenAPI override in pulse-stt-openapi-overrides.yaml remaps only the SDK property name, explicitly leaving the REST wire field transcription untouched, which means no backend or API contract is broken.
• The changelog entry correctly characterizes this as a breaking change and provides side-by-side before/after migration examples for both Python and JS/TS consumers, reducing friction for adopters.
• Zero review comments were generated across any of the changed files, and no pre-existing unresolved concerns exist that touch this PR's scope.
• Coverage of 2/6 changed files is the only minor gap, but the unreviewed files are documentation pages whose content change (renaming transcription to text) is straightforward and consistent with the stated intent.

Files requiring special attention

• pulse-stt-openapi-overrides.yaml
• 2026-05-07-pulse-stt-sdk-text-rename.mdx