程序包 io.agentscope.core.message

枚举类 GenerateReason

java.lang.Object
java.lang.Enum<GenerateReason>
io.agentscope.core.message.GenerateReason
所有已实现的接口:
Serializable, Comparable<GenerateReason>, Constable
public enum GenerateReason extends Enum<GenerateReason>
Represents the reason why a message was generated by an agent.

This enum helps users understand the context and state of agent execution when a message is returned. Different reasons indicate different follow-up actions that may be required.

Example usage: 


 Msg response = agent.call(userMsg).block();
 switch (response.getGenerateReason()) {
     case MODEL_STOP -> System.out.println("Task completed");
     case TOOL_SUSPENDED -> handleSuspendedTools(response);
     case REASONING_STOP_REQUESTED -> handleHumanReview(response);
     // ...
 }

  • 枚举常量详细资料

    • MODEL_STOP

      public static final GenerateReason MODEL_STOP
      Model stopped normally, task completed.

    • TOOL_CALLS

      public static final GenerateReason TOOL_CALLS
      Model returned tool calls (internal tools, framework will continue execution).

    • STRUCTURED_OUTPUT

      public static final GenerateReason STRUCTURED_OUTPUT
      Structured output completed.

    • TOOL_SUSPENDED

      public static final GenerateReason TOOL_SUSPENDED
      Tool execution was suspended, waiting for user to provide results.

    • REASONING_STOP_REQUESTED

      public static final GenerateReason REASONING_STOP_REQUESTED
      Reasoning phase was stopped by a Hook (PostReasoningEvent.stopAgent()).

    • ACTING_STOP_REQUESTED

      public static final GenerateReason ACTING_STOP_REQUESTED
      Acting phase was stopped by a Hook (PostActingEvent.stopAgent()).

    • PERMISSION_ASKING

      public static final GenerateReason PERMISSION_ASKING
      Permission engine is asking the user to confirm one or more tool calls.

      The returned Msg contains ToolUseBlocks with state=ASKING. The caller resumes by issuing a second agent.call(...) carrying ConfirmResults.

    • MIDDLEWARE_STOP_REQUESTED

      public static final GenerateReason MIDDLEWARE_STOP_REQUESTED
      A middleware requested the agent to pause via RequestStopEvent.

      The caller resumes by issuing a second agent.call() with no arguments — the agent picks up any pending tool calls and continues from where it stopped.

    • ALL_TOOLS_DENIED

      public static final GenerateReason ALL_TOOLS_DENIED
      All tool calls were denied by the user and a hook requested the agent to stop.

      Fired when every tool call from the most recent reasoning step was denied via HITL permission confirmation and an AllToolsDeniedEvent hook handler called stopAgent().

    • INTERRUPTED

      public static final GenerateReason INTERRUPTED
      Agent was interrupted.

    • MAX_ITERATIONS

      public static final GenerateReason MAX_ITERATIONS
      Maximum iterations reached.

  • 方法详细资料

    • values

      public static GenerateReason[] values()
      返回包含该枚举类的常量的数组， 顺序与声明这些常量的顺序相同
      返回:
      包含该枚举类的常量的数组，顺序与声明这些常量的顺序相同

    • valueOf

      public static GenerateReason valueOf(String name)
      返回带有指定名称的该类的枚举常量。 字符串必须与用于声明该类的枚举常量的 标识符完全匹配。（不允许有多余 的空格字符。）
      参数:
      name - 要返回的枚举常量的名称。
      返回:
      返回带有指定名称的枚举常量
      抛出:
      IllegalArgumentException - 如果该枚举类没有带有指定名称的常量
      NullPointerException - 如果参数为空值