Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
agentscope-extensions-rag-dify 接入 Dify 的数据集（Dataset）API，复用 Dify 上已经维护的知识库。
<dependency>
<groupId>io.agentscope</groupId>
<artifactId>agentscope-extensions-rag-dify</artifactId>
<version>${agentscope.version}</version>
</dependency>
import io.agentscope.core.rag.integration.dify.DifyKnowledge;
import io.agentscope.core.rag.integration.dify.DifyRAGConfig;
import io.agentscope.core.rag.integration.dify.RetrievalMode;
import io.agentscope.core.rag.model.RetrieveConfig;
DifyRAGConfig config = DifyRAGConfig.builder()
.apiKey(System.getenv("DIFY_RAG_API_KEY"))
.datasetId("your-dataset-id")
.retrievalMode(RetrievalMode.HYBRID_SEARCH)
.enableRerank(true)
.build();
DifyKnowledge knowledge = DifyKnowledge.builder()
.config(config)
.build();
List<Document> hits = knowledge.retrieve(
"如何续费会员？",
RetrieveConfig.builder().limit(5).scoreThreshold(0.5).build()
).block();
RetrievalMode 决定 Dify 在数据集上的检索方式：
| 枚举 | 说明 |
|---|---|
KEYWORD_SEARCH | 仅关键词检索 |
SEMANTIC_SEARCH | 仅向量语义检索 |
HYBRID_SEARCH | 关键词 + 向量混合（推荐） |
FULL_TEXT_SEARCH | 全文检索 |
baseUrl 指过去：
DifyRAGConfig config = DifyRAGConfig.builder()
.apiKey("dataset-xxx")
.baseUrl("https://dify.mycompany.com")
.datasetId("ds-xxxx")
.retrievalMode(RetrievalMode.HYBRID_SEARCH)
.build();
MetadataFilter / MetadataFilterCondition 可以按 Dify 上配置的元数据字段过滤：
DifyRAGConfig config = DifyRAGConfig.builder()
.apiKey(apiKey)
.datasetId(datasetId)
.retrievalMode(RetrievalMode.HYBRID_SEARCH)
.metadataFilter(MetadataFilter.builder()
.conditions(List.of(
MetadataFilterCondition.builder()
.name("category").comparisonOperator("=")
.value(List.of("faq")).build()))
.logicalOperator("and")
.build())
.build();
addDocuments(...) 不可用——文档管理请去 Dify 控制台：登录 → 知识 → 选择数据集 → 上传文档 → 等待索引完成。这与 Bailian、HayStack、RAGFlow 保持一致。
| 字段 | 说明 |
|---|---|
apiKey | Dify 数据集 API Key（必填） |
datasetId | 数据集 ID（必填） |
baseUrl | 默认 https://api.dify.ai/v1，自托管时改为你的地址 |
retrievalMode | 见上表 |
enableRerank | 是否启用 rerank |
metadataFilter | 元数据过滤条件 |