Repository navigation
docs(schema): let cancelled cover stops the user chose through the Agent - #2576
Merged
Merged
Conversation
The v2 cancelled stop reason was limited to session/cancel and closing the session. A user can also stop a turn through an interaction the Agent offers, such as a permission option like "No, keep planning" that tells the Agent to stop; that is a user cancel too, not an error. The reason stays reserved against Agent-side limits and failures.
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.
#2523 limited the v2
cancelledstop reason tosession/canceland closing the session. A user can also stop a turn through an interaction the Agent offers. For example, answering a plan-approval permission request with "No, keep planning" interrupts the turn so the user can give feedback. That is a user cancel, and reporting it aserrorwould be wrong.New wording:
cancelled: the user or Client chose to stop the work, viasession/cancel, by closing the session, or through an interaction the Agent offers, such as a permission option that tells the Agent to stop.max_tokens,max_turn_requests,refusalorerror.Changed: the
StopReason::Cancelleddoc comment, the v2prompt-lifecycle.mdx(stable and draft), and the regenerated schema and schema docs.