AS AgentScopeAPI 手册 / API Reference

MemoryConfig

public final class MemoryConfig
源码Source io/agentscope/harness/agent/memory/MemoryConfig.java:52–365

记忆配置,保存相关配置项。位于 io.agentscope.harness.agent.memory 包。核心成员包括 model、flushPrompt、consolidationPrompt、consolidationMaxTokens、consolidationMinGap、dailyFileRetentionDays。

Unified configuration for the long-term memory pipeline (flush + consolidation + maintenance). Pair with CompactionConfig for the in-context summarization pipeline.

The harness has three LLM-driven memory operations, each with its own prompt and triggering rules:

  • Flush — extracts long-term memories from a conversation window into today's daily ledger (memory/YYYY-MM-DD.md). Prompt: #flushPrompt(), defaults to MemoryFlushManager#DEFAULT_FLUSH_PROMPT. Trigger: #flushTrigger().

  • Consolidation — periodically merges daily ledgers into the curated MEMORY.md. Prompt: #consolidationPrompt(), defaults to MemoryConsolidator#DEFAULT_CONSOLIDATION_PROMPT. Run cadence: #consolidationMinGap().

  • Compaction summary — distills the conversation prefix into one summary message before reasoning. Prompt lives on CompactionConfig#getSummaryPrompt(); configure via .compaction(CompactionConfig...) rather than here.

Flush and consolidation use independent throttle windows. A throttled policy allows the first eligible call immediately; its minimum gap applies only between subsequent runs and is not an initial delay. FlushTrigger#never() disables only the per-call flush.

All fields have sensible defaults; #defaults() returns a config equivalent to the harness's historical behavior so adopting this class is a no-op upgrade.

嵌套类摘要Nested Class Summary

类Class类型Kind说明Description
FlushMode枚举enum
定义刷新模式相关取值的枚举。
Strategy for the per-call flush hook.
FlushTrigger类class
刷新 Trigger,在多次调用之间保存和恢复会话与记忆数据。
Trigger policy for `io.agentscope.harness.agent.middleware.MemoryFlushMiddleware`.
Builder类class
构建器,用于构建并配置目标实例。
A class in io.agentscope.harness.agent.memory that persists and restores session and memory data across calls.

字段摘要Field Summary

字段Field类型Type说明Description
DEFAULT_CONSOLIDATION_MAX_TOKENS
staticfinal
int
默认 CONSOLIDATION 最大令牌数字段。
Default `consolidationMaxTokens`.
DEFAULT_CONSOLIDATION_MIN_GAP
staticfinal
Duration
默认 CONSOLIDATION 最小 GAP字段。
Default `consolidationMinGap` — matches `MemoryMaintenanceMiddleware`.
DEFAULT_DAILY_FILE_RETENTION_DAYS
staticfinal
int
默认 DAILY 文件 RETENTION DAYS字段。
Default retention before a daily ledger is archived.
DEFAULT_SESSION_RETENTION_DAYS
staticfinal
int
默认会话 RETENTION DAYS字段。
Default retention before a session JSONL log is pruned.

方法摘要Method Summary

方法Method说明Description
public Model model()
返回模型。
Optional model override for memory operations (flush + consolidation).
public String flushPrompt()
返回刷新提示词。
Override for the flush prompt.
public String consolidationPrompt()
返回 `consolidationPrompt` 结果。
Override for the consolidation prompt.
public int consolidationMaxTokens()
返回 `consolidationMaxTokens` 结果。
Returns the consolidation max tokens.
public Duration consolidationMinGap()
返回 `consolidationMinGap` 结果。
Minimum gap between consolidation/maintenance runs.
public int dailyFileRetentionDays()
返回 `dailyFileRetentionDays` 结果。
Returns the daily file retention days.
public int sessionRetentionDays()
返回 `sessionRetentionDays` 结果。
Returns the session retention days.
public FlushTrigger flushTrigger()
返回 `flushTrigger` 结果。
Returns the flush trigger.
public static MemoryConfig defaults()
static
返回 `defaults` 结果。
Returns a config equivalent to the harness's historical defaults.
public static Builder builder()
static
返回构建器实例。
Returns the builder.

字段详情Field Detail

DEFAULT_CONSOLIDATION_MAX_TOKENS

public static final int DEFAULT_CONSOLIDATION_MAX_TOKENS
staticfinal

默认 CONSOLIDATION 最大令牌数字段。声明为 public static final int DEFAULT_CONSOLIDATION_MAX_TOKENS。

Default consolidationMaxTokens.

源码Source io/agentscope/harness/agent/memory/MemoryConfig.java:55

DEFAULT_CONSOLIDATION_MIN_GAP

public static final Duration DEFAULT_CONSOLIDATION_MIN_GAP
staticfinal

默认 CONSOLIDATION 最小 GAP字段。声明为 public static final Duration DEFAULT_CONSOLIDATION_MIN_GAP。

Default consolidationMinGap — matches MemoryMaintenanceMiddleware.

源码Source io/agentscope/harness/agent/memory/MemoryConfig.java:58

DEFAULT_DAILY_FILE_RETENTION_DAYS

public static final int DEFAULT_DAILY_FILE_RETENTION_DAYS
staticfinal

默认 DAILY 文件 RETENTION DAYS字段。声明为 public static final int DEFAULT_DAILY_FILE_RETENTION_DAYS。

Default retention before a daily ledger is archived.

源码Source io/agentscope/harness/agent/memory/MemoryConfig.java:61

DEFAULT_SESSION_RETENTION_DAYS

public static final int DEFAULT_SESSION_RETENTION_DAYS
staticfinal

默认会话 RETENTION DAYS字段。声明为 public static final int DEFAULT_SESSION_RETENTION_DAYS。

Default retention before a session JSONL log is pruned.

源码Source io/agentscope/harness/agent/memory/MemoryConfig.java:64

方法详情Method Detail

model

public Model model()

返回模型。

Optional model override for memory operations (flush + consolidation).

返回Returns Model
返回模型。Returns model.
源码Source io/agentscope/harness/agent/memory/MemoryConfig.java:174–176

flushPrompt

public String flushPrompt()

返回刷新提示词。

Override for the flush prompt.

返回Returns String
返回字符串结果。Returns a string.
源码Source io/agentscope/harness/agent/memory/MemoryConfig.java:182–184

consolidationPrompt

public String consolidationPrompt()

返回 consolidationPrompt 结果。

Override for the consolidation prompt.

返回Returns String
返回字符串结果。Returns a string.
源码Source io/agentscope/harness/agent/memory/MemoryConfig.java:193–195

consolidationMaxTokens

public int consolidationMaxTokens()

返回 consolidationMaxTokens 结果。

Returns the consolidation max tokens.

返回Returns int
返回数值结果。Returns a numeric result.
源码Source io/agentscope/harness/agent/memory/MemoryConfig.java:197–199

consolidationMinGap

public Duration consolidationMinGap()

返回 consolidationMinGap 结果。

Minimum gap between consolidation/maintenance runs.

返回Returns Duration
返回时长。Returns duration.
源码Source io/agentscope/harness/agent/memory/MemoryConfig.java:206–208

dailyFileRetentionDays

public int dailyFileRetentionDays()

返回 dailyFileRetentionDays 结果。

Returns the daily file retention days.

返回Returns int
返回数值结果。Returns a numeric result.
源码Source io/agentscope/harness/agent/memory/MemoryConfig.java:210–212

sessionRetentionDays

public int sessionRetentionDays()

返回 sessionRetentionDays 结果。

Returns the session retention days.

返回Returns int
返回数值结果。Returns a numeric result.
源码Source io/agentscope/harness/agent/memory/MemoryConfig.java:214–216

flushTrigger

public FlushTrigger flushTrigger()

返回 flushTrigger 结果。

Returns the flush trigger.

返回Returns FlushTrigger
返回FlushTrigger。Returns flush trigger.
源码Source io/agentscope/harness/agent/memory/MemoryConfig.java:218–220

defaults

public static MemoryConfig defaults()
static

返回 defaults 结果。

Returns a config equivalent to the harness's historical defaults.

返回Returns MemoryConfig
返回MemoryConfig。Returns memory config.
源码Source io/agentscope/harness/agent/memory/MemoryConfig.java:223–225

builder

public static Builder builder()
static

返回构建器实例。

Returns the builder.

返回Returns Builder
返回当前实例,以支持链式调用。Returns the current instance for chaining.
源码Source io/agentscope/harness/agent/memory/MemoryConfig.java:227–229

嵌套类详情Nested Class Detail

FlushMode

public enum FlushMode

定义刷新模式相关取值的枚举。位于 io.agentscope.harness.agent.memory 包。核心成员包括 ALWAYS、NEVER、THROTTLED。

Strategy for the per-call flush hook. See FlushTrigger.

FlushTrigger

public static final class FlushTrigger

刷新 Trigger,在多次调用之间保存和恢复会话与记忆数据。位于 io.agentscope.harness.agent.memory 包。核心成员包括 always、never、throttled、mode、minGap、equals。

Trigger policy for io.agentscope.harness.agent.middleware.MemoryFlushMiddleware.

A throttled trigger allows the first eligible call immediately. Its minimum gap is measured between subsequent per-call flushes, independently of consolidation maintenance. #never() disables only this per-call flush path.

throttled(Duration.ZERO) normalises to #always() so callers do not need a special branch for the degenerate case.

Builder

public static final class Builder

构建器,用于构建并配置目标实例。位于 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.

基于官方固定版本源码静态生成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.