AIMA开放平台文档中心Agent SDK (Java)

LinkSoul AgentSDK for Java v1.5.0-SNAPSHOT

LinkSoul AgentSDK for Java v1.5.0-SNAPSHOT

🆕 v1.5.0 新增：超视距遥操（Teleop）/ Beyond-line-of-sight teleoperation

v1.5.0 在既有的被动交互 / 主动交互两条路径之外，新增第三条能力线 —— 超视距遥操（Teleop）：远端操作员通过 SDK 端下发 enter → startAudio / appendAudioDelta / doneAudio* → exit 语音接管指令，目标机器人在线执行。

  • 核心请求类：TeleopRequest（enter / startAudio(AgentParam) / appendAudioDelta / doneAudio / exit）
  • 回调基类：TeleopEnterCallback.onEnterAck(...) / TeleopExitCallback.onExitAck(...)（code=0 成功、code=1000 表示 SDK 侧连接已 closed、code=-1 服务端拒绝）
  • 注册：AgentSdk.registerTeleop(TeleopRequest) / AgentSdk.unregisterTeleop(String teleopId)
  • 事件类型 7 个：agentsdk.teleop.enter / agentsdk.teleop.enter_ack / agentsdk.teleop_audio.start|delta|done / agentsdk.teleop.exit / agentsdk.teleop.exit_ack，共享策略枚举 AgentPolicy.TELEOP
  • ID 前缀：teleop_...（IdGenerator.generateTeleopId()）
  • startAudio(AgentParam) 可携带 role（man / woman）、threshold（-14 ~ 14）等遥操音色 / 灵敏度参数

完整用法见 超视距遥操指南（zh） / Teleop guide (en)、 Teleop API（zh） / Teleop API (en)、 Teleop 示例（zh） / Teleop example (en)。

v1.5.0 introduces a third interaction mode, teleop (beyond-line-of-sight teleoperation), on top of the existing passive / active paths. A remote operator drives the robot via TeleopRequest.enter → startAudio(AgentParam) → appendAudioDelta* → doneAudio → exit; the enter/exit legs are ack'd through TeleopEnterCallback / TeleopExitCallback, while audio.* messages are fire-and-forget. See the guide / API / example links above for the full flow.

⚠️ 验签方式标准化（不兼容 v1.3.0 及更早版本）/ Breaking auth change

v1.4.0 已遵循灵心开放平台规范，对 SDK 的鉴权（验签）方式做了标准化改造，v1.3.0 及更早版本无法直接平滑升级（v1.5.0 保持与 v1.4.0 相同的鉴权体系）：

项目v1.3.0 及更早v1.4.0
网关 URLwss://agentsdk.agibot.com/v1/agentsdkwss://open.agibot.com/api/V1/open-portal/app/wss/agent-sdk
凭证来源灵心平台「二开智能体模板」灵心开放平台「应用」（新增 appKey）
创建方法AgentSdk.create(url, appId, appSecret)AgentSdk.create(url, appId, appKey, appSecret)
鉴权机制JWT（AGIBOT_AUTHORIZATION 请求头）HMAC-SHA256（5 个请求头：X-App-Id / X-App-Key / X-Timestamp / X-Nonce / X-Signature）
回调类型JWT payload独立请求头 X-Callback-Types（JSON 数组字符串）

升级路径见 zh/CHANGELOG.md / en/CHANGELOG.md。

v1.4.0 standardises the AgentSDK signing scheme to match the LinkSoul open-platform spec and is NOT backward compatible with v1.3.0 or earlier. JWT auth (one AGIBOT_AUTHORIZATION header) is replaced by HMAC-SHA256 with five signed request headers (X-App-Id / X-App-Key / X-Timestamp / X-Nonce / X-Signature); AgentSdk.create() gains a new appKey parameter, credentials are issued by the open-platform application page, and the gateway URL has changed. See the CHANGELOGs above for the full migration path.

选择语种 / Choose locale

语种 / Locale入口
简体中文zh/index.md
Englishen/index.md
Section中文English
Home / 首页zh/index.mden/index.md
Quick Start / 快速开始zh/guide/quickstart.mden/guide/quickstart.md
Architecture / 架构zh/guide/architecture.mden/guide/architecture.md
Passive guide / 被动交互zh/guide/passive_callbacks.mden/guide/passive_callbacks.md
Active guide / 主动交互zh/guide/active_operations.mden/guide/active_operations.md
Teleop guide / 超视距遥操zh/guide/teleop.mden/guide/teleop.md
Task-flow payload / 任务流协议zh/guide/taskflow_payload.mden/guide/taskflow_payload.md
Semantic skills / 语义技能zh/guide/skills.mden/guide/skills.md
Error handling / 错误处理zh/guide/error_handling.mden/guide/error_handling.md
AgentSdk APIzh/api/agent_sdk.mden/api/agent_sdk.md
Passive callbacks APIzh/api/passive_callbacks.mden/api/passive_callbacks.md
Active requests APIzh/api/active_requests.mden/api/active_requests.md
Teleop API / 超视距遥操zh/api/teleop.mden/api/teleop.md
Enumszh/api/enums.mden/api/enums.md
Passive examples / 被动示例zh/examples/passive_examples.mden/examples/passive_examples.md
Active examples / 主动示例zh/examples/active_examples.mden/examples/active_examples.md
Teleop examples / 超视距遥操示例zh/examples/teleop_examples.mden/examples/teleop_examples.md
Glossary / 名词解释zh/glossary.mden/glossary.md
Changelogzh/CHANGELOG.mden/CHANGELOG.md

跨语言对照 / Cross-language counterparts

同版本号的 Python SDK 文档 与本套接口等价。 The Python SDK docs at the same version expose an equivalent API surface.