Deploying to gh-pages from @ microsoft/graphrag@0ccfbccd2b 🚀

This commit is contained in:
darthtrevino 2024-05-23 00:03:23 +00:00
parent 283098b9e8
commit e5cd5dadf5
6 changed files with 43 additions and 9 deletions

Binary file not shown.

View File

@ -292,7 +292,7 @@ For a deeper dive into the main sub-systems, please visit the docpages for the <
</ul>
<p>To address this, the tech community is working to develop methods that extend and enhance RAG. Microsoft Researchs new approach, GraphRAG, uses LLMs to create a knowledge graph based on an input corpus. This graph, along with community summaries and graph machine learning outputs, are used to augment prompts at query time. GraphRAG shows substantial improvement in answering the two classes of questions described above, demonstrating intelligence or mastery that outperforms other approaches previously applied to private datasets.</p>
<h2>The GraphRAG Process 🤖</h2>
<p>GraphRAG builds upon our prior <a href="https://www.microsoft.com/en-us/worklab/patterns-hidden-inside-the-org-chart">research</a> and <a href="https://github.com/microsoft/graspologic">tooling</a> using graph machine learning. The basic steps of the GraphRAG process are as follows:</p>
<p>GraphRAG builds upon our prior <a href="https://www.microsoft.com/en-us/worklab/patterns-hidden-inside-the-org-chart">research</a> and <a href="https://github.com/graspologic-org/graspologic">tooling</a> using graph machine learning. The basic steps of the GraphRAG process are as follows:</p>
<h3>Index</h3>
<ul>
<li>Slice up an input corpus into a series of TextUnits, which act as analyzable units for the rest of the process, and provide fine-grained references ino our outputs.</li>

View File

@ -301,8 +301,8 @@ a {
<tbody>
<tr>
<td><code>GRAPHRAG_API_KEY</code></td>
<td><strong>Yes</strong></td>
<td>The API key. (Note: `OPENAI_API_KEY is also used as a fallback)</td>
<td><strong>Yes for OpenAI. Optional for AOAI</strong></td>
<td>The API key. (Note: `OPENAI_API_KEY is also used as a fallback). If not defined when using AOAI, managed identity will be used.</td>
<td><code>str</code></td>
<td><code>None</code></td>
</tr>
@ -366,7 +366,7 @@ a {
<tr>
<td><code>GRAPHRAG_LLM_API_KEY</code></td>
<td>Yes (uses fallback)</td>
<td>The API key.</td>
<td>The API key. If not defined when using AOAI, managed identity will be used.</td>
<td><code>str</code></td>
<td><code>None</code></td>
</tr>
@ -514,7 +514,7 @@ a {
<tr>
<td><code>GRAPHRAG_EMBEDDING_API_KEY</code></td>
<td>Yes (uses fallback)</td>
<td>The API key to use for the embedding client.</td>
<td>The API key to use for the embedding client. If not defined when using AOAI, managed identity will be used.</td>
<td><code>str</code></td>
<td><code>None</code></td>
</tr>
@ -646,6 +646,8 @@ a {
</tr>
</tbody>
</table>
<h2>Input Settings</h2>
<p>These settings control the data input used by the pipeline. Any settings with a fallback will use the base LLM settings, if available.</p>
<h3>Plaintext Input Data (<code>GRAPHRAG_INPUT_TYPE</code>=text)</h3>
<table>
<thead>
@ -702,7 +704,7 @@ a {
</tr>
<tr>
<td><code>GRAPHRAG_INPUT_TIMESTAMP_FORMAT</code></td>
<td>The timestamp format to use when parsing timestamps in the timestamp column</td>
<td>The timestamp format to use when parsing timestamps in the timestamp column.</td>
<td><code>str</code></td>
<td>optional</td>
<td><code>None</code></td>
@ -736,6 +738,13 @@ a {
<td><code>file</code></td>
</tr>
<tr>
<td><code>GRAPHRAG_INPUT_STORAGE_ACCOUNT_BLOB_URL</code></td>
<td>The Azure Storage blob endpoint to use when in <code>blob</code> mode and using managed identity. Will have the format <code>https://&lt;storage_account_name&gt;.blob.core.windows.net</code></td>
<td><code>str</code></td>
<td>optional</td>
<td><code>None</code></td>
</tr>
<tr>
<td><code>GRAPHRAG_INPUT_CONNECTION_STRING</code></td>
<td>The connection string to use when reading CSV input files from Azure Blob Storage.</td>
<td><code>str</code></td>
@ -933,6 +942,13 @@ a {
<td><code>file</code></td>
</tr>
<tr>
<td><code>GRAPHRAG_STORAGE_STORAGE_ACCOUNT_BLOB_URL</code></td>
<td>The Azure Storage blob endpoint to use when in <code>blob</code> mode and using managed identity. Will have the format <code>https://&lt;storage_account_name&gt;.blob.core.windows.net</code></td>
<td><code>str</code></td>
<td>optional</td>
<td>None</td>
</tr>
<tr>
<td><code>GRAPHRAG_STORAGE_CONNECTION_STRING</code></td>
<td>The Azure Storage connection string to use when in <code>blob</code> mode.</td>
<td><code>str</code></td>
@ -976,6 +992,13 @@ a {
<td><code>file</code></td>
</tr>
<tr>
<td><code>GRAPHRAG_CACHE_STORAGE_ACCOUNT_BLOB_URL</code></td>
<td>The Azure Storage blob endpoint to use when in <code>blob</code> mode and using managed identity. Will have the format <code>https://&lt;storage_account_name&gt;.blob.core.windows.net</code></td>
<td><code>str</code></td>
<td>optional</td>
<td>None</td>
</tr>
<tr>
<td><code>GRAPHRAG_CACHE_CONNECTION_STRING</code></td>
<td>The Azure Storage connection string to use when in <code>blob</code> mode.</td>
<td><code>str</code></td>
@ -1019,6 +1042,13 @@ a {
<td><code>file</code></td>
</tr>
<tr>
<td><code>GRAPHRAG_REPORTING_STORAGE_ACCOUNT_BLOB_URL</code></td>
<td>The Azure Storage blob endpoint to use when in <code>blob</code> mode and using managed identity. Will have the format <code>https://&lt;storage_account_name&gt;.blob.core.windows.net</code></td>
<td><code>str</code></td>
<td>optional</td>
<td>None</td>
</tr>
<tr>
<td><code>GRAPHRAG_REPORTING_CONNECTION_STRING</code></td>
<td>The Azure Storage connection string to use when in <code>blob</code> mode.</td>
<td><code>str</code></td>

View File

@ -299,6 +299,7 @@ API_KEY=some_api_key
<li><code>connection_string</code> <strong>str</strong> - (blob only) The Azure Storage connection string.</li>
<li><code>container_name</code> <strong>str</strong> - (blob only) The Azure Storage container name.</li>
<li><code>base_dir</code> <strong>str</strong> - The base directory to read input from, relative to the root.</li>
<li><code>storage_account_blob_url</code> <strong>str</strong> - The storage account blob URL to use.</li>
</ul>
<h2>llm</h2>
<p>This is the base LLM configuration section. Other steps may override this configuration with their own LLM configuration.</p>
@ -357,6 +358,7 @@ API_KEY=some_api_key
<li><code>connection_string</code> <strong>str</strong> - (blob only) The Azure Storage connection string.</li>
<li><code>container_name</code> <strong>str</strong> - (blob only) The Azure Storage container name.</li>
<li><code>base_dir</code> <strong>str</strong> - The base directory to write cache to, relative to the root.</li>
<li><code>storage_account_blob_url</code> <strong>str</strong> - The storage account blob URL to use.</li>
</ul>
<h2>storage</h2>
<h3>Fields</h3>
@ -365,6 +367,7 @@ API_KEY=some_api_key
<li><code>connection_string</code> <strong>str</strong> - (blob only) The Azure Storage connection string.</li>
<li><code>container_name</code> <strong>str</strong> - (blob only) The Azure Storage container name.</li>
<li><code>base_dir</code> <strong>str</strong> - The base directory to write reports to, relative to the root.</li>
<li><code>storage_account_blob_url</code> <strong>str</strong> - The storage account blob URL to use.</li>
</ul>
<h2>reporting</h2>
<h3>Fields</h3>
@ -373,6 +376,7 @@ API_KEY=some_api_key
<li><code>connection_string</code> <strong>str</strong> - (blob only) The Azure Storage connection string.</li>
<li><code>container_name</code> <strong>str</strong> - (blob only) The Azure Storage container name.</li>
<li><code>base_dir</code> <strong>str</strong> - The base directory to write reports to, relative to the root.</li>
<li><code>storage_account_blob_url</code> <strong>str</strong> - The storage account blob URL to use.</li>
</ul>
<h2>entity_extraction</h2>
<h3>Fields</h3>

View File

@ -281,7 +281,7 @@ a {
</thead>
<tbody>
<tr>
<td>Python 3.10 or 3.11</td>
<td>Python 3.10-3.12</td>
<td><a href="https://www.python.org/downloads/">Download</a></td>
<td>The library is Python-based.</td>
</tr>

View File

@ -271,7 +271,7 @@ a {
<main>
<h1>Get Started</h1>
<h2>Requirements</h2>
<p><a href="https://www.python.org/downloads/">Python 3.10 or 3.11</a></p>
<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>
@ -338,7 +338,7 @@ It shows how to use the system to index some text, and then use the indexed data
<div style="position: relative">
<pre class="language-sh"><code id="code-64" class="language-sh"><span class="token builtin class-name">export</span> <span class="token assign-left variable">GRAPHRAG_API_BASE</span><span class="token operator">=</span><span class="token string">"https://&lt;domain>.openai.azure.com"</span> <span class="token operator">&amp;&amp;</span> <span class="token punctuation">\</span>
<span class="token builtin class-name">export</span> <span class="token assign-left variable">GRAPHRAG_API_VERSION</span><span class="token operator">=</span><span class="token string">"2024-02-15-preview"</span> <span class="token operator">&amp;&amp;</span> <span class="token punctuation">\</span>
<span class="token builtin class-name">export</span> GRAPHRAG_LLM_API_TYPE <span class="token operator">=</span> <span class="token string">"azure_openai_chat"</span> <span class="token operator">&amp;&amp;</span> <span class="token punctuation">\</span>
<span class="token builtin class-name">export</span> GRAPHRAG_LLM_TYPE <span class="token operator">=</span> <span class="token string">"azure_openai_chat"</span> <span class="token operator">&amp;&amp;</span> <span class="token punctuation">\</span>
<span class="token builtin class-name">export</span> <span class="token assign-left variable">GRAPHRAG_LLM_DEPLOYMENT_NAME</span><span class="token operator">=</span><span class="token string">"&lt;chat_completions_deployment_name>"</span> <span class="token operator">&amp;&amp;</span> <span class="token punctuation">\</span>
<span class="token builtin class-name">export</span> GRAPHRAG_EMBEDDING_API_TYPE <span class="token operator">=</span> <span class="token string">"azure_openai_embedding"</span> <span class="token operator">&amp;&amp;</span> <span class="token punctuation">\</span>
<span class="token builtin class-name">export</span> <span class="token assign-left variable">GRAPHRAG_EMBEDDING_DEPLOYMENT_NAME</span><span class="token operator">=</span><span class="token string">"&lt;embeddings_deployment_name>"</span></code></pre>