writinwaters commited on
Commit
5245317
·
1 Parent(s): c87ddd7

0509 faq (#693)

Browse files

### What problem does this PR solve?

Editorial updates only.

### Type of change

- [x] Documentation Update

Files changed (2) hide show
  1. README.md +2 -2
  2. docs/faq.md +8 -7
README.md CHANGED
@@ -58,12 +58,12 @@
58
 
59
  ## 📌 Latest Features
60
 
61
- - 2024-05-08 Integrates LLM DeepSeek.
62
  - 2024-04-26 Adds file management.
63
  - 2024-04-19 Supports conversation API ([detail](./docs/conversation_api.md)).
64
  - 2024-04-16 Integrates an embedding model 'bce-embedding-base_v1' from [BCEmbedding](https://github.com/netease-youdao/BCEmbedding), and [FastEmbed](https://github.com/qdrant/fastembed), which is designed specifically for light and speedy embedding.
65
  - 2024-04-11 Supports [Xinference](./docs/xinference.md) for local LLM deployment.
66
- - 2024-04-10 Adds a new layout recognition model for analyzing Laws documentation.
67
  - 2024-04-08 Supports [Ollama](./docs/ollama.md) for local LLM deployment.
68
  - 2024-04-07 Supports Chinese UI.
69
 
 
58
 
59
  ## 📌 Latest Features
60
 
61
+ - 2024-05-08 Integrates LLM DeepSeek-V2.
62
  - 2024-04-26 Adds file management.
63
  - 2024-04-19 Supports conversation API ([detail](./docs/conversation_api.md)).
64
  - 2024-04-16 Integrates an embedding model 'bce-embedding-base_v1' from [BCEmbedding](https://github.com/netease-youdao/BCEmbedding), and [FastEmbed](https://github.com/qdrant/fastembed), which is designed specifically for light and speedy embedding.
65
  - 2024-04-11 Supports [Xinference](./docs/xinference.md) for local LLM deployment.
66
+ - 2024-04-10 Adds a new layout recognition model for analyzing legal documents.
67
  - 2024-04-08 Supports [Ollama](./docs/ollama.md) for local LLM deployment.
68
  - 2024-04-07 Supports Chinese UI.
69
 
docs/faq.md CHANGED
@@ -367,11 +367,11 @@ You can use Ollama to deploy local LLM. See [here](https://github.com/infiniflow
367
  2. Right click the desired knowledge base to display the **Configuration** dialogue.
368
  3. Choose **Q&A** as the chunk method and click **Save** to confirm your change.
369
 
370
- ### 7 Do I need to connect to Redis?
371
 
372
  No, connecting to Redis is not required.
373
 
374
- ### 8 `Error: Range of input length should be [1, 30000]`
375
 
376
  This error occurs because there are too many chunks matching your search criteria. Try reducing the **TopN** and increasing **Similarity threshold** to fix this issue:
377
 
@@ -382,14 +382,15 @@ This error occurs because there are too many chunks matching your search criteri
382
 
383
  ![topn](https://github.com/infiniflow/ragflow/assets/93570324/7ec72ab3-0dd2-4cff-af44-e2663b67b2fc)
384
 
385
- ### 9 How to upgrade RAGFlow?
386
 
387
- You can upgrade RAGFlow to either the dev version or the latest version
 
388
  - Dev versions are for developers and contributors. They are published on a nightly basis and may crash because they are not fully tested. We cannot guarantee their validity and you are at your own risk trying out latest, untested features.
389
- - The latest version is stable and reliable, and works best with RAGFlow users.
390
 
391
 
392
- Update RAGFlow to dev version:
393
 
394
  1. Pull the latest source code
395
  ```bash
@@ -411,7 +412,7 @@ This error occurs because there are too many chunks matching your search criteri
411
  docker compose -f docker-compose-CN.yml up -d
412
  ```
413
 
414
- To upgrade RAGFlow to latest version:
415
 
416
  1. Update **ragflow/docker/.env** as follows:
417
  ```bash
 
367
  2. Right click the desired knowledge base to display the **Configuration** dialogue.
368
  3. Choose **Q&A** as the chunk method and click **Save** to confirm your change.
369
 
370
+ ### 7. Do I need to connect to Redis?
371
 
372
  No, connecting to Redis is not required.
373
 
374
+ ### 8. `Error: Range of input length should be [1, 30000]`
375
 
376
  This error occurs because there are too many chunks matching your search criteria. Try reducing the **TopN** and increasing **Similarity threshold** to fix this issue:
377
 
 
382
 
383
  ![topn](https://github.com/infiniflow/ragflow/assets/93570324/7ec72ab3-0dd2-4cff-af44-e2663b67b2fc)
384
 
385
+ ### 9. How to upgrade RAGFlow?
386
 
387
+ You can upgrade RAGFlow to either the dev version or the latest version:
388
+
389
  - Dev versions are for developers and contributors. They are published on a nightly basis and may crash because they are not fully tested. We cannot guarantee their validity and you are at your own risk trying out latest, untested features.
390
+ - The latest version refers to the most recent, officially published release. It is stable and works best with regular users.
391
 
392
 
393
+ To upgrade RAGFlow to the dev version:
394
 
395
  1. Pull the latest source code
396
  ```bash
 
412
  docker compose -f docker-compose-CN.yml up -d
413
  ```
414
 
415
+ To upgrade RAGFlow to the latest version:
416
 
417
  1. Update **ragflow/docker/.env** as follows:
418
  ```bash