Add completion and cancellation docs for AI Transport#3204
Open
Add completion and cancellation docs for AI Transport#3204
Conversation
Add a new page covering completion signalling and cancellation patterns for AI responses streamed via message-per-response. The page explains content-part completion using operation metadata empty appends, response-level completion via discrete messages, detecting completion from history, and user-initiated cancellation with correlation IDs. Also improve the message-per-response page with: - Required channel capabilities table - Guidance on awaiting appends between content parts - Clarification that data should be raw strings, not JSON-encoded - Note on append conflation and message.update delivery - Link to the new completion and cancellation page
|
Important Review skippedAuto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
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.
Add a new page covering completion signalling and
cancellation patterns for AI responses streamed via message-per-response. The page explains content-part completion using operation metadata empty appends, response-level completion via discrete messages,
detecting completion from history, and user-initiated cancellation with correlation IDs.
Also improve the message-per-response page with: