Skip to content

docs: add streaming speaker diarization parameters to API reference#787

Merged
MAsuamah merged 2 commits intomainfrom
devin/1773863576-streaming-diarization-params
Mar 18, 2026
Merged

docs: add streaming speaker diarization parameters to API reference#787
MAsuamah merged 2 commits intomainfrom
devin/1773863576-streaming-diarization-params

Conversation

@devin-ai-integration
Copy link
Contributor

Summary

Adds streaming speaker diarization parameters to both the Universal-Streaming and Universal-3 Pro Streaming API reference specs, based on the Streaming Diarization docs.

Connection parameters added (to both usm-streaming.yml and usm-streaming-u3-pro.yml):

  • speaker_labels — boolean ("true"/"false", default "false") to enable real-time speaker diarization
  • max_speakers — integer (1–10) to hint the expected number of speakers

Response field added (to TurnPayload schema in both specs):

  • speaker_label — string (e.g. "A", "B", "UNKNOWN") on Turn events when diarization is enabled

Fern overrides updated to mark both new connection parameters as optional.

Review & Testing Checklist for Human

  • Verify speaker_labels and max_speakers parameter names, types, defaults, and constraints match the actual streaming API behavior
  • Confirm speaker_label should not be in the required array of TurnPayload (it's only present when speaker_labels is enabled)
  • Check whether enable_extra_session_information or multichannel parameters (also on the docs page) should be added in this PR or a follow-up
  • Build the Fern docs locally (pnpm run docs) and verify the new parameters render correctly on both streaming API reference pages

Notes

  • The speaker_labels param uses enum: ["true", "false"] to match the convention of other boolean query params in these specs (e.g. language_detection, format_turns).
  • The docs page also documents enable_extra_session_information and multichannel parameters, but they are not strictly diarization parameters — excluded based on the request scope.

Link to Devin session: https://app.devin.ai/sessions/fd93e5c0f422444a90a899b7734b9607
Requested by: @LeeVaughn

Add speaker_labels and max_speakers connection parameters and
speaker_label Turn response field to both Universal-Streaming and
Universal-3 Pro Streaming API reference specs.

Also update fern overrides to mark the new parameters as optional.

Co-Authored-By: Lee Vaughn <dlvprogramming@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

@github-actions
Copy link

@MAsuamah MAsuamah merged commit 409874f into main Mar 18, 2026
4 checks passed
@MAsuamah MAsuamah deleted the devin/1773863576-streaming-diarization-params branch March 18, 2026 20:36
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.

2 participants