Skip to content

Commit 7a6e53b

Browse files
committed
update 'README.md'
1 parent af61759 commit 7a6e53b

5 files changed

+28
-6
lines changed

README.md

+28-6
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,9 @@ Quickly launch an intelligent customer service system with Flask, LLM, RAG, incl
2929
- [Configure the admin console](#configure-the-admin-console)
3030
- [Login to the admin console](#login-to-the-admin-console)
3131
- [Import your data](#import-your-data)
32+
- [import websites](#import-websites)
33+
- [import isolated urls](#import-isolated-urls)
34+
- [import local files](#import-local-files)
3235
- [Test the chatbot](#test-the-chatbot)
3336
- [Embed on your website](#embed-on-your-website)
3437
- [Dashboard of user's historical request](#dashboard-of-users-historical-request)
@@ -38,9 +41,9 @@ Quickly launch an intelligent customer service system with Flask, LLM, RAG, incl
3841

3942

4043
## Features
41-
- **Built-in LLM Support**: Provides integrated support for large language models.
44+
- **Built-in LLM Support**: Support cloud-based LLMs and local LLMs.
4245
- **Quick Setup**: Enables deployment of production-level conversational service robots within just five minutes.
43-
- **Simple Maintenance**: Only requires Python, with no need for additional middleware.
46+
- **Diverse Knowledge Base Integration**: Supports multiple types of knowledge bases, including websites, isolated URLs, and local files.
4447
- **Flexible Configuration**: Offers a user-friendly backend equipped with customizable settings for streamlined management.
4548
- **Attractive UI**: Features a customizable and visually appealing user interface.
4649

@@ -129,7 +132,7 @@ If your knowledge base involves **sensitive information** and you prefer not to
129132

130133

131134
> [!NOTE]
132-
> First, refer to `https://github.com/ollama/ollama` to **Install Ollama**, and download the embedding model `mxbai-embed-large` and the LLM model such as `llama3`.
135+
> First, refer to [ollama](https://github.com/ollama/ollama) to **Install Ollama**, and download the embedding model `mxbai-embed-large` and the LLM model such as `llama3`.
133136
134137

135138
```shell
@@ -253,16 +256,18 @@ On the page **`http://your-server-ip:7000/open-kf-admin/#/`**, you can set the f
253256

254257
### Import your data
255258

259+
#### Import websites
260+
256261
After submitting the website URL, once the server retrieves the list of all web page URLs via crawling, you can select the web page URLs you need as the knowledge base (all selected by default). The initial `Status` is **`Recorded`**.
257262

258263
<div align="center">
259-
<img style="display: block; margin: auto; width: 70%;" src="./doc/screenshot-4.jpg">
264+
<img style="display: block; margin: auto; width: 70%;" src="./doc/screenshot-12.jpg">
260265
</div>
261266

262-
You can actively refresh the page **`http://your-server-ip:7000/open-kf-admin/#/source`** in your browser to get the progress of web page URL processing. After the content of the web page URL has been crawled, and the Embedding calculation and storage are completed, you can see the corresponding `Size` in the admin console, and the `Status` will also be updated to **`Stored`**.
267+
You can actively refresh the page **`http://your-server-ip:7000/open-kf-admin/#/source`** in your browser to get the progress of web page URL processing. After the content of the web page URL has been crawled, and the Embedding calculation and storage are completed, you can see the corresponding `Size` in the admin console, and the `Status` will also be updated to **`Trained`**.
263268

264269
<div align="center">
265-
<img style="display: block; margin: auto; width: 70%;" src="./doc/screenshot-5.jpg">
270+
<img style="display: block; margin: auto; width: 70%;" src="./doc/screenshot-13.jpg">
266271
</div>
267272

268273
Clicking on a webpage's URL reveals how many sub-pages the webpage is divided into, and the text size of each sub-page.
@@ -277,6 +282,23 @@ Clicking on a sub-page allows you to view its full text content. This will be ve
277282
<img style="display: block; margin: auto; width: 70%;" src="./doc/screenshot-11.jpg">
278283
</div>
279284

285+
#### Import isolated urls
286+
287+
Collect the URLs of the required web pages. You can submit up to `10` web page URLs at a time, and these pages can be from different domains.
288+
289+
<div align="center">
290+
<img style="display: block; margin: auto; width: 70%;" src="./doc/screenshot-14.jpg">
291+
</div>
292+
293+
#### Import local files
294+
295+
Upload the required local files. You can upload up to `10` files at a time, and each file cannot exceed `30MB`. The following file types are currently supported: `[".txt", ".md", ".pdf", ".epub", ".mobi", ".html", ".docx", ".pptx", ".xlsx", ".csv"]`.
296+
297+
<div align="center">
298+
<img style="display: block; margin: auto; width: 70%;" src="./doc/screenshot-15.jpg">
299+
</div>
300+
301+
280302
### Test the chatbot
281303

282304
After importing website data in the admin console, you can experience the chatbot service through the link **`http://your-server-ip:7000/open-kf-chatbot/`**.

doc/screenshot-12.jpg

102 KB
Loading

doc/screenshot-13.jpg

174 KB
Loading

doc/screenshot-14.jpg

197 KB
Loading

doc/screenshot-15.jpg

159 KB
Loading

0 commit comments

Comments
 (0)