docs(ai-transport): document interruption and steering#3471
Draft
zknill wants to merge 3 commits into
Draft
Conversation
Replace the Interruption feature page with a combined Interruption and steering page, and add a "Steer a Run" section to the Runs concept. Repoint the nav entry and all cross-links from the old page, with a redirect_from to preserve the old URL. The page documents three ways a client changes direction mid-response: steer the active Run with a follow-up prompt, cancel and re-prompt, or send alongside as a concurrent Run.
The server-side abort-signal example fed run.messages straight to the model. run.messages is only the current Run's own turn (its triggering input plus its output), not the multi-turn conversation, so a model called with it loses all prior context. Drain run.view with loadOlder() before run.start() and feed run.view.getMessages() through convertToModelMessages, matching the agent hydration pattern used across the getting-started and interruption-and-steering pages.
|
Important Review skippedAuto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Repository UI Review profile: CHILL Plan: Pro Run ID: 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 |
Order the Features section entries by name so the nav is predictable and new pages have an obvious insertion point.
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
2 participants
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.
Documents the AI Transport interruption and steering feature, and verifies the affected agent-side docs against the SDK source (the
ait-1017-steering-stepsbranch, the release target).features/interruption.mdxwithfeatures/interruption-and-steering.mdx, covering the three change-direction patterns: steer the active Run with a follow-up prompt, cancel and re-prompt, or send alongside as a concurrent Run.concepts/runs.mdxdocumenting the client-sidesteer()API ({ published, outcome },consumed/runTerminalReason).cancellation.mdx,concurrent-turns.mdx,double-texting.mdx, andwhy/index.mdx.createRunis synchronous (noawait), drainrun.viewwithloadOlder()beforerun.start(), feedrun.view.getMessages()to the model (notrun.messages, which is turn-only), and tear down withsession.end(). Corrects a strayActiveRunreference toClientRun.run.messages(this Run's own turn) straight to the model, losing all prior conversation context. It now drainsrun.viewand feeds the full conversation.