待办事项列表（无认证） - ChatGPT聊天插件案例

这是一个关于如何构建一个简单的待办事项列表插件（不需要身份验证）的教程。

学习如何构建一个简单的待办事项列表插件，不需要身份验证。

首先，查看无身份验证页面，然后定义一个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": "PLUGIN_HOSTNAME/openapi.yaml" 
   }, 
   "logo_url": "PLUGIN_HOSTNAME/logo.png", 
   "contact_email": "support@example.com", 
   "legal_info_url": "https://example.com/legal" 
}

注意：PLUGIN_HOSTNAME应该是您插件服务器的实际主机名。

接下来，我们可以定义API端点，为特定用户创建、删除和获取待办事项列表。

import json

import quart 
import quart_cors 
from quart import request

# Note: Setting CORS to allow chat.openapi.com is only required when running a localhost plugin 
app = quart_cors.cors(quart.Quart(__name__), allow_origin="https://chat.openai.com")

_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("ai-plugin.json") as f: 
       text = f.read() 
       # This is a trick we do to populate the PLUGIN_HOSTNAME constant in the manifest 
       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() 
       # This is a trick we do to populate the PLUGIN_HOSTNAME constant in the OpenAPI spec 
       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()

最后，我们需要设置并定义一个OpenAPI规范，以匹配我们在本地或远程服务器上定义的端点。您不需要通过规范公开API的全部功能，而可以选择只让ChatGPT访问某些功能。

还有许多工具可以自动将您的服务器定义代码转换为OpenAPI规范，因此您不需要手动进行。对于上面的Python代码，OpenAPI规范看起来是这样的：

openapi: 3.0.1 
info: 
   title: TODO Plugin 
   description: A plugin that allows the user to create and manage a TODO list using ChatGPT. If you do not know the user's username, ask them first before making queries to the plugin. Otherwise, use the username "global". 
   version: "v1" 
servers: 
   - url: PLUGIN_HOSTNAME 
paths: 
   /todos/{username}: 
       get: 
           operationId: getTodos 
           summary: Get the list of todos 
           parameters: 
               - in: path 
                 name: username 
                 schema: 
                     type: string 
                 required: true 
                 description: The name of the user. 
           responses: 
               "200": 
                   description: OK 
                   content: 
                       application/json: 
                           schema: 
                               $ref: "#/components/schemas/getTodosResponse" 
       post: 
           operationId: addTodo 
           summary: Add a todo to the list 
           parameters: 
               - in: path 
                 name: username 
                 schema: 
                     type: string 
                 required: true 
                 description: The name of the user. 
           requestBody: 
               required: true 
               content: 
                   application/json: 
                       schema: 
                           $ref: "#/components/schemas/addTodoRequest" 
           responses: 
               "200": 
                   description: OK 
       delete: 
           operationId: deleteTodo 
           summary: Delete a todo from the list 
           parameters: 
               - in: path 
                 name: username 
                 schema: 
                     type: string 
                 required: true 
                 description: The name of the user. 
           requestBody: 
               required: true 
               content: 
                   application/json: 
                       schema: 
                           $ref: "#/components/schemas/deleteTodoRequest" 
           responses: 
               "200": 
                   description: OK

components: 
   schemas: 
       getTodosResponse: 
           type: object 
           properties: 
               todos: 
                   type: array 
                   items: 
                       type: string 
                   description: The list of todos. 
       addTodoRequest: 
           type: object 
           required: 
               - todo 
           properties: 
               todo: 
                   type: string 
                   description: The todo to add to the list. 
                   required: true 
       deleteTodoRequest: 
           type: object 
           required: 
               - todo_idx 
           properties: 
               todo_idx: 
                   type: integer 
                   description: The index of the todo to delete. 
                   required: true