程序包 io.agentscope.core.message

Enum Class 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);
     // ...
 }
 

嵌套类概要

从类继承的嵌套类/接口 java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

枚举常量概要

枚举常量

枚举常量	说明
ACTING_STOP_REQUESTED	Acting phase was stopped by a Hook (PostActingEvent.stopAgent()).
INTERRUPTED	Agent was interrupted.
MAX_ITERATIONS	Maximum iterations reached.
MODEL_STOP	Model stopped normally, task completed.
REASONING_STOP_REQUESTED	Reasoning phase was stopped by a Hook (PostReasoningEvent.stopAgent()).
STRUCTURED_OUTPUT	Structured output completed.
TOOL_CALLS	Model returned tool calls (internal tools, framework will continue execution).
TOOL_SUSPENDED	Tool execution was suspended, waiting for user to provide results.

方法概要

修饰符和类型	方法	说明
static GenerateReason	valueOf(String name)	Returns the enum constant of this class with the specified name.
static GenerateReason[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

从类继承的方法 java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

从类继承的方法 java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

枚举常量详细资料

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()).

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()

Returns an array containing the constants of this enum class, in the order they are declared.

返回:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static GenerateReason valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

参数:

name - 要返回的枚举常量的名称。

返回:

返回带有指定名称的枚举常量

抛出:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - 如果参数为空值