Skip to content

Commit bebc349

Browse files
committed
docs: fix typo and tidy SDK naming in comparison section (AIT-865)
Fix 'primarly' typo and use consistent article and naming for the AI Transport SDK and the Chat SDK.
1 parent c7e4f05 commit bebc349

1 file changed

Lines changed: 7 additions & 7 deletions

File tree

src/pages/docs/platform/products/index.mdx

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ AI Transport is a good fit when:
121121
* You need to manage AI chat sessions with identity and resumability.
122122
* You want to fan out AI-generated content to multiple subscribers.
123123

124-
If your chat is primarly between humans, even when AI moderates or assists behind the scenes, then consider the [Chat SDK](#chat).
124+
If your chat is primarily between humans, even when AI moderates or assists behind the scenes, then consider the [Chat SDK](#chat).
125125

126126
### Why use purpose-built SDKs
127127

@@ -291,19 +291,19 @@ When combining SDKs with Pub/Sub:
291291
* **Consider message ordering**: Messages on SDK-managed channels and custom Pub/Sub channels are independent; design your application accordingly.
292292
* **Handle connection state once**: The underlying Realtime client manages connection state; don't add redundant connection handling for custom features.
293293

294-
## Choosing between AI Transport and Chat SDKs <a id="ait-vs-chat"/>
294+
## Choosing between AI Transport and the Chat SDK <a id="ait-vs-chat"/>
295295

296-
AI Transport and the Chat SDK both handle conversations but for different types of users.
296+
The AI Transport SDK and the Chat SDK both handle conversations but for different types of users and operations.
297+
298+
The Chat SDK provides support for common chat application operations: not just publishing and subscribing to messages, but moderation, typing indicators, emoji reactions, and editing or deleting messages.
299+
300+
The AI Transport SDK enables interactions with AI agents that go beyond those operations. It is built for human-to-agent and client-to-agent interactions that support an agentic loop, tool calls, human-in-the-loop, interruption and steering, as well as streamed responses. Simple editing of messages, as supported by the Chat SDK, is not sufficient for agent applications, because of the need to support regeneration of responses and the resultant forking of conversations. Similarly, agentic applications have a much richer need to indicate progress than the simple typing indicators used for human chat, and agentic interactions such as runs and steps are an intrinsic part of the control flow of an agent session, not just a visual indicator.
297301

298302
| You are building | Use |
299303
| --- | --- |
300304
| A user conversing with an AI agent: streaming responses, multi-turn, across devices | [AI Transport](/docs/ai-transport) |
301305
| People conversing with each other: support staffed by humans, group chat, livestream chat | [Chat SDK](/docs/chat) |
302306

303-
The Chat SDK provides support for operations that are commonly needed in chat applications: not just publishing and subscribing to messages, but moderation, typing indicators, emoji reactions, and editing and deleting messages.
304-
305-
AI Transport supports interactions with AI agents that go beyond this. It is built for human-to-agent and client-to-agent interactions that support an agentic loop, tool calls, human-in-the-loop, interruption and steering, as well as streamed responses. Simple editing of messages, as supported by the Chat SDK, is not sufficient for agent applications, because of the need to support regeneration of responses and the resultant forking of conversations. Similarly, agentic applications have a much richer need to indicate progress than the simple typing indicators sufficient for human chat, and agentic interactions such as runs and steps are an intrinsic part of the control flow of an agent session, not just a visual indicator.
306-
307307
In support scenarios, if an AI answers the user then reach for AI Transport, even when a human can take over the conversation. If people staff the conversation, reach for the Chat SDK, even when AI moderates or assists behind the scenes.
308308

309309
The two products run on the same Ably platform but are separate today, so you can [combine](#combine-pubsub) either of them with Pub/Sub but not with each other. Closer integration between AI Transport and Chat is coming soon, which will give applications that need both AI-driven and human-to-human messaging a simple implementation path.

0 commit comments

Comments
 (0)