GraphRAG init 命令深度解析一条命令生成可运行的配置工作区【免费下载链接】graphragA modular graph-based Retrieval-Augmented Generation (RAG) system项目地址: https://gitcode.com/GitHub_Trending/gr/graphragGraphRAG 的所有后续操作索引、查询、Prompt 调优都依赖一个初始化工作区而graphrag init就是创建该工作区的起点。本篇基于官方文档 init 配置说明 与 CLI 源码实现完整讲解init命令的参数、生成的settings.yaml/.env/prompts/各文件的结构与默认值以及初始化过程在源码中的具体执行逻辑帮助你从零搭建一个可直接运行索引管线的 GraphRAG 项目。init 命令的角色与定位GraphRAG 的配置体系要求项目根目录下存在settings.yaml核心配置与.env环境变量两类文件并通过 YAML 中引用的prompts/目录加载各阶段的 LLM 提示词。手动编写这些文件容易遗漏必需字段因此项目提供了init子命令它在指定目录生成.env与settings.yaml并输出 GraphRAG 使用的全部默认 LLM 提示词文件。这是官方推荐的启动方式——在 配置总览 中Default Configuration Mode 明确将 Init command 列为建议的第一步之后的深度定制则通过编辑settings.yaml完成详见 YAML 配置详解。命令用法与参数文档给出的基本用法为graphrag init [--root PATH] [--force, --no-force]文档定义的参数如下参数说明--root PATH要初始化 GraphRAG 的项目根目录默认是当前目录--force,--no-force可选默认为--no-force。若配置与提示词文件已存在则覆盖它们从源码 CLI 入口 看init由 typer 框架定义除文档中列出的两个参数外当前版本还提供了两个可选参数且所有参数均带短选项--root/-r项目根目录仅允许目录dir_okayTrue、要求可写并做了路径解析与目录自动补全--model/-m默认 chat 模型缺省值为gpt-4.1定义于 defaults.py--embedding/-e默认 embedding 模型缺省值为text-embedding-3-largedefaults.py--force/-f布尔开关默认为False。也就是说即使不传任何参数直接执行graphrag init也会以当前目录为根、以gpt-4.1和text-embedding-3-largeopenaiprovider生成一份开箱即用的配置。初始化示例文档给出的标准示例graphrag init --root ./ragtest执行后./ragtest即成为一个完整的 GraphRAG 工作区。若需指定模型可组合使用graphrag init --root ./ragtest --model gpt-4o --embedding text-embedding-3-smallinit 生成的文件与目录文档说明init会在目标目录创建以下内容settings.yaml—— 配置设置文件包含 GraphRAG 的运行配置.env—— 环境变量文件其中的变量被settings.yaml引用prompts/—— LLM 提示词文件夹包含 GraphRAG 使用的默认提示词你可以直接修改它们或运行 Auto Prompt Tuning 命令生成适配你数据的提示词。从源码 initialize.py 的实现看实际还会额外创建与配置中input_storage.base_dir一致的输入目录默认为input/用于存放待索引的原始文档。settings.yaml生成内容的完整结构settings.yaml的模板定义在 init_content.py 的INIT_YAML中生成时会把其中的DEFAULT_COMPLETION_MODEL与DEFAULT_EMBEDDING_MODEL占位符替换为命令行传入或默认的模型名。其结构可分为五大板块各默认值均取自 defaults.py 中集中管理的 dataclass 默认值LLM 设置completion_models/embedding_models以模型 ID 为键默认为default_completion_model/default_embedding_model配置model_provider: openai、model、auth_method: api_key注释中提示可改用 azure_managed_identityapi_key通过${GRAPHRAG_API_KEY}引用.env中的变量并默认启用exponential_backoff重试策略文档处理设置input.type默认text支持 csv、text、json、jsonlchunking默认按 token 切分type: tokens块大小size: 1200、重叠overlap: 100、编码模型o200k_base存储设置input_storage默认input/、output_storage默认output/、reporting、cache默认 json 缓存存储目录cache/与vector_store默认均为 file 类型的本地存储若改用 blob 存储则必须提供connection_string与container_name工作流设置embed_text指定 embedding 模型extract_graph绑定prompts/extract_graph.txt并定义默认实体类型[organization, person, geo, event]、max_gleanings: 1summarize_descriptions、extract_graph_nlp默认regex_english名词短语抽取器、cluster_graphmax_cluster_size: 10、extract_claims默认enabled: false、community_reportsmax_length: 2000、max_input_length: 8000以及snapshotsgraphml 与 embeddings 快照默认关闭查询设置local_search、global_search、drift_search、basic_search四种搜索方式各自绑定completion_model_id、embedding_model_id及对应提示词文件路径。文件头部注释也明确提示这份配置只包含必需的核心默认项与少量常用可选项完整参数列表请查阅 YAML 配置文档对应仓库中的 docs/config/yaml.md。.env 与 prompts/.env模板极简只有一行GRAPHRAG_API_KEYAPI_KEY需要替换为真实的 OpenAI API Key 后方可调用 LLM。prompts/目录中的 13 个提示词文件与其对应功能的映射关系在 initialize.py 的prompts字典中逐项写明可直接对照源码查看索引阶段extract_graph.txt实体/关系抽取、summarize_descriptions.txt实体描述聚合、extract_claims.txtclaim 抽取、community_report_graph.txt与community_report_text.txt社区报告分别基于图结构与纯文本查询阶段local_search_system_prompt.txt、global_search_map_system_prompt.txt、global_search_reduce_system_prompt.txt、global_search_knowledge_system_prompt.txt、drift_search_system_prompt.txt、drift_reduce_prompt.txt、basic_search_system_prompt.txt、question_gen_system_prompt.txt。这些文件与settings.yaml中各工作流/查询节引用的prompt路径一一对应因此修改提示词后无需改动配置即可生效。初始化过程的源码逻辑init命令的完整执行链为typer 子命令_initialize_cli解析参数后调用 initialize_project_at。其关键行为可以归纳为四点目录创建对--root路径做resolve()后mkdir(parentsTrue)目录不存在会自动递归创建防误覆盖校验若目标目录已存在settings.yaml且未指定--force直接抛出ValueError(Project already initialized at {root})——这与文档中默认--no-force的语义一致避免静默覆盖已有配置模型占位符替换写入settings.yaml前用str.replace而非str.format替换模型占位符源码注释解释了原因模板中还存在${GRAPHRAG_API_KEY}这类花括号占位符需要在后续.env叠加阶段保留差异化的覆盖策略.env仅在不存在或forceTrue时写入各prompts/*.txt文件同样遵循不存在或 force 才写的规则而settings.yaml在 force 模式下会被整体重写。这意味着已存在的.env不会被默认初始化动作冲掉——你此前填入的 API Key 是安全的。后续步骤完成初始化后按文档给出的路径有两条推荐路线对应 Next Steps 章节将待索引文档放入工作区input/目录运行 自动提示词调优graphrag prompt-tune让 LLM 基于你的数据生成实体类型、示例等定制化提示词输出默认仍写入prompts/目录直接启动 索引管线graphrag index使用默认提示词对数据建图与建索引。需要更细粒度的控制如更换模型 provider、切换 blob/cosmosdb 存储、调整各工作流参数时则回到settings.yaml逐项修改全部可配置项见 YAML 配置参考。【免费下载链接】graphragA modular graph-based Retrieval-Augmented Generation (RAG) system项目地址: https://gitcode.com/GitHub_Trending/gr/graphrag创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考 GraphRAG init 命令深度解析：一条命令生成可运行的配置工作区
GraphRAG init 命令深度解析一条命令生成可运行的配置工作区【免费下载链接】graphragA modular graph-based Retrieval-Augmented Generation (RAG) system项目地址: https://gitcode.com/GitHub_Trending/gr/graphragGraphRAG 的所有后续操作索引、查询、Prompt 调优都依赖一个初始化工作区而graphrag init就是创建该工作区的起点。本篇基于官方文档 init 配置说明 与 CLI 源码实现完整讲解init命令的参数、生成的settings.yaml/.env/prompts/各文件的结构与默认值以及初始化过程在源码中的具体执行逻辑帮助你从零搭建一个可直接运行索引管线的 GraphRAG 项目。init 命令的角色与定位GraphRAG 的配置体系要求项目根目录下存在settings.yaml核心配置与.env环境变量两类文件并通过 YAML 中引用的prompts/目录加载各阶段的 LLM 提示词。手动编写这些文件容易遗漏必需字段因此项目提供了init子命令它在指定目录生成.env与settings.yaml并输出 GraphRAG 使用的全部默认 LLM 提示词文件。这是官方推荐的启动方式——在 配置总览 中Default Configuration Mode 明确将 Init command 列为建议的第一步之后的深度定制则通过编辑settings.yaml完成详见 YAML 配置详解。命令用法与参数文档给出的基本用法为graphrag init [--root PATH] [--force, --no-force]文档定义的参数如下参数说明--root PATH要初始化 GraphRAG 的项目根目录默认是当前目录--force,--no-force可选默认为--no-force。若配置与提示词文件已存在则覆盖它们从源码 CLI 入口 看init由 typer 框架定义除文档中列出的两个参数外当前版本还提供了两个可选参数且所有参数均带短选项--root/-r项目根目录仅允许目录dir_okayTrue、要求可写并做了路径解析与目录自动补全--model/-m默认 chat 模型缺省值为gpt-4.1定义于 defaults.py--embedding/-e默认 embedding 模型缺省值为text-embedding-3-largedefaults.py--force/-f布尔开关默认为False。也就是说即使不传任何参数直接执行graphrag init也会以当前目录为根、以gpt-4.1和text-embedding-3-largeopenaiprovider生成一份开箱即用的配置。初始化示例文档给出的标准示例graphrag init --root ./ragtest执行后./ragtest即成为一个完整的 GraphRAG 工作区。若需指定模型可组合使用graphrag init --root ./ragtest --model gpt-4o --embedding text-embedding-3-smallinit 生成的文件与目录文档说明init会在目标目录创建以下内容settings.yaml—— 配置设置文件包含 GraphRAG 的运行配置.env—— 环境变量文件其中的变量被settings.yaml引用prompts/—— LLM 提示词文件夹包含 GraphRAG 使用的默认提示词你可以直接修改它们或运行 Auto Prompt Tuning 命令生成适配你数据的提示词。从源码 initialize.py 的实现看实际还会额外创建与配置中input_storage.base_dir一致的输入目录默认为input/用于存放待索引的原始文档。settings.yaml生成内容的完整结构settings.yaml的模板定义在 init_content.py 的INIT_YAML中生成时会把其中的DEFAULT_COMPLETION_MODEL与DEFAULT_EMBEDDING_MODEL占位符替换为命令行传入或默认的模型名。其结构可分为五大板块各默认值均取自 defaults.py 中集中管理的 dataclass 默认值LLM 设置completion_models/embedding_models以模型 ID 为键默认为default_completion_model/default_embedding_model配置model_provider: openai、model、auth_method: api_key注释中提示可改用 azure_managed_identityapi_key通过${GRAPHRAG_API_KEY}引用.env中的变量并默认启用exponential_backoff重试策略文档处理设置input.type默认text支持 csv、text、json、jsonlchunking默认按 token 切分type: tokens块大小size: 1200、重叠overlap: 100、编码模型o200k_base存储设置input_storage默认input/、output_storage默认output/、reporting、cache默认 json 缓存存储目录cache/与vector_store默认均为 file 类型的本地存储若改用 blob 存储则必须提供connection_string与container_name工作流设置embed_text指定 embedding 模型extract_graph绑定prompts/extract_graph.txt并定义默认实体类型[organization, person, geo, event]、max_gleanings: 1summarize_descriptions、extract_graph_nlp默认regex_english名词短语抽取器、cluster_graphmax_cluster_size: 10、extract_claims默认enabled: false、community_reportsmax_length: 2000、max_input_length: 8000以及snapshotsgraphml 与 embeddings 快照默认关闭查询设置local_search、global_search、drift_search、basic_search四种搜索方式各自绑定completion_model_id、embedding_model_id及对应提示词文件路径。文件头部注释也明确提示这份配置只包含必需的核心默认项与少量常用可选项完整参数列表请查阅 YAML 配置文档对应仓库中的 docs/config/yaml.md。.env 与 prompts/.env模板极简只有一行GRAPHRAG_API_KEYAPI_KEY需要替换为真实的 OpenAI API Key 后方可调用 LLM。prompts/目录中的 13 个提示词文件与其对应功能的映射关系在 initialize.py 的prompts字典中逐项写明可直接对照源码查看索引阶段extract_graph.txt实体/关系抽取、summarize_descriptions.txt实体描述聚合、extract_claims.txtclaim 抽取、community_report_graph.txt与community_report_text.txt社区报告分别基于图结构与纯文本查询阶段local_search_system_prompt.txt、global_search_map_system_prompt.txt、global_search_reduce_system_prompt.txt、global_search_knowledge_system_prompt.txt、drift_search_system_prompt.txt、drift_reduce_prompt.txt、basic_search_system_prompt.txt、question_gen_system_prompt.txt。这些文件与settings.yaml中各工作流/查询节引用的prompt路径一一对应因此修改提示词后无需改动配置即可生效。初始化过程的源码逻辑init命令的完整执行链为typer 子命令_initialize_cli解析参数后调用 initialize_project_at。其关键行为可以归纳为四点目录创建对--root路径做resolve()后mkdir(parentsTrue)目录不存在会自动递归创建防误覆盖校验若目标目录已存在settings.yaml且未指定--force直接抛出ValueError(Project already initialized at {root})——这与文档中默认--no-force的语义一致避免静默覆盖已有配置模型占位符替换写入settings.yaml前用str.replace而非str.format替换模型占位符源码注释解释了原因模板中还存在${GRAPHRAG_API_KEY}这类花括号占位符需要在后续.env叠加阶段保留差异化的覆盖策略.env仅在不存在或forceTrue时写入各prompts/*.txt文件同样遵循不存在或 force 才写的规则而settings.yaml在 force 模式下会被整体重写。这意味着已存在的.env不会被默认初始化动作冲掉——你此前填入的 API Key 是安全的。后续步骤完成初始化后按文档给出的路径有两条推荐路线对应 Next Steps 章节将待索引文档放入工作区input/目录运行 自动提示词调优graphrag prompt-tune让 LLM 基于你的数据生成实体类型、示例等定制化提示词输出默认仍写入prompts/目录直接启动 索引管线graphrag index使用默认提示词对数据建图与建索引。需要更细粒度的控制如更换模型 provider、切换 blob/cosmosdb 存储、调整各工作流参数时则回到settings.yaml逐项修改全部可配置项见 YAML 配置参考。【免费下载链接】graphragA modular graph-based Retrieval-Augmented Generation (RAG) system项目地址: https://gitcode.com/GitHub_Trending/gr/graphrag创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考