# @amaster\.ai/copilot-client 中文文档

规范地址：https://npmcn.com/package/%40amaster.ai/copilot-client/

版本：1\.1\.72
npm 元数据更新时间：2026-11-05T13:04:14.797Z
中文译文更新时间：2026-11-08T00:11:07.939Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40amaster.ai/copilot-client
原文对照：https://npmcn.com/package/%40amaster.ai/copilot-client/?lang=original

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：363 kB，9 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：4 个
- peer 依赖：@a2a-js/sdk ^0\.3\.7
- 首次发布：2026-01-17T08:19:57.364Z
- 最新版本发布：2026-11-05T13:04:14.645Z
- 近 30 天下载量：1961（2026-10-06 至 2026-11-04，npm 官方下载统计）
- 已发布版本数：207（近 12 个月 207 个）

## 中文简介

AI 副驾驶聊天客户端,并有流支持

## 安装

```sh
npm install @amaster.ai/copilot-client
```

也可以使用：`pnpm add @amaster.ai/copilot-client`、`yarn add @amaster.ai/copilot-client`、`bun add @amaster.ai/copilot-client`

## README

# @amaster.ai/副驾驶-客户端

支持 : **Vite / 浏览器 / Taro H5 / Taro 小型程序** (自动发现)

## 安装

```bash
pnpm add @amaster.ai/copilot-client
```

### 同伴依赖关系

```bash
pnpm add @a2a-js/sdk
```

## 使用量

```typescript
import { createHttpClient } from "@amaster.ai/http-client";
import { createCopilotClient, type ServerToClientMessage } from "@amaster.ai/copilot-client";

const http = createHttpClient();
const client = createCopilotClient(http);

for await (const messages of client.chat([{ role: "user", content: "Hello" }])) {
  // messages: ServerToClientMessage[]
  // Process/render the messages
}
```

## API 密码

### `createCopilotClient(http)`

创建副驾驶客户端.

### `client.chat(messages, options?)`

流出从 A2A 响应中转换的消息 .

```typescript
interface ChatMessage {
  role: "system" | "user" | "assistant";
  content: string | MessageContent[];
}

interface ChatOptions {
  taskId?: string;
}
```

### `client.cancelChat(taskId)`

取消正在进行的聊天任务.

### `client.getChatStatus(taskId)`

获取聊天任务的当前状态.

## 多式联运输入

```typescript
// Text
{ role: "user", content: "Hello" }

// Image
{ role: "user", content: [
  { type: "text", text: "What's this?" },
  { type: "image", url: "https://..." }
]}

// File
{ role: "user", content: [
  { type: "file", url: "https://...", name: "doc.pdf" }
]}
```

## 参考资料

-   [A2A议定书](https://github.com/google-a2a/A2A)

## 许可证

麻省理工学院

## 常见问题

### @amaster\.ai/copilot-client 是什么？

AI 副驾驶聊天客户端,并有流支持

### 如何安装 @amaster\.ai/copilot-client？

在项目目录运行 npm install @amaster\.ai/copilot-client，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@a2a-js/sdk（^0\.3\.7）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @amaster\.ai/copilot-client 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @amaster\.ai/copilot-client 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @amaster\.ai/copilot-client 可以商用吗？

@amaster\.ai/copilot-client 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @amaster\.ai/copilot-client 的下载量有多少？

根据 npm 官方下载统计，@amaster\.ai/copilot-client 在 2026/10/06 – 2026/11/04 这 30 天内被下载 1,961 次，日均约 65 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @amaster\.ai/copilot-client 还在维护吗？

最新版本 1\.1\.72 发布于 2026/11/05（2 天前）；至今共发布 207 个版本，其中过去 12 个月发布了 207 个；首次发布于 2026/01/17。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。