From ba1063c2b9cacaaf67973dad250428ca97ef5682 Mon Sep 17 00:00:00 2001 From: writinwaters <93570324+writinwaters@users.noreply.github.com> Date: Tue, 26 Aug 2025 19:35:29 +0800 Subject: [PATCH] Docs: Miscellaneous updates (#9729) ### What problem does this PR solve? ### Type of change - [x] Documentation Update --- api/utils/api_utils.py | 2 +- docs/develop/acquire_ragflow_api_key.md | 2 +- docs/references/http_api_reference.md | 6 +++--- docs/references/python_api_reference.md | 2 +- docs/release_notes.md | 4 ++-- web/src/locales/en.ts | 2 +- 6 files changed, 9 insertions(+), 9 deletions(-) diff --git a/api/utils/api_utils.py b/api/utils/api_utils.py index 836a9da6c..9b0b481e3 100644 --- a/api/utils/api_utils.py +++ b/api/utils/api_utils.py @@ -354,7 +354,7 @@ def get_parser_config(chunk_method, parser_config): if not chunk_method: chunk_method = "naive" - # Define default configurations for each chunk method + # Define default configurations for each chunking method key_mapping = { "naive": {"chunk_token_num": 512, "delimiter": r"\n", "html4excel": False, "layout_recognize": "DeepDOC", "raptor": {"use_raptor": False}, "graphrag": {"use_graphrag": False}}, "qa": {"raptor": {"use_raptor": False}, "graphrag": {"use_graphrag": False}}, diff --git a/docs/develop/acquire_ragflow_api_key.md b/docs/develop/acquire_ragflow_api_key.md index 65c5a4c8f..4dc4520fe 100644 --- a/docs/develop/acquire_ragflow_api_key.md +++ b/docs/develop/acquire_ragflow_api_key.md @@ -11,7 +11,7 @@ An API key is required for the RAGFlow server to authenticate your HTTP/Python o 2. Click **API** to switch to the **API** page. 3. Obtain a RAGFlow API key: -![ragflow_api_key](https://github.com/user-attachments/assets/f461ed61-04c6-4faf-b3d8-6b5fa56be4e7) +![ragflow_api_key](https://raw.githubusercontent.com/infiniflow/ragflow-docs/main/images/ragflow_api_key.jpg) :::tip NOTE See the [RAGFlow HTTP API reference](../references/http_api_reference.md) or the [RAGFlow Python API reference](../references/python_api_reference.md) for a complete reference of RAGFlow's HTTP or Python APIs. diff --git a/docs/references/http_api_reference.md b/docs/references/http_api_reference.md index 3facf77c3..3c00bffd7 100644 --- a/docs/references/http_api_reference.md +++ b/docs/references/http_api_reference.md @@ -5,7 +5,7 @@ slug: /http_api_reference # HTTP API -A complete reference for RAGFlow's RESTful API. Before proceeding, please ensure you [have your RAGFlow API key ready for authentication](../develop/acquire_ragflow_api_key.md). +A complete reference for RAGFlow's RESTful API. Before proceeding, please ensure you [have your RAGFlow API key ready for authentication](https://ragflow.io/docs/dev/acquire_ragflow_api_key). --- @@ -383,7 +383,7 @@ curl --request POST \ - `"layout_recognize"`: `string` - Defaults to `DeepDOC` - `"tag_kb_ids"`: `array` refer to [Use tag set](https://ragflow.io/docs/dev/use_tag_sets) - - Must include a list of dataset IDs, where each dataset is parsed using the ​​Tag Chunk Method + - Must include a list of dataset IDs, where each dataset is parsed using the ​​Tag Chunking Method - `"task_page_size"`: `int` For PDF only. - Defaults to `12` - Minimum: `1` @@ -604,7 +604,7 @@ curl --request PUT \ - `"layout_recognize"`: `string` - Defaults to `DeepDOC` - `"tag_kb_ids"`: `array` refer to [Use tag set](https://ragflow.io/docs/dev/use_tag_sets) - - Must include a list of dataset IDs, where each dataset is parsed using the ​​Tag Chunk Method + - Must include a list of dataset IDs, where each dataset is parsed using the ​​Tag Chunking Method - `"task_page_size"`: `int` For PDF only. - Defaults to `12` - Minimum: `1` diff --git a/docs/references/python_api_reference.md b/docs/references/python_api_reference.md index 07fd92bbf..d13b0516e 100644 --- a/docs/references/python_api_reference.md +++ b/docs/references/python_api_reference.md @@ -5,7 +5,7 @@ slug: /python_api_reference # Python API -A complete reference for RAGFlow's Python APIs. Before proceeding, please ensure you [have your RAGFlow API key ready for authentication](../develop/acquire_ragflow_api_key.md). +A complete reference for RAGFlow's Python APIs. Before proceeding, please ensure you [have your RAGFlow API key ready for authentication](https://ragflow.io/docs/dev/acquire_ragflow_api_key). :::tip NOTE Run the following command to download the Python SDK: diff --git a/docs/release_notes.md b/docs/release_notes.md index 31449706c..df42051ad 100644 --- a/docs/release_notes.md +++ b/docs/release_notes.md @@ -9,8 +9,8 @@ Key features, improvements and bug fixes in the latest releases. :::info Each RAGFlow release is available in two editions: -- **Slim edition**: excludes built-in embedding models and is identified by a **-slim** suffix added to the version name. Example: `infiniflow/ragflow:v0.20.1-slim` -- **Full edition**: includes built-in embedding models and has no suffix added to the version name. Example: `infiniflow/ragflow:v0.20.1` +- **Slim edition**: excludes built-in embedding models and is identified by a **-slim** suffix added to the version name. Example: `infiniflow/ragflow:v0.20.3-slim` +- **Full edition**: includes built-in embedding models and has no suffix added to the version name. Example: `infiniflow/ragflow:v0.20.3` ::: :::danger IMPORTANT diff --git a/web/src/locales/en.ts b/web/src/locales/en.ts index d4d1a7f0d..04424462f 100644 --- a/web/src/locales/en.ts +++ b/web/src/locales/en.ts @@ -196,7 +196,7 @@ export default { delimiterTip: 'A delimiter or separator can consist of one or multiple special characters. If it is multiple characters, ensure they are enclosed in backticks( ``). For example, if you configure your delimiters like this: \\n`##`;, then your texts will be separated at line breaks, double hash symbols (##), and semicolons.', html4excel: 'Excel to HTML', - html4excelTip: `Use with the General chunking method. When disabled, spreadsheets (XLSX or XLS(Excel 97-2003)) in the knowledge base will be parsed into key-value pairs. When enabled, they will be parsed into HTML tables, splitting every 12 rows if the original table has more than 12 rows.`, + html4excelTip: `Use with the General chunking method. When disabled, spreadsheets (XLSX or XLS(Excel 97-2003)) in the knowledge base will be parsed into key-value pairs. When enabled, they will be parsed into HTML tables, splitting every 12 rows if the original table has more than 12 rows. See https://ragflow.io/docs/dev/enable_excel2html for details.`, autoKeywords: 'Auto-keyword', autoKeywordsTip: `Automatically extract N keywords for each chunk to increase their ranking for queries containing those keywords. Be aware that extra tokens will be consumed by the chat model specified in 'System model settings'. You can check or update the added keywords for a chunk from the chunk list. For details, see https://ragflow.io/docs/dev/autokeyword_autoquestion.`, autoQuestions: 'Auto-question',