Deploying to gh-pages from @ microsoft/graphrag@25bbae8642 🚀

This commit is contained in:
natoverse 2025-04-29 00:38:22 +00:00
parent 9e31d7a5b2
commit c0060731bb
43 changed files with 5026 additions and 829 deletions

View File

@ -553,11 +553,11 @@
<li class="md-nav__item">
<a href="/index/architecture/" class="md-nav__link">
<a href="/index/default_dataflow/" class="md-nav__link">
<span class="md-ellipsis">
Architecture
Dataflow
</span>
@ -575,11 +575,11 @@
<li class="md-nav__item">
<a href="/index/default_dataflow/" class="md-nav__link">
<a href="/index/methods/" class="md-nav__link">
<span class="md-ellipsis">
Dataflow
Methods
</span>
@ -634,6 +634,28 @@
<li class="md-nav__item">
<a href="/index/byog/" class="md-nav__link">
<span class="md-ellipsis">
Custom Graphs
</span>
</a>
</li>
</ul>
</nav>
@ -1138,7 +1160,7 @@
<span class="md-ellipsis">
Using YAML
Detailed Configuration
</span>
@ -1156,11 +1178,11 @@
<li class="md-nav__item">
<a href="/config/env_vars/" class="md-nav__link">
<a href="/config/models/" class="md-nav__link">
<span class="md-ellipsis">
Using Env Vars
Language Model Selection
</span>

View File

@ -559,11 +559,11 @@
<li class="md-nav__item">
<a href="../index/architecture/" class="md-nav__link">
<a href="../index/default_dataflow/" class="md-nav__link">
<span class="md-ellipsis">
Architecture
Dataflow
</span>
@ -581,11 +581,11 @@
<li class="md-nav__item">
<a href="../index/default_dataflow/" class="md-nav__link">
<a href="../index/methods/" class="md-nav__link">
<span class="md-ellipsis">
Dataflow
Methods
</span>
@ -640,6 +640,28 @@
<li class="md-nav__item">
<a href="../index/byog/" class="md-nav__link">
<span class="md-ellipsis">
Custom Graphs
</span>
</a>
</li>
</ul>
</nav>
@ -1144,7 +1166,7 @@
<span class="md-ellipsis">
Using YAML
Detailed Configuration
</span>
@ -1162,11 +1184,11 @@
<li class="md-nav__item">
<a href="../config/env_vars/" class="md-nav__link">
<a href="../config/models/" class="md-nav__link">
<span class="md-ellipsis">
Using Env Vars
Language Model Selection
</span>

View File

@ -9,7 +9,7 @@
<link rel="prev" href="../config/env_vars/">
<link rel="prev" href="../config/models/">
<link rel="next" href="../blog_posts/">
@ -564,11 +564,11 @@
<li class="md-nav__item">
<a href="../index/architecture/" class="md-nav__link">
<a href="../index/default_dataflow/" class="md-nav__link">
<span class="md-ellipsis">
Architecture
Dataflow
</span>
@ -586,11 +586,11 @@
<li class="md-nav__item">
<a href="../index/default_dataflow/" class="md-nav__link">
<a href="../index/methods/" class="md-nav__link">
<span class="md-ellipsis">
Dataflow
Methods
</span>
@ -645,6 +645,28 @@
<li class="md-nav__item">
<a href="../index/byog/" class="md-nav__link">
<span class="md-ellipsis">
Custom Graphs
</span>
</a>
</li>
</ul>
</nav>
@ -1149,7 +1171,7 @@
<span class="md-ellipsis">
Using YAML
Detailed Configuration
</span>
@ -1167,11 +1189,11 @@
<li class="md-nav__item">
<a href="../config/env_vars/" class="md-nav__link">
<a href="../config/models/" class="md-nav__link">
<span class="md-ellipsis">
Using Env Vars
Language Model Selection
</span>
@ -1621,7 +1643,7 @@
<nav class="md-footer__inner md-grid" aria-label="Footer" >
<a href="../config/env_vars/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Using Env Vars">
<a href="../config/models/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Language Model Selection">
<div class="md-footer__button md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg>
@ -1631,7 +1653,7 @@
Previous
</span>
<div class="md-ellipsis">
Using Env Vars
Language Model Selection
</div>
</div>
</a>

View File

@ -9,10 +9,6 @@
<link rel="prev" href="../yaml/">
<link rel="next" href="../../cli/">
<link rel="icon" href="../../assets/images/favicon.png">
@ -20,7 +16,7 @@
<title>Using Env Vars - GraphRAG</title>
<title>Default Configuration Mode (using Env Vars) - GraphRAG</title>
@ -110,7 +106,7 @@
<div class="md-header__topic" data-md-component="header-topic">
<span class="md-ellipsis">
Using Env Vars
Default Configuration Mode (using Env Vars)
</span>
</div>
@ -287,12 +283,10 @@
<li class="md-tabs__item md-tabs__item--active">
<li class="md-tabs__item">
<a href="../overview/" class="md-tabs__link">
@ -564,11 +558,11 @@
<li class="md-nav__item">
<a href="../../index/architecture/" class="md-nav__link">
<a href="../../index/default_dataflow/" class="md-nav__link">
<span class="md-ellipsis">
Architecture
Dataflow
</span>
@ -586,11 +580,11 @@
<li class="md-nav__item">
<a href="../../index/default_dataflow/" class="md-nav__link">
<a href="../../index/methods/" class="md-nav__link">
<span class="md-ellipsis">
Dataflow
Methods
</span>
@ -645,6 +639,28 @@
<li class="md-nav__item">
<a href="../../index/byog/" class="md-nav__link">
<span class="md-ellipsis">
Custom Graphs
</span>
</a>
</li>
</ul>
</nav>
@ -1059,28 +1075,23 @@
<li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" checked>
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" >
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="">
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
<span class="md-ellipsis">
@ -1092,7 +1103,7 @@
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="true">
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_5">
<span class="md-nav__icon md-icon"></span>
Configuration
@ -1154,7 +1165,7 @@
<span class="md-ellipsis">
Using YAML
Detailed Configuration
</span>
@ -1169,225 +1180,19 @@
<li class="md-nav__item md-nav__item--active">
<input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
<label class="md-nav__link md-nav__link--active" for="__toc">
<span class="md-ellipsis">
Using Env Vars
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
<li class="md-nav__item">
<a href="../models/" class="md-nav__link">
<span class="md-ellipsis">
Using Env Vars
Language Model Selection
</span>
</a>
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#text-embeddings-customization" class="md-nav__link">
<span class="md-ellipsis">
Text-Embeddings Customization
</span>
</a>
<nav class="md-nav" aria-label="Text-Embeddings Customization">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#embedded-fields" class="md-nav__link">
<span class="md-ellipsis">
Embedded Fields
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#input-data" class="md-nav__link">
<span class="md-ellipsis">
Input Data
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#base-llm-settings" class="md-nav__link">
<span class="md-ellipsis">
Base LLM Settings
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#text-generation-settings" class="md-nav__link">
<span class="md-ellipsis">
Text Generation Settings
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#text-embedding-settings" class="md-nav__link">
<span class="md-ellipsis">
Text Embedding Settings
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#input-settings" class="md-nav__link">
<span class="md-ellipsis">
Input Settings
</span>
</a>
<nav class="md-nav" aria-label="Input Settings">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#plaintext-input-data-graphrag_input_file_typetext" class="md-nav__link">
<span class="md-ellipsis">
Plaintext Input Data (GRAPHRAG_INPUT_FILE_TYPE=text)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#csv-input-data-graphrag_input_file_typecsv" class="md-nav__link">
<span class="md-ellipsis">
CSV Input Data (GRAPHRAG_INPUT_FILE_TYPE=csv)
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#data-mapping-settings" class="md-nav__link">
<span class="md-ellipsis">
Data Mapping Settings
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#data-chunking" class="md-nav__link">
<span class="md-ellipsis">
Data Chunking
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#prompting-overrides" class="md-nav__link">
<span class="md-ellipsis">
Prompting Overrides
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#storage" class="md-nav__link">
<span class="md-ellipsis">
Storage
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#cache" class="md-nav__link">
<span class="md-ellipsis">
Cache
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#reporting" class="md-nav__link">
<span class="md-ellipsis">
Reporting
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#node2vec-parameters" class="md-nav__link">
<span class="md-ellipsis">
Node2Vec Parameters
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#data-snapshotting" class="md-nav__link">
<span class="md-ellipsis">
Data Snapshotting
</span>
</a>
</li>
</ul>
</nav>
</li>
@ -2798,44 +2603,6 @@
<footer class="md-footer">
<nav class="md-footer__inner md-grid" aria-label="Footer" >
<a href="../yaml/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Using YAML">
<div class="md-footer__button md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg>
</div>
<div class="md-footer__title">
<span class="md-footer__direction">
Previous
</span>
<div class="md-ellipsis">
Using YAML
</div>
</div>
</a>
<a href="../../cli/" class="md-footer__link md-footer__link--next" aria-label="Next: CLI">
<div class="md-footer__title">
<span class="md-footer__direction">
Next
</span>
<div class="md-ellipsis">
CLI
</div>
</div>
<div class="md-footer__button md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11z"/></svg>
</div>
</a>
</nav>
<div class="md-footer-meta md-typeset">
<div class="md-footer-meta__inner md-grid">

View File

@ -564,11 +564,11 @@
<li class="md-nav__item">
<a href="../../index/architecture/" class="md-nav__link">
<a href="../../index/default_dataflow/" class="md-nav__link">
<span class="md-ellipsis">
Architecture
Dataflow
</span>
@ -586,11 +586,11 @@
<li class="md-nav__item">
<a href="../../index/default_dataflow/" class="md-nav__link">
<a href="../../index/methods/" class="md-nav__link">
<span class="md-ellipsis">
Dataflow
Methods
</span>
@ -645,6 +645,28 @@
<li class="md-nav__item">
<a href="../../index/byog/" class="md-nav__link">
<span class="md-ellipsis">
Custom Graphs
</span>
</a>
</li>
</ul>
</nav>
@ -1240,7 +1262,7 @@
<span class="md-ellipsis">
Using YAML
Detailed Configuration
</span>
@ -1258,11 +1280,11 @@
<li class="md-nav__item">
<a href="../env_vars/" class="md-nav__link">
<a href="../models/" class="md-nav__link">
<span class="md-ellipsis">
Using Env Vars
Language Model Selection
</span>
@ -1593,7 +1615,7 @@
<li><code>prompts/</code> - The LLM prompts folder. This contains the default prompts used by GraphRAG, you can modify them or run the <a href="../../prompt_tuning/auto_prompt_tuning/">Auto Prompt Tuning</a> command to generate new prompts adapted to your data.</li>
</ul>
<h2 id="next-steps">Next Steps</h2>
<p>After initializing your workspace, you can either run the <a href="../../prompt_tuning/auto_prompt_tuning/">Prompt Tuning</a> command to adapt the prompts to your data or even start running the <a href="../../index/overview/">Indexing Pipeline</a> to index your data. For more information on configuring GraphRAG, see the <a href="../overview/">Configuration</a> documentation.</p>
<p>After initializing your workspace, you can either run the <a href="../../prompt_tuning/auto_prompt_tuning/">Prompt Tuning</a> command to adapt the prompts to your data or even start running the <a href="../../index/overview/">Indexing Pipeline</a> to index your data. For more information on configuration options available, see the <a href="../yaml/">YAML details page</a>.</p>
@ -1640,13 +1662,13 @@
<a href="../yaml/" class="md-footer__link md-footer__link--next" aria-label="Next: Using YAML">
<a href="../yaml/" class="md-footer__link md-footer__link--next" aria-label="Next: Detailed Configuration">
<div class="md-footer__title">
<span class="md-footer__direction">
Next
</span>
<div class="md-ellipsis">
Using YAML
Detailed Configuration
</div>
</div>
<div class="md-footer__button md-icon">

1788
config/models/index.html Normal file

File diff suppressed because it is too large Load Diff

View File

@ -564,11 +564,11 @@
<li class="md-nav__item">
<a href="../../index/architecture/" class="md-nav__link">
<a href="../../index/default_dataflow/" class="md-nav__link">
<span class="md-ellipsis">
Architecture
Dataflow
</span>
@ -586,11 +586,11 @@
<li class="md-nav__item">
<a href="../../index/default_dataflow/" class="md-nav__link">
<a href="../../index/methods/" class="md-nav__link">
<span class="md-ellipsis">
Dataflow
Methods
</span>
@ -645,6 +645,28 @@
<li class="md-nav__item">
<a href="../../index/byog/" class="md-nav__link">
<span class="md-ellipsis">
Custom Graphs
</span>
</a>
</li>
</ul>
</nav>
@ -1204,7 +1226,7 @@
<span class="md-ellipsis">
Using YAML
Detailed Configuration
</span>
@ -1222,11 +1244,11 @@
<li class="md-nav__item">
<a href="../env_vars/" class="md-nav__link">
<a href="../models/" class="md-nav__link">
<span class="md-ellipsis">
Using Env Vars
Language Model Selection
</span>
@ -1503,10 +1525,10 @@
<h1 id="configuring-graphrag-indexing">Configuring GraphRAG Indexing</h1>
<p>The GraphRAG system is highly configurable. This page provides an overview of the configuration options available for the GraphRAG indexing engine.</p>
<h2 id="default-configuration-mode">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>
<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 main ways to set up GraphRAG in Default Configuration mode are via:</p>
<ul>
<li><a href="../init/">Init command</a> (recommended)</li>
<li><a href="../yaml/">Using YAML for deeper control</a></li>
<li><a href="../init/">Init command</a> (recommended first step)</li>
<li><a href="../yaml/">Edit settings.yaml for deeper control</a></li>
<li><a href="../env_vars/">Purely using environment variables</a> (not recommended)</li>
</ul>

View File

@ -12,7 +12,7 @@
<link rel="prev" href="../init/">
<link rel="next" href="../env_vars/">
<link rel="next" href="../models/">
<link rel="icon" href="../../assets/images/favicon.png">
@ -20,7 +20,7 @@
<title>Using YAML - GraphRAG</title>
<title>Detailed Configuration - GraphRAG</title>
@ -110,7 +110,7 @@
<div class="md-header__topic" data-md-component="header-topic">
<span class="md-ellipsis">
Using YAML
Detailed Configuration
</span>
</div>
@ -564,11 +564,11 @@
<li class="md-nav__item">
<a href="../../index/architecture/" class="md-nav__link">
<a href="../../index/default_dataflow/" class="md-nav__link">
<span class="md-ellipsis">
Architecture
Dataflow
</span>
@ -586,11 +586,11 @@
<li class="md-nav__item">
<a href="../../index/default_dataflow/" class="md-nav__link">
<a href="../../index/methods/" class="md-nav__link">
<span class="md-ellipsis">
Dataflow
Methods
</span>
@ -645,6 +645,28 @@
<li class="md-nav__item">
<a href="../../index/byog/" class="md-nav__link">
<span class="md-ellipsis">
Custom Graphs
</span>
</a>
</li>
</ul>
</nav>
@ -1163,7 +1185,7 @@
<span class="md-ellipsis">
Using YAML
Detailed Configuration
</span>
@ -1182,11 +1204,11 @@
<li class="md-nav__item">
<a href="../env_vars/" class="md-nav__link">
<a href="../models/" class="md-nav__link">
<span class="md-ellipsis">
Using Env Vars
Language Model Selection
</span>
@ -1493,12 +1515,14 @@
<li><code>concurrent_requests</code> <strong>int</strong> The number of open requests to allow at once.</li>
<li><code>async_mode</code> <strong>asyncio|threaded</strong> The async mode to use. Either <code>asyncio</code> or <code>threaded</code>.</li>
<li><code>responses</code> <strong>list[str]</strong> - If this model type is mock, this is a list of response strings to return.</li>
<li><code>max_tokens</code> <strong>int</strong> - The maximum number of output tokens.</li>
<li><code>temperature</code> <strong>float</strong> - The temperature to use.</li>
<li><code>top_p</code> <strong>float</strong> - The top-p value to use.</li>
<li><code>n</code> <strong>int</strong> - The number of completions to generate.</li>
<li><code>frequency_penalty</code> <strong>float</strong> - Frequency penalty for token generation.</li>
<li><code>presence_penalty</code> <strong>float</strong> - Frequency penalty for token generation.</li>
<li><code>max_tokens</code> <strong>int</strong> - The maximum number of output tokens. Not valid for o-series models.</li>
<li><code>temperature</code> <strong>float</strong> - The temperature to use. Not valid for o-series models.</li>
<li><code>top_p</code> <strong>float</strong> - The top-p value to use. Not valid for o-series models.</li>
<li><code>frequency_penalty</code> <strong>float</strong> - Frequency penalty for token generation. Not valid for o-series models.</li>
<li><code>presence_penalty</code> <strong>float</strong> - Frequency penalty for token generation. Not valid for o-series models.</li>
<li><code>max_completion_tokens</code> <strong>int</strong> - Max number of tokens to consume for chat completion. Must be large enough to include an unknown amount for "reasoning" by the model. o-series models only.</li>
<li><code>reasoning_effort</code> <strong>low|medium|high</strong> - Amount of "thought" for the model to expend reasoning about a response. o-series models only.</li>
</ul>
<h2 id="input-files-and-chunking">Input Files and Chunking</h2>
<h3 id="input">input</h3>
@ -1621,7 +1645,6 @@
<li><code>prompt</code> <strong>str</strong> - The prompt file to use.</li>
<li><code>entity_types</code> <strong>list[str]</strong> - The entity types to identify.</li>
<li><code>max_gleanings</code> <strong>int</strong> - The maximum number of gleaning cycles to use.</li>
<li><code>encoding_model</code> <strong>str</strong> - The text encoding model to use. Default is to use the encoding model aligned with the language model (i.e., it is retrieved from tiktoken if unset). This is only used for gleanings during the logit_bias check.</li>
</ul>
<h3 id="summarize_descriptions">summarize_descriptions</h3>
<h4 id="fields_10">Fields</h4>
@ -1629,6 +1652,7 @@
<li><code>model_id</code> <strong>str</strong> - Name of the model definition to use for API calls.</li>
<li><code>prompt</code> <strong>str</strong> - The prompt file to use.</li>
<li><code>max_length</code> <strong>int</strong> - The maximum number of output tokens per summarization.</li>
<li><code>max_input_length</code> <strong>int</strong> - The maximum number of tokens to collect for summarization (this will limit how many descriptions you send to be summarized for a given entity or relationship).</li>
</ul>
<h3 id="extract_graph_nlp">extract_graph_nlp</h3>
<p>Defines settings for NLP-based graph extraction methods.</p>
@ -1675,7 +1699,6 @@
<li><code>prompt</code> <strong>str</strong> - The prompt file to use.</li>
<li><code>description</code> <strong>str</strong> - Describes the types of claims we want to extract.</li>
<li><code>max_gleanings</code> <strong>int</strong> - The maximum number of gleaning cycles to use.</li>
<li><code>encoding_model</code> <strong>str</strong> - The text encoding model to use. Default is to use the encoding model aligned with the language model (i.e., it is retrieved from tiktoken if unset). This is only used for gleanings during the logit_bias check.</li>
</ul>
<h3 id="community_reports">community_reports</h3>
<h4 id="fields_15">Fields</h4>
@ -1722,11 +1745,7 @@
<li><code>conversation_history_max_turns</code> <strong>int</strong> - The conversation history maximum turns.</li>
<li><code>top_k_entities</code> <strong>int</strong> - The top k mapped entities.</li>
<li><code>top_k_relationships</code> <strong>int</strong> - The top k mapped relations.</li>
<li><code>temperature</code> <strong>float | None</strong> - The temperature to use for token generation.</li>
<li><code>top_p</code> <strong>float | None</strong> - The top-p value to use for token generation.</li>
<li><code>n</code> <strong>int | None</strong> - The number of completions to generate.</li>
<li><code>max_tokens</code> <strong>int</strong> - The maximum tokens.</li>
<li><code>llm_max_tokens</code> <strong>int</strong> - The LLM maximum tokens.</li>
<li><code>max_context_tokens</code> <strong>int</strong> - The maximum tokens to use building the request context.</li>
</ul>
<h3 id="global_search">global_search</h3>
<h4 id="fields_20">Fields</h4>
@ -1738,20 +1757,14 @@
<li><code>map_prompt</code> <strong>str | None</strong> - The global search mapper prompt to use.</li>
<li><code>reduce_prompt</code> <strong>str | None</strong> - The global search reducer to use.</li>
<li><code>knowledge_prompt</code> <strong>str | None</strong> - The global search general prompt to use.</li>
<li><code>temperature</code> <strong>float | None</strong> - The temperature to use for token generation.</li>
<li><code>top_p</code> <strong>float | None</strong> - The top-p value to use for token generation.</li>
<li><code>n</code> <strong>int | None</strong> - The number of completions to generate.</li>
<li><code>max_tokens</code> <strong>int</strong> - The maximum context size in tokens.</li>
<li><code>data_max_tokens</code> <strong>int</strong> - The data llm maximum tokens.</li>
<li><code>map_max_tokens</code> <strong>int</strong> - The map llm maximum tokens.</li>
<li><code>reduce_max_tokens</code> <strong>int</strong> - The reduce llm maximum tokens.</li>
<li><code>concurrency</code> <strong>int</strong> - The number of concurrent requests.</li>
<li><code>dynamic_search_llm</code> <strong>str</strong> - LLM model to use for dynamic community selection.</li>
<li><code>max_context_tokens</code> <strong>int</strong> - The maximum context size to create, in tokens.</li>
<li><code>data_max_tokens</code> <strong>int</strong> - The maximum tokens to use constructing the final response from the reduces responses.</li>
<li><code>map_max_length</code> <strong>int</strong> - The maximum length to request for map responses, in words.</li>
<li><code>reduce_max_length</code> <strong>int</strong> - The maximum length to request for reduce responses, in words.</li>
<li><code>dynamic_search_threshold</code> <strong>int</strong> - Rating threshold in include a community report.</li>
<li><code>dynamic_search_keep_parent</code> <strong>bool</strong> - Keep parent community if any of the child communities are relevant.</li>
<li><code>dynamic_search_num_repeats</code> <strong>int</strong> - Number of times to rate the same community report.</li>
<li><code>dynamic_search_use_summary</code> <strong>bool</strong> - Use community summary instead of full_context.</li>
<li><code>dynamic_search_concurrent_coroutines</code> <strong>int</strong> - Number of concurrent coroutines to rate community reports.</li>
<li><code>dynamic_search_max_level</code> <strong>int</strong> - The maximum level of community hierarchy to consider if none of the processed communities are relevant.</li>
</ul>
<h3 id="drift_search">drift_search</h3>
@ -1761,11 +1774,9 @@
<li><code>embedding_model_id</code> <strong>str</strong> - Name of the model definition to use for Embedding calls.</li>
<li><code>prompt</code> <strong>str</strong> - The prompt file to use.</li>
<li><code>reduce_prompt</code> <strong>str</strong> - The reducer prompt file to use.</li>
<li><code>temperature</code> <strong>float</strong> - The temperature to use for token generation.",</li>
<li><code>top_p</code> <strong>float</strong> - The top-p value to use for token generation.</li>
<li><code>n</code> <strong>int</strong> - The number of completions to generate.</li>
<li><code>max_tokens</code> <strong>int</strong> - The maximum context size in tokens.</li>
<li><code>data_max_tokens</code> <strong>int</strong> - The data llm maximum tokens.</li>
<li><code>reduce_max_tokens</code> <strong>int</strong> - The maximum tokens for the reduce phase. Only use if a non-o-series model.</li>
<li><code>reduce_max_completion_tokens</code> <strong>int</strong> - The maximum tokens for the reduce phase. Only use for o-series models.</li>
<li><code>concurrency</code> <strong>int</strong> - The number of concurrent requests.</li>
<li><code>drift_k_followups</code> <strong>int</strong> - The number of top global results to retrieve.</li>
<li><code>primer_folds</code> <strong>int</strong> - The number of folds for search priming.</li>
@ -1779,7 +1790,8 @@
<li><code>local_search_temperature</code> <strong>float</strong> - The temperature to use for token generation in local search.</li>
<li><code>local_search_top_p</code> <strong>float</strong> - The top-p value to use for token generation in local search.</li>
<li><code>local_search_n</code> <strong>int</strong> - The number of completions to generate in local search.</li>
<li><code>local_search_llm_max_gen_tokens</code> <strong>int</strong> - The maximum number of generated tokens for the LLM in local search.</li>
<li><code>local_search_llm_max_gen_tokens</code> <strong>int</strong> - The maximum number of generated tokens for the LLM in local search. Only use if a non-o-series model.</li>
<li><code>local_search_llm_max_gen_completion_tokens</code> <strong>int</strong> - The maximum number of generated tokens for the LLM in local search. Only use for o-series models.</li>
</ul>
<h3 id="basic_search">basic_search</h3>
<h4 id="fields_22">Fields</h4>
@ -1787,16 +1799,7 @@
<li><code>chat_model_id</code> <strong>str</strong> - Name of the model definition to use for Chat Completion calls.</li>
<li><code>embedding_model_id</code> <strong>str</strong> - Name of the model definition to use for Embedding calls.</li>
<li><code>prompt</code> <strong>str</strong> - The prompt file to use.</li>
<li><code>text_unit_prop</code> <strong>float</strong> - The text unit proportion. </li>
<li><code>community_prop</code> <strong>float</strong> - The community proportion.</li>
<li><code>conversation_history_max_turns</code> <strong>int</strong> - The conversation history maximum turns.</li>
<li><code>top_k_entities</code> <strong>int</strong> - The top k mapped entities.</li>
<li><code>top_k_relationships</code> <strong>int</strong> - The top k mapped relations.</li>
<li><code>temperature</code> <strong>float | None</strong> - The temperature to use for token generation.</li>
<li><code>top_p</code> <strong>float | None</strong> - The top-p value to use for token generation.</li>
<li><code>n</code> <strong>int | None</strong> - The number of completions to generate.</li>
<li><code>max_tokens</code> <strong>int</strong> - The maximum tokens.</li>
<li><code>llm_max_tokens</code> <strong>int</strong> - The LLM maximum tokens.</li>
<li><code>k</code> <strong>int | None</strong> - Number of text units to retrieve from the vector store for context building.</li>
</ul>
@ -1844,13 +1847,13 @@
<a href="../env_vars/" class="md-footer__link md-footer__link--next" aria-label="Next: Using Env Vars">
<a href="../models/" class="md-footer__link md-footer__link--next" aria-label="Next: Language Model Selection">
<div class="md-footer__title">
<span class="md-footer__direction">
Next
</span>
<div class="md-ellipsis">
Using Env Vars
Language Model Selection
</div>
</div>
<div class="md-footer__button md-icon">

View File

@ -564,11 +564,11 @@
<li class="md-nav__item">
<a href="../../../index/architecture/" class="md-nav__link">
<a href="../../../index/default_dataflow/" class="md-nav__link">
<span class="md-ellipsis">
Architecture
Dataflow
</span>
@ -586,11 +586,11 @@
<li class="md-nav__item">
<a href="../../../index/default_dataflow/" class="md-nav__link">
<a href="../../../index/methods/" class="md-nav__link">
<span class="md-ellipsis">
Dataflow
Methods
</span>
@ -645,6 +645,28 @@
<li class="md-nav__item">
<a href="../../../index/byog/" class="md-nav__link">
<span class="md-ellipsis">
Custom Graphs
</span>
</a>
</li>
</ul>
</nav>
@ -1149,7 +1171,7 @@
<span class="md-ellipsis">
Using YAML
Detailed Configuration
</span>
@ -1167,11 +1189,11 @@
<li class="md-nav__item">
<a href="../../../config/env_vars/" class="md-nav__link">
<a href="../../../config/models/" class="md-nav__link">
<span class="md-ellipsis">
Using Env Vars
Language Model Selection
</span>

View File

@ -562,11 +562,11 @@
<li class="md-nav__item">
<a href="../../../index/architecture/" class="md-nav__link">
<a href="../../../index/default_dataflow/" class="md-nav__link">
<span class="md-ellipsis">
Architecture
Dataflow
</span>
@ -584,11 +584,11 @@
<li class="md-nav__item">
<a href="../../../index/default_dataflow/" class="md-nav__link">
<a href="../../../index/methods/" class="md-nav__link">
<span class="md-ellipsis">
Dataflow
Methods
</span>
@ -643,6 +643,28 @@
<li class="md-nav__item">
<a href="../../../index/byog/" class="md-nav__link">
<span class="md-ellipsis">
Custom Graphs
</span>
</a>
</li>
</ul>
</nav>
@ -1147,7 +1169,7 @@
<span class="md-ellipsis">
Using YAML
Detailed Configuration
</span>
@ -1165,11 +1187,11 @@
<li class="md-nav__item">
<a href="../../../config/env_vars/" class="md-nav__link">
<a href="../../../config/models/" class="md-nav__link">
<span class="md-ellipsis">
Using Env Vars
Language Model Selection
</span>

View File

@ -579,11 +579,11 @@
<li class="md-nav__item">
<a href="../index/architecture/" class="md-nav__link">
<a href="../index/default_dataflow/" class="md-nav__link">
<span class="md-ellipsis">
Architecture
Dataflow
</span>
@ -601,11 +601,11 @@
<li class="md-nav__item">
<a href="../index/default_dataflow/" class="md-nav__link">
<a href="../index/methods/" class="md-nav__link">
<span class="md-ellipsis">
Dataflow
Methods
</span>
@ -660,6 +660,28 @@
<li class="md-nav__item">
<a href="../index/byog/" class="md-nav__link">
<span class="md-ellipsis">
Custom Graphs
</span>
</a>
</li>
</ul>
</nav>
@ -1164,7 +1186,7 @@
<span class="md-ellipsis">
Using YAML
Detailed Configuration
</span>
@ -1182,11 +1204,11 @@
<li class="md-nav__item">
<a href="../config/env_vars/" class="md-nav__link">
<a href="../config/models/" class="md-nav__link">
<span class="md-ellipsis">
Using Env Vars
Language Model Selection
</span>

View File

@ -558,11 +558,11 @@
<li class="md-nav__item">
<a href="../../index/architecture/" class="md-nav__link">
<a href="../../index/default_dataflow/" class="md-nav__link">
<span class="md-ellipsis">
Architecture
Dataflow
</span>
@ -580,11 +580,11 @@
<li class="md-nav__item">
<a href="../../index/default_dataflow/" class="md-nav__link">
<a href="../../index/methods/" class="md-nav__link">
<span class="md-ellipsis">
Dataflow
Methods
</span>
@ -639,6 +639,28 @@
<li class="md-nav__item">
<a href="../../index/byog/" class="md-nav__link">
<span class="md-ellipsis">
Custom Graphs
</span>
</a>
</li>
</ul>
</nav>
@ -1143,7 +1165,7 @@
<span class="md-ellipsis">
Using YAML
Detailed Configuration
</span>
@ -1161,11 +1183,11 @@
<li class="md-nav__item">
<a href="../../config/env_vars/" class="md-nav__link">
<a href="../../config/models/" class="md-nav__link">
<span class="md-ellipsis">
Using Env Vars
Language Model Selection
</span>

View File

@ -559,11 +559,11 @@
<li class="md-nav__item">
<a href="../../index/architecture/" class="md-nav__link">
<a href="../../index/default_dataflow/" class="md-nav__link">
<span class="md-ellipsis">
Architecture
Dataflow
</span>
@ -581,11 +581,11 @@
<li class="md-nav__item">
<a href="../../index/default_dataflow/" class="md-nav__link">
<a href="../../index/methods/" class="md-nav__link">
<span class="md-ellipsis">
Dataflow
Methods
</span>
@ -640,6 +640,28 @@
<li class="md-nav__item">
<a href="../../index/byog/" class="md-nav__link">
<span class="md-ellipsis">
Custom Graphs
</span>
</a>
</li>
</ul>
</nav>
@ -1159,7 +1181,7 @@
<span class="md-ellipsis">
Using YAML
Detailed Configuration
</span>
@ -1177,11 +1199,11 @@
<li class="md-nav__item">
<a href="../../config/env_vars/" class="md-nav__link">
<a href="../../config/models/" class="md-nav__link">
<span class="md-ellipsis">
Using Env Vars
Language Model Selection
</span>

View File

@ -564,11 +564,11 @@
<li class="md-nav__item">
<a href="../../index/architecture/" class="md-nav__link">
<a href="../../index/default_dataflow/" class="md-nav__link">
<span class="md-ellipsis">
Architecture
Dataflow
</span>
@ -586,11 +586,11 @@
<li class="md-nav__item">
<a href="../../index/default_dataflow/" class="md-nav__link">
<a href="../../index/methods/" class="md-nav__link">
<span class="md-ellipsis">
Dataflow
Methods
</span>
@ -645,6 +645,28 @@
<li class="md-nav__item">
<a href="../../index/byog/" class="md-nav__link">
<span class="md-ellipsis">
Custom Graphs
</span>
</a>
</li>
</ul>
</nav>
@ -1250,7 +1272,7 @@
<span class="md-ellipsis">
Using YAML
Detailed Configuration
</span>
@ -1268,11 +1290,11 @@
<li class="md-nav__item">
<a href="../../config/env_vars/" class="md-nav__link">
<a href="../../config/models/" class="md-nav__link">
<span class="md-ellipsis">
Using Env Vars
Language Model Selection
</span>

View File

@ -558,11 +558,11 @@
<li class="md-nav__item">
<a href="../../index/architecture/" class="md-nav__link">
<a href="../../index/default_dataflow/" class="md-nav__link">
<span class="md-ellipsis">
Architecture
Dataflow
</span>
@ -580,11 +580,11 @@
<li class="md-nav__item">
<a href="../../index/default_dataflow/" class="md-nav__link">
<a href="../../index/methods/" class="md-nav__link">
<span class="md-ellipsis">
Dataflow
Methods
</span>
@ -639,6 +639,28 @@
<li class="md-nav__item">
<a href="../../index/byog/" class="md-nav__link">
<span class="md-ellipsis">
Custom Graphs
</span>
</a>
</li>
</ul>
</nav>
@ -1143,7 +1165,7 @@
<span class="md-ellipsis">
Using YAML
Detailed Configuration
</span>
@ -1161,11 +1183,11 @@
<li class="md-nav__item">
<a href="../../config/env_vars/" class="md-nav__link">
<a href="../../config/models/" class="md-nav__link">
<span class="md-ellipsis">
Using Env Vars
Language Model Selection
</span>

View File

@ -558,11 +558,11 @@
<li class="md-nav__item">
<a href="../../index/architecture/" class="md-nav__link">
<a href="../../index/default_dataflow/" class="md-nav__link">
<span class="md-ellipsis">
Architecture
Dataflow
</span>
@ -580,11 +580,11 @@
<li class="md-nav__item">
<a href="../../index/default_dataflow/" class="md-nav__link">
<a href="../../index/methods/" class="md-nav__link">
<span class="md-ellipsis">
Dataflow
Methods
</span>
@ -639,6 +639,28 @@
<li class="md-nav__item">
<a href="../../index/byog/" class="md-nav__link">
<span class="md-ellipsis">
Custom Graphs
</span>
</a>
</li>
</ul>
</nav>
@ -1143,7 +1165,7 @@
<span class="md-ellipsis">
Using YAML
Detailed Configuration
</span>
@ -1161,11 +1183,11 @@
<li class="md-nav__item">
<a href="../../config/env_vars/" class="md-nav__link">
<a href="../../config/models/" class="md-nav__link">
<span class="md-ellipsis">
Using Env Vars
Language Model Selection
</span>

View File

@ -558,11 +558,11 @@
<li class="md-nav__item">
<a href="../../index/architecture/" class="md-nav__link">
<a href="../../index/default_dataflow/" class="md-nav__link">
<span class="md-ellipsis">
Architecture
Dataflow
</span>
@ -580,11 +580,11 @@
<li class="md-nav__item">
<a href="../../index/default_dataflow/" class="md-nav__link">
<a href="../../index/methods/" class="md-nav__link">
<span class="md-ellipsis">
Dataflow
Methods
</span>
@ -639,6 +639,28 @@
<li class="md-nav__item">
<a href="../../index/byog/" class="md-nav__link">
<span class="md-ellipsis">
Custom Graphs
</span>
</a>
</li>
</ul>
</nav>
@ -1143,7 +1165,7 @@
<span class="md-ellipsis">
Using YAML
Detailed Configuration
</span>
@ -1161,11 +1183,11 @@
<li class="md-nav__item">
<a href="../../config/env_vars/" class="md-nav__link">
<a href="../../config/models/" class="md-nav__link">
<span class="md-ellipsis">
Using Env Vars
Language Model Selection
</span>

View File

@ -558,11 +558,11 @@
<li class="md-nav__item">
<a href="../../../../index/architecture/" class="md-nav__link">
<a href="../../../../index/default_dataflow/" class="md-nav__link">
<span class="md-ellipsis">
Architecture
Dataflow
</span>
@ -580,11 +580,11 @@
<li class="md-nav__item">
<a href="../../../../index/default_dataflow/" class="md-nav__link">
<a href="../../../../index/methods/" class="md-nav__link">
<span class="md-ellipsis">
Dataflow
Methods
</span>
@ -639,6 +639,28 @@
<li class="md-nav__item">
<a href="../../../../index/byog/" class="md-nav__link">
<span class="md-ellipsis">
Custom Graphs
</span>
</a>
</li>
</ul>
</nav>
@ -1143,7 +1165,7 @@
<span class="md-ellipsis">
Using YAML
Detailed Configuration
</span>
@ -1161,11 +1183,11 @@
<li class="md-nav__item">
<a href="../../../../config/env_vars/" class="md-nav__link">
<a href="../../../../config/models/" class="md-nav__link">
<span class="md-ellipsis">
Using Env Vars
Language Model Selection
</span>

View File

@ -558,11 +558,11 @@
<li class="md-nav__item">
<a href="../../../../index/architecture/" class="md-nav__link">
<a href="../../../../index/default_dataflow/" class="md-nav__link">
<span class="md-ellipsis">
Architecture
Dataflow
</span>
@ -580,11 +580,11 @@
<li class="md-nav__item">
<a href="../../../../index/default_dataflow/" class="md-nav__link">
<a href="../../../../index/methods/" class="md-nav__link">
<span class="md-ellipsis">
Dataflow
Methods
</span>
@ -639,6 +639,28 @@
<li class="md-nav__item">
<a href="../../../../index/byog/" class="md-nav__link">
<span class="md-ellipsis">
Custom Graphs
</span>
</a>
</li>
</ul>
</nav>
@ -1143,7 +1165,7 @@
<span class="md-ellipsis">
Using YAML
Detailed Configuration
</span>
@ -1161,11 +1183,11 @@
<li class="md-nav__item">
<a href="../../../../config/env_vars/" class="md-nav__link">
<a href="../../../../config/models/" class="md-nav__link">
<span class="md-ellipsis">
Using Env Vars
Language Model Selection
</span>

View File

@ -564,11 +564,11 @@
<li class="md-nav__item">
<a href="../../index/architecture/" class="md-nav__link">
<a href="../../index/default_dataflow/" class="md-nav__link">
<span class="md-ellipsis">
Architecture
Dataflow
</span>
@ -586,11 +586,11 @@
<li class="md-nav__item">
<a href="../../index/default_dataflow/" class="md-nav__link">
<a href="../../index/methods/" class="md-nav__link">
<span class="md-ellipsis">
Dataflow
Methods
</span>
@ -645,6 +645,28 @@
<li class="md-nav__item">
<a href="../../index/byog/" class="md-nav__link">
<span class="md-ellipsis">
Custom Graphs
</span>
</a>
</li>
</ul>
</nav>
@ -1319,7 +1341,7 @@
<span class="md-ellipsis">
Using YAML
Detailed Configuration
</span>
@ -1337,11 +1359,11 @@
<li class="md-nav__item">
<a href="../../config/env_vars/" class="md-nav__link">
<a href="../../config/models/" class="md-nav__link">
<span class="md-ellipsis">
Using Env Vars
Language Model Selection
</span>

View File

@ -558,11 +558,11 @@
<li class="md-nav__item">
<a href="../../index/architecture/" class="md-nav__link">
<a href="../../index/default_dataflow/" class="md-nav__link">
<span class="md-ellipsis">
Architecture
Dataflow
</span>
@ -580,11 +580,11 @@
<li class="md-nav__item">
<a href="../../index/default_dataflow/" class="md-nav__link">
<a href="../../index/methods/" class="md-nav__link">
<span class="md-ellipsis">
Dataflow
Methods
</span>
@ -639,6 +639,28 @@
<li class="md-nav__item">
<a href="../../index/byog/" class="md-nav__link">
<span class="md-ellipsis">
Custom Graphs
</span>
</a>
</li>
</ul>
</nav>
@ -1143,7 +1165,7 @@
<span class="md-ellipsis">
Using YAML
Detailed Configuration
</span>
@ -1161,11 +1183,11 @@
<li class="md-nav__item">
<a href="../../config/env_vars/" class="md-nav__link">
<a href="../../config/models/" class="md-nav__link">
<span class="md-ellipsis">
Using Env Vars
Language Model Selection
</span>

View File

@ -511,15 +511,6 @@
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#quickstart" class="md-nav__link">
<span class="md-ellipsis">
Quickstart
</span>
</a>
</li>
</ul>
@ -628,11 +619,11 @@
<li class="md-nav__item">
<a href="../index/architecture/" class="md-nav__link">
<a href="../index/default_dataflow/" class="md-nav__link">
<span class="md-ellipsis">
Architecture
Dataflow
</span>
@ -650,11 +641,11 @@
<li class="md-nav__item">
<a href="../index/default_dataflow/" class="md-nav__link">
<a href="../index/methods/" class="md-nav__link">
<span class="md-ellipsis">
Dataflow
Methods
</span>
@ -709,6 +700,28 @@
<li class="md-nav__item">
<a href="../index/byog/" class="md-nav__link">
<span class="md-ellipsis">
Custom Graphs
</span>
</a>
</li>
</ul>
</nav>
@ -1213,7 +1226,7 @@
<span class="md-ellipsis">
Using YAML
Detailed Configuration
</span>
@ -1231,11 +1244,11 @@
<li class="md-nav__item">
<a href="../config/env_vars/" class="md-nav__link">
<a href="../config/models/" class="md-nav__link">
<span class="md-ellipsis">
Using Env Vars
Language Model Selection
</span>
@ -1488,15 +1501,6 @@
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#quickstart" class="md-nav__link">
<span class="md-ellipsis">
Quickstart
</span>
</a>
</li>
</ul>
@ -1525,15 +1529,11 @@
<p>👉 <a href="https://github.com/Azure-Samples/graphrag-accelerator">Use the GraphRAG Accelerator solution</a> <br/>
👉 <a href="https://pypi.org/project/graphrag/">Install from pypi</a>. <br/>
👉 <a href="../developing/">Use it from source</a><br/></p>
<h2 id="quickstart">Quickstart</h2>
<p>To get started with the GraphRAG system we recommend trying the <a href="https://github.com/Azure-Samples/graphrag-accelerator">Solution Accelerator</a> package. This provides a user-friendly end-to-end experience with Azure resources.</p>
<h1 id="overview">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>
<p>The following is a simple end-to-end example for using the GraphRAG system, using the install from pypi option.</p>
<p>It shows how to use the system to index some text, and then use the indexed data to answer questions about the documents.</p>
<h1 id="install-graphrag">Install GraphRAG</h1>
<div class="highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a>pip<span class="w"> </span>install<span class="w"> </span>graphrag
</code></pre></div>
<p>The graphrag library includes a CLI for a no-code approach to getting started. Please review the full <a href="../cli/">CLI documentation</a> for further detail.</p>
<h1 id="running-the-indexer">Running the Indexer</h1>
<p>We need to set up a data project and some initial configuration. First let's get a sample dataset ready:</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a>mkdir<span class="w"> </span>-p<span class="w"> </span>./ragtest/input
@ -1549,49 +1549,54 @@ Since we have already configured a directory named <code>./ragtest</code> in the
<p>This will create two files: <code>.env</code> and <code>settings.yaml</code> in the <code>./ragtest</code> directory.</p>
<ul>
<li><code>.env</code> contains the environment variables required to run the GraphRAG pipeline. If you inspect the file, you'll see a single environment variable defined,
<code>GRAPHRAG_API_KEY=&lt;API_KEY&gt;</code>. This is the API key for the OpenAI API or Azure OpenAI endpoint. You can replace this with your own API key. If you are using another form of authentication (i.e. managed identity), please delete this file.</li>
<code>GRAPHRAG_API_KEY=&lt;API_KEY&gt;</code>. Replace <code>&lt;API_KEY&gt;</code> with your own OpenAI or Azure API key.</li>
<li><code>settings.yaml</code> contains the settings for the pipeline. You can modify this file to change the settings for the pipeline.
<br/></li>
</ul>
<h4 id="openai-and-azure-openai"><ins>OpenAI and Azure OpenAI</ins></h4>
<p>If running in OpenAI mode, update the value of <code>GRAPHRAG_API_KEY</code> in the <code>.env</code> file with your OpenAI API key.</p>
<h4 id="azure-openai"><ins>Azure OpenAI</ins></h4>
<p>In addition, Azure OpenAI users should set the following variables in the settings.yaml file. To find the appropriate sections, just search for the <code>llm:</code> configuration, you should see two sections, one for the chat endpoint and one for the embeddings endpoint. Here is an example of how to configure the chat endpoint:</p>
<h3 id="using-openai">Using OpenAI</h3>
<p>If running in OpenAI mode, you only need to update the value of <code>GRAPHRAG_API_KEY</code> in the <code>.env</code> file with your OpenAI API key.</p>
<h3 id="using-azure-openai">Using Azure OpenAI</h3>
<p>In addition to setting your API key, Azure OpenAI users should set the variables below in the settings.yaml file. To find the appropriate sections, just search for the <code>models:</code> root configuration; you should see two sections, one for the default chat endpoint and one for the default embeddings endpoint. Here is an example of what to add to the chat model config:</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-4-1" name="__codelineno-4-1" href="#__codelineno-4-1"></a><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">azure_openai_chat</span><span class="w"> </span><span class="c1"># Or azure_openai_embedding for embeddings</span>
<a id="__codelineno-4-2" name="__codelineno-4-2" href="#__codelineno-4-2"></a><span class="nt">api_base</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">https://&lt;instance&gt;.openai.azure.com</span>
<a id="__codelineno-4-3" name="__codelineno-4-3" href="#__codelineno-4-3"></a><span class="nt">api_version</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">2024-02-15-preview</span><span class="w"> </span><span class="c1"># You can customize this for other versions</span>
<a id="__codelineno-4-4" name="__codelineno-4-4" href="#__codelineno-4-4"></a><span class="nt">deployment_name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">&lt;azure_model_deployment_name&gt;</span>
</code></pre></div>
<h4 id="using-managed-auth-on-azure">Using Managed Auth on Azure</h4>
<p>To use managed auth, add an additional value to your model config and comment out or remove the api_key line:</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-5-1" name="__codelineno-5-1" href="#__codelineno-5-1"></a><span class="nt">auth_type</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">azure_managed_identity</span><span class="w"> </span><span class="c1"># Default auth_type is is api_key</span>
<a id="__codelineno-5-2" name="__codelineno-5-2" href="#__codelineno-5-2"></a><span class="c1"># api_key: ${GRAPHRAG_API_KEY}</span>
</code></pre></div>
<p>You will also need to login with <a href="https://learn.microsoft.com/en-us/cli/azure/authenticate-azure-cli">az login</a> and select the subscription with your endpoint.</p>
<h2 id="running-the-indexing-pipeline">Running the Indexing pipeline</h2>
<p>Finally we'll run the pipeline!</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-6-1" name="__codelineno-6-1" href="#__codelineno-6-1"></a>graphrag<span class="w"> </span>index<span class="w"> </span>--root<span class="w"> </span>./ragtest
</code></pre></div>
<p><img alt="pipeline executing from the CLI" src="../img/pipeline-running.png" /></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>settings.yaml</code> file).
Once the pipeline is complete, you should see a new folder called <code>./ragtest/output</code> with a series of parquet files.</p>
<h1 id="using-the-query-engine">Using the Query Engine</h1>
<p>Now let's ask some questions using this dataset.</p>
<p>Here is an example using Global search to ask a high-level question:</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-7-1" name="__codelineno-7-1" href="#__codelineno-7-1"></a>graphrag<span class="w"> </span>query<span class="w"> </span><span class="se">\</span>
<a id="__codelineno-7-2" name="__codelineno-7-2" href="#__codelineno-7-2"></a>--root<span class="w"> </span>./ragtest<span class="w"> </span><span class="se">\</span>
<a id="__codelineno-7-3" name="__codelineno-7-3" href="#__codelineno-7-3"></a>--method<span class="w"> </span>global<span class="w"> </span><span class="se">\</span>
<a id="__codelineno-7-4" name="__codelineno-7-4" href="#__codelineno-7-4"></a>--query<span class="w"> </span><span class="s2">&quot;What are the top themes in this story?&quot;</span>
</code></pre></div>
<p>Here is an example using Local search to ask a more specific question about a particular character:</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-8-1" name="__codelineno-8-1" href="#__codelineno-8-1"></a>graphrag<span class="w"> </span>query<span class="w"> </span><span class="se">\</span>
<a id="__codelineno-8-2" name="__codelineno-8-2" href="#__codelineno-8-2"></a>--root<span class="w"> </span>./ragtest<span class="w"> </span><span class="se">\</span>
<a id="__codelineno-8-3" name="__codelineno-8-3" href="#__codelineno-8-3"></a>--method<span class="w"> </span><span class="nb">local</span><span class="w"> </span><span class="se">\</span>
<a id="__codelineno-8-4" name="__codelineno-8-4" href="#__codelineno-8-4"></a>--query<span class="w"> </span><span class="s2">&quot;Who is Scrooge and what are his main relationships?&quot;</span>
</code></pre></div>
<p>Please refer to <a href="../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>
<h1 id="going-deeper">Going Deeper</h1>
<ul>
<li>For more details about configuring GraphRAG, see the <a href="../config/overview/">configuration documentation</a>.</li>
<li>To learn more about Initialization, refer to the <a href="../config/init/">Initialization documentation</a>.</li>
<li>For more details about using the CLI, refer to the <a href="../cli/">CLI documentation</a>.</li>
<li>Check out our <a href="../visualization_guide/">visualization guide</a> for a more interactive experience in debugging and exploring the knowledge graph.</li>
</ul>
<h2 id="running-the-indexing-pipeline">Running the Indexing pipeline</h2>
<p>Finally we'll run the pipeline!</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-5-1" name="__codelineno-5-1" href="#__codelineno-5-1"></a>graphrag<span class="w"> </span>index<span class="w"> </span>--root<span class="w"> </span>./ragtest
</code></pre></div>
<p><img alt="pipeline executing from the CLI" src="../img/pipeline-running.png" /></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>settings.yml</code> file).
Once the pipeline is complete, you should see a new folder called <code>./ragtest/output</code> with a series of parquet files.</p>
<h1 id="using-the-query-engine">Using the Query Engine</h1>
<h2 id="running-the-query-engine">Running the Query Engine</h2>
<p>Now let's ask some questions using this dataset.</p>
<p>Here is an example using Global search to ask a high-level question:</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-6-1" name="__codelineno-6-1" href="#__codelineno-6-1"></a>graphrag<span class="w"> </span>query<span class="w"> </span><span class="se">\</span>
<a id="__codelineno-6-2" name="__codelineno-6-2" href="#__codelineno-6-2"></a>--root<span class="w"> </span>./ragtest<span class="w"> </span><span class="se">\</span>
<a id="__codelineno-6-3" name="__codelineno-6-3" href="#__codelineno-6-3"></a>--method<span class="w"> </span>global<span class="w"> </span><span class="se">\</span>
<a id="__codelineno-6-4" name="__codelineno-6-4" href="#__codelineno-6-4"></a>--query<span class="w"> </span><span class="s2">&quot;What are the top themes in this story?&quot;</span>
</code></pre></div>
<p>Here is an example using Local search to ask a more specific question about a particular character:</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-7-1" name="__codelineno-7-1" href="#__codelineno-7-1"></a>graphrag<span class="w"> </span>query<span class="w"> </span><span class="se">\</span>
<a id="__codelineno-7-2" name="__codelineno-7-2" href="#__codelineno-7-2"></a>--root<span class="w"> </span>./ragtest<span class="w"> </span><span class="se">\</span>
<a id="__codelineno-7-3" name="__codelineno-7-3" href="#__codelineno-7-3"></a>--method<span class="w"> </span><span class="nb">local</span><span class="w"> </span><span class="se">\</span>
<a id="__codelineno-7-4" name="__codelineno-7-4" href="#__codelineno-7-4"></a>--query<span class="w"> </span><span class="s2">&quot;Who is Scrooge and what are his main relationships?&quot;</span>
</code></pre></div>
<p>Please refer to <a href="../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>
<h1 id="visualizing-the-graph">Visualizing the Graph</h1>
<p>Check out our <a href="../visualization_guide/">visualization guide</a> for a more interactive experience in debugging and exploring the knowledge graph.</p>

View File

@ -686,11 +686,11 @@
<li class="md-nav__item">
<a href="index/architecture/" class="md-nav__link">
<a href="index/default_dataflow/" class="md-nav__link">
<span class="md-ellipsis">
Architecture
Dataflow
</span>
@ -708,11 +708,11 @@
<li class="md-nav__item">
<a href="index/default_dataflow/" class="md-nav__link">
<a href="index/methods/" class="md-nav__link">
<span class="md-ellipsis">
Dataflow
Methods
</span>
@ -767,6 +767,28 @@
<li class="md-nav__item">
<a href="index/byog/" class="md-nav__link">
<span class="md-ellipsis">
Custom Graphs
</span>
</a>
</li>
</ul>
</nav>
@ -1271,7 +1293,7 @@
<span class="md-ellipsis">
Using YAML
Detailed Configuration
</span>
@ -1289,11 +1311,11 @@
<li class="md-nav__item">
<a href="config/env_vars/" class="md-nav__link">
<a href="config/models/" class="md-nav__link">
<span class="md-ellipsis">
Using Env Vars
Language Model Selection
</span>

View File

@ -9,10 +9,6 @@
<link rel="prev" href="../overview/">
<link rel="next" href="../default_dataflow/">
<link rel="icon" href="../../assets/images/favicon.png">
@ -20,7 +16,7 @@
<title>Architecture - GraphRAG</title>
<title>Indexing Architecture - GraphRAG</title>
@ -110,7 +106,7 @@
<div class="md-header__topic" data-md-component="header-topic">
<span class="md-ellipsis">
Architecture
Indexing Architecture
</span>
</div>
@ -233,12 +229,10 @@
<li class="md-tabs__item md-tabs__item--active">
<li class="md-tabs__item">
<a href="../overview/" class="md-tabs__link">
@ -500,28 +494,23 @@
<li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" checked>
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" >
<label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="">
<label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
<span class="md-ellipsis">
@ -533,7 +522,7 @@
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="true">
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_2">
<span class="md-nav__icon md-icon"></span>
Indexing
@ -566,102 +555,19 @@
<li class="md-nav__item md-nav__item--active">
<input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
<label class="md-nav__link md-nav__link--active" for="__toc">
<span class="md-ellipsis">
Architecture
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
<li class="md-nav__item">
<a href="../default_dataflow/" class="md-nav__link">
<span class="md-ellipsis">
Architecture
Dataflow
</span>
</a>
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#key-concepts" class="md-nav__link">
<span class="md-ellipsis">
Key Concepts
</span>
</a>
<nav class="md-nav" aria-label="Key Concepts">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#knowledge-model" class="md-nav__link">
<span class="md-ellipsis">
Knowledge Model
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#workflows" class="md-nav__link">
<span class="md-ellipsis">
Workflows
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#llm-caching" class="md-nav__link">
<span class="md-ellipsis">
LLM Caching
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
@ -674,11 +580,11 @@
<li class="md-nav__item">
<a href="../default_dataflow/" class="md-nav__link">
<a href="../methods/" class="md-nav__link">
<span class="md-ellipsis">
Dataflow
Methods
</span>
@ -733,6 +639,28 @@
<li class="md-nav__item">
<a href="../byog/" class="md-nav__link">
<span class="md-ellipsis">
Custom Graphs
</span>
</a>
</li>
</ul>
</nav>
@ -1237,7 +1165,7 @@
<span class="md-ellipsis">
Using YAML
Detailed Configuration
</span>
@ -1255,11 +1183,11 @@
<li class="md-nav__item">
<a href="../../config/env_vars/" class="md-nav__link">
<a href="../../config/models/" class="md-nav__link">
<span class="md-ellipsis">
Using Env Vars
Language Model Selection
</span>
@ -1615,44 +1543,6 @@ This allows our indexer to be more resilient to network issues, to act idempoten
<footer class="md-footer">
<nav class="md-footer__inner md-grid" aria-label="Footer" >
<a href="../overview/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Overview">
<div class="md-footer__button md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg>
</div>
<div class="md-footer__title">
<span class="md-footer__direction">
Previous
</span>
<div class="md-ellipsis">
Overview
</div>
</div>
</a>
<a href="../default_dataflow/" class="md-footer__link md-footer__link--next" aria-label="Next: Dataflow">
<div class="md-footer__title">
<span class="md-footer__direction">
Next
</span>
<div class="md-ellipsis">
Dataflow
</div>
</div>
<div class="md-footer__button md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11z"/></svg>
</div>
</a>
</nav>
<div class="md-footer-meta md-typeset">
<div class="md-footer-meta__inner md-grid">

1837
index/byog/index.html Normal file

File diff suppressed because it is too large Load Diff

View File

@ -9,10 +9,10 @@
<link rel="prev" href="../architecture/">
<link rel="prev" href="../overview/">
<link rel="next" href="../inputs/">
<link rel="next" href="../methods/">
<link rel="icon" href="../../assets/images/favicon.png">
@ -566,28 +566,6 @@
<li class="md-nav__item">
<a href="../architecture/" class="md-nav__link">
<span class="md-ellipsis">
Architecture
</span>
</a>
</li>
@ -881,6 +859,28 @@
<li class="md-nav__item">
<a href="../methods/" class="md-nav__link">
<span class="md-ellipsis">
Methods
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../inputs/" class="md-nav__link">
@ -919,6 +919,28 @@
<li class="md-nav__item">
<a href="../byog/" class="md-nav__link">
<span class="md-ellipsis">
Custom Graphs
</span>
</a>
</li>
</ul>
</nav>
@ -1423,7 +1445,7 @@
<span class="md-ellipsis">
Using YAML
Detailed Configuration
</span>
@ -1441,11 +1463,11 @@
<li class="md-nav__item">
<a href="../../config/env_vars/" class="md-nav__link">
<a href="../../config/models/" class="md-nav__link">
<span class="md-ellipsis">
Using Env Vars
Language Model Selection
</span>
@ -2106,7 +2128,7 @@ flowchart LR
<nav class="md-footer__inner md-grid" aria-label="Footer" >
<a href="../architecture/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Architecture">
<a href="../overview/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Overview">
<div class="md-footer__button md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg>
@ -2116,20 +2138,20 @@ flowchart LR
Previous
</span>
<div class="md-ellipsis">
Architecture
Overview
</div>
</div>
</a>
<a href="../inputs/" class="md-footer__link md-footer__link--next" aria-label="Next: Inputs">
<a href="../methods/" class="md-footer__link md-footer__link--next" aria-label="Next: Methods">
<div class="md-footer__title">
<span class="md-footer__direction">
Next
</span>
<div class="md-ellipsis">
Inputs
Methods
</div>
</div>
<div class="md-footer__button md-icon">

View File

@ -9,7 +9,7 @@
<link rel="prev" href="../default_dataflow/">
<link rel="prev" href="../methods/">
<link rel="next" href="../outputs/">
@ -569,11 +569,11 @@
<li class="md-nav__item">
<a href="../architecture/" class="md-nav__link">
<a href="../default_dataflow/" class="md-nav__link">
<span class="md-ellipsis">
Architecture
Dataflow
</span>
@ -591,11 +591,11 @@
<li class="md-nav__item">
<a href="../default_dataflow/" class="md-nav__link">
<a href="../methods/" class="md-nav__link">
<span class="md-ellipsis">
Dataflow
Methods
</span>
@ -841,6 +841,28 @@
<li class="md-nav__item">
<a href="../byog/" class="md-nav__link">
<span class="md-ellipsis">
Custom Graphs
</span>
</a>
</li>
</ul>
</nav>
@ -1345,7 +1367,7 @@
<span class="md-ellipsis">
Using YAML
Detailed Configuration
</span>
@ -1363,11 +1385,11 @@
<li class="md-nav__item">
<a href="../../config/env_vars/" class="md-nav__link">
<a href="../../config/models/" class="md-nav__link">
<span class="md-ellipsis">
Using Env Vars
Language Model Selection
</span>
@ -2202,7 +2224,7 @@
<nav class="md-footer__inner md-grid" aria-label="Footer" >
<a href="../default_dataflow/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Dataflow">
<a href="../methods/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Methods">
<div class="md-footer__button md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg>
@ -2212,7 +2234,7 @@
Previous
</span>
<div class="md-ellipsis">
Dataflow
Methods
</div>
</div>
</a>

View File

@ -9,6 +9,10 @@
<link rel="prev" href="../default_dataflow/">
<link rel="next" href="../inputs/">
<link rel="icon" href="../../assets/images/favicon.png">
@ -16,7 +20,7 @@
<title>Indexing Methods - GraphRAG</title>
<title>Methods - GraphRAG</title>
@ -106,7 +110,7 @@
<div class="md-header__topic" data-md-component="header-topic">
<span class="md-ellipsis">
Indexing Methods
Methods
</span>
</div>
@ -229,10 +233,12 @@
<li class="md-tabs__item">
<li class="md-tabs__item md-tabs__item--active">
<a href="../overview/" class="md-tabs__link">
@ -494,23 +500,28 @@
<li class="md-nav__item md-nav__item--nested">
<li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" >
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" checked>
<label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
<label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="">
<span class="md-ellipsis">
@ -522,7 +533,7 @@
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_2">
<span class="md-nav__icon md-icon"></span>
Indexing
@ -558,11 +569,11 @@
<li class="md-nav__item">
<a href="../architecture/" class="md-nav__link">
<a href="../default_dataflow/" class="md-nav__link">
<span class="md-ellipsis">
Architecture
Dataflow
</span>
@ -577,19 +588,87 @@
<li class="md-nav__item">
<a href="../default_dataflow/" class="md-nav__link">
<li class="md-nav__item md-nav__item--active">
<input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
<label class="md-nav__link md-nav__link--active" for="__toc">
<span class="md-ellipsis">
Methods
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
<span class="md-ellipsis">
Dataflow
Methods
</span>
</a>
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#standard-graphrag" class="md-nav__link">
<span class="md-ellipsis">
Standard GraphRAG
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#fastgraphrag" class="md-nav__link">
<span class="md-ellipsis">
FastGraphRAG
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#choosing-a-method" class="md-nav__link">
<span class="md-ellipsis">
Choosing a Method
</span>
</a>
</li>
</ul>
</nav>
</li>
@ -639,6 +718,28 @@
<li class="md-nav__item">
<a href="../byog/" class="md-nav__link">
<span class="md-ellipsis">
Custom Graphs
</span>
</a>
</li>
</ul>
</nav>
@ -1143,7 +1244,7 @@
<span class="md-ellipsis">
Using YAML
Detailed Configuration
</span>
@ -1161,11 +1262,11 @@
<li class="md-nav__item">
<a href="../../config/env_vars/" class="md-nav__link">
<a href="../../config/models/" class="md-nav__link">
<span class="md-ellipsis">
Using Env Vars
Language Model Selection
</span>
@ -1513,6 +1614,44 @@
<footer class="md-footer">
<nav class="md-footer__inner md-grid" aria-label="Footer" >
<a href="../default_dataflow/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Dataflow">
<div class="md-footer__button md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg>
</div>
<div class="md-footer__title">
<span class="md-footer__direction">
Previous
</span>
<div class="md-ellipsis">
Dataflow
</div>
</div>
</a>
<a href="../inputs/" class="md-footer__link md-footer__link--next" aria-label="Next: Inputs">
<div class="md-footer__title">
<span class="md-footer__direction">
Next
</span>
<div class="md-ellipsis">
Inputs
</div>
</div>
<div class="md-footer__button md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11z"/></svg>
</div>
</a>
</nav>
<div class="md-footer-meta md-typeset">
<div class="md-footer-meta__inner md-grid">

View File

@ -12,7 +12,7 @@
<link rel="prev" href="../inputs/">
<link rel="next" href="../../prompt_tuning/overview/">
<link rel="next" href="../byog/">
<link rel="icon" href="../../assets/images/favicon.png">
@ -569,11 +569,11 @@
<li class="md-nav__item">
<a href="../architecture/" class="md-nav__link">
<a href="../default_dataflow/" class="md-nav__link">
<span class="md-ellipsis">
Architecture
Dataflow
</span>
@ -591,11 +591,11 @@
<li class="md-nav__item">
<a href="../default_dataflow/" class="md-nav__link">
<a href="../methods/" class="md-nav__link">
<span class="md-ellipsis">
Dataflow
Methods
</span>
@ -763,6 +763,28 @@
<li class="md-nav__item">
<a href="../byog/" class="md-nav__link">
<span class="md-ellipsis">
Custom Graphs
</span>
</a>
</li>
</ul>
</nav>
@ -1267,7 +1289,7 @@
<span class="md-ellipsis">
Using YAML
Detailed Configuration
</span>
@ -1285,11 +1307,11 @@
<li class="md-nav__item">
<a href="../../config/env_vars/" class="md-nav__link">
<a href="../../config/models/" class="md-nav__link">
<span class="md-ellipsis">
Using Env Vars
Language Model Selection
</span>
@ -2073,13 +2095,13 @@
<a href="../../prompt_tuning/overview/" class="md-footer__link md-footer__link--next" aria-label="Next: Overview">
<a href="../byog/" class="md-footer__link md-footer__link--next" aria-label="Next: Custom Graphs">
<div class="md-footer__title">
<span class="md-footer__direction">
Next
</span>
<div class="md-ellipsis">
Overview
Custom Graphs
</div>
</div>
<div class="md-footer__button md-icon">

View File

@ -12,7 +12,7 @@
<link rel="prev" href="../../developing/">
<link rel="next" href="../architecture/">
<link rel="next" href="../default_dataflow/">
<link rel="icon" href="../../assets/images/favicon.png">
@ -676,11 +676,11 @@
<li class="md-nav__item">
<a href="../architecture/" class="md-nav__link">
<a href="../default_dataflow/" class="md-nav__link">
<span class="md-ellipsis">
Architecture
Dataflow
</span>
@ -698,11 +698,11 @@
<li class="md-nav__item">
<a href="../default_dataflow/" class="md-nav__link">
<a href="../methods/" class="md-nav__link">
<span class="md-ellipsis">
Dataflow
Methods
</span>
@ -757,6 +757,28 @@
<li class="md-nav__item">
<a href="../byog/" class="md-nav__link">
<span class="md-ellipsis">
Custom Graphs
</span>
</a>
</li>
</ul>
</nav>
@ -1261,7 +1283,7 @@
<span class="md-ellipsis">
Using YAML
Detailed Configuration
</span>
@ -1279,11 +1301,11 @@
<li class="md-nav__item">
<a href="../../config/env_vars/" class="md-nav__link">
<a href="../../config/models/" class="md-nav__link">
<span class="md-ellipsis">
Using Env Vars
Language Model Selection
</span>
@ -1689,13 +1711,13 @@ After you have a config file you can run the pipeline using the CLI or the Pytho
<a href="../architecture/" class="md-footer__link md-footer__link--next" aria-label="Next: Architecture">
<a href="../default_dataflow/" class="md-footer__link md-footer__link--next" aria-label="Next: Dataflow">
<div class="md-footer__title">
<span class="md-footer__direction">
Next
</span>
<div class="md-ellipsis">
Architecture
Dataflow
</div>
</div>
<div class="md-footer__button md-icon">

View File

@ -564,11 +564,11 @@
<li class="md-nav__item">
<a href="../../index/architecture/" class="md-nav__link">
<a href="../../index/default_dataflow/" class="md-nav__link">
<span class="md-ellipsis">
Architecture
Dataflow
</span>
@ -586,11 +586,11 @@
<li class="md-nav__item">
<a href="../../index/default_dataflow/" class="md-nav__link">
<a href="../../index/methods/" class="md-nav__link">
<span class="md-ellipsis">
Dataflow
Methods
</span>
@ -645,6 +645,28 @@
<li class="md-nav__item">
<a href="../../index/byog/" class="md-nav__link">
<span class="md-ellipsis">
Custom Graphs
</span>
</a>
</li>
</ul>
</nav>
@ -1249,7 +1271,7 @@
<span class="md-ellipsis">
Using YAML
Detailed Configuration
</span>
@ -1267,11 +1289,11 @@
<li class="md-nav__item">
<a href="../../config/env_vars/" class="md-nav__link">
<a href="../../config/models/" class="md-nav__link">
<span class="md-ellipsis">
Using Env Vars
Language Model Selection
</span>

View File

@ -564,11 +564,11 @@
<li class="md-nav__item">
<a href="../../index/architecture/" class="md-nav__link">
<a href="../../index/default_dataflow/" class="md-nav__link">
<span class="md-ellipsis">
Architecture
Dataflow
</span>
@ -586,11 +586,11 @@
<li class="md-nav__item">
<a href="../../index/default_dataflow/" class="md-nav__link">
<a href="../../index/methods/" class="md-nav__link">
<span class="md-ellipsis">
Dataflow
Methods
</span>
@ -645,6 +645,28 @@
<li class="md-nav__item">
<a href="../../index/byog/" class="md-nav__link">
<span class="md-ellipsis">
Custom Graphs
</span>
</a>
</li>
</ul>
</nav>
@ -1393,7 +1415,7 @@
<span class="md-ellipsis">
Using YAML
Detailed Configuration
</span>
@ -1411,11 +1433,11 @@
<li class="md-nav__item">
<a href="../../config/env_vars/" class="md-nav__link">
<a href="../../config/models/" class="md-nav__link">
<span class="md-ellipsis">
Using Env Vars
Language Model Selection
</span>

View File

@ -9,7 +9,7 @@
<link rel="prev" href="../../index/outputs/">
<link rel="prev" href="../../index/byog/">
<link rel="next" href="../auto_prompt_tuning/">
@ -564,11 +564,11 @@
<li class="md-nav__item">
<a href="../../index/architecture/" class="md-nav__link">
<a href="../../index/default_dataflow/" class="md-nav__link">
<span class="md-ellipsis">
Architecture
Dataflow
</span>
@ -586,11 +586,11 @@
<li class="md-nav__item">
<a href="../../index/default_dataflow/" class="md-nav__link">
<a href="../../index/methods/" class="md-nav__link">
<span class="md-ellipsis">
Dataflow
Methods
</span>
@ -645,6 +645,28 @@
<li class="md-nav__item">
<a href="../../index/byog/" class="md-nav__link">
<span class="md-ellipsis">
Custom Graphs
</span>
</a>
</li>
</ul>
</nav>
@ -1222,7 +1244,7 @@
<span class="md-ellipsis">
Using YAML
Detailed Configuration
</span>
@ -1240,11 +1262,11 @@
<li class="md-nav__item">
<a href="../../config/env_vars/" class="md-nav__link">
<a href="../../config/models/" class="md-nav__link">
<span class="md-ellipsis">
Using Env Vars
Language Model Selection
</span>
@ -1573,7 +1595,7 @@
<nav class="md-footer__inner md-grid" aria-label="Footer" >
<a href="../../index/outputs/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Outputs">
<a href="../../index/byog/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Custom Graphs">
<div class="md-footer__button md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg>
@ -1583,7 +1605,7 @@
Previous
</span>
<div class="md-ellipsis">
Outputs
Custom Graphs
</div>
</div>
</a>

View File

@ -564,11 +564,11 @@
<li class="md-nav__item">
<a href="../../index/architecture/" class="md-nav__link">
<a href="../../index/default_dataflow/" class="md-nav__link">
<span class="md-ellipsis">
Architecture
Dataflow
</span>
@ -586,11 +586,11 @@
<li class="md-nav__item">
<a href="../../index/default_dataflow/" class="md-nav__link">
<a href="../../index/methods/" class="md-nav__link">
<span class="md-ellipsis">
Dataflow
Methods
</span>
@ -645,6 +645,28 @@
<li class="md-nav__item">
<a href="../../index/byog/" class="md-nav__link">
<span class="md-ellipsis">
Custom Graphs
</span>
</a>
</li>
</ul>
</nav>
@ -1240,7 +1262,7 @@
<span class="md-ellipsis">
Using YAML
Detailed Configuration
</span>
@ -1258,11 +1280,11 @@
<li class="md-nav__item">
<a href="../../config/env_vars/" class="md-nav__link">
<a href="../../config/models/" class="md-nav__link">
<span class="md-ellipsis">
Using Env Vars
Language Model Selection
</span>

View File

@ -564,11 +564,11 @@
<li class="md-nav__item">
<a href="../../index/architecture/" class="md-nav__link">
<a href="../../index/default_dataflow/" class="md-nav__link">
<span class="md-ellipsis">
Architecture
Dataflow
</span>
@ -586,11 +586,11 @@
<li class="md-nav__item">
<a href="../../index/default_dataflow/" class="md-nav__link">
<a href="../../index/methods/" class="md-nav__link">
<span class="md-ellipsis">
Dataflow
Methods
</span>
@ -645,6 +645,28 @@
<li class="md-nav__item">
<a href="../../index/byog/" class="md-nav__link">
<span class="md-ellipsis">
Custom Graphs
</span>
</a>
</li>
</ul>
</nav>
@ -1231,7 +1253,7 @@
<span class="md-ellipsis">
Using YAML
Detailed Configuration
</span>
@ -1249,11 +1271,11 @@
<li class="md-nav__item">
<a href="../../config/env_vars/" class="md-nav__link">
<a href="../../config/models/" class="md-nav__link">
<span class="md-ellipsis">
Using Env Vars
Language Model Selection
</span>

View File

@ -564,11 +564,11 @@
<li class="md-nav__item">
<a href="../../index/architecture/" class="md-nav__link">
<a href="../../index/default_dataflow/" class="md-nav__link">
<span class="md-ellipsis">
Architecture
Dataflow
</span>
@ -586,11 +586,11 @@
<li class="md-nav__item">
<a href="../../index/default_dataflow/" class="md-nav__link">
<a href="../../index/methods/" class="md-nav__link">
<span class="md-ellipsis">
Dataflow
Methods
</span>
@ -645,6 +645,28 @@
<li class="md-nav__item">
<a href="../../index/byog/" class="md-nav__link">
<span class="md-ellipsis">
Custom Graphs
</span>
</a>
</li>
</ul>
</nav>
@ -1231,7 +1253,7 @@
<span class="md-ellipsis">
Using YAML
Detailed Configuration
</span>
@ -1249,11 +1271,11 @@
<li class="md-nav__item">
<a href="../../config/env_vars/" class="md-nav__link">
<a href="../../config/models/" class="md-nav__link">
<span class="md-ellipsis">
Using Env Vars
Language Model Selection
</span>

View File

@ -558,11 +558,11 @@
<li class="md-nav__item">
<a href="../../index/architecture/" class="md-nav__link">
<a href="../../index/default_dataflow/" class="md-nav__link">
<span class="md-ellipsis">
Architecture
Dataflow
</span>
@ -580,11 +580,11 @@
<li class="md-nav__item">
<a href="../../index/default_dataflow/" class="md-nav__link">
<a href="../../index/methods/" class="md-nav__link">
<span class="md-ellipsis">
Dataflow
Methods
</span>
@ -639,6 +639,28 @@
<li class="md-nav__item">
<a href="../../index/byog/" class="md-nav__link">
<span class="md-ellipsis">
Custom Graphs
</span>
</a>
</li>
</ul>
</nav>
@ -1143,7 +1165,7 @@
<span class="md-ellipsis">
Using YAML
Detailed Configuration
</span>
@ -1161,11 +1183,11 @@
<li class="md-nav__item">
<a href="../../config/env_vars/" class="md-nav__link">
<a href="../../config/models/" class="md-nav__link">
<span class="md-ellipsis">
Using Env Vars
Language Model Selection
</span>

View File

@ -564,11 +564,11 @@
<li class="md-nav__item">
<a href="../../../index/architecture/" class="md-nav__link">
<a href="../../../index/default_dataflow/" class="md-nav__link">
<span class="md-ellipsis">
Architecture
Dataflow
</span>
@ -586,11 +586,11 @@
<li class="md-nav__item">
<a href="../../../index/default_dataflow/" class="md-nav__link">
<a href="../../../index/methods/" class="md-nav__link">
<span class="md-ellipsis">
Dataflow
Methods
</span>
@ -645,6 +645,28 @@
<li class="md-nav__item">
<a href="../../../index/byog/" class="md-nav__link">
<span class="md-ellipsis">
Custom Graphs
</span>
</a>
</li>
</ul>
</nav>
@ -1166,7 +1188,7 @@
<span class="md-ellipsis">
Using YAML
Detailed Configuration
</span>
@ -1184,11 +1206,11 @@
<li class="md-nav__item">
<a href="../../../config/env_vars/" class="md-nav__link">
<a href="../../../config/models/" class="md-nav__link">
<span class="md-ellipsis">
Using Env Vars
Language Model Selection
</span>

View File

@ -564,11 +564,11 @@
<li class="md-nav__item">
<a href="../../index/architecture/" class="md-nav__link">
<a href="../../index/default_dataflow/" class="md-nav__link">
<span class="md-ellipsis">
Architecture
Dataflow
</span>
@ -586,11 +586,11 @@
<li class="md-nav__item">
<a href="../../index/default_dataflow/" class="md-nav__link">
<a href="../../index/methods/" class="md-nav__link">
<span class="md-ellipsis">
Dataflow
Methods
</span>
@ -645,6 +645,28 @@
<li class="md-nav__item">
<a href="../../index/byog/" class="md-nav__link">
<span class="md-ellipsis">
Custom Graphs
</span>
</a>
</li>
</ul>
</nav>
@ -887,6 +909,15 @@
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#basic-search" class="md-nav__link">
<span class="md-ellipsis">
Basic Search
</span>
</a>
</li>
<li class="md-nav__item">
@ -1231,7 +1262,7 @@
<span class="md-ellipsis">
Using YAML
Detailed Configuration
</span>
@ -1249,11 +1280,11 @@
<li class="md-nav__item">
<a href="../../config/env_vars/" class="md-nav__link">
<a href="../../config/models/" class="md-nav__link">
<span class="md-ellipsis">
Using Env Vars
Language Model Selection
</span>
@ -1524,6 +1555,15 @@
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#basic-search" class="md-nav__link">
<span class="md-ellipsis">
Basic Search
</span>
</a>
</li>
<li class="md-nav__item">
@ -1572,6 +1612,8 @@ It is responsible for the following tasks:</p>
<h2 id="drift-search">DRIFT Search</h2>
<p>DRIFT Search introduces a new approach to local search queries by including community information in the search process. This greatly expands the breadth of the querys starting point and leads to retrieval and usage of a far higher variety of facts in the final answer. This addition expands the GraphRAG query engine by providing a more comprehensive option for local search, which uses community insights to refine a query into detailed follow-up questions.</p>
<p>To learn more about DRIFT Search, please refer to the <a href="../drift_search/">DRIFT Search</a> documentation.</p>
<h2 id="basic-search">Basic Search</h2>
<p>GraphRAG includes a rudimentary implementation of basic vector RAG to make it easy to compare different search results based on the type of question you are asking. You can specify the top <code>k</code> txt unit chunks to include in the summarization context.</p>
<h2 id="question-generation">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="../question_generation/">Question Generation</a> documentation page.</p>

View File

@ -564,11 +564,11 @@
<li class="md-nav__item">
<a href="../../index/architecture/" class="md-nav__link">
<a href="../../index/default_dataflow/" class="md-nav__link">
<span class="md-ellipsis">
Architecture
Dataflow
</span>
@ -586,11 +586,11 @@
<li class="md-nav__item">
<a href="../../index/default_dataflow/" class="md-nav__link">
<a href="../../index/methods/" class="md-nav__link">
<span class="md-ellipsis">
Dataflow
Methods
</span>
@ -645,6 +645,28 @@
<li class="md-nav__item">
<a href="../../index/byog/" class="md-nav__link">
<span class="md-ellipsis">
Custom Graphs
</span>
</a>
</li>
</ul>
</nav>
@ -1231,7 +1253,7 @@
<span class="md-ellipsis">
Using YAML
Detailed Configuration
</span>
@ -1249,11 +1271,11 @@
<li class="md-nav__item">
<a href="../../config/env_vars/" class="md-nav__link">
<a href="../../config/models/" class="md-nav__link">
<span class="md-ellipsis">
Using Env Vars
Language Model Selection
</span>

File diff suppressed because one or more lines are too long

Binary file not shown.

View File

@ -564,11 +564,11 @@
<li class="md-nav__item">
<a href="../index/architecture/" class="md-nav__link">
<a href="../index/default_dataflow/" class="md-nav__link">
<span class="md-ellipsis">
Architecture
Dataflow
</span>
@ -586,11 +586,11 @@
<li class="md-nav__item">
<a href="../index/default_dataflow/" class="md-nav__link">
<a href="../index/methods/" class="md-nav__link">
<span class="md-ellipsis">
Dataflow
Methods
</span>
@ -645,6 +645,28 @@
<li class="md-nav__item">
<a href="../index/byog/" class="md-nav__link">
<span class="md-ellipsis">
Custom Graphs
</span>
</a>
</li>
</ul>
</nav>
@ -1149,7 +1171,7 @@
<span class="md-ellipsis">
Using YAML
Detailed Configuration
</span>
@ -1167,11 +1189,11 @@
<li class="md-nav__item">
<a href="../config/env_vars/" class="md-nav__link">
<a href="../config/models/" class="md-nav__link">
<span class="md-ellipsis">
Using Env Vars
Language Model Selection
</span>
@ -1673,19 +1695,19 @@
<div class="highlight"><pre><span></span><code><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a><span class="nt">embed_graph</span><span class="p">:</span>
<a id="__codelineno-1-2" name="__codelineno-1-2" href="#__codelineno-1-2"></a><span class="w"> </span><span class="nt">enabled</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span><span class="w"> </span><span class="c1"># will generate node2vec embeddings for nodes</span>
<a id="__codelineno-1-3" name="__codelineno-1-3" href="#__codelineno-1-3"></a><span class="nt">umap</span><span class="p">:</span>
<a id="__codelineno-1-4" name="__codelineno-1-4" href="#__codelineno-1-4"></a><span class="w"> </span><span class="nt">enabled</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span><span class="w"> </span><span class="c1"># will generate UMAP embeddings for nodes</span>
<a id="__codelineno-1-4" name="__codelineno-1-4" href="#__codelineno-1-4"></a><span class="w"> </span><span class="nt">enabled</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span><span class="w"> </span><span class="c1"># will generate UMAP embeddings for nodes, giving the entities table an x/y position to plot</span>
</code></pre></div>
After running the indexing pipeline over your data, there will be an output folder (defined by the <code>storage.base_dir</code> setting).</p>
<ul>
<li><strong>Output Folder</strong>: Contains artifacts from the LLMs indexing pass.</li>
</ul>
<h2 id="2-locate-the-knowledge-graph">2. Locate the Knowledge Graph</h2>
<p>In the output folder, look for a file named <code>merged_graph.graphml</code>. graphml is a standard <a href="http://graphml.graphdrawing.org">file format</a> supported by many visualization tools. We recommend trying <a href="https://gephi.org">Gephi</a>.</p>
<p>In the output folder, look for a file named <code>graph.graphml</code>. graphml is a standard <a href="http://graphml.graphdrawing.org">file format</a> supported by many visualization tools. We recommend trying <a href="https://gephi.org">Gephi</a>.</p>
<h2 id="3-open-the-graph-in-gephi">3. Open the Graph in Gephi</h2>
<ol>
<li>Install and open Gephi</li>
<li>Navigate to the <code>output</code> folder containing the various parquet files.</li>
<li>Import the <code>merged_graph.graphml</code> file into Gephi. This will result in a fairly plain view of the undirected graph nodes and edges.</li>
<li>Import the <code>graph.graphml</code> file into Gephi. This will result in a fairly plain view of the undirected graph nodes and edges.</li>
</ol>
<p align="center">
<img src="../img/viz_guide/gephi-initial-graph-example.png" alt="A basic graph visualization by Gephi" width="300"/>