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.
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
Clarifies and verifies that
multichannelis accepted as a valid speaker-separation option forSummarizationModel.conversational.The
SummarizationModel.conversationaldocstring previously listed onlyspeaker_labelsanddual_channelas required speaker-separation options, omittingmultichannel— the recommended, non-deprecated alternative todual_channel. This caused confusion (e.g. cross-referenced in AssemblyAI/assemblyai-node-sdk#71) as users were led to believe that the deprecateddual_channelparameter was required for conversational summaries.Changes
assemblyai/types.py: Update the docstring forSummarizationModel.conversationalto specifyspeaker_labels,multichannel, ordual_channel, notingmultichannelas the recommended approach anddual_channelas deprecated.assemblyai/__version__.py: Bump version from1.8.2to1.8.3to satisfy the repository's version bump check workflow.tests/unit/test_summarization.py: Add parametrized unit testtest_conversational_summary_with_speaker_separationverifying thatmultichannel,speaker_labels, anddual_channelare all properly validated and serialized alongsidesummary_model="conversational"andsummary_type="bullets".Verification
pytest tests/unit/test_summarization.pypasses (9/9 passed).ruff check assemblyai --config ./ruff.tomlpasses cleanly.ruff format --check --config ./ruff.toml assemblyaipasses cleanly.