-
Notifications
You must be signed in to change notification settings - Fork 5.7k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
daa5b55
commit 27ef4dc
Showing
2 changed files
with
110 additions
and
89 deletions.
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -4,6 +4,8 @@ | |
|
|
||
| # FastGPT | ||
|
|
||
|  | ||
|
|
||
| <p align="center"> | ||
| <a href="./README_en.md">English</a> | | ||
| <a href="./README.md">简体中文</a> | | ||
|
|
@@ -12,121 +14,105 @@ | |
|
|
||
| FastGPT is a knowledge-based platform built on the LLMs, offers a comprehensive suite of out-of-the-box capabilities such as data processing, RAG retrieval, and visual AI workflow orchestration, letting you easily develop and deploy complex question-answering systems without the need for extensive setup or configuration. | ||
|
|
||
| </div> | ||
|
|
||
| <p align="center"> | ||
| <a href="https://tryfastgpt.ai/"> | ||
| <img height="21" src="https://img.shields.io/badge/Try it Online-d4eaf7?style=flat-square&logo=spoj&logoColor=7d09f1" alt="cloud"> | ||
| </a> | ||
| <a href="https://doc.tryfastgpt.ai/docs/intro"> | ||
| <img height="21" src="https://img.shields.io/badge/Documents-7d09f1?style=flat-square" alt="document"> | ||
| </a> | ||
| <a href="https://doc.tryfastgpt.ai/docs/development"> | ||
| <img height="21" src="https://img.shields.io/badge/Local Development-%23d4eaf7?style=flat-square&logo=xcode&logoColor=7d09f1" alt="development"> | ||
| </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=d4eaf7&color=7d09f1" alt="license"> | ||
| </a> | ||
| </p> | ||
| [](https://github.com/labring/FastGPT/stargazers) | ||
| [](https://github.com/labring/FastGPT/pulls) | ||
| [](https://github.com/labring/FastGPT/pulls) | ||
| [](https://github.com/labring/FastGPT/blob/main/LICENSE) | ||
| [](https://doc.tryfastgpt.ai/docs/intro) | ||
| [](https://doc.tryfastgpt.ai/docs/intro) | ||
| [](https://tryfastgpt.ai/) | ||
|
|
||
| <div align="center"> | ||
| [](https://discord.gg/mp68xkZn2Q) | ||
| [](https://oss.laf.run/otnvvf-imgs/feishu3.png) | ||
|
|
||
| [](https://discord.gg/mp68xkZn2Q) | ||
|
|
||
| </div> | ||
|
|
||
| ## 🎥 Comprehensive Feature Demonstration | ||
|
|
||
| https://github.com/labring/FastGPT/assets/15308462/7d3a38df-eb0e-4388-9250-2409bd33f6d4 | ||
|
|
||
| ## 🛸 Use Cloud Services | ||
| ## 🛸 Online Use | ||
|
|
||
| Cloud: [tryfastgpt.ai](https://tryfastgpt.ai/) | ||
| Website: [tryfastgpt.ai](https://tryfastgpt.ai/) | ||
|
|
||
| | | | | ||
| | ---------------------------------- | ---------------------------------- | | ||
| | Conversational AI Setup | Workflow Automation | | ||
| |  |  | | ||
| | Knowledge Base Setup | Integration Process | | ||
| |  |  | | ||
|
|
||
| <a href="#readme"> | ||
| <a href="#FastGPT"> | ||
| <img src="https://img.shields.io/badge/-Back_to_Top-7d09f1.svg" alt="#" align="right"> | ||
| </a> | ||
|
|
||
| ## 💡 Features | ||
|
|
||
| `1` Application Orchestration Features | ||
| | **Features** | **Details** | | ||
| |--------------------------------------------|---------------------------------------------------| | ||
| | **Application Orchestration Features** | ✅ Offers a straightforward mode, eliminating the need for complex orchestration <br> ✅ Provides clear next-step instructions in dialogues <br> ✅ Facilitates workflow orchestration <br> ✅ Tracks references in source files <br> ✅ Encapsulates modules for enhanced reuse at multiple levels <br> ✅ Combines search and reordering functions <br> 🔜 Includes a tool module <br> 🔜 Integrates [Laf](https://github.com/labring/laf) for online HTTP module creation <br> 🔜 Plugin encapsulation capabilities | | ||
| | **Knowledge Base Features** | ✅ Allows for the mixed use of multiple databases <br> ✅ Keeps track of modifications and deletions in data chunks <br> ✅ Enables specific vector models for each knowledge base <br> ✅ Stores original source files <br> ✅ Supports direct input and segment-based QA import <br> ✅ Compatible with a variety of file formats: pdf, docx, txt, html, md, csv <br> ✅ Facilitates URL reading and bulk CSV importing <br> 🔜 Supports PPT and Excel file import <br> 🔜 Features a file reader <br> 🔜 Offers diverse data preprocessing options | | ||
| | **Application Debugging Features** | ✅ Enables targeted search testing within the knowledge base <br> ✅ Allows feedback, editing, and deletion during conversations <br> ✅ Presents the full context of interactions <br> ✅ Displays all intermediate values within modules <br> 🔜 Advanced Debug mode for orchestration | | ||
| | **OpenAPI Interface** | ✅ The completions interface (aligned with GPT's chat mode interface) <br> ✅ CRUD operations for the knowledge base <br> 🔜 CRUD operations for conversation | | ||
| | **Operational Features** | ✅ Share without requiring login <br> ✅ Easy embedding with Iframe <br> ✅ Customizable chat window embedding with features like default open, drag-and-drop <br> ✅ Centralizes conversation records for review and annotation | | ||
|
|
||
| - [x] Offers a straightforward mode, eliminating the need for complex orchestration | ||
| - [x] Provides clear next-step instructions in dialogues | ||
| - [x] Facilitates workflow orchestration | ||
| - [x] Tracks references in source files | ||
| - [x] Encapsulates modules for enhanced reuse at multiple levels | ||
| - [x] Combines search and reordering functions | ||
| - [ ] Includes a tool module | ||
| - [ ] Integrates [Laf](https://github.com/labring/laf) for online HTTP module creation | ||
| - [ ] Plugin encapsulation capabilities | ||
|
|
||
| `2` Knowledge Base Features | ||
|
|
||
| - [x] Allows for the mixed use of multiple databases | ||
| - [x] Keeps track of modifications and deletions in data chunks | ||
| - [x] Enables specific vector models for each knowledge base | ||
| - [x] Stores original source files | ||
| - [x] Supports direct input and segment-based QA import | ||
| - [x] Compatible with a variety of file formats: pdf, docx, txt, html, md, csv | ||
| - [x] Facilitates URL reading and bulk CSV importing | ||
| - [ ] Supports PPT and Excel file import | ||
| - [ ] Features a file reader | ||
| - [ ] Offers diverse data preprocessing options | ||
| <a href="#FastGPT"> | ||
| <img src="https://img.shields.io/badge/-Back_to_Top-7d09f1.svg" alt="#" align="right"> | ||
| </a> | ||
|
|
||
| `3` Application Debugging Features | ||
| ## 👨💻 Development | ||
|
|
||
| - [x] Enables targeted search testing within the knowledge base | ||
| - [x] Allows feedback, editing, and deletion during conversations | ||
| - [x] Presents the full context of interactions | ||
| - [x] Displays all intermediate values within modules | ||
| - [ ] Advanced DeBug mode for orchestration | ||
| Project tech stack: NextJs + TS + ChakraUI + MongoDB + PostgreSQL (PG Vector plug-in)/Milvus | ||
|
|
||
| `4` OpenAPI Interface | ||
| - **⚡ Fast Deployment** | ||
|
|
||
| - [x] The completions interface (aligned with GPT's chat mode interface) | ||
| - [x] CRUD operations for the knowledge base | ||
| - [ ] CRUD operations for conversations | ||
| > When using [Sealos](https://sealos.io) services, there is no need to purchase servers or domain names. It supports high concurrency and dynamic scaling, and the database application uses the kubeblocks database, which far exceeds the simple Docker container deployment in terms of IO performance. | ||
| <div align="center"> | ||
| [](https://cloud.sealos.io/?openapp=system-fastdeploy%3FtemplateName%3Dfastgpt) | ||
| </div> | ||
|
|
||
| `5` Operational Features | ||
| Give it a 2-4 minute wait after deployment as it sets up the database. Initially, it might be a too slow since we're using the basic settings. | ||
|
|
||
| - [x] Share without requiring login | ||
| - [x] Easy embedding with Iframe | ||
| - [x] Customizable chat window embedding with features like default open, drag-and-drop | ||
| - [x] Centralizes conversation records for review and annotation | ||
| [sealos one click deployment tutorial](https://doc.tryfastgpt.ai/docs/development/sealos/) | ||
|
|
||
| - [Getting Started with Local Development](https://doc.tryfastgpt.ai/docs/development) | ||
| - [Deploying FastGPT](https://doc.tryfastgpt.ai/docs/installation) | ||
| - [Guide on System Configs](https://doc.tryfastgpt.ai/docs/installation/reference) | ||
| - [Configuring Multiple Models](https://doc.tryfastgpt.ai/docs/installation/reference/models) | ||
| - [Version Updates & Upgrades](https://doc.tryfastgpt.ai/docs/installation/upgrading) | ||
|
|
||
| <a href="#readme"> | ||
| <a href="#FastGPT"> | ||
| <img src="https://img.shields.io/badge/-Back_to_Top-7d09f1.svg" alt="#" align="right"> | ||
| </a> | ||
|
|
||
| ## 👨💻 Development | ||
| ## 💪 Related Projects | ||
|
|
||
| Project tech stack: NextJs + TS + ChakraUI + Mongo + Postgres (Vector plugin) | ||
| - [Laf: 3-minute quick access to third-party applications](https://github.com/labring/laf) | ||
| - [Sealos: Rapid deployment of cluster applications](https://github.com/labring/sealos) | ||
| - [One API: Multi-model management, supports Azure, Wenxin Yiyuan, etc.](https://github.com/songquanpeng/one-api) | ||
| - [TuShan: Build a backend management system in 5 minutes](https://github.com/msgbyte/tushan) | ||
|
|
||
| - **⚡ Deployment** | ||
| <a href="#FastGPT"> | ||
| <img src="https://img.shields.io/badge/-Back_to_Top-7d09f1.svg" alt="#" align="right"> | ||
| </a> | ||
|
|
||
| [](https://cloud.sealos.io/?openapp=system-fastdeploy%3FtemplateName%3Dfastgpt) | ||
| ## 🤝 Third-party Ecosystem | ||
|
|
||
| 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. | ||
| - [luolinAI: Enterprise WeChat bot, ready to use](https://github.com/luolin-ai/FastGPT-Enterprise-WeChatbot) | ||
|
|
||
| - [Getting Started with Local Development](https://doc.tryfastgpt.ai/docs/development) | ||
| - [Deploying FastGPT](https://doc.tryfastgpt.ai/docs/installation) | ||
| - [Guide on System Configs](https://doc.tryfastgpt.ai/docs/installation/reference) | ||
| - [Configuring Multiple Models](https://doc.tryfastgpt.ai/docs/installation/reference/models) | ||
| - [Version Updates & Upgrades](https://doc.tryfastgpt.ai/docs/installation/upgrading) | ||
| <a href="#FastGPT"> | ||
| <img src="https://img.shields.io/badge/-Back_to_Top-7d09f1.svg" alt="#" align="right"> | ||
| </a> | ||
|
|
||
|
|
||
| ## 🏘️ Community & support | ||
| ## 🏘️ Community & Support | ||
|
|
||
| + 🌐 Visit the [FastGPT website](https://tryfastgpt.ai/) for full documentation and useful links. | ||
| + 💬 Join our [Discord server](https://discord.gg/mp68xkZn2Q) is to chat with FastGPT developers and other FastGPT users. This is a good place to learn about FastGPT, ask questions, and share your experiences. | ||
| + 🐞 Create [GitHub Issues](https://github.com/labring/FastGPT/issues/new/choose) for bug reports and feature requests. | ||
|
|
||
| <a href="#readme"> | ||
| <a href="#FastGPT"> | ||
| <img src="https://img.shields.io/badge/-Back_to_Top-7d09f1.svg" alt="#" align="right"> | ||
| </a> | ||
|
|
||
|
|
@@ -137,28 +123,46 @@ Project tech stack: NextJs + TS + ChakraUI + Mongo + Postgres (Vector plugin) | |
| - [Official Account Integration Video Tutorial](https://www.bilibili.com/video/BV1xh4y1t7fy/) | ||
| - [FastGPT Knowledge Base Demo](https://www.bilibili.com/video/BV1Wo4y1p7i1/) | ||
|
|
||
| <a href="#readme"> | ||
| <a href="#FastGPT"> | ||
| <img src="https://img.shields.io/badge/-Back_to_Top-7d09f1.svg" alt="#" align="right"> | ||
| </a> | ||
|
|
||
| ## 💪 Related Projects | ||
|
|
||
| - [Laf: 3-minute quick access to third-party applications](https://github.com/labring/laf) | ||
| - [Sealos: Rapid deployment of cluster applications](https://github.com/labring/sealos) | ||
| - [One API: Multi-model management, supports Azure, Wenxin Yiyuan, etc.](https://github.com/songquanpeng/one-api) | ||
| - [TuShan: Build a backend management system in 5 minutes](https://github.com/msgbyte/tushan) | ||
|
|
||
| <a href="#readme"> | ||
| <img src="https://img.shields.io/badge/-Back_to_Top-7d09f1.svg" alt="#" align="right"> | ||
| ## 🌱 Contributors | ||
|
|
||
| We welcome all forms of contributions. If you are interested in contributing code, you can check out our GitHub [Issues](https://github.com/labring/FastGPT/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc) to show us your ideas. | ||
|
|
||
| <a href="https://github.com/labring/FastGPT/graphs/contributors" target="_blank"> | ||
| <table> | ||
| <tr> | ||
| <th colspan="2"> | ||
| <br><img src="https://contrib.rocks/image?repo=labring/FastGPT"><br><br> | ||
| </th> | ||
| </tr> | ||
| <tr> | ||
| <td> | ||
| <picture> | ||
| <source media="(prefers-color-scheme: dark)" srcset="https://next.ossinsight.io/widgets/official/compose-org-active-contributors/thumbnail.png?activity=active&period=past_28_days&owner_id=102226726&repo_ids=605673387&image_size=2x3&color_scheme=dark"> | ||
| <img alt="Active participants of labring - past 28 days" src="https://next.ossinsight.io/widgets/official/compose-org-active-contributors/thumbnail.png?activity=active&period=past_28_days&owner_id=102226726&repo_ids=605673387&image_size=2x3&color_scheme=light"> | ||
| </picture> | ||
| </td> | ||
| <td rowspan="2"> | ||
| <picture> | ||
| <source media="(prefers-color-scheme: dark)" srcset="https://next.ossinsight.io/widgets/official/compose-org-participants-growth/thumbnail.png?activity=new&period=past_28_days&owner_id=102226726&repo_ids=605673387&image_size=4x7&color_scheme=dark"> | ||
| <img alt="New trends of labring" src="https://next.ossinsight.io/widgets/official/compose-org-participants-growth/thumbnail.png?activity=new&period=past_28_days&owner_id=102226726&repo_ids=605673387&image_size=4x7&color_scheme=light"> | ||
| </picture> | ||
| </td> | ||
| </tr> | ||
| <tr> | ||
| <td> | ||
| <picture> | ||
| <source media="(prefers-color-scheme: dark)" srcset="https://next.ossinsight.io/widgets/official/compose-org-active-contributors/thumbnail.png?activity=new&period=past_28_days&owner_id=102226726&repo_ids=605673387&image_size=2x3&color_scheme=dark"> | ||
| <img alt="New participants of labring - past 28 days" src="https://next.ossinsight.io/widgets/official/compose-org-active-contributors/thumbnail.png?activity=new&period=past_28_days&owner_id=102226726&repo_ids=605673387&image_size=2x3&color_scheme=light"> | ||
| </picture> | ||
| </td> | ||
| </tr> | ||
| </table> | ||
| </a> | ||
|
|
||
| ## 🤝 Third-party Ecosystem | ||
|
|
||
| - [luolinAI: Enterprise WeChat bot, ready to use](https://github.com/luolin-ai/FastGPT-Enterprise-WeChatbot) | ||
|
|
||
| <a href="#readme"> | ||
| <img src="https://img.shields.io/badge/-Back_to_Top-7d09f1.svg" alt="#" align="right"> | ||
| </a> | ||
|
|
||
| ## 🌟 Star History | ||
|
|
||
|
|
@@ -169,3 +173,20 @@ Project tech stack: NextJs + TS + ChakraUI + Mongo + Postgres (Vector plugin) | |
| <img alt="Star History Chart" src="https://api.star-history.com/svg?repos=labring/FastGPT&type=Date" /> | ||
| </picture> | ||
| </a> | ||
|
|
||
| <a href="#FastGPT"> | ||
| <img src="https://img.shields.io/badge/-Back_to_Top-7d09f1.svg" alt="#" align="right"> | ||
| </a> | ||
|
|
||
| ## 📄 Usage Agreement | ||
|
|
||
| This repository complies with the [FastGPT Open Source License](./LICENSE) open source agreement. | ||
|
|
||
| 1. Direct commercial use as a backend service is allowed, but provision of SaaS services is not allowed. | ||
| 2. Without commercial authorization, any form of commercial service must retain relevant copyright information. | ||
| 3. For full details, please see [FastGPT Open Source License](./LICENSE) | ||
| 4. Contact: [email protected] , [click to view commercial version pricing strategy](https://doc.tryfastgpt.ai/docs/commercial) | ||
|
|
||
| <a href="#FastGPT"> | ||
| <img src="https://img.shields.io/badge/-Back_to_Top-7d09f1.svg" alt="#" align="right"> | ||
| </a> | ||