待辦事項列表（無認證） - 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