D-ID 客户端 SDK
DID代理SDK嵌入了您在DID工作室或与代理API搭建的代理嵌入了网络应用程序. 创建一个 AgentManager 对于代理人, connect(),则 chat() 以自己的LLM或 speak() 让它说出你给它的一切 SDK打开了视频会话(WebRTC,或称LiveKit for Expressive 代理),保留了聊天记录并重试失败的连接.
请注意: 这个SDK的设计只用于前端开发. 代理人和知识库的建立应通过 探员API 或直接在 DID 工作室。 。 。 .
3.0版本是断开放出. 从 2.x 升级? 读取 移徙指南。 。 。 .
安装
npm i @d-id/client-sdk
你需要身份和客户密钥 都来自探员家 </> Embed 片断 D- ID Studio 代理画廊,这也是您列出该代理可能使用的域的地方 开始。 。 。 .
快开始
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 (中文(简体) )开始 createAgentManager(), (中文(简体) ), AgentManager, (中文(简体) ), AgentManagerCallbacks 在会谈(V2)和Clips(V3)代理商方面, StreamOptions。 。 。 .
指南:
- 开始 - 证书,第一个连接,
chat()财务报告和审定财务报表speak()断开. - 聊天模式 ——谈话,有脚本的演讲或闲聊,以及每个人在线上创造的东西.
- 客户工具 ——当代理的LLM调用时运行自己的功能.
- 显式剂 ——麦克风,相机,语音对文本,中断和数据通道信息.
- 处理错误 失败者拒绝,达到
onError记录什么. - 移徙指南 从2.x到2.x的每一个突破变化.
Vanilla JavaScript和Vite的一个工作样本项目正在 演示仓库。 。 。 .
所需资源
- 有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 问题. 产品文件生活在 docs.d-id.com (中文(简体) )。 。 。 .