kanshan/graphrag
1
0
Fork 0
mirror of https://github.com/microsoft/graphrag.git synced 2026-01-24 21:01:53 +08:00
Code Issues Actions 6 Packages Projects Releases Wiki Activity

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

Browse Source
This commit is contained in:
AlonsoGuevara 2024-04-04 19:00:36 +00:00
parent d2c74db35f
commit e5d442cd9f
1 changed files with 12 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
posts/get_started/index.html
View File

@ -369,6 +369,7 @@ It shows how to use the system to index some text, and then use the indexed data
<ul>
<li><code>GRAPHRAG_API_KEY</code> - API Key for executing the model, will fallback to <code>OPENAI_API_KEY</code> if one is not provided.</li>
<li><code>GRAPHRAG_LLM_MODEL</code> - Model to use for Chat Completions.</li>
<li><code>GRAPHRAG_LLM_MODEL_SUPPORTS_JSON</code> - This will signal to the indexing engine that you're using a model capable of JSON-mode output (e.g. gpt-4 or gpt-3.5-turbo). We <em>highly recommend</em> enabling this to avoid malformed JSON errors during indexing.</li>
<li><code>GRAPHRAG_EMBEDDING_MODEL</code> - Model to use for Embeddings.</li>
<li><code>GRAPHRAG_INPUT_TYPE</code> - Type of input data, can be <code>text</code> or <code>csv</code>.</li>
<li><code>GRAPHRAG_API_BASE</code> - Base URL for the Azure OpenAI. Only required for Azure OpenAI users.</li>
@ -378,25 +379,26 @@ It shows how to use the system to index some text, and then use the indexed data
<h4><ins>OpenAI</ins></h4>
<div style="position: relative">
<pre class="language-sh"><code id="code-91" class="language-sh"><span class="token builtin class-name">export</span> <span class="token assign-left variable">GRAPHRAG_API_KEY</span><span class="token operator">=</span><span class="token operator">&lt;</span>api_key<span class="token operator">></span> <span class="token operator">&amp;&amp;</span> <span class="token punctuation">\</span>
<pre class="language-sh"><code id="code-96" class="language-sh"><span class="token builtin class-name">export</span> <span class="token assign-left variable">GRAPHRAG_API_KEY</span><span class="token operator">=</span><span class="token operator">&lt;</span>api_key<span class="token operator">></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_MODEL</span><span class="token operator">=</span><span class="token operator">&lt;</span>chat_completions_model<span class="token operator">></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_MODEL</span><span class="token operator">=</span><span class="token operator">&lt;</span>embeddings_model<span class="token operator">></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_MODEL_SUPPORTS_JSON</span><span class="token operator">=</span><span class="token string">"True"</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_INPUT_TYPE</span><span class="token operator">=</span><span class="token string">"text"</span></code></pre>
<button class="code-copy " data-clipboard-target="#code-91" style="position: absolute; top: 7.5px; right: 6px; padding-top: 3px; cursor: pointer; outline: none; opacity: 0.8;" title="Copy">
<button class="code-copy " data-clipboard-target="#code-96" style="position: absolute; top: 7.5px; right: 6px; padding-top: 3px; cursor: pointer; outline: none; opacity: 0.8;" title="Copy">
<span style="display:inline-block;background:url(https://api.iconify.design/mdi/content-copy.svg) no-repeat center center / contain;width: 16px; height: 16px;" class=""></span>
</button>
</div>
<h4><ins>Azure OpenAI</ins></h4>
<div style="position: relative">
<pre class="language-sh"><code id="code-95" class="language-sh"><span class="token builtin class-name">export</span> <span class="token assign-left variable">GRAPHRAG_API_KEY</span><span class="token operator">=</span><span class="token operator">&lt;</span>api_key<span class="token operator">></span> <span class="token operator">&amp;&amp;</span> <span class="token punctuation">\</span>
<pre class="language-sh"><code id="code-100" class="language-sh"><span class="token builtin class-name">export</span> <span class="token assign-left variable">GRAPHRAG_API_KEY</span><span class="token operator">=</span><span class="token operator">&lt;</span>api_key<span class="token operator">></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 operator">&lt;</span>chat_completions_model<span class="token operator">></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 operator">&lt;</span>embeddings_model<span class="token operator">></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_INPUT_TYPE</span><span class="token operator">=</span><span class="token string">"text"</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_BASE</span><span class="token operator">=</span><span class="token string">"http://&lt;domain>.openai.azure.com"</span></code></pre>
<button class="code-copy " data-clipboard-target="#code-95" style="position: absolute; top: 7.5px; right: 6px; padding-top: 3px; cursor: pointer; outline: none; opacity: 0.8;" title="Copy">
<button class="code-copy " data-clipboard-target="#code-100" style="position: absolute; top: 7.5px; right: 6px; padding-top: 3px; cursor: pointer; outline: none; opacity: 0.8;" title="Copy">
<span style="display:inline-block;background:url(https://api.iconify.design/mdi/content-copy.svg) no-repeat center center / contain;width: 16px; height: 16px;" class=""></span>
</button>
</div>
@ -406,9 +408,9 @@ For more details about using the CLI, refer to the <a href="/graphrag/posts/quer
<p>Finally we'll run the pipeline!</p>
<div style="position: relative">
<pre class="language-sh"><code id="code-105" class="language-sh">python <span class="token parameter variable">-m</span> graphrag.index <span class="token parameter variable">--root</span> ./ragtest</code></pre>
<pre class="language-sh"><code id="code-110" class="language-sh">python <span class="token parameter variable">-m</span> graphrag.index <span class="token parameter variable">--root</span> ./ragtest</code></pre>
<button class="code-copy " data-clipboard-target="#code-105" style="position: absolute; top: 7.5px; right: 6px; padding-top: 3px; cursor: pointer; outline: none; opacity: 0.8;" title="Copy">
<button class="code-copy " data-clipboard-target="#code-110" style="position: absolute; top: 7.5px; right: 6px; padding-top: 3px; cursor: pointer; outline: none; opacity: 0.8;" title="Copy">
<span style="display:inline-block;background:url(https://api.iconify.design/mdi/content-copy.svg) no-repeat center center / contain;width: 16px; height: 16px;" class=""></span>
</button>
</div>
@ -421,24 +423,24 @@ Once the pipeline is complete, you should see a new folder called <code>./ragtes
<p>Here is an example using Global search to ask a high-level question:</p>
<div style="position: relative">
<pre class="language-sh"><code id="code-124" class="language-sh">python <span class="token parameter variable">-m</span> graphrag.query <span class="token punctuation">\</span>
<pre class="language-sh"><code id="code-129" class="language-sh">python <span class="token parameter variable">-m</span> graphrag.query <span class="token punctuation">\</span>
<span class="token parameter variable">--data</span> ./ragtest/output/<span class="token operator">&lt;</span>timestamp<span class="token operator">></span>/artifacts <span class="token punctuation">\</span>
<span class="token parameter variable">--method</span> global<span class="token punctuation">\</span>
<span class="token string">"What are the top themes in this story?"</span></code></pre>
<button class="code-copy " data-clipboard-target="#code-124" style="position: absolute; top: 7.5px; right: 6px; padding-top: 3px; cursor: pointer; outline: none; opacity: 0.8;" title="Copy">
<button class="code-copy " data-clipboard-target="#code-129" style="position: absolute; top: 7.5px; right: 6px; padding-top: 3px; cursor: pointer; outline: none; opacity: 0.8;" title="Copy">
<span style="display:inline-block;background:url(https://api.iconify.design/mdi/content-copy.svg) no-repeat center center / contain;width: 16px; height: 16px;" class=""></span>
</button>
</div>
<p>Here is an example using Local search to ask a more specific question about a particular character:</p>
<div style="position: relative">
<pre class="language-sh"><code id="code-128" class="language-sh">python <span class="token parameter variable">-m</span> graphrag.query <span class="token punctuation">\</span>
<pre class="language-sh"><code id="code-133" class="language-sh">python <span class="token parameter variable">-m</span> graphrag.query <span class="token punctuation">\</span>
<span class="token parameter variable">--data</span> ./ragtest/output/<span class="token operator">&lt;</span>timestamp<span class="token operator">></span>/artifacts <span class="token punctuation">\</span>
<span class="token parameter variable">--method</span> <span class="token builtin class-name">local</span> <span class="token punctuation">\</span>
<span class="token string">"Who is Scrooge, and what are his main relationships?"</span></code></pre>
<button class="code-copy " data-clipboard-target="#code-128" style="position: absolute; top: 7.5px; right: 6px; padding-top: 3px; cursor: pointer; outline: none; opacity: 0.8;" title="Copy">
<button class="code-copy " data-clipboard-target="#code-133" style="position: absolute; top: 7.5px; right: 6px; padding-top: 3px; cursor: pointer; outline: none; opacity: 0.8;" title="Copy">
<span style="display:inline-block;background:url(https://api.iconify.design/mdi/content-copy.svg) no-repeat center center / contain;width: 16px; height: 16px;" class=""></span>
</button>
</div>