GraphRag.Net 项目使用与配置指南

GraphRag.Net 项目使用与配置指南

GraphRag.Net 参考GraphRag使用 Semantic Kernel 来实现的dotnet版本，可以使用NuGet开箱即用集成到项目中 项目地址: https://gitcode.com/gh_mirrors/gr/GraphRag.Net

1. 项目的目录结构及介绍

GraphRag.Net 是一个基于 .NET 的开源项目，主要实现了图表示文本的生成和理解。以下是项目的目录结构及其简单介绍：

• doc/：存放项目文档。
• src/：包含项目的主要源代码。
  • GraphRag.Net.sln：项目的解决方案文件。
  • GraphRag.Net.Web/：Web 项目，提供 API 接口和 Blazor UI。
• .github/：GitHub 工作流和模板。
• .gitignore：指定 Git 忽略的文件和目录。
• LICENSE：项目许可证文件。
• README.md：项目说明文件。

2. 项目的启动文件介绍

项目的启动主要通过 GraphRag.Net.Web 目录下的 Program.cs 文件进行。以下是该文件的主要功能：

• 设置和配置应用程序的服务和中间件。
• 使用 WebHostBuilder 类来创建和配置 Web 主机环境。
• 启动 Web 服务器。

public class Program
{
    public static void Main(string[] args)
    {
        CreateWebHostBuilder(args).Build().Run();
    }

    public static IWebHostBuilder CreateWebHostBuilder(string[] args) =>
        WebHost.CreateDefaultBuilder(args)
            .ConfigureWebHostDefaults(webBuilder =>
            {
                webBuilder.UseStartup<Startup>();
            });
}

3. 项目的配置文件介绍

项目的配置主要通过 appsettings.json 文件进行。以下是该文件中的主要配置项：

• GraphOpenAI：配置 OpenAI 的 API 密钥和端点等信息。
• TextChunker：配置文本分割的相关参数，如行数和段落数。
• GraphDBConnection：配置数据库连接信息，包括数据库类型和连接字符串。
• GraphSearch：配置图搜索的相关参数，如最小相关性、搜索限制、节点深度等。
• GraphSys：系统相关配置，如重试次数。

{
  "GraphOpenAI": {
    "Key": "sk-xxx",
    "EndPoint": "https://api.antsk.cn/",
    "ChatModel": "gpt-4o-mini",
    "EmbeddingModel": "text-embedding-ada-002"
  },
  "TextChunker": {
    "LinesToken": 100,
    "ParagraphsToken": 1000
  },
  "GraphDBConnection": {
    "DbType": "Sqlite",
    "DBConnection": "Data Source=graph.db",
    "VectorConnection": "graphmem.db",
    "VectorSize": 1536
  },
  "GraphSearch": {
    "SearchMinRelevance": 0.5,
    "SearchLimit": 3,
    "NodeDepth": 3,
    "MaxNodes": 100
  },
  "GraphSys": {
    "RetryCounnt": 2
  }
}

以上是 GraphRag.Net 项目的目录结构、启动文件和配置文件的简单介绍。在实际使用过程中，需要根据具体需求进行调整和配置。

GraphRag.Net 参考GraphRag使用 Semantic Kernel 来实现的dotnet版本，可以使用NuGet开箱即用集成到项目中 项目地址: https://gitcode.com/gh_mirrors/gr/GraphRag.Net