Skip to content

docs: sync PR 756 - feat: split ai-chat and codemode into separate packages #27344

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

Open
agents-git-bot wants to merge 1 commit into
base: production
Choose a base branch
from
+902 −10
Open

docs: sync PR 756 - feat: split ai-chat and codemode into separate packages #27344

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 6 additions & 6 deletions src/content/docs/agents/api-reference/agents-api.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -804,14 +804,14 @@ function useAgent<State = unknown>(

The Agents SDK exposes an `AIChatAgent` class that extends the `Agent` class and exposes an `onChatMessage` method that simplifies building interactive chat agents.

You can combine this with the `useAgentChat` React hook from the `agents/ai-react` package to manage chat state and messages between a user and your Agent(s).
You can combine this with the `useAgentChat` React hook from the `@cloudflare/ai-chat/react` package to manage chat state and messages between a user and your Agent(s).

#### AIChatAgent

Extension of the `Agent` class with built-in chat capabilities.

```ts
import { AIChatAgent } from "agents/ai-chat-agent";
import { AIChatAgent } from "@cloudflare/ai-chat";
import { Message, StreamTextOnFinishCallback, ToolSet } from "ai";

// Base class for chat-specific agents
Expand All @@ -834,7 +834,7 @@ class AIChatAgent<Env = unknown, State = unknown> extends Agent<Env, State> {

```ts
// Example of extending AIChatAgent
import { AIChatAgent } from "agents/ai-chat-agent";
import { AIChatAgent } from "@cloudflare/ai-chat";
import { Message } from "ai";

interface Env {
Expand Down Expand Up @@ -897,7 +897,7 @@ When you use `AIChatAgent` with `useAgentChat`:
<TypeScriptExample>

```ts
import { AIChatAgent } from "agents/ai-chat-agent";
import { AIChatAgent } from "@cloudflare/ai-chat";
import { streamText } from "ai";
import { openai } from "@ai-sdk/openai";

Expand Down Expand Up @@ -938,7 +938,7 @@ const { messages } = useAgentChat({
React hook for building AI chat interfaces using an Agent.

```ts
import { useAgentChat } from "agents/ai-react";
import { useAgentChat } from "@cloudflare/ai-chat/react";
import { useAgent } from "agents/react";
import type { Message } from "ai";

Expand Down Expand Up @@ -1012,7 +1012,7 @@ function useAgentChat(options: UseAgentChatOptions): {

```tsx
// Example of using useAgentChat in a React component
import { useAgentChat } from "agents/ai-react";
import { useAgentChat } from "@cloudflare/ai-chat/react";
import { useAgent } from "agents/react";
import { useState } from "react";

Expand Down
Loading
Loading