Skip to content

Add completion and cancellation docs for AI Transport#3204

Open
zknill wants to merge 1 commit intomainfrom
zak/ait-improvements
Open

Add completion and cancellation docs for AI Transport#3204
zknill wants to merge 1 commit intomainfrom
zak/ait-improvements

Conversation

@zknill
Copy link
Contributor

@zknill zknill commented Feb 13, 2026

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

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
@zknill zknill requested a review from GregHolmes February 13, 2026 12:36
@coderabbitai
Copy link

coderabbitai bot commented Feb 13, 2026

Important

Review skipped

Auto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch zak/ait-improvements

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

1 participant