AgentSdk API 参考

AgentSdk API 参考

创建与获取

java
// 创建实例(单例:同一appId返回同一实例)
AgentSdk agentSdk = AgentSdk.create(url, appId, appKey, appSecret);

// 获取已创建的实例
AgentSdk agentSdk = AgentSdk.get(appId);

// 获取所有已注册的appId列表
List<String> appIds = AgentSdk.listAppIds();
方法返回值说明
create(url, appId, appKey, appSecret)AgentSdk创建或获取实例
get(appId)AgentSdk / null获取已创建实例
listAppIds()List<String>所有已注册appId

生命周期

java
agentSdk.initialize();  // 建立WebSocket连接
agentSdk.release();     // 关闭连接,释放所有资源
方法说明
initialize()建立 WebSocket 连接(触发认证、重连)
release()关闭连接、清理回调、清理缓存、停止重连

认证回调

java
agentSdk.registerAuth(AgentAuthCallback callback);
java
public interface AgentAuthCallback {
    void onAuthState(String appId, int code, String msg);
}

被动交互回调注册

重要:必须在 initialize() 之前注册。每个 SDK 实例只能注册一种被动回调类型。

方法回调类型场景
registerAudio2Llm(cb)Audio2LlmCallback音频→ASR+LLM
registerAudio2Tts(cb)Audio2TtsCallback音频→ASR+LLM+TTS
registerAsr2Llm(cb)Asr2LlmCallback文本→LLM
registerAsr2Tts(cb)Asr2TtsCallback文本→LLM+TTS
registerAsrVideo2Vlm(cb)AsrVideo2VlmCallback文本+视频→VLM
registerAsrVideo2Tts(cb)AsrVideo2TtsCallback文本+视频→VLM+TTS
registerAudioVideo2Vlm(cb)AudioVideo2VlmCallback音频+视频→VLM
registerAudioVideo2Tts(cb)AudioVideo2TtsCallback音频+视频→VLM+TTS

v1.4.0 变更

  • registerStateListen(...) 已移除,状态推送统一通过 PassiveCallback.onState(...) 接收。
  • 打招呼信令在 PassiveCallback.onGreetSignal(...) 中重载即可,无需单独注册。
  • 已从 SDK 移除:被动回调 Audio2Asr / Audio2Audio / AudioVideo2Audio / Text2Tts(类已删除), 主动接口 querySkill / queryState / registerPullStream / registerPushListen(注册方法已删除,底层类暂保留)。

详见 被动回调指南

主动交互

任务流

java
// 注册任务流
agentSdk.registerTaskFlow(TaskFlowRequest taskFlowRequest);

// 取消注册
agentSdk.unregisterTaskFlow(String flowId);

任务流的完整生命周期参见 主动交互指南 - 任务流

辅助方法

方法返回值说明
getAgentCallbackType(agentId)AgentCallbackType获取 agent 绑定的回调类型
getAgentMeta(agentId)AgentMeta获取 agent 元数据
getRobotCallback(callbackType)PassiveCallback获取已注册的回调实例
getAppId()String获取当前实例 appId
getUrl()String获取连接地址