Skip to content

Commit

Permalink
4.7 doc update (labring#1068)
Browse files Browse the repository at this point in the history
* fix: plugin update

* feat: get current time plugin

* fix: ts

* perf: select app ux

* fix: ts

* perf: max w

* move code

* perf: inform tip

* fix: inform

* doc

* fix: tool handle

* perf: tmp file store

* doc

* fix: message file selector

* feat: doc

* perf: switch trigger

* doc

* fix: openapi import

* rount the number

* parse openapi schema

* fix empty line after variables (labring#64)

* doc image

* image size

* doc

* doc

* catch error

---------

Co-authored-by: heheer <[email protected]>
  • Loading branch information
c121914yu and newfish-cmyk authored Mar 27, 2024
1 parent c7e6448 commit 6b7b03c
Show file tree
Hide file tree
Showing 160 changed files with 1,393 additions and 558 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -42,3 +42,5 @@ docSite/.vercel
.idea/
files/helm/fastgpt/fastgpt-0.1.0.tgz
files/helm/fastgpt/charts/*.tgz

tmp/
Binary file added docSite/assets/imgs/47-sealos1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docSite/assets/imgs/47-sealos2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docSite/assets/imgs/47-sealos3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docSite/assets/imgs/47-sealos4.webp
Binary file not shown.
Binary file added docSite/assets/imgs/47-sealos5.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docSite/assets/imgs/aichat.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docSite/assets/imgs/aichat0.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docSite/assets/imgs/aichat01.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docSite/assets/imgs/aichat02.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docSite/assets/imgs/aichat2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docSite/assets/imgs/aichat3.webp
Binary file not shown.
Binary file removed docSite/assets/imgs/coreferenceResolution2.jpg
Binary file not shown.
Binary file added docSite/assets/imgs/coreferenceResolution2.webp
Binary file not shown.
Binary file removed docSite/assets/imgs/coreferenceResolution3.jpg
Binary file not shown.
Binary file added docSite/assets/imgs/coreferenceResolution3.webp
Binary file not shown.
Binary file removed docSite/assets/imgs/datasetEngine3.jpg
Binary file not shown.
Binary file added docSite/assets/imgs/datasetEngine3.webp
Binary file not shown.
Binary file removed docSite/assets/imgs/datasetEngine4.jpg
Binary file not shown.
Binary file added docSite/assets/imgs/datasetEngine4.webp
Binary file not shown.
Binary file removed docSite/assets/imgs/datasetEngine5.jpg
Binary file not shown.
Binary file added docSite/assets/imgs/datasetEngine5.webp
Binary file not shown.
Binary file removed docSite/assets/imgs/datasetEngine6.jpg
Binary file not shown.
Binary file added docSite/assets/imgs/datasetEngine6.webp
Binary file not shown.
Binary file removed docSite/assets/imgs/datasetEngine7.jpg
Binary file not shown.
Binary file added docSite/assets/imgs/datasetEngine7.webp
Binary file not shown.
Binary file modified docSite/assets/imgs/dataset_search_params1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docSite/assets/imgs/dataset_search_params2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docSite/assets/imgs/dataset_search_params3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docSite/assets/imgs/datasetprompt7.jpg
Binary file not shown.
Binary file added docSite/assets/imgs/datasetprompt7.webp
Binary file not shown.
Binary file removed docSite/assets/imgs/demo-appointment1.jpg
Binary file not shown.
Binary file added docSite/assets/imgs/demo-appointment1.webp
Binary file not shown.
Binary file removed docSite/assets/imgs/demo-dalle2.png
Binary file not shown.
Binary file added docSite/assets/imgs/demo-dalle2.webp
Binary file not shown.
Binary file added docSite/assets/imgs/feishuwebhook1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docSite/assets/imgs/feishuwebhook2.webp
Binary file not shown.
Binary file added docSite/assets/imgs/feishuwebhook3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docSite/assets/imgs/feishuwebhook4.webp
Binary file not shown.
Binary file added docSite/assets/imgs/feishuwebhook5.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docSite/assets/imgs/flow-dataset1.png
Binary file added docSite/assets/imgs/flow-tool1.png
Binary file added docSite/assets/imgs/flow-tool2.png
Binary file added docSite/assets/imgs/flow-tool3.png
Binary file added docSite/assets/imgs/flow-tool4.png
Binary file removed docSite/assets/imgs/gapierTool10.png
Diff not rendered.
Binary file added docSite/assets/imgs/gapierTool10.webp
Binary file not shown.
Binary file removed docSite/assets/imgs/gapierTool12.png
Diff not rendered.
Binary file added docSite/assets/imgs/gapierTool12.webp
Binary file not shown.
Binary file removed docSite/assets/imgs/gapierTool13.png
Diff not rendered.
Binary file removed docSite/assets/imgs/gapierTool14.png
Diff not rendered.
Binary file added docSite/assets/imgs/gapierTool14.webp
Binary file not shown.
Binary file removed docSite/assets/imgs/gapierTool15.png
Diff not rendered.
Binary file added docSite/assets/imgs/gapierTool15.webp
Binary file not shown.
Binary file removed docSite/assets/imgs/gapierTool16.png
Diff not rendered.
Binary file added docSite/assets/imgs/gapierTool16.webp
Binary file not shown.
Binary file removed docSite/assets/imgs/gapierTool17.png
Diff not rendered.
Binary file added docSite/assets/imgs/gapierTool17.webp
Binary file not shown.
Binary file removed docSite/assets/imgs/gapierTool9.png
Diff not rendered.
Binary file added docSite/assets/imgs/gapierTool9.webp
Binary file not shown.
Binary file removed docSite/assets/imgs/gapierToolResult1.png
Diff not rendered.
Binary file added docSite/assets/imgs/gapierToolResult1.webp
Binary file not shown.
Binary file removed docSite/assets/imgs/getfile_id.png
Diff not rendered.
Binary file added docSite/assets/imgs/getfile_id.webp
Binary file not shown.
Binary file removed docSite/assets/imgs/google_search_1.jpg
Diff not rendered.
Binary file removed docSite/assets/imgs/google_search_1.png
Diff not rendered.
Binary file added docSite/assets/imgs/google_search_1.webp
Binary file not shown.
Binary file added docSite/assets/imgs/google_search_3.png
Binary file added docSite/assets/imgs/google_search_4.png
Binary file modified docSite/assets/imgs/http1.jpg
Binary file removed docSite/assets/imgs/intro1.png
Diff not rendered.
Binary file added docSite/assets/imgs/intro1.webp
Binary file not shown.
Binary file removed docSite/assets/imgs/oneapi-step1.jpg
Diff not rendered.
Binary file added docSite/assets/imgs/oneapi-step1.webp
Binary file not shown.
Binary file removed docSite/assets/imgs/question_guide.png
Diff not rendered.
Binary file added docSite/assets/imgs/question_guide.webp
Binary file not shown.
Binary file removed docSite/assets/imgs/sealos3.jpg
Diff not rendered.
Binary file added docSite/assets/imgs/sealos3.webp
Binary file not shown.
Binary file removed docSite/assets/imgs/tts_setting2.png
Diff not rendered.
Binary file added docSite/assets/imgs/tts_setting2.webp
Binary file not shown.
Binary file modified docSite/assets/imgs/variable3.png
Binary file removed docSite/assets/imgs/variable4.png
Diff not rendered.
Binary file added docSite/assets/imgs/variable4.webp
Binary file not shown.
Binary file removed docSite/assets/imgs/variable5.png
Diff not rendered.
Binary file added docSite/assets/imgs/variable5.webp
Binary file not shown.
Binary file removed docSite/assets/imgs/webSync10.jpg
Diff not rendered.
Binary file added docSite/assets/imgs/webSync10.webp
Binary file not shown.
Binary file removed docSite/assets/imgs/webSync6.jpg
Diff not rendered.
Binary file added docSite/assets/imgs/webSync6.webp
Binary file not shown.
Binary file removed docSite/assets/imgs/webSync7.jpg
Diff not rendered.
Binary file added docSite/assets/imgs/webSync7.webp
Binary file not shown.
Binary file removed docSite/assets/imgs/webSync8.jpg
Diff not rendered.
Binary file added docSite/assets/imgs/webSync8.webp
Binary file not shown.
Binary file removed docSite/assets/imgs/webSync9.jpg
Diff not rendered.
Binary file added docSite/assets/imgs/webSync9.webp
Binary file not shown.
Binary file added docSite/assets/imgs/workflow_process.png
3 changes: 2 additions & 1 deletion docSite/content/docs/commercial/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,11 @@ FastGPT 商业版是基于 FastGPT 开源版的增强版本,增加了一些独
| 内容审核 ||||
| web站点同步 ||||
| 管理后台 ||||
| 完整商业授权 ||||
| 增强训练模式 ||||
| 图片知识库 || 设计中 | 设计中 |
| 自动规划召回 || 设计中 | 设计中 |
| 对话日志运营分析 || 设计中 | 设计中 |
| 完整商业授权 ||||
{{< /table >}}

## 商业版软件价格
Expand Down
32 changes: 24 additions & 8 deletions docSite/content/docs/course/ai_settings.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "AI 高级配置说明"
description: "FastGPT AI 高级配置说明"
title: "AI 相关参数配置说明"
description: "FastGPT AI 相关参数配置说明"
icon: "sign_language"
draft: false
toc: true
Expand All @@ -9,17 +9,33 @@ weight: 102

在 FastGPT 的 AI 对话模块中,有一个 AI 高级配置,里面包含了 AI 模型的参数配置,本文详细介绍这些配置的含义。

## 返回AI内容
| | | |
| --- | --- | --- |
| ![](/imgs/aichat0.png) | ![](/imgs/aichat02.png) | ![](/imgs/aichat2.png) |

## 返回AI内容(高级编排特有)

这是一个开关,打开的时候,当 AI 对话模块运行时,会将其输出的内容返回到浏览器(API响应);如果关闭,AI 输出的内容不会返回到浏览器,但是生成的内容仍可以通过【AI回复】进行输出。你可以将【AI回复】连接到其他模块中。

## 温度
### 最大上下文

代表模型最多容纳的文字数量。

### 函数调用

支持函数调用的模型,在使用工具时更加准确。

### 温度

越低回答越严谨,少废话(实测下来,感觉差别不大)

### 回复上限

可选范围0-10,越大代表生成的内容越自由扩散,越小代表约严谨。调节能力有限,知识库问答场景通常设置为0
最大回复 token 数量。注意,是回复的Tokens!不是上下文 tokens

## 回复上限
### 系统提示词

控制 AI 回复的最大 Tokens,较小的值可以一定程度上减少 AI 的废话,但也可能导致 AI 回复不完整
被放置在上下文数组的最前面,role 为 system,用于引导模型

## 引用模板 & 引用提示词

Expand Down Expand Up @@ -123,7 +139,7 @@ Tips: 建议根据不同的场景,每种知识库仅选择1类数据类型,

| 非严格模板效果 | 选择严格模板 | 严格模板效果 |
| --- | --- | --- |
| ![](/imgs/datasetprompt7.jpg) | ![](/imgs/datasetprompt8.jpg) |![](/imgs/datasetprompt9.jpg) |
| ![](/imgs/datasetprompt7.webp) | ![](/imgs/datasetprompt8.jpg) |![](/imgs/datasetprompt9.jpg) |

#### 提示词设计思路

Expand Down
134 changes: 0 additions & 134 deletions docSite/content/docs/course/data_search.md

This file was deleted.

6 changes: 3 additions & 3 deletions docSite/content/docs/course/datasetEngine.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,15 +51,15 @@ FastGPT 采用了 `PostgresSQL` 的 `PG Vector` 插件作为向量检索器,

|| 集合 | 数据 |
| --- | --- | --- |
| ![](/imgs/datasetEngine1.jpg) | ![](/imgs/datasetEngine2.jpg) | ![](/imgs/datasetEngine3.jpg) |
| ![](/imgs/datasetEngine1.jpg) | ![](/imgs/datasetEngine2.jpg) | ![](/imgs/datasetEngine3.webp) |

### 导入数据方案1 - 直接分段导入

选择文件导入时,可以选择直接分段方案。直接分段会利用`句子分词器`对文本进行一定长度拆分,最终分割中多组的`q`。如果使用了直接分段方案,我们建议在`应用`设置`引用提示词`时,使用`通用模板`即可,无需选择`问答模板`

| 交互 | 结果 |
| --- | --- |
| ![](/imgs/datasetEngine4.jpg) | ![](/imgs/datasetEngine5.jpg) |
| ![](/imgs/datasetEngine4.webp) | ![](/imgs/datasetEngine5.webp) |


### 导入数据方案2 - QA导入
Expand All @@ -68,7 +68,7 @@ FastGPT 采用了 `PostgresSQL` 的 `PG Vector` 插件作为向量检索器,

| 交互 | 结果 |
| --- | --- |
| ![](/imgs/datasetEngine6.jpg) | ![](/imgs/datasetEngine7.jpg) |
| ![](/imgs/datasetEngine6.webp) | ![](/imgs/datasetEngine7.webp) |

### 导入数据方案3 - 手动录入

Expand Down
2 changes: 1 addition & 1 deletion docSite/content/docs/course/kb.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: " 利用 FastGPT 打造高质量 AI 知识库"
icon: "school"
draft: false
toc: true
weight: 106
weight: 300
---

## 前言
Expand Down
80 changes: 0 additions & 80 deletions docSite/content/docs/course/websync.md

This file was deleted.

20 changes: 11 additions & 9 deletions docSite/content/docs/development/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ llm模型全部合并
},
"llmModels": [
{
"model": "gpt-3.5-turbo", // 模型名
"model": "gpt-3.5-turbo", // 模型名(对应OneAPI中渠道的模型名)
"name": "gpt-3.5-turbo", // 别名
"avatar": "/imgs/model/openai.svg", // 模型的logo
"maxContext": 16000, // 最大上下文
Expand Down Expand Up @@ -97,14 +97,16 @@ llm模型全部合并
],
"vectorModels": [
{
"model": "text-embedding-ada-002",
"name": "Embedding-2",
"avatar": "/imgs/model/openai.svg",
"charsPointsPrice": 0,
"defaultToken": 700,
"maxToken": 3000,
"weight": 100,
"defaultConfig":{} // 默认配置。例如,如果希望使用 embedding3-large 的话,可以传入 dimensions:1024,来返回1024维度的向量。(目前必须小于1536维度)
"model": "text-embedding-ada-002", // 模型名(与OneAPI对应)
"name": "Embedding-2", // 模型展示名
"avatar": "/imgs/model/openai.svg", // logo
"charsPointsPrice": 0, // n积分/1k token
"defaultToken": 700, // 默认文本分割时候的 token
"maxToken": 3000, // 最大 token
"weight": 100, // 优先训练权重
"defaultConfig":{}, // 自定义额外参数。例如,如果希望使用 embedding3-large 的话,可以传入 dimensions:1024,来返回1024维度的向量。(目前必须小于1536维度)
"dbConfig": {}, // 存储时的额外参数(非对称向量模型时候需要用到)
"queryConfig": {} // 参训时的额外参数
}
],
"reRankModels": [],
Expand Down
6 changes: 4 additions & 2 deletions docSite/content/docs/development/docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,11 +96,13 @@ curl -O https://raw.githubusercontent.com/labring/FastGPT/main/projects/app/data

## 三、启动容器

在 docker-compose.yml 同级目录下执行
在 docker-compose.yml 同级目录下执行。请确保`docker-compose`版本最好在2.17以上,否则可能无法执行自动化命令。

```bash
# 启动容器
docker-compose up -d
# 等待10s,OneAPI第一次总是要重启几次才能连上Mysql
sleep 10
# 重启一次oneapi(由于OneAPI的默认Key有点问题,不重启的话会提示找不到渠道,临时手动重启一次解决,等待作者修复)
docker restart oneapi
```
Expand All @@ -109,7 +111,7 @@ docker restart oneapi

可以通过`ip:3001`访问OneAPI,默认账号为`root`密码为`123456`

在OneApi中添加合适的AI模型渠道。
在OneApi中添加合适的AI模型渠道。[点击查看相关教程](/docs/development/one-api/)

## 五、访问 FastGPT

Expand Down
Loading

0 comments on commit 6b7b03c

Please sign in to comment.