Skip to content

Commit 24ae670

Browse files
committed
docs: update readme
1 parent fec2932 commit 24ae670

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

README-CH.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# LLM LangChain Text To SQL Streamlit
22

3-
使用 LangChain 串接 OpenAI 或 Ollama 並連接資料庫,讓 AI 瞭解資料庫結構、優化提示詞、實現 Text-to-SQL,並使用 Streamlit 建立互動式前端網頁。
3+
使用 LangChain 串接 OpenAI 或 Ollama 並連接資料庫,讓 AI 瞭解資料庫結構、使用檢索增強生成優化提示詞、實現 Text-to-SQL,並使用 Streamlit 建立互動式前端網頁。
44

55

66
## Overview
@@ -10,7 +10,7 @@
1010

1111
## Env
1212

13-
可以選擇 OpenAI 或 Ollama 作為 LLM,並設置所選擇 LLM 的環境變數。如果使用 OpenAI,則需要從 [OpenAI](https://platform.openai.com/) 獲取 API 金鑰(可能需要付費訂閱)。
13+
可以選擇 OpenAI 或 Ollama 作為 LLM,並設置所選擇 LLM 的環境變數。如果使用 OpenAI,則需要從 [OpenAI](https://platform.openai.com/) 獲取 API 金鑰(可能需要付費訂閱)。並且設定 RAG 所使用 Embedding 模型,可以和 LLM 不相同。
1414

1515
```
1616
# LLM OPENAI or OLLAMA

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,15 @@
33
**(also provided Traditional Chinese version document [README-CH.md](README-CH.md).)**
44

55

6-
Use LangChain to integrate with OpenAI or Ollama and connect to the database, enabling the AI to understand the database structure, optimize prompts, achieve Text-to-SQL, and build an interactive frontend web page with Streamlit.
6+
Use LangChain to integrate with OpenAI or Ollama and connect to a database, enabling the AI to understand the database structure, enhance prompts with Retrieval-Augmented Generation (RAG), achieve Text-to-SQL, and build an interactive frontend web page with Streamlit.
77

88
## Overview
99
- Module: langchain-community v0.3.19, langchain-openai v0.3.7, langchain v0.3.20, langchain-ollama v0.2.3
1010
- UI: streamlit v1.42.2
1111

1212
## Env
1313

14-
Able to choose OpenAI or Ollama as the LLM, and set the environment variables for the selected LLM. If using OpenAI, an API key must be obtained from [OpenAI](https://platform.openai.com/) (a paid subscription may be required).
14+
Able to choose OpenAI or Ollama as the LLM and set the environment variables for the selected LLM. If using OpenAI, an API key must be obtained from [OpenAI](https://platform.openai.com/) (a paid subscription may be required). Additionally, the embedding model used for RAG can be different from the selected LLM.
1515

1616
```
1717
# LLM OPENAI or OLLAMA

0 commit comments

Comments
 (0)