writinwaters commited on
Commit
236885d
·
1 Parent(s): dcd7f0f

Updated README and FAQ (#343)

Browse files

### What problem does this PR solve?

Issue link:#[Link the issue here]

### Type of change

- [x] Documentation Update

Files changed (2) hide show
  1. README.md +9 -5
  2. docs/faq.md +153 -0
README.md CHANGED
@@ -53,6 +53,13 @@
53
  - Multiple recall paired with fused re-ranking.
54
  - Intuitive APIs for seamless integration with business.
55
 
 
 
 
 
 
 
 
56
  ## 🔎 System Architecture
57
 
58
  <div align="center" style="margin-top:20px;margin-bottom:20px;">
@@ -170,12 +177,9 @@ $ chmod +x ./entrypoint.sh
170
  $ docker compose up -d
171
  ```
172
 
173
- ## 🆕 Latest Features
174
 
175
- - 2024-04-11 Support [Xinference](./docs/xinference.md) for local LLM deployment.
176
- - 2024-04-10 Add a new layout recognize model for method 'Laws'.
177
- - 2024-04-08 Support [Ollama](./docs/ollama.md) for local LLM deployment.
178
- - 2024-04-07 Support Chinese UI.
179
 
180
  ## 📜 Roadmap
181
 
 
53
  - Multiple recall paired with fused re-ranking.
54
  - Intuitive APIs for seamless integration with business.
55
 
56
+ ## 📌 Latest Features
57
+
58
+ - 2024-04-11 Support [Xinference](./docs/xinference.md) for local LLM deployment.
59
+ - 2024-04-10 Add a new layout recognization model to the 'Laws' method.
60
+ - 2024-04-08 Support [Ollama](./docs/ollama.md) for local LLM deployment.
61
+ - 2024-04-07 Support Chinese UI.
62
+
63
  ## 🔎 System Architecture
64
 
65
  <div align="center" style="margin-top:20px;margin-bottom:20px;">
 
177
  $ docker compose up -d
178
  ```
179
 
180
+ ## 📚 Documentation
181
 
182
+ - [FAQ](./docs/faq.md)
 
 
 
183
 
184
  ## 📜 Roadmap
185
 
docs/faq.md ADDED
@@ -0,0 +1,153 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # Frequently Asked Questions
2
+
3
+ ## General
4
+
5
+ ### What sets RAGFlow apart from other RAG products?
6
+
7
+ The "garbage in garbage out" status quo remains unchanged despite the fact that LLMs have advanced Natural Language Processing (NLP) significantly. In response, RAGFlow introduces two unique features compared to other Retrieval-Augmented Generation (RAG) products.
8
+
9
+ - Fine-grained document parsing: Document parsing involves images and tables, with the flexibility for you to intervene as needed.
10
+ - Traceable answers with reduced hallucinations: You can trust RAGFlow's responses as you can view the citations and references supporting them.
11
+
12
+ ### Which languages does RAGFlow support?
13
+
14
+ English, simplified Chinese, traditional Chinese for now.
15
+
16
+ ## Performance
17
+
18
+ ### Why does it take longer for RAGFlow to parse a document than LangChain?
19
+
20
+ We put painstaking effort into document pre-processing tasks like layout analysis, table structure recognition, and OCR (Optical Character Recognition) using our vision model. This contributes to the additional time required.
21
+
22
+ ## Feature
23
+
24
+ ### Which architectures or devices does RAGFlow support?
25
+
26
+ ARM64 and Ascend GPU are not supported.
27
+
28
+ ### Do you offer an API for integration with third-party applications?
29
+
30
+ These APIs are still in development. Contributions are welcome.
31
+
32
+ ### Do you support stream output?
33
+
34
+ No, this feature is still in development. Contributions are welcome.
35
+
36
+ ### Is it possible to share dialogue through URL?
37
+
38
+ This feature and the related APIs are still in development. Contributions are welcome.
39
+
40
+ ### Do you support multiple rounds of dialogues, i.e., referencing previous dialogues as context for the current dialogue?
41
+
42
+ This feature and the related APIs are still in development. Contributions are welcome.
43
+
44
+ ## Configurations
45
+
46
+ ### How to increase the length of RAGFlow responses?
47
+
48
+ Adjust the **Max Tokens** slider in **Model Setting**:
49
+
50
+ ![](https://github.com/infiniflow/ragflow/assets/93570324/6a9c3577-6f5c-496a-9b8d-bee7f98a9c3c)
51
+
52
+
53
+ ### What does Empty response mean? How to set it?
54
+
55
+ You limit what the system responds to what you specify in Empty response if nothing is retrieved from your knowledge base. If you do not specify anything in Empty response, you let your LLM improvise, giving it a chance to hallucinate.
56
+
57
+ ### Can I set the base URL for OpenAI somewhere?
58
+
59
+ ![](https://github.com/infiniflow/ragflow/assets/93570324/8cfb6fa4-8a97-415d-b9fa-b6f405a055f3)
60
+
61
+
62
+ ### How to run RAGFlow with a locally deployed LLM?
63
+
64
+ You can use Ollama to deploy local LLM. See [here](https://github.com/infiniflow/ragflow/blob/main/docs/ollama.md) for more information.
65
+
66
+ ### How to link up ragflow and ollama servers?
67
+
68
+ - If RAGFlow is locally deployed, ensure that your RAGFlow and Ollama are in the same LAN.
69
+ - If you are using our online demo, ensure that the IP address of your Ollama server is public and accessible.
70
+
71
+ ### How to configure RAGFlow to respond with 100% matched results, rather than utilizing LLM?
72
+
73
+ In Configuration, choose **Q&A** as the chunk method:
74
+
75
+ ![](https://github.com/infiniflow/ragflow/assets/93570324/b119f201-ddc2-425f-ab6d-e82fa7b7ce8c)
76
+
77
+ ## Debugging
78
+
79
+ ### How to handle `WARNING: can't find /raglof/rag/res/borker.tm`?
80
+
81
+ Ignore this warning and continue. All system warnings can be ignored.
82
+
83
+ ### How to handle `Realtime synonym is disabled, since no redis connection`?
84
+
85
+ Ignore this warning and continue. All system warnings can be ignored.
86
+
87
+ ![](https://github.com/infiniflow/ragflow/assets/93570324/ef5a6194-084a-4fe3-bdd5-1c025b40865c)
88
+
89
+ ### Why does it take so long to parse a 2MB document?
90
+
91
+ Parsing requests have to wait in queue due to limited server resources. We are currently enhancing our algorithms and increasing computing power.
92
+
93
+ ### How to handle `Index failure`?
94
+
95
+ An index failure usually indicates an unavailable Elasticsearch service.
96
+
97
+ ### How to check the log of RAGFlow?
98
+
99
+ ```bash
100
+ tail -f path_to_ragflow/docker/ragflow-logs/rag/*.log
101
+ ```
102
+
103
+ ### How to check the status of each component in RAGFlow?
104
+
105
+ ```bash
106
+ $ docker ps
107
+ ```
108
+ *The system displays the following if all your RAGFlow components are running properly:*
109
+
110
+ ```
111
+ 5bc45806b680 infiniflow/ragflow:v1.0 "./entrypoint.sh" 11 hours ago Up 11 hours 0.0.0.0:80->80/tcp, :::80->80/tcp, 0.0.0.0:443->443/tcp, :::443->443/tcp, 0.0.0.0:9380->9380/tcp, :::9380->9380/tcp ragflow-server
112
+ 91220e3285dd docker.elastic.co/elasticsearch/elasticsearch:8.11.3 "/bin/tini -- /usr/l…" 11 hours ago Up 11 hours (healthy) 9300/tcp, 0.0.0.0:9200->9200/tcp, :::9200->9200/tcp ragflow-es-01
113
+ d8c86f06c56b mysql:5.7.18 "docker-entrypoint.s…" 7 days ago Up 16 seconds (healthy) 0.0.0.0:3306->3306/tcp, :::3306->3306/tcp ragflow-mysql
114
+ cd29bcb254bc quay.io/minio/minio:RELEASE.2023-12-20T01-00-02Z "/usr/bin/docker-ent…" 2 weeks ago Up 11 hours 0.0.0.0:9001->9001/tcp, :::9001->9001/tcp, 0.0.0.0:9000->9000/tcp, :::9000->9000/tcp ragflow-minio
115
+ ```
116
+
117
+ ### How to handle `Exception: Can't connect to ES cluster`?
118
+
119
+ 1. Check the status of your Elasticsearch component:
120
+
121
+ ```bash
122
+ $ docker ps
123
+ ```
124
+ *The status of a 'healthy' Elasticsearch component in your RAGFlow should look as follows:*
125
+ ```
126
+ 91220e3285dd docker.elastic.co/elasticsearch/elasticsearch:8.11.3 "/bin/tini -- /usr/l…" 11 hours ago Up 11 hours (healthy) 9300/tcp, 0.0.0.0:9200->9200/tcp, :::9200->9200/tcp ragflow-es-01
127
+ ```
128
+
129
+ 2. If your container keeps restarting, ensure `vm.max_map_count` >= 262144 as per [this README](https://github.com/infiniflow/ragflow?tab=readme-ov-file#-start-up-the-server).
130
+
131
+
132
+ 3. If your issue persists, ensure that the ES host setting is correct:
133
+
134
+ - If you are running RAGFlow with Docker, it is in **docker/service_conf.yml**. Set it as follows:
135
+ ```
136
+ es:
137
+ hosts: 'http://es01:9200'
138
+ ```
139
+ - - If you run RAGFlow outside of Docker, verify the ES host setting in **conf/service_conf.yml** using:
140
+ ```bash
141
+ curl http://<IP_OF_ES>:<PORT_OF_ES>
142
+ ```
143
+
144
+
145
+ ### How to handle `{"data":null,"retcode":100,"retmsg":"<NotFound '404: Not Found'>"}`?
146
+
147
+ Your IP address or port number may be incorrect. If you are using the default configurations, enter http://<IP_OF_YOUR_MACHINE> (NOT `localhost`, NOT 9380, AND NO PORT NUMBER REQUIRED!) in your browser. This should work.
148
+
149
+
150
+
151
+
152
+
153
+