docs: Clarify new_items
output conditions for improved developer experience
#1352
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.
This Pull Request focuses on improving the documentation for the
new_items
property withinRunResult
andRunResultStreaming
. The update aims to provide a clearer, more organized, and user-friendly explanation of how differentRunItem
types are generated.The current documentation lists all
RunItem
types, but does not explicitly explain that they are mutually exclusive outcomes of specific agent actions (e.g., a handoff will not also generate a tool call item). This can lead to confusion and wasted time for new users trying to understand the agent's output.Key changes and benefits:
new_items
: TheRunItems
are now grouped and described based on the specific agent action that triggers them (direct message, tool use, handoff, or internal reasoning).new_items
list for any given agent run, directly addressing a common point of confusion for beginners.I believe this update is a crucial improvement for the developer onboarding process and will reduce unnecessary frustration.