Package com.alibaba.cloud.ai.graph.agent.hook.hip

Class HumanInTheLoopHook

java.lang.Object

com.alibaba.cloud.ai.graph.agent.hook.ModelHook

com.alibaba.cloud.ai.graph.agent.hook.hip.HumanInTheLoopHook

All Implemented Interfaces:

AsyncNodeActionWithConfig, InterruptableAction, Hook, Prioritized, BiFunction<OverAllState,RunnableConfig,CompletableFuture<Map<String,Object>>>

public class HumanInTheLoopHook
extends ModelHook
implements AsyncNodeActionWithConfig, InterruptableAction

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	HumanInTheLoopHook.Builder

Nested classes/interfaces inherited from interface com.alibaba.cloud.ai.graph.action.AsyncNodeActionWithConfig

AsyncNodeActionWithConfig.InterruptableAsyncNodeActionWrapper

Field Summary

Fields

Modifier and Type	Field	Description
static final String	HITL_NODE_NAME

Fields inherited from interface com.alibaba.cloud.ai.graph.agent.Prioritized

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Method Summary

Modifier and Type	Method	Description
CompletableFuture<Map<String,Object>>	afterModel(OverAllState state, RunnableConfig config)
CompletableFuture<Map<String,Object>>	apply(OverAllState state, RunnableConfig config)
static HumanInTheLoopHook.Builder	builder()
List<JumpTo>	canJumpTo()	Gets the list of allowed jump destinations for this hook.
String	getName()	Gets the unique name of this hook.
Optional<InterruptionMetadata>	interrupt(String nodeId, OverAllState state, RunnableConfig config)

Methods inherited from class com.alibaba.cloud.ai.graph.agent.hook.ModelHook

beforeModel, getAgent, getAgentName, getOrder, setAgent, setAgentName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.function.BiFunction

andThen

Methods inherited from interface com.alibaba.cloud.ai.graph.agent.hook.Hook

getHookPositions, getKeyStrategys, getModelInterceptors, getToolInterceptors, getTools

Methods inherited from interface com.alibaba.cloud.ai.graph.action.InterruptableAction

interruptAfter

Field Details

HITL_NODE_NAME

public static final String HITL_NODE_NAME

See Also:

• Constant Field Values

Method Details

builder

public static HumanInTheLoopHook.Builder builder()

apply

public CompletableFuture<Map<String,Object>> apply(OverAllState state,
 RunnableConfig config)

Specified by:

apply in interface AsyncNodeActionWithConfig

Specified by:

apply in interface BiFunction<OverAllState,RunnableConfig,CompletableFuture<Map<String,Object>>>

afterModel

public CompletableFuture<Map<String,Object>> afterModel(OverAllState state,
 RunnableConfig config)

Overrides:

afterModel in class ModelHook

interrupt

public Optional<InterruptionMetadata> interrupt(String nodeId,
 OverAllState state,
 RunnableConfig config)

Specified by:

interrupt in interface InterruptableAction

getName

public String getName()

Description copied from interface: Hook

Gets the unique name of this hook. The name is used to identify the hook in the execution graph.

Specified by:

getName in interface Hook

Returns:

the hook name, must not be null

canJumpTo

public List<JumpTo> canJumpTo()

Description copied from interface: Hook

Gets the list of allowed jump destinations for this hook.

Hooks can control the flow of execution by specifying where the agent can jump to after the hook executes. This allows hooks to redirect the execution flow based on their logic.

Common jump destinations include:

• JumpTo.model: Jump to model node
• JumpTo.tool: Jump to tool node
• JumpTo.end: Jump to end (terminate agent)

Specified by:

canJumpTo in interface Hook

Returns:

list of allowed jump destinations, empty list by default

See Also:

• JumpTo