AI/ragflow
1
0
Fork 0
mirror of https://git.mirrors.martin98.com/https://github.com/infiniflow/ragflow.git synced 2025-08-14 14:35:52 +08:00
Code Issues Packages Projects Releases Wiki Activity

UI updates + RAGFlow image description (#3995)

Browse Source 
### What problem does this PR solve?



### Type of change

- [x] Documentation Update
This commit is contained in:
writinwaters 2024-12-12 09:57:52 +08:00 committed by GitHub
parent 6d19294ddc
commit bb8f97c9cd
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
11 changed files with 75 additions and 76 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@ -175,15 +175,14 @@ releases! 🌟
$ docker compose -f docker/docker-compose.yml up -d $ docker compose -f docker/docker-compose.yml up -d
``` ```
| RAGFLOW_IMAGE tag in docker/.env | size | Including embedding models and related Python packages? | comments | | RAGFlow image tag | Image size (GB) | Has embedding models? | Stable? |
| -------------------------------- | ----- | ------------------------------------------------------- | ---------------------- | | ----------------- | --------------- | --------------------- | ------------------------ |
| v0.14.1 | ~9 GB | YES | stable release | | v0.14.1 | ≈9 | :heavy_check_mark: | Stable release |
| v0.14.1-slim | ~2 GB | NO | stable release | | v0.14.1-slim | ≈2 | ❌ | Stable release |
| v0.15.0-dev1 | ~9 GB | YES | unstable beta release | | v0.15.0-dev1 | ≈9 | :heavy_check_mark: | *Unstable* beta release |
| v0.15.0-dev1-slim | ~2 GB | NO | unstable beta release | | v0.15.0-dev1-slim | ≈2 | ❌ | *Unstable* beta release |
| nightly | ~9 GB | YES | unstable nightly build | | nightly | ≈9 | :heavy_check_mark: | *Unstable* nightly build |
| nightly-slim | ~2 GB | NO | unstable nightly build | | nightly-slim | ≈2 | ❌ | *Unstable* nightly build |
4. Check the server status after having the server up and running: 4. Check the server status after having the server up and running:

18
README_id.md
View File

@ -168,16 +168,14 @@ Coba demo kami di [https://demo.ragflow.io](https://demo.ragflow.io).
$ docker compose -f docker/docker-compose.yml up -d $ docker compose -f docker/docker-compose.yml up -d
``` ```
| RAGFLOW_IMAGE tag in docker/.env | size | Including embedding models and related Python packages? | comments | | RAGFlow image tag | Image size (GB) | Has embedding models? | Stable? |
| -------------------------------- | ----- | ------------------------------------------------------- | ---------------------- | | ----------------- | --------------- | --------------------- | ------------------------ |
| v0.14.1 | ~9 GB | YES | stable release | | v0.14.1 | ≈9 | :heavy_check_mark: | Stable release |
| v0.14.1-slim | ~2 GB | NO | stable release | | v0.14.1-slim | ≈2 | ❌ | Stable release |
| v0.15.0-dev1 | ~9 GB | YES | unstable beta release | | v0.15.0-dev1 | ≈9 | :heavy_check_mark: | *Unstable* beta release |
| v0.15.0-dev1-slim | ~2 GB | NO | unstable beta release | | v0.15.0-dev1-slim | ≈2 | ❌ | *Unstable* beta release |
| nightly | ~9 GB | YES | unstable nightly build | | nightly | ≈9 | :heavy_check_mark: | *Unstable* nightly build |
| nightly-slim | ~2 GB | NO | unstable nightly build | | nightly-slim | ≈2 | ❌ | *Unstable* nightly build |
4. Periksa status server setelah server aktif dan berjalan: 4. Periksa status server setelah server aktif dan berjalan:

17
README_ja.md
View File

@ -148,15 +148,14 @@
$ docker compose -f docker/docker-compose.yml up -d $ docker compose -f docker/docker-compose.yml up -d
``` ```
| RAGFLOW_IMAGE tag in docker/.env | size | Including embedding models and related Python packages? | comments | | RAGFlow image tag | Image size (GB) | Has embedding models? | Stable? |
| -------------------------------- | ----- | ------------------------------------------------------- | ---------------------- | | ----------------- | --------------- | --------------------- | ------------------------ |
| v0.14.1 | ~9 GB | YES | stable release | | v0.14.1 | ≈9 | :heavy_check_mark: | Stable release |
| v0.14.1-slim | ~2 GB | NO | stable release | | v0.14.1-slim | ≈2 | ❌ | Stable release |
| v0.15.0-dev1 | ~9 GB | YES | unstable beta release | | v0.15.0-dev1 | ≈9 | :heavy_check_mark: | *Unstable* beta release |
| v0.15.0-dev1-slim | ~2 GB | NO | unstable beta release | | v0.15.0-dev1-slim | ≈2 | ❌ | *Unstable* beta release |
| nightly | ~9 GB | YES | unstable nightly build | | nightly | ≈9 | :heavy_check_mark: | *Unstable* nightly build |
| nightly-slim | ~2 GB | NO | unstable nightly build | | nightly-slim | ≈2 | ❌ | *Unstable* nightly build |
4. サーバーを立ち上げた後、サーバーの状態を確認する: 4. サーバーを立ち上げた後、サーバーの状態を確認する:

20
README_ko.md
View File

@ -152,18 +152,14 @@
$ docker compose -f docker/docker-compose.yml up -d $ docker compose -f docker/docker-compose.yml up -d
``` ```
| RAGFlow image tag | Image size (GB) | Has embedding models? | Stable? |
| RAGFLOW_IMAGE tag in docker/.env | size | Including embedding models and related Python packages? | comments | | ----------------- | --------------- | --------------------- | ------------------------ |
| -------------------------------- | ----- | ------------------------------------------------------- | ---------------------- | | v0.14.1 | ≈9 | :heavy_check_mark: | Stable release |
| v0.14.1 | ~9 GB | YES | stable release | | v0.14.1-slim | ≈2 | ❌ | Stable release |
| v0.14.1-slim | ~2 GB | NO | stable release | | v0.15.0-dev1 | ≈9 | :heavy_check_mark: | *Unstable* beta release |
| v0.15.0-dev1 | ~9 GB | YES | unstable beta release | | v0.15.0-dev1-slim | ≈2 | ❌ | *Unstable* beta release |
| v0.15.0-dev1-slim | ~2 GB | NO | unstable beta release | | nightly | ≈9 | :heavy_check_mark: | *Unstable* nightly build |
| nightly | ~9 GB | YES | unstable nightly build | | nightly-slim | ≈2 | ❌ | *Unstable* nightly build |
| nightly-slim | ~2 GB | NO | unstable nightly build |
4. 서버가 시작된 후 서버 상태를 확인하세요: 4. 서버가 시작된 후 서버 상태를 확인하세요:

17
README_zh.md
View File

@ -149,15 +149,14 @@
$ docker compose -f docker/docker-compose.yml up -d $ docker compose -f docker/docker-compose.yml up -d
``` ```
| RAGFLOW_IMAGE tag in docker/.env | 尺寸 | 内置 embedding 模型和相关 Python 库? | 描述 | | RAGFlow image tag | Image size (GB) | Has embedding models? | Stable? |
| -------------------------------- | ----- | ------------------------------------------------------- | ---------------------- | | ----------------- | --------------- | --------------------- | ------------------------ |
| v0.14.1 | ~9 GB | YES | stable release | | v0.14.1 | ≈9 | :heavy_check_mark: | Stable release |
| v0.14.1-slim | ~2 GB | NO | stable release | | v0.14.1-slim | ≈2 | ❌ | Stable release |
| v0.15.0-dev1 | ~9 GB | YES | unstable beta release | | v0.15.0-dev1 | ≈9 | :heavy_check_mark: | *Unstable* beta release |
| v0.15.0-dev1-slim | ~2 GB | NO | unstable beta release | | v0.15.0-dev1-slim | ≈2 | ❌ | *Unstable* beta release |
| nightly | ~9 GB | YES | unstable nightly build | | nightly | ≈9 | :heavy_check_mark: | *Unstable* nightly build |
| nightly-slim | ~2 GB | NO | unstable nightly build | | nightly-slim | ≈2 | ❌ | *Unstable* nightly build |
4. 服务器启动成功后再次确认服务器状态： 4. 服务器启动成功后再次确认服务器状态：

2
docs/guides/agentic_rag/general_purpose_chatbot.md
View File

@ -37,7 +37,7 @@ RAGFlow's no-code editor spares you the trouble of coding, making agent developm
Here’s a breakdown of each component and its role and requirements in the chatbot template: Here’s a breakdown of each component and its role and requirements in the chatbot template:
- **Begin** - **Begin**
- Function: Sets the opening greeting for the user. - Function: Sets an opening greeting for users.
- Purpose: Establishes a welcoming atmosphere and prepares the user for interaction. - Purpose: Establishes a welcoming atmosphere and prepares the user for interaction.
- **Interact** - **Interact**

26
docs/quickstart.mdx
View File

@ -6,6 +6,7 @@ slug: /
# Quick start # Quick start
import Tabs from '@theme/Tabs'; import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem'; import TabItem from '@theme/TabItem';
import APITable from '@site/src/components/APITable';
RAGFlow is an open-source RAG (Retrieval-Augmented Generation) engine based on deep document understanding. When integrated with LLMs, it is capable of providing truthful question-answering capabilities, backed by well-founded citations from various complex formatted data. RAGFlow is an open-source RAG (Retrieval-Augmented Generation) engine based on deep document understanding. When integrated with LLMs, it is capable of providing truthful question-answering capabilities, backed by well-founded citations from various complex formatted data.
@ -19,7 +20,7 @@ This quick start guide describes a general process from:
:::danger IMPORTANT :::danger IMPORTANT
We officially support x86 CPU and Nvidia GPU, and this document offers instructions on deploying RAGFlow using Docker on x86 platforms. While we also test RAGFlow on ARM64 platforms, we do not plan to maintain RAGFlow Docker images for ARM. We officially support x86 CPU and Nvidia GPU, and this document offers instructions on deploying RAGFlow using Docker on x86 platforms. While we also test RAGFlow on ARM64 platforms, we do not plan to maintain RAGFlow Docker images for ARM.
If you are on an ARM platform, following [this guide](https://ragflow.io/docs/dev/build_docker_image) to build a RAGFlow Docker image. If you are on an ARM platform, follow [this guide](https://ragflow.io/docs/dev/build_docker_image) to build a RAGFlow Docker image.
::: :::
## Prerequisites ## Prerequisites
@ -189,15 +190,22 @@ This section provides instructions on setting up the RAGFlow server on Linux. If
$ docker compose -f docker/docker-compose.yml up -d $ docker compose -f docker/docker-compose.yml up -d
``` ```
| RAGFLOW_IMAGE tag in docker/.env | size | Including embedding models and related Python packages? | comments | ```mdx-code-block
| -------------------------------- | ----- | ------------------------------------------------------- | ---------------------- | <APITable>
| v0.14.1 | ~9 GB | YES | stable release | ```
| v0.14.1-slim | ~2 GB | NO | stable release |
| v0.15.0-dev1 | ~9 GB | YES | unstable beta release |
| v0.15.0-dev1-slim | ~2 GB | NO | unstable beta release |
| nightly | ~9 GB | YES | unstable nightly build |
| nightly-slim | ~2 GB | NO | unstable nightly build |
| RAGFlow image tag | Image size (GB) | Has embedding models? | Stable? |
| ----------------- | --------------- | --------------------- | ------------------------ |
| v0.14.1 | &approx;9 | :heavy_check_mark: | Stable release |
| v0.14.1-slim | &approx;2 | ❌ | Stable release |
| v0.15.0-dev1 | &approx;9 | :heavy_check_mark: | *Unstable* beta release |
| v0.15.0-dev1-slim | &approx;2 | ❌ | *Unstable* beta release |
| nightly | &approx;9 | :heavy_check_mark: | *Unstable* nightly build |
| nightly-slim | &approx;2 | ❌ | *Unstable* nightly build |
```mdx-code-block
</APITable>
```
:::tip NOTE :::tip NOTE
A RAGFlow Docker image that includes embedding models and Python libraries is approximately 9GB in size and may take significantly longer time to load. A RAGFlow Docker image that includes embedding models and Python libraries is approximately 9GB in size and may take significantly longer time to load.

4
docs/references/http_api_reference.md
View File

@ -887,7 +887,7 @@ Failure:
--- ---
## Add chunks ## Add chunk
**POST** `/api/v1/datasets/{dataset_id}/documents/{document_id}/chunks` **POST** `/api/v1/datasets/{dataset_id}/documents/{document_id}/chunks`
@ -913,7 +913,7 @@ curl --request POST \
--header 'Authorization: Bearer <YOUR_API_KEY>' \ --header 'Authorization: Bearer <YOUR_API_KEY>' \
--data ' --data '
{ {
"content": "<SOME_CHUNK_CONTENT_HERE>" "content": "<CHUNK_CONTENT_HERE>"
}' }'
``` ```

2
docs/release_notes.md
View File

@ -208,7 +208,7 @@ Released on May 31, 2024.
:::danger IMPORTANT :::danger IMPORTANT
While we also test RAGFlow on ARM64 platforms, we do not plan to maintain RAGFlow Docker images for ARM. While we also test RAGFlow on ARM64 platforms, we do not plan to maintain RAGFlow Docker images for ARM.
If you are on an ARM platform, following [this guide](https://ragflow.io/docs/dev/build_docker_image) to build a RAGFlow Docker image. If you are on an ARM platform, follow [this guide](https://ragflow.io/docs/dev/build_docker_image) to build a RAGFlow Docker image.
::: :::
### Related APIs ### Related APIs

26
web/src/locales/en.ts
View File

@ -69,13 +69,13 @@ export default {
}, },
knowledgeList: { knowledgeList: {
welcome: 'Welcome back', welcome: 'Welcome back',
description: 'Which knowledge base are we going to use today?', description: 'Which knowledge bases will you use today?',
createKnowledgeBase: 'Create knowledge base', createKnowledgeBase: 'Create knowledge base',
name: 'Name', name: 'Name',
namePlaceholder: 'Please input name!', namePlaceholder: 'Please input name!',
doc: 'Docs', doc: 'Docs',
searchKnowledgePlaceholder: 'Search', searchKnowledgePlaceholder: 'Search',
noMoreData: 'It is all, nothing more', noMoreData: `That's all. Nothing more.`,
}, },
knowledgeDetails: { knowledgeDetails: {
dataset: 'Dataset', dataset: 'Dataset',
@ -340,20 +340,20 @@ The above is the content you need to summarize.`,
sendPlaceholder: 'Message the assistant...', sendPlaceholder: 'Message the assistant...',
chatConfiguration: 'Chat Configuration', chatConfiguration: 'Chat Configuration',
chatConfigurationDescription: chatConfigurationDescription:
' Here, dress up a dedicated assistant for your special knowledge bases! 💕', ' Set up a chat assistant dedicated to your selected knowledge bases here! 💕',
assistantName: 'Assistant name', assistantName: 'Assistant name',
assistantNameMessage: 'Assistant name is required', assistantNameMessage: 'Assistant name is required',
namePlaceholder: 'e.g. Resume Jarvis', namePlaceholder: 'e.g. Resume Jarvis',
assistantAvatar: 'Assistant avatar', assistantAvatar: 'Assistant avatar',
language: 'Language', language: 'Language',
emptyResponse: 'Empty response', emptyResponse: 'Empty response',
emptyResponseTip: `If nothing is retrieved with user's question in the knowledgebase, it will use this as an answer. If you want LLM comes up with its own opinion when nothing is retrieved, leave this blank.`, emptyResponseTip: `Set this as a response if no results are retrieved from the knowledge bases for your query, or leave this field blank to allow the LLM to improvise when nothing is found.`,
setAnOpener: 'Set an opener', setAnOpener: 'Set an opener',
setAnOpenerInitial: `Hi! I'm your assistant, what can I do for you?`, setAnOpenerInitial: `Hi! I'm your assistant, what can I do for you?`,
setAnOpenerTip: 'How do you want to welcome your clients?', setAnOpenerTip: 'Set an opening greeting for users.',
knowledgeBases: 'Knowledge bases', knowledgeBases: 'Knowledge bases',
knowledgeBasesMessage: 'Please select', knowledgeBasesMessage: 'Please select',
knowledgeBasesTip: 'Select knowledgebases associated.', knowledgeBasesTip: 'Select the knowledge bases to associate with this chat assistant.',
system: 'System', system: 'System',
systemInitialValue: `You are an intelligent assistant. Please summarize the content of the knowledge base to answer the question. Please list the data in the knowledge base and answer in detail. When all knowledge base content is irrelevant to the question, your answer must include the sentence "The answer you are looking for is not found in the knowledge base!" Answers need to consider chat history. systemInitialValue: `You are an intelligent assistant. Please summarize the content of the knowledge base to answer the question. Please list the data in the knowledge base and answer in detail. When all knowledge base content is irrelevant to the question, your answer must include the sentence "The answer you are looking for is not found in the knowledge base!" Answers need to consider chat history.
Here is the knowledge base: Here is the knowledge base:
@ -361,9 +361,9 @@ The above is the content you need to summarize.`,
The above is the knowledge base.`, The above is the knowledge base.`,
systemMessage: 'Please input!', systemMessage: 'Please input!',
systemTip: systemTip:
'Instructions you need LLM to follow when LLM answers questions, like charactor design, answer length and answer language etc.', 'Your prompts or instructions for the LLM, including but not limited to its role, the desired length, tone, and language of its answers.',
topN: 'Top N', topN: 'Top N',
topNTip: `Not all the chunks whose similarity score is above the 'simialrity threashold' will be feed to LLMs. LLM can only see these 'Top N' chunks.`, topNTip: `Not all chunks with similarity score above the 'similarity threshold' will be sent to the LLM. This selects 'Top N' chunks from the retrieved ones.`,
variable: 'Variable', variable: 'Variable',
variableTip: `If you use dialog APIs, the varialbes might help you chat with your clients with different strategies. variableTip: `If you use dialog APIs, the varialbes might help you chat with your clients with different strategies.
The variables are used to fill-in the 'System' part in prompt in order to give LLM a hint. The variables are used to fill-in the 'System' part in prompt in order to give LLM a hint.
@ -404,7 +404,7 @@ The above is the content you need to summarize.`,
maxTokensInvalidMessage: 'Please enter a valid number for Max Tokens.', maxTokensInvalidMessage: 'Please enter a valid number for Max Tokens.',
maxTokensMinMessage: 'Max Tokens cannot be less than 0.', maxTokensMinMessage: 'Max Tokens cannot be less than 0.',
quote: 'Show quote', quote: 'Show quote',
quoteTip: 'Should the source of the original text be displayed?', quoteTip: 'Whether to display the original text as a reference.',
selfRag: 'Self-RAG', selfRag: 'Self-RAG',
selfRagTip: 'Please refer to: https://huggingface.co/papers/2310.11511', selfRagTip: 'Please refer to: https://huggingface.co/papers/2310.11511',
overview: 'Chat ID', overview: 'Chat ID',
@ -433,7 +433,7 @@ The above is the content you need to summarize.`,
extensionTitle: 'Chrome Extension', extensionTitle: 'Chrome Extension',
tokenError: 'Please create API Token first!', tokenError: 'Please create API Token first!',
betaError: 'The beta field of the API Token cannot be empty!', betaError: 'The beta field of the API Token cannot be empty!',
searching: 'searching...', searching: 'Searching...',
parsing: 'Parsing', parsing: 'Parsing',
uploading: 'Uploading', uploading: 'Uploading',
uploadFailed: 'Upload failed', uploadFailed: 'Upload failed',
@ -441,12 +441,12 @@ The above is the content you need to summarize.`,
read: 'Read content', read: 'Read content',
tts: 'Text to speech', tts: 'Text to speech',
ttsTip: ttsTip:
'To play the voice using voice conversion, please select TTS (speech conversion model) in the settings first.', 'Ensure you select a TTS model on the Settings page before enabling this toggle to play text as audio.',
relatedQuestion: 'Related question', relatedQuestion: 'Related question',
answerTitle: 'R', answerTitle: 'R',
multiTurn: 'Multi-turn optimization', multiTurn: 'Multi-turn optimization',
multiTurnTip: multiTurnTip:
'In multi-round conversations, the query to the knowledge base is optimized. The large model will be called to consume additional tokens.', 'This optimizes user queries using context in a multi-round conversation. When enabled, it will consume additional LLM tokens.',
howUseId: 'How to use chat ID?', howUseId: 'How to use chat ID?',
description: 'Description of assistant', description: 'Description of assistant',
}, },
@ -456,7 +456,7 @@ The above is the content you need to summarize.`,
maxTokens: 'Max Tokens', maxTokens: 'Max Tokens',
maxTokensMessage: 'Max Tokens is required', maxTokensMessage: 'Max Tokens is required',
maxTokensTip: maxTokensTip:
'This sets the maximum length of the model’s output, measured in the number of tokens (words or pieces of words).', `This sets the maximum length of the model's output, measured in the number of tokens (words or pieces of words).`,
maxTokensInvalidMessage: 'Please enter a valid number for Max Tokens.', maxTokensInvalidMessage: 'Please enter a valid number for Max Tokens.',
maxTokensMinMessage: 'Max Tokens cannot be less than 0.', maxTokensMinMessage: 'Max Tokens cannot be less than 0.',
password: 'Password', password: 'Password',

2
web/src/locales/zh-traditional.ts
View File

@ -75,7 +75,7 @@ export default {
namePlaceholder: '請輸入名稱', namePlaceholder: '請輸入名稱',
doc: '文件', doc: '文件',
searchKnowledgePlaceholder: '搜索', searchKnowledgePlaceholder: '搜索',
noMoreData: 'It is all, nothing more', noMoreData: `That's all. Nothing more.`,
}, },
knowledgeDetails: { knowledgeDetails: {
dataset: '數據集', dataset: '數據集',