283 lines
6.2 KiB
Markdown
283 lines
6.2 KiB
Markdown
# 安全岛 - 接口清单（AI 会话）
|
||
|
||
> 来源：Apipost 分享文档 `https://docs.apipost.net/docs/detail/6bb6da071469000?target_id=19ff8d18312`
|
||
> 基础地址：`https://gbs-gateway.qhdsafety.com`
|
||
> OpenAPI 版本：`3.0.0`
|
||
> 标签：APP/AI会话
|
||
|
||
|
||
## 一、接口总览
|
||
|
||
| # | 方法 | 路径 | 说明 |
|
||
|---|------|------|------|
|
||
| 1 | POST | `/knowledge/openapi/v1/agent/chat` | ai对话 流式对话 |
|
||
| 2 | POST | `/knowledge/openapi/v1/user/register` | 用户获权 |
|
||
| 3 | GET | `/knowledge/openapi/v1/agent/conversations` | 查询ai会话列表 |
|
||
| 4 | POST | `/knowledge/openapi/v1/agent/conversations` | 创建会话 |
|
||
| 5 | DELETE | `/knowledge/openapi/v1/agent/conversations` | 删除指定会话 |
|
||
| 6 | PUT | `/knowledge/openapi/v1/agent/conversations` | 修改会话标题 |
|
||
| 7 | GET | `/knowledge/openapi/v1/agent/conversations/messages` | 查询ai会话消息历史 |
|
||
| 8 | POST | `/knowledge/openapi/v1/agent/attachment/upload` | 上传附件 |
|
||
| 9 | GET | `/knowledge/openapi/v1/agents` | 智能体列表 |
|
||
| 10 | GET | `/knowledge/openapi/v1/agent` | 智能体详情 |
|
||
|
||
## 二、接口详情
|
||
|
||
### 1. POST /knowledge/openapi/v1/agent/chat
|
||
|
||
- **说明**：ai对话 流式对话
|
||
- **标签**：APP/AI会话
|
||
|
||
**请求头**
|
||
|
||
| 名称 | 必填 | 类型 | 说明 |
|
||
|------|------|------|------|
|
||
| `Ai-App-Id` | 是 | string | |
|
||
| `Ai-Token` | 是 | string | |
|
||
|
||
**请求体**
|
||
|
||
- Content-Type：`application/json`
|
||
- 结构：{"type": "object"}
|
||
|
||
**响应**
|
||
|
||
- `200`：成功
|
||
- `404`：失败
|
||
|
||
### 2. POST /knowledge/openapi/v1/user/register
|
||
|
||
- **说明**：用户获权
|
||
- **标签**：APP/AI会话
|
||
|
||
**请求头**
|
||
|
||
| 名称 | 必填 | 类型 | 说明 |
|
||
|------|------|------|------|
|
||
| `Ai-App-Id` | 是 | string | |
|
||
| `Ai-Token` | 是 | string | |
|
||
|
||
**请求体**
|
||
|
||
- Content-Type：`application/json`
|
||
- 结构：{"type": "object"}
|
||
|
||
**响应**
|
||
|
||
- `200`：成功
|
||
- `404`：失败
|
||
|
||
### 3. GET /knowledge/openapi/v1/agent/conversations
|
||
|
||
- **说明**：查询ai会话列表
|
||
- **标签**：APP/AI会话
|
||
|
||
**请求头**
|
||
|
||
| 名称 | 必填 | 类型 | 说明 |
|
||
|------|------|------|------|
|
||
| `Ai-App-Id` | 是 | string | |
|
||
| `Ai-Token` | 是 | string | |
|
||
|
||
**Query 参数**
|
||
|
||
| 名称 | 必填 | 类型 | 说明 |
|
||
|------|------|------|------|
|
||
| `agentId` | 是 | string | |
|
||
| `openId` | 是 | string | |
|
||
| `page` | 是 | string | |
|
||
| `size` | 是 | string | |
|
||
|
||
**响应**
|
||
|
||
- `200`：成功
|
||
- `404`：失败
|
||
|
||
### 4. POST /knowledge/openapi/v1/agent/conversations
|
||
|
||
- **说明**：创建会话
|
||
- **标签**：APP/AI会话
|
||
|
||
**请求头**
|
||
|
||
| 名称 | 必填 | 类型 | 说明 |
|
||
|------|------|------|------|
|
||
| `Ai-App-Id` | 是 | string | |
|
||
| `Ai-Token` | 是 | string | |
|
||
|
||
**请求体**
|
||
|
||
- Content-Type：`application/json`
|
||
- 结构：{"type": "object"}
|
||
|
||
**响应**
|
||
|
||
- `200`：成功
|
||
- `404`：失败
|
||
|
||
### 5. DELETE /knowledge/openapi/v1/agent/conversations
|
||
|
||
- **说明**：删除指定会话
|
||
- **标签**：APP/AI会话
|
||
|
||
**请求头**
|
||
|
||
| 名称 | 必填 | 类型 | 说明 |
|
||
|------|------|------|------|
|
||
| `Ai-App-Id` | 是 | string | |
|
||
| `Ai-Token` | 是 | string | |
|
||
|
||
**Query 参数**
|
||
|
||
| 名称 | 必填 | 类型 | 说明 |
|
||
|------|------|------|------|
|
||
| `conversationId` | 是 | string | |
|
||
| `openId` | 是 | string | |
|
||
| `agentId` | 是 | string | |
|
||
|
||
**请求体**
|
||
|
||
- Content-Type：`application/json`
|
||
- 结构：{"type": "object"}
|
||
|
||
**响应**
|
||
|
||
- `200`：成功
|
||
- `404`：失败
|
||
|
||
### 6. PUT /knowledge/openapi/v1/agent/conversations
|
||
|
||
- **说明**：修改会话标题
|
||
- **标签**：APP/AI会话
|
||
|
||
**请求头**
|
||
|
||
| 名称 | 必填 | 类型 | 说明 |
|
||
|------|------|------|------|
|
||
| `Ai-App-Id` | 是 | string | |
|
||
| `Ai-Token` | 是 | string | |
|
||
|
||
**Query 参数**
|
||
|
||
| 名称 | 必填 | 类型 | 说明 |
|
||
|------|------|------|------|
|
||
| `conversationId` | 是 | string | |
|
||
| `openId` | 是 | string | |
|
||
| `agentId` | 是 | string | |
|
||
|
||
**请求体**
|
||
|
||
- Content-Type：`application/json`
|
||
- 结构：{"type": "object"}
|
||
|
||
**响应**
|
||
|
||
- `200`：成功
|
||
- `404`：失败
|
||
|
||
### 7. GET /knowledge/openapi/v1/agent/conversations/messages
|
||
|
||
- **说明**：查询ai会话消息历史
|
||
- **标签**：APP/AI会话
|
||
|
||
**请求头**
|
||
|
||
| 名称 | 必填 | 类型 | 说明 |
|
||
|------|------|------|------|
|
||
| `Ai-App-Id` | 是 | string | |
|
||
| `Ai-Token` | 是 | string | |
|
||
|
||
**Query 参数**
|
||
|
||
| 名称 | 必填 | 类型 | 说明 |
|
||
|------|------|------|------|
|
||
| `agentId` | 是 | string | |
|
||
| `openId` | 是 | string | |
|
||
| `page` | 是 | string | |
|
||
| `size` | 是 | string | |
|
||
| `conversationId` | 是 | string | |
|
||
|
||
**响应**
|
||
|
||
- `200`：成功
|
||
- `404`：失败
|
||
|
||
### 8. POST /knowledge/openapi/v1/agent/attachment/upload
|
||
|
||
- **说明**：上传附件
|
||
- **标签**：APP/AI会话
|
||
|
||
**请求头**
|
||
|
||
| 名称 | 必填 | 类型 | 说明 |
|
||
|------|------|------|------|
|
||
| `Ai-App-Id` | 是 | string | |
|
||
| `Ai-Token` | 是 | string | |
|
||
|
||
**请求体**
|
||
|
||
- Content-Type：`multipart/form-data`
|
||
- 结构：{"type": "object", "properties": {"openId": {"type": "string", "description": "", "example": "cd31e20033d346eaa3282f6c54bc8aa8"}, "type": {"type": "string", "description": "IMAGE 走图片处理；其他类型（DOCUMENT/AUDIO 等）统一按文档存储。不传默认按非图片处理", "example": "DOCUMENT"}, "file": {"type": "string", "description": "", "e
|
||
|
||
**响应**
|
||
|
||
- `200`：成功
|
||
- `404`：失败
|
||
|
||
### 9. GET /knowledge/openapi/v1/agents
|
||
|
||
- **说明**：智能体列表
|
||
- **标签**：APP/AI会话
|
||
|
||
**请求头**
|
||
|
||
| 名称 | 必填 | 类型 | 说明 |
|
||
|------|------|------|------|
|
||
| `Ai-App-Id` | 是 | string | |
|
||
| `Ai-Token` | 是 | string | |
|
||
|
||
**Query 参数**
|
||
|
||
| 名称 | 必填 | 类型 | 说明 |
|
||
|------|------|------|------|
|
||
| `page` | 是 | string | |
|
||
| `size` | 是 | string | |
|
||
|
||
**请求体**
|
||
|
||
- Content-Type：`application/json`
|
||
- 结构：{"type": "object"}
|
||
|
||
**响应**
|
||
|
||
- `200`：成功
|
||
- `404`：失败
|
||
|
||
### 10. GET /knowledge/openapi/v1/agent
|
||
|
||
- **说明**：智能体详情
|
||
- **标签**：APP/AI会话
|
||
|
||
**请求头**
|
||
|
||
| 名称 | 必填 | 类型 | 说明 |
|
||
|------|------|------|------|
|
||
| `Ai-App-Id` | 是 | string | |
|
||
| `Ai-Token` | 是 | string | |
|
||
|
||
**Query 参数**
|
||
|
||
| 名称 | 必填 | 类型 | 说明 |
|
||
|------|------|------|------|
|
||
| `agentId` | 是 | string | |
|
||
|
||
**请求体**
|
||
|
||
- Content-Type：`application/json`
|
||
- 结构：{"type": "object"}
|
||
|
||
**响应**
|
||
|
||
- `200`：成功
|
||
- `404`：失败
|