2024-04-04 01:23:24 +00:00
<!doctype html>
< html lang = "en" >
< head >
< meta charset = "utf-8" >
< meta name = "viewport" content = "width=device-width, initial-scale=1.0" >
< title > Query CLI< / title >
< link rel = "stylesheet" href = "https://cdn.jsdelivr.net/npm/bulma@0.9.4/css/bulma.min.css" >
< link href = "https://unpkg.com/prismjs@1.20.0/themes/prism-okaidia.css" rel = "stylesheet" >
2024-04-04 15:56:27 +00:00
< link rel = "stylesheet" href = "https://cdnjs.cloudflare.com/ajax/libs/Primer/19.1.1/tooltips.min.css" crossorigin = "anonymous" referrerpolicy = "no-referrer" >
2024-04-04 01:23:24 +00:00
< style >
html {
padding: 0;
margin: 0;
}
body{
font-family: "Helvetica Neue", Helvetica, Arial, sans-serif;
padding: 0;
margin: 0;
}
footer{
width: 100%;
height: 32px;
font-size: 12px;
display: flex;
flex-direction: row;
justify-content: center;
gap: 18px;
align-items: center;
color: #5d5d5d;
background: #e9eaeb;
border-top: 1px solid #c4c5c6;
}
#cookiesManager{
cursor: pointer;
color: #485fc7;
}
.page-content {
display: flex;
flex-direction: row;
margin: 0;
padding: 0;
overflow: scroll;
padding: 0;
margin: 0;
}
header {
background-color: lightgrey;
height: 2%;
padding: 10px;
}
nav {
padding: 1em;
min-width: 200px;
}
main {
flex: 1;
padding: 0 5em 0 5em;
}
.logotitle {
font-size: 1.5em;
font-weight: bold;
margin: 5px;
}
.number {
all: unset;
}
.tag.token {
all: unset;
}
main ul {
list-style-type: disc;
padding-left: 30px;
margin-top: 10px;
}
h1 {
font-size: 2rem;
margin-top: 10px;
}
h2 {
font-size: 1.5rem;
margin-top: 10px;
font-weight: 500;
}
h3 {
font-size: 1rem;
margin-top: 10px;
font-weight: 500;
}
p {
margin-top: 10px;
}
2024-04-04 18:26:16 +00:00
/* Accessibility styling */
a {
color: #485fc7;
text-decoration: underline;
}
.menu-list a {
text-decoration: none;
}
.token.comment, .token.prolog, .token.doctype, .token.cdata {
color: #8093a5;
}
.token.property, .token.tag, .token.constant, .token.symbol, .token.deleted {
color: #ff36ab;
}
2024-04-04 01:23:24 +00:00
< / style >
2024-04-04 15:56:27 +00:00
< script type = "module" async = "" > import mermaid from "https://unpkg.com/mermaid@10/dist/mermaid.esm.min.mjs" ; document . addEventListener ( 'DOMContentLoaded' , mermaid . initialize ( { "loadOnSave" : true } ) ) ; < / script >
2024-04-04 01:23:24 +00:00
< script > function showTooltip ( o , e ) { o . trigger . className . includes ( "tooltipped" ) || ( o . trigger . children [ 0 ] . className = "tooltipped tooltipped-s" , o . trigger . children [ 0 ] . ariaLabel = e ) } window . addEventListener ( "load" , ( ) => { var o = new ClipboardJS ( ".code-copy" ) ; o . on ( "success" , o => showTooltip ( o , "Copied!" ) ) , o . on ( "error" , o => showTooltip ( o , "Failed..." ) ) } ) ; < / script >
2024-04-04 15:56:27 +00:00
< script async = "" src = "https://cdn.jsdelivr.net/npm/clipboard@2.0.11/dist/clipboard.min.js" > < / script >
2024-04-04 01:23:24 +00:00
< script src = "https://wcpstatic.microsoft.com/mscc/lib/v2/wcp-consent.js" type = "text/javascript" > < / script >
< script >
function onConsentChanged(categoryPreferences) {
console.log("onConsentChanged", categoryPreferences);
}
var siteConsent
function initialize(){
var currentYear = new Date().getFullYear()
document.getElementById("copyright").innerHTML = `©️ ${currentYear} Microsoft`;
window.WcpConsent & & WcpConsent.init("en-US", "cookie-banner", function (err, _siteConsent) {
if (!err) {
siteConsent = _siteConsent; //siteConsent is used to get the current consent
} else {
console.log("Error initializing WcpConsent: "+ err);
}
}, onConsentChanged, WcpConsent.themes.light);
}
addEventListener("DOMContentLoaded", initialize)
2024-04-04 21:47:03 +00:00
addEventListener("DOMContentLoaded", checkCookieManager)
function checkCookieManager(){
if(siteConsent.isConsentRequired){
document.getElementById("cookiesManager").style.display = 'block';
document.getElementById("divider").style.display = 'block';
}
else{
document.getElementById("cookiesManager").style.display = 'none';
document.getElementById("divider").style.display = 'none';
}
}
2024-04-04 01:23:24 +00:00
function manageConsent() {
if(siteConsent.isConsentRequired){
siteConsent.manageConsent();
}
}
< / script >
< / head >
< body >
< header >
< div id = "cookie-banner" > < / div >
2024-04-04 15:56:27 +00:00
< a href = "/graphrag/" > < span class = "logotitle" > GraphRAG< / span > < / a >
2024-04-04 01:23:24 +00:00
< / header >
< div class = "page-content" >
<!-- Sidebar -->
< aside class = "menu" >
< ul class = "menu-list" >
< li >
2024-04-04 15:56:27 +00:00
< a href = "/graphrag/" > Welcome< / a >
2024-04-04 01:23:24 +00:00
< / li >
<!-- Get Started Links -->
< li >
2024-04-04 17:11:09 +00:00
< a href = "/graphrag/posts/get_started/" > Get Started< / a >
2024-04-04 01:23:24 +00:00
2024-04-04 17:11:09 +00:00
< a href = "/graphrag/posts/developing/" > Developing< / a >
2024-04-04 01:23:24 +00:00
< / li >
<!-- Indexing Links -->
< li >
2024-04-04 17:11:09 +00:00
< a href = "/graphrag/posts/index/overview/" > Indexing< / a >
2024-04-04 01:23:24 +00:00
< ul > < li >
2024-04-04 17:11:09 +00:00
< a href = "/graphrag/posts/index/0-architecture/" > Architecture< / a >
2024-04-04 01:23:24 +00:00
< / li > < li >
2024-04-04 17:11:09 +00:00
< a href = "/graphrag/posts/index/1-default_dataflow/" > Dataflow< / a >
2024-04-04 16:18:40 +00:00
< / li > < li >
2024-04-04 17:11:09 +00:00
< a href = "/graphrag/posts/index/2-cli/" > CLI< / a >
2024-04-04 01:23:24 +00:00
< / li > < li >
2024-04-04 19:46:42 +00:00
< a href = "/graphrag/posts/index/3-prompt_tuning/" > Prompt Tuning< / a >
< / li > < li >
2024-04-04 01:23:24 +00:00
2024-04-04 17:11:09 +00:00
< a href = "/graphrag/posts/index/workflows/overview/" > Workflows< / a >
2024-04-04 01:23:24 +00:00
2024-04-04 15:56:27 +00:00
< ul hidden = "" > < li >
2024-04-04 17:11:09 +00:00
< a href = "/graphrag/posts/index/workflows/create_base_documents/" > create_base_documents< / a >
2024-04-04 01:23:24 +00:00
< / li > < li >
2024-04-04 17:52:55 +00:00
< a href = "/graphrag/posts/index/workflows/create_base_entity_graph/" > create_base_entity_graph< / a >
2024-04-04 01:23:24 +00:00
< / li > < li >
2024-04-04 17:11:09 +00:00
< a href = "/graphrag/posts/index/workflows/create_base_extracted_entities/" > create_base_extracted_entities< / a >
2024-04-04 04:23:38 +00:00
< / li > < li >
2024-04-04 17:11:09 +00:00
< a href = "/graphrag/posts/index/workflows/create_base_text_units/" > create_base_text_units< / a >
2024-04-04 16:33:38 +00:00
< / li > < li >
2024-04-04 17:52:55 +00:00
< a href = "/graphrag/posts/index/workflows/create_final_communities/" > create_final_communities< / a >
2024-04-04 01:38:33 +00:00
< / li > < li >
2024-04-04 17:52:55 +00:00
< a href = "/graphrag/posts/index/workflows/create_final_community_reports/" > create_final_community_reports< / a >
2024-04-04 16:33:38 +00:00
< / li > < li >
2024-04-04 18:26:16 +00:00
< a href = "/graphrag/posts/index/workflows/create_final_covariates/" > create_final_covariates< / a >
< / li > < li >
2024-04-04 17:52:55 +00:00
< a href = "/graphrag/posts/index/workflows/create_final_documents/" > create_final_documents< / a >
2024-04-04 16:33:38 +00:00
< / li > < li >
2024-04-04 18:26:16 +00:00
< a href = "/graphrag/posts/index/workflows/create_final_entities/" > create_final_entities< / a >
< / li > < li >
< a href = "/graphrag/posts/index/workflows/create_final_nodes/" > create_final_nodes< / a >
< / li > < li >
2024-04-04 17:52:55 +00:00
< a href = "/graphrag/posts/index/workflows/create_final_relationships/" > create_final_relationships< / a >
2024-04-04 16:33:38 +00:00
< / li > < li >
2024-04-04 18:26:16 +00:00
< a href = "/graphrag/posts/index/workflows/create_final_text_units/" > create_final_text_units< / a >
< / li > < li >
2024-04-04 17:52:55 +00:00
< a href = "/graphrag/posts/index/workflows/create_summarized_entities/" > create_summarized_entities< / a >
2024-04-04 01:23:24 +00:00
< / li > < / ul >
< / li >
< li >
2024-04-04 17:11:09 +00:00
< a href = "/graphrag/posts/index/verbs/overview/" > Verbs< / a >
2024-04-04 01:23:24 +00:00
2024-04-04 15:56:27 +00:00
< ul hidden = "" > < li >
2024-04-04 18:26:16 +00:00
< a href = "/graphrag/posts/index/verbs/aggregate/" > aggregate< / a >
2024-04-04 04:10:45 +00:00
< / li > < li >
2024-04-04 18:26:16 +00:00
< a href = "/graphrag/posts/index/verbs/chunk/" > chunk< / a >
2024-04-04 01:23:24 +00:00
< / li > < li >
2024-04-04 18:26:16 +00:00
< a href = "/graphrag/posts/index/verbs/cluster_graph/" > cluster_graph< / a >
2024-04-04 01:23:24 +00:00
< / li > < li >
2024-04-04 17:11:09 +00:00
< a href = "/graphrag/posts/index/verbs/concat/" > concat< / a >
2024-04-04 16:33:38 +00:00
< / li > < li >
2024-04-04 18:26:16 +00:00
< a href = "/graphrag/posts/index/verbs/create_graph/" > create_graph< / a >
2024-04-04 04:23:38 +00:00
< / li > < li >
2024-04-04 18:26:16 +00:00
< a href = "/graphrag/posts/index/verbs/genid/" > genid< / a >
2024-04-04 16:18:40 +00:00
< / li > < li >
2024-04-04 18:26:16 +00:00
< a href = "/graphrag/posts/index/verbs/layout_graph/" > layout_graph< / a >
2024-04-04 17:52:55 +00:00
< / li > < li >
2024-04-04 18:26:16 +00:00
< a href = "/graphrag/posts/index/verbs/merge/" > merge< / a >
2024-04-04 17:52:55 +00:00
< / li > < li >
2024-04-04 18:26:16 +00:00
< a href = "/graphrag/posts/index/verbs/merge_graphs/" > merge_graphs< / a >
< / li > < li >
< a href = "/graphrag/posts/index/verbs/spread_json/" > spread_json< / a >
2024-04-04 16:33:38 +00:00
< / li > < li >
2024-04-04 17:52:55 +00:00
< a href = "/graphrag/posts/index/verbs/text_replace/" > text_replace< / a >
< / li > < li >
2024-04-04 18:26:16 +00:00
< a href = "/graphrag/posts/index/verbs/text_split/" > text_split< / a >
2024-04-04 04:23:38 +00:00
< / li > < li >
2024-04-04 17:11:09 +00:00
< a href = "/graphrag/posts/index/verbs/unpack_graph/" > unpack_graph< / a >
2024-04-04 02:27:06 +00:00
< / li > < li >
2024-04-04 18:26:16 +00:00
< a href = "/graphrag/posts/index/verbs/unzip/" > unzip< / a >
2024-04-04 16:33:38 +00:00
< / li > < li >
2024-04-04 18:26:16 +00:00
< a href = "/graphrag/posts/index/verbs/zip/" > zip< / a >
2024-04-04 01:23:24 +00:00
< / li > < / ul >
< / li >
< li >
2024-04-04 17:11:09 +00:00
< a href = "/graphrag/posts/config/overview/" > Configuration< / a >
2024-04-04 01:23:24 +00:00
< ul >
< li >
2024-04-04 17:11:09 +00:00
< a href = "/graphrag/posts/config/env_vars" > Using Env Vars< / a >
2024-04-04 01:23:24 +00:00
< / li >
< li >
2024-04-04 17:11:09 +00:00
< a href = "/graphrag/posts/config/json_yaml" > Using JSON or YAML< / a >
2024-04-04 01:23:24 +00:00
< / li >
< li >
2024-04-04 17:11:09 +00:00
< a href = "/graphrag/posts/config/custom" > Fully Custom< / a >
2024-04-04 01:23:24 +00:00
< / li >
< / ul >
< / li >
< / ul >
< / li >
<!-- Query Links -->
< li >
2024-04-04 17:11:09 +00:00
< a href = "/graphrag/posts/query/overview/" > Query< / a >
2024-04-04 01:23:24 +00:00
< ul > < li >
2024-04-04 17:11:09 +00:00
< a href = "/graphrag/posts/query/0-global_search/" > Global Search< / a >
2024-04-04 01:23:24 +00:00
< / li > < li >
2024-04-04 17:11:09 +00:00
< a href = "/graphrag/posts/query/1-local_search/" > Local Search< / a >
2024-04-04 01:23:24 +00:00
< / li > < li >
2024-04-04 17:11:09 +00:00
< a href = "/graphrag/posts/query/2-question_generation/" > Question Generation< / a >
2024-04-04 01:23:24 +00:00
< / li > < li >
2024-04-04 17:11:09 +00:00
< a href = "/graphrag/posts/query/3-cli/" class = "is-active" aria-current = "page" > CLI< / a >
2024-04-04 01:23:24 +00:00
< / li > < li >
2024-04-04 17:11:09 +00:00
< a href = "/graphrag/posts/query/notebooks/overview/" > Notebooks< / a >
2024-04-04 01:23:24 +00:00
< ul >
< li >
2024-04-04 17:11:09 +00:00
< a href = "/graphrag/posts/query/notebooks/global_search_nb" > Global Search< / a >
2024-04-04 01:23:24 +00:00
< / li >
< li >
2024-04-04 17:11:09 +00:00
< a href = "/graphrag/posts/query/notebooks/local_search_nb" > Local Search< / a >
2024-04-04 01:23:24 +00:00
< / li >
< / ul >
< / li >
< / ul >
< / li >
< / ul >
< / aside >
<!-- Main Content -->
< main >
< h1 > Query CLI< / h1 >
< p > The GraphRAG query CLI allows for no-code usage of the GraphRAG Query engine.< / p >
< div style = "position: relative" >
< pre class = "language-bash" > < code id = "code-3" class = "language-bash" > python < span class = "token parameter variable" > -m< / span > graphrag.query < span class = "token parameter variable" > --data< / span > < span class = "token operator" > < < / span > path-to-data< span class = "token operator" > >< / span > < span class = "token parameter variable" > --community_level< / span > < span class = "token operator" > < < / span > comunit-level< span class = "token operator" > >< / span > < span class = "token parameter variable" > --response_type< / span > < span class = "token operator" > < < / span > response-type< span class = "token operator" > >< / span > < span class = "token parameter variable" > --method< / span > < span class = "token operator" > < < / span > < span class = "token string" > "local"< / span > < span class = "token operator" > |< / span > < span class = "token string" > "global"< / span > < span class = "token operator" > >< / span > < span class = "token operator" > < < / span > query< span class = "token operator" > >< / span > < / code > < / pre >
2024-04-04 15:56:27 +00:00
< button class = "code-copy " data-clipboard-target = "#code-3" style = "position: absolute; top: 7.5px; right: 6px; padding-top: 3px; cursor: pointer; outline: none; opacity: 0.8;" title = "Copy" >
2024-04-04 01:23:24 +00:00
< 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 >
< h2 > CLI Arguments< / h2 >
< ul >
< li > < code > --data < path-to-data> < / code > - Folder containing the < code > .parquet< / code > output files from running the Indexer.< / li >
< li > < code > --community_level < community-level> < / code > - Community level in the Leiden community hierarchy from which we will load the community reports higher value means we use reports on smaller communities. Default: 2< / li >
< li > < code > --response_type < response-type> < / code > - Free form text describing the response type and format, can be anything, e.g. < code > Multiple Paragraphs< / code > , < code > Single Paragraph< / code > , < code > Single Sentence< / code > , < code > List of 3-7 Points< / code > , < code > Single Page< / code > , < code > Multi-Page Report< / code > . Default: < code > Multiple Paragraphs< / code > .< / li >
< li > < code > --method < " local" |" global" > < / code > - Method to use to answer the query, one of local or global. For more information check < a href = "overview.md" > Overview< / a > < / li >
< / ul >
< h2 > Env Variables< / h2 >
< p > Required environment variables to execute:< / p >
< 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_EMBEDDING_MODEL< / code > - Model to use for Embeddings.< / li >
< / ul >
< p > You can further customize the execution by providing these environment variables:< / p >
< ul >
< li > < code > GRAPHRAG_LLM_API_BASE< / code > - The API Base URL. Default: < code > None< / code > < / li >
< li > < code > GRAPHRAG_LLM_TYPE< / code > - The LLM operation type. Either < code > openai_chat< / code > or < code > azure_openai_chat< / code > . Default: < code > openai_chat< / code > < / li >
< li > < code > GRAPHRAG_LLM_MAX_RETRIES< / code > - The maximum number of retries to attempt when a request fails. Default: < code > 20< / code > < / li >
< li > < code > GRAPHRAG_EMBEDDING_API_BASE< / code > - The API Base URL. Default: < code > None< / code > < / li >
< li > < code > GRAPHRAG_EMBEDDING_TYPE< / code > - The embedding client to use. Either < code > openai_embedding< / code > or < code > azure_openai_embedding< / code > . Default: < code > openai_embedding< / code > < / li >
< li > < code > GRAPHRAG_EMBEDDING_MAX_RETRIES< / code > - The maximum number of retries to attempt when a request fails. Default: < code > 20< / code > < / li >
< li > < code > TEXT_UNIT_PROP< / code > - Proportion of context window dedicated to related text units. Default: < code > 0.5< / code > < / li >
< li > < code > COMMUNITY_PROP< / code > - Proportion of context window dedicated to community reports. Default: < code > 0.1< / code > < / li >
< li > < code > CONVERSATION_HISTORY_MAX_TURNS< / code > - Maximum number of turns to include in the conversation history. Default: < code > 5< / code > < / li >
< li > < code > TOP_K_MAPPED_ENTITIES< / code > - Number of related entities to retrieve from the entity description embedding store. Default: < code > 10< / code > < / li >
< li > < code > TOP_K_RELATIONSHIPS< / code > - Control the number of out-of-network relationships to pull into the context window. Default: < code > 10< / code > < / li >
< li > < code > LOCAL_CONTEXT_MAX_TOKENS< / code > - Change this based on the token limit you have on your model (if you are using a model with 8k limit, a good setting could be 5000). Default: < code > 12000< / code > < / li >
< li > < code > GRAPHRAG_LLM_MAX_TOKENS< / code > - Change this based on the token limit you have on your model (if you are using a model with 8k limit, a good setting could be 1000=1500). Default: < code > 2000< / code > < / li >
< li > < code > CONTEXT_BUILDER_MAX_TOKENS< / code > - Change this based on the token limit you have on your model (if you are using a model with 8k limit, a good setting could be 5000). Default: < code > 12000< / code > < / li >
< li > < code > MAP_LLM_MAX_TOKENS< / code > - Default: < code > 500< / code > < / li >
< li > < code > REDUCE_LLM_MAX_TOKENS< / code > - Change this based on the token limit you have on your model (if you are using a model with 8k limit, a good setting could be 1000-1500). Default: < code > 2000< / code > < / li >
< li > < code > SEARCH_ENGINE_MAX_TOKENS< / code > - Change this based on the token limit you have on your model (if you are using a model with 8k limit, a good setting could be 5000). Default: < code > 12000< / code > < / li >
< li > < code > SEARCH_ENGINE_CONCURRENCY< / code > - Default: < code > 32< / code > < / li >
< / ul >
< / main >
< / div >
< footer >
< a href = "https://go.microsoft.com/fwlink/?LinkId=521839" > Privacy< / a >
|
< a href = "https://go.microsoft.com/fwlink/?LinkId=2259814" > Consumer Health Privacy< / a >
|
< span id = "cookiesManager" onClick = "manageConsent();" > Cookies< / span >
2024-04-04 21:47:03 +00:00
< span id = "divider" > |< / span >
2024-04-04 01:23:24 +00:00
< a href = "https://go.microsoft.com/fwlink/?LinkID=206977" > Terms of Use< / a >
|
< a href = "https://www.microsoft.com/trademarks" > Trademarks< / a >
|
< a href = "https://www.microsoft.com" id = "copyright" > < / a >
|
< a href = "https://github.com/microsoft/graphrag" > GitHub< / a >
< / footer >
< / body >
< / html >
