IConversationalAIAPI 类
chat
Kotlin
fun chat(agentUserId: String, message: ChatMessage, completion: (error: ConversationalAIAPIError?) -> Unit)
向智能体发送消息。
支持通过 ChatMessage
密封类层级发送不同类型的消息:
ImageMessage
:用于发送图片消息。
参数
参数 | 数据类型 | 描述 |
---|---|---|
agentUserId | String | 智能体用户 ID。 |
message | ChatMessage | 消息对象,类型为 ImageMessage 。详见 ChatMessage 。 |
completion | (error: ConversationalAIAPIError?) -> Unit | 回调函数。调用成功时 error 为 null,失败时为非 null。 |
addHandler
Kotlin
fun addHandler(handler: IConversationalAIAPIEventHandler)
注册事件处理器,用于接收智能体会话事件。
参数
参数 | 数据类型 | 描述 |
---|---|---|
handler | IConversationalAIAPIEventHandler | 事件处理器实例,详见 IConversationalAIAPIEventHandler 。 |
removeHandler
Kotlin
fun removeHandler(handler: IConversationalAIAPIEventHandler)
移除已注册的事件处理器。
参数
参数 | 数据类型 | 描述 |
---|---|---|
handler | IConversationalAIAPIEventHandler | 事件处理器实例,详见 IConversationalAIAPIEventHandler 。 |
subscribeMessage
Kotlin
fun subscribeMessage(channelName: String, completion: (error: ConversationalAIAPIError?) -> Unit)
订阅频道以接收智能体对话事件。
参数
参数 | 数据类型 | 描述 |
---|---|---|
channelName | String | 频道名。 |
completion | (error: ConversationalAIAPIError?) -> Unit | 回调函数。调用成功时,error 为 null;调用失败时,error 为非 null。详见 ConversationalAIAPIError 。 |
unsubscribeMessage
Kotlin
fun unsubscribeMessage(channelName: String, completion: (error: ConversationalAIAPIError?) -> Unit)
取消订阅频道名,并停止接收事件。
参数
参数 | 数据类型 | 描述 |
---|---|---|
channelName | String | 频道名。 |
completion | (error: ConversationalAIAPIError?) -> Unit | 异步通知取消订阅结果的回调。成功时 error 为 null,失败时为非 null,详见 ConversationalAIAPIError 。 |
interrupt
Kotlin
fun interrupt(agentUserId: String, completion: (error: ConversationalAIAPIError?) -> Unit)
中断智能体的发言。
参数
参数 | 数据类型 | 描述 |
---|---|---|
agentUserId | String | 智能体用户 ID。 |
completion | (error: ConversationalAIAPIError?) -> Unit | 异步回调函数。调用成功时,error 为 null;调用失败时,error 为非 null,包含错误信息,详见 ConversationalAIAPIError 。 |
loadAudioSettings
Kotlin
fun loadAudioSettings(scenario: Int = Constants.AUDIO_SCENARIO_AI_CLIENT)
设置音频参数以优化智能体对话性能。
注意
你必须在每次调用 joinChannel
之前调用此方法,以确保最佳音频质量。
参数
参数 | 数据类型 | 描述 |
---|---|---|
scenario | Int | 音频场景,默认值为
注意 如果启用数字人功能,请将场景设置为 |
destroy
Kotlin
fun destroy()
销毁 API
实例并释放资源。
调用该方法释放所有资源。调用后,该实例将无法再次使用。建议在不再需要该实例时调用该方法。