功能域Functional domain

RAG 与知识库RAG & knowledge

从文档读取、切分、向量化到向量库检索与重排的完整链路，包含 Milvus/Qdrant/MongoDB/Elasticsearch 以及多种第三方 RAG 平台集成。The document-to-retrieval pipeline: readers, chunking, embeddings, vector stores, retrieval and third-party RAG integrations.

114类型总数types total

33Python

81Java

3学习锚点learning anchors

心智模型Mental model

知识库把文档切分、向量化、写入向量存储，并在查询时做召回与重排，最终把证据注入模型上下文。Knowledge bases chunk and embed documents, store vectors, retrieve and rerank at query time, then inject evidence into model context.

先学什么What to learn first

切分策略与 embedding 模型必须匹配，换模型要重建索引。Chunking strategy must match the embedding model; changing models requires re-indexing.
召回质量先看 chunk 元数据与过滤条件，再看重排模型。Debug recall through chunk metadata and filters before blaming the reranker.
回答要带来源引用，否则无法审计和纠错。Answers must carry source citations for auditability and correction.

生产常见坑Production pitfalls

文档更新后未删除旧向量，召回过期内容。Stale vectors remain after document updates and surface outdated facts.
把知识库检索放进每次对话的同步路径，首字延迟飙升。Synchronous retrieval on every turn destroys time-to-first-token.

进入对应闯关单元Practice this domain →

域内图谱Domain map

点击节点打开 API 页面；拖拽平移，滚轮缩放。Click a node to open its API page. Drag to pan, scroll to zoom.

Python API 集Python API set 33

归入本功能域的全部 Python 公开类型，按所属包分组。Every public Python type classified into this domain, grouped by owning package.

agentscope.rag22

`ApproxTokenChunker`	class	Approx 令牌切分器，把私有文档转化为可检索的知识。
`ApproxTokenChunker.Parameters`	class	参数，把私有文档转化为可检索的知识。
`Chunk`	class	分块，把私有文档转化为可检索的知识。
`ChunkerBase`	class	切分器基类，把私有文档转化为可检索的知识。
`ChunkerBase.Parameters`	class	参数，把私有文档转化为可检索的知识。
`DocumentSummary`	class	文档摘要，把私有文档转化为可检索的知识。
`ElasticsearchStore`	class	Elasticsearch 存储，负责持久化与读取数据。
`ExcelParser`	class	Excel 解析器，把私有文档转化为可检索的知识。
`ImageParser`	class	用于图像文件的解析器。
`KnowledgeBase`	class	文档知识库
`MilvusLiteStore`	class	Milvus Lite 存储，负责持久化与读取数据。
`MongoDBStore`	class	MongoDB 存储，负责持久化与读取数据。
`ParserBase`	class	解析器基类，把私有文档转化为可检索的知识。
`PDFParser`	class	用于PDF 文件的解析器。
`PPTParser`	class	用于PowerPoint`.pptx`文件的解析器。
`QdrantStore`	class	Qdrant 存储，负责持久化与读取数据。
`Section`	class	Section，把私有文档转化为可检索的知识。
`TextParser`	class	文本解析器，把私有文档转化为可检索的知识。
`VectorRecord`	class	向量记录，把私有文档转化为可检索的知识。
`VectorSearchResult`	class	向量搜索结果，把私有文档转化为可检索的知识。
`VectorStoreBase`	class	向量存储基类，把私有文档转化为可检索的知识。
`WordParser`	class	Word 解析器，把私有文档转化为可检索的知识。

agentscope.app.rag11

`AsyncReadable`	class	异步可读，把私有文档转化为可检索的知识。
`BlobStoreBase`	class	二进制对象存储基类，把私有文档转化为可检索的知识。
`CollectionPerKbManager`	class	集合每个知识库管理器，把私有文档转化为可检索的知识。
`DimensionPolicy`	class	维度策略，把私有文档转化为可检索的知识。
`DimensionPolicyError`	class	维度策略错误，把私有文档转化为可检索的知识。
`DimensionPolicyKind`	class	维度策略种类，把私有文档转化为可检索的知识。
`KnowledgeBaseError`	class	知识库基类管理器错误的基类。
`KnowledgeBaseManagerBase`	class	知识库管理器基类，把私有文档转化为可检索的知识。
`KnowledgeBaseNotFoundError`	class	知识库未找到错误，把私有文档转化为可检索的知识。
`LocalBlobStore`	class	本地二进制对象存储，负责持久化与读取数据。
`S3BlobStore`	class	S 3 二进制对象存储，负责持久化与读取数据。

Java API 集Java API set 81

归入本功能域的全部 Java 公开类型，按包分组并标注构件。Every public Java type classified into this domain, grouped by package with its artifact.

io.agentscope.core.rag.reader17

`AbstractChunkingReader`	class	`agentscope-extensions-rag-simple`	抽象 Chunking 读取器，把私有文档转化为可检索的知识。
`Builder`	class	`agentscope-extensions-rag-simple`	构建器，用于构建并配置目标实例。
`ExternalApiReader`	class	`agentscope-extensions-rag-simple`	外部 API 读取器，把私有文档转化为可检索的知识。
`ImageReader`	class	`agentscope-extensions-rag-simple`	图像读取器，把私有文档转化为可检索的知识。
`InputType`	enum	`agentscope-extensions-rag-simple`	定义输入类型的枚举。
`PDFReader`	class	`agentscope-extensions-rag-simple`	PDF 读取器，把私有文档转化为可检索的知识。
`Reader`	interface	`agentscope-extensions-rag-simple`	定义读取器契约的接口。
`ReaderInput`	class	`agentscope-extensions-rag-simple`	读取器输入，把私有文档转化为可检索的知识。
`ReaderUtils`	class	`agentscope-extensions-rag-simple`	读取器 Utils，把私有文档转化为可检索的知识。
`RequestBuilder`	interface	`agentscope-extensions-rag-simple`	定义请求构建器契约的接口。
`ResponseParser`	interface	`agentscope-extensions-rag-simple`	定义响应解析器契约的接口。
`SplitStrategy`	enum	`agentscope-extensions-rag-simple`	定义已拆分 Strategy相关取值的枚举。
`TableFormat`	enum	`agentscope-extensions-rag-simple`	定义Table 格式相关取值的枚举。
`TextChunker`	class	`agentscope-extensions-rag-simple`	文本切分器，把私有文档转化为可检索的知识。
`TextReader`	class	`agentscope-extensions-rag-simple`	文本读取器，把私有文档转化为可检索的知识。
`TikaReader`	class	`agentscope-extensions-rag-simple`	Tika 读取器，把私有文档转化为可检索的知识。
`WordReader`	class	`agentscope-extensions-rag-simple`	Word 读取器，把私有文档转化为可检索的知识。

io.agentscope.core.rag.integration.dify13

`Builder`	class	`agentscope-extensions-rag-dify`	DifyKnowledge的构建器。
`Builder`	class	`agentscope-extensions-rag-dify`	DifyRAGConfig的构建器。
`Builder`	class	`agentscope-extensions-rag-dify`	MetadataFilter的构建器。
`Builder`	class	`agentscope-extensions-rag-dify`	MetadataFilterCondition的构建器。
`Builder`	class	`agentscope-extensions-rag-dify`	RerankConfig的构建器。
`DifyDocumentConverter`	class	`agentscope-extensions-rag-dify`	Dify 文档转换器，把私有文档转化为可检索的知识。
`DifyKnowledge`	class	`agentscope-extensions-rag-dify`	Dify 知识库，把私有文档转化为可检索的知识。
`DifyRAGClient`	class	`agentscope-extensions-rag-dify`	Dify RAG 客户端，封装与远端服务的连接和调用。
`DifyRAGConfig`	class	`agentscope-extensions-rag-dify`	Dify RAG 配置，保存相关配置项。
`MetadataFilter`	class	`agentscope-extensions-rag-dify`	元数据过滤器，把私有文档转化为可检索的知识。
`MetadataFilterCondition`	class	`agentscope-extensions-rag-dify`	元数据过滤 Condition，把私有文档转化为可检索的知识。
`RerankConfig`	class	`agentscope-extensions-rag-dify`	重排配置，保存相关配置项。
`RetrievalMode`	enum	`agentscope-extensions-rag-dify`	定义检索模式相关取值的枚举。

io.agentscope.core.rag.store12

`Builder`	class	`agentscope-extensions-rag-simple`	ElasticsearchStore的构建器。
`Builder`	class	`agentscope-extensions-rag-simple`	InMemoryStore的构建器。
`Builder`	class	`agentscope-extensions-rag-simple`	构建器，用于构建并配置目标实例。
`Builder`	class	`agentscope-extensions-rag-simple`	构建器，用于构建并配置目标实例。
`Builder`	class	`agentscope-extensions-rag-simple`	构建器，用于构建并配置目标实例。
`DistanceType`	enum	`agentscope-extensions-rag-simple`	定义Distance 类型的枚举。
`ElasticsearchStore`	class	`agentscope-extensions-rag-simple`	Elasticsearch 存储，负责持久化与读取数据。
`InMemoryStore`	class	`agentscope-extensions-rag-simple`	In 记忆存储，负责持久化与读取数据。
`MilvusStore`	class	`agentscope-extensions-rag-simple`	Milvus 存储，负责持久化与读取数据。
`PgVectorStore`	class	`agentscope-extensions-rag-simple`	Pg 向量存储，负责持久化与读取数据。
`QdrantStore`	class	`agentscope-extensions-rag-simple`	Qdrant 存储，负责持久化与读取数据。
`VDBStoreBase`	interface	`agentscope-extensions-rag-simple`	定义 VDB 存储基类契约的接口。

io.agentscope.core.rag.integration.bailian11

`BailianClient`	class	`agentscope-extensions-rag-bailian`	Bailian 客户端，封装与远端服务的连接和调用。
`BailianConfig`	class	`agentscope-extensions-rag-bailian`	Bailian 配置，保存相关配置项。
`BailianDocumentConverter`	class	`agentscope-extensions-rag-bailian`	Bailian 文档转换器，把私有文档转化为可检索的知识。
`BailianKnowledge`	class	`agentscope-extensions-rag-bailian`	Bailian 知识库，把私有文档转化为可检索的知识。
`Builder`	class	`agentscope-extensions-rag-bailian`	BailianConfig的构建器。
`Builder`	class	`agentscope-extensions-rag-bailian`	BailianKnowledge的构建器。
`Builder`	class	`agentscope-extensions-rag-bailian`	RerankConfig的构建器。
`Builder`	class	`agentscope-extensions-rag-bailian`	RewriteConfig的构建器。
`QueryHistoryEntry`	class	`agentscope-extensions-rag-bailian`	查询历史条目，把私有文档转化为可检索的知识。
`RerankConfig`	class	`agentscope-extensions-rag-bailian`	重排配置，保存相关配置项。
`RewriteConfig`	class	`agentscope-extensions-rag-bailian`	Rewrite 配置，保存相关配置项。

io.agentscope.core.rag.integration.haystack7

`Builder`	class	`agentscope-extensions-rag-haystack`	构建器，用于构建并配置目标实例。
`Builder`	class	`agentscope-extensions-rag-haystack`	构建器，用于构建并配置目标实例。
`FilterPolicy`	enum	`agentscope-extensions-rag-haystack`	定义过滤策略相关取值的枚举。
`HayStackClient`	class	`agentscope-extensions-rag-haystack`	Hay Stack 客户端，封装与远端服务的连接和调用。
`HayStackConfig`	class	`agentscope-extensions-rag-haystack`	Hay Stack 配置，保存相关配置项。
`HayStackDocumentConverter`	class	`agentscope-extensions-rag-haystack`	Hay Stack 文档转换器，把私有文档转化为可检索的知识。
`HayStackKnowledge`	class	`agentscope-extensions-rag-haystack`	Hay Stack 知识库，把私有文档转化为可检索的知识。

io.agentscope.core.rag.integration.ragflow6

`Builder`	class	`agentscope-extensions-rag-ragflow`	构建器，用于构建并配置目标实例。
`Builder`	class	`agentscope-extensions-rag-ragflow`	构建器，用于构建并配置目标实例。
`RAGFlowClient`	class	`agentscope-extensions-rag-ragflow`	用于RAGFlow API的HTTP 客户端。
`RAGFlowConfig`	class	`agentscope-extensions-rag-ragflow`	RAG Flow 配置，保存相关配置项。
`RAGFlowDocumentConverter`	class	`agentscope-extensions-rag-ragflow`	RAG Flow 文档转换器，把私有文档转化为可检索的知识。
`RAGFlowKnowledge`	class	`agentscope-extensions-rag-ragflow`	RAG Flow 知识库，把私有文档转化为可检索的知识。

io.agentscope.core.rag4

`GenericRAGHook`	class	`agentscope-core`	泛型 RAG 钩子，把私有文档转化为可检索的知识。
`Knowledge`	interface	`agentscope-core`	定义知识库契约的接口。
`KnowledgeRetrievalTools`	class	`agentscope-core`	知识库检索工具，封装可被智能体调用的能力。
`RAGMode`	enum	`agentscope-core`	定义RAG 模式相关取值的枚举。

io.agentscope.core.rag.exception2

`ReaderException`	class	`agentscope-extensions-rag-simple`	读取器异常，表示执行过程中的错误。
`VectorStoreException`	class	`agentscope-extensions-rag-simple`	向量存储异常，表示执行过程中的错误。

io.agentscope.core.rag.integration.dify.exception2

`DifyApiException`	class	`agentscope-extensions-rag-dify`	Dify API 异常，表示执行过程中的错误。
`DifyAuthException`	class	`agentscope-extensions-rag-dify`	Dify 认证异常，表示执行过程中的错误。

io.agentscope.core.rag.integration.ragflow.exception2

`RAGFlowApiException`	class	`agentscope-extensions-rag-ragflow`	RAG Flow API 异常，表示执行过程中的错误。
`RAGFlowAuthException`	class	`agentscope-extensions-rag-ragflow`	RAG Flow 认证异常，表示执行过程中的错误。

io.agentscope.core.rag.knowledge2

`Builder`	class	`agentscope-extensions-rag-simple`	SimpleKnowledge的构建器。
`SimpleKnowledge`	class	`agentscope-extensions-rag-simple`	开箱即用的知识库实现

io.agentscope.core.rag.store.dto2

`SearchDocumentDto`	class	`agentscope-extensions-rag-simple`	搜索文档 Dto，把私有文档转化为可检索的知识。
`SearchDocumentDtoBuilder`	class	`agentscope-extensions-rag-simple`	用于SearchDocument DTO的构建器类。

io.agentscope.core.rag.integration.haystack.exception1

HayStackApiException class agentscope-extensions-rag-haystack Hay Stack API 异常，表示执行过程中的错误。

Python ↔ Java 对照Python ↔ Java

Python

KnowledgeBaseVectorStoreBaseMilvusLiteStoreQdrantStoreChunk

Java

SimpleKnowledgeKnowledgeInMemoryStoreDocumentRetrieveConfig

两套实现共享同一概念模型，但在并发（async/await 与 Reactor）、打包（wheel 模块与 Maven 构件）和生命周期 API 上存在差异。需要精确签名时请使用 API 全景。The two implementations follow the same conceptual model but differ in concurrency (async/await vs Reactor), packaging (wheel modules vs Maven artifacts) and lifecycle APIs. Use the full API map to locate exact signatures.

打开 API 全景Open full API map →