microsoft--graphrag/README.md

<!-- WEHUB_ZH_README -->
> [!NOTE]
> 本文档由 WeHub 基于上游 README 翻译整理，属于社区翻译，非官方中文文档。  
> [English](./README.en.md) · [原始项目](https://github.com/microsoft/graphrag) · [上游 README](https://github.com/microsoft/graphrag/blob/HEAD/README.md)  
> 原作者、版权与许可证归属以原始项目及本仓库 LICENSE 文件为准。

# GraphRAG

👉 [Microsoft Research 博客文章](https://www.microsoft.com/en-us/research/blog/graphrag-unlocking-llm-discovery-on-narrative-private-data/)<br/>
👉 [阅读文档](https://microsoft.github.io/graphrag)<br/>
👉 [GraphRAG Arxiv](https://arxiv.org/pdf/2404.16130)

<div align="left">
  <a href="https://pypi.org/project/graphrag/">
    <img alt="PyPI - Version" src="https://img.shields.io/pypi/v/graphrag">
  </a>
  <a href="https://pypi.org/project/graphrag/">
    <img alt="PyPI - Downloads" src="https://img.shields.io/pypi/dm/graphrag">
  </a>
  <a href="https://github.com/microsoft/graphrag/issues">
    <img alt="GitHub Issues" src="https://img.shields.io/github/issues/microsoft/graphrag">
  </a>
  <a href="https://github.com/microsoft/graphrag/discussions">
    <img alt="GitHub Discussions" src="https://img.shields.io/github/discussions/microsoft/graphrag">
  </a>
</div>

## 概览

GraphRAG 项目是一套数据流水线（data pipeline）与转换工具套件，旨在借助大语言模型（LLM）的能力，从非结构化文本中提取有意义、结构化的数据。

要了解更多关于 GraphRAG 的信息，以及它如何用于增强 LLM 对私有数据的推理能力，请访问 <a href="https://www.microsoft.com/en-us/research/blog/graphrag-unlocking-llm-discovery-on-narrative-private-data/" target="_blank">Microsoft Research 博客文章。</a>

## 快速入门

要开始使用 GraphRAG 系统，我们建议你尝试[命令行快速入门](https://microsoft.github.io/graphrag/get_started/).

## 仓库指南

本仓库介绍了一种利用知识图谱（knowledge graph）记忆结构来增强 LLM 输出的方法。请注意，所提供的代码仅作演示用途，并非 Microsoft 官方支持的产品。

⚠️ *警告：GraphRAG 索引可能是一项开销较大的操作，请阅读全部文档以了解相关流程与成本，并从小规模开始。*

## 深入了解

- 要了解我们的贡献指南，请参阅 [CONTRIBUTING.md](./CONTRIBUTING.md)
- 要开始开发 _GraphRAG_，请参阅 [DEVELOPING.md](./DEVELOPING.md)
- 欢迎在 [GitHub Discussions 版块！](https://github.com/microsoft/graphrag/discussions) 加入讨论并提供反馈

## 提示词调优（Prompt Tuning）

开箱即用地将 _GraphRAG_ 用于你的数据，可能无法获得最佳效果。
我们强烈建议你按照文档中的 [提示词调优指南](https://microsoft.github.io/graphrag/prompt_tuning/overview/) 对提示词进行微调。

## 版本管理

请参阅[破坏性变更](./breaking-changes.md)文档，了解我们对项目版本管理的做法说明。

*在次要版本（minor version）升级之间，请始终运行 `graphrag init --root [path] --force`，以确保使用最新的配置格式。若要在主要版本（major version）升级时避免重新索引先前数据集，请运行提供的迁移 notebook。注意，这将覆盖你的配置与提示词，如有需要请先备份。*

## 负责任的 AI 常见问题

请参阅 [RAI_TRANSPARENCY.md](./RAI_TRANSPARENCY.md)

- [什么是 GraphRAG？](./RAI_TRANSPARENCY.md#what-is-graphrag)
- [GraphRAG 能做什么？](./RAI_TRANSPARENCY.md#what-can-graphrag-do)
- [GraphRAG 的预期用途是什么？](./RAI_TRANSPARENCY.md#what-are-graphrags-intended-uses)
- [GraphRAG 是如何评估的？使用哪些指标来衡量性能？](./RAI_TRANSPARENCY.md#how-was-graphrag-evaluated-what-metrics-are-used-to-measure-performance)
- [GraphRAG 有哪些局限性？用户在使用系统时如何尽可能降低这些局限性的影响？](./RAI_TRANSPARENCY.md#what-are-the-limitations-of-graphrag-how-can-users-minimize-the-impact-of-graphrags-limitations-when-using-the-system)
- [哪些运营因素和设置有助于有效且负责任地使用 GraphRAG？](./RAI_TRANSPARENCY.md#what-operational-factors-and-settings-allow-for-effective-and-responsible-use-of-graphrag)

## 商标

本项目可能包含项目、产品或服务的商标或标识。Microsoft
商标或标识的授权使用须遵守并遵循
[Microsoft 商标与品牌指南](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks/usage/general).
在本项目的修改版本中使用 Microsoft 商标或标识，不得造成混淆或暗示 Microsoft 的赞助。
任何第三方商标或标识的使用均须遵守相应第三方的政策。

## 隐私

[Microsoft 隐私声明](https://privacy.microsoft.com/en-us/privacystatement)