Chat Copilot开发实战：创建自定义插件的完整指南-CSDN博客

Chat Copilot开发实战：创建自定义插件的完整指南

【免费下载链接】chat-copilot 项目地址: https://gitcode.com/gh_mirrors/ch/chat-copilot

Chat Copilot是一款强大的开源AI助手框架，通过自定义插件系统可以轻松扩展其功能。本文将带你从零开始创建自己的Chat Copilot插件，无需复杂编程知识，只需简单几步即可完成。

插件开发准备工作

在开始开发之前，请确保已完成以下准备：

克隆Chat Copilot项目代码库：

git clone https://gitcode.com/gh_mirrors/ch/chat-copilot

熟悉项目结构，插件开发主要涉及以下目录：
- plugins/ - 存放所有插件代码
- plugins/shared/ - 插件共享组件
准备开发环境：
- .NET SDK 6.0或更高版本
- 代码编辑器（推荐Visual Studio或VS Code）

插件开发核心组件解析

Chat Copilot插件系统基于OpenAI插件标准设计，主要包含三个核心组件：

1. 插件清单（PluginManifest）

插件清单是插件的元数据文件，定义了插件的基本信息。核心代码位于plugins/shared/PluginManifest.cs：

public class PluginManifest
{
    [JsonPropertyName("schema_version")]
    public string SchemaVersion { get; set; } = "v1";
    
    [JsonPropertyName("name_for_model")]
    public string NameForModel { get; set; } = string.Empty;
    
    [JsonPropertyName("name_for_human")]
    public string NameForHuman { get; set; } = string.Empty;
    
    // 其他属性...
}

关键属性说明：

NameForModel：AI模型使用的插件名称（简短，无空格）
NameForHuman：用户界面显示的插件名称
DescriptionForModel：模型理解的插件功能描述
DescriptionForHuman：用户理解的插件功能描述

2. API规范（PluginApi）

API规范定义了插件提供的接口，位于plugins/shared/PluginApi.cs：

public class PluginApi
{
    public string Type { get; set; } = "openapi";
    public string Url { get; set; } = string.Empty;
}

通常使用OpenAPI规范来描述API接口，你需要提供OpenAPI文档的URL。

3. 认证方式（PluginAuth）

认证方式定义了插件的安全访问机制，位于plugins/shared/PluginAuth.cs：

public class PluginAuth
{
    public string Type { get; set; } = "none";
    
    [JsonPropertyName("authorization_type")]
    public string AuthorizationType { get; } = "bearer";
    
    // 其他认证相关属性...
}

支持的认证类型包括：none（无认证）、service_http（服务级HTTP认证）和user_http（用户级HTTP认证）。

五步创建自定义插件

第一步：创建插件项目结构

在plugins目录下创建新的插件文件夹，推荐结构如下：

plugins/
  your-plugin-name/
    Models/          # 数据模型
    Services/        # 业务逻辑
    PluginEndpoint.cs # API端点
    Program.cs       # 插件入口
    your-plugin.csproj # 项目文件
    README.md        # 插件说明

可以参考plugins/web-searcher/目录结构作为模板。

第二步：实现API端点

创建PluginEndpoint.cs文件，定义插件的API端点：

[Function("YourPluginFunction")]
public async Task<HttpResponseData> YourPluginFunction(
    [HttpTrigger(AuthorizationLevel.Anonymous, "get", "post")] HttpRequestData req)
{
    // 实现你的插件逻辑
    var response = req.CreateResponse(HttpStatusCode.OK);
    await response.WriteAsJsonAsync(new { result = "Hello from your plugin!" });
    return response;
}

第三步：配置插件清单

在代码中创建插件清单实例：

var pluginManifest = new PluginManifest()
{
    NameForModel = "yourplugin",
    NameForHuman = "Your Custom Plugin",
    DescriptionForModel = "A plugin that provides amazing functionality",
    DescriptionForHuman = "My awesome Chat Copilot plugin",
    Api = new PluginApi { Type = "openapi", Url = "/openapi.yaml" },
    Auth = new PluginAuth { Type = "none" },
    // 其他必要属性...
};

第四步：编写OpenAPI规范

创建openapi.yaml文件，描述你的API接口：

openapi: 3.0.1
info:
  title: Your Custom Plugin
  version: 1.0.0
paths:
  /api/your-function:
    get:
      summary: Your function description
      responses:
        '200':
          description: Successful response