类class io.agentscope.core.state 2.x

Builder

public static final class Builder

源码Source io/agentscope/core/state/AgentState.java:313–393

构建器，用于构建并配置目标实例。位于 io.agentscope.core.state 包。核心成员包括 sessionId、userId、summary、context、addMessage、replyId。

A class in io.agentscope.core.state that persists and restores session and memory data across calls. Declared in io.agentscope.core.state.

方法摘要Method Summary

方法Method	说明Description
`public` `Builder sessionId(String sessionId)`	设置会话标识。 Performs the session id operation.
`public` `Builder userId(String userId)`	设置用户标识。 Nullable; `null` = anonymous / single-tenant context.
`public` `Builder summary(String summary)`	设置摘要。 Performs the summary operation.
`public` `Builder context(List<Msg> context)`	设置上下文。 Performs the context operation.
`public` `Builder addMessage(Msg message)`	添加消息。 Adds the message.
`public` `Builder replyId(String replyId)`	设置回复标识。 Replies to the id.
`public` `Builder curIter(int curIter)`	设置当前迭代次数。 Performs the cur iter operation.
`public` `Builder shutdownInterrupted(boolean shutdownInterrupted)`	设置该配置项。 Performs the shutdown interrupted operation.
`public` `Builder permissionContext(PermissionContextState permissionContext)`	设置权限上下文。 Performs the permission context operation.
`public` `Builder toolContext(ToolContextState toolContext)`	设置工具上下文。 Performs the tool context operation.
`public` `Builder tasksContext(TaskContextState tasksContext)`	设置任务上下文。 Performs the tasks context operation.
`public` `Builder planModeContext(PlanModeContextState planModeContext)`	设置计划模式上下文。 Performs the plan mode context operation.
`public` `AgentState build()`	构建并返回最终实例。 Creates and returns an instance.

方法详情Method Detail

sessionId

public Builder sessionId(String sessionId)

设置会话标识。

Performs the session id operation.

参数Parameters

名称Name	类型Type	说明Description
`sessionId`	String	会话标识（类型 `String`）。The session id.

返回Returns Builder

返回当前实例，以支持链式调用。Returns the current instance for chaining.

源码Source io/agentscope/core/state/AgentState.java:328–331

userId

public Builder userId(String userId)

设置用户标识。

Nullable; null = anonymous / single-tenant context.

参数Parameters

名称Name	类型Type	说明Description
`userId`	String	用户标识（类型 `String`）。The user id.

返回Returns Builder

返回当前实例，以支持链式调用。Returns the current instance for chaining.

源码Source io/agentscope/core/state/AgentState.java:334–337

summary

public Builder summary(String summary)

设置摘要。

Performs the summary operation.

参数Parameters

名称Name	类型Type	说明Description
`summary`	String	摘要（类型 `String`）。The summary.

返回Returns Builder

返回当前实例，以支持链式调用。Returns the current instance for chaining.

源码Source io/agentscope/core/state/AgentState.java:339–342

context

public Builder context(List<Msg> context)

设置上下文。

Performs the context operation.

参数Parameters

名称Name	类型Type	说明Description
`context`	List<Msg>	上下文（类型 `List`）。The context.

返回Returns Builder

返回当前实例，以支持链式调用。Returns the current instance for chaining.

源码Source io/agentscope/core/state/AgentState.java:344–347

addMessage

public Builder addMessage(Msg message)

添加消息。

Adds the message.

参数Parameters

名称Name	类型Type	说明Description
`message`	Msg	消息（类型 `Msg`）。The message.

返回Returns Builder

返回当前实例，以支持链式调用。Returns the current instance for chaining.

源码Source io/agentscope/core/state/AgentState.java:349–353

replyId

public Builder replyId(String replyId)

设置回复标识。

Replies to the id.

参数Parameters

名称Name	类型Type	说明Description
`replyId`	String	回复标识（类型 `String`）。The reply id.

返回Returns Builder

返回当前实例，以支持链式调用。Returns the current instance for chaining.

源码Source io/agentscope/core/state/AgentState.java:355–358

curIter

public Builder curIter(int curIter)

设置当前迭代次数。

Performs the cur iter operation.

参数Parameters

名称Name	类型Type	说明Description
`curIter`	int	当前迭代次数（类型 `int`）。The cur iter.

返回Returns Builder

返回当前实例，以支持链式调用。Returns the current instance for chaining.

源码Source io/agentscope/core/state/AgentState.java:360–363

shutdownInterrupted

public Builder shutdownInterrupted(boolean shutdownInterrupted)

设置该配置项。

Performs the shutdown interrupted operation.

参数Parameters

名称Name	类型Type	说明Description
`shutdownInterrupted`	boolean	shutdown Interrupted（类型 `boolean`）。The shutdown interrupted.

返回Returns Builder

返回当前实例，以支持链式调用。Returns the current instance for chaining.

源码Source io/agentscope/core/state/AgentState.java:365–368

permissionContext

public Builder permissionContext(PermissionContextState permissionContext)

设置权限上下文。

Performs the permission context operation.

参数Parameters

名称Name	类型Type	说明Description
`permissionContext`	PermissionContextState	权限上下文（类型 `PermissionContextState`）。The permission context.

返回Returns Builder

返回当前实例，以支持链式调用。Returns the current instance for chaining.

源码Source io/agentscope/core/state/AgentState.java:370–373

toolContext

public Builder toolContext(ToolContextState toolContext)

设置工具上下文。

Performs the tool context operation.

参数Parameters

名称Name	类型Type	说明Description
`toolContext`	ToolContextState	工具上下文（类型 `ToolContextState`）。The tool context.

返回Returns Builder

返回当前实例，以支持链式调用。Returns the current instance for chaining.

源码Source io/agentscope/core/state/AgentState.java:375–378

tasksContext

public Builder tasksContext(TaskContextState tasksContext)

设置任务上下文。

Performs the tasks context operation.

参数Parameters

名称Name	类型Type	说明Description
`tasksContext`	TaskContextState	任务上下文（类型 `TaskContextState`）。The tasks context.

返回Returns Builder

返回当前实例，以支持链式调用。Returns the current instance for chaining.

源码Source io/agentscope/core/state/AgentState.java:380–383

planModeContext

public Builder planModeContext(PlanModeContextState planModeContext)

设置计划模式上下文。

Performs the plan mode context operation.

参数Parameters

名称Name	类型Type	说明Description
`planModeContext`	PlanModeContextState	计划模式上下文（类型 `PlanModeContextState`）。The plan mode context.

返回Returns Builder

返回当前实例，以支持链式调用。Returns the current instance for chaining.

源码Source io/agentscope/core/state/AgentState.java:385–388

build

public AgentState build()

构建并返回最终实例。

Creates and returns an instance.

返回Returns AgentState

返回AgentState。Returns agent state.

源码Source io/agentscope/core/state/AgentState.java:390–392