Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
devin-ai-integration wants to merge 1 commit into
base: main
Choose a base branch
from
Open

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions fern/pages/speech-to-text/pre-recorded-audio/multichannel-transcription.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -184,6 +184,10 @@ while (true) {

If you have a multichannel audio file where individual channels may contain multiple speakers, you can combine `multichannel` and `speaker_labels` to perform diarization within each channel.

<Warning>
When using `multichannel` with `speaker_labels`, the `speaker_options` parameters (`min_speakers_expected` and `max_speakers_expected`) are applied **per channel**, not globally across the entire file. For example, setting `min_speakers_expected: 5` and `max_speakers_expected: 7` on a 5-channel file means the model will find 5–7 speakers on _each_ channel, resulting in 25–35 total speakers. Adjust your speaker options accordingly when using multichannel transcription.
</Warning>

When both parameters are enabled:

- Channels are labeled numerically (1, 2, 3, etc.)
Expand Down
4 changes: 4 additions & 0 deletions fern/pages/speech-to-text/pre-recorded-audio/speaker-diarization.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -430,6 +430,10 @@ This parameter is suitable for use cases where there is a known minimum/maximum
labels.
</Warning>

<Warning>
When using `multichannel` with `speaker_labels`, the `speaker_options` parameters are applied **per channel**, not globally across the entire file. For example, setting `min_speakers_expected: 5` and `max_speakers_expected: 7` on a 5-channel file means the model will find 5–7 speakers on _each_ channel, resulting in 25–35 total speakers. Adjust your speaker options accordingly when using [multichannel transcription](/docs/speech-to-text/pre-recorded-audio/multichannel-transcription).
</Warning>

Building on the [Quickstart](#quickstart) above, add `speaker_options` to your transcription config:

<Tabs groupId="language">
Expand Down
Loading