当前位置：首页 > news >正文

TencentDB Agent Memory文档生成工具：自动创建项目API与使用指南

news 2026/8/8 13:10:06

TencentDB Agent Memory文档生成工具：自动创建项目API与使用指南

【免费下载链接】TencentDB-Agent-MemoryTencentDB Agent Memory is a team-level memory hub for AI Agents — turning conversations, docs, and code into four reusable memory assets (Chat Memory, Skill, LLM-Wiki, Code-Graph) that are governed, shared, and equipped across agents and frameworks.项目地址: https://gitcode.com/GitHub_Trending/te/TencentDB-Agent-Memory

TencentDB Agent Memory是一款团队级AI Agent记忆中枢，能够将对话、文档和代码转化为四种可重用的记忆资产（聊天记忆、技能、LLM知识库、代码图谱），实现跨Agent和框架的治理、共享与赋能。本文将详细介绍如何利用其文档生成工具自动创建项目API与使用指南，帮助新手和普通用户快速上手。

🌟为什么选择TencentDB Agent Memory文档生成工具

TencentDB Agent Memory文档生成工具具有以下核心优势：

自动化程度高：无需手动编写大量文档，工具可自动从项目代码和配置中提取关键信息，生成清晰的API文档和使用指南。
结构化输出：生成的文档采用标准的Markdown格式，包含详细的目录、说明和示例，便于阅读和使用。
与项目紧密结合：能够识别项目中的核心功能模块，如内存分层架构、符号化记忆等，并将其融入文档中。

🧠TencentDB Agent Memory核心技术架构

TencentDB Agent Memory的架构基于两大支柱：内存分层和符号化记忆，这也是文档生成工具的重要依据。

内存分层：从原始日志到用户画像的语义金字塔

传统的内存系统将数据碎片化并存储在扁平的向量库中，而TencentDB Agent Memory采用分层架构，确保Agent不仅“记住更多”，还能“更好地推理”。

如上图所示，内存分层包括以下几个层次：

L0原始日志（Raw Log）：全量保留原始对话与事件流，确保原始信息不丢失，提供证据依据。
L1原子记忆（Atomic Memory）：自动提取事实、偏好、约束、状态，从语音中稳定抽出关键信息。
L2场景块（Scene Block）：按项目/主题/工作流场景聚类，带上文召回，减少单场误用。
L3用户画像（Persona）：稳定的用户偏好与服务方式画像，让Agent按用户习惯协作。

这种分层架构使得文档生成工具能够清晰地梳理各层的功能和API，为用户提供全面的使用指南。

符号化记忆：以最小符号承载最大语义

在长任务中，冗长的中间日志（搜索结果、代码、错误跟踪）是最大的令牌消耗者。TencentDB Agent Memory结合上下文卸载和符号化记忆来解决这一问题：

Mermaid符号图：使用高密度的Mermaid语法编码任务状态转换，既精确到LLM可解析，又简洁到人类可阅读。
历史卸载：完整的工具日志被卸载到外部文件，上下文只保留轻量级的Mermaid任务图。
node_id追踪：Agent基于符号图推理，需要验证细节时，通过node_id grep即可立即检索完整原始文本，在保留完整可追溯性的同时降低令牌成本。

🚀快速开始：安装与配置

环境准备

在使用文档生成工具之前，需要确保已安装TencentDB Agent Memory。以下是针对不同框架的安装方法：

OpenClaw框架

openclaw plugins install @tencentdb-agent-memory/memory-tencentdb openclaw gateway restart

升级插件：

openclaw plugins update @tencentdb-agent-memory/memory-tencentdb

默认使用本地SQLite + sqlite-vec后端，零配置启用：

// ~/.openclaw/openclaw.json { "memory-tencentdb": { "enabled": true } }

启用短期压缩（可选，需版本≥0.3.4）：

{ "memory-tencentdb": { "config": { "offload": { "enabled": true } } } }

Hermes框架

可以通过Docker快速部署或添加到现有Hermes安装中。

Docker部署（推荐，需版本≥0.3.4）：

MODEL_API_KEY="your-api-key" MODEL_BASE_URL="https://api.lkeap.cloud.tencent.com/v1" MODEL_NAME="deepseek-v3.2" MODEL_PROVIDER="custom" cd docker/opensource docker build -f Dockerfile.hermes -t hermes-memory . docker run -d \ --name hermes-memory \ --restart unless-stopped \ -p 8420:8420 \ -e MODEL_API_KEY="your-api-key" \ -e MODEL_BASE_URL="https://api.lkeap.cloud.tencent.com/v1" \ -e MODEL_NAME="deepseek-v3.2" \ -e MODEL_PROVIDER="custom" \ -v hermes_data:/opt/data \ hermes-memory

验证Gateway：

curl http://localhost:8420/health

文档生成工具使用步骤

安装文档生成依赖：
文档生成工具通常集成在项目的脚本中，确保已安装相关依赖：
```
npm install --omit=dev
```
运行文档生成命令：
在项目根目录下执行以下命令，自动生成API文档和使用指南：
```
# 示例命令，具体以项目实际脚本为准 node scripts/generate-docs.js
```
查看生成的文档：
生成的文档通常位于项目的docs目录下，使用Markdown格式，可直接用浏览器或Markdown编辑器打开查看。

📚API文档详解

文档生成工具会自动提取项目中的API信息，包括核心模块、函数定义、参数说明等。以下是一些关键API的示例：

内存存储相关API

存储后端工厂：src/core/store/factory.ts
用于创建不同类型的存储后端实例，如SQLite、TCVDB等。
BM25本地搜索：src/core/store/bm25-local.ts
提供基于BM25算法的本地搜索功能，支持关键词检索。

内存提取相关API

L1提取器：src/core/record/l1-extractor.ts
从原始对话中提取原子记忆（L1）。
场景提取器：src/core/scene/scene-extractor.ts
从原子记忆中提取场景块（L2）。

⚙️配置参数说明

文档生成工具会根据项目的配置文件自动生成参数说明，以下是一些常用的配置参数：

字段	默认值	描述
`timezone`	`"system"`	用户/LLM面向的时间戳时区：`"system"`（跟随进程时区）/ IANA名称（`Asia/Shanghai`）/ 偏移字符串（`+08:00`）
`storeBackend`	`"sqlite"`	存储后端：`sqlite`
`recall.strategy`	`"hybrid"`	召回策略：`keyword`/`embedding`/`hybrid`（RRF融合，推荐）
`recall.maxResults`	`5`	每次召回返回的项目数
`offload.enabled`	`false`	是否启用短期压缩