protonuniverse / ais-ninja

A ChatGPT that supports plugins.

ais-ninja

English README

介绍

ais-ninja 是一个基于 chatgpt 的 Web 应用程序。它基于 ChatGpt-Web.

• 重构了后端代码。
• 多语言支持。
• 支持插件系统。

部署

docker

docker run -d \
    --name ais-ninja \
    --hostname ais-ninja \
    -p 6789:80    \
    -e PUID=0     \
    -e DATABASE_NAME=ais_ninja     \
    -e DATABASE_PORT=3306     \
    -e DATABASE_HOST=host     \
    -e DATABASE_USER=root     \
    -e DATABASE_PASSWORD=123456     \
    -e DATABASE_SYNC='true'     \
    -e REDIS_URL=redis://${url}:6379/0     \
    -e EMAIL_HOST=smtp.office365.com     \
    -e EMAIL_PORT=587     \
    -e EMAIL_FROM=     \
    -e EMAIL_AUTH_USER=     \
    -e EMAIL_AUTH_PASS=     \
    -e SOCIAL_GOOGLE_CLIENT_ID=     \
    -e VITE_APP_REQUEST_HOST=     \
    jarvis2f/ais-ninja:v1.0.0

docker-compose

1. 创建文件夹 ais_ninja 创建 docker-compose.yml 文件.

   mkdir ais.ninja && cd ais.ninja
   touch docker-compose.yml

2. 复制 docker-compose.yml 到 docker-compose.yml 文件中

3. 修改 docker-compose.yml 中的环境变量

4. 运行 docker-compose up -d 启动服务

运行 docker logs ais-ninja-app 查看日志。如果看到如下日志，则说明服务启动成功。首次启动会生成默认管理员帐户和密码。

[12:47:52.887] INFO (43): Logger initialized: info
[12:47:57.798] INFO (config/43): Config file path: /app/server/config.json
[12:47:58.308] INFO (db/43): Database connected
[12:47:58.822] INFO (db/43): Database synced
[12:47:58.832] INFO (redis/43): Redis connected
[12:47:58.851] WARN (openai/43): No OpenAI tokens provided
[12:47:58.851] INFO (app/43): OpenAI clients initialized
[12:47:58.860] INFO (app/43): Server running on port 5174
[12:47:58.861] INFO (db/43): Administrator initialized: ${administrator account}  ${administrator password}

后台地址：http://localhost:6789/admin

环境变量

本项目中的大部分配置项都是通过环境变量来设置的。

你也可以修改 config.json 文件去设置环境变量。 然后运行 docker run -d --name ais-ninja -v /path/to/config.json:/app/server/config.json jarvis2f/ais-ninja:1.0.0 启动服务.

Environment Variable	Description
DATABASE_NAME	数据库名称
DATABASE_PORT	数据库端口
DATABASE_HOST	数据库地址
DATABASE_USER	数据库用户名
DATABASE_PASSWORD	数据库密码
DATABASE_SYNC	项目启动是否自动同步数据库表结构。 true or false
REDIS_URL	Redis 地址，格式: redis[s]://[[username][:password]@][host][:port][/db-number]
EMAIL_HOST	邮箱服务地址
EMAIL_PORT	邮箱服务端口
EMAIL_FROM	邮箱服务发送方邮箱地址
EMAIL_AUTH_USER	邮箱服务用户名
EMAIL_AUTH_PASS	邮箱服务密码
SOCIAL_GOOGLE_CLIENT_ID	谷歌登录的client_id

插件

项目启动之后可以到后台 -> 系统配置中填写仓库地址：https://github.com/jarvis2f/ais-ninja.git 导入本仓库 plugins 下的插件。

创建对话插件

可以先看下 OpenAI 的文档。 对话中会将插件中的方法以下方这种格式传递给 ChatGPT 的接口，ChatGPT 会返回需要调用的插件方法名称和参数。

{
  "functions": [
    {
      "name": "search_weather",
      "description": "Query china real time weather information from seniverse.com",
      "parameters": {
        "type": "object",
        "properties": {
          "location": {
            "type": "string",
            "description": "China Pinyin Location name, e.g. beijing"
          }
        },
        "required": [
          "location"
        ]
      }
    }
  ]
}

系统中一个插件可以有多个 function, 用户安装一个插件之后会把插件中的所有 function 传递给 ChatGPT。 插件使用 JavaScript 编写，可以参考 plugins中的代码。 可以使用的库：

• fetch 发起网络请求
• dayjs 时间处理
• lodash 工具库

plugins 目录格式：

• plugins/${plugin_name}/index.js 插件代码
• plugins/${plugin_name}/desc.md 插件介绍
• plugins/${plugin_name}/plugin.json 插件信息

插件变量

可以将一些私有的 key 设为插件变量，这样就不会暴露在代码中。在 plugin.json 中的 variables 字段中定义变量。

{
  "name": "weather",
  "description": "Query china real time weather information from seniverse.com",
  "variables": {
    "SENIVERSE_KEY": "Your API Key"
  }
}

在前台插件编辑中编写变量保存，然后就可以在代码中使用 process.env.SENIVERSE_KEY 获取变量。