Repository navigation
Conversation
…rsational summary model The SummarizationModel.conversational docstring listed only `speaker_labels` and `dual_channel` as valid speaker-separation requirements, omitting `multichannel` — the recommended and non-deprecated alternative to `dual_channel`. This caused confusion because passing `multichannel=True` alongside `summary_model=SummarizationModel.conversational` is fully supported by the API but was undocumented, leading users to incorrectly assume they had to use the deprecated `dual_channel` flag. Fixes AssemblyAI/assemblyai-node-sdk#71 (same root cause applies to the Python SDK docstring). Changes: - Updated `SummarizationModel.conversational` docstring to list `multichannel` as the recommended speaker-separation option, with `dual_channel` noted as deprecated. - Added parametrized regression test `test_conversational_summary_with_speaker_separation` covering multichannel, speaker_labels, and dual_channel to confirm no client-side error is raised for any of these valid combinations.
pylrn
force-pushed
the
fix/conversational-summary-multichannel
branch
from
September 25, 2026 04:57
007e70e to
b6c6183
Compare
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.
Problem
Closes #71 (cross-repo — originally filed against
assemblyai-node-sdkbut the same root cause applies here).SummarizationModel.conversationalrequires at least one speaker-separation mode to be enabled. The docstring listed onlyspeaker_labelsanddual_channel, leaving outmultichannel— the recommended, non-deprecated alternative.This caused confusion: users who followed the deprecation guidance and switched to
multichannel=Truesaw what appeared to be an undocumented or unsupported configuration, even though the API accepts it correctly.Changes
assemblyai/types.pySummarizationModel.conversationaldocstring to includemultichannelin the "Required Parameters" list.multichannelis the recommended option anddual_channelis deprecated — consistent with the deprecation note already present elsewhere in the SDK.tests/unit/test_summarization.pyAdded
test_conversational_summary_with_speaker_separation, a parametrized regression test covering all three valid speaker-separation flags:multichannel=True(the previously undocumented case)speaker_labels=Truedual_channel=TrueEach variant verifies that no client-side
ValueErroris raised and that the correct fields are forwarded to the API.Testing
All 9 tests in
test_summarization.pypass (6 pre-existing + 3 new):