docs: update U3-Pro streaming docs for release#688
Closed
devin-ai-integration[bot] wants to merge 8 commits intomainfrom
Closed
docs: update U3-Pro streaming docs for release#688devin-ai-integration[bot] wants to merge 8 commits intomainfrom
devin-ai-integration[bot] wants to merge 8 commits intomainfrom
Conversation
- Mark prompting for streaming as beta in prompting guide and U3-Pro guide - Rename min_end_of_turn_silence_when_confident to min_turn_silence across all docs and API specs - Add min_turn_silence and max_turn_silence to 'Already using AssemblyAI streaming?' tip - Bold and enhance 'native multilingual code switching' callout - Add 'How keyterms prompting works behind the scenes' section to streaming docs Co-Authored-By: Zackary Klebanoff <zklebanoff@assemblyai.com>
Contributor
Author
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
…ecat-u3pro parameter docs Co-Authored-By: Zackary Klebanoff <zklebanoff@assemblyai.com>
Co-Authored-By: Zackary Klebanoff <zklebanoff@assemblyai.com>
Co-Authored-By: Zackary Klebanoff <zklebanoff@assemblyai.com>
Co-Authored-By: Zackary Klebanoff <zklebanoff@assemblyai.com>
Co-Authored-By: Zackary Klebanoff <zklebanoff@assemblyai.com>
…uides and best practices Co-Authored-By: Zackary Klebanoff <zklebanoff@assemblyai.com>
…ro docs, hide legacy pages Co-Authored-By: Zackary Klebanoff <zklebanoff@assemblyai.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
docs: update U3-Pro streaming docs for release
Summary
Documentation updates ahead of the Universal-3 Pro streaming model release, covering eight changes:
<Warning title="Prompting: Beta">to the streaming prompting guide and U3-Pro streaming guide.min_end_of_turn_silence_when_confident→min_turn_silenceacross all docs, API specs, cookbooks, and integration guides (~23 files). Bothsnake_caseandcamelCase(minEndOfTurnSilenceWhenConfident→minTurnSilence) variants updated.min_turn_silenceandmax_turn_silencewhen switching to U3-Pro.<Warning title="Universal-3-Pro: Public beta">block fromuniversal-3-pro.mdx(streaming) andprompting-guide.mdx, and removed "Currently in public beta." from the getting-started card ingetting-started/universal-3-pro.mdx./docs/streaming/voice-agents, replaced the Livekit and Pipecat page entries with links pointing to the corresponding U3-Pro docs (/docs/voice-agents/u3pro-livekitand/docs/voice-agents/u3pro-pipecat). Legacy Livekit, Pipecat, and Vapi pages are now hidden but remain accessible via direct URL.Updates since last revision
fern/docs.yml) — In the/docs/streaming/voice-agentssection, Livekit and Pipecat are nowlinkentries pointing to the U3-Pro guides instead ofpageentries. The legacy pages (livekit.mdx,pipecat.mdx,vapi.mdx) are markedhidden: true.Review & Testing Checklist for Human
usm-streaming.yml,streamingApi.yml,__package__.yml,usm-streaming-overrides.yml) — Confirm the backend actually acceptsmin_turn_silenceas the new parameter name. These are breaking spec changes.__package__.yml(e.g.,JsonSchemaConfigtype) and large auto-generated changes inassemblyai.ymlthat appear unrelated to this PR. Verify these are expected and not accidentally pulled in by tooling./docs/voice-agents/u3pro-livekit,/docs/voice-agents/u3pro-pipecat) resolve correctly from the streaming voice-agents section. These link across nav sections.livekit-intro-guide,pipecat-intro-guide,vapi,voice-agent-best-practices, legacylivekit.mdx,pipecat.mdx) remain accessible via direct URL for existing bookmarks.min_turn_silence=100andmax_turn_silence=1200are correct starting-point recommendations for U3-Pro.grep -r "min_end_of_turn_silence_when_confident\|minEndOfTurnSilenceWhenConfident"across the repo to verify all occurrences were renamed.Test Plan: Preview the docs locally with
fern docs devand manually check:u3pro-livekitandu3pro-pipecatas first two items. Hidden pages not visible but accessible via direct URL.Notes
fern-check✅,run✅,lint(merge commit) ✅,lint(branch) ❌ pre-existing issue (JSX comments, not required)