Repository navigation
Python: Fix the async ChatResponse aggregation example - #9518
Open
LI (ktz03) wants to merge 1 commit into
Open
LI (ktz03) wants to merge 1 commit into
LI (ktz03) wants to merge 1 commit into
Conversation
Contributor
There was a problem hiding this comment.
🟢 Approval recommended
The documentation-only correction uses the existing public APIs correctly and has no unresolved findings.
No open issues 🎉
What changed in this PR
Corrects the async ChatResponse aggregation example without changing APIs or runtime behavior.
Changes:
- Replaces the obsolete client placeholder with a self-contained async generator using public types.
- Shows the expected aggregated text output.
| File | Description |
|---|---|
python/packages/core/agent_framework/_types.py |
Updates the from_update_generator docstring example. |
Review effort: Balanced
This branch was successfully deployed
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.
Motivation & Context
The
ChatResponse.from_update_generatorexample imports aChatClientplaceholder that the package does not export and uses the legacyget_streaming_responsename. Copying it currently fails at the import.Description & Review Guide
Hello How can I help you?, and the adjacent synchronous example still works. Current-config Ruff checks and source compilation pass. No provider/model, package build or full-suite run was performed.ChatResponseUpdate,Content.from_textandChatResponse.from_update_generatorAPIs correctly.Related Issue
N/A - trivial change. This is an obvious correction to an example that imports a non-exported client placeholder and uses a legacy streaming method. It uses existing public types and a self-contained async generator without changing any API or runtime behavior.
AI Assistance
AI assistance details: Documentation, example verification, and this PR description.
Contribution Checklist
breaking changelabel (or add "[BREAKING]" to the title prefix, before or after any language prefix) — a workflow keeps the label and title prefix in sync automatically.