Skip to content

docs: add warning that speaker_options apply per-channel with multichannel transcription#781

Open
devin-ai-integration[bot] wants to merge 1 commit intomainfrom
devin/1773800807-multichannel-speaker-options-warning
Open

docs: add warning that speaker_options apply per-channel with multichannel transcription#781
devin-ai-integration[bot] wants to merge 1 commit intomainfrom
devin/1773800807-multichannel-speaker-options-warning

Conversation

@devin-ai-integration
Copy link
Contributor

Summary

Adds <Warning> callouts to both the Multichannel Transcription and Speaker Diarization docs pages noting that speaker_options (min_speakers_expected / max_speakers_expected) are applied per channel, not globally, when multichannel: true and speaker_labels: true are used together.

This was flagged internally as a major customer gotcha — e.g. setting min=5, max=7 on a 5-channel file results in 25–35 total speakers, not 5–7.

Files changed:

  • fern/pages/speech-to-text/pre-recorded-audio/multichannel-transcription.mdx — warning added in the "Per-channel diarization" section
  • fern/pages/speech-to-text/pre-recorded-audio/speaker-diarization.mdx — warning added in the "Set a range of possible speakers" section

Review & Testing Checklist for Human

  • Verify the described behavior is accurate — confirm that speaker_options are indeed applied per-channel (not globally) when multichannel is enabled. This claim comes from an internal investigation but should be validated by someone familiar with the diarization backend.
  • Preview the rendered docs to confirm the <Warning> blocks render correctly and the cross-link from the speaker diarization page to the multichannel page resolves properly (/docs/speech-to-text/pre-recorded-audio/multichannel-transcription).

Notes

  • The warning text is intentionally similar on both pages since users may land on either one independently.

Link to Devin session: https://app.devin.ai/sessions/64d717aba1a74942a8d222b1d187fb3e
Requested by: @ryanseams

…annel transcription

Co-Authored-By: Ryan Seams <ryan.seams@gmail.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

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