Heta_Framework/mkdocs.yml at main · KnowledgeXLab/Heta_Framework · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
site_name: Heta Framework
site_url: https://knowledgexlab.github.io/Heta_Framework/
repo_url: https://github.com/KnowledgeXLab/Heta_Framework
repo_name: KnowledgeXLab/Heta_Framework
docs_dir: docs
site_dir: site

theme:
  name: material
  language: zh
  logo: images/heta-icon.png
  favicon: images/heta-icon.png
  features:
    - content.code.copy
    - navigation.expand
    - navigation.sections
    - navigation.top
    - navigation.tracking
    - search.suggest
    - toc.follow

plugins:
  - search
  - i18n:
      docs_structure: suffix
      fallback_to_default: true
      languages:
        - locale: zh
          default: true
          name: 简体中文
          build: true
          site_name: Heta Framework
          site_url: https://knowledgexlab.github.io/Heta_Framework/
        - locale: en
          name: English
          build: true
          site_name: Heta Framework
          site_url: https://knowledgexlab.github.io/Heta_Framework/en/
          nav:
            - Home: index.en.md
            - Quick Start: quick-start.en.md
            - Guides:
                - What is a Recipe: guides/what-is-recipe.en.md
                - Choose a build path: guides/choose-build-path.en.md
                - Query a KnowledgeBase: guides/query-knowledge-base.en.md
                - Evaluate a Recipe: guides/evaluate-recipe.en.md
                - Load and delete a KnowledgeBase: guides/load-delete-knowledge-base.en.md
            - Core components:
                - Knowledge base:
                    - Knowledge recipe: core-components/knowledge-base/knowledge-recipe.en.md
                    - KnowledgeBaseBuilder: core-components/knowledge-base/knowledge-base-builder.en.md
                    - KnowledgeBase: core-components/knowledge-base/knowledge-base.en.md
                - Models:
                    - Language models: core-components/models/language-models.en.md
                    - Embeddings: core-components/models/embeddings.en.md
                    - Rerankers: core-components/models/rerankers.en.md
                - Parsers:
                    - Document parsers: core-components/parsers/document-parsers.en.md
                - Procedures:
                    - Knowledge procedures: core-components/procedures/knowledge-procedures.en.md
                    - Heta Wiki procedure: core-components/procedures/heta-wiki-procedure.en.md
                - Search:
                    - Query protocols: core-components/search/query-protocols.en.md
                    - Vector search: core-components/search/vector-search.en.md
                    - SQL text search: core-components/search/keyword-search.en.md
                    - Full-text search: core-components/search/full-text-search.en.md
                    - Heta graph search: core-components/search/heta-graph-search.en.md
                    - Heta query modes: core-components/search/heta-query-modes.en.md
                    - Wiki agent search: core-components/search/wiki-agent-search.en.md
                - Evaluation:
                    - Benchmark protocols: core-components/evaluation/benchmark-protocols.en.md
                    - BenchmarkRunner: core-components/evaluation/benchmark-runner.en.md
                    - Evaluators: core-components/evaluation/evaluators.en.md
                    - Evaluation reports: core-components/evaluation/evaluation-reports.en.md
                    - Benchmarks:
                        - MultiHop-RAG: core-components/evaluation/multihop-rag.en.md
                        - UDA-Benchmark: core-components/evaluation/uda-benchmark.en.md
                        - BEIR: core-components/evaluation/beir.en.md
                - Steps:
                    - Step protocols: core-components/steps/step-protocols.en.md
                    - Document indexing:
                        - Parse documents: core-components/steps/parse-documents.en.md
                        - Split documents: core-components/steps/split-documents.en.md
                        - Embed chunks: core-components/steps/embed-chunks.en.md
                        - Index vectors: core-components/steps/index-vectors.en.md
                        - Index full text: core-components/steps/index-full-text.en.md
                    - Heta Wiki procedure:
                        - Build Wiki pages: core-components/steps/build-wiki-pages.en.md
                        - Split Wiki pages: core-components/steps/split-wiki-pages.en.md
                    - Heta graph procedure:
                        - Merge chunks: core-components/steps/merge-chunks.en.md
                        - Rechunk documents: core-components/steps/rechunk-documents.en.md
                        - Persist chunks: core-components/steps/persist-chunks.en.md
                        - Deduplicate entities: core-components/steps/deduplicate-entities.en.md
                        - Deduplicate relations: core-components/steps/deduplicate-relations.en.md
                        - Build graph: core-components/steps/build-graph.en.md
                        - Merge graph into store: core-components/steps/merge-graph-into-store.en.md
                - Stores:
                    - Object stores: core-components/stores/object-stores.en.md
                    - SQL stores: core-components/stores/sql-stores.en.md
                    - Text index stores: core-components/stores/text-index-stores.en.md
                    - Vector stores: core-components/stores/vector-stores.en.md
                    - Graph stores: core-components/stores/graph-stores.en.md

hooks:
  - hooks/copy_markdown.py

extra_css:
  - stylesheets/heta-home.css?v=20260703-pages

extra_javascript:
  - javascripts/heta-home.js?v=20260703-pages

nav:
  - 首页: index.md
  - 快速开始: quick-start.zh.md
  - Guides:
      - What is a Recipe: guides/what-is-recipe.zh.md
      - Choose a build path: guides/choose-build-path.zh.md
      - Query a KnowledgeBase: guides/query-knowledge-base.zh.md
      - Evaluate a Recipe: guides/evaluate-recipe.zh.md
      - Load and delete a KnowledgeBase: guides/load-delete-knowledge-base.zh.md
  - Core components:
      - Knowledge base:
          - Knowledge recipe: core-components/knowledge-base/knowledge-recipe.zh.md
          - KnowledgeBaseBuilder: core-components/knowledge-base/knowledge-base-builder.zh.md
          - KnowledgeBase: core-components/knowledge-base/knowledge-base.zh.md
      - Models:
          - Language models: core-components/models/language-models.zh.md
          - Embeddings: core-components/models/embeddings.zh.md
          - Rerankers: core-components/models/rerankers.zh.md
      - Parsers:
          - Document parsers: core-components/parsers/document-parsers.zh.md
      - Procedures:
          - Knowledge procedures: core-components/procedures/knowledge-procedures.zh.md
          - Heta Wiki procedure: core-components/procedures/heta-wiki-procedure.zh.md
      - Search:
          - Query protocols: core-components/search/query-protocols.zh.md
          - Vector search: core-components/search/vector-search.zh.md
          - SQL text search: core-components/search/keyword-search.zh.md
          - Full-text search: core-components/search/full-text-search.zh.md
          - Heta graph search: core-components/search/heta-graph-search.zh.md
          - Heta query modes: core-components/search/heta-query-modes.zh.md
          - Wiki agent search: core-components/search/wiki-agent-search.zh.md
      - Evaluation:
          - Benchmark protocols: core-components/evaluation/benchmark-protocols.zh.md
          - BenchmarkRunner: core-components/evaluation/benchmark-runner.zh.md
          - Evaluators: core-components/evaluation/evaluators.zh.md
          - Evaluation reports: core-components/evaluation/evaluation-reports.zh.md
          - Benchmarks:
              - MultiHop-RAG: core-components/evaluation/multihop-rag.zh.md
              - UDA-Benchmark: core-components/evaluation/uda-benchmark.zh.md
              - BEIR: core-components/evaluation/beir.zh.md
      - Steps:
          - Step protocols: core-components/steps/step-protocols.zh.md
          - Document indexing:
              - Parse documents: core-components/steps/parse-documents.zh.md
              - Split documents: core-components/steps/split-documents.zh.md
              - Embed chunks: core-components/steps/embed-chunks.zh.md
              - Index vectors: core-components/steps/index-vectors.zh.md
              - Index full text: core-components/steps/index-full-text.zh.md
          - Heta Wiki procedure:
              - Build Wiki pages: core-components/steps/build-wiki-pages.zh.md
              - Split Wiki pages: core-components/steps/split-wiki-pages.zh.md
          - Heta graph procedure:
              - Merge chunks: core-components/steps/merge-chunks.zh.md
              - Rechunk documents: core-components/steps/rechunk-documents.zh.md
              - Persist chunks: core-components/steps/persist-chunks.zh.md
              - Deduplicate entities: core-components/steps/deduplicate-entities.zh.md
              - Deduplicate relations: core-components/steps/deduplicate-relations.zh.md
              - Build graph: core-components/steps/build-graph.zh.md
              - Merge graph into store: core-components/steps/merge-graph-into-store.zh.md
      - Stores:
          - Object stores: core-components/stores/object-stores.zh.md
          - SQL stores: core-components/stores/sql-stores.zh.md
          - Text index stores: core-components/stores/text-index-stores.zh.md
          - Vector stores: core-components/stores/vector-stores.zh.md
          - Graph stores: core-components/stores/graph-stores.zh.md

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.tabbed:
      alternate_style: true
  - tables
  - attr_list
  - md_in_html