writinwaters commited on
Commit
376c8b6
·
1 Parent(s): dd62358

Miscellaneous updates (#769)

Browse files

### What problem does this PR solve?

_Briefly describe what this PR aims to solve. Include background context
that will help reviewers understand the purpose of the PR._

### Type of change

- [x] Documentation Update

Files changed (4) hide show
  1. README.md +2 -1
  2. README_ja.md +2 -1
  3. README_zh.md +2 -1
  4. docs/quickstart.md +5 -4
README.md CHANGED
@@ -26,7 +26,7 @@
26
 
27
  ## 💡 What is RAGFlow?
28
 
29
- [RAGFlow](https://demo.ragflow.io) is an open-source RAG (Retrieval-Augmented Generation) engine based on deep document understanding. It offers a streamlined RAG workflow for businesses of any scale, combining LLM (Large Language Models) to provide truthful question-answering capabilities, backed by well-founded citations from various complex formatted data.
30
 
31
  ## 📌 Latest Updates
32
 
@@ -274,6 +274,7 @@ $ systemctl start nginx
274
 
275
  ## 📚 Documentation
276
 
 
277
  - [FAQ](./docs/faq.md)
278
 
279
  ## 📜 Roadmap
 
26
 
27
  ## 💡 What is RAGFlow?
28
 
29
+ [RAGFlow](https://ragflow.io/) is an open-source RAG (Retrieval-Augmented Generation) engine based on deep document understanding. It offers a streamlined RAG workflow for businesses of any scale, combining LLM (Large Language Models) to provide truthful question-answering capabilities, backed by well-founded citations from various complex formatted data.
30
 
31
  ## 📌 Latest Updates
32
 
 
274
 
275
  ## 📚 Documentation
276
 
277
+ - [Quickstart](./docs/quickstart.md)
278
  - [FAQ](./docs/faq.md)
279
 
280
  ## 📜 Roadmap
README_ja.md CHANGED
@@ -26,7 +26,7 @@
26
 
27
  ## 💡 RAGFlow とは?
28
 
29
- [RAGFlow](https://demo.ragflow.io) は、深い文書理解に基づいたオープンソースの RAG (Retrieval-Augmented Generation) エンジンである。LLM(大規模言語モデル)を組み合わせることで、様々な複雑なフォーマットのデータから根拠のある引用に裏打ちされた、信頼できる質問応答機能を実現し、あらゆる規模のビジネスに適した RAG ワークフローを提供します。
30
 
31
  ## 📌 最新情報
32
 
@@ -252,6 +252,7 @@ $ bash ./entrypoint.sh
252
 
253
  ## 📚 ドキュメンテーション
254
 
 
255
  - [FAQ](./docs/faq.md)
256
 
257
  ## 📜 ロードマップ
 
26
 
27
  ## 💡 RAGFlow とは?
28
 
29
+ [RAGFlow](https://ragflow.io/) は、深い文書理解に基づいたオープンソースの RAG (Retrieval-Augmented Generation) エンジンである。LLM(大規模言語モデル)を組み合わせることで、様々な複雑なフォーマットのデータから根拠のある引用に裏打ちされた、信頼できる質問応答機能を実現し、あらゆる規模のビジネスに適した RAG ワークフローを提供します。
30
 
31
  ## 📌 最新情報
32
 
 
252
 
253
  ## 📚 ドキュメンテーション
254
 
255
+ - [Quickstart](./docs/quickstart.md)
256
  - [FAQ](./docs/faq.md)
257
 
258
  ## 📜 ロードマップ
README_zh.md CHANGED
@@ -26,7 +26,7 @@
26
 
27
  ## 💡 RAGFlow 是什么?
28
 
29
- [RAGFlow](https://demo.ragflow.io) 是一款基于深度文档理解构建的开源 RAG(Retrieval-Augmented Generation)引擎。RAGFlow 可以为各种规模的企业及个人提供一套精简的 RAG 工作流程,结合大语言模型(LLM)针对用户各类不同的复杂格式数据提供可靠的问答以及有理有据的引用。
30
 
31
  ## 📌 近期更新
32
 
@@ -271,6 +271,7 @@ $ systemctl start nginx
271
  ```
272
  ## 📚 技术文档
273
 
 
274
  - [FAQ](./docs/faq.md)
275
 
276
  ## 📜 路线图
 
26
 
27
  ## 💡 RAGFlow 是什么?
28
 
29
+ [RAGFlow](https://ragflow.io/) 是一款基于深度文档理解构建的开源 RAG(Retrieval-Augmented Generation)引擎。RAGFlow 可以为各种规模的企业及个人提供一套精简的 RAG 工作流程,结合大语言模型(LLM)针对用户各类不同的复杂格式数据提供可靠的问答以及有理有据的引用。
30
 
31
  ## 📌 近期更新
32
 
 
271
  ```
272
  ## 📚 技术文档
273
 
274
+ - [Quickstart](./docs/quickstart.md)
275
  - [FAQ](./docs/faq.md)
276
 
277
  ## 📜 路线图
docs/quickstart.md CHANGED
@@ -114,7 +114,7 @@ To add and configure an LLM:
114
 
115
  ![added available models](https://github.com/infiniflow/ragflow/assets/93570324/d08b80e4-f921-480a-b41d-11832489c916)
116
 
117
- 3. Click **System Mode Settings** to globally set the following models:
118
 
119
  - Chat model,
120
  - Embedding model,
@@ -140,7 +140,7 @@ To create your first knowledge base:
140
 
141
  3. RAGFlow offers multiple chunk templates that cater to different document layouts and file formats. Select the embedding model and chunk method (template) for your knowledge base.
142
 
143
- > IMPORTANT: Once you have selected an embedding model and used it to parse a file, you are no longer allowed to change it. The obvious reason is that we must ensure that all files in a specific knowledge base are parsed using the *same* embedding model.
144
 
145
  _You are taken to the **Dataset** page of your knowledge base._
146
 
@@ -180,14 +180,15 @@ RAGFlow features visibility and explainability, allowing you to view the chunkin
180
 
181
  Conversations in RAGFlow are based on a particular knowledge base or multiple knowledge bases. Once you have created your knowledge base and finished file parsing, you can go ahead and start an AI conversation.
182
 
183
- 1. Click the **Chat** tab in the middle top of the mage **>** **Create an assistant** to show the **Chat Configuration** dialogue of your next dialogue.
 
184
 
185
  2. Update **Assistant Setting**:
186
 
187
  - Name your assistant and specify your knowledge bases.
188
  - **Empty response**:
189
  - If you wish to *confine* RAGFlow's answers to your knowledge bases, leave a response here. Then when it doesn't retrieve an answer, it *uniformly* responds with what you set here.
190
- - If you wish RAGFlow to *improvise* when it doesn't retrieve an answer from your knowledge bases, leave it blank, while may give rise to hallucinations.
191
 
192
  3. Update **Prompt Engine** or leave it as is for the beginning.
193
 
 
114
 
115
  ![added available models](https://github.com/infiniflow/ragflow/assets/93570324/d08b80e4-f921-480a-b41d-11832489c916)
116
 
117
+ 3. Click **System Model Settings** to select the default models:
118
 
119
  - Chat model,
120
  - Embedding model,
 
140
 
141
  3. RAGFlow offers multiple chunk templates that cater to different document layouts and file formats. Select the embedding model and chunk method (template) for your knowledge base.
142
 
143
+ > IMPORTANT: Once you have selected an embedding model and used it to parse a file, you are no longer allowed to change it. The obvious reason is that we must ensure that all files in a specific knowledge base are parsed using the *same* embedding model (ensure that they are being compared in the same embedding space).
144
 
145
  _You are taken to the **Dataset** page of your knowledge base._
146
 
 
180
 
181
  Conversations in RAGFlow are based on a particular knowledge base or multiple knowledge bases. Once you have created your knowledge base and finished file parsing, you can go ahead and start an AI conversation.
182
 
183
+ 1. Click the **Chat** tab in the middle top of the mage **>** **Create an assistant** to show the **Chat Configuration** dialogue *of your next dialogue*.
184
+ > RAGFlow offer the flexibility of choosing a different chat model for each dialogue, while allowing you to set the default models in **System Model Settings**.
185
 
186
  2. Update **Assistant Setting**:
187
 
188
  - Name your assistant and specify your knowledge bases.
189
  - **Empty response**:
190
  - If you wish to *confine* RAGFlow's answers to your knowledge bases, leave a response here. Then when it doesn't retrieve an answer, it *uniformly* responds with what you set here.
191
+ - If you wish RAGFlow to *improvise* when it doesn't retrieve an answer from your knowledge bases, leave it blank, which may give rise to hallucinations.
192
 
193
  3. Update **Prompt Engine** or leave it as is for the beginning.
194