From a6115f746be735f63cfdcd12db9bb7fdb5e46c2d Mon Sep 17 00:00:00 2001 From: Vissidarte-Herman Date: Wed, 15 May 2024 16:06:11 +0800 Subject: [PATCH 1/3] Added file management guide --- docs/manage_files.md | 64 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 64 insertions(+) create mode 100644 docs/manage_files.md diff --git a/docs/manage_files.md b/docs/manage_files.md new file mode 100644 index 0000000000..4ab7c58383 --- /dev/null +++ b/docs/manage_files.md @@ -0,0 +1,64 @@ +# Manage files + +Knowledge base, hallucination-free chat, and file management are three pillars of RAGFlow. RAGFlow's file management allows you to upload files individually or in bulk. You can then link an uploaded file to multiple target knowledge bases. This guide showcases some basic usages of the file management feature. + +## Create folder + +RAGFlow's file management allows you to establish your file system with nested folder structures. To create a folder in the root directory of RAGFlow: + +![create new folder](https://github.com/infiniflow/ragflow/assets/93570324/3a37a5f4-43a6-426d-a62a-e5cd2ff7a533) + +> Each knowledge base in RAGFlow has a corresponding folder under the **root/.knowledgebase** directory. You are not allowed to create a subfolder within it. + +## Upload file + +RAGFlow's file management supports file uploads from your local machine, allowing both individual and bulk uploads: + +![upload file](https://github.com/infiniflow/ragflow/assets/93570324/5d7ded14-ce2b-4703-8567-9356a978f45c) + +![bulk upload](https://github.com/infiniflow/ragflow/assets/93570324/def0db55-824c-4236-b809-a98d8c8674e3) + +## Preview file + +RAGFlow's file management supports previewing files in the following formats: + +- Documents (PDF, DOCS) +- Tables (XLSX) +- Pictures (JPEG, JPG, PNG, TIF, GIF) + +![preview](https://github.com/infiniflow/ragflow/assets/93570324/2e931362-8bbf-482c-ac86-b68b09d331bc) + +## Link file to knowledge bases + +RAGFlow's file management allows you to *link* an uploaded file to multiple knowledge bases, creating a file reference in each target knowledge base. Therefore, deleting a file in your file management will AUTOMATICALLY REMOVE all related file references across the knowledge bases. + +![link knowledgebase](https://github.com/infiniflow/ragflow/assets/93570324/6c6b8db4-3269-4e35-9434-6089887e3e3f) + +You can link your file to one knowledge base or multiple knowledge bases at one time: + +![link multiple kb](https://github.com/infiniflow/ragflow/assets/93570324/6c508803-fb1f-435d-b688-683066fd7fff) + +## Move file to specified folder + +As of RAGFlow v0.5.0, this feature is *not* available. + +## Search files or folders + +As of RAGFlow v0.5.0, the search feature is still in a rudimentary form, supporting only file and folder search in the current directory by name (files or folders in the child directory will not be retrieved). + +![search file](https://github.com/infiniflow/ragflow/assets/93570324/77ffc2e5-bd80-4ed1-841f-068e664efffe) + +## Delete files or folders + +RAGFlow's file management allows you to delete files or folders individually or in bulk. + +To delete a file or folder: + +![delete file](https://github.com/infiniflow/ragflow/assets/93570324/85872728-125d-45e9-a0ee-21e9d4cedb8b) + +To bulk delete files or folders: + +![bulk delete](https://github.com/infiniflow/ragflow/assets/93570324/519b99ab-ec7f-4c8a-8cea-e0b6dcb3cb46) + +> - You are not allowed to delete the **.knowledgebase** folder. +> - Deleting files that have been linked to knowledge bases will AUTOMATICALLY REMOVE all associated file references across the knowledge bases. From 9477564fb0a1b5a71130941e2ed3fe8dee87fe8f Mon Sep 17 00:00:00 2001 From: Vissidarte-Herman Date: Wed, 15 May 2024 19:02:42 +0800 Subject: [PATCH 2/3] Added instructions on renaming and bulk downloading --- docs/manage_files.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/docs/manage_files.md b/docs/manage_files.md index 4ab7c58383..4fc05ea660 100644 --- a/docs/manage_files.md +++ b/docs/manage_files.md @@ -48,6 +48,13 @@ As of RAGFlow v0.5.0, the search feature is still in a rudimentary form, support ![search file](https://github.com/infiniflow/ragflow/assets/93570324/77ffc2e5-bd80-4ed1-841f-068e664efffe) +## Rename file or folder + +RAGFlow's file management allows you to rename a file or folder: + +![rename_file](https://github.com/infiniflow/ragflow/assets/93570324/5abb0704-d9e9-4b43-9ed4-5750ccee011f) + + ## Delete files or folders RAGFlow's file management allows you to delete files or folders individually or in bulk. @@ -62,3 +69,11 @@ To bulk delete files or folders: > - You are not allowed to delete the **.knowledgebase** folder. > - Deleting files that have been linked to knowledge bases will AUTOMATICALLY REMOVE all associated file references across the knowledge bases. + +## Download uploaded file + +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.5.0, bulk download is not supported, nor can you download an entire folder. From 37a09a05c26cb6bfd08c5dc8a12169609c326d7e Mon Sep 17 00:00:00 2001 From: Vissidarte-Herman Date: Wed, 15 May 2024 19:19:35 +0800 Subject: [PATCH 3/3] updated folder name --- docs/manage_files.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/manage_files.md b/docs/manage_files.md index 4fc05ea660..9e67d1c1d7 100644 --- a/docs/manage_files.md +++ b/docs/manage_files.md @@ -67,7 +67,7 @@ To bulk delete files or folders: ![bulk delete](https://github.com/infiniflow/ragflow/assets/93570324/519b99ab-ec7f-4c8a-8cea-e0b6dcb3cb46) -> - You are not allowed to delete the **.knowledgebase** folder. +> - You are not allowed to delete the **root/.knowledgebase** folder. > - Deleting files that have been linked to knowledge bases will AUTOMATICALLY REMOVE all associated file references across the knowledge bases. ## Download uploaded file