Enums Reference

Enums Reference

AgentCallbackType

Passive callback type, determines which events the SDK receives:

Enum ValueString ValueDescription
AUDIO_2_LLMaudio2llmAudio -> ASR+LLM
AUDIO_2_TTSaudio2ttsAudio -> ASR+LLM+TTS
ASR_2_LLMasr2llmText -> LLM
ASR_2_TTSasr2ttsText -> LLM+TTS
ASR_VIDEO_2_TTSasrVideo2ttsText+Video -> VLM+TTS
ASR_VIDEO_2_VLMasrVideo2vlmText+Video -> VLM
AUDIO_VIDEO_2_TTSaudioVideo2ttsAudio+Video -> VLM+TTS
AUDIO_VIDEO_2_VLMaudioVideo2vlmAudio+Video -> VLM
ILLEGALillegalInvalid type
java
AgentCallbackType type = AgentCallbackType.of("audio2tts"); // String to enum

Greeting signals, state pushes, face UID and video passthrough no longer use dedicated callback types. Override onGreetSignal / onState / onFaceInfo / onVideoFrame on any registered passive callback to receive them.

FlowMode

Task flow mode:

Enum ValueDescription
SIMPLESingle-step mode: startRequest carries the complete payload
COMPLEXMulti-step mode: start -> task x N -> end

RobotState

Robot online state:

Enum ValueDescription
ONLINERobot is online (triggers onRobotOnline)
OFFLINERobot is offline (triggers onRobotOffline)

AgentPolicy

Interaction policy (internal use, developers need not concern themselves with this):

Enum ValueDescription
PASSIVEPassive interaction (robot initiates)
ACTIVEActive interaction (SDK initiates)
TELEOPTeleop — new in v1.5.0; remote operator drives the robot (wire value "teleop")
EXT_SKILLExtSkill — new in v1.5.0; query and invoke robot extended skills (wire value "extskill")
SIGNALSignaling interaction

AgentEventType

WebSocket message event types (internal use). Key events:

Enum ValueEvent Type StringDescription
AGENTSDK_ROBOT_STATE_SYNCagentsdk.robot_state.syncRobot online/offline
AGENTSDK_AUDIO_REQUEST_STARTagentsdk.audio_request.startVAD start
AGENTSDK_AUDIO_REQUEST_APPENDagentsdk.audio_request.appendAudio frame
AGENTSDK_AUDIO_REQUEST_COMMITagentsdk.audio_request.commitVAD end
AGENTSDK_ASR_REQUEST_TEXTagentsdk.asr_request.textASR text input
AGENTSDK_TTS_REQUEST_TEXTagentsdk.tts_request.textTTS text input
AGENTSDK_SKILL_QUERY_RESPONSEagentsdk.skill_query.responseSkill query response
AGENTSDK_STATE_QUERY_RESPONSEagentsdk.state_query.responseState query response
AGENTSDK_STATE_REQUEST_METAagentsdk.state_request.metaState push notification
AGENTSDK_GREET_REQUEST_FACEagentsdk.greet_request.faceGreeting — face/UID signal
AGENTSDK_GREET_REQUEST_VIDEOagentsdk.greet_request.videoGreeting — video signal
AGENTSDK_GREET_REQUEST_SIGNALagentsdk.greet_request.signalGreeting — business signal
AGENTSDK_GREET_RESPONSE_VLM_DELTAagentsdk.greet_response.vlm.deltaGreeting VLM streaming chunk
AGENTSDK_GREET_RESPONSE_VLM_DONEagentsdk.greet_response.vlm.doneGreeting VLM finished
AGENTSDK_GREET_RESPONSE_TTS_DELTAagentsdk.greet_response.tts.deltaGreeting TTS streaming chunk
AGENTSDK_GREET_RESPONSE_TTS_DONEagentsdk.greet_response.tts.doneGreeting TTS finished
AGENTSDK_TELEOP_ENTERagentsdk.teleop.enterv1.5.0: teleop — enter
AGENTSDK_TELEOP_ENTER_ACKagentsdk.teleop.enter_ackv1.5.0: teleop — enter ack
AGENTSDK_TELEOP_AUDIO_STARTagentsdk.teleop_audio.startv1.5.0: teleop — audio segment start (may carry role / threshold)
AGENTSDK_TELEOP_AUDIO_DELTAagentsdk.teleop_audio.deltav1.5.0: teleop — audio delta (audio field is base64)
AGENTSDK_TELEOP_AUDIO_DONEagentsdk.teleop_audio.donev1.5.0: teleop — audio segment end
AGENTSDK_TELEOP_EXITagentsdk.teleop.exitv1.5.0: teleop — exit
AGENTSDK_TELEOP_EXIT_ACKagentsdk.teleop.exit_ackv1.5.0: teleop — exit ack
AGENTSDK_EXT_SKILL_QUERYagentsdk.ext_skill.queryv1.5.0: ext skill — query request
AGENTSDK_EXT_SKILL_QUERY_RESULTagentsdk.ext_skill.query_resultv1.5.0: ext skill — query result
AGENTSDK_EXT_SKILL_INVOKEagentsdk.ext_skill.invokev1.5.0: ext skill — invoke request
AGENTSDK_EXT_SKILL_INVOKE_ACKagentsdk.ext_skill.invoke_ackv1.5.0: ext skill — invoke acknowledgement
AGENTSDK_EXT_SKILL_REPORT_STATEagentsdk.ext_skill.report_statev1.5.0: ext skill — execution state report (gateway → SDK, triggers ExtSkillInvokeCallback.onState)
AGENTSDK_EXT_SKILL_INVOKE_RESULTagentsdk.ext_skill.invoke_resultv1.5.0: ext skill — invoke execution result
AGENTSDK_FUNCTION_CALL_EXPOSEagentsdk.function_call.exposev1.5.0: function call forwarded (gateway → SDK, triggers onFunctionCall)
AGENTSDK_FUNCTION_CALL_ARBITERagentsdk.function_call.arbiterv1.5.0: arbitration decision returned (SDK → gateway, emitted by onArbiter)
AGENTSDK_HISTORIES_EXPOSEagentsdk.histories.exposev1.5.0: conversation history forwarded (gateway → SDK, triggers onHistories)

ArbiterDecision

New in v1.5.0. Function-call arbitration decision enum (com.agibot.aiem.sdk.enums.ArbiterDecision), used as the decision argument of response.onArbiter(eventId, decision, arbParam).

Enumwire valueDescription
DELEGATEdelegateDelegate: let the agent's default pipeline handle the function call
OVERRIDEoverrideOverride: the application takes over, overriding the default behaviour
ILLEGALillegalIllegal / fallback value

See Passive Callbacks Guide · Function Call exposure & Arbiter for the interface and usage.