Tbot GPT服务接口说明

为了避免重复，这里mask 最好为一个uuid

1. /chat/qa

该接口是一个POST接口，用于提交一个消息列表，并返回AI的响应。

请求参数

mask (字符串): 配置文件名
messages (列表): 包含多个消息对象的列表。每个消息对象应该包含'role'和'content'两个字段。

请求示例


1
{
2
    "mask": "test",
3
    "messages": [
4
        {
5
            "role": "user",
6
            "content": "hello"
7
        }
8
    ]
9
}

响应示例


xxxxxxxxxx
4
1
{
2
    "role": "assistant",
3
    "content": "world"
4
}

2. /chat/ws

这是一个WebSocket接口，它接收一个类似于'/qa'接口的请求，并返回AI的响应。

todo

流式输出

请求示例


xxxxxxxxxx
9
1
{
2
    "mask": "test",
3
    "messages": [
4
        {
5
            "role": "user",
6
            "content": "hello"
7
        }
8
    ]
9
}

响应示例


xxxxxxxxxx
4
1
{
2
    "role": "assistant",
3
    "content": "world"
4
}

3. /mask/config

该接口有3种方法：GET、POST、DELETE，用于获取、更新和删除配置文件。

3.1 GET /mask/config

用于获取配置文件的内容。

请求参数

mask (字符串): 配置文件名

请求示例


xxxxxxxxxx
1
1
GET /mask/config?mask=myconfig

响应示例


xxxxxxxxxx
9
1
{
2
    "mask": "test",
3
    "messages": [
4
      {
5
        "role": "system",
6
        "content": "your are a helpful assistant"
7
      }
8
    ]
9
}

3.2 POST /mask/config

用于更新或创建一个新的配置文件。

请求参数

mask (字符串): 配置文件名

请求示例

POST /mask/config Content-Type: application/json


xxxxxxxxxx
9
1
{
2
    "mask": "test",
3
    "messages": [
4
      {
5
        "role": "system",
6
        "content": "your are a helpful assistant"
7
      }
8
    ]
9
  }

响应示例


xxxxxxxxxx
3
1
{
2
    "status": "success"
3
}

3.3 DELETE /mask/config

用于删除一个已存在的配置文件。

请求参数

mask (字符串): 配置文件名

请求示例


xxxxxxxxxx
4
1
DELETE /mask/config
2
{
3
    "mask": "test"
4
}

响应示例


xxxxxxxxxx
3
1
{
2
    "status": "success"
3
}