gitea/FastGPT
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README (#371)

Browse Source 
Signed-off-by: Carson Yang <yangchuansheng33@gmail.com>
This commit is contained in:
Carson Yang 2023-10-06 14:07:37 +08:00 committed by GitHub
parent ace8134a16
commit 4197f63751
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 91 additions and 49 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
.github/imgs/logo-left.svg vendored Normal file
View File

File diff suppressed because one or more lines are too long
Side by Side

After

Width:  |  Height:  |  Size: 10 KiB

34
README.md
View File

@ -1,26 +1,37 @@
<div align="center"> <div align="center">
<a href="https://fastgpt.run/"><img src="/.github/imgs/logo.svg" width="120" height="120" alt="fastgpt logo"></a> <a href="https://fastgpt.run/"><img src=".github/imgs/logo-left.svg" alt="fastgpt logo"></a>
# FastGPT <p align="center">
<a href="./README_en.md">English</a> |
<a href="./README.md">简体中文</a>
</p>
FastGPT 是一个基于 LLM 大语言模型的知识库问答系统，提供开箱即用的数据处理、模型调用等能力。同时可以通过 Flow 可视化进行工作流编排，从而实现复杂的问答场景！ FastGPT 是一个基于 LLM 大语言模型的知识库问答系统，提供开箱即用的数据处理、模型调用等能力。同时可以通过 Flow 可视化进行工作流编排，从而实现复杂的问答场景！
</div> </div>
<p align="center"> <p align="center">
<a href="https://fastgpt.run/">线上体验</a> <a href="https://fastgpt.run/">
· <img height="21" src="https://img.shields.io/badge/在线使用-fff?style=flat-square&logo=spoj&logoColor=7d09f1" alt="cloud">
<a href="https://doc.fastgpt.run/docs/intro">相关文档</a> </a>
· <a href="https://doc.fastgpt.run/docs/intro">
<a href="https://doc.fastgpt.run/docs/development">本地开发</a> <img height="21" src="https://img.shields.io/badge/相关文档-7d09f1?style=flat-square" alt="document">
· </a>
<a href="https://github.com/labring/FastGPT#-%E7%9B%B8%E5%85%B3%E9%A1%B9%E7%9B%AE">相关项目</a> <a href="https://doc.fastgpt.run/docs/development">
<img height="21" src="https://img.shields.io/badge/本地开发-%23fff?style=flat-square&logo=xcode&logoColor=7d09f1" alt="development">
</a>
<a href="/#-%E7%9B%B8%E5%85%B3%E9%A1%B9%E7%9B%AE">
<img height="21" src="https://img.shields.io/badge/相关项目-7d09f1?style=flat-square" alt="project">
</a>
<a href="https://github.com/labring/FastGPT/blob/main/LICENSE">
<img height="21" src="https://img.shields.io/badge/License-Apache--2.0-ffffff?style=flat-square&labelColor=fff&color=7d09f1" alt="license">
</a>
</p> </p>
https://github.com/labring/FastGPT/assets/15308462/7d3a38df-eb0e-4388-9250-2409bd33f6d4 https://github.com/labring/FastGPT/assets/15308462/7d3a38df-eb0e-4388-9250-2409bd33f6d4
## 🛸 在线体验 ## 🛸 在线使用
[fastgpt.run](https://fastgpt.run/)（服务器在新加坡，部分地区可能无法直连） [fastgpt.run](https://fastgpt.run/)（服务器在新加坡，部分地区可能无法直连）
@ -69,7 +80,6 @@ https://github.com/labring/FastGPT/assets/15308462/7d3a38df-eb0e-4388-9250-2409b
项目技术栈: NextJs + TS + ChakraUI + Mongo + Postgres（Vector 插件） 项目技术栈: NextJs + TS + ChakraUI + Mongo + Postgres（Vector 插件）
- **⚡ 快速部署** - **⚡ 快速部署**
> Sealos 的服务器在国外，不需要额外处理网络问题，无需服务器、无需魔法、无需域名，支持高并发 & 动态伸缩。点击以下按钮即可一键部署 👇 > Sealos 的服务器在国外，不需要额外处理网络问题，无需服务器、无需魔法、无需域名，支持高并发 & 动态伸缩。点击以下按钮即可一键部署 👇
[![](https://cdn.jsdelivr.us/gh/labring-actions/templates@main/Deploy-on-Sealos.svg)](https://cloud.sealos.io/?openapp=system-fastdeploy%3FtemplateName%3Dfastgpt) [![](https://cdn.jsdelivr.us/gh/labring-actions/templates@main/Deploy-on-Sealos.svg)](https://cloud.sealos.io/?openapp=system-fastdeploy%3FtemplateName%3Dfastgpt)
@ -114,7 +124,7 @@ https://github.com/labring/FastGPT/assets/15308462/7d3a38df-eb0e-4388-9250-2409b
本仓库遵循 [FastGPT Open Source License](./LICENSE) 开源协议。 本仓库遵循 [FastGPT Open Source License](./LICENSE) 开源协议。
1. 允许作为后台服务直接商用，但不允许直接使用 saas 服务商用。 1. 允许作为后台服务直接商用，但不允许直接使用 SaaS 服务商用。
2. 需保留相关版权信息。 2. 需保留相关版权信息。
3. 完整请查看 [FastGPT Open Source License](./LICENSE) 3. 完整请查看 [FastGPT Open Source License](./LICENSE)
4. 联系方式：yujinlong@sealos.io, [点击查看定价策略](https://doc.fastgpt.run/docs/commercial) 4. 联系方式：yujinlong@sealos.io, [点击查看定价策略](https://doc.fastgpt.run/docs/commercial)

89
README_en.md
View File

@ -1,25 +1,37 @@
<div align="center"> <div align="center">
<a href="https://fastgpt.run/"><img src="/.github/imgs/logo.svg" width="120" height="120" alt="fastgpt logo"></a>
# FastGPT <a href="https://fastgpt.run/"><img src=".github/imgs/logo-left.svg" alt="fastgpt logo"></a>
FastGPT is a knowledge-based question answering system built on the LLM. It offers out-of-the-box data processing and model invocation capabilities. Moreover, it allows for workflow orchestration through Flow visualization, thereby enabling complex question and answer scenarios! <p align="center">
<a href="./README_en.md">English</a> |
<a href="./README.md">简体中文</a>
</p>
FastGPT is a knowledge-based Q&A system built on the LLM, offers out-of-the-box data processing and model invocation capabilities, allows for workflow orchestration through Flow visualization!
</div> </div>
<p align="center"> <p align="center">
<a href="https://fastgpt.run/">Online</a> <a href="https://fastgpt.run/">
· <img height="21" src="https://img.shields.io/badge/Website-fff?style=flat-square&logo=spoj&logoColor=7d09f1" alt="cloud">
<a href="https://doc.fastgpt.run/docs/intro">Document</a> </a>
· <a href="https://doc.fastgpt.run/docs/intro">
<a href="https://doc.fastgpt.run/docs/development">Development</a> <img height="21" src="https://img.shields.io/badge/Docs-7d09f1?style=flat-square" alt="document">
· </a>
<a href="https://doc.fastgpt.run/docs/installation">Deploy</a> <a href="https://doc.fastgpt.run/docs/development">
· <img height="21" src="https://img.shields.io/badge/Development-%23fff?style=flat-square&logo=xcode&logoColor=7d09f1" alt="development">
<a href="#powered-by">Power By</a> </a>
<a href="/#-%E7%9B%B8%E5%85%B3%E9%A1%B9%E7%9B%AE">
<img height="21" src="https://img.shields.io/badge/Related Projects-7d09f1?style=flat-square" alt="project">
</a>
<a href="https://github.com/labring/FastGPT/blob/main/LICENSE">
<img height="21" src="https://img.shields.io/badge/License-Apache--2.0-ffffff?style=flat-square&labelColor=fff&color=7d09f1" alt="license">
</a>
</p> </p>
## 🛸 Online https://github.com/labring/FastGPT/assets/15308462/7d3a38df-eb0e-4388-9250-2409bd33f6d4
## 🛸 Use Cloud Services
[fastgpt.run](https://fastgpt.run/) [fastgpt.run](https://fastgpt.run/)
| | | | | |
@ -29,35 +41,34 @@ FastGPT is a knowledge-based question answering system built on the LLM. It offe
## 💡 Features ## 💡 Features
1. Powerful visual orchestration for easy AI application building 1. Powerful visual workflows: Effortlessly craft AI applications
- [x] Provides a simple mode without the need for orchestration operations - [x] Simple mode on deck - no need for manual arrangement
- [x] User dialogue pre-guidance - [x] User dialogue pre-guidance
- [x] Global variables - [x] Global variables
- [x] Knowledge base search - [x] Knowledge base search
- [x] Multi-LLM model dialogue - [x] Dialogue via multiple LLM models
- [x] Extraction of text content into structured data - [x] Text magic - convert to structured data
- [x] HTTP extension - [x] Extend with HTTP
- [ ] Sandbox JS runtime module - [ ] Embed Laf for on-the-fly HTTP module crafting
- [ ] Continuous dialogue guidance - [x] Directions for the next dialogue steps
- [ ] Dialogue multi-path selection - [ ] Multiple dialogue paths selection
- [ ] Source file reference tracking - [x] Tracking source file references
- [ ] Custom file reader
2. Rich knowledge base preprocessing 2. Extensive knowledge base preprocessing
- [x] Multiple library reuse and mixing - [x] Reuse and mix multiple knowledge bases
- [x] Chunk record modification and deletion - [x] Track chunk modifications and deletions
- [x] Supports direct segment import - [x] Supports manual entries, direct segmentation, and QA split imports
- [x] Supports QA split import - [x] Supports URL fetching and batch CSV imports
- [x] Supports manual input content - [x] Supports Set unique vector models for knowledge bases
- [ ] Supports URL import reading - [x] Store original files
- [x] Supports batch import of Q&A pairs in CSV format - [ ] File learning Agent
- [ ] Supports separate vector model settings for knowledge bases
- [ ] Source file storage
3. Multiple effect testing channels 3. Multiple effect testing channels
- [x] Knowledge base single point search testing - [x] Single-point knowledge base search test
- [x] Feedback references and ability to modify and delete during dialogue - [x] Feedback references and ability to modify and delete during dialogue
- [x] Complete context presentation - [x] Complete context presentation
- [ ] Complete module intermediate value presentation - [ ] Complete module intermediate value presentation
@ -77,11 +88,17 @@ FastGPT is a knowledge-based question answering system built on the LLM. It offe
Project tech stack: NextJs + TS + ChakraUI + Mongo + Postgres (Vector plugin) Project tech stack: NextJs + TS + ChakraUI + Mongo + Postgres (Vector plugin)
- **⚡ Deployment**
[![](https://cdn.jsdelivr.us/gh/labring-actions/templates@main/Deploy-on-Sealos.svg)](https://cloud.sealos.io/?openapp=system-fastdeploy%3FtemplateName%3Dfastgpt)
Give it a 2-4 minute wait after deployment as it sets up the database. Initially, it might be a tad slow since we're using the basic settings.
- [Getting Started with Local Development](https://doc.fastgpt.run/docs/development) - [Getting Started with Local Development](https://doc.fastgpt.run/docs/development)
- [Deploying FastGPT](https://doc.fastgpt.run/docs/installation) - [Deploying FastGPT](https://doc.fastgpt.run/docs/installation)
- [System Configuration File Explanation](https://doc.fastgpt.run/docs/installation/reference) - [Guide on System Configs](https://doc.fastgpt.run/docs/installation/reference)
- [Multi-model Configuration](https://doc.fastgpt.run/docs/installation/reference/models) - [Configuring Multiple Models](https://doc.fastgpt.run/docs/installation/reference/models)
- [V3 Upgrade V4 Initialization](https://doc.fastgpt.run/docs/installation/upgrading) - [Version Updates & Upgrades](https://doc.fastgpt.run/docs/installation/upgrading)
<!-- ## :point_right: RoadMap <!-- ## :point_right: RoadMap
- [FastGPT RoadMap](https://kjqvjse66l.feishu.cn/docx/RVUxdqE2WolDYyxEKATcM0XXnte) --> - [FastGPT RoadMap](https://kjqvjse66l.feishu.cn/docx/RVUxdqE2WolDYyxEKATcM0XXnte) -->