Skip to content

Docs improvements: streaming termination, translation structure, LeMUR deprecation#733

Open
devin-ai-integration[bot] wants to merge 1 commit intomainfrom
devin/1773040364-docs-improvements
Open

Docs improvements: streaming termination, translation structure, LeMUR deprecation#733
devin-ai-integration[bot] wants to merge 1 commit intomainfrom
devin/1773040364-docs-improvements

Conversation

@devin-ai-integration
Copy link
Contributor

@devin-ai-integration devin-ai-integration bot commented Mar 9, 2026

Docs: streaming termination, translation structure, LeMUR deprecation

Summary

Three documentation improvements based on customer-reported issues:

1. Streaming session termination (Universal-3 Pro)

  • Added a new Session termination section to the Universal-3 Pro Streaming page with explicit SDK and WebSocket examples for properly closing sessions.
  • Improved the termination section in the U3 Pro Message Sequence page to show the client-side Terminate message and warn about zombie sessions.
  • Key message: sessions left open without explicit termination auto-close after 3 hours (code 3008) and continue accruing charges.

2. Speech Understanding translation request structure

  • Added a <Note> in the Translation page Quickstart clarifying that translation parameters must be nested under speech_understanding.request.translation (not placed at root level).
  • Clarified in the Output format section that translated text appears in translated_texts.<lang_code>, not the main text field.

3. LeMUR deprecation notices

  • Added prominent <Warning> banners to three LeMUR pages (customize-parameters.mdx, examples.mdx, summarize-audio.mdx) with the March 31, 2026 deprecation date and pointers to LLM Gateway and the migration guide.
  • Marked the "Summary with specialized endpoint" section as deprecated in summarize-audio.mdx.

Review & Testing Checklist for Human

  • Verify streaming termination claims: Confirm that (a) sessions without explicit Terminate truly stay open for 3 hours, and (b) closing the WebSocket without Terminate does not guarantee immediate session end. These claims match common-errors.mdx (code 3008) but should be validated by someone with backend knowledge.
  • Check "SDK support is not yet available" for LLM Gateway: The deprecation banners state this — verify this is still accurate.
  • Decide if additional LeMUR pages need deprecation banners: ask-questions.mdx and improving-your-prompt.mdx were not given banners since they already reference LLM Gateway, but they still contain LeMUR SDK code examples. Reviewer should decide if they need banners too.
  • Render the docs locally (fern docs dev) or check the preview deployment to verify the Warning/Note components render correctly and the new "Session termination" section appears in the right place in the page hierarchy.

Notes


Open with Devin

…recation

1. Clarify streaming session termination patterns in Universal-3 Pro docs
2. Clarify nested JSON structure for Speech Understanding translation requests
3. Add prominent deprecation notices for LeMUR with migration pointers to LLM Gateway

Co-Authored-By: dylan.duan <dylan.duan@assemblyai.com>
@devin-ai-integration
Copy link
Contributor Author

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment and CI monitoring

@github-actions
Copy link

github-actions bot commented Mar 9, 2026

Copy link
Contributor Author

@devin-ai-integration devin-ai-integration bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✅ Devin Review: No Issues Found

Devin Review analyzed this PR and found no potential bugs to report.

View in Devin Review to see 2 additional findings.

Open in Devin Review

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