Skip to content

Commit

Permalink
Updated FAQ plus miscellaneous updates. (#364)
Browse files Browse the repository at this point in the history
### What problem does this PR solve?

### Type of change

- [x] Documentation Update
  • Loading branch information
writinwaters committed Apr 15, 2024
1 parent 826ad6a commit ec76585
Show file tree
Hide file tree
Showing 4 changed files with 28 additions and 20 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@
## 📌 Latest Features

- 2024-04-11 Support [Xinference](./docs/xinference.md) for local LLM deployment.
- 2024-04-10 Add a new layout recognization model to the 'Laws' method.
- 2024-04-10 Add a new layout recognization model for analyzing Laws documentation.
- 2024-04-08 Support [Ollama](./docs/ollama.md) for local LLM deployment.
- 2024-04-07 Support Chinese UI.

Expand Down
14 changes: 9 additions & 5 deletions README_ja.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,13 @@
- 複数の想起と融合された再ランク付け。
- 直感的な API によってビジネスとの統合がシームレスに。

## 📌 最新の機能

- 2024-04-11 ローカル LLM デプロイメント用に [Xinference](./docs/xinference.md) をサポートします。
- 2024-04-10 メソッド「Laws」に新しいレイアウト認識モデルを追加します。
- 2024-04-08 [Ollama](./docs/ollama.md) を使用した大規模モデルのローカライズされたデプロイメントをサポートします。
- 2024-04-07 中国語インターフェースをサポートします。

## 🔎 システム構成

<div align="center" style="margin-top:20px;margin-bottom:20px;">
Expand Down Expand Up @@ -170,12 +177,9 @@ $ chmod +x ./entrypoint.sh
$ docker compose up -d
```

## 🆕 最新の新機能
## 📚 ドキュメンテーション

- 2024-04-11 ローカル LLM デプロイメント用に [Xinference](./docs/xinference.md) をサポートします。
- 2024-04-10 メソッド「Laws」に新しいレイアウト認識モデルを追加します。
- 2024-04-08 [Ollama](./docs/ollama.md) を使用した大規模モデルのローカライズされたデプロイメントをサポートします。
- 2024-04-07 中国語インターフェースをサポートします。
- [FAQ](./docs/faq.md)

## 📜 ロードマップ

Expand Down
14 changes: 9 additions & 5 deletions README_zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,13 @@
- 基于多路召回、融合重排序。
- 提供易用的 API,可以轻松集成到各类企业系统。

## 📌 新增功能

- 2024-04-11 支持用 [Xinference](./docs/xinference.md) 本地化部署大模型。
- 2024-04-10 为‘Laws’版面分析增加了底层模型。
- 2024-04-08 支持用 [Ollama](./docs/ollama.md) 本地化部署大模型。
- 2024-04-07 支持中文界面。

## 🔎 系统架构

<div align="center" style="margin-top:20px;margin-bottom:20px;">
Expand Down Expand Up @@ -170,12 +177,9 @@ $ chmod +x ./entrypoint.sh
$ docker compose up -d
```

## 🆕 最近新特性
## 📚 技术文档

- 2024-04-11 支持用 [Xinference](./docs/xinference.md) for local LLM deployment.
- 2024-04-10 为‘Laws’版面分析增加了模型。
- 2024-04-08 支持用 [Ollama](./docs/ollama.md) 对大模型进行本地化部署。
- 2024-04-07 支持中文界面。
- [FAQ](./docs/faq.md)

## 📜 路线图

Expand Down
18 changes: 9 additions & 9 deletions docs/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,14 +45,14 @@ This feature and the related APIs are still in development. Contributions are we

### How to increase the length of RAGFlow responses?

Adjust the **Max Tokens** slider in **Model Setting**:

![](https://github.com/infiniflow/ragflow/assets/93570324/6a9c3577-6f5c-496a-9b8d-bee7f98a9c3c)
1. Right click the desired dialog to display the **Chat Configuration** window.
2. Switch to the **Model Setting** tab and adjust the **Max Tokens** slider to get the desired length.
3. Click **OK** to confirm your change.


### What does Empty response mean? How to set it?

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.
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.

### Can I set the base URL for OpenAI somewhere?

Expand All @@ -70,9 +70,9 @@ You can use Ollama to deploy local LLM. See [here](https://github.com/infiniflow

### How to configure RAGFlow to respond with 100% matched results, rather than utilizing LLM?

In Configuration, choose **Q&A** as the chunk method:

![](https://github.com/infiniflow/ragflow/assets/93570324/b119f201-ddc2-425f-ab6d-e82fa7b7ce8c)
1. Click the **Knowledge Base** tab in the middle top of the page.
2. Right click the desired knowledge base to display the **Configuration** dialogue.
3. Choose **Q&A** as the chunk method and click **Save** to confirm your change.

## Debugging

Expand Down Expand Up @@ -136,15 +136,15 @@ $ docker ps
es:
hosts: 'http://es01:9200'
```
- - If you run RAGFlow outside of Docker, verify the ES host setting in **conf/service_conf.yml** using:
- If you run RAGFlow outside of Docker, verify the ES host setting in **conf/service_conf.yml** using:
```bash
curl http://<IP_OF_ES>:<PORT_OF_ES>
```


### How to handle `{"data":null,"retcode":100,"retmsg":"<NotFound '404: Not Found'>"}`?

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.
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.



Expand Down

0 comments on commit ec76585

Please sign in to comment.