# @d-id/client-sdk 中文文档

规范地址：https://npmcn.com/package/%40d-id/client-sdk/

版本：3\.0\.9
npm 元数据更新时间：2026-11-08T10:35:47.434Z
中文译文更新时间：2026-11-11T07:40:18.428Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40d-id/client-sdk
原文对照：https://npmcn.com/package/%40d-id/client-sdk/?lang=original
项目主页：https://sdk.d-id.com/
源码仓库：https://github.com/de-id/agents-sdk

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

- 包体积（解压后）：2.4 MB，12 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=20
- 运行依赖：1 个
- 首次发布：2023-11-19T11:20:04.295Z
- 最新版本发布：2026-11-08T10:35:47.134Z
- 近 30 天下载量：34525（2026-10-11 至 2026-11-09，npm 官方下载统计）
- 已发布版本数：614（近 12 个月 338 个）

## 中文简介

D-ID Agents的浏览器SDK:连接到一个代理,流出其视频和音频,聊天和说话.

## 安装

```sh
npm install @d-id/client-sdk
```

也可以使用：`pnpm add @d-id/client-sdk`、`yarn add @d-id/client-sdk`、`bun add @d-id/client-sdk`

## README

# D-ID 客户端 SDK

[![npm version](https://img.shields.io/npm/v/@d-id/client-sdk)](https://www.npmjs.com/package/@d-id/client-sdk) [![license](https://img.shields.io/npm/l/@d-id/client-sdk)](https://github.com/de-id/agents-sdk/blob/main/LICENSE) [![docs coverage](https://sdk.d-id.com/coverage.svg)](https://sdk.d-id.com/)

![D-ID Agents SDK](https://create-images-results.d-id.com/api_docs/assets/agents_sdk_cover_v2.png)

DID代理SDK嵌入了您在DID工作室或与代理API搭建的代理嵌入了网络应用程序. 创建一个 `AgentManager` 对于代理人, `connect()`,则 `chat()` 以自己的LLM或 `speak()` 让它说出你给它的一切 SDK打开了视频会话(WebRTC,或称LiveKit for Expressive 代理),保留了聊天记录并重试失败的连接.

**请注意:** 这个SDK的设计只用于前端开发. 代理人和知识库的建立应通过 [探员API](https://docs.d-id.com/docs/agent-quickstart) 或直接在 [DID 工作室](https://studio.d-id.com/agents)。 。 。 .

> **3.0版本是断开放出.** 从 2.x 升级? 读取 [移徙指南](https://sdk.d-id.com/documents/Migration_guide.html)。 。 。 .

## 安装

```shell
npm i @d-id/client-sdk
```

你需要身份和客户密钥 都来自探员家 `</> Embed` 片断 [D- ID Studio 代理画廊](https://studio.d-id.com/agents),这也是您列出该代理可能使用的域的地方 [开始](https://sdk.d-id.com/documents/Getting_started.html)。 。 。 .

## 快开始

```ts
import * as sdk from '@d-id/client-sdk';

const videoElement = document.getElementById('agent-video') as HTMLVideoElement;
const agentManager = await sdk.createAgentManager('agt_fumf1234', {
    auth: { type: 'key', clientKey: 'YOUR_CLIENT_KEY' },
    callbacks: {
        onSrcObjectReady: stream => (videoElement.srcObject = stream),
        onNewMessage: messages => console.log(messages[messages.length - 1]?.content),
    },
});

await agentManager.connect();
await agentManager.speak({ type: 'text', input: "Hi! I'm Alice!" });
await agentManager.chat('What is the distance to the moon?');

// Both resolve when the request is accepted, not when the agent has spoken.
window.addEventListener('beforeunload', () => void agentManager.disconnect());
```

## 今后的步骤

API 参考文献全文——每个版本上来源生成的每一种方法、回调、选项和类型——均在 **[sdk.d-id.com (中文(简体) )](https://sdk.d-id.com/)**开始 [`createAgentManager()`](https://sdk.d-id.com/functions/createAgentManager.html), (中文(简体) ), [`AgentManager`](https://sdk.d-id.com/interfaces/AgentManager.html), (中文(简体) ), [`AgentManagerCallbacks`](https://sdk.d-id.com/interfaces/AgentManagerCallbacks.html) 在会谈(V2)和Clips(V3)代理商方面, [`StreamOptions`](https://sdk.d-id.com/interfaces/StreamOptions.html)。 。 。 .

指南:

-   [开始](https://sdk.d-id.com/documents/Getting_started.html) - 证书,第一个连接, `chat()` 财务报告和审定财务报表 `speak()`断开.
-   [聊天模式](https://sdk.d-id.com/documents/Chat_modes.html) ——谈话,有脚本的演讲或闲聊,以及每个人在线上创造的东西.
-   [客户工具](https://sdk.d-id.com/documents/Client_tools.html) ——当代理的LLM调用时运行自己的功能.
-   [显式剂](https://sdk.d-id.com/documents/Expressive_agents.html) ——麦克风,相机,语音对文本,中断和数据通道信息.
-   [处理错误](https://sdk.d-id.com/documents/Handling_errors.html) 失败者拒绝,达到 `onError`记录什么.
-   [移徙指南](https://sdk.d-id.com/documents/Migration_guide.html) 从2.x到2.x的每一个突破变化.

Vanilla JavaScript和Vite的一个工作样本项目正在 [演示仓库](https://github.com/de-id/Agents-SDK-Demo)。 。 。 .

## 所需资源

-   **有WebRTC的现代浏览器.** SDK通过WebRTC(Talks and Clips)或LiveKit(Expressive)流出代理的视频,并使其成为一个 `<video>` 您提供的元素.
-   **无害环境管理和UMD建设.** `import` 决定采用ES模块; `require` (单位:千美元) `<script>` 标记解析到 UMD 捆绑 .
-   **包含类型脚本 .** 他们用包裹运送,没有单独的 `@types` 要安装.
-   **节点不是一个运行时间目标**,但是在服务器上导入软件包是安全的:模块图在导入时不会触碰浏览器全局,因此服务器发送的框架(Next.js, Remix, SvelteKit, Astro)可以评价. 一切过去 `createAgentManager()` 需要一个浏览器 .

## 神通类型

-   **会谈(V2)** ——采用WebRTC流媒体的以相片为主的介绍者.
-   **剪贴( V3)** ——采用WebRTC流线方式预建的演示人相声.
-   **表达式( V4)** ——下一代相机使用基于LiveKit的流线,支持麦克风输入并始终能流畅地进行.

## 支助

欢迎提出问题、错误报告和文件问题 [GitHub 问题](https://github.com/de-id/agents-sdk/issues). 产品文件生活在 [docs.d-id.com (中文(简体) )](https://docs.d-id.com/)。 。 。 .

## 常见问题

### @d-id/client-sdk 是什么？

D-ID Agents的浏览器SDK:连接到一个代理,流出其视频和音频,聊天和说话\.

### 如何安装 @d-id/client-sdk？

在项目目录运行 npm install @d-id/client-sdk，或使用 pnpm add / yarn add / bun add。

### @d-id/client-sdk 支持 TypeScript 吗？

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

### @d-id/client-sdk 支持 ESM 还是 CommonJS？

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

### @d-id/client-sdk 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=20。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @d-id/client-sdk 可以商用吗？

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

### @d-id/client-sdk 的下载量有多少？

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

### @d-id/client-sdk 还在维护吗？

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