Skip to content

docs(ag-ui): voice pass on guides + concepts #624

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
blove merged 3 commits into from
Jun 8, 2026
+9 −5
Merged

docs(ag-ui): voice pass on guides + concepts #624

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ede96c8
docs(ag-ui): voice pass on guides + concepts
blove Jun 8, 2026
8ca4829
Merge branch 'main' into claude/voice-ag-ui-docs
blove Jun 8, 2026
fd53b10
Merge branch 'main' into claude/voice-ag-ui-docs
blove Jun 8, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion apps/website/content/docs/ag-ui/guides/citations.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

`@threadplane/ag-ui` can copy citations from AG-UI state onto chat messages.

The bridge is intentionally simple: put citations under `state.citations`, keyed by message id. When a `STATE_SNAPSHOT` or `STATE_DELTA` arrives, the adapter merges matching citations onto `messages`.
The bridge is deliberately simple: put citations under `state.citations`, keyed by message id. When a `STATE_SNAPSHOT` or `STATE_DELTA` arrives, the adapter merges matching citations onto `messages`.

## State shape

Expand Down
6 changes: 3 additions & 3 deletions apps/website/content/docs/ag-ui/guides/fake-agent.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Fake Agent

`FakeAgent` is an in-process AG-UI `AbstractAgent` for frontend work when a backend is not ready.
`FakeAgent` is an in-process AG-UI `AbstractAgent` for frontend work when the backend isn't ready yet.

It emits a canned stream:

Expand All @@ -11,7 +11,7 @@ It emits a canned stream:
5. `TEXT_MESSAGE_END`
6. `RUN_FINISHED`

It is for demos, story-like development, and tests. It is not a production transport.
It's for demos, story-like development, and tests. It's not a production transport.

## Use the provider

Expand Down Expand Up @@ -98,6 +98,6 @@ That gives you the same `Agent` contract as `provideFakeAgent()`.

`FakeAgent` does not call a model, execute tools, persist history, or simulate interrupts.

It is deliberately small. Use it to keep UI work moving, not to validate backend behavior.
It's deliberately small. Use it to keep UI work moving, not to validate backend behavior.

For backend integration, test against your real AG-UI endpoint and the event map in [Event Mapping](/docs/ag-ui/reference/event-mapping).
6 changes: 5 additions & 1 deletion apps/website/content/docs/ag-ui/guides/interrupts.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
# Interrupts (Human-in-the-Loop)

Interrupts let your AG-UI agent pause mid-run and hand control to a human. The agent proposes an action, the run freezes, your Angular UI shows an approval dialog, the user decides, and the agent resumes with the human's decision. This guide covers the AG-UI adapter specifics. For the broader conceptual model — lifecycle stages, timeout strategies, typed payloads — see the [LangGraph interrupts guide](/docs/langgraph/guides/interrupts).
Interrupts let your AG-UI agent pause mid-run and hand control to a human.

The agent proposes an action, the run freezes, your Angular UI shows an approval dialog, the user decides, and the agent resumes with the human's decision.

This guide covers the AG-UI adapter specifics. For the broader conceptual model — lifecycle stages, timeout strategies, typed payloads — see the [LangGraph interrupts guide](/docs/langgraph/guides/interrupts).

## The Wire Format

Expand Down
Loading