ConversationalAIAPI 类

用于通过声网的 RTC 和 RTM 服务管理对话式 AI 引擎交互的类。

信息

自 1.7.0 版本新增。

chat

TypeScript

public async chat(agentUserId: string, message: IChatMessageText | IChatMessageImage)

向对话式智能体发送聊天消息。

信息

自 1.7.0 版本新增。

示例代码

TypeScript

// Send an image message
const imageMessage: IChatMessageImage = {
  messageType: EChatMessageType.IMAGE,
  imageData: urlImageData
};
await api.chat("user123", imageMessage);

参数

参数	数据类型	描述
agentUserId	string	智能体的唯一标识符。
message	IChatMessageText | IChatMessageImage	要发送的聊天消息，类型为 IChatMessageImage，详见 IChatMessageImage。

返回值

方法调用成功，返回一个 Promise，表示消息发送结果。

getInstance

TypeScript

public static getInstance()

获取 ConversationalAIAPI 的单例实例。

信息

自 1.6.0 版本新增。

该方法确保在整个应用程序生命周期中只存在一个 ConversationalAIAPI 实例。调用前必须先执行 init 方法进行初始化，否则会抛出异常。

返回值

方法调用成功，返回 ConversationalAIAPI 实例。

init

TypeScript

public static init(cfg: IConversationalAIAPIConfig)

初始化 ConversationalAIAPI 单例实例。

信息

自 1.6.0 版本新增。

该方法用于设置 RTC 和 RTM 引擎、渲染模式以及日志选项。必须在调用 ConversationalAIAPI 的其他方法之前调用此方法。

• 同一时间只能初始化一个实例。
• 如果已初始化，将抛出错误

参数

参数	数据类型	描述
cfg	IConversationalAIAPIConfig	用于初始化 API 的配置对象，详见 IConversationalAIAPIConfig。

返回值

方法调用成功，返回初始化后的 ConversationalAIAPI 实例。

subscribeMessage

TypeScript

public subscribeMessage(channel: string)

订阅消息频道以获取实时更新。

信息

自 1.6.0 版本新增。

该方法绑定必要的 RTC 和 RTM 事件，并启动 CovSubRenderController 以处理接收到的消息。

注意

• 使用此方法前必须调用 init。
• 如果未初始化将抛出错误。

参数

参数	数据类型	描述
channel	string	要订阅消息的频道名。

unsubscribe

TypeScript

public unsubscribe()

取消订阅消息频道并清理资源。

信息

自 1.6.0 版本新增。

该方法解绑 RTC 和 RTM 事件，清空频道，并清理 CovSubRenderController。

注意

• 使用此方法前必须调用 subscribeMessage。
• 如果未初始化将抛出错误。

destroy

TypeScript

public destroy(): void

销毁 ConversationalAIAPI 实例并清理资源。

信息

自 1.6.0 版本新增。

该方法会解绑所有 RTC 和 RTM 事件，清空频道场景，并清理 CovSubRenderController。

注意

• 使用该方法前必须调用 unsubscribe。
• 如果未初始化，则会抛出错误。

interrupt

TypeScript

public async interrupt(agentUserId: string)

向指定的智能体发送中断消息。

信息

自 1.6.0 版本新增。

注意

• 使用该方法前必须调用 init。
• 如果未初始化或发送失败，将抛出错误。

参数

参数	数据类型	描述
agentUserId	string	要中断的智能体的用户 ID。