通过阅读本文，您可以了解到DingRTC Web AIAgent SDK接口详情。
数据类型
类型 | 描述 | 支持的最低版本 |
AIAgent状态 | 3.9.0 | |
AIAgent透出消息结构体 | 3.9.0 |
接口列表
接口 | 描述 | 支持的最低版本 |
通知 agent 本端开始“按下说话”（push-to-talk) | 3.9.0 | |
通知 agent 本端结束“按下说话”（push-to-talk) | 3.9.0 | |
通知 agent 本端取消“按下说话”（push-to-talk) | 3.9.0 | |
打断 agent | 3.9.0 |
事件列表
DingRTC 全局事件
事件 | 回调类型 | 描述 | 版本 |
(messgae: AIAgentMessage) => void; | 智能体消息发布通知。 | 3.9.0 | |
(newStatus: AgentStatus) => void | 智能体状态通知。 | 3.9.0 |
数据类型
AgentStatus
智能体当前所处的状态，类型：string (enum-like)
指 | 描述 | 版本 |
'listening' | 智能体正在监听用户输入。 | 3.9.0 |
'thinking' | 智能体正在思考。 | 3.9.0 |
'responding' | 智能体正在发送响应。 | 3.9.0 |
AIAgentMessage
AIAgent 透出消息结构
属性 | 类型 | 描述 | 版本 |
message | Uint8Array | 消息载体 | 3.9.0 |
uid | string | 发布人的uid | 3.9.0 |
reasoning | boolean | 是否为推理过程 | 3.9.0 |
userType | 'user' | 'agent' | 发布人类型 | 3.9.0 |
end | boolean | 当前句子是否结束，用来实现分句 | 3.9.0 |
extra | string | 插播消息自定义内容 | 3.9.0 |
接口详情
startPushToTalk()
通知 agent 本端开始“按下说话”（push-to-talk)。
类型签名
startPushToTalk():void;返回
void
stopPushToTalk()
通知 agent 本端结束“按下说话”（push-to-talk)。
类型签名
stopPushToTalk(): void;
返回
void
cancelPushToTalk()
通知 agent 本端取消“按下说话”（push-to-talk)。
类型签名
cancelPushToTalk(): void;返回
void
interrupt()
打断 agent。
类型签名
interrupt(): void;返回
void
事件详情
"message"
收到远端发布消息
类型签名
'message': (message: AIAgentMessage) => void;示例
rtm.on('message', (message) => {
console.log(message);
});"agent-status"
收到智能体状态
类型签名
'agent-status': (agentStatus: AgentStatus) => void;示例
rtm.on('agent-status', (status) => {
console.log(status);
});