Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat:add financial report how to use doc. #1757

Merged
merged 2 commits into from
Aug 2, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 34 additions & 16 deletions docs/docs/application/started_tutorial/chat_financial_report.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,20 @@
# Chat With Financial Report

Recently, financial analysis with the help of large models is becoming a popular application in vertical fields. Large models can not only understand complex financial rules more accurately than humans, but can also output reasonable analysis results based on professional knowledge. Many cutting-edge solutions have provided answers such as RAG and Agent. However, financial statement information is large and complex, and the accuracy of data analysis is extremely high. It is difficult for general solutions to meet these needs.

For example, when a user queries "What is the operating net profit of XXX subsidiary in 2022?", the conventional method is to recall the most relevant text blocks for summary and question and answer through knowledge vector similarity retrieval and matching. However, the annual financial report contains many relevant information that may lead to misjudgment. If you cannot accurately recall and understand the correct part, it is easy to generate wrong answers.
# Chat With Financial Report
Financial report analysis using large models is becoming a popular application in vertical fields. Large models can not only understand complex financial rules more accurately than humans, but can also output reasonable analysis results based on professional knowledge.

Using AWEL to build a financial report knowledge building workflow and a financial report intelligent Q&A workflow app can help users
- answer basic information questions about financial reports
- financial report indicator calculation and analysis questions
- financial report content analysis questions.

#### financial report knowledge building workflow
<p align="left">
<img src={'/img/chat_knowledge/fin_report/knowledge_workflow.png'} width="1000px"/>
</p>

In order to overcome some obstacles in the application of large models, we need to combine the knowledge background in the financial field and add specialized external modules to enhance its functions. This article will take DB-GPT's Awel orchestration mode as an example, and use several key atoms of DB-GPT-Hub to describe how to use large models to conduct effective financial report data analysis.
#### a financial report intelligent robot workflow
<p align="left">
<img src={'/img/chat_knowledge/fin_report/financial_robot_chat.png'} width="1000px"/>
</p>

# How to Use
Upload financial report pdf and chat with financial report
Expand All @@ -29,12 +39,13 @@ scene3:analyze financial report
# How to Install

Step 1: make sure your dbgpt version is >=0.5.10
```

Step 2: upgrade python dependencies
```
pip install pdfplumber
pip install fuzzywuzzy
```

Step 3: install financial report app from dbgpts
```
# install poetry
Expand All @@ -45,8 +56,7 @@ dbgpt app install financial-robot-app financial-report-knowledge-factory

```

Step4:
download pre_trained embedding model from https://www.modelscope.cn/models/AI-ModelScope/bge-large-zh-v1.5
Step 4: download pre_trained embedding model from https://www.modelscope.cn/models/AI-ModelScope/bge-large-zh-v1.5
```
git clone https://www.modelscope.cn/models/AI-ModelScope/bge-large-zh-v1.5
```
Expand All @@ -58,14 +68,22 @@ git clone https://www.modelscope.cn/models/AI-ModelScope/bge-large-zh-v1.5
FIN_REPORT_MODEL=/app/DB-GPT/models/bge-large-zh-v1.5
```

Step 4: create FinancialReport knowledge space
![image](https://github.com/user-attachments/assets/90d938f0-e09f-49f2-8f8b-fa69ef6f8ae6)
Step 5: create knowledge space, choose `FinancialReport` doamin type
<p align="left">
<img src={'/img/chat_knowledge/fin_report/financial_space.png'} width="1000px"/>
</p>

Step 5: upload financial report from `docker/examples/fin_report`
![upload_report](https://github.com/eosphoros-ai/DB-GPT/assets/13723926/4630f226-4bd6-4645-858a-bd3cde4e4789)
Step 6: automatic segment and wait for a while
![process_log](https://github.com/eosphoros-ai/DB-GPT/assets/13723926/0506dd86-4089-4ba4-8589-b617afc0eafe)
Step 7: chat with financial report

Step 6: upload financial report from `docker/examples/fin_report`, if your want to use the financial report dataset, you can download from modelscope.
```bash
git clone http://www.modelscope.cn/datasets/modelscope/chatglm_llm_fintech_raw_dataset.git
```
Step 7: automatic segment and wait for a while

Step 8: chat with financial report
<p align="left">
<img src={'/img/chat_knowledge/fin_report/chat.jpg'} width="1000px"/>
</p>



6 changes: 3 additions & 3 deletions docs/docs/awel/cookbook/first_rag_with_awel.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,8 +85,8 @@ vector_store = ChromaStore(
vector_store_config=ChromaVectorConfig(
name="test_vstore",
persist_path="/tmp/awel_rag_test_vector_store",
),
embedding_fn=embeddings
embedding_fn=embeddings
)
)

with DAG("load_knowledge_dag") as knowledge_dag:
Expand Down Expand Up @@ -275,8 +275,8 @@ vector_store = ChromaStore(
vector_store_config=ChromaVectorConfig(
name="test_vstore",
persist_path="/tmp/awel_rag_test_vector_store",
embedding_fn=embeddings
),
embedding_fn=embeddings
)

with DAG("load_knowledge_dag") as knowledge_dag:
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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 docs/static/img/chat_knowledge/fin_report/financial_space.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading