docs: add streaming speaker diarization parameters to API reference#787
Merged
docs: add streaming speaker diarization parameters to API reference#787
Conversation
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>
Contributor
Author
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
MAsuamah
approved these changes
Mar 18, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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.ymlandusm-streaming-u3-pro.yml):speaker_labels— boolean ("true"/"false", default"false") to enable real-time speaker diarizationmax_speakers— integer (1–10) to hint the expected number of speakersResponse field added (to
TurnPayloadschema in both specs):speaker_label— string (e.g."A","B","UNKNOWN") on Turn events when diarization is enabledFern overrides updated to mark both new connection parameters as optional.
Review & Testing Checklist for Human
speaker_labelsandmax_speakersparameter names, types, defaults, and constraints match the actual streaming API behaviorspeaker_labelshould not be in therequiredarray ofTurnPayload(it's only present whenspeaker_labelsis enabled)enable_extra_session_informationormultichannelparameters (also on the docs page) should be added in this PR or a follow-uppnpm run docs) and verify the new parameters render correctly on both streaming API reference pagesNotes
speaker_labelsparam usesenum: ["true", "false"]to match the convention of other boolean query params in these specs (e.g.language_detection,format_turns).enable_extra_session_informationandmultichannelparameters, 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