Passive Callback & Response API
Passive Callback & Response API
Callback / Response mapping
| Callback | Response | onRequest signature |
|---|---|---|
Audio2LlmCallback | Audio2LlmResponse | (agentId, eventId, flag, buf, param, response) |
Audio2TtsCallback | Audio2TtsResponse | (agentId, eventId, itemId, flag, buf, param, response) |
Asr2LlmCallback | Asr2LlmResponse | (agentId, eventId, text, param, response) |
Asr2TtsCallback | Asr2TtsResponse | (agentId, eventId, text, param, response) |
AsrVideo2VlmCallback | AsrVideo2VlmResponse | (agentId, eventId, flag, text, video, param, response) |
AsrVideo2TtsCallback | AsrVideo2TtsResponse | (agentId, eventId, flag, text, video, param, response) |
AudioVideo2VlmCallback | AudioVideo2VlmResponse | (agentId, eventId, flag, data, param, response) |
AudioVideo2TtsCallback | AudioVideo2TtsResponse | (agentId, eventId, flag, data, param, response) |
Response capability matrix
| Response | ASR | LLM | VLM | TTS | Skill | Interrupt |
|---|---|---|---|---|---|---|
| Audio2LlmResponse | ✓ | ✓ | ✓ | ✓ | ||
| Audio2TtsResponse | ✓ | ✓ | ✓ | ✓ | ✓ | |
| Asr2LlmResponse | ✓ | ✓ | ✓ | |||
| Asr2TtsResponse | ✓ | ✓ | ✓ | ✓ | ||
| AsrVideo2VlmResponse | ✓ | ✓ | ✓ | |||
| AsrVideo2TtsResponse | ✓ | ✓ | ✓ | ✓ | ||
| AudioVideo2VlmResponse | ✓ | ✓ | ✓ | ✓ | ||
| AudioVideo2TtsResponse | ✓ | ✓ | ✓ | ✓ | ✓ |
Every response supports onError(eventId, errorCode, errorMsg).
Function Call & Arbiter (new in v1.5.0)
⚠️ Not yet released: in-development v1.5.0-SNAPSHOT capability; interface and protocol may change. Do not use in production before the official release.
v1.5.0 adds Function Call dispatch and Arbiter arbitration on the passive interaction path; the interface is woven into the existing 8 callback / response classes. See Passive Callbacks Guide · Function Call exposure & Arbiter for the workflow.
Callback method (on all 8 callback classes)
public void onFunctionCall(String agentId, String eventId, FunctionCallInfo functionCall, <XxxResponse> response)
Default no-op; override to receive a function call forwarded by the gateway. <XxxResponse> is the response type for that callback class.
FunctionCallInfo (com.agibot.aiem.sdk.FunctionCallInfo)
| Field | Type | Description |
|---|---|---|
source | String | function call source |
policy | String | handling policy identifier |
type | String | function call type |
value | String | main value |
param | Map<String, Object> | extra parameters |
Response method (on all 8 Response classes)
public void onArbiter(String eventId, String decision, AgentParam arbParam)
Returns the arbitration decision; the SDK emits agentsdk.function_call.arbiter. decision comes from ArbiterDecision:
Enum (com.agibot.aiem.sdk.enums.ArbiterDecision) | wire value | Meaning |
|---|---|---|
DELEGATE | delegate | delegate to the agent's default pipeline |
OVERRIDE | override | the application takes over, overriding the default behaviour |
Event types
agentsdk.function_call.expose (gateway → SDK, triggers onFunctionCall) / agentsdk.function_call.arbiter (SDK → gateway, emitted by onArbiter). See the enums reference.
Shared base methods (PassiveCallback)
Every callback class extends PassiveCallback. The following methods may be overridden as needed
(they have safe no-op log defaults):
| Method | Trigger |
|---|---|
onRobotOnline(agentId, agentMeta) | Robot online |
onRobotOffline(agentId) | Robot offline |
onFaceInfo(agentId, eventId, param) | Face / voiceprint UID detected (opened in v1.4.0) |
onVideoFrame(agentId, eventId, flag, buf, isKeyFrame, localTs, param) | Video passthrough (flag=2 H264, flag=3 image) |
onGreetSignal(agentId, eventId, param, GreetResponse response) | Greeting signal (merged in v1.4.0) |
onState(agentId, eventId, stateName, stateValue) | Robot state push (merged in v1.4.0); see robot-side state modules for the full catalogue |
onHistories(agentId, eventId, List<HistoryInfo> histories) | Conversation history push (new in v1.5.0); HistoryInfo fields below |
HistoryInfo (com.agibot.aiem.sdk.HistoryInfo, v1.5.0)
| Field | Type | Description |
|---|---|---|
timestamp | long | timestamp, for sorting |
query | String | user-side input |
answer | String | agent-side reply |
complete | boolean | whether this turn finished completely |
eventId | String | corresponding session event ID, for de-duplication |
GreetResponse methods
| Method | Description |
|---|---|
onGreetVlmDelta(eventId, text) | VLM streaming chunk |
onGreetVlmDone(eventId) | VLM streaming finished |
onGreetTtsDelta(eventId, audioBase64) | TTS audio chunk — audioBase64 is the base64-encoded chunk of synthesised audio bytes |
onGreetTtsDone(eventId) | TTS audio stream finished |
onError(eventId, code, msg) | Error reply |