docs(streaming): add stream_final_turn_only documentation#768
Open
zhifanl wants to merge 1 commit intostrands-agents:mainfrom
Open
docs(streaming): add stream_final_turn_only documentation#768zhifanl wants to merge 1 commit intostrands-agents:mainfrom
zhifanl wants to merge 1 commit intostrands-agents:mainfrom
Conversation
Add documentation for the new stream_final_turn_only parameter on Agent.stream_async(). This parameter allows callers to suppress intermediate turn text events and only receive the final answer, which is useful for production chat UIs and SSE endpoints. The new section is added to the async-iterators page with a before/after code example and use case descriptions. Resolves: #2055
zhifanl
requested a deployment
to
manual-approval
GitHub Actions
Waiting
zhifanl
requested a deployment
to
manual-approval
GitHub Actions
Waiting
Open
7 tasks
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
1 participant
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
Description
Add documentation for the new stream_final_turn_only parameter on Agent.stream_async(). This parameter allows callers to suppress intermediate turn text events and only receive the final answer, which is useful for production chat UIs and SSE endpoints.
The new section is added to the async-iterators page with a before/after code example and use case descriptions.
Resolves: #2055
Related Issues
SDK PR: strands-agents/sdk-python#2104, strands-agents/sdk-python#2104
Feature request: strands-agents/sdk-python#2055
Type of Change
Checklist
npm run devBy submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.