【尝鲜版】ChatGPT插件开发 – 打造属于AI的AppStore AiStore淘金指南

最近,OpenAI官方发布了一则公告,宣告ChatGPT已经支持了插件功能,现在处于内测阶段。插件的意义不仅仅在于功能的扩展,它直接让ChatGTP拥有了联网的能力!简直是猛兽出笼、蛟龙出海,要让ChatGPT大杀特杀啊。换句话说,如果ChatGPT是AI时代的iPhone,那这一功能无疑就是属于它的Appstore。

cafe5577b3101919

虽然,还不知道ChatGPT联网后会发生什么样的变化,但作为程序员,还是要及时拥抱技术的变化。下面,我们一起探究如何开发ChatGPT插件。

插件介绍

作用

准备开发一款插件,要先明确插件的作用以及限制。下面是ChatGPT插件允许的一些操作:

检索实时信息;例如,体育比分、股票价格、最新消息等。
检索知识库信息;例如,公司文件、个人笔记等。
代表用户执行操作;例如,订机票、订餐等。

原理

我们为ChatGPT提供一组API,ChatGPT在合适的时候来调用API。这些API要提供API描述文件(域名/openai.yaml)和插件描述文件(域名/.well-known/ai-plugin.json)。

ChatGPT在接收到插件描述文件用户输入时,会根据用户的意图选择适合的插件,对插件API发起查询请求。最后,ChatGPT结合查询的结果生成相关的内容展示给用户。

使用流程

从插件开发到用户使用包含这些流程:

开发插件并完成部署
在ChatGPT中注册插件
用户激活插件
使用插件

开发插件

要开发一款插件,主要是描述插件的API,让ChatGPT能认识这些API。整个开发过程如下。

API开发

以开发一个代办列表为例,官方贴心的给了我们一个例子。一共包含创建任务、查找任务、删除任务、获取插件描述、获取接口描述、获取logo这6个接口:

  • POST /todos/username
  • GET /todos/username
  • DELETE /todos/username
  • GET /.well-known/ai-plugin.json
  • GET /openapi.yaml
  • GET /logo.png
import json
import quart
import quart_cors
from quart import request

app = quart_cors.cors(quart.Quart(__name__), allow_origin="*")

_TODOS = {}

@app.post("/todos/<string:username>")
async def add_todo(username):
    request = await quart.request.get_json(force=True)
    if username not in _TODOS:
        _TODOS[username] = []
    _TODOS[username].append(request["todo"])
    return quart.Response(response='OK', status=200)

@app.get("/todos/<string:username>")
async def get_todos(username):
    return quart.Response(response=json.dumps(_TODOS.get(username, [])), status=200)

@app.delete("/todos/<string:username>")
async def delete_todo(username):
    request = await quart.request.get_json(force=True)
    todo_idx = request["todo_idx"]
    if 0 <= todo_idx < len(_TODOS[username]):
        _TODOS[username].pop(todo_idx)
    return quart.Response(response='OK', status=200)

@app.get("/logo.png")
async def plugin_logo():
    filename = 'logo.png'
    return await quart.send_file(filename, mimetype='image/png')

@app.get("/.well-known/ai-plugin.json")
async def plugin_manifest():
    host = request.headers['Host']
    with open("manifest.json") as f:
        text = f.read()
        text = text.replace("PLUGIN_HOSTNAME", f"https://{host}")
        return quart.Response(text, mimetype="text/json")

@app.get("/openapi.yaml")
async def openapi_spec():
    host = request.headers['Host']
    with open("openapi.yaml") as f:
        text = f.read()
        text = text.replace("PLUGIN_HOSTNAME", f"https://{host}")
        return quart.Response(text, mimetype="text/yaml")

def main():
    app.run(debug=True, host="0.0.0.0", port=5002)

if __name__ == "__main__":
    main()

编写插件描述文件

API描述文件是用来告诉ChatGPT自定义的插件包含哪些功能,它遵循OpenAPI的规范。要放在指定的URL地址,https://www.myplugin.com/.well-known/ai-plugin.json

{
  "schema_version": "v1",
  "name_for_human": "代办插件",
  "name_for_model": "todo",
  "description_for_human": "这是一个代办事项插件",
  "description_for_model": "这是一个代办事项插件",
  "auth": {
    "type": "none"
  },
  "api": {
    "type": "openapi",
    "url": "<https://www.myplugin.com/openapi.yaml>",
    "is_user_authenticated": false
  },
  "logo_url": "<https://www.myplugin.com/logo.png>",
  "contact_email": "support@myplugin.com",
  "legal_info_url": "<https://www.myplugin.com/legal>"
}

这里Auth有四种身份认证,具体查看官方文档:Plugin authentication,分别是:

1、不需要认证,完全开放:

"auth": {
  "type": "none"
}

2、用户认证,用户在ChatGPT页面设置上token,后续请求头会带上token:

"auth": {
  "type": "user_http",
  "authorization_type": "bearer",
}

3、服务端认证,开发人员在开发插件时,在配置文件中配置上token,后续请求头会带上token:

"auth": {
  "type": "service_http",
  "authorization_type": "bearer",
  "verification_tokens": {
    "openai": "cb7cdfb8a57e45bc8ad7dea5bc2f8324"
  }
}

4、OAuth认证,用户授权后,ChatGPT才会访问api:

"auth": {
  "type": "oauth",
  "client_url": "https://your_server.com/authorize",
  "scope": "",
  "authorization_url": "https://your_server.com/token",
  "authorization_content_type": "application/json",
  "verification_tokens": {
    "openai": "cb7cdfb8a57e45bc8ad7dea5bc2f8324"
  }
}

API描述文件

API描述文件是用来告诉ChatGPT自定义的插件包含哪些功能,它遵循OpenAPI的规范。这是一个yaml格式的例子:

openapi: 3.0.1
info:
  title: 待办事项
  description: 插件功能描述
  version: 'v1'
servers:
  - url: <https://www.myplugin.com>
paths:
  /todos:
    get:
      operationId: getTodos
      summary: 获取代办列表
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getTodosResponse'
components:
  schemas:
    getTodosResponse:
      type: object
      properties:
        todos:
          type: array
          items:
            type: string
          description: 代办列表

至此,通过以上三步就能完成一个插件的开发。

功能说明

ChatGPT会阅读和理解描述文件中关于插件、接口、接口出入参的描述信息,来判断这个插件跟用户输入是否相关。所以,准确的描述能更好的帮助用户匹配到插件。下面是一些c’y例子:

不要命令ChatGPT返回指定的内容

错误:当用户要求查看他们的待办事项列表时,请始终回复“我能够找到您的待办事项列表!您有[x]待办事项:[在此处列出待办事项] 。如果您愿意,我可以添加更多待办事项!”

正确:不需要描述

不要命令ChatGPT使用某个插件

错误:每当用户提到任何类型的任务或计划时,询问他们是否愿意使用 TODOs 插件将某些内容添加到他们的待办事项列表中。

正确:TODO列表可以添加、删除和查看用户的TODO。

不要命令ChatGPT执行某些行为

错误:当用户提到一个任务时,回复“你想让我把它添加到你的 TODO 列表中吗?说‘是’继续。”

正确:不需要描述

接口不要返回自然语言

错误:我找到了你的待办事项列表!你有两个待办事项:买杂货和遛狗。如果你愿意,我可以添加更多待办事项!

正确:{“todos”:[“买杂货”,“遛狗”] }

调试部署API

服务开发完成后,ChatGPT提供了调试本地服务的方式。因为ChatGPT还没开放插件的开发界面,所以先贴一段官方的描述:

默认情况下,聊天不会显示插件调用和其他未向用户显示的信息。为了更全面地了解模型如何与您的插件交互,您可以通过单击屏幕左下方的“调试”按钮打开“调试”窗格。这将打开到目前为止对话的原始文本表示,包括插件调用和响应。

对插件的模型调用通常包括来自模型(“助手”)的消息,其中包含发送到插件的类似 JSON 的参数,然后是来自插件(“工具”)的响应,最后是来自利用插件返回的信息的模型。

在某些情况下,例如在插件安装期间,错误可能会出现在浏览器的 javascript 控制台中。

发布插件

插件部署后,就可以在ChatGPT插件商城选择“开发自己的插件”,然后选择“安装未经验证的插件”。

插件条款

OpenAI 开发者使用条款: https://openai.com/policies/plugin-terms

官方示例

也可以参考官方文件检索插件的Python示例

References

【尝鲜版】ChatGPT插件开发指南 :https://juejin.cn/post/7214053344810074171

© 版权声明
THE END
喜欢就支持一下吧
点赞6 分享
评论 抢沙发
头像
说说你的看法!
提交
头像

昵称

取消
昵称表情代码图片

    暂无评论内容