SqlDatabaseVectorSearch 的安装和配置教程

1. 项目基础介绍和主要编程语言

SqlDatabaseVectorSearch 是一个开源项目，它展示了如何在 Azure SQL Database 中使用原生的 VECTOR 类型来执行嵌入向量搜索和检索增强生成（RAG）功能。该项目通过集成 Azure OpenAI，允许用户加载文档、生成嵌入向量并将它们保存到数据库中。目前，该项目支持 PDF、DOCX、TXT 和 MD 文件的导入。VECTOR 类型的数据是通过 Entity Framework Core 以及 EFCore.SqlServer.VectorSearch 库进行保存和检索的。

该项目主要使用以下编程语言和框架：

• C#：用于后端逻辑和数据处理。
• HTML/CSS/JavaScript：用于前端用户界面。
• TSQL：用于与 Azure SQL Database 交互。

2. 项目使用的关键技术和框架

• Azure SQL Database：用于存储和管理数据。
• EFCore.SqlServer.VectorSearch：一个 Entity Framework Core 扩展库，支持 VECTOR 类型数据的操作。
• Azure OpenAI：提供嵌入向量生成和 RAG 功能。
• Blazor：一个用于构建客户端 Web 应用的框架。
• Semantic Kernel：集成嵌入向量和聊天完成功能。

3. 项目安装和配置的准备工作及详细安装步骤

准备工作

在开始安装之前，请确保您已经完成了以下准备工作：

• 安装了.NET Core SDK。
• 安装了 SQL Server Management Studio 或其他 SQL 管理工具。
• 创建了一个 Azure SQL Database 实例。

安装步骤

1. 克隆项目仓库

   打开命令行工具，使用以下命令克隆项目仓库：

   git clone https://github.com/marcominerva/SqlDatabaseVectorSearch.git
   

2. 安装依赖项

   在项目根目录下运行以下命令来安装所需的 NuGet 包：

   dotnet restore
   

3. 配置数据库连接

   打开 appsettings.json 文件，并设置 Azure SQL Database 的连接字符串以及其他所需的 Azure OpenAI 设置。

   {
     "ConnectionStrings": {
       "DefaultConnection": "Server=tcp:your_server.database.windows.net,1433;Database=your_database;User ID=your_username;Password=your_password;Trusted_Connection=False;Encrypt=True;Connection Timeout=30;"
     },
     // ... 其他配置
   }
   

4. 更新VECTOR列大小

   根据您的嵌入模型大小，可能需要更新数据库中VECTOR列的大小。在 SQL Server Management Studio 中执行相应的 ALTER TABLE 命令，例如：

   ALTER TABLE YourTableName
   ALTER COLUMN YourVectorColumnName VECTOR(1536);
   

5. 运行数据库迁移

   在项目根目录下运行以下命令来执行数据库迁移：

   dotnet ef migrations add InitialCreate
   dotnet ef database update
   

6. 运行项目

   运行以下命令来启动项目：

   dotnet run
   

   如果您直接使用 APIs，可以使用以下端点：

   • 导入文档：/api/documents
   • 提问：/api/ask 或 /api/ask-streaming

现在，您已经完成了 SqlDatabaseVectorSearch 的安装和配置，可以开始使用它来管理和搜索向量数据了。