Ben.SemanticKernel 5.2.16

Ben.SemanticKernel

一个基于 Microsoft Semantic Kernel 的强大 .NET 库，旨在简化 AI 能力的集成和使用，为企业级应用提供完整的 AI 解决方案。

✨ 核心特性

🤖 多模型支持

• OpenAI 兼容服务: OpenAI、DeepSeek、Grok、SiliconCloud
• 本地模型: Ollama 支持
• 云服务: Azure OpenAI、阿里云百炼

💬 智能对话系统

• 流式和非流式对话支持
• 对话缓存机制，提升响应速度
• 支持推理模型（o1、o3）的思维链展示
• 联网搜索增强（支持多搜索引擎）

📚 知识管理

• 向量数据库: Qdrant、PostgreSQL (pgvector)、SQLite
• 文档处理: 支持多种格式文档解析和分块
• 语义搜索: 高效的向量检索和重排序

🕸️ 知识图谱

• Neo4j 集成
• 社区检索和关系检索
• 图谱生成和查询优化

🔧 开发友好

• 完整的依赖注入支持
• 弹性策略（重试、超时、熔断）
• 后台任务队列
• Text2SQL 工具

📦 安装

NuGet 包管理器

Install-Package Ben.SemanticKernel

.NET CLI

dotnet add package Ben.SemanticKernel

PackageReference

<PackageReference Include="Ben.SemanticKernel" Version="5.2.11" />

🚀 快速开始

1. 配置文件设置

在 appsettings.json 中添加配置：

{
  "BEN_SK": {
    "AIConfig": {
      "TextInfo": {
        "ApiKey": "your-api-key",
        "Model": "gpt-4",
        "BaseUri": "https://api.openai.com/v1",
        "Provider": "openai"
      },
      "EmbeddingInfo": {
        "ApiKey": "your-api-key",
        "Model": "text-embedding-3-small",
        "BaseUri": "https://api.openai.com/v1",
        "Provider": "openai",
        "KmsPoint": "http://localhost:6333",
        "VertorType": "qdrant",
        "VectorSize": 1536,
        "Index": "default"
      },
      "CachDays": 7
    },
    "BackgroundQueue": {
      "MaxConcurrentTasks": 5,
      "RetryCount": 3,
      "TaskTimeout": "00:10:00"
    }
  }
}

2. 注册服务

在 Program.cs 中注册服务：

using Ben.SemanticKernel.Services;

var builder = WebApplication.CreateBuilder(args);

// 注册所有 Ben.SemanticKernel 服务
builder.Services.AddBenSKAllService(builder.Configuration);

// 或者选择性注册特定服务
// builder.Services.AddBenSKGlobalService(builder.Configuration);
// builder.Services.AddChatService(builder.Configuration);

var app = builder.Build();
app.Run();

3. 使用聊天服务

using Ben.SemanticKernel.Services.ChatService;
using Microsoft.SemanticKernel.ChatCompletion;

public class ChatController : ControllerBase
{
    private readonly ChatService _chatService;
    private readonly IOptions<AIOptions> _aiOptions;

    public ChatController(ChatService chatService, IOptions<AIOptions> aiOptions)
    {
        _chatService = chatService;
        _aiOptions = aiOptions;
    }

    // 流式对话
    [HttpPost("stream")]
    public async IAsyncEnumerable<string> StreamChat([FromBody] string message)
    {
        var history = new List<ChatMessageContent>();
        
        await foreach (var chunk in _chatService.ChatAsync(
            message,
            "你是一个友好的AI助手",
            _aiOptions.Value,
            history))
        {
            yield return chunk;
        }
    }

    // 非流式对话
    [HttpPost("chat")]
    public async Task<string> Chat([FromBody] string message)
    {
        var history = new List<ChatMessageContent>();
        
        var result = await _chatService.Chat(
            message,
            "你是一个友好的AI助手",
            _aiOptions.Value,
            history);
        
        return result;
    }
}

4. 知识库对话

using Ben.SemanticKernel.Services.TextMemory;
using Microsoft.SemanticKernel;

public class KnowledgeController : ControllerBase
{
    private readonly ImportKmsService _importService;
    private readonly ChatService _chatService;
    private readonly IOptions<AIOptions> _aiOptions;

    // 导入文档到知识库
    [HttpPost("import")]
    public async Task<IActionResult> ImportDocument(IFormFile file)
    {
        var tempPath = Path.GetTempFileName();
        await using (var stream = new FileStream(tempPath, FileMode.Create))
        {
            await file.CopyToAsync(stream);
        }

        await _importService.ImportFromFileAsync(
            tempPath,
            _aiOptions.Value,
            file.FileName);

        return Ok("导入成功");
    }

    // 基于知识库的对话
    [HttpPost("ask")]
    public async IAsyncEnumerable<string> AskWithKnowledge([FromBody] AskRequest request)
    {
        // 从知识库检索相关文档
        var documents = await _chatService.getMemoryDocument(
            request.Question,
            _aiOptions.Value,
            index: "my-index");

        // 构建提示词
        var prompt = $@"基于以下文档回答问题：

文档内容：
{documents}

问题：{{{{$input}}}}

请基于文档内容给出准确的回答。如果文档中没有相关信息，请明确说明。";

        var arguments = new KernelArguments
        {
            ["input"] = request.Question
        };

        // 流式返回答案
        await foreach (var chunk in _chatService.KmsChatCompletionAsync(
            request.Question,
            _aiOptions.Value,
            prompt,
            arguments))
        {
            yield return chunk;
        }
    }
}

public record AskRequest(string Question);

5. 联网搜索增强对话

// 启用联网搜索的对话
[HttpPost("search-chat")]
public async IAsyncEnumerable<string> SearchChat([FromBody] string message)
{
    var history = new List<ChatMessageContent>();
    
    await foreach (var chunk in _chatService.ChatAsync(
        message,
        "你是一个能够搜索互联网的AI助手",
        _aiOptions.Value,
        history,
        netWork: true,  // 启用联网搜索
        engine: "smart"))  // 使用智能多引擎搜索
    {
        yield return chunk;
    }
}

📖 高级用法

配置多种 AI 提供商

DeepSeek

{
  "TextInfo": {
    "ApiKey": "sk-xxx",
    "Model": "deepseek-chat",
    "BaseUri": "https://api.deepseek.com",
    "Provider": "deepseek"
  }
}

Ollama（本地模型）

{
  "TextInfo": {
    "ApiKey": "not-needed",
    "Model": "qwen2.5:7b",
    "BaseUri": "http://localhost:11434",
    "Provider": "ollama"
  },
  "EmbeddingInfo": {
    "ApiKey": "not-needed",
    "Model": "nomic-embed-text",
    "BaseUri": "http://localhost:11434",
    "Provider": "ollama"
  }
}

Azure OpenAI

{
  "TextInfo": {
    "ApiKey": "your-azure-key",
    "Model": "gpt-4",
    "BaseUri": "https://your-resource.openai.azure.com",
    "Provider": "azure"
  }
}

使用 PostgreSQL 作为向量数据库

{
  "EmbeddingInfo": {
    "KmsPoint": "Host=localhost;Port=5432;Database=vectors;Username=postgres;Password=password",
    "VertorType": "pgsql",
    "VectorSize": 1536
  }
}

对话缓存

// 使用缓存提升响应速度
var cacheList = new List<ChatCacheDto>
{
    new ChatCacheDto
    {
        Question = "什么是AI？",
        Answer = "人工智能（AI）是...",
        QuestionEmbedding = "...",
        ExpiresAt = DateTime.UtcNow.AddDays(7)
    }
};

await foreach (var chunk in _chatService.KmsChatCompletionAsync(
    input: "什么是人工智能？",
    aiOptions: _aiOptions.Value,
    prompt: myPrompt,
    arguments: args,
    EnableCache: true,  // 启用缓存
    SimilarityThreshold: 0.9f,  // 相似度阈值
    chatCacheDtos: cacheList))
{
    // 如果缓存命中，将直接返回缓存的答案
    yield return chunk;
}

🏗️ 项目架构

Ben.SemanticKernel/
├── AI/                          # AI 核心功能
│   ├── KernelFactory.cs        # Kernel 工厂
│   ├── MemoryKernelFactory.cs  # Memory Kernel 工厂
│   └── HttpClientHandlerFactory.cs
├── Models/                      # 数据模型
│   ├── AIOptions.cs            # AI 配置
│   ├── ChatCache.cs            # 缓存模型
│   └── Tools/                  # 工具模型
├── Services/                    # 业务服务
│   ├── ChatService/            # 聊天服务
│   ├── TextMemory/             # 文本记忆
│   ├── KnowledgeGraph/         # 知识图谱
│   ├── DocumentParsing/        # 文档解析
│   └── Tools/                  # 工具服务
├── Plugins/                     # SK 插件
│   ├── graph/                  # 图谱插件
│   └── tools/                  # 工具插件
└── Utils/                       # 工具类

🔌 主要依赖

• Microsoft.SemanticKernel (1.54.0) - 核心框架
• Microsoft.KernelMemory.Core (0.98.x) - 内存管理
• Microsoft.SemanticKernel.Connectors.Qdrant - Qdrant 连接器
• Microsoft.SemanticKernel.Connectors.PgVector - PostgreSQL 连接器
• Microsoft.Playwright - Web 自动化（联网搜索）
• Polly - 弹性和瞬态故障处理

📝 配置说明

文本模型配置 (TextInfo)

嵌入模型配置 (EmbeddingInfo)

🤝 贡献指南

欢迎提交 Pull Request 或提出 Issue！

1. Fork 本仓库
2. 创建特性分支 (git checkout -b feature/AmazingFeature)
3. 提交更改 (git commit -m 'Add some AmazingFeature')
4. 推送到分支 (git push origin feature/AmazingFeature)
5. 开启 Pull Request

📄 许可证

本项目采用 MIT 许可证 - 详见 LICENSE 文件

🔗 相关资源

• Microsoft Semantic Kernel 文档
• 项目结构文档
• 联网搜索功能指南
• 多引擎搜索配置

📧 联系方式

• 作者：benbena
• 邮箱：[您的邮箱]
• 项目主页：[GitHub 链接]

🌟 Star History

如果这个项目对你有帮助，请给一个 ⭐️ Star！