docs: 配置阿里云数据库文档

18586361686

2025-05-19 00a1e97a5c0778497096eb5097c02cb5a3ae33aa

docs: 配置阿里云数据库文档

 docs/.vitepress/config.mts

@@ -176,6 +176,8 @@
                {text: '挂载知识库', link: 'bot-application/mount-knowledge'},
                {text: '挂载插件', link: 'bot-application/mount-plugins'},
                {text: '挂载工作流', link: 'bot-application/mount-workflow'},
                {text: 'Web 客户端', link: 'bot-application/bot-web-client'},
                {text: '通过 API 请求', link: 'bot-application/bot-api-key'},
            ]
        },
        {

 docs/zh/product/bot-application/bot-api-key.md

New file
@@ -0,0 +1,163 @@
# 通过api key 请求一个bot

apiKey 的作用是 用于身份认证，通过 apiKey 第三方可以携带对应的参数访问到 AIFlowy 对应的Bot进行对话。

## 第三方接入 Bot 聊天地址：
请求方式： POST
请求地址： http://127.0.0.1:8080/api/v1/aiBot/externalChat




### 默认请求方式以 JSON格式返回
请求头：

Headers: {
Authorization: apiKey
}

请求格式参数说明：
```
messages： 消息体
botId： 第三方想要请求的 BotId
```

请求示例：
```json
{   
    "messages": [

        {
            "role": "user",
            "content": "你好"
        },
          {
            "role": "assistant",
            "content": "你好我是科大讯飞模型"
        },
         {
            "role": "user",
            "content": "帮我翻译 what's your name ?"
        }
    ],
    "botId": "267848016181075968"
   
    
}
```



响应参数说明：

```json
status: END 表示本次对话正常结束
created： 创建时间
message： 消息体

```

请求成功示例：
```json
{
    "status": "END",
    "usage": {
        "completionTokens": 3,
        "promptTokens": 22,
        "totalTokens": 25
    },
    "created": 1745205152874,
    "choices": {
        "index": 0,
        "message": {
            "content": "你叫什么名字？",
            "role": "assistant"
        }
    }
}
```

### stream 格式返回

参数说明：

```
stream: true 表示以流式返回
```

请求示例：
```json
{   
    "stream": true,
    "messages": [

        {
            "role": "user",
            "content": "你好"
        },
          {
            "role": "assistant",
            "content": "你好我是科大讯飞模型"
        },
         {
            "role": "user",
            "content": "你叫什么名字?"
        }
    ],
    "botId": "267848016181075968"
   
    
}
```

返回参数说明：
```
status: START 表示本次对话开始
status: MIDDLE 表示本次对话进行中
status: END 表示本次对话正常结束
```

请求成功示例：

```json
{
    "status": "START",
    "created": 1745205750472,
    "choices": {
        "delta": {
            "content": "我的名字叫讯",
            "role": "assistant"
        },
        "index": 0
    }
}

```

```json
{
    "status": "MIDDLE",
    "created": 1745205750750,
    "choices": {
        "delta": {
            "content": "认知大模型，很高兴",
            "role": "assistant"
        },
        "index": 0
    }
}
```

```json
{
    "status": "END",
    "created": 1745205750901,
    "choices": {
        "delta": {
            "content": "为你服务。",
            "role": "assistant"
        },
        "index": 0
    }
}
```

 docs/zh/product/bot-application/bot-web-client.md

New file
@@ -0,0 +1,12 @@
# Bot web 客户端

Bot Web 客户端是指专门为机器人 Bot 设计的基于网页的用户界面或操作平台。它的主要功能是让用户能够通过浏览器来管理、控制和与自动化程序(机器人)进行交互。

## 如何进入Bot Web 客户端
点击如下所示的按钮，进入 Bot Web 客户端
![img.png](resource/bot-web-client-1.png)

## Bot Web 界面
这里是 Bot Web 界面，这个 Bot 包含了 **对话**、**插件**、**工作流**、**知识库** 四个模块，分别对应 Bot 的对话、插件、工作流、知识库功能。
用户输入想要提问的问题，点击 **发送** 按钮，Bot 会根据用户输入的提问，主动判断是调用哪个插件还是调用哪个工作流，然后调用对应的插件或者工作流，得到结果，返回给用户。
![img_1.png](resource/bot-web-client-2.png)

 docs/zh/product/bot-application/resource/bot-web-client-1.png

 docs/zh/product/bot-application/resource/bot-web-client-2.png

 docs/zh/product/knowledge/resource/config-aliyun-1.png

 docs/zh/product/knowledge/resource/config-aliyun-2.png

 docs/zh/product/knowledge/vector-database.md

@@ -129,4 +129,13 @@

## 2. OpenSearch 知识库配置样例

![open_search_config.png](../../development/ai/resource/open_search_config.png)
![open_search_config.png](../../development/ai/resource/open_search_config.png)

## 阿里云 向量数据库

## 1. 登录阿里云配置向量数据库，并创建集合名称
![img_1.png](resource/config-aliyun-2.png)
注意：集合名称需要先在阿里云上创建，才能配置在AIFlowy中

## 2. 阿里云向量数据库配置样例
![img.png](resource/config-aliyun-1.png)