插件开发者文档

{
    "schema_version": "v1",   
    "name_for_human": "长文本理解工具",
    "name_for_model": "LongtextSummary",
    "description": "基于PDF/Doc格式文档（不支持扫描件），可检索知识点、对文档进行摘要等，支持10MB以内文件",
    "auth": {
        "type": "none"
    },
    "api": {
        "type": "openapi",
        "url": "https://example.com/openapi.yaml"
    },
    "logo_url": "https://example.com/example-icon.png",
    "contact_email": "example@baidu.com",
    "legal_info_url": "https://example.com/legal"
}

openapi: 3.0.1
info:
  title: 插件名称
  description: 插件描述，需要在何时使用这个插件
  version: 'v1'
servers:
  - url: <http://www.example.com>
paths:
  /run:
    post:
      operationId: exampleOperation
      summary: 接口描述
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/exampleRequest'
      responses:
        "200":
          description: OK
          content:
              application/json:
                schema:
                  $ref: '#/components/schemas/exampleResponse'
        "503": 
          description: "one or more services are unavailable"
components:
  schemas:
    exampleRequest:
      type: object
      required:
      - example_param
      properties:
        example_param:
          type: string
    exampleResponse:
      type: string
      

import json

import quart
import quart_cors
from quart import request

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


@app.post("/run")
async def run(username):
    request = await quart.request.get_json(force=True)
    if "example_param" not in request:
        return quart.Response(response='缺少example_param', status=503)
    return quart.Response(response='OK', status=200)

@app.get("/ai-plugin.json")
async def plugin_manifest()
    host = request.headers['Host']
    with open("ai-plugin.json") as f:
        text = f.read()
        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()
        return quart.Response(text, mimetype="text/yaml"）

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

if __name__ == "__main__":
    main()

{
  "schema_version": "v1",
  "name_for_human": "待办事项",
  "name_for_model": "ToDoList",
  "description": "给自己记录记录待办事项时使用，对待办事项的处理支持插入、删除、查询",
  "auth": {
    "type": "none"
  },
  "api": {
    "type": "openapi",
    "url": "http://www.example.com/openapi.yaml",
    "is_user_authenticated": false
  },
  "contact_email": "support@example.com",
  "legal_info_url": "http://www.example.com/legal"
}

openapi: 3.0.1
info:
  title: 待办事项
  description: 给自己记录记录待办事项时使用，对待办事项的处理支持插入、删除、查询
  version: 'v1'
servers:
  - url: http://www.example.com
paths:
  /run:
    post:
      operationId: todo
      summary: 对待办事项进行处理
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/todoRequest'
      responses:
        "200":
          description: OK
          content:
              application/json:
                schema:
                  $ref: '#/components/schemas/todoResponse'
                               
components:
  schemas:
    todoRequest:
      type: object
      required:
        - 操作
      properties:
        操作:
          type: string
          description: 对待办事项的操作方法
        顺序:
          type: string
        事项:
          type: string
   todoResponse:
       type:object
       properties:
           result:
              type: string

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