From 8406a5ea47dbd80b2fe7191a69def2cba1c02e02 Mon Sep 17 00:00:00 2001 From: Jin Hai Date: Wed, 12 Nov 2025 14:20:04 +0800 Subject: [PATCH 1/3] Fix typos (#11208) ### What problem does this PR solve? As title ### Type of change - [x] Documentation Update Signed-off-by: Jin Hai --- docs/develop/mcp/launch_mcp_server.md | 2 +- docs/faq.mdx | 4 ++-- docs/guides/accessing_admin_ui.md | 2 +- docs/guides/agent/agent_component_reference/agent.mdx | 8 ++++---- .../guides/agent/agent_component_reference/categorize.mdx | 4 ++-- docs/guides/agent/agent_component_reference/code.mdx | 4 ++-- .../guides/agent/agent_component_reference/execute_sql.md | 6 +++--- docs/guides/agent/agent_component_reference/parser.md | 4 ++-- docs/guides/agent/agent_component_reference/retrieval.mdx | 2 +- .../guides/agent/agent_component_reference/transformer.md | 2 +- .../best_practices/accelerate_agent_question_answering.md | 2 +- docs/guides/chat/start_chat.md | 2 +- docs/guides/dataset/autokeyword_autoquestion.mdx | 2 +- docs/guides/dataset/construct_knowledge_graph.md | 2 +- docs/guides/dataset/enable_excel2html.md | 2 +- docs/guides/dataset/enable_raptor.md | 4 ++-- docs/guides/dataset/select_pdf_parser.md | 8 ++++---- docs/guides/dataset/set_metadata.md | 2 +- docs/guides/dataset/use_tag_sets.md | 2 +- docs/guides/migration/migrate_from_docker_compose.md | 2 +- docs/guides/team/join_or_leave_team.md | 2 +- 21 files changed, 34 insertions(+), 34 deletions(-) diff --git a/docs/develop/mcp/launch_mcp_server.md b/docs/develop/mcp/launch_mcp_server.md index 7544ed4de..53aff485c 100644 --- a/docs/develop/mcp/launch_mcp_server.md +++ b/docs/develop/mcp/launch_mcp_server.md @@ -60,7 +60,7 @@ Where: ### Transports -The RAGFlow MCP server supports two transports: the legacy SSE transport (served at `/sse`), introduced on November 5, 2024 and deprecated on March 26, 2025, and the streamable-HTTP transport (served at `/mcp`). The legacy SSE transport and the streamable HTTP transport with JSON responses are enabled by default. To disable either transport, use the flags `--no-transport-sse-enabled` or `--no-transport-streamable-http-enabled`. To disable JSON responses for the streamable HTTP transport, use the `--no-json-response` flag. +The RAGFlow MCP server supports two transports: the legacy SSE transport (served at `/sse`), introduced on November 5, 2024, and deprecated on March 26, 2025, and the streamable-HTTP transport (served at `/mcp`). The legacy SSE transport and the streamable HTTP transport with JSON responses are enabled by default. To disable either transport, use the flags `--no-transport-sse-enabled` or `--no-transport-streamable-http-enabled`. To disable JSON responses for the streamable HTTP transport, use the `--no-json-response` flag. ### Launch from Docker diff --git a/docs/faq.mdx b/docs/faq.mdx index c80b2740c..84203c6a3 100644 --- a/docs/faq.mdx +++ b/docs/faq.mdx @@ -193,7 +193,7 @@ This error suggests that you do not have Internet access or are unable to connec --- -### `WARNING: can't find /raglof/rag/res/borker.tm` +### `WARNING: can't find /ragflow/rag/res/borker.tm` Ignore this warning and continue. All system warnings can be ignored. @@ -413,7 +413,7 @@ See [here](./guides/models/deploy_local_llm.mdx) for more information. For a locally deployed RAGFlow: the total file size limit per upload is 1GB, with a batch upload limit of 32 files. There is no cap on the total number of files per account. To update this 1GB file size limit: -- In **docker/.env**, upcomment `# MAX_CONTENT_LENGTH=1073741824`, adjust the value as needed, and note that `1073741824` represents 1GB in bytes. +- In **docker/.env**, uncomment `# MAX_CONTENT_LENGTH=1073741824`, adjust the value as needed, and note that `1073741824` represents 1GB in bytes. - If you update the value of `MAX_CONTENT_LENGTH` in **docker/.env**, ensure that you update `client_max_body_size` in **nginx/nginx.conf** accordingly. :::tip NOTE diff --git a/docs/guides/accessing_admin_ui.md b/docs/guides/accessing_admin_ui.md index b2b096729..52ff4d6c7 100644 --- a/docs/guides/accessing_admin_ui.md +++ b/docs/guides/accessing_admin_ui.md @@ -24,7 +24,7 @@ The service status page displays of all services within the RAGFlow system. - **Search**: Use the search bar to quickly find services by **Name** or **Service Type**. - **Actions** (hover over a row to see action buttons): - **Extra Info**: Display additional configuration information of a service in a dialog. - - **Service Details**: Display detailed status information of a service in a dialog. According to services's type, a service's status information could be displayed as a plain text, a key-value data list, a data table or a bar chart. + - **Service Details**: Display detailed status information of a service in a dialog. According to service's type, a service's status information could be displayed as a plain text, a key-value data list, a data table or a bar chart. ### User management diff --git a/docs/guides/agent/agent_component_reference/agent.mdx b/docs/guides/agent/agent_component_reference/agent.mdx index dd358f062..cdd508cce 100644 --- a/docs/guides/agent/agent_component_reference/agent.mdx +++ b/docs/guides/agent/agent_component_reference/agent.mdx @@ -59,7 +59,7 @@ The **+ Add tools** and **+ Add agent** sections are used *only* when you need t ### 6. Choose the next component -When necessary, click the **+** button on the **Agent** component to choose the next component in the worflow from the dropdown list. +When necessary, click the **+** button on the **Agent** component to choose the next component in the workflow from the dropdown list. ## Connect to an MCP server as a client @@ -97,7 +97,7 @@ Update your MCP server's name, URL (including the API key), server type, and oth To ensure reliable tool calls, you may specify within the system prompt which tasks should trigger each tool call. -### 6. View the availabe tools of your MCP server +### 6. View the available tools of your MCP server On the canvas, click the newly-populated Tavily server to view and select its available tools: @@ -113,7 +113,7 @@ Click the dropdown menu of **Model** to show the model configuration window. - **Model**: The chat model to use. - Ensure you set the chat model correctly on the **Model providers** page. - You can use different models for different components to increase flexibility or improve overall performance. -- **Creavity**: A shortcut to **Temperature**, **Top P**, **Presence penalty**, and **Frequency penalty** settings, indicating the freedom level of the model. From **Improvise**, **Precise**, to **Balance**, each preset configuration corresponds to a unique combination of **Temperature**, **Top P**, **Presence penalty**, and **Frequency penalty**. +- **Creativity**: A shortcut to **Temperature**, **Top P**, **Presence penalty**, and **Frequency penalty** settings, indicating the freedom level of the model. From **Improvise**, **Precise**, to **Balance**, each preset configuration corresponds to a unique combination of **Temperature**, **Top P**, **Presence penalty**, and **Frequency penalty**. This parameter has three options: - **Improvise**: Produces more creative responses. - **Precise**: (Default) Produces more conservative responses. @@ -137,7 +137,7 @@ Click the dropdown menu of **Model** to show the model configuration window. :::tip NOTE - It is not necessary to stick with the same model for all components. If a specific model is not performing well for a particular task, consider using a different one. -- If you are uncertain about the mechanism behind **Temperature**, **Top P**, **Presence penalty**, and **Frequency penalty**, simply choose one of the three options of **Creavity**. +- If you are uncertain about the mechanism behind **Temperature**, **Top P**, **Presence penalty**, and **Frequency penalty**, simply choose one of the three options of **Creativity**. ::: ### System prompt diff --git a/docs/guides/agent/agent_component_reference/categorize.mdx b/docs/guides/agent/agent_component_reference/categorize.mdx index 39cc7c4b2..a40cc3731 100644 --- a/docs/guides/agent/agent_component_reference/categorize.mdx +++ b/docs/guides/agent/agent_component_reference/categorize.mdx @@ -42,7 +42,7 @@ Click the dropdown menu of **Model** to show the model configuration window. - **Model**: The chat model to use. - Ensure you set the chat model correctly on the **Model providers** page. - You can use different models for different components to increase flexibility or improve overall performance. -- **Creavity**: A shortcut to **Temperature**, **Top P**, **Presence penalty**, and **Frequency penalty** settings, indicating the freedom level of the model. From **Improvise**, **Precise**, to **Balance**, each preset configuration corresponds to a unique combination of **Temperature**, **Top P**, **Presence penalty**, and **Frequency penalty**. +- **Creativity**: A shortcut to **Temperature**, **Top P**, **Presence penalty**, and **Frequency penalty** settings, indicating the freedom level of the model. From **Improvise**, **Precise**, to **Balance**, each preset configuration corresponds to a unique combination of **Temperature**, **Top P**, **Presence penalty**, and **Frequency penalty**. This parameter has three options: - **Improvise**: Produces more creative responses. - **Precise**: (Default) Produces more conservative responses. @@ -66,7 +66,7 @@ Click the dropdown menu of **Model** to show the model configuration window. :::tip NOTE - It is not necessary to stick with the same model for all components. If a specific model is not performing well for a particular task, consider using a different one. -- If you are uncertain about the mechanism behind **Temperature**, **Top P**, **Presence penalty**, and **Frequency penalty**, simply choose one of the three options of **Creavity**. +- If you are uncertain about the mechanism behind **Temperature**, **Top P**, **Presence penalty**, and **Frequency penalty**, simply choose one of the three options of **Creativity**. ::: ### Message window size diff --git a/docs/guides/agent/agent_component_reference/code.mdx b/docs/guides/agent/agent_component_reference/code.mdx index 3d90496e1..91c6a316f 100644 --- a/docs/guides/agent/agent_component_reference/code.mdx +++ b/docs/guides/agent/agent_component_reference/code.mdx @@ -163,7 +163,7 @@ pandas requests openpyxl # here it is -(ragflow) ➜ ragflow/sandbox main ✗ make # rebuild the docker image, this command will rebuild the iamge and start the service immediately. To build image only, using `make build` instead. +(ragflow) ➜ ragflow/sandbox main ✗ make # rebuild the docker image, this command will rebuild the image and start the service immediately. To build image only, using `make build` instead. (ragflow) ➜ ragflow/sandbox main ✗ docker exec -it sandbox_python_0 /bin/bash # entering container to check if the package is installed @@ -189,7 +189,7 @@ To import your JavaScript packages, navigate to `sandbox_base_image/nodejs` and (ragflow) ➜ ragflow/sandbox/sandbox_base_image/nodejs main ✓ cd ../.. # go back to sandbox root directory -(ragflow) ➜ ragflow/sandbox main ✗ make # rebuild the docker image, this command will rebuild the iamge and start the service immediately. To build image only, using `make build` instead. +(ragflow) ➜ ragflow/sandbox main ✗ make # rebuild the docker image, this command will rebuild the image and start the service immediately. To build image only, using `make build` instead. (ragflow) ➜ ragflow/sandbox main ✗ docker exec -it sandbox_nodejs_0 /bin/bash # entering container to check if the package is installed diff --git a/docs/guides/agent/agent_component_reference/execute_sql.md b/docs/guides/agent/agent_component_reference/execute_sql.md index f74bc32ad..47561eccb 100644 --- a/docs/guides/agent/agent_component_reference/execute_sql.md +++ b/docs/guides/agent/agent_component_reference/execute_sql.md @@ -40,12 +40,12 @@ For dynamic SQL queries, you can include variables in your SQL queries, such as ### Database type -The supported database type. Currently the following database types are available: +The supported database type. Currently, the following database types are available: - MySQL -- PostreSQL +- PostgreSQL - MariaDB -- Microsoft SQL Server (Myssql) +- Microsoft SQL Server (Mssql) ### Database diff --git a/docs/guides/agent/agent_component_reference/parser.md b/docs/guides/agent/agent_component_reference/parser.md index 74d67b82d..55adcc132 100644 --- a/docs/guides/agent/agent_component_reference/parser.md +++ b/docs/guides/agent/agent_component_reference/parser.md @@ -9,7 +9,7 @@ A component that sets the parsing rules for your dataset. --- -A **Parser** component is auto-populated on the ingestion pipeline canvas and required in all ingestion pipeline workflows. Just like the **Extract** stage in the traditional ETL process, a **Parser** component in an ingestion pipeline defines how various file types are parsed into structured data. Click the component to display its configuration panel. In this configuration panel, you set the parsing rules for various file types. +A **Parser** component is autopopulated on the ingestion pipeline canvas and required in all ingestion pipeline workflows. Just like the **Extract** stage in the traditional ETL process, a **Parser** component in an ingestion pipeline defines how various file types are parsed into structured data. Click the component to display its configuration panel. In this configuration panel, you set the parsing rules for various file types. ## Configurations @@ -39,7 +39,7 @@ The output of a PDF parser is `json`. In the PDF parser, you select the parsing - [Docling](https://github.com/docling-project/docling): (Experimental) An open-source document processing tool for gen AI. - A third-party visual model from a specific model provider. -:::danger IMPORTANG +:::danger IMPORTANT MinerU PDF document parsing is available starting from v0.22.0. RAGFlow supports MinerU (>= 2.6.3) as an optional PDF parser with multiple backends. RAGFlow acts only as a client for MinerU, calling it to parse documents, reading the output files, and ingesting the parsed content. To use this feature, follow these steps: 1. Prepare MinerU: diff --git a/docs/guides/agent/agent_component_reference/retrieval.mdx b/docs/guides/agent/agent_component_reference/retrieval.mdx index 1ccd9e744..1f88669cf 100644 --- a/docs/guides/agent/agent_component_reference/retrieval.mdx +++ b/docs/guides/agent/agent_component_reference/retrieval.mdx @@ -61,7 +61,7 @@ Click the **Run** button on the top of canvas to test the retrieval results. ### 7. Choose the next component -When necessary, click the **+** button on the **Retrieval** component to choose the next component in the worflow from the dropdown list. +When necessary, click the **+** button on the **Retrieval** component to choose the next component in the workflow from the dropdown list. ## Configurations diff --git a/docs/guides/agent/agent_component_reference/transformer.md b/docs/guides/agent/agent_component_reference/transformer.md index ab21f60db..ad8274ac4 100644 --- a/docs/guides/agent/agent_component_reference/transformer.md +++ b/docs/guides/agent/agent_component_reference/transformer.md @@ -24,7 +24,7 @@ Click the dropdown menu of **Model** to show the model configuration window. - **Model**: The chat model to use. - Ensure you set the chat model correctly on the **Model providers** page. - You can use different models for different components to increase flexibility or improve overall performance. -- **Creavity**: A shortcut to **Temperature**, **Top P**, **Presence penalty**, and **Frequency penalty** settings, indicating the freedom level of the model. From **Improvise**, **Precise**, to **Balance**, each preset configuration corresponds to a unique combination of **Temperature**, **Top P**, **Presence penalty**, and **Frequency penalty**. +- **Creativity**: A shortcut to **Temperature**, **Top P**, **Presence penalty**, and **Frequency penalty** settings, indicating the freedom level of the model. From **Improvise**, **Precise**, to **Balance**, each preset configuration corresponds to a unique combination of **Temperature**, **Top P**, **Presence penalty**, and **Frequency penalty**. This parameter has three options: - **Improvise**: Produces more creative responses. - **Precise**: (Default) Produces more conservative responses. diff --git a/docs/guides/agent/best_practices/accelerate_agent_question_answering.md b/docs/guides/agent/best_practices/accelerate_agent_question_answering.md index c06937755..76de06068 100644 --- a/docs/guides/agent/best_practices/accelerate_agent_question_answering.md +++ b/docs/guides/agent/best_practices/accelerate_agent_question_answering.md @@ -17,7 +17,7 @@ An Agent’s response time generally depends on many factors, e.g., the LLM’s - For simple tasks, such as retrieval, rewriting, formatting, or structured data extraction, use concise prompts, remove planning or reasoning instructions, enforce output length limits, and select smaller or Turbo-class models. This significantly reduces latency and cost with minimal impact on quality. -- For complex tasks, like multi-step reasoning, cross-document synthesis, or tool-based workflows, maintain or enhance prompts that include planning, reflection, and verification steps. +- For complex tasks, like multistep reasoning, cross-document synthesis, or tool-based workflows, maintain or enhance prompts that include planning, reflection, and verification steps. - In multi-Agent orchestration systems, delegate simple subtasks to sub-Agents using smaller, faster models, and reserve more powerful models for the lead Agent to handle complexity and uncertainty. diff --git a/docs/guides/chat/start_chat.md b/docs/guides/chat/start_chat.md index e3581aad7..1e4265fe8 100644 --- a/docs/guides/chat/start_chat.md +++ b/docs/guides/chat/start_chat.md @@ -55,7 +55,7 @@ You start an AI conversation by creating an assistant. 4. Update Model-specific Settings: - In **Model**: you select the chat model. Though you have selected the default chat model in **System Model Settings**, RAGFlow allows you to choose an alternative chat model for your dialogue. - - **Creavity**: A shortcut to **Temperature**, **Top P**, **Presence penalty**, and **Frequency penalty** settings, indicating the freedom level of the model. From **Improvise**, **Precise**, to **Balance**, each preset configuration corresponds to a unique combination of **Temperature**, **Top P**, **Presence penalty**, and **Frequency penalty**. + - **Creativity**: A shortcut to **Temperature**, **Top P**, **Presence penalty**, and **Frequency penalty** settings, indicating the freedom level of the model. From **Improvise**, **Precise**, to **Balance**, each preset configuration corresponds to a unique combination of **Temperature**, **Top P**, **Presence penalty**, and **Frequency penalty**. This parameter has three options: - **Improvise**: Produces more creative responses. - **Precise**: (Default) Produces more conservative responses. diff --git a/docs/guides/dataset/autokeyword_autoquestion.mdx b/docs/guides/dataset/autokeyword_autoquestion.mdx index f61e50317..e91764585 100644 --- a/docs/guides/dataset/autokeyword_autoquestion.mdx +++ b/docs/guides/dataset/autokeyword_autoquestion.mdx @@ -58,7 +58,7 @@ The Auto-keyword or Auto-question values relate closely to the chunking size in |---------------------------------------------------------------------|---------------------------------|----------------------------|----------------------------| | Internal process guidance for employee handbook | Small, under 10 pages | 0 | 0 | | Customer service FAQs | Medium, 10–100 pages | 3–7 | 1–3 | -| Technical whitepapers: Development standards, protocol details | Large, over 100 pages | 2–4 | 1–2 | +| Technical white papers: Development standards, protocol details | Large, over 100 pages | 2–4 | 1–2 | | Contracts / Regulations / Legal clause retrieval | Large, over 50 pages | 2–5 | 0–1 | | Multi-repository layered new documents + old archive | Many | Adjust as appropriate |Adjust as appropriate | | Social media comment pool: multilingual & mixed spelling | Very large volume of short text | 8–12 | 0 | diff --git a/docs/guides/dataset/construct_knowledge_graph.md b/docs/guides/dataset/construct_knowledge_graph.md index 23ee6bf24..471080811 100644 --- a/docs/guides/dataset/construct_knowledge_graph.md +++ b/docs/guides/dataset/construct_knowledge_graph.md @@ -91,7 +91,7 @@ Nope. The knowledge graph does *not* update *until* you regenerate a knowledge g ### How to remove a generated knowledge graph? -On the **Configuration** page of your dataset, find the **Knoweledge graph** field and click the recycle bin button to the right of the field. +On the **Configuration** page of your dataset, find the **Knowledge graph** field and click the recycle bin button to the right of the field. ### Where is the created knowledge graph stored? diff --git a/docs/guides/dataset/enable_excel2html.md b/docs/guides/dataset/enable_excel2html.md index d8090420d..5a7a8fa41 100644 --- a/docs/guides/dataset/enable_excel2html.md +++ b/docs/guides/dataset/enable_excel2html.md @@ -12,7 +12,7 @@ Convert complex Excel spreadsheets into HTML tables. When using the **General** chunking method, you can enable the **Excel to HTML** toggle to convert spreadsheet files into HTML tables. If it is disabled, spreadsheet tables will be represented as key-value pairs. For complex tables that cannot be simply represented this way, you must enable this feature. :::caution WARNING -The feature is disabled by default. If your dataset contains spreadsheets with complex tables and you do not enable this feature, RAGFlow will not throw an error but your tables are likely to be garbled. +The feature is disabled by default. If your dataset contains spreadsheets with complex tables, and you do not enable this feature, RAGFlow will not throw an error but your tables are likely to be garbled. ::: ## Scenarios diff --git a/docs/guides/dataset/enable_raptor.md b/docs/guides/dataset/enable_raptor.md index aab4cd720..2d8fa2453 100644 --- a/docs/guides/dataset/enable_raptor.md +++ b/docs/guides/dataset/enable_raptor.md @@ -13,7 +13,7 @@ RAPTOR (Recursive Abstractive Processing for Tree Organized Retrieval) is an enh ![document_clustering](https://raw.githubusercontent.com/infiniflow/ragflow-docs/main/images/document_clustering_as_preprocessing.jpg) -Our tests with this new approach demonstrate state-of-the-art (SOTA) results on question-answering tasks requiring complex, multi-step reasoning. By combining RAPTOR retrieval with our built-in chunking methods and/or other retrieval-augmented generation (RAG) approaches, you can further improve your question-answering accuracy. +Our tests with this new approach demonstrate state-of-the-art (SOTA) results on question-answering tasks requiring complex, multistep reasoning. By combining RAPTOR retrieval with our built-in chunking methods and/or other retrieval-augmented generation (RAG) approaches, you can further improve your question-answering accuracy. :::danger WARNING Enabling RAPTOR requires significant memory, computational resources, and tokens. @@ -29,7 +29,7 @@ The recursive clustering and summarization capture a broad understanding (by the ## Scenarios -For multi-hop question-answering tasks involving complex, multi-step reasoning, a semantic gap often exists between the question and its answer. As a result, searching with the question often fails to retrieve the relevant chunks that contribute to the correct answer. RAPTOR addresses this challenge by providing the chat model with richer and more context-aware and relevant chunks to summarize, enabling a holistic understanding without losing granular details. +For multi-hop question-answering tasks involving complex, multistep reasoning, a semantic gap often exists between the question and its answer. As a result, searching with the question often fails to retrieve the relevant chunks that contribute to the correct answer. RAPTOR addresses this challenge by providing the chat model with richer and more context-aware and relevant chunks to summarize, enabling a holistic understanding without losing granular details. :::tip NOTE Knowledge graphs can also be used for multi-hop question-answering tasks. See [Construct knowledge graph](./construct_knowledge_graph.md) for details. You may use either approach or both, but ensure you understand the memory, computational, and token costs involved. diff --git a/docs/guides/dataset/select_pdf_parser.md b/docs/guides/dataset/select_pdf_parser.md index 454b9a215..302e9f850 100644 --- a/docs/guides/dataset/select_pdf_parser.md +++ b/docs/guides/dataset/select_pdf_parser.md @@ -23,7 +23,7 @@ RAGFlow isn't one-size-fits-all. It is built for flexibility and supports deeper - **Laws** - **Presentation** - **One** -- To use a third-party visual model for parsing PDFs, ensure you have set a default img2txt model under **Set default models** on the **Model providers** page. +- To use a third-party visual model for parsing PDFs, ensure you have set a default VLM under **Set default models** on the **Model providers** page. ## Quickstart @@ -39,7 +39,7 @@ RAGFlow isn't one-size-fits-all. It is built for flexibility and supports deeper - [Docling](https://github.com/docling-project/docling): (Experimental) An open-source document processing tool for gen AI. - A third-party visual model from a specific model provider. -:::danger IMPORTANG +:::danger IMPORTANT MinerU PDF document parsing is available starting from v0.22.0. RAGFlow supports MinerU (>= 2.6.3) as an optional PDF parser with multiple backends. RAGFlow acts only as a client for MinerU, calling it to parse documents, reading the output files, and ingesting the parsed content. To use this feature, follow these steps: 1. Prepare MinerU: @@ -90,7 +90,7 @@ MinerU PDF document parsing is available starting from v0.22.0. RAGFlow supports ``` 3. Restart the ragflow-server. -4. In the web UI, navigate to the **Configuration** page of your dataset. Click **Built-in** in the **Ingestion pipeline** section, select a chunking method from the **Built-in** dropdown, which supports PDF parsing, and slect **MinerU** in **PDF parser**. +4. In the web UI, navigate to the **Configuration** page of your dataset. Click **Built-in** in the **Ingestion pipeline** section, select a chunking method from the **Built-in** dropdown, which supports PDF parsing, and select **MinerU** in **PDF parser**. 5. If you use a custom ingestion pipeline instead, you must also complete the first three steps before selecting **MinerU** in the **Parsing method** section of the **Parser** component. ::: @@ -102,7 +102,7 @@ Third-party visual models are marked **Experimental**, because we have not fully ### When should I select DeepDoc or a third-party visual model as the PDF parser? -Use a visual model to extract data if your PDFs contain formatted or image-based text rather than plain text. DeepDoc is the default visual model but can be time-consuming. You can also choose a lightweight or high-performance img2txt model depending on your needs and hardware capabilities. +Use a visual model to extract data if your PDFs contain formatted or image-based text rather than plain text. DeepDoc is the default visual model but can be time-consuming. You can also choose a lightweight or high-performance VLM depending on your needs and hardware capabilities. ### Can I select a visual model to parse my DOCX files? diff --git a/docs/guides/dataset/set_metadata.md b/docs/guides/dataset/set_metadata.md index 15491ad23..fda0fcdbb 100644 --- a/docs/guides/dataset/set_metadata.md +++ b/docs/guides/dataset/set_metadata.md @@ -1,6 +1,6 @@ --- sidebar_position: -7 -slug: /set_metada +slug: /set_metadata --- # Set metadata diff --git a/docs/guides/dataset/use_tag_sets.md b/docs/guides/dataset/use_tag_sets.md index 35af071cf..e0c359267 100644 --- a/docs/guides/dataset/use_tag_sets.md +++ b/docs/guides/dataset/use_tag_sets.md @@ -73,7 +73,7 @@ Creating a tag set is *not* for once and for all. Oftentimes, you may find it ne ### Update tag set in tag frequency table 1. Navigate to the **Configuration** page in your tag set. -2. Click the **Table** tab under **Tag view** to view the tag frequncy table, where you can update tag names or delete tags. +2. Click the **Table** tab under **Tag view** to view the tag frequency table, where you can update tag names or delete tags. :::danger IMPORTANT When a tag set is updated, you must re-parse the documents in your dataset so that their tags can be updated accordingly. diff --git a/docs/guides/migration/migrate_from_docker_compose.md b/docs/guides/migration/migrate_from_docker_compose.md index a8d36ea13..c2e8eeb54 100644 --- a/docs/guides/migration/migrate_from_docker_compose.md +++ b/docs/guides/migration/migrate_from_docker_compose.md @@ -89,7 +89,7 @@ Once the restore process is complete, you can start the RAGFlow services on your docker-compose -f docker/docker-compose.yml up -d ``` -**Note:** If you already have build an service by docker-compose before, you may need to backup your data for target machine like this guide above and run like: +**Note:** If you already have built a service by docker-compose before, you may need to backup your data for target machine like this guide above and run like: ```bash # Please backup by `sh docker/migration.sh backup backup_dir_name` before you do the following line. diff --git a/docs/guides/team/join_or_leave_team.md b/docs/guides/team/join_or_leave_team.md index 93255ef3c..978523d80 100644 --- a/docs/guides/team/join_or_leave_team.md +++ b/docs/guides/team/join_or_leave_team.md @@ -5,7 +5,7 @@ slug: /join_or_leave_team # Join or leave a team -Accept an invite to join a team, decline an invite, or leave a team. +Accept an invitation to join a team, decline an invitation, or leave a team. --- From a81f6d1b245e5de2cbdbb1f63aeceb68bf96f407 Mon Sep 17 00:00:00 2001 From: chanx <1243304602@qq.com> Date: Wed, 12 Nov 2025 14:36:30 +0800 Subject: [PATCH 2/3] Fix: Bug Fixes - Added disabled logic RAPTOR scope #10703 (#11207) ### What problem does this PR solve? Fix: Bug Fixes #10703 - Fixed the menu order in the user center - Added a disabled RAPTOR scope - Fixed some style issues ### Type of change - [x] Bug Fix (non-breaking change which fixes an issue) --- web/src/components/originui/select-with-search.tsx | 4 ++-- .../components/parse-configuration/raptor-form-fields.tsx | 2 +- web/src/locales/en.ts | 8 ++++---- web/src/pages/admin/login.tsx | 2 +- web/src/pages/user-setting/sidebar/index.tsx | 8 ++++---- web/src/routes.ts | 2 +- 6 files changed, 13 insertions(+), 13 deletions(-) diff --git a/web/src/components/originui/select-with-search.tsx b/web/src/components/originui/select-with-search.tsx index 4a1e1e74e..595844f49 100644 --- a/web/src/components/originui/select-with-search.tsx +++ b/web/src/components/originui/select-with-search.tsx @@ -149,13 +149,13 @@ export const SelectWithSearch = forwardRef< {selectLabel} ) : ( - {placeholder} + {placeholder} )}
{value && allowClear && ( <>
- +
{t('scopeDataset')} {t('scopeSingleFile')} diff --git a/web/src/locales/en.ts b/web/src/locales/en.ts index 913330d50..e176b7e3d 100644 --- a/web/src/locales/en.ts +++ b/web/src/locales/en.ts @@ -788,8 +788,8 @@ Example: general/v2/`, 'Please enter the API key (for locally deployed model,ignore this).', apiKeyTip: 'The API key can be obtained by registering the corresponding LLM supplier.', - showMoreModels: 'View Models', - hideModels: 'Hide Models', + showMoreModels: 'View models', + hideModels: 'Hide models', baseUrl: 'Base-Url', baseUrlTip: 'If your API key is from OpenAI, just ignore it. Any other intermediate providers will give this base url with the API key.', @@ -814,7 +814,7 @@ Example: general/v2/`, ttsModel: 'TTS', ttsModelTip: 'The default text-to-speech model. If you cannot find a model from the dropdown, check https://ragflow.io/docs/dev/supported_models to see if your model provider supports this model.', - workspace: 'Workspace', + workspace: 'workspace', upgrade: 'Upgrade', addLlmTitle: 'Add LLM', editLlmTitle: 'Edit {{name}} Model', @@ -922,7 +922,7 @@ Example: general/v2/`, add: 'Add', updateDate: 'Date', role: 'State', - invite: 'Invite Member', + invite: 'Invite member', agree: 'Accept', refuse: 'Decline', teamMembers: 'Team members', diff --git a/web/src/pages/admin/login.tsx b/web/src/pages/admin/login.tsx index 589db8a88..33f696052 100644 --- a/web/src/pages/admin/login.tsx +++ b/web/src/pages/admin/login.tsx @@ -126,7 +126,7 @@ function AdminLogin() { color="rgb(128, 255, 248)" /> - +
diff --git a/web/src/pages/user-setting/sidebar/index.tsx b/web/src/pages/user-setting/sidebar/index.tsx index 20f20fdde..165958035 100644 --- a/web/src/pages/user-setting/sidebar/index.tsx +++ b/web/src/pages/user-setting/sidebar/index.tsx @@ -17,9 +17,11 @@ import { useEffect } from 'react'; import { useHandleMenuClick } from './hooks'; const menuItems = [ - { icon: User, label: t('setting.profile'), key: Routes.Profile }, - { icon: Users, label: t('setting.team'), key: Routes.Team }, + { icon: Server, label: t('setting.dataSources'), key: Routes.DataSource }, { icon: Box, label: t('setting.model'), key: Routes.Model }, + { icon: Banknote, label: 'MCP', key: Routes.Mcp }, + { icon: Users, label: t('setting.team'), key: Routes.Team }, + { icon: User, label: t('setting.profile'), key: Routes.Profile }, { icon: Unplug, label: t('setting.api'), key: Routes.Api }, // { // icon: MessageSquareQuote, @@ -27,10 +29,8 @@ const menuItems = [ // key: Routes.Profile, // }, // { icon: TextSearch, label: 'Retrieval Templates', key: Routes.Profile }, - { icon: Server, label: t('setting.dataSources'), key: Routes.DataSource }, // { icon: Cog, label: t('setting.system'), key: Routes.System }, // { icon: Banknote, label: 'Plan', key: Routes.Plan }, - { icon: Banknote, label: 'MCP', key: Routes.Mcp }, ]; export function SideBar() { diff --git a/web/src/routes.ts b/web/src/routes.ts index 2e9692120..56dd84077 100644 --- a/web/src/routes.ts +++ b/web/src/routes.ts @@ -367,7 +367,7 @@ const routes = [ component: '@/pages/user-setting', layout: false, routes: [ - { path: '/user-setting', redirect: '/user-setting/profile' }, + { path: '/user-setting', redirect: `/user-setting${Routes.DataSource}` }, { path: '/user-setting/profile', // component: '@/pages/user-setting/setting-profile', From a36a0fe71c58993d629016b3f3eab224e25be306 Mon Sep 17 00:00:00 2001 From: Liu An Date: Wed, 12 Nov 2025 14:54:28 +0800 Subject: [PATCH 3/3] Docs: Update version references to v0.22.0 in READMEs and docs (#11211) ### What problem does this PR solve? - Update version tags in README files (including translations) from v0.21.1 to v0.22.0 - Modify Docker image references and documentation to reflect new version - Update version badges and image descriptions - Maintain consistency across all language variants of README files ### Type of change - [x] Documentation Update --- admin/client/README.md | 2 +- admin/client/admin_client.py | 2 +- docker/.env | 4 ++-- docs/configurations.md | 2 +- docs/develop/build_docker_image.mdx | 2 +- docs/guides/chat/start_chat.md | 2 +- docs/guides/dataset/configure_knowledge_base.md | 4 ++-- docs/guides/manage_files.md | 2 +- docs/guides/manage_users_and_services.md | 2 +- docs/guides/tracing.mdx | 2 +- docs/guides/upgrade_ragflow.mdx | 10 +++++----- docs/quickstart.mdx | 6 +++--- docs/references/glossary.mdx | 2 +- helm/values.yaml | 2 +- pyproject.toml | 2 +- sdk/python/pyproject.toml | 2 +- sdk/python/uv.lock | 2 +- uv.lock | 2 +- 18 files changed, 26 insertions(+), 26 deletions(-) diff --git a/admin/client/README.md b/admin/client/README.md index d13ff4dd7..1964a41d4 100644 --- a/admin/client/README.md +++ b/admin/client/README.md @@ -48,7 +48,7 @@ It consists of a server-side Service and a command-line client (CLI), both imple 1. Ensure the Admin Service is running. 2. Install ragflow-cli. ```bash - pip install ragflow-cli==0.21.1 + pip install ragflow-cli==0.22.0 ``` 3. Launch the CLI client: ```bash diff --git a/admin/client/admin_client.py b/admin/client/admin_client.py index 098132fd3..b52e67494 100644 --- a/admin/client/admin_client.py +++ b/admin/client/admin_client.py @@ -378,7 +378,7 @@ class AdminCLI(Cmd): self.session.headers.update({ 'Content-Type': 'application/json', 'Authorization': response.headers['Authorization'], - 'User-Agent': 'RAGFlow-CLI/0.21.1' + 'User-Agent': 'RAGFlow-CLI/0.22.0' }) print("Authentication successful.") return True diff --git a/docker/.env b/docker/.env index f62292724..5ed35b1b9 100644 --- a/docker/.env +++ b/docker/.env @@ -109,8 +109,8 @@ SVR_MCP_PORT=9382 RAGFLOW_IMAGE=infiniflow/ragflow:v0.22.0 # If you cannot download the RAGFlow Docker image: -# RAGFLOW_IMAGE=swr.cn-north-4.myhuaweicloud.com/infiniflow/ragflow:v0.21.1 -# RAGFLOW_IMAGE=registry.cn-hangzhou.aliyuncs.com/infiniflow/ragflow:v0.21.1 +# RAGFLOW_IMAGE=swr.cn-north-4.myhuaweicloud.com/infiniflow/ragflow:v0.22.0 +# RAGFLOW_IMAGE=registry.cn-hangzhou.aliyuncs.com/infiniflow/ragflow:v0.22.0 # # - For the `nightly` edition, uncomment either of the following: # RAGFLOW_IMAGE=swr.cn-north-4.myhuaweicloud.com/infiniflow/ragflow:nightly diff --git a/docs/configurations.md b/docs/configurations.md index 37a96c4e6..ee3b1bfbc 100644 --- a/docs/configurations.md +++ b/docs/configurations.md @@ -97,7 +97,7 @@ RAGFlow utilizes MinIO as its object storage solution, leveraging its scalabilit - `SVR_HTTP_PORT` The port used to expose RAGFlow's HTTP API service to the host machine, allowing **external** access to the service running inside the Docker container. Defaults to `9380`. - `RAGFLOW-IMAGE` - The Docker image edition. Defaults to `infiniflow/ragflow:v0.21.1` (the RAGFlow Docker image without embedding models). + The Docker image edition. Defaults to `infiniflow/ragflow:v0.22.0` (the RAGFlow Docker image without embedding models). :::tip NOTE If you cannot download the RAGFlow Docker image, try the following mirrors. diff --git a/docs/develop/build_docker_image.mdx b/docs/develop/build_docker_image.mdx index 07451498e..5ecdc3748 100644 --- a/docs/develop/build_docker_image.mdx +++ b/docs/develop/build_docker_image.mdx @@ -47,7 +47,7 @@ After building the infiniflow/ragflow:nightly image, you are ready to launch a f 1. Edit Docker Compose Configuration -Open the `docker/.env` file. Find the `RAGFLOW_IMAGE` setting and change the image reference from `infiniflow/ragflow:v0.21.1` to `infiniflow/ragflow:nightly` to use the pre-built image. +Open the `docker/.env` file. Find the `RAGFLOW_IMAGE` setting and change the image reference from `infiniflow/ragflow:v0.22.0` to `infiniflow/ragflow:nightly` to use the pre-built image. 2. Launch the Service diff --git a/docs/guides/chat/start_chat.md b/docs/guides/chat/start_chat.md index 1e4265fe8..d057151e2 100644 --- a/docs/guides/chat/start_chat.md +++ b/docs/guides/chat/start_chat.md @@ -48,7 +48,7 @@ You start an AI conversation by creating an assistant. - If no target language is selected, the system will search only in the language of your query, which may cause relevant information in other languages to be missed. - **Variable** refers to the variables (keys) to be used in the system prompt. `{knowledge}` is a reserved variable. Click **Add** to add more variables for the system prompt. - If you are uncertain about the logic behind **Variable**, leave it *as-is*. - - As of v0.21.1, if you add custom variables here, the only way you can pass in their values is to call: + - As of v0.17.2, if you add custom variables here, the only way you can pass in their values is to call: - HTTP method [Converse with chat assistant](../../references/http_api_reference.md#converse-with-chat-assistant), or - Python method [Converse with chat assistant](../../references/python_api_reference.md#converse-with-chat-assistant). diff --git a/docs/guides/dataset/configure_knowledge_base.md b/docs/guides/dataset/configure_knowledge_base.md index 2b737fb5c..ac3369070 100644 --- a/docs/guides/dataset/configure_knowledge_base.md +++ b/docs/guides/dataset/configure_knowledge_base.md @@ -59,7 +59,7 @@ You can also change a file's chunking method on the **Files** page. ![change chunking method](https://raw.githubusercontent.com/infiniflow/ragflow-docs/main/images/change_chunking_method.jpg)
- From v0.21.1 onward, RAGFlow supports ingestion pipeline for customized data ingestion and cleansing workflows. + From v0.21.0 onward, RAGFlow supports ingestion pipeline for customized data ingestion and cleansing workflows. To use a customized data pipeline: @@ -133,7 +133,7 @@ See [Run retrieval test](./run_retrieval_test.md) for details. ## Search for dataset -As of RAGFlow v0.21.1, the search feature is still in a rudimentary form, supporting only dataset search by name. +As of RAGFlow v0.22.0, the search feature is still in a rudimentary form, supporting only dataset search by name. ![search dataset](https://raw.githubusercontent.com/infiniflow/ragflow-docs/main/images/search_datasets.jpg) diff --git a/docs/guides/manage_files.md b/docs/guides/manage_files.md index 127eaf54f..e28b73ff1 100644 --- a/docs/guides/manage_files.md +++ b/docs/guides/manage_files.md @@ -87,4 +87,4 @@ RAGFlow's file management allows you to download an uploaded file: ![download_file](https://github.com/infiniflow/ragflow/assets/93570324/cf3b297f-7d9b-4522-bf5f-4f45743e4ed5) -> As of RAGFlow v0.21.1, bulk download is not supported, nor can you download an entire folder. +> As of RAGFlow v0.22.0, bulk download is not supported, nor can you download an entire folder. diff --git a/docs/guides/manage_users_and_services.md b/docs/guides/manage_users_and_services.md index 79e968e90..1d7f0fa64 100644 --- a/docs/guides/manage_users_and_services.md +++ b/docs/guides/manage_users_and_services.md @@ -46,7 +46,7 @@ The Admin CLI and Admin Service form a client-server architectural suite for RAG 2. Install ragflow-cli. ```bash - pip install ragflow-cli==0.21.1 + pip install ragflow-cli==0.22.0 ``` 3. Launch the CLI client: diff --git a/docs/guides/tracing.mdx b/docs/guides/tracing.mdx index 37e5243ae..c9f37ba75 100644 --- a/docs/guides/tracing.mdx +++ b/docs/guides/tracing.mdx @@ -18,7 +18,7 @@ RAGFlow ships with a built-in [Langfuse](https://langfuse.com) integration so th Langfuse stores traces, spans and prompt payloads in a purpose-built observability backend and offers filtering and visualisations on top. :::info NOTE -• RAGFlow **≥ 0.21.1** (contains the Langfuse connector) +• RAGFlow **≥ 0.18.0** (contains the Langfuse connector) • A Langfuse workspace (cloud or self-hosted) with a _Project Public Key_ and _Secret Key_ ::: diff --git a/docs/guides/upgrade_ragflow.mdx b/docs/guides/upgrade_ragflow.mdx index c54d42d7d..f10e549ed 100644 --- a/docs/guides/upgrade_ragflow.mdx +++ b/docs/guides/upgrade_ragflow.mdx @@ -48,16 +48,16 @@ To upgrade RAGFlow, you must upgrade **both** your code **and** your Docker imag git clone https://github.com/infiniflow/ragflow.git ``` -2. Switch to the latest, officially published release, e.g., `v0.21.1`: +2. Switch to the latest, officially published release, e.g., `v0.22.0`: ```bash - git checkout -f v0.21.1 + git checkout -f v0.22.0 ``` 3. Update **ragflow/docker/.env**: ```bash - RAGFLOW_IMAGE=infiniflow/ragflow:v0.21.1 + RAGFLOW_IMAGE=infiniflow/ragflow:v0.22.0 ``` 4. Update the RAGFlow image and restart RAGFlow: @@ -78,10 +78,10 @@ No, you do not need to. Upgrading RAGFlow in itself will *not* remove your uploa 1. From an environment with Internet access, pull the required Docker image. 2. Save the Docker image to a **.tar** file. ```bash - docker save -o ragflow.v0.21.1.tar infiniflow/ragflow:v0.21.1 + docker save -o ragflow.v0.22.0.tar infiniflow/ragflow:v0.22.0 ``` 3. Copy the **.tar** file to the target server. 4. Load the **.tar** file into Docker: ```bash - docker load -i ragflow.v0.21.1.tar + docker load -i ragflow.v0.22.0.tar ``` diff --git a/docs/quickstart.mdx b/docs/quickstart.mdx index c4582caf9..a6706d06a 100644 --- a/docs/quickstart.mdx +++ b/docs/quickstart.mdx @@ -44,7 +44,7 @@ This section provides instructions on setting up the RAGFlow server on Linux. If `vm.max_map_count`. This value sets the maximum number of memory map areas a process may have. Its default value is 65530. While most applications require fewer than a thousand maps, reducing this value can result in abnormal behaviors, and the system will throw out-of-memory errors when a process reaches the limitation. - RAGFlow v0.21.1 uses Elasticsearch or [Infinity](https://github.com/infiniflow/infinity) for multiple recall. Setting the value of `vm.max_map_count` correctly is crucial to the proper functioning of the Elasticsearch component. + RAGFlow v0.22.0 uses Elasticsearch or [Infinity](https://github.com/infiniflow/infinity) for multiple recall. Setting the value of `vm.max_map_count` correctly is crucial to the proper functioning of the Elasticsearch component.