Skip to content

Commit

Permalink
🍎 docs: add docs for v0.6.0
Browse files Browse the repository at this point in the history
  • Loading branch information
csunny committed Sep 4, 2024
1 parent 74a1a59 commit e444b60
Show file tree
Hide file tree
Showing 29 changed files with 372 additions and 68 deletions.
16 changes: 15 additions & 1 deletion docs/docs/application/apps/app_chat.md
Original file line number Diff line number Diff line change
@@ -1 +1,15 @@
# App Chat
# App Chat

The online Chat interface provides the main conversation capabilities, showing the historical conversation records and the application currently in conversation. As shown in the figure below, clicking any smart application will also jump to this interface.

<p align="center">
<img src={'/img/app/app_chat_v0.6.jpg'} width="800px" />
</p>

In the dialogue interface, a series of operations such as refreshing and pausing the dialogue are supported. The specific operation buttons are in the edit box at the bottom right. At the same time, the dialog box also provides a variety of parameter selections, such as model selection, temperature parameter adjustment, file upload, etc.

<p align="center">
<img src={'/img/app/app_chat_op_v0.6.jpg'} width="800" />
</p>

If you find new problems or have good ideas during use, you can also directly post them on Github [issue](https://github.com/eosphoros-ai/DB-GPT/issues) feedback.
18 changes: 17 additions & 1 deletion docs/docs/application/apps/app_explore.md
Original file line number Diff line number Diff line change
@@ -1 +1,17 @@
# App Explore
# App Explore

In the new version of DB-GPT V0.6.0, the application management has been comprehensively upgraded. The search square module is mainly used to discover various interesting, fun and useful data applications.KeywordsIn addition to searching for apps, it also provides popular recommendations, comprehensive apps, my favorites, etc.

After the default installation, the previous six application scenarios are retained.

- [Chat Excel](chat_excel.md)
- Chat Normal
- [Chat DB](chat_db.md)
- [Chat DashBoard](chat_dashboard.md)
- [Chat Data](chat_data.md)
- [Chat Knowledge Base](chat_knowledge.md)


<p align="center">
<img src={'/img/app/app_explore_v0.6.jpg'} width="800px" />
</p>
56 changes: 55 additions & 1 deletion docs/docs/application/apps/app_manage.md
Original file line number Diff line number Diff line change
@@ -1 +1,55 @@
# App Manage
# App Manage

The application management panel provides many capabilities. Here we mainly introduce the management of the data intelligence application life cycle, including application creation, editing, deletion, and use.

<p align="center">
<img src={'/img/app/app_manage_v0.6.jpg'} width="800px" />
</p>

As shown in the figure, the application management interface. First, let's take a look at the creation of an application. In DB-GPT, four application creation modes are provided.

- Multi-agent automatic planning mode
- Task flow orchestration mode
- Single Agent Mode
- Native application mode

<p align="center">
<img src={'/img/app/app_manage_mode_v0.6.jpg'} width="800px" />
</p>

Next, we will explain the creation of applications in each mode respectively. Native application mode In the early versions of DB-GPT, six types of native application scenarios were provided, such as `Chat DB`, `Chat Data`, `Chat Dashboard`, `Chat Knowledge Base`, `Chat Normal`, `Chat Excel`, etc.

By creating a data intelligence application in the native application mode, you can quickly build a similar application based on your own database, knowledge base and other parameters. Click the upper right cornerCreate an applicationbutton, select **Native application mode**, enter the application name and description, click **Sure**

<p align="center">
<img src={'/img/app/app_manage_chat_data_v0.6.jpg'} width="800px" />
</p>

After confirmation, enter the parameter selection panel. As shown in the figure below, we can see selection boxes such as application type, model, temperature, and recommended questions.

<p align="center">
<img src={'/img/app/app_manage_chat_data_editor_v0.6.jpg'} width="800px" />
</p>

Here, we select **Chat Data** Application, fill in the parameters in order according to the requirements. Note that in the data dialogue application, the parameter column needs to fill in the data source. If you do not have a data source, you need to follow [Data Source Tutorial](../datasources.md) to add it.


After completing the parameters, click **Save** to view related applications in the application panel.

<p align="center">
<img src={'/img/app/app_manage_app_v0.6.jpg'} width="800px" />
</p>

Please note that after creating an application, there is a **Publish Application** button. Only after the application is published can it be discovered and used by other users.

<p align="center">
<img src={'/img/app/app_manage_app_publish_v0.6.jpg'} width="800px" />
</p>

Finally, click the **Start a conversation** button to start a conversation with the application you just created.

<p align="center">
<img src={'/img/app/app_manage_chat_v0.6.jpg'} width="800px" />
</p>

In addition, you can also edit and delete applications. Just operate on the corresponding interface.
59 changes: 0 additions & 59 deletions docs/docs/application/apps/app_usage.md

This file was deleted.

8 changes: 7 additions & 1 deletion docs/docs/application/awel.md
Original file line number Diff line number Diff line change
@@ -1 +1,7 @@
# Use Data App With AWEL
# Use Data App With AWEL


## Reference
- [AWEL](../awel/awel.md)
- [AWEL CookBook](../awel/cookbook/)
- [AWEL Tutorial](../awel/awel_tutorial/)
14 changes: 14 additions & 0 deletions docs/docs/application/datasources.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Datasources

The DB-GPT data source module is designed to manage the structured and semi-structured data assets of an enterprise, connect databases, data warehouses, data lakes, etc. to the DB-GPT framework, and quickly build data-based intelligent applications and large models. Currently, DB-GPT supports some common data sources and also supports custom extensions.

<p align="center">
<img src={'/img/app/datasource.jpg'} width="800px" />
</p>


You can add data sources through the upper right corner **Add a data source** button to add. In the pop-up dialog box, select the corresponding database type and fill in the required parameters to complete the addition.

<p align="center">
<img src={'/img/app/datasource_add.jpg'} width="800px" />
</p>
15 changes: 15 additions & 0 deletions docs/docs/application/llms.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# LLMs

In the new version, the location of model management has moved to **Application Management** Under the panel, other functional modules remain unchanged


<p align="center">
<img src={'/img/app/llms_v0.6.jpg'} width="800px" />
</p>


For the use of multi-model management, please refer to the following documents.

- [Multi-Model Management](../application/advanced_tutorial/smmf.md)
- [Model Service deployment](../installation/model_service/)
- [Introduction to the principles of multi-model management](../modules/smmf.md)
61 changes: 61 additions & 0 deletions docs/docs/application/prompts.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
# Prompts

In the actual application development process, Prompt needs to be customized in different scenarios, Agent, RAG and other modules. In order to make the editing and adjustment of Prompt more flexible, an independent Prompt module is created.

## Browse

As shown in the figure below, click **Application Management** ->**Prompt** You can enter the corresponding management interface. The interface displays a custom prompt list by default, and you can manage all prompts.

<p align="center">
<img src={'/img/app/prompt_v0.6.jpg'} width="800px" />
</p>

## Added
Next, let's see how to create a new prompt. Click the **Add Prompt** button and the prompt edit box will pop up.

<p align="center">
<img src={'/img/app/prompt_add_v0.6.jpg'} width="800px" />
</p>

We define four types of prompts:
- AGENT: Agent Prompt
- SCENE: Scene Prompt
- NORMAL: Normal prompt word
- EVALUATE: Evaluation Mode Prompt

When the AGENT type is selected, all registered agents can be seen in the drop-down list menu, and you can select an agent to set the prompt.

<p align="center">
<img src={'/img/app/agent_prompt_v0.6.jpg'} width="400px" />
</p>

After setting the prompt, a unique UID will be generated. You can bind the corresponding prompt according to the ID when using it.

<p align="center">
<img src={'/img/app/agent_prompt_code_v0.6.jpg'} width="800px" />
</p>


## Usage

Enter the AWEL editing interface, as shown below, click **Application Management** -> **Create Workflow**


<p align="center">
<img src={'/img/app/awel_create.6.jpg'} width="800px" />
</p>

Find the Agent resource and select the AWEL Layout Agent operator. We can see that each Agent contains the following information:

- Profile
- Role
- Goal
- Resource (AWELResource): The resource that Agent depends on
- AgentConfig(AWELAgentConfig) Agent Config
- AgentPrompt: Prompt

<p align="center">
<img src={'/img/app/agent_prompt_awel_v0.6.jpg'} width="800px" />
</p>

Click the [+] next to **AgentPrompt**, select the Prompt operator that pops up, and select the corresponding Prompt name or UID in the parameter panel to bind our newly created Prompt to the Agent, and debug the Agent's behavior in turn.
Loading

0 comments on commit e444b60

Please sign in to comment.