Skip to content

docs(asr): label transcribe-stream-1 as Preview - #276

Merged
liujiahua123123 merged 4 commits into
mainfrom
docs/transcribe-stream-1-preview
Oct 20, 2026
Merged

liujiahua123123 merged 4 commits into
mainfrom
docs/transcribe-stream-1-preview

Conversation

@liujiahua123123

@liujiahua123123 liujiahua123123 commented Oct 20, 2026 •

Copy link
Copy Markdown
Contributor

Summary

Labels transcribe-stream-1 as Preview everywhere the docs present it. This was requested by NaturalHG. It follows the patterns the repo already uses for previews and betas (Drama 3 preview, the migration guide's Beta tag).

  • Sidebar. The 4 realtime pages get tag: "Preview" in their frontmatter: the guide, the WebSocket reference and the two cookbooks.
  • Page note. Each of those pages gets one <Note>: "transcribe-stream-1 is in preview." It does not mention pricing.
  • Model mentions. Places that name the model get a "(Preview)" suffix, the same way "(recommended)" is used:
    • the models overview row;
    • the pricing row, which now reads transcribe-stream-1 (Realtime ASR, Preview); prices are unchanged;
    • the capabilities sentence;
    • the Realtime vs File table and the model header row in the reference;
    • the AsyncAPI model header description (the enum and default are unchanged);
    • the five realtime entries in llms.txt.

Note for reviewers: #270 launched the model framed as GA ("No longer preview") and removed the earlier preview notes. This PR brings the Preview label back, at product's request. Please confirm the intended status with the #270 author before merging. Gating behaviour is unchanged.

Checks:

  • prettier passes on the files that were clean before. Three files already failed prettier --check on main, and this PR adds no new drift to them.
  • All changed MDX compiles, and @asyncapi/parser reports 0 errors and 0 warnings.
  • No Chinese characters and no internal names.
  • mint broken-links hung offline on the authoring machine, so it was not run there. CI or Mintlify validation covers it.

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Realtime speech-to-text, WebSocket, voice-agent, and model documentation now identifies transcribe-stream-1 as a Preview model.
    • The realtime speech-to-text API and related guides are now marked Preview.
    • Clarified that transcribe-stream-1 is the only available realtime model.
    • Pricing and billing amounts, capabilities, limits, defaults, and legacy alias behavior remain unchanged.

liujiahua123123 and others added 2 commits October 20, 2026 08:15
Mark the realtime speech-to-text model with a "Preview" label wherever it
is presented, following the Drama 3 preview pattern (tag: "Preview" page
frontmatter plus a short Note) and the existing "(recommended)" suffix in
model tables:

- sidebar tag on the realtime guide, the WebSocket reference and the two
  realtime cookbooks, each with a preview Note near the top
- "(Preview)" next to the model in the models overview, the ASR pricing
  table, the capabilities page and the AsyncAPI model header description
- "Preview" in the five realtime llms.txt entries

No renames, price or behavior changes.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…view

The first pass labeled the model header description in the AsyncAPI
spec but left two other descriptions of the same header unlabeled, and
left the model row of the realtime guide's comparison table bare while
the models overview table carries the label. Label them the same way,
as "`transcribe-stream-1` (Preview)":

- AsyncAPI channel description, Connection Headers bullet
- WebSocket reference page, model header table row
- realtime guide, Realtime vs File table, Model row

Column widths are unchanged, so no other rows move.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@mintlify

mintlify Bot commented Oct 20, 2026 •

Copy link
Copy Markdown

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
hanabiaiinc 🟢 Ready View Preview Oct 20, 2026, 10:43 AM

💡 Tip: Enable Automations to automatically generate PRs for you.

@coderabbitai

coderabbitai Bot commented Oct 20, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration
  • Configuration used: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 4ace6cbe-b745-44c2-84d5-88ad38588b98
📥 Commits

Reviewing files that changed from the base of the PR and between eaac907 and 4cf4ede.

📒 Files selected for processing: 4
  • api-reference/endpoint/websocket/asr-realtime.mdx
  • developer-guide/sdk-guide/cookbook/realtime-transcription.mdx
  • developer-guide/sdk-guide/cookbook/realtime-voice-agent.mdx
  • features/speech-to-text/realtime.mdx
🚧 Files skipped from review as they are similar to previous changes: 4
  • developer-guide/sdk-guide/cookbook/realtime-transcription.mdx
  • developer-guide/sdk-guide/cookbook/realtime-voice-agent.mdx
  • api-reference/endpoint/websocket/asr-realtime.mdx
  • features/speech-to-text/realtime.mdx

Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.

📝 Walkthrough

Documentation now marks transcribe-stream-1 as Preview across realtime speech-to-text API references, product pages, pricing information, cookbooks, and the documentation index. Existing capabilities, limits, aliases, and prices remain unchanged.

Changes: Realtime ASR Preview

Layer / File(s) Summary
Document the API model status
api-reference/asyncapi-asr-realtime.yml, api-reference/endpoint/websocket/asr-realtime.mdx
The AsyncAPI specification and WebSocket endpoint identify transcribe-stream-1 as Preview. The endpoint retains its default, sole-model, and legacy-alias details.
Update product model references
developer-guide/models-pricing/models-overview.mdx, developer-guide/models-pricing/pricing-and-rate-limits.mdx, features/speech-to-text/realtime.mdx, overview/capabilities.mdx
Model, pricing, capability, and realtime speech-to-text pages label transcribe-stream-1 as Preview. Documented capabilities, limits, and prices remain unchanged.
Update guides and documentation index
developer-guide/sdk-guide/cookbook/realtime-transcription.mdx, developer-guide/sdk-guide/cookbook/realtime-voice-agent.mdx, llms.txt
The cookbooks and documentation index identify transcribe-stream-1 as Preview.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~5 minutes

Change: Other

Suggested reviewers: kilerd

Merge Risk: ⚪ Minimal · up to 4cf4e

No concrete merge-blocking defect is established. Confirm the intended model status with the author of #270 before merging.

Pre-merge checks: Passed 5
Check name Status Explanation
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check Passed The title clearly and concisely describes the main change: labeling the transcribe-stream-1 ASR model as Preview throughout the documentation.
Docstring Coverage Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Full details: Docstring Coverage

Explanation

No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (4 skipped: 4 unsupported.)

✨ Finishing Touches: 💡 1
🛠️ Fix failing CI checks: 💡
  • Commit to this branch
  • Create a new PR
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@liujiahua123123
liujiahua123123 merged commit 2a2375a into main Oct 20, 2026
5 of 6 checks passed
@liujiahua123123
liujiahua123123 deleted the docs/transcribe-stream-1-preview branch October 20, 2026 18:14

This branch was successfully deployed

1 active deployment
staging — 4cf4edeb Deployed Oct 20, 2026 by mintlify[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant