ConversationalAIAPIEventHandler 类

onMessageError

Swift

@objc func onMessageError(agentUserId: String, error: MessageError)

消息处理发生错误时触发的回调。

该回调在消息处理过程中发生错误时被触发。例如，当发送聊天消息失败时，会返回错误信息。

参数

参数	数据类型	描述
agentUserId	String	智能体的 RTM 用户 ID。
error	MessageError	消息错误对象，包含错误类型和错误信息。详见 MessageError。

onMessageReceiptUpdated

Swift

@objc func onMessageReceiptUpdated(agentUserId: String, messageReceipt: MessageReceipt)

图像消息信息更新回调。

该回调在会话中处理图像时被触发，用于提供图像的元数据。

参数

参数	数据类型	描述
agentUserId	String	智能体的 RTM 用户 ID。
messageReceipt	MessageReceipt	消息回执，包含类型、模块和图像信息。详见 MessageReceipt。

onAgentStateChanged

Swift

@objc func onAgentStateChanged(agentUserId: String, event: StateChangeEvent)

智能体代理状态发生变化回调。

该回调在智能体状态发生变化时触发，例如从空闲切换为静音、聆听、思考或说话状态。你可以使用该回调更新用户界面或跟踪对话流程。

参数

参数	数据类型	描述
agentUserId	String	代理的 RTM 用户 ID。
event	StateChangeEvent	智能体状态变更事件，包含状态、轮次 ID、时间戳和原因。详见 StateChangeEvent。

onAgentInterrupted

Swift

@objc func onAgentInterrupted(agentUserId: String, event: InterruptEvent)

中断事件发生时触发的回调。

注意

该回调不一定与 agent 的状态同步，因此不建议在该回调中处理业务逻辑。

参数

参数	数据类型	描述
agentUserId	String	智能体的 RTM 用户 ID。
event	InterruptEvent	中断事件，包含轮次 ID 和时间戳，详见 InterruptEvent。

onAgentMetrics

Swift

@objc func onAgentMetrics(agentUserId: String, metrics: Metric)

性能指标可用时触发的回调。

该回调提供性能数据，例如 LLM 推理延迟和 TTS 语音合成延迟，用于监测系统性能。

注意

该性能指标回调不一定与 agent 的状态同步，因此不建议在此回调中处理业务逻辑。

参数

参数	数据类型	描述
agentUserId	String	智能体的 RTM 用户 ID。
metrics	Metric	性能指标，包含类型、数值和时间戳。详见 Metric。

onAgentError

Swift

@objc func onAgentError(agentUserId: String, error: ModuleError)

AI 模块发生错误时的回调。

当模块组件（如 LLM、TTS 等）发生错误时，会调用该回调。可用于错误监控、日志记录以及实现服务降级策略。

注意

该回调不一定与智能体的状态同步，因此不建议在该回调中处理业务逻辑。

参数

参数	数据类型	描述
agentUserId	String	智能体的 RTM 用户 ID。
error	ModuleError	模块错误，包含类型、错误码、错误信息和时间戳。详见 ModuleError。

onTranscriptionUpdated

Swift

@objc func onTranscriptionUpdated(agentUserId: String, transcription: Transcription)

转写内容更新回调。

该回调在会话中的语音转写内容发生更新时触发。

参数

参数	数据类型	描述
agentUserId	String	智能体的 RTM 用户 ID。
transcription	Transcription	转写数据，包含文本内容、状态和元数据。详见 Transcription。