mirror of
https://github.com/microsoft/graphrag.git
synced 2025-11-02 02:40:23 +00:00
Deploying to gh-pages from @ microsoft/graphrag@973fde0f7e 🚀
This commit is contained in:
AlonsoGuevara
parent
deafae3795
commit
940f8bac43
Binary file not shown.
44
index.html
44
index.html
@ -178,7 +178,7 @@ a {
|
||||
<body>
|
||||
<header>
|
||||
<div id="cookie-banner"></div>
|
||||
<a href="/graphrag/"><span class="logotitle">GraphRAG</span></a>
|
||||
<a href="/"><span class="logotitle">GraphRAG</span></a>
|
||||
</header>
|
||||
<div class="page-content">
|
||||
<!-- Sidebar -->
|
||||
@ -186,49 +186,49 @@ a {
|
||||
<ul class="menu-list">
|
||||
<li>
|
||||
|
||||
<a href="/graphrag/" class="is-active" aria-current="page">Welcome</a>
|
||||
<a href="/" class="is-active" aria-current="page">Welcome</a>
|
||||
|
||||
</li>
|
||||
|
||||
<!-- Get Started Links -->
|
||||
<li>
|
||||
|
||||
<a href="/graphrag/posts/get_started/">Get Started</a>
|
||||
<a href="/posts/get_started/">Get Started</a>
|
||||
|
||||
|
||||
<a href="/graphrag/posts/developing/">Developing</a>
|
||||
<a href="/posts/developing/">Developing</a>
|
||||
|
||||
</li>
|
||||
|
||||
<!-- Indexing Links -->
|
||||
<li>
|
||||
|
||||
<a href="/graphrag/posts/index/overview/">Indexing</a>
|
||||
<a href="/posts/index/overview/">Indexing</a>
|
||||
|
||||
<ul><li>
|
||||
<a href="/graphrag/posts/index/0-architecture/">Architecture</a>
|
||||
<a href="/posts/index/0-architecture/">Architecture</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/index/1-default_dataflow/">Dataflow</a>
|
||||
<a href="/posts/index/1-default_dataflow/">Dataflow</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/index/2-cli/">CLI</a>
|
||||
<a href="/posts/index/2-cli/">CLI</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/index/3-prompt_tuning/">Prompt Tuning</a>
|
||||
<a href="/posts/index/3-prompt_tuning/">Prompt Tuning</a>
|
||||
</li><li>
|
||||
|
||||
<a href="/graphrag/posts/config/overview/">Configuration</a>
|
||||
<a href="/posts/config/overview/">Configuration</a>
|
||||
|
||||
<ul>
|
||||
<li>
|
||||
<a href="/graphrag/posts/config/env_vars">Using Env Vars</a>
|
||||
<a href="/posts/config/env_vars">Using Env Vars</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="/graphrag/posts/config/json_yaml">Using JSON or YAML</a>
|
||||
<a href="/posts/config/json_yaml">Using JSON or YAML</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="/graphrag/posts/config/custom">Fully Custom</a>
|
||||
<a href="/posts/config/custom">Fully Custom</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="/graphrag/posts/config/template">Template</a>
|
||||
<a href="/posts/config/template">Template</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
@ -239,26 +239,26 @@ a {
|
||||
<!-- Query Links -->
|
||||
<li>
|
||||
|
||||
<a href="/graphrag/posts/query/overview/">Query</a>
|
||||
<a href="/posts/query/overview/">Query</a>
|
||||
|
||||
<ul><li>
|
||||
<a href="/graphrag/posts/query/1-local_search/">Local Search</a>
|
||||
<a href="/posts/query/1-local_search/">Local Search</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/query/2-question_generation/">Question Generation</a>
|
||||
<a href="/posts/query/2-question_generation/">Question Generation</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/query/0-global_search/">Global Search</a>
|
||||
<a href="/posts/query/0-global_search/">Global Search</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/query/3-cli/">CLI</a>
|
||||
<a href="/posts/query/3-cli/">CLI</a>
|
||||
</li><li>
|
||||
|
||||
<a href="/graphrag/posts/query/notebooks/overview/">Notebooks</a>
|
||||
<a href="/posts/query/notebooks/overview/">Notebooks</a>
|
||||
|
||||
<ul>
|
||||
<li>
|
||||
<a href="/graphrag/posts/query/notebooks/global_search_nb">Global Search</a>
|
||||
<a href="/posts/query/notebooks/global_search_nb">Global Search</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="/graphrag/posts/query/notebooks/local_search_nb">Local Search</a>
|
||||
<a href="/posts/query/notebooks/local_search_nb">Local Search</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
|
||||
@ -178,7 +178,7 @@ a {
|
||||
<body>
|
||||
<header>
|
||||
<div id="cookie-banner"></div>
|
||||
<a href="/graphrag/"><span class="logotitle">GraphRAG</span></a>
|
||||
<a href="/"><span class="logotitle">GraphRAG</span></a>
|
||||
</header>
|
||||
<div class="page-content">
|
||||
<!-- Sidebar -->
|
||||
@ -186,49 +186,49 @@ a {
|
||||
<ul class="menu-list">
|
||||
<li>
|
||||
|
||||
<a href="/graphrag/">Welcome</a>
|
||||
<a href="/">Welcome</a>
|
||||
|
||||
</li>
|
||||
|
||||
<!-- Get Started Links -->
|
||||
<li>
|
||||
|
||||
<a href="/graphrag/posts/get_started/">Get Started</a>
|
||||
<a href="/posts/get_started/">Get Started</a>
|
||||
|
||||
|
||||
<a href="/graphrag/posts/developing/">Developing</a>
|
||||
<a href="/posts/developing/">Developing</a>
|
||||
|
||||
</li>
|
||||
|
||||
<!-- Indexing Links -->
|
||||
<li>
|
||||
|
||||
<a href="/graphrag/posts/index/overview/">Indexing</a>
|
||||
<a href="/posts/index/overview/">Indexing</a>
|
||||
|
||||
<ul><li>
|
||||
<a href="/graphrag/posts/index/0-architecture/">Architecture</a>
|
||||
<a href="/posts/index/0-architecture/">Architecture</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/index/1-default_dataflow/">Dataflow</a>
|
||||
<a href="/posts/index/1-default_dataflow/">Dataflow</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/index/2-cli/">CLI</a>
|
||||
<a href="/posts/index/2-cli/">CLI</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/index/3-prompt_tuning/">Prompt Tuning</a>
|
||||
<a href="/posts/index/3-prompt_tuning/">Prompt Tuning</a>
|
||||
</li><li>
|
||||
|
||||
<a href="/graphrag/posts/config/overview/">Configuration</a>
|
||||
<a href="/posts/config/overview/">Configuration</a>
|
||||
|
||||
<ul>
|
||||
<li>
|
||||
<a href="/graphrag/posts/config/env_vars">Using Env Vars</a>
|
||||
<a href="/posts/config/env_vars">Using Env Vars</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="/graphrag/posts/config/json_yaml">Using JSON or YAML</a>
|
||||
<a href="/posts/config/json_yaml">Using JSON or YAML</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="/graphrag/posts/config/custom">Fully Custom</a>
|
||||
<a href="/posts/config/custom">Fully Custom</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="/graphrag/posts/config/template">Template</a>
|
||||
<a href="/posts/config/template">Template</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
@ -239,26 +239,26 @@ a {
|
||||
<!-- Query Links -->
|
||||
<li>
|
||||
|
||||
<a href="/graphrag/posts/query/overview/">Query</a>
|
||||
<a href="/posts/query/overview/">Query</a>
|
||||
|
||||
<ul><li>
|
||||
<a href="/graphrag/posts/query/1-local_search/">Local Search</a>
|
||||
<a href="/posts/query/1-local_search/">Local Search</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/query/2-question_generation/">Question Generation</a>
|
||||
<a href="/posts/query/2-question_generation/">Question Generation</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/query/0-global_search/">Global Search</a>
|
||||
<a href="/posts/query/0-global_search/">Global Search</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/query/3-cli/">CLI</a>
|
||||
<a href="/posts/query/3-cli/">CLI</a>
|
||||
</li><li>
|
||||
|
||||
<a href="/graphrag/posts/query/notebooks/overview/">Notebooks</a>
|
||||
<a href="/posts/query/notebooks/overview/">Notebooks</a>
|
||||
|
||||
<ul>
|
||||
<li>
|
||||
<a href="/graphrag/posts/query/notebooks/global_search_nb">Global Search</a>
|
||||
<a href="/posts/query/notebooks/global_search_nb">Global Search</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="/graphrag/posts/query/notebooks/local_search_nb">Local Search</a>
|
||||
<a href="/posts/query/notebooks/local_search_nb">Local Search</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
@ -271,7 +271,7 @@ a {
|
||||
<main>
|
||||
<h1>Custom Configuration Mode</h1>
|
||||
<p>The primary configuration sections for Indexing Engine pipelines are described below. Each configuration section can be expressed in Python (for use in Python API mode) as well as YAML, but YAML is show here for brevity.</p>
|
||||
<p>Using custom configuration is an advanced use-case. Most users will want to use the <a href="/graphrag/posts/config/overview">Default Configuration</a> instead.</p>
|
||||
<p>Using custom configuration is an advanced use-case. Most users will want to use the <a href="/posts/config/overview">Default Configuration</a> instead.</p>
|
||||
<h2>Indexing Engine Examples</h2>
|
||||
<p>The <a href="https://github.com/microsoft/graphrag/blob/main/examples/">examples</a> directory contains several examples of how to use the indexing engine with <em>custom configuration</em>.</p>
|
||||
<p>Most examples include two different forms of running the pipeline, both are contained in the examples <code>run.py</code></p>
|
||||
|
||||
@ -178,7 +178,7 @@ a {
|
||||
<body>
|
||||
<header>
|
||||
<div id="cookie-banner"></div>
|
||||
<a href="/graphrag/"><span class="logotitle">GraphRAG</span></a>
|
||||
<a href="/"><span class="logotitle">GraphRAG</span></a>
|
||||
</header>
|
||||
<div class="page-content">
|
||||
<!-- Sidebar -->
|
||||
@ -186,49 +186,49 @@ a {
|
||||
<ul class="menu-list">
|
||||
<li>
|
||||
|
||||
<a href="/graphrag/">Welcome</a>
|
||||
<a href="/">Welcome</a>
|
||||
|
||||
</li>
|
||||
|
||||
<!-- Get Started Links -->
|
||||
<li>
|
||||
|
||||
<a href="/graphrag/posts/get_started/">Get Started</a>
|
||||
<a href="/posts/get_started/">Get Started</a>
|
||||
|
||||
|
||||
<a href="/graphrag/posts/developing/">Developing</a>
|
||||
<a href="/posts/developing/">Developing</a>
|
||||
|
||||
</li>
|
||||
|
||||
<!-- Indexing Links -->
|
||||
<li>
|
||||
|
||||
<a href="/graphrag/posts/index/overview/">Indexing</a>
|
||||
<a href="/posts/index/overview/">Indexing</a>
|
||||
|
||||
<ul><li>
|
||||
<a href="/graphrag/posts/index/0-architecture/">Architecture</a>
|
||||
<a href="/posts/index/0-architecture/">Architecture</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/index/1-default_dataflow/">Dataflow</a>
|
||||
<a href="/posts/index/1-default_dataflow/">Dataflow</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/index/2-cli/">CLI</a>
|
||||
<a href="/posts/index/2-cli/">CLI</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/index/3-prompt_tuning/">Prompt Tuning</a>
|
||||
<a href="/posts/index/3-prompt_tuning/">Prompt Tuning</a>
|
||||
</li><li>
|
||||
|
||||
<a href="/graphrag/posts/config/overview/">Configuration</a>
|
||||
<a href="/posts/config/overview/">Configuration</a>
|
||||
|
||||
<ul>
|
||||
<li>
|
||||
<a href="/graphrag/posts/config/env_vars">Using Env Vars</a>
|
||||
<a href="/posts/config/env_vars">Using Env Vars</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="/graphrag/posts/config/json_yaml">Using JSON or YAML</a>
|
||||
<a href="/posts/config/json_yaml">Using JSON or YAML</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="/graphrag/posts/config/custom">Fully Custom</a>
|
||||
<a href="/posts/config/custom">Fully Custom</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="/graphrag/posts/config/template">Template</a>
|
||||
<a href="/posts/config/template">Template</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
@ -239,26 +239,26 @@ a {
|
||||
<!-- Query Links -->
|
||||
<li>
|
||||
|
||||
<a href="/graphrag/posts/query/overview/">Query</a>
|
||||
<a href="/posts/query/overview/">Query</a>
|
||||
|
||||
<ul><li>
|
||||
<a href="/graphrag/posts/query/1-local_search/">Local Search</a>
|
||||
<a href="/posts/query/1-local_search/">Local Search</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/query/2-question_generation/">Question Generation</a>
|
||||
<a href="/posts/query/2-question_generation/">Question Generation</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/query/0-global_search/">Global Search</a>
|
||||
<a href="/posts/query/0-global_search/">Global Search</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/query/3-cli/">CLI</a>
|
||||
<a href="/posts/query/3-cli/">CLI</a>
|
||||
</li><li>
|
||||
|
||||
<a href="/graphrag/posts/query/notebooks/overview/">Notebooks</a>
|
||||
<a href="/posts/query/notebooks/overview/">Notebooks</a>
|
||||
|
||||
<ul>
|
||||
<li>
|
||||
<a href="/graphrag/posts/query/notebooks/global_search_nb">Global Search</a>
|
||||
<a href="/posts/query/notebooks/global_search_nb">Global Search</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="/graphrag/posts/query/notebooks/local_search_nb">Local Search</a>
|
||||
<a href="/posts/query/notebooks/local_search_nb">Local Search</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
|
||||
@ -178,7 +178,7 @@ a {
|
||||
<body>
|
||||
<header>
|
||||
<div id="cookie-banner"></div>
|
||||
<a href="/graphrag/"><span class="logotitle">GraphRAG</span></a>
|
||||
<a href="/"><span class="logotitle">GraphRAG</span></a>
|
||||
</header>
|
||||
<div class="page-content">
|
||||
<!-- Sidebar -->
|
||||
@ -186,49 +186,49 @@ a {
|
||||
<ul class="menu-list">
|
||||
<li>
|
||||
|
||||
<a href="/graphrag/">Welcome</a>
|
||||
<a href="/">Welcome</a>
|
||||
|
||||
</li>
|
||||
|
||||
<!-- Get Started Links -->
|
||||
<li>
|
||||
|
||||
<a href="/graphrag/posts/get_started/">Get Started</a>
|
||||
<a href="/posts/get_started/">Get Started</a>
|
||||
|
||||
|
||||
<a href="/graphrag/posts/developing/">Developing</a>
|
||||
<a href="/posts/developing/">Developing</a>
|
||||
|
||||
</li>
|
||||
|
||||
<!-- Indexing Links -->
|
||||
<li>
|
||||
|
||||
<a href="/graphrag/posts/index/overview/">Indexing</a>
|
||||
<a href="/posts/index/overview/">Indexing</a>
|
||||
|
||||
<ul><li>
|
||||
<a href="/graphrag/posts/index/0-architecture/">Architecture</a>
|
||||
<a href="/posts/index/0-architecture/">Architecture</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/index/1-default_dataflow/">Dataflow</a>
|
||||
<a href="/posts/index/1-default_dataflow/">Dataflow</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/index/2-cli/">CLI</a>
|
||||
<a href="/posts/index/2-cli/">CLI</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/index/3-prompt_tuning/">Prompt Tuning</a>
|
||||
<a href="/posts/index/3-prompt_tuning/">Prompt Tuning</a>
|
||||
</li><li>
|
||||
|
||||
<a href="/graphrag/posts/config/overview/">Configuration</a>
|
||||
<a href="/posts/config/overview/">Configuration</a>
|
||||
|
||||
<ul>
|
||||
<li>
|
||||
<a href="/graphrag/posts/config/env_vars">Using Env Vars</a>
|
||||
<a href="/posts/config/env_vars">Using Env Vars</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="/graphrag/posts/config/json_yaml">Using JSON or YAML</a>
|
||||
<a href="/posts/config/json_yaml">Using JSON or YAML</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="/graphrag/posts/config/custom">Fully Custom</a>
|
||||
<a href="/posts/config/custom">Fully Custom</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="/graphrag/posts/config/template">Template</a>
|
||||
<a href="/posts/config/template">Template</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
@ -239,26 +239,26 @@ a {
|
||||
<!-- Query Links -->
|
||||
<li>
|
||||
|
||||
<a href="/graphrag/posts/query/overview/">Query</a>
|
||||
<a href="/posts/query/overview/">Query</a>
|
||||
|
||||
<ul><li>
|
||||
<a href="/graphrag/posts/query/1-local_search/">Local Search</a>
|
||||
<a href="/posts/query/1-local_search/">Local Search</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/query/2-question_generation/">Question Generation</a>
|
||||
<a href="/posts/query/2-question_generation/">Question Generation</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/query/0-global_search/">Global Search</a>
|
||||
<a href="/posts/query/0-global_search/">Global Search</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/query/3-cli/">CLI</a>
|
||||
<a href="/posts/query/3-cli/">CLI</a>
|
||||
</li><li>
|
||||
|
||||
<a href="/graphrag/posts/query/notebooks/overview/">Notebooks</a>
|
||||
<a href="/posts/query/notebooks/overview/">Notebooks</a>
|
||||
|
||||
<ul>
|
||||
<li>
|
||||
<a href="/graphrag/posts/query/notebooks/global_search_nb">Global Search</a>
|
||||
<a href="/posts/query/notebooks/global_search_nb">Global Search</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="/graphrag/posts/query/notebooks/local_search_nb">Local Search</a>
|
||||
<a href="/posts/query/notebooks/local_search_nb">Local Search</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
|
||||
@ -178,7 +178,7 @@ a {
|
||||
<body>
|
||||
<header>
|
||||
<div id="cookie-banner"></div>
|
||||
<a href="/graphrag/"><span class="logotitle">GraphRAG</span></a>
|
||||
<a href="/"><span class="logotitle">GraphRAG</span></a>
|
||||
</header>
|
||||
<div class="page-content">
|
||||
<!-- Sidebar -->
|
||||
@ -186,49 +186,49 @@ a {
|
||||
<ul class="menu-list">
|
||||
<li>
|
||||
|
||||
<a href="/graphrag/">Welcome</a>
|
||||
<a href="/">Welcome</a>
|
||||
|
||||
</li>
|
||||
|
||||
<!-- Get Started Links -->
|
||||
<li>
|
||||
|
||||
<a href="/graphrag/posts/get_started/">Get Started</a>
|
||||
<a href="/posts/get_started/">Get Started</a>
|
||||
|
||||
|
||||
<a href="/graphrag/posts/developing/">Developing</a>
|
||||
<a href="/posts/developing/">Developing</a>
|
||||
|
||||
</li>
|
||||
|
||||
<!-- Indexing Links -->
|
||||
<li>
|
||||
|
||||
<a href="/graphrag/posts/index/overview/">Indexing</a>
|
||||
<a href="/posts/index/overview/">Indexing</a>
|
||||
|
||||
<ul><li>
|
||||
<a href="/graphrag/posts/index/0-architecture/">Architecture</a>
|
||||
<a href="/posts/index/0-architecture/">Architecture</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/index/1-default_dataflow/">Dataflow</a>
|
||||
<a href="/posts/index/1-default_dataflow/">Dataflow</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/index/2-cli/">CLI</a>
|
||||
<a href="/posts/index/2-cli/">CLI</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/index/3-prompt_tuning/">Prompt Tuning</a>
|
||||
<a href="/posts/index/3-prompt_tuning/">Prompt Tuning</a>
|
||||
</li><li>
|
||||
|
||||
<a href="/graphrag/posts/config/overview/" class="is-active" aria-current="page">Configuration</a>
|
||||
<a href="/posts/config/overview/" class="is-active" aria-current="page">Configuration</a>
|
||||
|
||||
<ul>
|
||||
<li>
|
||||
<a href="/graphrag/posts/config/env_vars">Using Env Vars</a>
|
||||
<a href="/posts/config/env_vars">Using Env Vars</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="/graphrag/posts/config/json_yaml">Using JSON or YAML</a>
|
||||
<a href="/posts/config/json_yaml">Using JSON or YAML</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="/graphrag/posts/config/custom">Fully Custom</a>
|
||||
<a href="/posts/config/custom">Fully Custom</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="/graphrag/posts/config/template">Template</a>
|
||||
<a href="/posts/config/template">Template</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
@ -239,26 +239,26 @@ a {
|
||||
<!-- Query Links -->
|
||||
<li>
|
||||
|
||||
<a href="/graphrag/posts/query/overview/">Query</a>
|
||||
<a href="/posts/query/overview/">Query</a>
|
||||
|
||||
<ul><li>
|
||||
<a href="/graphrag/posts/query/1-local_search/">Local Search</a>
|
||||
<a href="/posts/query/1-local_search/">Local Search</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/query/2-question_generation/">Question Generation</a>
|
||||
<a href="/posts/query/2-question_generation/">Question Generation</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/query/0-global_search/">Global Search</a>
|
||||
<a href="/posts/query/0-global_search/">Global Search</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/query/3-cli/">CLI</a>
|
||||
<a href="/posts/query/3-cli/">CLI</a>
|
||||
</li><li>
|
||||
|
||||
<a href="/graphrag/posts/query/notebooks/overview/">Notebooks</a>
|
||||
<a href="/posts/query/notebooks/overview/">Notebooks</a>
|
||||
|
||||
<ul>
|
||||
<li>
|
||||
<a href="/graphrag/posts/query/notebooks/global_search_nb">Global Search</a>
|
||||
<a href="/posts/query/notebooks/global_search_nb">Global Search</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="/graphrag/posts/query/notebooks/local_search_nb">Local Search</a>
|
||||
<a href="/posts/query/notebooks/local_search_nb">Local Search</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
@ -274,11 +274,11 @@ a {
|
||||
<h2>Default Configuration Mode</h2>
|
||||
<p>The default configuration mode is the simplest way to get started with the GraphRAG system. It is designed to work out-of-the-box with minimal configuration. The primary configuration sections for the Indexing Engine pipelines are described below. The main ways to set up GraphRAG in Default Configuration mode are via:</p>
|
||||
<ul>
|
||||
<li><a href="/graphrag/posts/config/env_vars">Purely using environment variables</a></li>
|
||||
<li><a href="/graphrag/posts/config/json_yaml">Using JSON or YAML for deeper control</a></li>
|
||||
<li><a href="/posts/config/env_vars">Purely using environment variables</a></li>
|
||||
<li><a href="/posts/config/json_yaml">Using JSON or YAML for deeper control</a></li>
|
||||
</ul>
|
||||
<h2>Custom Configuration Mode</h2>
|
||||
<p>Custom configuration mode is an advanced use-case. Most users will want to use the Default Configuration instead. The primary configuration sections for Indexing Engine pipelines are described below. Details about how to use custom configuration are available in the <a href="/graphrag/posts/config/custom">Custom Configuration Mode</a> documentation.</p>
|
||||
<p>Custom configuration mode is an advanced use-case. Most users will want to use the Default Configuration instead. The primary configuration sections for Indexing Engine pipelines are described below. Details about how to use custom configuration are available in the <a href="/posts/config/custom">Custom Configuration Mode</a> documentation.</p>
|
||||
|
||||
</main>
|
||||
</div>
|
||||
|
||||
@ -178,7 +178,7 @@ a {
|
||||
<body>
|
||||
<header>
|
||||
<div id="cookie-banner"></div>
|
||||
<a href="/graphrag/"><span class="logotitle">GraphRAG</span></a>
|
||||
<a href="/"><span class="logotitle">GraphRAG</span></a>
|
||||
</header>
|
||||
<div class="page-content">
|
||||
<!-- Sidebar -->
|
||||
@ -186,49 +186,49 @@ a {
|
||||
<ul class="menu-list">
|
||||
<li>
|
||||
|
||||
<a href="/graphrag/">Welcome</a>
|
||||
<a href="/">Welcome</a>
|
||||
|
||||
</li>
|
||||
|
||||
<!-- Get Started Links -->
|
||||
<li>
|
||||
|
||||
<a href="/graphrag/posts/get_started/">Get Started</a>
|
||||
<a href="/posts/get_started/">Get Started</a>
|
||||
|
||||
|
||||
<a href="/graphrag/posts/developing/">Developing</a>
|
||||
<a href="/posts/developing/">Developing</a>
|
||||
|
||||
</li>
|
||||
|
||||
<!-- Indexing Links -->
|
||||
<li>
|
||||
|
||||
<a href="/graphrag/posts/index/overview/">Indexing</a>
|
||||
<a href="/posts/index/overview/">Indexing</a>
|
||||
|
||||
<ul><li>
|
||||
<a href="/graphrag/posts/index/0-architecture/">Architecture</a>
|
||||
<a href="/posts/index/0-architecture/">Architecture</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/index/1-default_dataflow/">Dataflow</a>
|
||||
<a href="/posts/index/1-default_dataflow/">Dataflow</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/index/2-cli/">CLI</a>
|
||||
<a href="/posts/index/2-cli/">CLI</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/index/3-prompt_tuning/">Prompt Tuning</a>
|
||||
<a href="/posts/index/3-prompt_tuning/">Prompt Tuning</a>
|
||||
</li><li>
|
||||
|
||||
<a href="/graphrag/posts/config/overview/">Configuration</a>
|
||||
<a href="/posts/config/overview/">Configuration</a>
|
||||
|
||||
<ul>
|
||||
<li>
|
||||
<a href="/graphrag/posts/config/env_vars">Using Env Vars</a>
|
||||
<a href="/posts/config/env_vars">Using Env Vars</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="/graphrag/posts/config/json_yaml">Using JSON or YAML</a>
|
||||
<a href="/posts/config/json_yaml">Using JSON or YAML</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="/graphrag/posts/config/custom">Fully Custom</a>
|
||||
<a href="/posts/config/custom">Fully Custom</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="/graphrag/posts/config/template">Template</a>
|
||||
<a href="/posts/config/template">Template</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
@ -239,26 +239,26 @@ a {
|
||||
<!-- Query Links -->
|
||||
<li>
|
||||
|
||||
<a href="/graphrag/posts/query/overview/">Query</a>
|
||||
<a href="/posts/query/overview/">Query</a>
|
||||
|
||||
<ul><li>
|
||||
<a href="/graphrag/posts/query/1-local_search/">Local Search</a>
|
||||
<a href="/posts/query/1-local_search/">Local Search</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/query/2-question_generation/">Question Generation</a>
|
||||
<a href="/posts/query/2-question_generation/">Question Generation</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/query/0-global_search/">Global Search</a>
|
||||
<a href="/posts/query/0-global_search/">Global Search</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/query/3-cli/">CLI</a>
|
||||
<a href="/posts/query/3-cli/">CLI</a>
|
||||
</li><li>
|
||||
|
||||
<a href="/graphrag/posts/query/notebooks/overview/">Notebooks</a>
|
||||
<a href="/posts/query/notebooks/overview/">Notebooks</a>
|
||||
|
||||
<ul>
|
||||
<li>
|
||||
<a href="/graphrag/posts/query/notebooks/global_search_nb">Global Search</a>
|
||||
<a href="/posts/query/notebooks/global_search_nb">Global Search</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="/graphrag/posts/query/notebooks/local_search_nb">Local Search</a>
|
||||
<a href="/posts/query/notebooks/local_search_nb">Local Search</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
|
||||
@ -178,7 +178,7 @@ a {
|
||||
<body>
|
||||
<header>
|
||||
<div id="cookie-banner"></div>
|
||||
<a href="/graphrag/"><span class="logotitle">GraphRAG</span></a>
|
||||
<a href="/"><span class="logotitle">GraphRAG</span></a>
|
||||
</header>
|
||||
<div class="page-content">
|
||||
<!-- Sidebar -->
|
||||
@ -186,49 +186,49 @@ a {
|
||||
<ul class="menu-list">
|
||||
<li>
|
||||
|
||||
<a href="/graphrag/">Welcome</a>
|
||||
<a href="/">Welcome</a>
|
||||
|
||||
</li>
|
||||
|
||||
<!-- Get Started Links -->
|
||||
<li>
|
||||
|
||||
<a href="/graphrag/posts/get_started/">Get Started</a>
|
||||
<a href="/posts/get_started/">Get Started</a>
|
||||
|
||||
|
||||
<a href="/graphrag/posts/developing/" class="is-active" aria-current="page">Developing</a>
|
||||
<a href="/posts/developing/" class="is-active" aria-current="page">Developing</a>
|
||||
|
||||
</li>
|
||||
|
||||
<!-- Indexing Links -->
|
||||
<li>
|
||||
|
||||
<a href="/graphrag/posts/index/overview/">Indexing</a>
|
||||
<a href="/posts/index/overview/">Indexing</a>
|
||||
|
||||
<ul><li>
|
||||
<a href="/graphrag/posts/index/0-architecture/">Architecture</a>
|
||||
<a href="/posts/index/0-architecture/">Architecture</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/index/1-default_dataflow/">Dataflow</a>
|
||||
<a href="/posts/index/1-default_dataflow/">Dataflow</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/index/2-cli/">CLI</a>
|
||||
<a href="/posts/index/2-cli/">CLI</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/index/3-prompt_tuning/">Prompt Tuning</a>
|
||||
<a href="/posts/index/3-prompt_tuning/">Prompt Tuning</a>
|
||||
</li><li>
|
||||
|
||||
<a href="/graphrag/posts/config/overview/">Configuration</a>
|
||||
<a href="/posts/config/overview/">Configuration</a>
|
||||
|
||||
<ul>
|
||||
<li>
|
||||
<a href="/graphrag/posts/config/env_vars">Using Env Vars</a>
|
||||
<a href="/posts/config/env_vars">Using Env Vars</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="/graphrag/posts/config/json_yaml">Using JSON or YAML</a>
|
||||
<a href="/posts/config/json_yaml">Using JSON or YAML</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="/graphrag/posts/config/custom">Fully Custom</a>
|
||||
<a href="/posts/config/custom">Fully Custom</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="/graphrag/posts/config/template">Template</a>
|
||||
<a href="/posts/config/template">Template</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
@ -239,26 +239,26 @@ a {
|
||||
<!-- Query Links -->
|
||||
<li>
|
||||
|
||||
<a href="/graphrag/posts/query/overview/">Query</a>
|
||||
<a href="/posts/query/overview/">Query</a>
|
||||
|
||||
<ul><li>
|
||||
<a href="/graphrag/posts/query/1-local_search/">Local Search</a>
|
||||
<a href="/posts/query/1-local_search/">Local Search</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/query/2-question_generation/">Question Generation</a>
|
||||
<a href="/posts/query/2-question_generation/">Question Generation</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/query/0-global_search/">Global Search</a>
|
||||
<a href="/posts/query/0-global_search/">Global Search</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/query/3-cli/">CLI</a>
|
||||
<a href="/posts/query/3-cli/">CLI</a>
|
||||
</li><li>
|
||||
|
||||
<a href="/graphrag/posts/query/notebooks/overview/">Notebooks</a>
|
||||
<a href="/posts/query/notebooks/overview/">Notebooks</a>
|
||||
|
||||
<ul>
|
||||
<li>
|
||||
<a href="/graphrag/posts/query/notebooks/global_search_nb">Global Search</a>
|
||||
<a href="/posts/query/notebooks/global_search_nb">Global Search</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="/graphrag/posts/query/notebooks/local_search_nb">Local Search</a>
|
||||
<a href="/posts/query/notebooks/local_search_nb">Local Search</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
|
||||
@ -178,7 +178,7 @@ a {
|
||||
<body>
|
||||
<header>
|
||||
<div id="cookie-banner"></div>
|
||||
<a href="/graphrag/"><span class="logotitle">GraphRAG</span></a>
|
||||
<a href="/"><span class="logotitle">GraphRAG</span></a>
|
||||
</header>
|
||||
<div class="page-content">
|
||||
<!-- Sidebar -->
|
||||
@ -186,49 +186,49 @@ a {
|
||||
<ul class="menu-list">
|
||||
<li>
|
||||
|
||||
<a href="/graphrag/">Welcome</a>
|
||||
<a href="/">Welcome</a>
|
||||
|
||||
</li>
|
||||
|
||||
<!-- Get Started Links -->
|
||||
<li>
|
||||
|
||||
<a href="/graphrag/posts/get_started/" class="is-active" aria-current="page">Get Started</a>
|
||||
<a href="/posts/get_started/" class="is-active" aria-current="page">Get Started</a>
|
||||
|
||||
|
||||
<a href="/graphrag/posts/developing/">Developing</a>
|
||||
<a href="/posts/developing/">Developing</a>
|
||||
|
||||
</li>
|
||||
|
||||
<!-- Indexing Links -->
|
||||
<li>
|
||||
|
||||
<a href="/graphrag/posts/index/overview/">Indexing</a>
|
||||
<a href="/posts/index/overview/">Indexing</a>
|
||||
|
||||
<ul><li>
|
||||
<a href="/graphrag/posts/index/0-architecture/">Architecture</a>
|
||||
<a href="/posts/index/0-architecture/">Architecture</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/index/1-default_dataflow/">Dataflow</a>
|
||||
<a href="/posts/index/1-default_dataflow/">Dataflow</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/index/2-cli/">CLI</a>
|
||||
<a href="/posts/index/2-cli/">CLI</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/index/3-prompt_tuning/">Prompt Tuning</a>
|
||||
<a href="/posts/index/3-prompt_tuning/">Prompt Tuning</a>
|
||||
</li><li>
|
||||
|
||||
<a href="/graphrag/posts/config/overview/">Configuration</a>
|
||||
<a href="/posts/config/overview/">Configuration</a>
|
||||
|
||||
<ul>
|
||||
<li>
|
||||
<a href="/graphrag/posts/config/env_vars">Using Env Vars</a>
|
||||
<a href="/posts/config/env_vars">Using Env Vars</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="/graphrag/posts/config/json_yaml">Using JSON or YAML</a>
|
||||
<a href="/posts/config/json_yaml">Using JSON or YAML</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="/graphrag/posts/config/custom">Fully Custom</a>
|
||||
<a href="/posts/config/custom">Fully Custom</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="/graphrag/posts/config/template">Template</a>
|
||||
<a href="/posts/config/template">Template</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
@ -239,26 +239,26 @@ a {
|
||||
<!-- Query Links -->
|
||||
<li>
|
||||
|
||||
<a href="/graphrag/posts/query/overview/">Query</a>
|
||||
<a href="/posts/query/overview/">Query</a>
|
||||
|
||||
<ul><li>
|
||||
<a href="/graphrag/posts/query/1-local_search/">Local Search</a>
|
||||
<a href="/posts/query/1-local_search/">Local Search</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/query/2-question_generation/">Question Generation</a>
|
||||
<a href="/posts/query/2-question_generation/">Question Generation</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/query/0-global_search/">Global Search</a>
|
||||
<a href="/posts/query/0-global_search/">Global Search</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/query/3-cli/">CLI</a>
|
||||
<a href="/posts/query/3-cli/">CLI</a>
|
||||
</li><li>
|
||||
|
||||
<a href="/graphrag/posts/query/notebooks/overview/">Notebooks</a>
|
||||
<a href="/posts/query/notebooks/overview/">Notebooks</a>
|
||||
|
||||
<ul>
|
||||
<li>
|
||||
<a href="/graphrag/posts/query/notebooks/global_search_nb">Global Search</a>
|
||||
<a href="/posts/query/notebooks/global_search_nb">Global Search</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="/graphrag/posts/query/notebooks/local_search_nb">Local Search</a>
|
||||
<a href="/posts/query/notebooks/local_search_nb">Local Search</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
@ -274,10 +274,10 @@ a {
|
||||
<p><a href="https://www.python.org/downloads/">Python 3.10-3.12</a></p>
|
||||
<p>To get started with the GraphRAG system, you have a few options:</p>
|
||||
<p>👉 <a href="https://pypi.org/project/graphrag/">Install from pypi</a>. <br>
|
||||
👉 <a href="/graphrag/posts/developing">Use it from source</a><br></p>
|
||||
👉 <a href="/posts/developing">Use it from source</a><br></p>
|
||||
<h1>Top-Level Packages</h1>
|
||||
<p><a href="/graphrag/posts/index/overview">Indexing Pipeline Overview</a><br>
|
||||
<a href="/graphrag/posts/query/overview">Query Engine Overview</a></p>
|
||||
<p><a href="/posts/index/overview">Indexing Pipeline Overview</a><br>
|
||||
<a href="/posts/query/overview">Query Engine Overview</a></p>
|
||||
<h1>Overview</h1>
|
||||
<p>The following is a simple end-to-end example for using the GraphRAG system.
|
||||
It shows how to use the system to index some text, and then use the indexed data to answer questions about the documents.</p>
|
||||
@ -291,7 +291,7 @@ It shows how to use the system to index some text, and then use the indexed data
|
||||
</button>
|
||||
</div>
|
||||
<h1>Running the Indexer</h1>
|
||||
<p>Now we need to set up a data project and some initial configuration. Let's set that up. We're using the <a href="/graphrag/posts/config/overview/">default configuration mode</a>, which you can customize as needed using <a href="/graphrag/posts/config/env_vars/">environment variables</a> or using a <a href="/graphrag/posts/config/json_yaml/">config file</a>.</p>
|
||||
<p>Now we need to set up a data project and some initial configuration. Let's set that up. We're using the <a href="/posts/config/overview/">default configuration mode</a>, which you can customize as needed using <a href="/posts/config/env_vars/">environment variables</a> or using a <a href="/posts/config/json_yaml/">config file</a>.</p>
|
||||
<p>First let's get a sample dataset ready:</p>
|
||||
|
||||
<div style="position: relative">
|
||||
@ -312,7 +312,7 @@ It shows how to use the system to index some text, and then use the indexed data
|
||||
</div>
|
||||
<p>Next we'll inject some required config variables:</p>
|
||||
<h2>Set Up Environment Variables</h2>
|
||||
<p>First let's make sure to setup the required environment variables. For details on these environment variables, and what environment variables are available, see the <a href="/graphrag/posts/config/env_vars/">environment variables documentation</a>.</p>
|
||||
<p>First let's make sure to setup the required environment variables. For details on these environment variables, and what environment variables are available, see the <a href="/posts/config/env_vars/">environment variables documentation</a>.</p>
|
||||
<h4><ins>OpenAI and Azure OpenAI</ins></h4>
|
||||
<p>Let's set the base environment variables.</p>
|
||||
|
||||
@ -347,8 +347,8 @@ It shows how to use the system to index some text, and then use the indexed data
|
||||
<span style="display:inline-block;background:url(https://api.iconify.design/mdi/content-copy.svg) no-repeat center center / contain;width: 16px; height: 16px;" class=""></span>
|
||||
</button>
|
||||
</div>
|
||||
<p>For more details about configuring GraphRAG, see the <a href="/graphrag/posts/config/overview/">configuration documentation</a>.
|
||||
For more details about using the CLI, refer to the <a href="/graphrag/posts/query/3-cli/">CLI documentation</a>.</p>
|
||||
<p>For more details about configuring GraphRAG, see the <a href="/posts/config/overview/">configuration documentation</a>.
|
||||
For more details about using the CLI, refer to the <a href="/posts/query/3-cli/">CLI documentation</a>.</p>
|
||||
<h2>Running the Indexing pipeline</h2>
|
||||
<p>Finally we'll run the pipeline!</p>
|
||||
|
||||
@ -359,7 +359,7 @@ For more details about using the CLI, refer to the <a href="/graphrag/posts/quer
|
||||
<span style="display:inline-block;background:url(https://api.iconify.design/mdi/content-copy.svg) no-repeat center center / contain;width: 16px; height: 16px;" class=""></span>
|
||||
</button>
|
||||
</div>
|
||||
<p><img src="/graphrag/img/pipeline-running.png" alt="pipeline executing from the CLI"></p>
|
||||
<p><img src="/img/pipeline-running.png" alt="pipeline executing from the CLI"></p>
|
||||
<p>This process will take some time to run. This depends on the size of your input data, what model you're using, and the text chunk size being used (these can be configured in your <code>.env</code> file).
|
||||
Once the pipeline is complete, you should see a new folder called <code>./ragtest/output/<timestamp>/artifacts</code> with a series of parquet files.</p>
|
||||
<h1>Using the Query Engine</h1>
|
||||
@ -389,7 +389,7 @@ Once the pipeline is complete, you should see a new folder called <code>./ragtes
|
||||
<span style="display:inline-block;background:url(https://api.iconify.design/mdi/content-copy.svg) no-repeat center center / contain;width: 16px; height: 16px;" class=""></span>
|
||||
</button>
|
||||
</div>
|
||||
<p>Please refer to <a href="/graphrag/posts/query/overview">Query Engine</a> docs for detailed information about how to leverage our Local and Global search mechanisms for extracting meaningful insights from data after the Indexer has wrapped up execution.</p>
|
||||
<p>Please refer to <a href="/posts/query/overview">Query Engine</a> docs for detailed information about how to leverage our Local and Global search mechanisms for extracting meaningful insights from data after the Indexer has wrapped up execution.</p>
|
||||
|
||||
</main>
|
||||
</div>
|
||||
|
||||
@ -178,7 +178,7 @@ a {
|
||||
<body>
|
||||
<header>
|
||||
<div id="cookie-banner"></div>
|
||||
<a href="/graphrag/"><span class="logotitle">GraphRAG</span></a>
|
||||
<a href="/"><span class="logotitle">GraphRAG</span></a>
|
||||
</header>
|
||||
<div class="page-content">
|
||||
<!-- Sidebar -->
|
||||
@ -186,49 +186,49 @@ a {
|
||||
<ul class="menu-list">
|
||||
<li>
|
||||
|
||||
<a href="/graphrag/">Welcome</a>
|
||||
<a href="/">Welcome</a>
|
||||
|
||||
</li>
|
||||
|
||||
<!-- Get Started Links -->
|
||||
<li>
|
||||
|
||||
<a href="/graphrag/posts/get_started/">Get Started</a>
|
||||
<a href="/posts/get_started/">Get Started</a>
|
||||
|
||||
|
||||
<a href="/graphrag/posts/developing/">Developing</a>
|
||||
<a href="/posts/developing/">Developing</a>
|
||||
|
||||
</li>
|
||||
|
||||
<!-- Indexing Links -->
|
||||
<li>
|
||||
|
||||
<a href="/graphrag/posts/index/overview/">Indexing</a>
|
||||
<a href="/posts/index/overview/">Indexing</a>
|
||||
|
||||
<ul><li>
|
||||
<a href="/graphrag/posts/index/0-architecture/" class="is-active" aria-current="page">Architecture</a>
|
||||
<a href="/posts/index/0-architecture/" class="is-active" aria-current="page">Architecture</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/index/1-default_dataflow/">Dataflow</a>
|
||||
<a href="/posts/index/1-default_dataflow/">Dataflow</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/index/2-cli/">CLI</a>
|
||||
<a href="/posts/index/2-cli/">CLI</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/index/3-prompt_tuning/">Prompt Tuning</a>
|
||||
<a href="/posts/index/3-prompt_tuning/">Prompt Tuning</a>
|
||||
</li><li>
|
||||
|
||||
<a href="/graphrag/posts/config/overview/">Configuration</a>
|
||||
<a href="/posts/config/overview/">Configuration</a>
|
||||
|
||||
<ul>
|
||||
<li>
|
||||
<a href="/graphrag/posts/config/env_vars">Using Env Vars</a>
|
||||
<a href="/posts/config/env_vars">Using Env Vars</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="/graphrag/posts/config/json_yaml">Using JSON or YAML</a>
|
||||
<a href="/posts/config/json_yaml">Using JSON or YAML</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="/graphrag/posts/config/custom">Fully Custom</a>
|
||||
<a href="/posts/config/custom">Fully Custom</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="/graphrag/posts/config/template">Template</a>
|
||||
<a href="/posts/config/template">Template</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
@ -239,26 +239,26 @@ a {
|
||||
<!-- Query Links -->
|
||||
<li>
|
||||
|
||||
<a href="/graphrag/posts/query/overview/">Query</a>
|
||||
<a href="/posts/query/overview/">Query</a>
|
||||
|
||||
<ul><li>
|
||||
<a href="/graphrag/posts/query/1-local_search/">Local Search</a>
|
||||
<a href="/posts/query/1-local_search/">Local Search</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/query/2-question_generation/">Question Generation</a>
|
||||
<a href="/posts/query/2-question_generation/">Question Generation</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/query/0-global_search/">Global Search</a>
|
||||
<a href="/posts/query/0-global_search/">Global Search</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/query/3-cli/">CLI</a>
|
||||
<a href="/posts/query/3-cli/">CLI</a>
|
||||
</li><li>
|
||||
|
||||
<a href="/graphrag/posts/query/notebooks/overview/">Notebooks</a>
|
||||
<a href="/posts/query/notebooks/overview/">Notebooks</a>
|
||||
|
||||
<ul>
|
||||
<li>
|
||||
<a href="/graphrag/posts/query/notebooks/global_search_nb">Global Search</a>
|
||||
<a href="/posts/query/notebooks/global_search_nb">Global Search</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="/graphrag/posts/query/notebooks/local_search_nb">Local Search</a>
|
||||
<a href="/posts/query/notebooks/local_search_nb">Local Search</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
|
||||
@ -178,7 +178,7 @@ a {
|
||||
<body>
|
||||
<header>
|
||||
<div id="cookie-banner"></div>
|
||||
<a href="/graphrag/"><span class="logotitle">GraphRAG</span></a>
|
||||
<a href="/"><span class="logotitle">GraphRAG</span></a>
|
||||
</header>
|
||||
<div class="page-content">
|
||||
<!-- Sidebar -->
|
||||
@ -186,49 +186,49 @@ a {
|
||||
<ul class="menu-list">
|
||||
<li>
|
||||
|
||||
<a href="/graphrag/">Welcome</a>
|
||||
<a href="/">Welcome</a>
|
||||
|
||||
</li>
|
||||
|
||||
<!-- Get Started Links -->
|
||||
<li>
|
||||
|
||||
<a href="/graphrag/posts/get_started/">Get Started</a>
|
||||
<a href="/posts/get_started/">Get Started</a>
|
||||
|
||||
|
||||
<a href="/graphrag/posts/developing/">Developing</a>
|
||||
<a href="/posts/developing/">Developing</a>
|
||||
|
||||
</li>
|
||||
|
||||
<!-- Indexing Links -->
|
||||
<li>
|
||||
|
||||
<a href="/graphrag/posts/index/overview/">Indexing</a>
|
||||
<a href="/posts/index/overview/">Indexing</a>
|
||||
|
||||
<ul><li>
|
||||
<a href="/graphrag/posts/index/0-architecture/">Architecture</a>
|
||||
<a href="/posts/index/0-architecture/">Architecture</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/index/1-default_dataflow/" class="is-active" aria-current="page">Dataflow</a>
|
||||
<a href="/posts/index/1-default_dataflow/" class="is-active" aria-current="page">Dataflow</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/index/2-cli/">CLI</a>
|
||||
<a href="/posts/index/2-cli/">CLI</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/index/3-prompt_tuning/">Prompt Tuning</a>
|
||||
<a href="/posts/index/3-prompt_tuning/">Prompt Tuning</a>
|
||||
</li><li>
|
||||
|
||||
<a href="/graphrag/posts/config/overview/">Configuration</a>
|
||||
<a href="/posts/config/overview/">Configuration</a>
|
||||
|
||||
<ul>
|
||||
<li>
|
||||
<a href="/graphrag/posts/config/env_vars">Using Env Vars</a>
|
||||
<a href="/posts/config/env_vars">Using Env Vars</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="/graphrag/posts/config/json_yaml">Using JSON or YAML</a>
|
||||
<a href="/posts/config/json_yaml">Using JSON or YAML</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="/graphrag/posts/config/custom">Fully Custom</a>
|
||||
<a href="/posts/config/custom">Fully Custom</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="/graphrag/posts/config/template">Template</a>
|
||||
<a href="/posts/config/template">Template</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
@ -239,26 +239,26 @@ a {
|
||||
<!-- Query Links -->
|
||||
<li>
|
||||
|
||||
<a href="/graphrag/posts/query/overview/">Query</a>
|
||||
<a href="/posts/query/overview/">Query</a>
|
||||
|
||||
<ul><li>
|
||||
<a href="/graphrag/posts/query/1-local_search/">Local Search</a>
|
||||
<a href="/posts/query/1-local_search/">Local Search</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/query/2-question_generation/">Question Generation</a>
|
||||
<a href="/posts/query/2-question_generation/">Question Generation</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/query/0-global_search/">Global Search</a>
|
||||
<a href="/posts/query/0-global_search/">Global Search</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/query/3-cli/">CLI</a>
|
||||
<a href="/posts/query/3-cli/">CLI</a>
|
||||
</li><li>
|
||||
|
||||
<a href="/graphrag/posts/query/notebooks/overview/">Notebooks</a>
|
||||
<a href="/posts/query/notebooks/overview/">Notebooks</a>
|
||||
|
||||
<ul>
|
||||
<li>
|
||||
<a href="/graphrag/posts/query/notebooks/global_search_nb">Global Search</a>
|
||||
<a href="/posts/query/notebooks/global_search_nb">Global Search</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="/graphrag/posts/query/notebooks/local_search_nb">Local Search</a>
|
||||
<a href="/posts/query/notebooks/local_search_nb">Local Search</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
@ -282,7 +282,7 @@ a {
|
||||
<li><code>Node</code> - This table contains layout information for rendered graph-views of the Entities and Documents which have been embedded and clustered.</li>
|
||||
</ul>
|
||||
<h2>The Default Configuration Workflow</h2>
|
||||
<p>Let's take a look at how the default-configuration workflow transforms text documents into the <em>GraphRAG Knowledge Model</em>. This page gives a general overview of the major steps in this process. To fully configure this workflow, check out the <a href="/graphrag/posts/config/overview/">configuration</a> documentation.</p>
|
||||
<p>Let's take a look at how the default-configuration workflow transforms text documents into the <em>GraphRAG Knowledge Model</em>. This page gives a general overview of the major steps in this process. To fully configure this workflow, check out the <a href="/posts/config/overview/">configuration</a> documentation.</p>
|
||||
<pre class="mermaid">--- title: Dataflow Overview --- flowchart TB subgraph phase1[Phase 1: Compose TextUnits] documents[Documents] --> chunk[Chunk] chunk --> embed[Embed] --> textUnits[Text Units] end subgraph phase2[Phase 2: Graph Extraction] textUnits --> graph_extract[Entity & Relationship Extraction] graph_extract --> graph_summarize[Entity & Relationship Summarization] graph_summarize --> entity_resolve[Entity Resolution] entity_resolve --> claim_extraction[Claim Extraction] claim_extraction --> graph_outputs[Graph Tables] end subgraph phase3[Phase 3: Graph Augmentation] graph_outputs --> community_detect[Community Detection] community_detect --> graph_embed[Graph Embedding] graph_embed --> augmented_graph[Augmented Graph Tables] end subgraph phase4[Phase 4: Community Summarization] augmented_graph --> summarized_communities[Community Summarization] summarized_communities --> embed_communities[Community Embedding] embed_communities --> community_outputs[Community Tables] end subgraph phase5[Phase 5: Document Processing] documents --> link_to_text_units[Link to TextUnits] textUnits --> link_to_text_units link_to_text_units --> embed_documents[Document Embedding] embed_documents --> document_graph[Document Graph Creation] document_graph --> document_outputs[Document Tables] end subgraph phase6[Phase 6: Network Visualization] document_outputs --> umap_docs[Umap Documents] augmented_graph --> umap_entities[Umap Entities] umap_docs --> combine_nodes[Nodes Table] umap_entities --> combine_nodes end </pre>
|
||||
<h2>Phase 1: Compose TextUnits</h2>
|
||||
<p>The first phase of the default-configuration workflow is to transform input documents into <em>TextUnits</em>. A <em>TextUnit</em> is a chunk of text that is used for our graph extraction techniques. They are also used as source-references by extracted knowledge items in order to empower breadcrumbs and provenance by concepts back to their original source tex.</p>
|
||||
@ -330,7 +330,7 @@ Entities and Relationships are extracted at once in our <em>entity_extract</em>
|
||||
<p>In this phase of the workflow, we create the <em>Documents</em> table for the knowledge model.</p>
|
||||
<pre class="mermaid">--- title: Document Processing --- flowchart LR aug[Augment] --> dp[Link to TextUnits] --> de[Avg. Embedding] --> dg[Document Table Emission] </pre>
|
||||
<h3>Augment with Columns (CSV Only)</h3>
|
||||
<p>If the workflow is operating on CSV data, you may configure your workflow to add additional fields to Documents output. These fields should exist on the incoming CSV tables. Details about configuring this can be found in the <a href="/graphrag/posts/config/overview/">configuration documentation</a>.</p>
|
||||
<p>If the workflow is operating on CSV data, you may configure your workflow to add additional fields to Documents output. These fields should exist on the incoming CSV tables. Details about configuring this can be found in the <a href="/posts/config/overview/">configuration documentation</a>.</p>
|
||||
<h3>Link to TextUnits</h3>
|
||||
<p>In this step, we link each document to the text-units that were created in the first phase. This allows us to understand which documents are related to which text-units and vice-versa.</p>
|
||||
<h3>Document Embedding</h3>
|
||||
|
||||
@ -178,7 +178,7 @@ a {
|
||||
<body>
|
||||
<header>
|
||||
<div id="cookie-banner"></div>
|
||||
<a href="/graphrag/"><span class="logotitle">GraphRAG</span></a>
|
||||
<a href="/"><span class="logotitle">GraphRAG</span></a>
|
||||
</header>
|
||||
<div class="page-content">
|
||||
<!-- Sidebar -->
|
||||
@ -186,49 +186,49 @@ a {
|
||||
<ul class="menu-list">
|
||||
<li>
|
||||
|
||||
<a href="/graphrag/">Welcome</a>
|
||||
<a href="/">Welcome</a>
|
||||
|
||||
</li>
|
||||
|
||||
<!-- Get Started Links -->
|
||||
<li>
|
||||
|
||||
<a href="/graphrag/posts/get_started/">Get Started</a>
|
||||
<a href="/posts/get_started/">Get Started</a>
|
||||
|
||||
|
||||
<a href="/graphrag/posts/developing/">Developing</a>
|
||||
<a href="/posts/developing/">Developing</a>
|
||||
|
||||
</li>
|
||||
|
||||
<!-- Indexing Links -->
|
||||
<li>
|
||||
|
||||
<a href="/graphrag/posts/index/overview/">Indexing</a>
|
||||
<a href="/posts/index/overview/">Indexing</a>
|
||||
|
||||
<ul><li>
|
||||
<a href="/graphrag/posts/index/0-architecture/">Architecture</a>
|
||||
<a href="/posts/index/0-architecture/">Architecture</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/index/1-default_dataflow/">Dataflow</a>
|
||||
<a href="/posts/index/1-default_dataflow/">Dataflow</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/index/2-cli/" class="is-active" aria-current="page">CLI</a>
|
||||
<a href="/posts/index/2-cli/" class="is-active" aria-current="page">CLI</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/index/3-prompt_tuning/">Prompt Tuning</a>
|
||||
<a href="/posts/index/3-prompt_tuning/">Prompt Tuning</a>
|
||||
</li><li>
|
||||
|
||||
<a href="/graphrag/posts/config/overview/">Configuration</a>
|
||||
<a href="/posts/config/overview/">Configuration</a>
|
||||
|
||||
<ul>
|
||||
<li>
|
||||
<a href="/graphrag/posts/config/env_vars">Using Env Vars</a>
|
||||
<a href="/posts/config/env_vars">Using Env Vars</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="/graphrag/posts/config/json_yaml">Using JSON or YAML</a>
|
||||
<a href="/posts/config/json_yaml">Using JSON or YAML</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="/graphrag/posts/config/custom">Fully Custom</a>
|
||||
<a href="/posts/config/custom">Fully Custom</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="/graphrag/posts/config/template">Template</a>
|
||||
<a href="/posts/config/template">Template</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
@ -239,26 +239,26 @@ a {
|
||||
<!-- Query Links -->
|
||||
<li>
|
||||
|
||||
<a href="/graphrag/posts/query/overview/">Query</a>
|
||||
<a href="/posts/query/overview/">Query</a>
|
||||
|
||||
<ul><li>
|
||||
<a href="/graphrag/posts/query/1-local_search/">Local Search</a>
|
||||
<a href="/posts/query/1-local_search/">Local Search</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/query/2-question_generation/">Question Generation</a>
|
||||
<a href="/posts/query/2-question_generation/">Question Generation</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/query/0-global_search/">Global Search</a>
|
||||
<a href="/posts/query/0-global_search/">Global Search</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/query/3-cli/">CLI</a>
|
||||
<a href="/posts/query/3-cli/">CLI</a>
|
||||
</li><li>
|
||||
|
||||
<a href="/graphrag/posts/query/notebooks/overview/">Notebooks</a>
|
||||
<a href="/posts/query/notebooks/overview/">Notebooks</a>
|
||||
|
||||
<ul>
|
||||
<li>
|
||||
<a href="/graphrag/posts/query/notebooks/global_search_nb">Global Search</a>
|
||||
<a href="/posts/query/notebooks/global_search_nb">Global Search</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="/graphrag/posts/query/notebooks/local_search_nb">Local Search</a>
|
||||
<a href="/posts/query/notebooks/local_search_nb">Local Search</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
|
||||
@ -178,7 +178,7 @@ a {
|
||||
<body>
|
||||
<header>
|
||||
<div id="cookie-banner"></div>
|
||||
<a href="/graphrag/"><span class="logotitle">GraphRAG</span></a>
|
||||
<a href="/"><span class="logotitle">GraphRAG</span></a>
|
||||
</header>
|
||||
<div class="page-content">
|
||||
<!-- Sidebar -->
|
||||
@ -186,49 +186,49 @@ a {
|
||||
<ul class="menu-list">
|
||||
<li>
|
||||
|
||||
<a href="/graphrag/">Welcome</a>
|
||||
<a href="/">Welcome</a>
|
||||
|
||||
</li>
|
||||
|
||||
<!-- Get Started Links -->
|
||||
<li>
|
||||
|
||||
<a href="/graphrag/posts/get_started/">Get Started</a>
|
||||
<a href="/posts/get_started/">Get Started</a>
|
||||
|
||||
|
||||
<a href="/graphrag/posts/developing/">Developing</a>
|
||||
<a href="/posts/developing/">Developing</a>
|
||||
|
||||
</li>
|
||||
|
||||
<!-- Indexing Links -->
|
||||
<li>
|
||||
|
||||
<a href="/graphrag/posts/index/overview/">Indexing</a>
|
||||
<a href="/posts/index/overview/">Indexing</a>
|
||||
|
||||
<ul><li>
|
||||
<a href="/graphrag/posts/index/0-architecture/">Architecture</a>
|
||||
<a href="/posts/index/0-architecture/">Architecture</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/index/1-default_dataflow/">Dataflow</a>
|
||||
<a href="/posts/index/1-default_dataflow/">Dataflow</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/index/2-cli/">CLI</a>
|
||||
<a href="/posts/index/2-cli/">CLI</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/index/3-prompt_tuning/" class="is-active" aria-current="page">Prompt Tuning</a>
|
||||
<a href="/posts/index/3-prompt_tuning/" class="is-active" aria-current="page">Prompt Tuning</a>
|
||||
</li><li>
|
||||
|
||||
<a href="/graphrag/posts/config/overview/">Configuration</a>
|
||||
<a href="/posts/config/overview/">Configuration</a>
|
||||
|
||||
<ul>
|
||||
<li>
|
||||
<a href="/graphrag/posts/config/env_vars">Using Env Vars</a>
|
||||
<a href="/posts/config/env_vars">Using Env Vars</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="/graphrag/posts/config/json_yaml">Using JSON or YAML</a>
|
||||
<a href="/posts/config/json_yaml">Using JSON or YAML</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="/graphrag/posts/config/custom">Fully Custom</a>
|
||||
<a href="/posts/config/custom">Fully Custom</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="/graphrag/posts/config/template">Template</a>
|
||||
<a href="/posts/config/template">Template</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
@ -239,26 +239,26 @@ a {
|
||||
<!-- Query Links -->
|
||||
<li>
|
||||
|
||||
<a href="/graphrag/posts/query/overview/">Query</a>
|
||||
<a href="/posts/query/overview/">Query</a>
|
||||
|
||||
<ul><li>
|
||||
<a href="/graphrag/posts/query/1-local_search/">Local Search</a>
|
||||
<a href="/posts/query/1-local_search/">Local Search</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/query/2-question_generation/">Question Generation</a>
|
||||
<a href="/posts/query/2-question_generation/">Question Generation</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/query/0-global_search/">Global Search</a>
|
||||
<a href="/posts/query/0-global_search/">Global Search</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/query/3-cli/">CLI</a>
|
||||
<a href="/posts/query/3-cli/">CLI</a>
|
||||
</li><li>
|
||||
|
||||
<a href="/graphrag/posts/query/notebooks/overview/">Notebooks</a>
|
||||
<a href="/posts/query/notebooks/overview/">Notebooks</a>
|
||||
|
||||
<ul>
|
||||
<li>
|
||||
<a href="/graphrag/posts/query/notebooks/global_search_nb">Global Search</a>
|
||||
<a href="/posts/query/notebooks/global_search_nb">Global Search</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="/graphrag/posts/query/notebooks/local_search_nb">Local Search</a>
|
||||
<a href="/posts/query/notebooks/local_search_nb">Local Search</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
@ -303,7 +303,7 @@ We provide a means for you to do this by allowing you to specify a custom prompt
|
||||
<p>Note: there is additional paramater for the <code>Claim Description</code> that is used in claim extraction.
|
||||
The default value is</p>
|
||||
<p><code>"Any claims or facts that could be relevant to information discovery."</code></p>
|
||||
<p>See the <a href="/graphrag/posts/config/overview/">configuration documentation</a> for details on how to change this.</p>
|
||||
<p>See the <a href="/posts/config/overview/">configuration documentation</a> for details on how to change this.</p>
|
||||
<h2>Generate Community Reports</h2>
|
||||
<p><a href="http://github.com/microsoft/graphrag/blob/main/graphrag/index/graph/extractors/community_reports/prompts.py">Prompt Source</a></p>
|
||||
<h3>Tokens (values provided by extractor)</h3>
|
||||
|
||||
@ -178,7 +178,7 @@ a {
|
||||
<body>
|
||||
<header>
|
||||
<div id="cookie-banner"></div>
|
||||
<a href="/graphrag/"><span class="logotitle">GraphRAG</span></a>
|
||||
<a href="/"><span class="logotitle">GraphRAG</span></a>
|
||||
</header>
|
||||
<div class="page-content">
|
||||
<!-- Sidebar -->
|
||||
@ -186,49 +186,49 @@ a {
|
||||
<ul class="menu-list">
|
||||
<li>
|
||||
|
||||
<a href="/graphrag/">Welcome</a>
|
||||
<a href="/">Welcome</a>
|
||||
|
||||
</li>
|
||||
|
||||
<!-- Get Started Links -->
|
||||
<li>
|
||||
|
||||
<a href="/graphrag/posts/get_started/">Get Started</a>
|
||||
<a href="/posts/get_started/">Get Started</a>
|
||||
|
||||
|
||||
<a href="/graphrag/posts/developing/">Developing</a>
|
||||
<a href="/posts/developing/">Developing</a>
|
||||
|
||||
</li>
|
||||
|
||||
<!-- Indexing Links -->
|
||||
<li>
|
||||
|
||||
<a href="/graphrag/posts/index/overview/" class="is-active" aria-current="page">Indexing</a>
|
||||
<a href="/posts/index/overview/" class="is-active" aria-current="page">Indexing</a>
|
||||
|
||||
<ul><li>
|
||||
<a href="/graphrag/posts/index/0-architecture/">Architecture</a>
|
||||
<a href="/posts/index/0-architecture/">Architecture</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/index/1-default_dataflow/">Dataflow</a>
|
||||
<a href="/posts/index/1-default_dataflow/">Dataflow</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/index/2-cli/">CLI</a>
|
||||
<a href="/posts/index/2-cli/">CLI</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/index/3-prompt_tuning/">Prompt Tuning</a>
|
||||
<a href="/posts/index/3-prompt_tuning/">Prompt Tuning</a>
|
||||
</li><li>
|
||||
|
||||
<a href="/graphrag/posts/config/overview/">Configuration</a>
|
||||
<a href="/posts/config/overview/">Configuration</a>
|
||||
|
||||
<ul>
|
||||
<li>
|
||||
<a href="/graphrag/posts/config/env_vars">Using Env Vars</a>
|
||||
<a href="/posts/config/env_vars">Using Env Vars</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="/graphrag/posts/config/json_yaml">Using JSON or YAML</a>
|
||||
<a href="/posts/config/json_yaml">Using JSON or YAML</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="/graphrag/posts/config/custom">Fully Custom</a>
|
||||
<a href="/posts/config/custom">Fully Custom</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="/graphrag/posts/config/template">Template</a>
|
||||
<a href="/posts/config/template">Template</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
@ -239,26 +239,26 @@ a {
|
||||
<!-- Query Links -->
|
||||
<li>
|
||||
|
||||
<a href="/graphrag/posts/query/overview/">Query</a>
|
||||
<a href="/posts/query/overview/">Query</a>
|
||||
|
||||
<ul><li>
|
||||
<a href="/graphrag/posts/query/1-local_search/">Local Search</a>
|
||||
<a href="/posts/query/1-local_search/">Local Search</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/query/2-question_generation/">Question Generation</a>
|
||||
<a href="/posts/query/2-question_generation/">Question Generation</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/query/0-global_search/">Global Search</a>
|
||||
<a href="/posts/query/0-global_search/">Global Search</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/query/3-cli/">CLI</a>
|
||||
<a href="/posts/query/3-cli/">CLI</a>
|
||||
</li><li>
|
||||
|
||||
<a href="/graphrag/posts/query/notebooks/overview/">Notebooks</a>
|
||||
<a href="/posts/query/notebooks/overview/">Notebooks</a>
|
||||
|
||||
<ul>
|
||||
<li>
|
||||
<a href="/graphrag/posts/query/notebooks/global_search_nb">Global Search</a>
|
||||
<a href="/posts/query/notebooks/global_search_nb">Global Search</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="/graphrag/posts/query/notebooks/local_search_nb">Local Search</a>
|
||||
<a href="/posts/query/notebooks/local_search_nb">Local Search</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
@ -282,9 +282,9 @@ a {
|
||||
<p>The outputs of the pipeline can be stored in a variety of formats, including JSON and Parquet - or they can be handled manually via the Python API.</p>
|
||||
<h2>Getting Started</h2>
|
||||
<h3>Requirements</h3>
|
||||
<p>See the <a href="/graphrag/posts/developing#requirements">requirements</a> section in <a href="/graphrag/posts/get_started">Get Started</a> for details on setting up a development environment.</p>
|
||||
<p>See the <a href="/posts/developing#requirements">requirements</a> section in <a href="/posts/get_started">Get Started</a> for details on setting up a development environment.</p>
|
||||
<p>The Indexing Engine can be used in either a default configuration mode or with a custom pipeline.
|
||||
To configure GraphRAG, see the <a href="/graphrag/posts/config/overview">configuration</a> documentation.
|
||||
To configure GraphRAG, see the <a href="/posts/config/overview">configuration</a> documentation.
|
||||
After you have a config file you can run the pipeline using the CLI or the Python API.</p>
|
||||
<h2>Usage</h2>
|
||||
<h3>CLI</h3>
|
||||
@ -340,10 +340,10 @@ pipeline_result <span class="token operator">=</span> outputs<span class="token
|
||||
</div>
|
||||
<h2>Further Reading</h2>
|
||||
<ul>
|
||||
<li>To start developing within the <em>GraphRAG</em> project, see <a href="/graphrag/posts/developing/">getting started</a></li>
|
||||
<li>To understand the underlying concepts and execution model of the indexing library, see <a href="/graphrag/posts/index/0-architecture/">the architecture documentation</a></li>
|
||||
<li>To start developing within the <em>GraphRAG</em> project, see <a href="/posts/developing/">getting started</a></li>
|
||||
<li>To understand the underlying concepts and execution model of the indexing library, see <a href="/posts/index/0-architecture/">the architecture documentation</a></li>
|
||||
<li>To get running with a series of examples, see <a href="https://github.com/microsoft/graphrag/blob/main/examples/README.md">the examples documentation</a></li>
|
||||
<li>To read more about configuring the indexing engine, see <a href="/graphrag/posts/config/overview">the configuration documentation</a></li>
|
||||
<li>To read more about configuring the indexing engine, see <a href="/posts/config/overview">the configuration documentation</a></li>
|
||||
</ul>
|
||||
|
||||
</main>
|
||||
|
||||
@ -178,7 +178,7 @@ a {
|
||||
<body>
|
||||
<header>
|
||||
<div id="cookie-banner"></div>
|
||||
<a href="/graphrag/"><span class="logotitle">GraphRAG</span></a>
|
||||
<a href="/"><span class="logotitle">GraphRAG</span></a>
|
||||
</header>
|
||||
<div class="page-content">
|
||||
<!-- Sidebar -->
|
||||
@ -186,49 +186,49 @@ a {
|
||||
<ul class="menu-list">
|
||||
<li>
|
||||
|
||||
<a href="/graphrag/">Welcome</a>
|
||||
<a href="/">Welcome</a>
|
||||
|
||||
</li>
|
||||
|
||||
<!-- Get Started Links -->
|
||||
<li>
|
||||
|
||||
<a href="/graphrag/posts/get_started/">Get Started</a>
|
||||
<a href="/posts/get_started/">Get Started</a>
|
||||
|
||||
|
||||
<a href="/graphrag/posts/developing/">Developing</a>
|
||||
<a href="/posts/developing/">Developing</a>
|
||||
|
||||
</li>
|
||||
|
||||
<!-- Indexing Links -->
|
||||
<li>
|
||||
|
||||
<a href="/graphrag/posts/index/overview/">Indexing</a>
|
||||
<a href="/posts/index/overview/">Indexing</a>
|
||||
|
||||
<ul><li>
|
||||
<a href="/graphrag/posts/index/0-architecture/">Architecture</a>
|
||||
<a href="/posts/index/0-architecture/">Architecture</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/index/1-default_dataflow/">Dataflow</a>
|
||||
<a href="/posts/index/1-default_dataflow/">Dataflow</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/index/2-cli/">CLI</a>
|
||||
<a href="/posts/index/2-cli/">CLI</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/index/3-prompt_tuning/">Prompt Tuning</a>
|
||||
<a href="/posts/index/3-prompt_tuning/">Prompt Tuning</a>
|
||||
</li><li>
|
||||
|
||||
<a href="/graphrag/posts/config/overview/">Configuration</a>
|
||||
<a href="/posts/config/overview/">Configuration</a>
|
||||
|
||||
<ul>
|
||||
<li>
|
||||
<a href="/graphrag/posts/config/env_vars">Using Env Vars</a>
|
||||
<a href="/posts/config/env_vars">Using Env Vars</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="/graphrag/posts/config/json_yaml">Using JSON or YAML</a>
|
||||
<a href="/posts/config/json_yaml">Using JSON or YAML</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="/graphrag/posts/config/custom">Fully Custom</a>
|
||||
<a href="/posts/config/custom">Fully Custom</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="/graphrag/posts/config/template">Template</a>
|
||||
<a href="/posts/config/template">Template</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
@ -239,26 +239,26 @@ a {
|
||||
<!-- Query Links -->
|
||||
<li>
|
||||
|
||||
<a href="/graphrag/posts/query/overview/">Query</a>
|
||||
<a href="/posts/query/overview/">Query</a>
|
||||
|
||||
<ul><li>
|
||||
<a href="/graphrag/posts/query/1-local_search/">Local Search</a>
|
||||
<a href="/posts/query/1-local_search/">Local Search</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/query/2-question_generation/">Question Generation</a>
|
||||
<a href="/posts/query/2-question_generation/">Question Generation</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/query/0-global_search/" class="is-active" aria-current="page">Global Search</a>
|
||||
<a href="/posts/query/0-global_search/" class="is-active" aria-current="page">Global Search</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/query/3-cli/">CLI</a>
|
||||
<a href="/posts/query/3-cli/">CLI</a>
|
||||
</li><li>
|
||||
|
||||
<a href="/graphrag/posts/query/notebooks/overview/">Notebooks</a>
|
||||
<a href="/posts/query/notebooks/overview/">Notebooks</a>
|
||||
|
||||
<ul>
|
||||
<li>
|
||||
<a href="/graphrag/posts/query/notebooks/global_search_nb">Global Search</a>
|
||||
<a href="/posts/query/notebooks/global_search_nb">Global Search</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="/graphrag/posts/query/notebooks/local_search_nb">Local Search</a>
|
||||
<a href="/posts/query/notebooks/local_search_nb">Local Search</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
|
||||
@ -178,7 +178,7 @@ a {
|
||||
<body>
|
||||
<header>
|
||||
<div id="cookie-banner"></div>
|
||||
<a href="/graphrag/"><span class="logotitle">GraphRAG</span></a>
|
||||
<a href="/"><span class="logotitle">GraphRAG</span></a>
|
||||
</header>
|
||||
<div class="page-content">
|
||||
<!-- Sidebar -->
|
||||
@ -186,49 +186,49 @@ a {
|
||||
<ul class="menu-list">
|
||||
<li>
|
||||
|
||||
<a href="/graphrag/">Welcome</a>
|
||||
<a href="/">Welcome</a>
|
||||
|
||||
</li>
|
||||
|
||||
<!-- Get Started Links -->
|
||||
<li>
|
||||
|
||||
<a href="/graphrag/posts/get_started/">Get Started</a>
|
||||
<a href="/posts/get_started/">Get Started</a>
|
||||
|
||||
|
||||
<a href="/graphrag/posts/developing/">Developing</a>
|
||||
<a href="/posts/developing/">Developing</a>
|
||||
|
||||
</li>
|
||||
|
||||
<!-- Indexing Links -->
|
||||
<li>
|
||||
|
||||
<a href="/graphrag/posts/index/overview/">Indexing</a>
|
||||
<a href="/posts/index/overview/">Indexing</a>
|
||||
|
||||
<ul><li>
|
||||
<a href="/graphrag/posts/index/0-architecture/">Architecture</a>
|
||||
<a href="/posts/index/0-architecture/">Architecture</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/index/1-default_dataflow/">Dataflow</a>
|
||||
<a href="/posts/index/1-default_dataflow/">Dataflow</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/index/2-cli/">CLI</a>
|
||||
<a href="/posts/index/2-cli/">CLI</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/index/3-prompt_tuning/">Prompt Tuning</a>
|
||||
<a href="/posts/index/3-prompt_tuning/">Prompt Tuning</a>
|
||||
</li><li>
|
||||
|
||||
<a href="/graphrag/posts/config/overview/">Configuration</a>
|
||||
<a href="/posts/config/overview/">Configuration</a>
|
||||
|
||||
<ul>
|
||||
<li>
|
||||
<a href="/graphrag/posts/config/env_vars">Using Env Vars</a>
|
||||
<a href="/posts/config/env_vars">Using Env Vars</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="/graphrag/posts/config/json_yaml">Using JSON or YAML</a>
|
||||
<a href="/posts/config/json_yaml">Using JSON or YAML</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="/graphrag/posts/config/custom">Fully Custom</a>
|
||||
<a href="/posts/config/custom">Fully Custom</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="/graphrag/posts/config/template">Template</a>
|
||||
<a href="/posts/config/template">Template</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
@ -239,26 +239,26 @@ a {
|
||||
<!-- Query Links -->
|
||||
<li>
|
||||
|
||||
<a href="/graphrag/posts/query/overview/">Query</a>
|
||||
<a href="/posts/query/overview/">Query</a>
|
||||
|
||||
<ul><li>
|
||||
<a href="/graphrag/posts/query/1-local_search/" class="is-active" aria-current="page">Local Search</a>
|
||||
<a href="/posts/query/1-local_search/" class="is-active" aria-current="page">Local Search</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/query/2-question_generation/">Question Generation</a>
|
||||
<a href="/posts/query/2-question_generation/">Question Generation</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/query/0-global_search/">Global Search</a>
|
||||
<a href="/posts/query/0-global_search/">Global Search</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/query/3-cli/">CLI</a>
|
||||
<a href="/posts/query/3-cli/">CLI</a>
|
||||
</li><li>
|
||||
|
||||
<a href="/graphrag/posts/query/notebooks/overview/">Notebooks</a>
|
||||
<a href="/posts/query/notebooks/overview/">Notebooks</a>
|
||||
|
||||
<ul>
|
||||
<li>
|
||||
<a href="/graphrag/posts/query/notebooks/global_search_nb">Global Search</a>
|
||||
<a href="/posts/query/notebooks/global_search_nb">Global Search</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="/graphrag/posts/query/notebooks/local_search_nb">Local Search</a>
|
||||
<a href="/posts/query/notebooks/local_search_nb">Local Search</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
|
||||
@ -178,7 +178,7 @@ a {
|
||||
<body>
|
||||
<header>
|
||||
<div id="cookie-banner"></div>
|
||||
<a href="/graphrag/"><span class="logotitle">GraphRAG</span></a>
|
||||
<a href="/"><span class="logotitle">GraphRAG</span></a>
|
||||
</header>
|
||||
<div class="page-content">
|
||||
<!-- Sidebar -->
|
||||
@ -186,49 +186,49 @@ a {
|
||||
<ul class="menu-list">
|
||||
<li>
|
||||
|
||||
<a href="/graphrag/">Welcome</a>
|
||||
<a href="/">Welcome</a>
|
||||
|
||||
</li>
|
||||
|
||||
<!-- Get Started Links -->
|
||||
<li>
|
||||
|
||||
<a href="/graphrag/posts/get_started/">Get Started</a>
|
||||
<a href="/posts/get_started/">Get Started</a>
|
||||
|
||||
|
||||
<a href="/graphrag/posts/developing/">Developing</a>
|
||||
<a href="/posts/developing/">Developing</a>
|
||||
|
||||
</li>
|
||||
|
||||
<!-- Indexing Links -->
|
||||
<li>
|
||||
|
||||
<a href="/graphrag/posts/index/overview/">Indexing</a>
|
||||
<a href="/posts/index/overview/">Indexing</a>
|
||||
|
||||
<ul><li>
|
||||
<a href="/graphrag/posts/index/0-architecture/">Architecture</a>
|
||||
<a href="/posts/index/0-architecture/">Architecture</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/index/1-default_dataflow/">Dataflow</a>
|
||||
<a href="/posts/index/1-default_dataflow/">Dataflow</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/index/2-cli/">CLI</a>
|
||||
<a href="/posts/index/2-cli/">CLI</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/index/3-prompt_tuning/">Prompt Tuning</a>
|
||||
<a href="/posts/index/3-prompt_tuning/">Prompt Tuning</a>
|
||||
</li><li>
|
||||
|
||||
<a href="/graphrag/posts/config/overview/">Configuration</a>
|
||||
<a href="/posts/config/overview/">Configuration</a>
|
||||
|
||||
<ul>
|
||||
<li>
|
||||
<a href="/graphrag/posts/config/env_vars">Using Env Vars</a>
|
||||
<a href="/posts/config/env_vars">Using Env Vars</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="/graphrag/posts/config/json_yaml">Using JSON or YAML</a>
|
||||
<a href="/posts/config/json_yaml">Using JSON or YAML</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="/graphrag/posts/config/custom">Fully Custom</a>
|
||||
<a href="/posts/config/custom">Fully Custom</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="/graphrag/posts/config/template">Template</a>
|
||||
<a href="/posts/config/template">Template</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
@ -239,26 +239,26 @@ a {
|
||||
<!-- Query Links -->
|
||||
<li>
|
||||
|
||||
<a href="/graphrag/posts/query/overview/">Query</a>
|
||||
<a href="/posts/query/overview/">Query</a>
|
||||
|
||||
<ul><li>
|
||||
<a href="/graphrag/posts/query/1-local_search/">Local Search</a>
|
||||
<a href="/posts/query/1-local_search/">Local Search</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/query/2-question_generation/" class="is-active" aria-current="page">Question Generation</a>
|
||||
<a href="/posts/query/2-question_generation/" class="is-active" aria-current="page">Question Generation</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/query/0-global_search/">Global Search</a>
|
||||
<a href="/posts/query/0-global_search/">Global Search</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/query/3-cli/">CLI</a>
|
||||
<a href="/posts/query/3-cli/">CLI</a>
|
||||
</li><li>
|
||||
|
||||
<a href="/graphrag/posts/query/notebooks/overview/">Notebooks</a>
|
||||
<a href="/posts/query/notebooks/overview/">Notebooks</a>
|
||||
|
||||
<ul>
|
||||
<li>
|
||||
<a href="/graphrag/posts/query/notebooks/global_search_nb">Global Search</a>
|
||||
<a href="/posts/query/notebooks/global_search_nb">Global Search</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="/graphrag/posts/query/notebooks/local_search_nb">Local Search</a>
|
||||
<a href="/posts/query/notebooks/local_search_nb">Local Search</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
|
||||
@ -178,7 +178,7 @@ a {
|
||||
<body>
|
||||
<header>
|
||||
<div id="cookie-banner"></div>
|
||||
<a href="/graphrag/"><span class="logotitle">GraphRAG</span></a>
|
||||
<a href="/"><span class="logotitle">GraphRAG</span></a>
|
||||
</header>
|
||||
<div class="page-content">
|
||||
<!-- Sidebar -->
|
||||
@ -186,49 +186,49 @@ a {
|
||||
<ul class="menu-list">
|
||||
<li>
|
||||
|
||||
<a href="/graphrag/">Welcome</a>
|
||||
<a href="/">Welcome</a>
|
||||
|
||||
</li>
|
||||
|
||||
<!-- Get Started Links -->
|
||||
<li>
|
||||
|
||||
<a href="/graphrag/posts/get_started/">Get Started</a>
|
||||
<a href="/posts/get_started/">Get Started</a>
|
||||
|
||||
|
||||
<a href="/graphrag/posts/developing/">Developing</a>
|
||||
<a href="/posts/developing/">Developing</a>
|
||||
|
||||
</li>
|
||||
|
||||
<!-- Indexing Links -->
|
||||
<li>
|
||||
|
||||
<a href="/graphrag/posts/index/overview/">Indexing</a>
|
||||
<a href="/posts/index/overview/">Indexing</a>
|
||||
|
||||
<ul><li>
|
||||
<a href="/graphrag/posts/index/0-architecture/">Architecture</a>
|
||||
<a href="/posts/index/0-architecture/">Architecture</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/index/1-default_dataflow/">Dataflow</a>
|
||||
<a href="/posts/index/1-default_dataflow/">Dataflow</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/index/2-cli/">CLI</a>
|
||||
<a href="/posts/index/2-cli/">CLI</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/index/3-prompt_tuning/">Prompt Tuning</a>
|
||||
<a href="/posts/index/3-prompt_tuning/">Prompt Tuning</a>
|
||||
</li><li>
|
||||
|
||||
<a href="/graphrag/posts/config/overview/">Configuration</a>
|
||||
<a href="/posts/config/overview/">Configuration</a>
|
||||
|
||||
<ul>
|
||||
<li>
|
||||
<a href="/graphrag/posts/config/env_vars">Using Env Vars</a>
|
||||
<a href="/posts/config/env_vars">Using Env Vars</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="/graphrag/posts/config/json_yaml">Using JSON or YAML</a>
|
||||
<a href="/posts/config/json_yaml">Using JSON or YAML</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="/graphrag/posts/config/custom">Fully Custom</a>
|
||||
<a href="/posts/config/custom">Fully Custom</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="/graphrag/posts/config/template">Template</a>
|
||||
<a href="/posts/config/template">Template</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
@ -239,26 +239,26 @@ a {
|
||||
<!-- Query Links -->
|
||||
<li>
|
||||
|
||||
<a href="/graphrag/posts/query/overview/">Query</a>
|
||||
<a href="/posts/query/overview/">Query</a>
|
||||
|
||||
<ul><li>
|
||||
<a href="/graphrag/posts/query/1-local_search/">Local Search</a>
|
||||
<a href="/posts/query/1-local_search/">Local Search</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/query/2-question_generation/">Question Generation</a>
|
||||
<a href="/posts/query/2-question_generation/">Question Generation</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/query/0-global_search/">Global Search</a>
|
||||
<a href="/posts/query/0-global_search/">Global Search</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/query/3-cli/" class="is-active" aria-current="page">CLI</a>
|
||||
<a href="/posts/query/3-cli/" class="is-active" aria-current="page">CLI</a>
|
||||
</li><li>
|
||||
|
||||
<a href="/graphrag/posts/query/notebooks/overview/">Notebooks</a>
|
||||
<a href="/posts/query/notebooks/overview/">Notebooks</a>
|
||||
|
||||
<ul>
|
||||
<li>
|
||||
<a href="/graphrag/posts/query/notebooks/global_search_nb">Global Search</a>
|
||||
<a href="/posts/query/notebooks/global_search_nb">Global Search</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="/graphrag/posts/query/notebooks/local_search_nb">Local Search</a>
|
||||
<a href="/posts/query/notebooks/local_search_nb">Local Search</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
|
||||
@ -178,7 +178,7 @@ a {
|
||||
<body>
|
||||
<header>
|
||||
<div id="cookie-banner"></div>
|
||||
<a href="/graphrag/"><span class="logotitle">GraphRAG</span></a>
|
||||
<a href="/"><span class="logotitle">GraphRAG</span></a>
|
||||
</header>
|
||||
<div class="page-content">
|
||||
<!-- Sidebar -->
|
||||
@ -186,49 +186,49 @@ a {
|
||||
<ul class="menu-list">
|
||||
<li>
|
||||
|
||||
<a href="/graphrag/">Welcome</a>
|
||||
<a href="/">Welcome</a>
|
||||
|
||||
</li>
|
||||
|
||||
<!-- Get Started Links -->
|
||||
<li>
|
||||
|
||||
<a href="/graphrag/posts/get_started/">Get Started</a>
|
||||
<a href="/posts/get_started/">Get Started</a>
|
||||
|
||||
|
||||
<a href="/graphrag/posts/developing/">Developing</a>
|
||||
<a href="/posts/developing/">Developing</a>
|
||||
|
||||
</li>
|
||||
|
||||
<!-- Indexing Links -->
|
||||
<li>
|
||||
|
||||
<a href="/graphrag/posts/index/overview/">Indexing</a>
|
||||
<a href="/posts/index/overview/">Indexing</a>
|
||||
|
||||
<ul><li>
|
||||
<a href="/graphrag/posts/index/0-architecture/">Architecture</a>
|
||||
<a href="/posts/index/0-architecture/">Architecture</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/index/1-default_dataflow/">Dataflow</a>
|
||||
<a href="/posts/index/1-default_dataflow/">Dataflow</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/index/2-cli/">CLI</a>
|
||||
<a href="/posts/index/2-cli/">CLI</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/index/3-prompt_tuning/">Prompt Tuning</a>
|
||||
<a href="/posts/index/3-prompt_tuning/">Prompt Tuning</a>
|
||||
</li><li>
|
||||
|
||||
<a href="/graphrag/posts/config/overview/">Configuration</a>
|
||||
<a href="/posts/config/overview/">Configuration</a>
|
||||
|
||||
<ul>
|
||||
<li>
|
||||
<a href="/graphrag/posts/config/env_vars">Using Env Vars</a>
|
||||
<a href="/posts/config/env_vars">Using Env Vars</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="/graphrag/posts/config/json_yaml">Using JSON or YAML</a>
|
||||
<a href="/posts/config/json_yaml">Using JSON or YAML</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="/graphrag/posts/config/custom">Fully Custom</a>
|
||||
<a href="/posts/config/custom">Fully Custom</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="/graphrag/posts/config/template">Template</a>
|
||||
<a href="/posts/config/template">Template</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
@ -239,26 +239,26 @@ a {
|
||||
<!-- Query Links -->
|
||||
<li>
|
||||
|
||||
<a href="/graphrag/posts/query/overview/">Query</a>
|
||||
<a href="/posts/query/overview/">Query</a>
|
||||
|
||||
<ul><li>
|
||||
<a href="/graphrag/posts/query/1-local_search/">Local Search</a>
|
||||
<a href="/posts/query/1-local_search/">Local Search</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/query/2-question_generation/">Question Generation</a>
|
||||
<a href="/posts/query/2-question_generation/">Question Generation</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/query/0-global_search/">Global Search</a>
|
||||
<a href="/posts/query/0-global_search/">Global Search</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/query/3-cli/">CLI</a>
|
||||
<a href="/posts/query/3-cli/">CLI</a>
|
||||
</li><li>
|
||||
|
||||
<a href="/graphrag/posts/query/notebooks/overview/">Notebooks</a>
|
||||
<a href="/posts/query/notebooks/overview/">Notebooks</a>
|
||||
|
||||
<ul>
|
||||
<li>
|
||||
<a href="/graphrag/posts/query/notebooks/global_search_nb">Global Search</a>
|
||||
<a href="/posts/query/notebooks/global_search_nb">Global Search</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="/graphrag/posts/query/notebooks/local_search_nb">Local Search</a>
|
||||
<a href="/posts/query/notebooks/local_search_nb">Local Search</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
|
||||
@ -178,7 +178,7 @@ a {
|
||||
<body>
|
||||
<header>
|
||||
<div id="cookie-banner"></div>
|
||||
<a href="/graphrag/"><span class="logotitle">GraphRAG</span></a>
|
||||
<a href="/"><span class="logotitle">GraphRAG</span></a>
|
||||
</header>
|
||||
<div class="page-content">
|
||||
<!-- Sidebar -->
|
||||
@ -186,49 +186,49 @@ a {
|
||||
<ul class="menu-list">
|
||||
<li>
|
||||
|
||||
<a href="/graphrag/">Welcome</a>
|
||||
<a href="/">Welcome</a>
|
||||
|
||||
</li>
|
||||
|
||||
<!-- Get Started Links -->
|
||||
<li>
|
||||
|
||||
<a href="/graphrag/posts/get_started/">Get Started</a>
|
||||
<a href="/posts/get_started/">Get Started</a>
|
||||
|
||||
|
||||
<a href="/graphrag/posts/developing/">Developing</a>
|
||||
<a href="/posts/developing/">Developing</a>
|
||||
|
||||
</li>
|
||||
|
||||
<!-- Indexing Links -->
|
||||
<li>
|
||||
|
||||
<a href="/graphrag/posts/index/overview/">Indexing</a>
|
||||
<a href="/posts/index/overview/">Indexing</a>
|
||||
|
||||
<ul><li>
|
||||
<a href="/graphrag/posts/index/0-architecture/">Architecture</a>
|
||||
<a href="/posts/index/0-architecture/">Architecture</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/index/1-default_dataflow/">Dataflow</a>
|
||||
<a href="/posts/index/1-default_dataflow/">Dataflow</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/index/2-cli/">CLI</a>
|
||||
<a href="/posts/index/2-cli/">CLI</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/index/3-prompt_tuning/">Prompt Tuning</a>
|
||||
<a href="/posts/index/3-prompt_tuning/">Prompt Tuning</a>
|
||||
</li><li>
|
||||
|
||||
<a href="/graphrag/posts/config/overview/">Configuration</a>
|
||||
<a href="/posts/config/overview/">Configuration</a>
|
||||
|
||||
<ul>
|
||||
<li>
|
||||
<a href="/graphrag/posts/config/env_vars">Using Env Vars</a>
|
||||
<a href="/posts/config/env_vars">Using Env Vars</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="/graphrag/posts/config/json_yaml">Using JSON or YAML</a>
|
||||
<a href="/posts/config/json_yaml">Using JSON or YAML</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="/graphrag/posts/config/custom">Fully Custom</a>
|
||||
<a href="/posts/config/custom">Fully Custom</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="/graphrag/posts/config/template">Template</a>
|
||||
<a href="/posts/config/template">Template</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
@ -239,26 +239,26 @@ a {
|
||||
<!-- Query Links -->
|
||||
<li>
|
||||
|
||||
<a href="/graphrag/posts/query/overview/">Query</a>
|
||||
<a href="/posts/query/overview/">Query</a>
|
||||
|
||||
<ul><li>
|
||||
<a href="/graphrag/posts/query/1-local_search/">Local Search</a>
|
||||
<a href="/posts/query/1-local_search/">Local Search</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/query/2-question_generation/">Question Generation</a>
|
||||
<a href="/posts/query/2-question_generation/">Question Generation</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/query/0-global_search/">Global Search</a>
|
||||
<a href="/posts/query/0-global_search/">Global Search</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/query/3-cli/">CLI</a>
|
||||
<a href="/posts/query/3-cli/">CLI</a>
|
||||
</li><li>
|
||||
|
||||
<a href="/graphrag/posts/query/notebooks/overview/">Notebooks</a>
|
||||
<a href="/posts/query/notebooks/overview/">Notebooks</a>
|
||||
|
||||
<ul>
|
||||
<li>
|
||||
<a href="/graphrag/posts/query/notebooks/global_search_nb">Global Search</a>
|
||||
<a href="/posts/query/notebooks/global_search_nb">Global Search</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="/graphrag/posts/query/notebooks/local_search_nb">Local Search</a>
|
||||
<a href="/posts/query/notebooks/local_search_nb">Local Search</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
|
||||
@ -178,7 +178,7 @@ a {
|
||||
<body>
|
||||
<header>
|
||||
<div id="cookie-banner"></div>
|
||||
<a href="/graphrag/"><span class="logotitle">GraphRAG</span></a>
|
||||
<a href="/"><span class="logotitle">GraphRAG</span></a>
|
||||
</header>
|
||||
<div class="page-content">
|
||||
<!-- Sidebar -->
|
||||
@ -186,49 +186,49 @@ a {
|
||||
<ul class="menu-list">
|
||||
<li>
|
||||
|
||||
<a href="/graphrag/">Welcome</a>
|
||||
<a href="/">Welcome</a>
|
||||
|
||||
</li>
|
||||
|
||||
<!-- Get Started Links -->
|
||||
<li>
|
||||
|
||||
<a href="/graphrag/posts/get_started/">Get Started</a>
|
||||
<a href="/posts/get_started/">Get Started</a>
|
||||
|
||||
|
||||
<a href="/graphrag/posts/developing/">Developing</a>
|
||||
<a href="/posts/developing/">Developing</a>
|
||||
|
||||
</li>
|
||||
|
||||
<!-- Indexing Links -->
|
||||
<li>
|
||||
|
||||
<a href="/graphrag/posts/index/overview/">Indexing</a>
|
||||
<a href="/posts/index/overview/">Indexing</a>
|
||||
|
||||
<ul><li>
|
||||
<a href="/graphrag/posts/index/0-architecture/">Architecture</a>
|
||||
<a href="/posts/index/0-architecture/">Architecture</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/index/1-default_dataflow/">Dataflow</a>
|
||||
<a href="/posts/index/1-default_dataflow/">Dataflow</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/index/2-cli/">CLI</a>
|
||||
<a href="/posts/index/2-cli/">CLI</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/index/3-prompt_tuning/">Prompt Tuning</a>
|
||||
<a href="/posts/index/3-prompt_tuning/">Prompt Tuning</a>
|
||||
</li><li>
|
||||
|
||||
<a href="/graphrag/posts/config/overview/">Configuration</a>
|
||||
<a href="/posts/config/overview/">Configuration</a>
|
||||
|
||||
<ul>
|
||||
<li>
|
||||
<a href="/graphrag/posts/config/env_vars">Using Env Vars</a>
|
||||
<a href="/posts/config/env_vars">Using Env Vars</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="/graphrag/posts/config/json_yaml">Using JSON or YAML</a>
|
||||
<a href="/posts/config/json_yaml">Using JSON or YAML</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="/graphrag/posts/config/custom">Fully Custom</a>
|
||||
<a href="/posts/config/custom">Fully Custom</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="/graphrag/posts/config/template">Template</a>
|
||||
<a href="/posts/config/template">Template</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
@ -239,26 +239,26 @@ a {
|
||||
<!-- Query Links -->
|
||||
<li>
|
||||
|
||||
<a href="/graphrag/posts/query/overview/">Query</a>
|
||||
<a href="/posts/query/overview/">Query</a>
|
||||
|
||||
<ul><li>
|
||||
<a href="/graphrag/posts/query/1-local_search/">Local Search</a>
|
||||
<a href="/posts/query/1-local_search/">Local Search</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/query/2-question_generation/">Question Generation</a>
|
||||
<a href="/posts/query/2-question_generation/">Question Generation</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/query/0-global_search/">Global Search</a>
|
||||
<a href="/posts/query/0-global_search/">Global Search</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/query/3-cli/">CLI</a>
|
||||
<a href="/posts/query/3-cli/">CLI</a>
|
||||
</li><li>
|
||||
|
||||
<a href="/graphrag/posts/query/notebooks/overview/" class="is-active" aria-current="page">Notebooks</a>
|
||||
<a href="/posts/query/notebooks/overview/" class="is-active" aria-current="page">Notebooks</a>
|
||||
|
||||
<ul>
|
||||
<li>
|
||||
<a href="/graphrag/posts/query/notebooks/global_search_nb">Global Search</a>
|
||||
<a href="/posts/query/notebooks/global_search_nb">Global Search</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="/graphrag/posts/query/notebooks/local_search_nb">Local Search</a>
|
||||
<a href="/posts/query/notebooks/local_search_nb">Local Search</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
@ -272,10 +272,10 @@ a {
|
||||
<h1>Query Engine Notebooks</h1>
|
||||
<p>For examples about running Query please refer to the following notebooks:</p>
|
||||
<ul>
|
||||
<li><a href="/graphrag/posts/query/notebooks/global_search_nb">Global Search Notebook</a></li>
|
||||
<li><a href="/graphrag/posts/query/notebooks/local_search_nb">Local Search Notebook</a></li>
|
||||
<li><a href="/posts/query/notebooks/global_search_nb">Global Search Notebook</a></li>
|
||||
<li><a href="/posts/query/notebooks/local_search_nb">Local Search Notebook</a></li>
|
||||
</ul>
|
||||
<p>The test dataset for these notebooks can be found <a href="/graphrag/data/operation_dulce/dataset.zip">here</a>.</p>
|
||||
<p>The test dataset for these notebooks can be found <a href="/data/operation_dulce/dataset.zip">here</a>.</p>
|
||||
|
||||
</main>
|
||||
</div>
|
||||
|
||||
@ -178,7 +178,7 @@ a {
|
||||
<body>
|
||||
<header>
|
||||
<div id="cookie-banner"></div>
|
||||
<a href="/graphrag/"><span class="logotitle">GraphRAG</span></a>
|
||||
<a href="/"><span class="logotitle">GraphRAG</span></a>
|
||||
</header>
|
||||
<div class="page-content">
|
||||
<!-- Sidebar -->
|
||||
@ -186,49 +186,49 @@ a {
|
||||
<ul class="menu-list">
|
||||
<li>
|
||||
|
||||
<a href="/graphrag/">Welcome</a>
|
||||
<a href="/">Welcome</a>
|
||||
|
||||
</li>
|
||||
|
||||
<!-- Get Started Links -->
|
||||
<li>
|
||||
|
||||
<a href="/graphrag/posts/get_started/">Get Started</a>
|
||||
<a href="/posts/get_started/">Get Started</a>
|
||||
|
||||
|
||||
<a href="/graphrag/posts/developing/">Developing</a>
|
||||
<a href="/posts/developing/">Developing</a>
|
||||
|
||||
</li>
|
||||
|
||||
<!-- Indexing Links -->
|
||||
<li>
|
||||
|
||||
<a href="/graphrag/posts/index/overview/">Indexing</a>
|
||||
<a href="/posts/index/overview/">Indexing</a>
|
||||
|
||||
<ul><li>
|
||||
<a href="/graphrag/posts/index/0-architecture/">Architecture</a>
|
||||
<a href="/posts/index/0-architecture/">Architecture</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/index/1-default_dataflow/">Dataflow</a>
|
||||
<a href="/posts/index/1-default_dataflow/">Dataflow</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/index/2-cli/">CLI</a>
|
||||
<a href="/posts/index/2-cli/">CLI</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/index/3-prompt_tuning/">Prompt Tuning</a>
|
||||
<a href="/posts/index/3-prompt_tuning/">Prompt Tuning</a>
|
||||
</li><li>
|
||||
|
||||
<a href="/graphrag/posts/config/overview/">Configuration</a>
|
||||
<a href="/posts/config/overview/">Configuration</a>
|
||||
|
||||
<ul>
|
||||
<li>
|
||||
<a href="/graphrag/posts/config/env_vars">Using Env Vars</a>
|
||||
<a href="/posts/config/env_vars">Using Env Vars</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="/graphrag/posts/config/json_yaml">Using JSON or YAML</a>
|
||||
<a href="/posts/config/json_yaml">Using JSON or YAML</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="/graphrag/posts/config/custom">Fully Custom</a>
|
||||
<a href="/posts/config/custom">Fully Custom</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="/graphrag/posts/config/template">Template</a>
|
||||
<a href="/posts/config/template">Template</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
@ -239,26 +239,26 @@ a {
|
||||
<!-- Query Links -->
|
||||
<li>
|
||||
|
||||
<a href="/graphrag/posts/query/overview/" class="is-active" aria-current="page">Query</a>
|
||||
<a href="/posts/query/overview/" class="is-active" aria-current="page">Query</a>
|
||||
|
||||
<ul><li>
|
||||
<a href="/graphrag/posts/query/1-local_search/">Local Search</a>
|
||||
<a href="/posts/query/1-local_search/">Local Search</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/query/2-question_generation/">Question Generation</a>
|
||||
<a href="/posts/query/2-question_generation/">Question Generation</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/query/0-global_search/">Global Search</a>
|
||||
<a href="/posts/query/0-global_search/">Global Search</a>
|
||||
</li><li>
|
||||
<a href="/graphrag/posts/query/3-cli/">CLI</a>
|
||||
<a href="/posts/query/3-cli/">CLI</a>
|
||||
</li><li>
|
||||
|
||||
<a href="/graphrag/posts/query/notebooks/overview/">Notebooks</a>
|
||||
<a href="/posts/query/notebooks/overview/">Notebooks</a>
|
||||
|
||||
<ul>
|
||||
<li>
|
||||
<a href="/graphrag/posts/query/notebooks/global_search_nb">Global Search</a>
|
||||
<a href="/posts/query/notebooks/global_search_nb">Global Search</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="/graphrag/posts/query/notebooks/local_search_nb">Local Search</a>
|
||||
<a href="/posts/query/notebooks/local_search_nb">Local Search</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
@ -270,7 +270,7 @@ a {
|
||||
<!-- Main Content -->
|
||||
<main>
|
||||
<h1>Query Engine 🔎</h1>
|
||||
<p>The Query Engine is the retrieval module of the Graph RAG Library. It is one of the two main components of the Graph RAG library, the other being the Indexing Pipeline (see <a href="/graphrag/posts/index/overview">Indexing Pipeline</a>).
|
||||
<p>The Query Engine is the retrieval module of the Graph RAG Library. It is one of the two main components of the Graph RAG library, the other being the Indexing Pipeline (see <a href="/posts/index/overview">Indexing Pipeline</a>).
|
||||
It is responsible for the following tasks:</p>
|
||||
<ul>
|
||||
<li><a href="#local-search">Local Search</a></li>
|
||||
@ -279,13 +279,13 @@ It is responsible for the following tasks:</p>
|
||||
</ul>
|
||||
<h2>Local Search</h2>
|
||||
<p>Local search method generates answers by combining relevant data from the AI-extracted knowledge-graph with text chunks of the raw documents. This method is suitable for questions that require an understanding of specific entities mentioned in the documents (e.g. What are the healing properties of chamomile?).</p>
|
||||
<p>For more details about how Local Search works please refer to the <a href="/graphrag/posts/query/1-local_search">Local Search</a> documentation.</p>
|
||||
<p>For more details about how Local Search works please refer to the <a href="/posts/query/1-local_search">Local Search</a> documentation.</p>
|
||||
<h2>Global Search</h2>
|
||||
<p>Global search method generates answers by searching over all AI-generated community reports in a map-reduce fashion. This is a resource-intensive method, but often gives good responses for questions that require an understanding of the dataset as a whole (e.g. What are the most significant values of the herbs mentioned in this notebook?).</p>
|
||||
<p>More about this can be checked at the <a href="/graphrag/posts/query/0-global_search">Global Search</a> documentation.</p>
|
||||
<p>More about this can be checked at the <a href="/posts/query/0-global_search">Global Search</a> documentation.</p>
|
||||
<h2>Question Generation</h2>
|
||||
<p>This functionality takes a list of user queries and generates the next candidate questions. This is useful for generating follow-up questions in a conversation or for generating a list of questions for the investigator to dive deeper into the dataset.</p>
|
||||
<p>Information about how question generation works can be found at the <a href="/graphrag/posts/query/2-question_generation">Question Generation</a> documentation page.</p>
|
||||
<p>Information about how question generation works can be found at the <a href="/posts/query/2-question_generation">Question Generation</a> documentation page.</p>
|
||||
|
||||
</main>
|
||||
</div>
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user