ConversationalAIAPI 类

interrupt

Objective-C

@objc func interrupt(agentUserId: String, completion: @escaping (ConversationalAIAPIError?) -> Void)

中断智能体当前正在进行的语音或任务处理。

使用该方法可以中断当前正在说话或处理任务的 智能体。

注意

• 如果 error 有值，表示消息发送失败。
• 如果 error 为 nil，表示消息发送成功，但不保证智能体成功被中断。

参数

参数	数据类型	描述
agentUserId	String	智能体的 RTM 用户 ID，必须全局唯一。
completion	(ConversationalAIAPIError?) -> Void	操作完成时的回调函数。你可以通过该回调的 error 参数得知操作的结果或错误信息，详见 ConversationalAIAPIError。

loadAudioSettings[1/2]

Objective-C

@objc func loadAudioSettings()

设置音频最佳实践参数以获得最佳性能。

设置用于智能体对话中实现最佳性能所需的音频参数。默认使用 .aiClient 音频场景。

示例代码：

Swift

// 在加入频道前设置音频最佳实践参数
api.loadAudioSettings()  // 使用默认场景

// 然后加入频道
rtcEngine.joinChannel(byToken: token, channelId: channelName, info: nil, uid: userId)

注意

重要：如果你需要启用音频最佳实践，必须在每次调用 joinChannel 之前调用此方法。

loadAudioSettings[2/2]

Objective-C

@objc func loadAudioSettings(secnario: AgoraAudioScenario)

设置特定场景下的音频最佳实践参数。

你可以通过此方法配置在智能体对话中实现最佳性能所需的音频参数。

注意

如果你需要启用音频最佳实践，必须在每次调用 joinChannel 之前调用此方法。

参数

参数	数据类型	描述

subscribeMessage

Objective-C

@objc func subscribeMessage(channelName: String, completion: @escaping (ConversationalAIAPIError?) -> Void)

订阅频道消息。

设置频道参数并注册消息订阅回调。该方法在频道发生变化时调用，通常在智能体启动时被调用。

参数

参数	数据类型	描述
channelName	String	要订阅的频道名。
completion	(ConversationalAIAPIError?) -> Void	订阅失败时返回错误信息的回调，详见 ConversationalAIAPIError。

unsubscribeMessage

Objective-C

@objc func unsubscribeMessage(channelName: String, completion: @escaping (ConversationalAIAPIError?) -> Void)

取消订阅频道消息。

调用该方法可停止接收指定频道的消息，适用于与智能体断开连接的场景。

参数

参数	数据类型	描述
channelName	String	要取消订阅的频道名。
completion	(ConversationalAIAPIError?) -> Void	取消订阅操作完成后的回调。你可以通过该回调获取错误信息，详见 ConversationalAIAPIError。

addHandler

Objective-C

@objc func addHandler(handler: ConversationalAIAPIEventHandler)

添加事件处理器以接收回调。

你可以注册一个代理，用于接收会话事件、状态变更以及其他通知。

参数

参数	数据类型	描述
handler	ConversationalAIAPIEventHandler	事件处理器，需实现 ConversationalAIAPIEventHandler 协议。详见 ConversationalAIAPIEventHandler。

removeHandler

Objective-C

@objc func removeHandler(handler: ConversationalAIAPIEventHandler)

移除事件处理器。

参数

参数	数据类型	描述
handler	ConversationalAIAPIEventHandler	要移除的事件处理器。详见 ConversationalAIAPIEventHandler。

destroy

Objective-C

@objc func destroy()

销毁 API 实例并释放所有资源。

调用该方法可销毁当前 API 实例并释放所有资源。调用后，该实例将无法再次使用。请在不再需要使用 destroy 方法所属的 API 时调用此方法。