AS AgentScopeAPI 手册 / API Reference

Builder

public static final class Builder
源码Source io/agentscope/harness/agent/memory/MemoryConfig.java:231–364

构建器,用于构建并配置目标实例。位于 io.agentscope.harness.agent.memory 包。核心成员包括 model、flushPrompt、consolidationPrompt、consolidationMaxTokens、consolidationMinGap、dailyFileRetentionDays。

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

方法摘要Method Summary

方法Method说明Description
public Builder model(Model model)
设置模型。
Sets a dedicated model for memory operations (flush + consolidation), allowing a lighter/cheaper model than the agent's primary reasoning model.
public Builder model(String modelId)
设置模型。
Sets a dedicated model for memory operations by model id string (e.g.
public Builder flushPrompt(String flushPrompt)
设置刷新提示词。
Overrides the prompt used by `MemoryFlushManager#flushMemories`.
public Builder consolidationPrompt(String consolidationPrompt)
设置该配置项。
Overrides the prompt used by `MemoryConsolidator#consolidate`.
public Builder consolidationMaxTokens(int consolidationMaxTokens)
设置该配置项。
Token budget passed to the consolidation prompt.
public Builder consolidationMinGap(Duration consolidationMinGap)
设置该配置项。
Minimum gap between consolidation/maintenance runs.
public Builder dailyFileRetentionDays(int dailyFileRetentionDays)
设置该配置项。
Days before a daily ledger is moved to `memory/archive/`.
public Builder sessionRetentionDays(int sessionRetentionDays)
设置该配置项。
Days before a session JSONL log is pruned.
public Builder flushTrigger(FlushTrigger flushTrigger)
设置该配置项。
Trigger policy for the per-call flush hook.
public MemoryConfig build()
构建并返回最终实例。
Creates and returns an instance.

方法详情Method Detail

model

public Builder model(Model model)

设置模型。

Sets a dedicated model for memory operations (flush + consolidation), allowing a lighter/cheaper model than the agent's primary reasoning model.

参数Parameters
名称Name类型Type说明Description
modelModel模型实例(类型 `Model`)。The model.
返回Returns Builder
返回当前实例,以支持链式调用。Returns the current instance for chaining.
源码Source io/agentscope/harness/agent/memory/MemoryConfig.java:247–250

model

public Builder model(String modelId)

设置模型。

Sets a dedicated model for memory operations by model id string (e.g.

另见See also @see ModelRegistry#resolve(String)
参数Parameters
名称Name类型Type说明Description
modelIdString模型标识(类型 `String`)。The model id.
返回Returns Builder
返回当前实例,以支持链式调用。Returns the current instance for chaining.
源码Source io/agentscope/harness/agent/memory/MemoryConfig.java:258–261

flushPrompt

public Builder flushPrompt(String flushPrompt)

设置刷新提示词。

Overrides the prompt used by MemoryFlushManager#flushMemories.

参数Parameters
名称Name类型Type说明Description
flushPromptString刷新提示词(类型 `String`)。The flush prompt.
返回Returns Builder
返回当前实例,以支持链式调用。Returns the current instance for chaining.
源码Source io/agentscope/harness/agent/memory/MemoryConfig.java:268–271

consolidationPrompt

public Builder consolidationPrompt(String consolidationPrompt)

设置该配置项。

Overrides the prompt used by MemoryConsolidator#consolidate.

参数Parameters
名称Name类型Type说明Description
consolidationPromptStringconsolidation 提示词(类型 `String`)。The consolidation prompt.
返回Returns Builder
返回当前实例,以支持链式调用。Returns the current instance for chaining.
抛出Throws
  • IllegalArgumentException 可能抛出 `IllegalArgumentException`。if the prompt does not contain exactly two `%d` placeholders
源码Source io/agentscope/harness/agent/memory/MemoryConfig.java:282–294

consolidationMaxTokens

public Builder consolidationMaxTokens(int consolidationMaxTokens)

设置该配置项。

Token budget passed to the consolidation prompt.

参数Parameters
名称Name类型Type说明Description
consolidationMaxTokensintconsolidation 最大令牌数(类型 `int`)。The consolidation max tokens.
返回Returns Builder
返回当前实例,以支持链式调用。Returns the current instance for chaining.
源码Source io/agentscope/harness/agent/memory/MemoryConfig.java:297–304

consolidationMinGap

public Builder consolidationMinGap(Duration consolidationMinGap)

设置该配置项。

Minimum gap between consolidation/maintenance runs.

参数Parameters
名称Name类型Type说明Description
consolidationMinGapDurationconsolidation 最小 Gap(类型 `Duration`)。The consolidation min gap.
返回Returns Builder
返回当前实例,以支持链式调用。Returns the current instance for chaining.
源码Source io/agentscope/harness/agent/memory/MemoryConfig.java:311–320

dailyFileRetentionDays

public Builder dailyFileRetentionDays(int dailyFileRetentionDays)

设置该配置项。

Days before a daily ledger is moved to memory/archive/.

参数Parameters
名称Name类型Type说明Description
dailyFileRetentionDaysintdaily 文件 Retention Days(类型 `int`)。The daily file retention days.
返回Returns Builder
返回当前实例,以支持链式调用。Returns the current instance for chaining.
源码Source io/agentscope/harness/agent/memory/MemoryConfig.java:323–330

sessionRetentionDays

public Builder sessionRetentionDays(int sessionRetentionDays)

设置该配置项。

Days before a session JSONL log is pruned.

参数Parameters
名称Name类型Type说明Description
sessionRetentionDaysint会话 Retention Days(类型 `int`)。The session retention days.
返回Returns Builder
返回当前实例,以支持链式调用。Returns the current instance for chaining.
源码Source io/agentscope/harness/agent/memory/MemoryConfig.java:333–340

flushTrigger

public Builder flushTrigger(FlushTrigger flushTrigger)

设置该配置项。

Trigger policy for the per-call flush hook.

参数Parameters
名称Name类型Type说明Description
flushTriggerFlushTrigger刷新 Trigger(类型 `FlushTrigger`)。The flush trigger.
返回Returns Builder
返回当前实例,以支持链式调用。Returns the current instance for chaining.
源码Source io/agentscope/harness/agent/memory/MemoryConfig.java:343–349

build

public MemoryConfig build()

构建并返回最终实例。

Creates and returns an instance.

返回Returns MemoryConfig
返回MemoryConfig。Returns memory config.
源码Source io/agentscope/harness/agent/memory/MemoryConfig.java:351–353
基于官方固定版本源码静态生成Generated from pinned official sources · Python 2.0.11 · Java 2.0.4
签名与文档为静态抽取;如有疑问请以源码为准。Signatures and docs are extracted statically; verify against the source when in doubt.