feat(eval): 添加知识库评估功能及相关文档
新增知识库评估功能，支持对 Milvus 类型知识库进行 RAG 系统评估 - 添加评估基准管理功能，支持手动上传和自动生成基准 - 实现评估指标计算和结果展示 - 更新文档添加评估功能说明 - 优化界面交互，增加类型不支持时的提示
This commit is contained in:
Wenjie Zhang
parent
e6cfb16429
commit
d435b49c97
@ -34,7 +34,8 @@ export default defineConfig({
|
||||
{ text: '什么是 Yuxi-Know？', link: '/latest/intro/project-overview' },
|
||||
{ text: '快速开始', link: '/latest/intro/quick-start' },
|
||||
{ text: '模型配置', link: '/latest/intro/model-config' },
|
||||
{ text: '知识库与知识图谱', link: '/latest/intro/knowledge-base' }
|
||||
{ text: '知识库与知识图谱', link: '/latest/intro/knowledge-base' },
|
||||
{ text: '知识库评估', link: '/latest/intro/evaluation' }
|
||||
]
|
||||
},
|
||||
{
|
||||
|
||||
131
docs/latest/intro/evaluation.md
Normal file
131
docs/latest/intro/evaluation.md
Normal file
@ -0,0 +1,131 @@
|
||||
# 知识库评估
|
||||
|
||||
Yuxi-Know 提供了完整的 RAG 系统评估解决方案，帮助您科学地衡量知识库的检索质量和答案准确性。评估系统通过标准化的基准测试、多维度的指标计算和直观的结果展示，让您能够全面了解系统性能并持续优化。
|
||||
|
||||
> **注意**：目前评估功能仅支持 Milvus 类型的知识库。
|
||||
|
||||
## 评估基准
|
||||
|
||||
评估基准是衡量知识库性能的标准数据集，包含了测试问题、相关的黄金文档块 ID 和标准答案。系统支持两种创建评估基准的方式。
|
||||
|
||||
### 手动上传评估基准
|
||||
|
||||
您可以通过上传 JSONL 格式的文件创建评估基准。每行代表一个测试样本，必须包含 `query` 字段（查询问题），可选地包含 `gold_chunk_ids`（黄金文档块 ID 列表）和 `gold_answer`（标准答案）。
|
||||
|
||||
- 当基准包含黄金文档块 ID 时，系统会计算检索指标（如 Recall@K、F1@K）
|
||||
- 当基准包含标准答案时，系统会使用 LLM 作为评判者评估生成答案的准确性
|
||||
- 同时包含两者时，系统会进行全面的检索和生成质量评估
|
||||
|
||||
#### JSONL 文件格式示例
|
||||
|
||||
```json
|
||||
{"query": "什么是人工智能？", "gold_chunk_ids": ["chunk_001", "chunk_002"], "gold_answer": "人工智能是计算机科学的一个分支，致力于创建能够执行通常需要人类智能的任务的系统。"}
|
||||
{"query": "机器学习的主要类型有哪些？", "gold_chunk_ids": ["chunk_005"], "gold_answer": "机器学习主要包括监督学习、无监督学习和强化学习三种主要类型。"}
|
||||
{"query": "深度学习的应用领域", "gold_chunk_ids": ["chunk_010", "chunk_011", "chunk_012"]}
|
||||
```
|
||||
|
||||
每行一个独立的 JSON 对象，包含以下字段：
|
||||
- `query`（必需）：查询问题
|
||||
- `gold_chunk_ids`（可选）：黄金文档块 ID 列表
|
||||
- `gold_answer`（可选）：标准答案
|
||||
|
||||
### 自动生成评估基准
|
||||
|
||||
系统可以根据知识库内容自动生成评估基准。生成过程包括：
|
||||
|
||||
1. **随机采样**：从知识库中随机选择文档块作为基础材料
|
||||
2. **相似度计算**：使用指定的嵌入模型计算文档块间的相似度，选取相似文档作为上下文
|
||||
3. **问题生成**：使用 LLM 基于采样到的文档生成相关查询问题和标准答案
|
||||
4. **质量保证**：确保生成的问题能由提供的上下文准确回答，且黄金文档块 ID 与上下文匹配
|
||||
|
||||
生成参数说明：
|
||||
- **问题数量**：控制生成的问题总数（1-100）
|
||||
- **相似 chunks 数量**：每个问题关联的相似文档块数量（0-10）
|
||||
- **LLM 模型**：用于生成问题和答案的语言模型
|
||||
- **Embedding 模型**：用于计算文档相似度的嵌入模型
|
||||
- **Temperature**：控制生成内容的随机性（0-2）
|
||||
- **Max Tokens**：限制生成内容的最大长度
|
||||
|
||||
## 评估指标
|
||||
|
||||
系统提供多维度的评估指标，全面衡量 RAG 系统的性能。
|
||||
|
||||
### 检索评估指标
|
||||
|
||||
当基准包含黄金文档块 ID 时，系统会计算以下指标：
|
||||
|
||||
- **Recall@K**：在前 K 个检索结果中找到的相关文档比例，衡量检索的召回能力
|
||||
- **F1@K**：Precision@K 和 Recall@K 的调和平均值，综合评估检索精确度和召回率
|
||||
|
||||
默认计算 K=1、3、5、10 的指标值，让您了解不同检索深度下的性能表现。
|
||||
|
||||
### 答案评估指标
|
||||
|
||||
当基准包含标准答案时，系统会使用指定的 Judge LLM 评估生成答案的质量：
|
||||
|
||||
- **答案准确性**：LLM 评判者基于事实一致性判断生成答案是否正确
|
||||
- **评判理由**：提供详细的判定依据，便于理解和分析
|
||||
|
||||
评判过程会忽略措辞差异，专注于核心事实的准确性。
|
||||
|
||||
### 综合评分
|
||||
|
||||
系统会计算一个整体评分，将所有检索指标和答案准确性的分数进行平均，提供一个直观的性能概览。
|
||||
|
||||
## 评估流程
|
||||
|
||||
### 执行评估
|
||||
|
||||
1. **选择基准**：从知识库的评估基准列表中选择合适的基准
|
||||
2. **配置模型**：
|
||||
- 答案生成模型：用于基于检索到的文档生成答案
|
||||
- 答案评判模型：用于评估生成答案的准确性（仅当基准包含标准答案时需要）
|
||||
3. **检索配置**：可以调整检索参数，如相似度阈值、返回文档数量等
|
||||
4. **启动评估**：系统会在后台异步执行评估任务
|
||||
|
||||
### 实时进度追踪
|
||||
|
||||
评估过程中，您可以：
|
||||
- 查看实时进度和当前已完成的问题数量
|
||||
- 监控中间结果，了解各项指标的实时变化
|
||||
- 取消正在运行的评估任务
|
||||
|
||||
### 结果分析
|
||||
|
||||
评估完成后，系统提供详细的结果报告：
|
||||
|
||||
- **整体性能概览**：展示各项指标的平均得分和总体评分
|
||||
- **检索配置记录**：保存评估时使用的检索和生成配置，确保结果可重现
|
||||
- **详细结果表格**：每个问题的具体表现，包括：
|
||||
- 原始查询和生成答案
|
||||
- 检索到的文档列表
|
||||
- 各项指标的得分
|
||||
- 答案正确性评判和理由
|
||||
|
||||
## 评估历史
|
||||
|
||||
系统会自动保存所有评估记录，您可以：
|
||||
- 查看历史评估列表，包括执行时间、基准信息、总体评分等
|
||||
- 对比不同配置下的评估结果，分析优化效果
|
||||
- 删除不需要的评估记录
|
||||
- 基于历史结果调整系统配置
|
||||
|
||||
## 最佳实践
|
||||
|
||||
### 基准设计建议
|
||||
|
||||
- **代表性问题**：确保基准覆盖知识库的主要内容和典型应用场景
|
||||
- **难度梯度**：包含不同难度级别的问题，全面评估系统能力
|
||||
- **数据质量**：黄金答案应准确、完整，黄金文档块应与问题高度相关
|
||||
|
||||
### 评估频率
|
||||
|
||||
- **定期评估**：在知识库更新或系统配置调整后进行评估
|
||||
- **版本对比**：记录每次评估的结果，追踪性能变化趋势
|
||||
- **A/B 测试**：对比不同配置下的性能，选择最优方案
|
||||
|
||||
### 结果解读
|
||||
|
||||
- **检索指标**：重点关注 Recall@1 和 Recall@5，它们反映了用户最可能查看的文档质量
|
||||
- **答案准确性**：结合评判理由分析错误原因，是检索不足还是生成质量问题
|
||||
- **综合评分**：作为参考，但更应关注具体指标的改进方向
|
||||
@ -107,23 +107,7 @@
|
||||
</a-card>
|
||||
</a-form-item>
|
||||
|
||||
<a-form-item>
|
||||
<a-alert
|
||||
message="生成说明"
|
||||
type="info"
|
||||
show-icon
|
||||
>
|
||||
<template #description>
|
||||
<ul>
|
||||
<li>系统将从知识库中随机采样文档块</li>
|
||||
<li>基于采样的文档块生成相关查询问题</li>
|
||||
<li>可选择为每个问题生成对应的黄金答案</li>
|
||||
<li>生成过程可能需要几分钟，请耐心等待</li>
|
||||
</ul>
|
||||
</template>
|
||||
</a-alert>
|
||||
</a-form-item>
|
||||
</a-form>
|
||||
</a-form>
|
||||
</a-modal>
|
||||
</template>
|
||||
|
||||
@ -272,14 +256,4 @@ watch(visible, (val) => {
|
||||
}
|
||||
}
|
||||
|
||||
:deep(.ant-alert) {
|
||||
ul {
|
||||
margin: 8px 0;
|
||||
padding-left: 20px;
|
||||
|
||||
li {
|
||||
margin-bottom: 4px;
|
||||
}
|
||||
}
|
||||
}
|
||||
</style>
|
||||
|
||||
@ -47,27 +47,7 @@
|
||||
</a-upload-dragger>
|
||||
</a-form-item>
|
||||
|
||||
<a-form-item label="文件格式说明">
|
||||
<a-alert
|
||||
message="JSONL文件格式要求"
|
||||
type="info"
|
||||
show-icon
|
||||
>
|
||||
<template #description>
|
||||
<div class="format-info">
|
||||
<p>每行一个JSON对象，包含以下字段：</p>
|
||||
<ul>
|
||||
<li><code>query</code> (必需): 查询问题</li>
|
||||
<li><code>gold_chunk_ids</code> (可选): 黄金文档块ID列表</li>
|
||||
<li><code>gold_answer</code> (可选): 黄金答案</li>
|
||||
</ul>
|
||||
<p>示例：</p>
|
||||
<pre class="format-example">{"query": "什么是人工智能？", "gold_chunk_ids": ["chunk_001"], "gold_answer": "人工智能是..."}</pre>
|
||||
</div>
|
||||
</template>
|
||||
</a-alert>
|
||||
</a-form-item>
|
||||
</a-form>
|
||||
</a-form>
|
||||
</a-modal>
|
||||
</template>
|
||||
|
||||
@ -231,39 +211,6 @@ watch(visible, (val) => {
|
||||
</script>
|
||||
|
||||
<style lang="less" scoped>
|
||||
.format-info {
|
||||
p {
|
||||
margin-bottom: 8px;
|
||||
}
|
||||
|
||||
ul {
|
||||
margin: 8px 0;
|
||||
padding-left: 20px;
|
||||
|
||||
li {
|
||||
margin-bottom: 4px;
|
||||
}
|
||||
}
|
||||
|
||||
code {
|
||||
background-color: var(--gray-100);
|
||||
padding: 2px 4px;
|
||||
border-radius: 3px;
|
||||
font-family: 'Monaco', 'Consolas', monospace;
|
||||
font-size: 13px;
|
||||
}
|
||||
|
||||
.format-example {
|
||||
background-color: var(--gray-100);
|
||||
padding: 8px;
|
||||
border-radius: 4px;
|
||||
margin-top: 8px;
|
||||
overflow-x: auto;
|
||||
font-family: 'Monaco', 'Consolas', monospace;
|
||||
font-size: 12px;
|
||||
line-height: 1.4;
|
||||
}
|
||||
}
|
||||
|
||||
:deep(.ant-upload-dragger) {
|
||||
.ant-upload-text {
|
||||
|
||||
@ -42,18 +42,34 @@
|
||||
ref="mindmapSectionRef"
|
||||
/>
|
||||
</a-tab-pane>
|
||||
<a-tab-pane key="evaluation" tab="RAG评估">
|
||||
<a-tab-pane key="evaluation" tab="RAG评估" :disabled="!isEvaluationSupported">
|
||||
<template #tab>
|
||||
<span :style="{ color: !isEvaluationSupported ? 'var(--gray-400)' : '' }">
|
||||
RAG评估
|
||||
<a-tooltip v-if="!isEvaluationSupported" title="仅支持 Milvus 类型的知识库">
|
||||
<InfoCircleOutlined style="margin-left: 4px;" />
|
||||
</a-tooltip>
|
||||
</span>
|
||||
</template>
|
||||
<RAGEvaluationTab
|
||||
v-if="databaseId"
|
||||
v-if="databaseId && isEvaluationSupported"
|
||||
:database-id="databaseId"
|
||||
@switch-to-benchmarks="activeTab = 'benchmarks'"
|
||||
/>
|
||||
</a-tab-pane>
|
||||
<a-tab-pane key="benchmarks" tab="评估基准">
|
||||
<a-tab-pane key="benchmarks" tab="评估基准" :disabled="!isEvaluationSupported">
|
||||
<template #tab>
|
||||
<span :style="{ color: !isEvaluationSupported ? 'var(--gray-400)' : '' }">
|
||||
评估基准
|
||||
<a-tooltip v-if="!isEvaluationSupported" title="仅支持 Milvus 类型的知识库">
|
||||
<InfoCircleOutlined style="margin-left: 4px;" />
|
||||
</a-tooltip>
|
||||
</span>
|
||||
</template>
|
||||
<div class="benchmark-management-container">
|
||||
<div class="benchmark-content">
|
||||
<EvaluationBenchmarks
|
||||
v-if="databaseId"
|
||||
v-if="databaseId && isEvaluationSupported"
|
||||
:database-id="databaseId"
|
||||
@benchmark-selected="(benchmark) => {
|
||||
// 处理基准选择逻辑
|
||||
@ -77,6 +93,7 @@ import { onMounted, reactive, ref, watch, onUnmounted, computed } from 'vue';
|
||||
import { useRoute } from 'vue-router';
|
||||
import { useDatabaseStore } from '@/stores/database';
|
||||
import { useTaskerStore } from '@/stores/tasker';
|
||||
import { InfoCircleOutlined } from '@ant-design/icons-vue';
|
||||
import KnowledgeBaseCard from '@/components/KnowledgeBaseCard.vue';
|
||||
import FileTable from '@/components/FileTable.vue';
|
||||
import FileDetailModal from '@/components/FileDetailModal.vue';
|
||||
@ -100,6 +117,12 @@ const isGraphSupported = computed(() => {
|
||||
return kbType === 'lightrag';
|
||||
});
|
||||
|
||||
// 计算属性：是否支持评估功能
|
||||
const isEvaluationSupported = computed(() => {
|
||||
const kbType = database.value.kb_type?.toLowerCase();
|
||||
return kbType === 'milvus';
|
||||
});
|
||||
|
||||
// Tab 切换逻辑 - 智能默认
|
||||
const activeTab = ref('query');
|
||||
|
||||
@ -123,9 +146,9 @@ const resetGraphStats = () => {
|
||||
|
||||
// LightRAG 默认展示知识图谱
|
||||
watch(
|
||||
() => [databaseId.value, isGraphSupported.value],
|
||||
([newDbId, supported], oldValue = []) => {
|
||||
const [oldDbId, previouslySupported] = oldValue;
|
||||
() => [databaseId.value, isGraphSupported.value, isEvaluationSupported.value],
|
||||
([newDbId, supported, evaluationSupported], oldValue = []) => {
|
||||
const [oldDbId, previouslySupported, previouslyEvaluationSupported] = oldValue;
|
||||
|
||||
if (!newDbId) {
|
||||
return;
|
||||
@ -145,6 +168,11 @@ watch(
|
||||
if (!supported && activeTab.value === 'graph') {
|
||||
activeTab.value = 'query';
|
||||
}
|
||||
|
||||
// 如果知识库类型不支持评估功能且当前在评估相关 tab，切换到查询 tab
|
||||
if (!isEvaluationSupported.value && (activeTab.value === 'evaluation' || activeTab.value === 'benchmarks')) {
|
||||
activeTab.value = 'query';
|
||||
}
|
||||
},
|
||||
{ immediate: true }
|
||||
);
|
||||
|
||||
Loading…
Reference in New Issue
Block a user