fix: use Modality enum for RunConfig.response_modalities#4889
Closed
brucearctor wants to merge 7 commits into
Closed
fix: use Modality enum for RunConfig.response_modalities#4889brucearctor wants to merge 7 commits into
brucearctor wants to merge 7 commits into
Conversation
RunConfig.response_modalities was typed as Optional[list[str]] but is assigned to LiveConnectConfig.response_modalities which expects Optional[list[Modality]]. This type mismatch caused Pydantic serialization warnings on every live streaming session. Change the type to Optional[list[types.Modality]] and update string literal usages in runners.py to use the enum. This is backwards compatible since Modality is a string enum and Pydantic coerces string values automatically. Fixes: google#4869
Contributor
|
Warning You have reached your daily quota limit. Please wait up to 24 hours and I will start processing your requests again! |
adk-bot
added
the
live
Contributor
Author
|
/gemini review |
rohityan
added
the
request clarification
Collaborator
|
Hi @brucearctor ,Thank you for your contribution! We appreciate you taking the time to submit this pull request. Can you please fix the failing mypy-diff tests |
Contributor
Author
|
@rohityan - yes, those were fixed awhile ago. |
copybara-service Bot
pushed a commit
that referenced
this pull request
Jun 19, 2026
Merge #4889 ## Description Fixes #4869 `RunConfig.response_modalities` is typed as `Optional[list[str]]`, but it gets assigned to `LiveConnectConfig.response_modalities` which expects `Optional[list[Modality]]` (an enum from `google-genai`). This type mismatch causes Pydantic to emit a `PydanticSerializationUnexpectedValue` warning on every live streaming session, polluting production logs. ## Changes - **`run_config.py`**: Changed `response_modalities` type from `Optional[list[str]]` to `Optional[list[types.Modality]]` - **`runners.py`**: Updated two string literal `'AUDIO'` usages to `types.Modality.AUDIO` for consistency This is backwards compatible — `Modality` is a string enum, so Pydantic automatically coerces string values like `'AUDIO'` to `Modality.AUDIO`. ## Testing Plan Added 4 new unit tests in `test_run_config.py`: - `test_response_modalities_accepts_enum` — enum values are stored correctly - `test_response_modalities_coerces_string_to_enum` — string values still work (backwards compat) - `test_response_modalities_coerces_lowercase_string_to_enum` — lowercase string values also work (backwards compat) - `test_response_modalities_serialization_no_warning` — `LiveConnectConfig.model_dump()` produces no Pydantic warnings Co-authored-by: Liang Wu <wuliang@google.com> COPYBARA_INTEGRATE_REVIEW=#4889 from brucearctor:fix/response-modalities-type e67f715 PiperOrigin-RevId: 934659835
Collaborator
|
Thank you @brucearctor for your contribution! 🎉 Your changes have been successfully imported and merged via Copybara in commit 5c8c55a. Closing this PR as the changes are now in the main branch. |
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
4 participants
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.
Description
Fixes #4869
RunConfig.response_modalitiesis typed asOptional[list[str]], but it gets assigned toLiveConnectConfig.response_modalitieswhich expectsOptional[list[Modality]](an enum fromgoogle-genai). This type mismatch causes Pydantic to emit aPydanticSerializationUnexpectedValuewarning on every live streaming session, polluting production logs.Changes
run_config.py: Changedresponse_modalitiestype fromOptional[list[str]]toOptional[list[types.Modality]]runners.py: Updated two string literal'AUDIO'usages totypes.Modality.AUDIOfor consistencyThis is backwards compatible —
Modalityis a string enum, so Pydantic automatically coerces string values like'AUDIO'toModality.AUDIO.Testing Plan
Added 3 new unit tests in
test_run_config.py:test_response_modalities_accepts_enum— enum values are stored correctlytest_response_modalities_coerces_string_to_enum— string values still work (backwards compat)test_response_modalities_serialization_no_warning—model_dump()produces no Pydantic warnings