微软Copilot插件开发系列（一）-Toy模板网

这篇具有很好参考价值的文章主要介绍了微软Copilot插件开发系列（一）。希望对大家有所帮助。如果存在错误或未考虑完全的地方，请大家不吝赐教，您也可以点击"举报违法"按钮提交疑问。

懂AI PC的人要先拥抱新世界了。继联想、荣耀之后，微软的首款AI PC马上也要来了。去年9月，Colpilot正式进入Windows 11，成为电脑系统的AI助手。

插件api 微软,AIGC,Copilot,microsoft,copilot,chatgpt

可以在各种场景下完成各种任务，例如发邮件、控制电脑亮度等

插件api 微软,AIGC,Copilot,microsoft,copilot,chatgpt
但是，Copilot 无法获取第三方服务的实时信息，例如最新的新闻、天气、股票等。这时，我们就可以使用 OpenAI schema 开发Copilot 插件，来扩展Copilot 的功能，让它能够与我们自己的 API 交互。本文作为该系列的第一篇，将带你初步了解下copilot的基本概念和开发示例。

什么是Copilot 插件？

通俗说就是使用 OpenAI schema 来为Copilot 添加自定义功能的方式，以此来将我们自己的应用连接到Copilot。插件可以让 Copilot获取外部信息或执行某个任务。例如，一个获取最新的新闻和天气信息的插件，或者让用户在一个待办事项列表中添加或删除项目。

那么构成插件由哪些要素呢？

运行在我们自己服务器上的 API服务，用来执行具体的任务。
遵循OpenAPI schema 的对API做了详细说明的 YAML 或 JSON 文件，例如 openapi.yaml
名为ai-plugin.json 的 JSON 文件，用来告诉Copilot 何时以及如何使用我们的插件插件api 微软,AIGC,Copilot,microsoft,copilot,chatgpt

插件三要素

那么具体起来应该怎么操作呢？下面举一个具体的栗子

一个 Copilot 插件的示例

假设我们想要开发一个插件，可以根据用户的搜索条件，例如城市、卧室数、浴室数、设施等，来找到房地产列表。我们用 http://contoso.com 作为我们API 服务。

那么第一步我么就来定义Openapi 格式的YAML文件

下面定义一个 /get-listings 的路径，以搜索条件作为参数，返回一个 JSON 格式的房地产列表。


openapi: 3.0.0
info:
  title: Contoso Real Estate API
  version: 1.0.0
paths:
  /get-listings:
    get:
      summary: 根据搜索条件获取房地产列表
      parameters:
        - name: city
          in: query
          description: 要搜索的城市
          required: true
          schema:
            type: string
        - name: bedrooms
          in: query
          description: 卧室数量
          required: false
          schema:
            type: integer
        - name: bathrooms
          in: query
          description: 浴室数量
          required: false
          schema:
            type: integer
        - name: amenities
          in: query
          description: 需要包含的设施
          required: false
          schema:
            type: array
            items:
              type: string
      responses:
        '200':
          description: 房地产列表
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      type: string
                      description: 房地产的唯一标识符
                    address:
                      type: string
                      description: 房地产的地址
                    price:
                      type: number
                      description: 房地产的价格
                    image_url:
                      type: string
                      description: 房地产图片的 URL
                    description:
                      type: string
                      description: 房地产的描述

第二步来定义ai-plugin.json，用来告诉Copilot 何时以及如何使用我们的插件，如下所示：

{
  "schema_version": "v1",[^1^][1]
  "name_for_model": "contosorealestate",[^2^][2]
  "description_for_model": "根据搜索条件在市场上找到待售的房地产的插件",
  "name_for_human": "Contoso 房地产",[^3^][3]
  "description_for_human": "在市场上找到最新和详细的待售房地产",
  "api": {[^4^][4]
    "type": "openapi",[^5^][5]
    "url": "https://contoso.com/openapi.yaml",[^6^][6]
    "is_user_authenticated": false[^8^][8]
  },
  "auth": {[^9^][9]
    "type": "none"[^10^][10]
  },
  "logo_url": "https://contoso.com/logo.png",[^11^][11]
  "contact_email": "contact@contoso.com",[^13^][13]
  "legal_info_url": "https://contoso.com/legal/",[^12^][12]
  "privacy_url": "https://contoso.com/privacy-policy"[^7^][7]
}

以上都准备妥当之后，下一步是啥呢？那就要走软件开发标准流程-测试了。