公共插件

Database SQL

GPTBots 平台开放的一款公共插件，开发者可用于连接自有数据库，并通过自然语言实现业务数据查询和分析。

URL

scheme://database_url

完整 URL 示例：

http://mysql://common_u:$123&456@127.0.0.1:3306/db_crm

• scheme只支持http和https

• url格式：dialect://username:password@HOST:PORT/database_name

序号	参数字段	描述
1	dialect	数据库类型，全小写，目前只支持mysql、clickhouse
2	username	数据库用户名
3	password	数据库用户密码
4	HOST	数据库主机名或IP地址
5	PORT	数据库端口
6	database_name	数据库名称

本插件使用的 LLM 为 ChatGPT-3.5-16K，数据库中所有表结构信息及其每个表的第一条样例信息的Tokens 总数不应超过16k，否则会LLM 超限报错

paths

只支持一个统一资源定位符（URI），URI中只允许一个get方法，一个query位置参数q，其余参数约定是通用的。

Plugin 协议

{
  "openapi": "3.0.0",
  "servers": [
    {
      "url": "http://mysql://common_u:$123&456@127.0.0.1:3306/db_crm"
    }
  ],
  "paths": {
    "/": {
      "get": {
        "description": "CRM数据库",
        "operationId": "提取关于CRM数据的查询请求问题，不要生成 SQL",
        "parameters": [
          {
            "name": "q",
            "in": "query",
            "description": "查询的问题",
            "required": true,
            "schema": {
              "type": "string",
              "default": "问题"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "*/*": {
                "schema": {
                  "type": "string"
                }
              }
            }
          },
          "403": {
            "description": "Authentication failed"
          }
        }
      }
    }
  }
}