docs(dataset): expand dataset card

#2
by shiphex - opened
Files changed (1) hide show
  1. README.md +87 -41
README.md CHANGED
@@ -1,41 +1,87 @@
1
- ---
2
- license: other
3
- language:
4
- - zh
5
- tags:
6
- - rag
7
- - retrieval
8
- - genshin-impact
9
- configs:
10
- - config_name: story
11
- default: true
12
- data_files:
13
- - split: train
14
- path: data/corpus.jsonl
15
- ---
16
-
17
- # Genshin Agent RAG corpus
18
-
19
- 中文剧情检索语料,共 22822 条。发布格式版本:`rag-full-20260605-v2`;
20
- 原始快照:`genshin_wiki_data_20260605`。`story/train` 只加载 `data/corpus.jsonl`,
21
- train 是加载分区名;用途为剧情检索和回查。metadata 下为审计、排除记录和覆盖说明。
22
-
23
- ## 来源与限制
24
-
25
- 记录保留 source_file、RFC 6901 source_pointer、解码后原字段的零基半开字符范围
26
- source_spans 及 source_kind。wiki_excerpt 是 Wiki 摘录,wiki_compilation 是 Wiki
27
- 编纂,均不自动等同于官方事实。人物说法、传说和推测须保持原限定。
28
-
29
- 本发布不包含原始快照、题库、模型回答、复核资料、权重或缓存。路径不是公开原文 URL;
30
- 完整回查需要另行提供相同冻结快照。
31
-
32
- ## 许可
33
-
34
- 原神及 Wiki 来源文本未通过本仓库获得再许可,权利和使用限制仍由相应权利人及来源决定。
35
- license: other 表示未授予这些文本开放数据许可。发布者原创脚本、清单和说明可按 MIT
36
- 使用,此声明不扩展到语料文本。
37
-
38
- ## 校验
39
-
40
- manifest.json 记录发布身份、行数、文件大小与 SHA-256;下载后先核对哈希,再逐行解析。
41
- corpus.jsonl 通过 Git LFS 分发。本次发布不表示已完成语义质量或用户验收。
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ license: other
3
+ language:
4
+ - zh
5
+ tags:
6
+ - rag
7
+ - retrieval
8
+ - genshin-impact
9
+ configs:
10
+ - config_name: story
11
+ default: true
12
+ data_files:
13
+ - split: train
14
+ path: data/corpus.jsonl
15
+ ---
16
+
17
+ # Genshin Agent RAG corpus
18
+
19
+ 这是为原神剧情讨论与 RAG 检索准备的中文语料,当前发布包含 **22,822 条记录**。
20
+
21
+ | 属性 | 值 |
22
+ | --- | --- |
23
+ | 发布格式 | `rag-full-20260605-v2` |
24
+ | 基线 | `current-003` |
25
+ | 来源快照 | `genshin_wiki_data_20260605` |
26
+ | 主数据文件 | `data/corpus.jsonl`(JSON Lines,UTF-8) |
27
+
28
+ ## 加载数据
29
+
30
+ 数据集提供 `story` 配置。其 `train` split **只读取** `data/corpus.jsonl`;`train` 是加载器的分区名称,不表示这些记录是模型训练样本。审计、排除记录和覆盖说明不进入该 split。
31
+
32
+ ```python
33
+ from datasets import load_dataset
34
+
35
+ corpus = load_dataset(
36
+ "shiphex/genshin_agent_RAG",
37
+ name="story",
38
+ split="train",
39
+ )
40
+ print(len(corpus))
41
+ print(corpus[0])
42
+ ```
43
+
44
+ ## 数据内容与字段
45
+
46
+ 每行是一条剧情相关的语料片段。记录保留片段文本及其来源定位信息,便于检索后回查原材料。
47
+
48
+ | 字段 | 含义 |
49
+ | --- | --- |
50
+ | `id` | 语料记录的稳定标识 |
51
+ | `title` | 来源条目的标题或路径标签 |
52
+ | `type` | 来源内容的分类 |
53
+ | `parent_id` | 解析记录对应的来源条目标识 |
54
+ | `text` | 用于检索的中文片段文本 |
55
+ | `source_file` | 冻结快照内的来源文件相对路径 |
56
+ | `source_pointer` | RFC 6901 JSON Pointer 路径数组,用于定位来源 JSON 中的字段 |
57
+ | `source_spans` | 与 `source_pointer` 顺序对应的字符范围;起点包含、终点不包含,按解码后的原字段文本计数 |
58
+ | `source_kind` | 来源性质:`wiki_excerpt`(Wiki 摘录)或 `wiki_compilation`(Wiki 编纂) |
59
+
60
+ Wiki 摘录与 Wiki 编纂都不能自动视作官方确认事实。引用人物说法、传说、推测及存在争议的内容时,应保留来源语气和不确定限定;检索结果适合作为回查线索,不单独构成事实核验结论。
61
+
62
+ ## 发布文件
63
+
64
+ | 路径 | 用途 | 是否载入 `story/train` |
65
+ | --- | --- | --- |
66
+ | `data/corpus.jsonl` | 完整剧情检索语料 | 是 |
67
+ | `metadata/audit.json` | 纳入语料的审计信息 | 否 |
68
+ | `metadata/exclusions.jsonl` | 排除项记录 | 否 |
69
+ | `metadata/coverage.md` | 覆盖范围与限制说明 | 否 |
70
+ | `manifest.json` | 发布身份、行数、大小与文件 SHA-256 | 否 |
71
+ | `README.md` | 数据集卡与加载配置 | 否 |
72
+
73
+ ## 来源与回查
74
+
75
+ 语料由冻结 Wiki 快照 `genshin_wiki_data_20260605` 派生。\`source_file\` 和 \`source_pointer\` 是该快照内部的路径,不是可直接访问的网页 URL。本发布不包含原始快照;若要按记录精确回查,需要另行取得相同版本的快照。来源文件路径、快照版本与记录 ID 应一并保留,避免把片段脱离上下文使用。
76
+
77
+ 本数据集面向剧情文本检索与证据回查,不包含游戏数值、养成、配队或攻略类语料作为目标内容,也不是带有题目、标准答案或训练标签的基准集。本发布不包含题库、模型回答、人工复核材料、模型权重或缓存。
78
+
79
+ ## 许可与使用边界
80
+
81
+ Hugging Face 元数据中的 `license: other` 不授予语料文本开放数据许可。原神及 Wiki 来源文本没有通过本仓库获得再许可;相关权利与使用限制仍由相应权利人和来源���款决定。发布者原创的脚本、清单及说明可按 MIT 许可使用,该声明不扩展到语料文本。使用者应自行确认其使用方式符合适用的来源条款和法律要求。
82
+
83
+ ## 完整性校验
84
+
85
+ `manifest.json` 记录发布版本、基线标识、来源快照、语料行数,以及每个数据文件的字节数和 SHA-256。下载后可先按清单核对文件大小与哈希,再解析 JSON Lines 并确认记录数为 **22,822**。`data/corpus.jsonl` 使用 Git LFS 分发。
86
+
87
+ 文件完整性校验只能确认下载内容与该发布清单一致,不代表语义质量、覆盖完整性或逐条事实正确性已经获得验收。