默认配置模式（使用YAML/JSON）

默认配置模式可以通过在数据项目根目录中使用settings.yml或settings.json文件进行配置。如果同时存在.env文件，则会加载该文件，其中定义的环境变量将可用于配置文档中的令牌替换，使用${ENV_VAR}语法。默认情况下，graphrag init会使用YML初始化，但您也可以选择使用等效的JSON格式。

许多配置值都有默认值。与其在此处重复这些值，请直接参考代码中的常量。

例如：

# .env
GRAPHRAG_API_KEY=some_api_key

# settings.yml
llm: 
  api_key: ${GRAPHRAG_API_KEY}

配置部分

语言模型设置

models

这是一个模型配置的字典。字典键用于在需要模型实例时在其他地方引用此配置。通过这种方式，您可以指定任意数量的不同模型，并在工作流程步骤中差异化地引用它们。

例如：

models:
  default_chat_model:
    api_key: ${GRAPHRAG_API_KEY}
    type: openai_chat
    model: gpt-4o
    model_supports_json: true
  default_embedding_model:
    api_key: ${GRAPHRAG_API_KEY}
    type: openai_embedding
    model: text-embedding-ada-002

字段

api_key str - 使用的OpenAI API密钥。
auth_type api_key|managed_identity - 指示您希望如何进行请求认证。
type openai_chat|azure_openai_chat|openai_embedding|azure_openai_embedding|mock_chat|mock_embeddings - 使用的LLM类型。
model str - 模型名称。
encoding_model str - 使用的文本编码模型。默认为使用与语言模型对齐的编码模型（即如果未设置，则从tiktoken检索）。
api_base str - 使用的API基础URL。
api_version str - API版本。
deployment_name str - 使用的部署名称（Azure）。
organization str - 客户组织。
proxy str - 使用的代理URL。
audience str - （仅限Azure OpenAI）请求托管身份令牌的目标Azure资源/服务的URI。如果未定义api_key则使用。默认=https://cognitiveservices.azure.com/.default
model_supports_json bool - 模型是否支持JSON模式输出。
request_timeout float - 每个请求的超时时间。
tokens_per_minute int - 设置每分钟令牌数的漏桶限制。
requests_per_minute int - 设置每分钟请求数的漏桶限制。
retry_strategy str - 使用的重试策略，"native"是默认值，使用OpenAI SDK内置的策略。其他允许值包括"exponential_backoff"、"random_wait"和"incremental_wait"。
max_retries int - 使用的最大重试次数。
max_retry_wait float - 最大回退时间。
concurrent_requests int 允许的并发请求数。
async_mode asyncio|threaded 使用的异步模式。可以是asyncio或threaded。
responses list[str] - 如果此模型类型为mock，则这是要返回的响应字符串列表。
n int - 要生成的完成数。
max_tokens int - 最大输出令牌数。不适用于o系列模型。
temperature float - 使用的温度值。不适用于o系列模型。
top_p float - 使用的top-p值。不适用于o系列模型。
frequency_penalty float - 令牌生成的频率惩罚。不适用于o系列模型。
presence_penalty float - 令牌生成的频率惩罚。不适用于o系列模型。
max_completion_tokens int - 聊天完成消耗的最大令牌数。必须足够大以包含模型"推理"的未知数量。仅限o系列模型。
reasoning_effort low|medium|high - 模型用于推理响应的"思考"量。仅限o系列模型。

输入文件和分块

input

我们的pipeline可以从输入文件夹中摄取.csv、.txt或.json数据。有关更多详细信息和示例，请参阅输入页面。

字段

type file|blob - 使用的输入类型。默认=file
file_type text|csv|json - 要加载的输入数据类型。默认为text
base_dir str - 相对于根目录的读取输入的基础目录。
connection_string str - （仅限blob）Azure存储连接字符串。
storage_account_blob_url str - 使用的存储账户blob URL。
container_name str - （仅限blob）Azure存储容器名称。
encoding str - 输入文件的编码。默认为utf-8
file_pattern str - 匹配输入文件的正则表达式。根据指定的file_type默认为.*\.csv$、.*\.txt$或.*\.json$，但您可以根据需要进行自定义。
file_filter dict - 用于过滤的键/值对。默认为None。
text_column str - （仅限CSV/JSON）文本列名称。如果未设置，我们期望有一个名为text的列。
title_column str - （仅限CSV/JSON）标题列名称，如果未设置将使用文件名。
metadata list[str] - （仅限CSV/JSON）要保留的附加文档属性字段。

chunks

这些设置配置了我们如何将文档解析为文本块。这是必要的，因为非常大的文档可能不适合单个上下文窗口，并且可以调整图提取的准确性。另请注意输入文档配置中的metadata设置，该设置会将文档元数据复制到每个块中。

字段

size int - 以令牌为单位的最大块大小。
overlap int - 以令牌为单位的块重叠。
group_by_columns list[str] - 在分块前按这些字段分组文档。
strategy str[tokens|sentences] - 如何分块文本。
encoding_model str - 用于在令牌边界上拆分的文本编码模型。
prepend_metadata bool - 确定是否应在每个块的开头添加元数据值。默认=False。
chunk_size_includes_metadata bool - 指定块大小计算是否应包括元数据令牌。默认=False。

输出和存储

output

此部分控制pipeline用于导出输出表的存储机制。

字段

type file|memory|blob|cosmosdb - 使用的存储类型。默认=file
base_dir str - 相对于根目录的写入输出工件的基础目录。
connection_string str - （仅限blob/cosmosdb）Azure存储连接字符串。
container_name str - （仅限blob/cosmosdb）Azure存储容器名称。
storage_account_blob_url str - （仅限blob）使用的存储账户blob URL。
cosmosdb_account_blob_url str - （仅限cosmosdb）使用的CosmosDB账户blob URL。

update_index_output

该部分定义了用于运行增量索引的辅助存储位置，以保留您的原始输出。

字段

type file|memory|blob|cosmosdb - 使用的存储类型。默认=file
base_dir str - 相对于根目录的写入输出工件的基础目录。
connection_string str - （仅限blob/cosmosdb）Azure存储连接字符串。
container_name str - （仅限blob/cosmosdb）Azure存储容器名称。
storage_account_blob_url str - （仅限blob）使用的存储账户blob URL。
cosmosdb_account_blob_url str - （仅限cosmosdb）使用的CosmosDB账户blob URL。

cache

此部分控制pipeline使用的缓存机制。这用于缓存LLM调用结果，以便在重新运行索引过程时获得更快的性能。

字段

type file|memory|blob|cosmosdb - 使用的存储类型。默认=file
base_dir str - 相对于根目录的写入输出工件的基础目录。
connection_string str - （仅限blob/cosmosdb）Azure存储连接字符串。
container_name str - （仅限blob/cosmosdb）Azure存储容器名称。
storage_account_blob_url str - （仅限blob）使用的存储账户blob URL。
cosmosdb_account_blob_url str - （仅限cosmosdb）使用的CosmosDB账户blob URL。

reporting

此部分控制pipeline用于常见事件和错误消息的报告机制。默认是将报告写入输出目录中的文件。但是，您也可以选择将报告写入控制台或Azure Blob Storage容器。

字段

type file|console|blob - 使用的报告类型。默认=file
base_dir str - 相对于根目录的写入报告的基础目录。
connection_string str - （仅限blob）Azure存储连接字符串。
container_name str - （仅限blob）Azure存储容器名称。
storage_account_blob_url str - 使用的存储账户blob URL。

vector_store

放置系统所有向量的位置。默认配置为lancedb。这是一个字典，键用于标识各个存储参数（例如，用于文本嵌入）。

字段

type lancedb|azure_ai_search|cosmosdb - 向量存储类型。默认=lancedb
db_uri str （仅限lancedb） - 数据库uri。默认=storage.base_dir/lancedb
url str （仅限AI Search） - AI Search端点
api_key str （可选 - 仅限AI Search） - 使用的AI Search api密钥。
audience str （仅限AI Search） - 如果使用托管身份认证，则为请求托管身份令牌的目标Azure资源/服务的URI。
container_name str - 向量容器的名称。这存储给定数据集摄取的所有索引（表）。默认=default
database_name str - （仅限cosmosdb）数据库名称。
overwrite bool （仅在索引创建时使用） - 如果集合存在则覆盖。默认=True

工作流配置

这些设置控制每个单独工作流的执行过程。

workflows

list[str] - 这是要按顺序运行的工作流名称列表。GraphRAG有内置的pipeline来配置这个，但您可以通过在此处指定列表来精确且仅运行您想要的内容。如果您已经自己完成了部分处理，这将非常有用。

embed_text

默认情况下，GraphRAG索引器只会导出我们的查询方法所需的嵌入。但是，模型为所有纯文本字段定义了嵌入，这些嵌入可以通过设置target和names字段进行自定义。

支持的嵌入名称包括：

text_unit.text
document.text
entity.title
entity.description
relationship.description
community.title
community.summary
community.full_content

字段

model_id str - 用于文本嵌入的模型定义名称。
vector_store_id str - 要写入的向量存储定义名称。
batch_size int - 使用的最大批次大小。
batch_max_tokens int - 批次的最大令牌数。
names list[str] - 要运行的嵌入名称列表（必须在支持的列表中）。

extract_graph

调整基于语言模型的图提取过程。

字段

model_id str - 用于API调用的模型定义名称。
prompt str - 使用的提示文件。
entity_types list[str] - 要识别的实体类型。
max_gleanings int - 使用的最大收集周期数。

summarize_descriptions

字段

model_id str - 用于API调用的模型定义名称。
prompt str - 使用的提示文件。
max_length int - 每个摘要的最大输出令牌数。
max_input_length int - 为摘要收集的最大令牌数（这将限制您为给定实体或关系发送的摘要描述数量）。

extract_graph_nlp

定义基于NLP的图提取方法的设置。

字段

normalize_edge_weights bool - 在图构建过程中是否规范化边权重。默认=True。
text_analyzer dict - NLP模型的参数。
extractor_type regex_english|syntactic_parser|cfg - 默认=regex_english。
model_name str - NLP模型名称（基于SpaCy的模型）
max_word_length int - 允许的最长单词。默认=15。
word_delimiter str - 分割单词的分隔符。默认' '。
include_named_entities bool - 是否在名词短语中包含命名实体。默认=True。
exclude_nouns list[str] | None - 要排除的名词列表。如果为None，我们使用内部停用词列表。
exclude_entity_tags list[str] - 要忽略的实体标签列表。
exclude_pos_tags list[str] - 要忽略的词性标签列表。
noun_phrase_tags list[str] - 名词短语要忽略的标签列表。
noun_phrase_grammars dict[str, str] - 模型的名词短语语法（仅限cfg）。

prune_graph

手动图剪枝的参数。这可用于通过移除过度连接或稀有节点来优化图簇的模块性。

字段

min_node_freq int - 允许的最小节点频率。
max_node_freq_std float | None - 允许的节点频率最大标准差。
min_node_degree int - 允许的最小节点度数。
max_node_degree_std float | None - 允许的节点度数最大标准差。
min_edge_weight_pct float - 允许的最小边权重百分比。
remove_ego_nodes bool - 移除自我节点。
lcc_only bool - 仅使用最大连通分量。

cluster_graph

这些是用于Leiden层次聚类以创建社区的设置。

字段

max_cluster_size int - 要导出的最大簇大小。
use_lcc bool - 是否仅使用最大连通分量。
seed int - 如果需要一致的运行结果，则提供随机种子。我们确实提供了一个默认值以保证聚类稳定性。

extract_claims

字段

enabled bool - 是否启用声明提取。默认关闭，因为声明提示确实需要用户调整。
model_id str - 用于API调用的模型定义名称。
prompt str - 使用的提示文件。
description str - 描述我们要提取的声明类型。
max_gleanings int - 使用的最大收集周期数。

community_reports

字段

model_id str - 用于API调用的模型定义名称。
prompt str - 使用的提示文件。
max_length int - 每个报告的最大输出令牌数。
max_input_length int - 生成报告时使用的最大输入令牌数。

embed_graph

我们使用node2vec来嵌入图。这主要用于可视化，因此默认情况下未启用。

字段

enabled bool - 是否启用图嵌入。
dimensions int - 生成的向量维度数。
num_walks int - node2vec的游走次数。
walk_length int - node2vec的游走长度。
window_size int - node2vec的窗口大小。
iterations int - node2vec的迭代次数。
random_seed int - node2vec的随机种子。
strategy dict - 完全覆盖嵌入图策略。

umap

指示我们是否应该运行UMAP降维。这用于为每个图节点提供适合可视化的x/y坐标。如果未启用，节点将获得0/0的x/y坐标。如果启用，您必须同时启用图嵌入。

字段

enabled bool - 是否启用UMAP布局。

snapshots

字段

embeddings bool - 将嵌入快照导出到parquet。
graphml bool - 将图快照导出到GraphML。

查询

local_search

字段

chat_model_id str - 用于聊天完成调用的模型定义名称。
`embedding_model_idstr - 用于嵌入调用的模型定义名称。
prompt str - 使用的提示文件。
text_unit_prop float - 文本单元比例。
community_prop float - 社区比例。
conversation_history_max_turns int - 对话历史最大轮数。
top_k_entities int - 映射的顶级实体数。
top_k_relationships int - 映射的顶级关系数。
max_context_tokens int - 构建请求上下文使用的最大令牌数。

global_search

字段

chat_model_id str - 用于聊天完成调用的模型定义名称。
map_prompt str - 使用的映射器提示文件。
reduce_prompt str - 使用的归约器提示文件。
knowledge_prompt str - 使用的知识提示文件。
map_prompt str | None - 使用的全局搜索映射器提示。
reduce_prompt str | None - 使用的全局搜索归约器。
knowledge_prompt str | None - 使用的全局搜索通用提示。
max_context_tokens int - 创建的上下文最大大小（以令牌计）。
data_max_tokens int - 从归约响应构建最终响应使用的最大令牌数。
map_max_length int - 映射响应的最大请求长度（以单词计）。
reduce_max_length int - 归约响应的最大请求长度（以单词计）。
dynamic_search_threshold int - 包含社区报告的评分阈值。
dynamic_search_keep_parent bool - 如果任何子社区相关，则保留父社区。
dynamic_search_num_repeats int - 对同一社区报告进行评分的次数。
dynamic_search_use_summary bool - 使用社区摘要而非full_context。
dynamic_search_max_level int - 如果处理的社区都不相关，则考虑社区层次结构的最大级别。

drift_search

字段

chat_model_id str - 用于聊天完成调用的模型定义名称。
embedding_model_id str - 用于嵌入调用的模型定义名称。
prompt str - 使用的提示文件。
reduce_prompt str - 使用的归约器提示文件。
data_max_tokens int - 数据LLM的最大令牌数。
reduce_max_tokens int - 归约阶段的最大令牌数。仅适用于非o系列模型。
reduce_max_completion_tokens int - 归约阶段的最大令牌数。仅适用于o系列模型。
concurrency int - 并发请求数。
drift_k_followups int - 要检索的顶级全局结果数。
primer_folds int - 搜索引导的折叠数。
primer_llm_max_tokens int - 引导中LLM的最大令牌数。
n_depth int - 要进行的漂移搜索步骤数。
local_search_text_unit_prop float - 专用于文本单元的搜索比例。
local_search_community_prop float - 专用于社区属性的搜索比例。
local_search_top_k_mapped_entities int - 本地搜索期间要映射的顶级实体数。
local_search_top_k_relationships int - 本地搜索期间要映射的顶级关系数。
local_search_max_data_tokens int - 本地搜索的上下文最大大小（以令牌计）。
local_search_temperature float - 本地搜索中令牌生成使用的温度值。
local_search_top_p float - 本地搜索中令牌生成使用的top-p值。
local_search_n int - 本地搜索中生成的完成数。
local_search_llm_max_gen_tokens int - 本地搜索中LLM生成的最大令牌数。仅适用于非o系列模型。
local_search_llm_max_gen_completion_tokens int - 本地搜索中LLM生成的最大令牌数。仅适用于o系列模型。

basic_search

字段

chat_model_id str - 用于聊天完成调用的模型定义名称。
embedding_model_id str - 用于嵌入调用的模型定义名称。
prompt str - 使用的提示文件。
k int | None - 从向量存储检索用于构建上下文的文本单元数。