-
Notifications
You must be signed in to change notification settings - Fork 2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: add docs and usage for v0.5.0 (#1216)
- Loading branch information
Showing
22 changed files
with
442 additions
and
1 deletion.
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 |
---|---|---|
@@ -0,0 +1,59 @@ | ||
# Data App Usage | ||
|
||
Starting with version 0.5.0, the DB-GPT project has natively integrated the management and distribution of data-centric applications. The application management repository is also part of the open-source [dbgpts](https://github.com/eosphoros-ai/dbgpts) project. The [dbgpts](https://github.com/eosphoros-ai/dbgpts) project manages and shares resources categorized into the following: | ||
|
||
- [apps](https://github.com/eosphoros-ai/dbgpts/tree/main/apps): These are native intelligent data applications developed using the DB-GPT framework. | ||
- [workflow](https://github.com/eosphoros-ai/dbgpts/tree/main/workflow): Workflows constructed using the AWEL (Agentic Workflow Expression Language). | ||
- [agents](https://github.com/eosphoros-ai/dbgpts/tree/main/agents): Intelligent agents that can perform various tasks. | ||
- [operators](https://github.com/eosphoros-ai/dbgpts/tree/main/operators): Basic operational operators (or symbols) that can be used within workflows. | ||
|
||
:::info NOTE | ||
|
||
Please note that this tutorial primarily focuses on the installation and use of intelligent agent workflows. For the development of applications, you should refer to the `Development Guide`. | ||
|
||
Support for these capabilities is provided from version V0.5.0 onwards. For developers and teams looking to build and distribute their applications through DB-GPT, this structured approach provides both a framework and ecosystem for creating, sharing, and managing data applications effectively. | ||
::: | ||
|
||
Here we introduce the creation of a data intelligence analysis assistant application. This tutorial utilizes the auto-planning capability of Multi-Agents. | ||
|
||
The effect is as follows: | ||
|
||
<p align="left"> | ||
<img src={'/img/app/app_analysis.png'} width="720px" /> | ||
</p> | ||
|
||
In the application panel, click on `Create Application` and fill in the parameters as shown in the image. It is important to note that the work mode selected here is `auto_plan`. This involves the collaboration of two dependent Agents: 1. DataScientist and 2. Reporter. Both of these agents depend on the resource `database`, and for testing, you can use the default database and data provided in the official tutorial. | ||
|
||
Special Note: Currently, in auto-plan mode, the building of applications is conducted through multiple Agents. This project has a number of built-in Agents, which currently include: | ||
- [CodeEngineer](https://github.com/eosphoros-ai/DB-GPT/blob/main/dbgpt/agent/agents/expand/code_assistant_agent.py) | ||
- [Reporter](https://github.com/eosphoros-ai/DB-GPT/blob/main/dbgpt/agent/agents/expand/dashboard_assistant_agent.py) | ||
- [DataScientist](https://github.com/eosphoros-ai/DB-GPT/blob/main/dbgpt/agent/agents/expand/data_scientist_agent.py) | ||
- [ToolExpert](https://github.com/eosphoros-ai/DB-GPT/blob/main/dbgpt/agent/agents/expand/plugin_assistant_agent.py) | ||
- [RetrieveSummarizer](https://github.com/eosphoros-ai/DB-GPT/blob/main/dbgpt/agent/agents/expand/retrieve_summary_assistant_agent.py) | ||
- [Summarizer](https://github.com/eosphoros-ai/DB-GPT/blob/main/dbgpt/agent/agents/expand/summary_assistant_agent.py) | ||
|
||
If you wish to expand and implement customized Agents, you can refer to the `Agents Development Guide`. | ||
|
||
<p align="left"> | ||
<img src={'/img/app/app_agents.png'} width="720px" /> | ||
</p> | ||
|
||
<p align="left"> | ||
<img src={'/img/app/app_agent_reporter.jpg'} width="720px" /> | ||
</p> | ||
|
||
After adding the necessary information, choose to submit to complete the creation of the application. In the application panel, click the dialogue button to enter the dialogue interface. | ||
|
||
<p align="left"> | ||
<img src={'/img/app/app_list.png'} width="720px" /> | ||
</p> | ||
|
||
<p align="left"> | ||
<img src={'/img/app/app_analysis_black.png'} width="720px" /> | ||
</p> | ||
|
||
|
||
# Summary | ||
This tutorial is just a simple introduction to application construction. If you are interested in more complex applications, you can achieve more intricate scenarios by orchestrating AWEL workflows and customizing the expansion of Agents. | ||
|
||
|
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 |
---|---|---|
@@ -0,0 +1,75 @@ | ||
# AWEL Flow Usage | ||
|
||
:::info NOTE | ||
|
||
⚠️ Please note that this tutorial mainly introduces the installation and use of agent workflows. For the development of workflows, please refer to the `Development Guide`. | ||
This capability is supported after version V0.5.0. | ||
::: | ||
|
||
<p align="left"> | ||
<img src={'/img/app/dbgpts_flow_black.png'} width="720px" /> | ||
</p> | ||
|
||
As shown in the picture, this is the management and editing interface for DB-GPT workflows. Intelligent agents can be orchestrated into definitive workflows using the Agentic Workflow Expression Language (AWEL). These workflows can be used for subsequent application creation. | ||
|
||
<p align="left"> | ||
<img src={'/img/app/awel_flow_node.png'} width="720px" /> | ||
</p> | ||
|
||
## Workflow Installation | ||
|
||
As part of this introductory tutorial, we will cover the installation and use of workflows. | ||
|
||
Before you can start using workflows, you need to complete the installation and deployment of DB-GPT. For detailed deployment instructions, you can refer to the quick start guide. Once the project is deployed, you can begin installing and using AWEL workflows. The DB-GPT official provides an application repository that can be used for installation. Here, we will use the command line for operation. Execute `dbgpt --help` in the terminal to check if the command line is installed correctly. | ||
|
||
<p align="left"> | ||
<img src={'/img/app/dbgpts_cli.png'} width="720px" /> | ||
</p> | ||
|
||
As illustrated, the dbgpt command supports various operations, including model-related tasks, knowledge base interactions, Trace logs, and more. Here, we will focus on the operations related to apps. | ||
|
||
<p align="left"> | ||
<img src={'/img/app/dbgpts_apps.png'} width="720px" /> | ||
</p> | ||
|
||
By using the `dbgpt app list-remote` command, we can see that there are three available AWEL workflows in the current repository. Here, we will install the `awel-flow-web-info-search` workflow. To do this, execute the command dbgpt app install `awel-flow-web-info-search`. | ||
|
||
Let's also install the other official workflows provided: | ||
|
||
``` | ||
dbgpt app install awel-flow-web-info-search | ||
dbgpt app install awel-flow-example-chat | ||
dbgpt app install awel-flow-simple-streaming-chat | ||
``` | ||
By executing these commands, you will install the respective workflows onto your system. | ||
|
||
<p align="left"> | ||
<img src={'/img/app/dbgpts_app_install.png'} width="720px" /> | ||
</p> | ||
|
||
After successful installation, restart the DB-GPT service (dynamic hot loading is on the way 😊). Refresh the page, and you will be able to see the corresponding workflows on the AWEL workflow page. | ||
|
||
## Creating Applications Based on Workflows | ||
|
||
Earlier, we introduced the construction and installation of AWEL workflows. Next, let's discuss how to create data applications based on large models. | ||
|
||
Here, we will create a search dialogue application based on the `awel-flow-web-info-search` workflow. | ||
|
||
The core capability of the search dialogue application is to search for relevant knowledge using a search engine (such as Baidu or Google) and then provide a summarized answer. The effect is as follows: | ||
|
||
<p align="left"> | ||
<img src={'/img/app/app_search.png'} width="720px" /> | ||
</p> | ||
|
||
Creating the aforementioned application is very simple. In the application creation panel, click `Create`, enter the following parameters, and the creation process will be complete. There are a few parameters that require attention: | ||
|
||
- Work Mode | ||
- Flows | ||
The work mode we are using here is `awel_layout`. The AWEL workflow selected is `awel-flow-web-info-search`, which is the workflow that was installed previously. | ||
|
||
<p align="left"> | ||
<img src={'/img/app/app_awel.png'} width="720px" /> | ||
</p> | ||
|
||
The above is the basic introduction to using the intelligent agent workflow. We look forward to more of your suggestions on how to play around with it. For instructions on how to develop workflows, you can refer to the development tutorial that follows. | ||
|
Oops, something went wrong.