Skip to content

Update code switching prompts and reorganize U3Pro docs#756

Open
devin-ai-integration[bot] wants to merge 5 commits intomainfrom
devin/1773327112-update-code-switching-prompt
Open

Update code switching prompts and reorganize U3Pro docs#756
devin-ai-integration[bot] wants to merge 5 commits intomainfrom
devin/1773327112-update-code-switching-prompt

Conversation

@devin-ai-integration
Copy link
Contributor

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

Update code switching prompts and reorganize U3Pro docs

Summary

Changes across two files to standardize the code-switching/verbatim prompt and improve section ordering.

prompt-engineering.mdx (Prompting Guide)

  1. Renamed recommended prompt section: "Verbatim with multilingual support" → "Verbatim with code-switching/multilingual support"

  2. Added full prompt to section 1 (Verbatim transcription and disfluencies): Added the full verbatim + code-switching prompt as the top example prompt in this section.

  3. Updated section 9 (Native code switching): Replaced the two existing example prompts with the single full prompt.

universal-3-pro.mdx (Async U3Pro page)

  1. Reorganized section order under Prompting. New order:

    • Default prompt
    • Verbatim transcription and disfluencies (was 2nd → stays 2nd)
    • Native code switching (moved up from last position)
    • Handling unclear audio with [masked] (moved down from 1st)
    • Audio event tags, Labeling crosstalk, Speaker attribution, Output style and formatting, Numbers and measurements, Context aware clues, Entity accuracy and spelling
  2. Updated all code examples in both "Verbatim transcription and disfluencies" and "Native code switching" sections to use the full prompt.

  3. Added full prompt as top example in both sections' "Example prompts" blocks.

All updated sections now consistently use:

Required: Preserve the original language(s) and script as spoken,
including code-switching and mixed-language phrases.

Mandatory: Preserve linguistic speech patterns including disfluencies,
filler words, hesitations, repetitions, stutters, false starts, and
colloquialisms in the spoken language.

Always: Transcribe speech with your best guess based on context in all
possible scenarios where speech is present in the audio.

Review & Testing Checklist for Human

  • Verify no content was lost during reorganization: The "Native code switching" section (with audio player, before/after examples, 4 code tabs, example prompts, and Note) should appear in full after "Verbatim transcription and disfluencies" in universal-3-pro.mdx. The "Handling unclear audio with [masked]" section (with Tip, prompt, Note, and explanation paragraph) should appear in full after "Native code switching".
  • Preview both pages using the latest preview URL from PR comments — verify section ordering and rendering on the async U3Pro page and the prompting guide page
  • Check prompt text in code examples: The inline prompt strings in all 8 code tabs (4 for verbatim, 4 for code switching) should match the intended prompt. Note: code examples use a single-line version without newlines.
  • Verify the full prompt wording matches exactly across all locations (recommended prompts heading area in prompt-engineering.mdx, section 1 examples, section 9 examples, and both sections in universal-3-pro.mdx)
  • Minor formatting: A blank line before ### Default prompt was removed in universal-3-pro.mdx — confirm this doesn't affect rendering

Notes

Co-Authored-By: Zackary Klebanoff <zklebanoff@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

Co-Authored-By: Zackary Klebanoff <zklebanoff@assemblyai.com>
@devin-ai-integration devin-ai-integration bot changed the title Update code switching prompt in async prompting guide Update code switching prompts in async prompting guide Mar 12, 2026
@github-actions
Copy link

… section

Co-Authored-By: Zackary Klebanoff <zklebanoff@assemblyai.com>
@github-actions
Copy link

…example in section 1

Co-Authored-By: Zackary Klebanoff <zklebanoff@assemblyai.com>
@github-actions
Copy link

Co-Authored-By: Zackary Klebanoff <zklebanoff@assemblyai.com>
@devin-ai-integration devin-ai-integration bot changed the title Update code switching prompts in async prompting guide Update code switching prompts and reorganize U3Pro docs Mar 12, 2026
@github-actions
Copy link

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