Skip to content

fix(types): document multichannel as valid speaker-separation for conversational summary model - #256

Open
pylrn wants to merge 2 commits into
AssemblyAI:masterfrom
pylrn:fix/conversational-summary-multichannel
Open

pylrn wants to merge 2 commits into
AssemblyAI:masterfrom
pylrn:fix/conversational-summary-multichannel

Conversation

@pylrn

@pylrn pylrn commented Sep 23, 2026

Copy link
Copy Markdown
Contributor

Problem

Closes #71 (cross-repo — originally filed against assemblyai-node-sdk but the same root cause applies here).

SummarizationModel.conversational requires at least one speaker-separation mode to be enabled. The docstring listed only speaker_labels and dual_channel, leaving out multichannel — the recommended, non-deprecated alternative.

This caused confusion: users who followed the deprecation guidance and switched to multichannel=True saw what appeared to be an undocumented or unsupported configuration, even though the API accepts it correctly.

Changes

assemblyai/types.py

  • Updated the SummarizationModel.conversational docstring to include multichannel in the "Required Parameters" list.
  • Added a note that multichannel is the recommended option and dual_channel is deprecated — consistent with the deprecation note already present elsewhere in the SDK.

tests/unit/test_summarization.py

  • Added 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=True
    • dual_channel=True

    Each variant verifies that no client-side ValueError is raised and that the correct fields are forwarded to the API.

Testing

All 9 tests in test_summarization.py pass (6 pre-existing + 3 new):

tests/unit/test_summarization.py::test_conversational_summary_with_speaker_separation[multichannel] PASSED
tests/unit/test_summarization.py::test_conversational_summary_with_speaker_separation[speaker_labels] PASSED
tests/unit/test_summarization.py::test_conversational_summary_with_speaker_separation[dual_channel] PASSED
======================== 9 passed in 0.20s ========================

…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
pylrn force-pushed the fix/conversational-summary-multichannel branch from 007e70e to b6c6183 Compare September 25, 2026 04:57
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.

1 participant