docs(ai-transport): add OpenAI Responses codec pages#3488
Open
zknill wants to merge 3 commits into
Open
Conversation
|
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 Plus 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 |
zknill
marked this pull request as ready for review
July 24, 2026 08:27
Add a getting-started walkthrough and a framework page for the OpenAI Responses codec (ResponsesCodec) from @ably/ai-transport/openai. - Getting started: build a Next.js chat app that streams the Responses event stream over a durable session using the generic createAgentSession and core React hooks, with cancellation and multi-device sync. - Framework page: what the Responses API brings, what AI Transport adds, the run.pipe connection point, and the server-side tool loop. - Add both pages to the AI Transport nav (OpenAI first under By SDK and first in Frameworks). - Remove the getting-started/openai redirect from the Vercel AI SDK page now that it resolves to a real page.
The codecs concept page implied the Vercel codec was the only bundled codec. Now that the OpenAI ResponsesCodec ships in the SDK, update the non-codec-specific pages so neither frames Vercel as the sole option. - codecs concept: the SDK bundles a Vercel codec and a ResponsesCodec, each covering its framework end-to-end; add an OpenAI Read next link; correct the intro from "an OpenAI completion" to "an OpenAI Responses event". - why overview: list OpenAI Responses events alongside the Vercel UIMessage as a codec-layer example.
The ResponsesCodec now supports the full client-side tool surface (client-executed tools, tool failures, and human approvals), so the docs no longer match the SDK. - Add a "Run client-side tools and approvals" section to the OpenAI framework page covering the createToolResult, createToolResultError, and createToolApprovalResponse factories and the tool-approval-request output, and remove the stale run-outcome Aside. - Rewrite "Scope and trade-offs" so only hosted tools remain listed as unsupported. - Add an "OpenAI codec" section to the tool-calling feature page.
zknill
force-pushed
the
zak/ait-1077-openai-codec-docs
branch
from
July 24, 2026 08:27
47e677d to
3fcb6c5
Compare
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
1 participant
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 documentation for the OpenAI Responses codec (
ResponsesCodecfrom@ably/ai-transport/openai) and reconcile the surrounding pages so none of them frame the Vercel codec as the only bundled codec.createAgentSessionand the core React hooks, with a stop button for cancellation and a second tab for multi-device sync.run.pipeconnection point (with a before/after that contrasts the hand-rolled SSE response againstrun.pipe(stream)), and the server-side tool loop.aitransport.ts. OpenAI sits first under "By SDK" and first under "Frameworks".ResponsesCodec, add an OpenAI "Read next" link, and correct the codecs intro from "an OpenAI completion" to "an OpenAI Responses event".getting-started/openairedirect from the Vercel AI SDK page, since that path now resolves to a real page.