diff --git a/docs/administrator/management/admin_ui/manage_user_accounts.md b/docs/administrator/management/admin_ui/manage_user_accounts.md index 80a4882650..dc674dcc8c 100644 --- a/docs/administrator/management/admin_ui/manage_user_accounts.md +++ b/docs/administrator/management/admin_ui/manage_user_accounts.md @@ -10,12 +10,6 @@ title: Manage User Accounts User accounts are managed on the **Users** page. Administrators can view the user list, including `Email`, `Nickname`, `Status`, and `User type`. -![User Management](https://raw.githubusercontent.com/infiniflow/ragflow-docs/main/images/disable_or_restore_accounts.jpg) - -![User Management](https://raw.githubusercontent.com/infiniflow/ragflow-docs/main/images/set_backend_administrator_identity.jpg) - -![User Management](https://raw.githubusercontent.com/infiniflow/ragflow-docs/main/images/view_user_details_and_resource_impact.jpg) - Use the search box in the upper-right corner to search users by `Email` or `Nickname`. You can also filter `Active` or `Inactive` users by `Status`. ![View And Search Users](https://raw.githubusercontent.com/infiniflow/ragflow-docs/main/images/view_and_search_users_1.jpg) diff --git a/docs/guides/agent/ingestion_pipeline/configure_chunker_component.md b/docs/guides/agent/ingestion_pipeline/configure_chunker_component.md index 230859dc9b..9fe2aafca8 100644 --- a/docs/guides/agent/ingestion_pipeline/configure_chunker_component.md +++ b/docs/guides/agent/ingestion_pipeline/configure_chunker_component.md @@ -27,6 +27,8 @@ Use token-based chunking for text without reliable section structure. Click the | Delimiters | Defaults to `\n`, `!`, `?`, `;`, `。`, `；`, `！`, and `？`. Each entry is a separate delimiter. Edit or remove entries, or click **Add** for another delimiter; check the **Splits at** preview. | | Child chunk are used for retrieval | Splits parent chunks into smaller retrieval chunks using **Child delimiters**, which appear after enabling the switch. Disabled by default. For line-based child chunks, enable it and add `\n`. | +![Token Chunker delimiters and child chunk settings](https://raw.githubusercontent.com/infiniflow/ragflow-docs/main/images/pipeline_token_chunker_delimiters.jpg) + The output is `chunks`, an array of objects that downstream components can process. Click **Save draft** after configuring the node. [Publish and validate](./test_run.md) on a sample to check chunk boundaries, overlap, and child chunks. @@ -45,4 +47,6 @@ Use Title Chunker for documents with clear headings, such as manuals and papers. | Separate parent-heading content | Keeps content directly below a parent heading in a separate chunk. Disabled by default. | | Set first chunk as global context | Uses the first section as shared context across the heading hierarchy. Disabled by default. | +![Title Chunker hierarchy, token cap, and heading rules](https://raw.githubusercontent.com/infiniflow/ragflow-docs/main/images/pipeline_title_chunker_hierarchy_rules.jpg) + For Markdown headings, add `^# ` for level 1 and `^## ` for level 2, then select level 2. In Hierarchy mode, check that each subsection retains its parent heading. Use the output `chunks` in downstream components. diff --git a/docs/guides/agent/ingestion_pipeline/configure_indexer_component.md b/docs/guides/agent/ingestion_pipeline/configure_indexer_component.md index 9565f1fb05..b8ec1e7e6d 100644 --- a/docs/guides/agent/ingestion_pipeline/configure_indexer_component.md +++ b/docs/guides/agent/ingestion_pipeline/configure_indexer_component.md @@ -37,6 +37,8 @@ Select the content to embed: For Questions or Augmented context, first enable the corresponding function in Transformer. This setting selects embedding content; it does not replace the configured search methods. +![Indexer search methods, filename embedding weight, and Field options](https://raw.githubusercontent.com/infiniflow/ragflow-docs/main/images/pipeline_indexer_embedding_field.jpg) + ## Embedding model The model comes from the connected knowledge base, rather than an independent model selector in this panel. Knowledge bases searched together must use the same embedding model. diff --git a/docs/guides/agent/ingestion_pipeline/configure_parser_component.md b/docs/guides/agent/ingestion_pipeline/configure_parser_component.md index a4dd554646..17dd92baab 100644 --- a/docs/guides/agent/ingestion_pipeline/configure_parser_component.md +++ b/docs/guides/agent/ingestion_pipeline/configure_parser_component.md @@ -52,6 +52,8 @@ Configured OCR and vision models depend on the pipeline owner's available provid To turn OCR off, enable vision enhancement first. The panel rejects a configuration with both disabled. +![Parser image OCR settings and shared vision enhancement](https://raw.githubusercontent.com/infiniflow/ragflow-docs/main/images/pipeline_parser_image_ocr.jpg) + ## Other File Categories | Category | Configuration | diff --git a/docs/guides/agent/ingestion_pipeline/configure_transformer_component.md b/docs/guides/agent/ingestion_pipeline/configure_transformer_component.md index 42fd5429f5..e21140f083 100644 --- a/docs/guides/agent/ingestion_pipeline/configure_transformer_component.md +++ b/docs/guides/agent/ingestion_pipeline/configure_transformer_component.md @@ -33,6 +33,8 @@ The panel lists **Auto keywords**, **Auto-question**, **Tags**, **Summary**, and Enable only the functions you need. Review the prompts for your document language, required output, and business scope before processing a large collection of files. +![Transformer model, enrichment functions, and Metadata Settings](https://raw.githubusercontent.com/infiniflow/ragflow-docs/main/images/pipeline_transformer_model_and_metadata.jpg) + ## Configure Metadata 1. Expand **Metadata**, turn on its switch, and click **Settings**. diff --git a/docs/guides/agent/ingestion_pipeline/connect_the_pipeline_to_a_knowledge_base.md b/docs/guides/agent/ingestion_pipeline/connect_the_pipeline_to_a_knowledge_base.md index c63b9e3d46..ad4c9e66db 100644 --- a/docs/guides/agent/ingestion_pipeline/connect_the_pipeline_to_a_knowledge_base.md +++ b/docs/guides/agent/ingestion_pipeline/connect_the_pipeline_to_a_knowledge_base.md @@ -16,7 +16,7 @@ Publish a pipeline version before applying a custom pipeline to a Dataset. Savin 2. Find **Parsing mode** and open its dropdown. Search for the pipeline name if needed. 3. Expand the custom pipeline to view its published versions, then select the required version within the same dropdown. Use the version title and alias, when provided, to identify the intended configuration. The pipeline name itself is a group, not a selectable draft. - ![Parsing mode dropdown showing available pipelines](https://raw.githubusercontent.com/infiniflow/ragflow-docs/main/images/connect_the_pipeline_to_a_knowledge_base.jpg) + ![Parsing mode dropdown with a custom pipeline expanded to show published versions](https://raw.githubusercontent.com/infiniflow/ragflow-docs/main/images/pipeline_dataset_published_version_tree.jpg) 4. Click **Save** to apply the selection to the Dataset. 5. [Parse a sample document and inspect the results](./test_run.md) before processing more files. diff --git a/docs/guides/agent/ingestion_pipeline/create_ingestion_pipeline.md b/docs/guides/agent/ingestion_pipeline/create_ingestion_pipeline.md index 42865ac068..ea8a64d361 100644 --- a/docs/guides/agent/ingestion_pipeline/create_ingestion_pipeline.md +++ b/docs/guides/agent/ingestion_pipeline/create_ingestion_pipeline.md @@ -44,6 +44,8 @@ An editable pipeline has **Save draft**, **Publish**, and **Management** in the | Checklist | Appears when configuration issues are detected. Open it and click an issue to locate the affected component. Correct the configuration; the button disappears when no issues are detected. | | Management | Open the pipeline's variables, version history, JSON export, or settings. | +![Pipeline Save draft, Publish, and Management menu](https://raw.githubusercontent.com/infiniflow/ragflow-docs/main/images/pipeline_canvas_publish_management.jpg) + ### Management Menu | Entry | What you can do | diff --git a/docs/guides/agent/ingestion_pipeline/understand_core_ingestion_pipeline_components.md b/docs/guides/agent/ingestion_pipeline/understand_core_ingestion_pipeline_components.md index b188abb6a9..c77a460a62 100644 --- a/docs/guides/agent/ingestion_pipeline/understand_core_ingestion_pipeline_components.md +++ b/docs/guides/agent/ingestion_pipeline/understand_core_ingestion_pipeline_components.md @@ -37,4 +37,6 @@ The connection menu depends on the selected node and the components already on t 2. In the Compiler panel, select a template group under **Operator**. To create a group from this panel, click **Create template** beside the field and complete the dialog. You can also manage groups on the **Compilation operator** tab. Select the execution model under **Model** and review its model settings. The selected group determines the compilation tasks, such as a knowledge tree or wiki. 3. Connect **Compiler → Indexer** to index the original and generated chunks. Click **Save draft**, publish a version, and [validate the pipeline](./test_run.md) with a sample document. +![Compiler Operator selection, Create template, and model settings](https://raw.githubusercontent.com/infiniflow/ragflow-docs/main/images/pipeline_compiler_operator_model.jpg) + Example: **Begin → Parser → Token Chunker → Compiler → Indexer**. After parsing, check the generated content and retrieval results. If the template group or model is unavailable after import, select an accessible one. diff --git a/docs/guides/chat/Mutimodel_comparison_and_FAQ.md b/docs/guides/chat/Mutimodel_comparison_and_FAQ.md index 9a00c87792..9b259dad82 100644 --- a/docs/guides/chat/Mutimodel_comparison_and_FAQ.md +++ b/docs/guides/chat/Mutimodel_comparison_and_FAQ.md @@ -14,18 +14,20 @@ sidebar_custom_props: Multi-model comparison tests several models simultaneously with the same Chat configuration and the same question, then displays the answer generated by each model. 1. Open the Chat you want to test and click **Multiple models** above the conversation area. + + ![Open Multiple models](https://raw.githubusercontent.com/infiniflow/ragflow-docs/main/images/multi_model_comparison_1.jpg) + 2. The comparison page initially displays one model panel. Click **+** in the last panel to add another. The counter beside **Multiple models** shows the number of panels; the current UI supports up to **3**. 3. Use the model dropdown at the top of each panel to select the model for that panel. Configure the required model providers first if a model is not available. + + ![Configure model comparison panels](https://raw.githubusercontent.com/infiniflow/ragflow-docs/main/images/multi_model_comparison_2.jpg) + 4. Enter one test question in the shared message box at the bottom, select **Naive** or **Agentic** as needed, and click **Send message**. The selected models receive the same question for comparison. 5. Compare the answers side by side. Check accuracy, use of dataset evidence, completeness, and differences in the responses. 6. To remove a panel, click its trash icon. This action is available when more than one panel is present. Click **Back** to return to the normal Chat view. To use a panel's model configuration for the Chat, click its **Apply model configs** icon. This updates the Chat's saved model configuration; simply selecting a model for comparison does not apply it to the Chat. -![Select models for comparison](https://raw.githubusercontent.com/infiniflow/ragflow-docs/main/images/multi_model_comparison_1.jpg) - -![Compare model answers](https://raw.githubusercontent.com/infiniflow/ragflow-docs/main/images/multi_model_comparison_2.jpg) - Use representative questions from actual business scenarios instead of selecting a model based on a single question. Multi-model comparison is primarily intended for model selection and debugging. For example, after changing a model provider or model version, use the same questions to quickly compare the practical performance of the old and new models. # FAQ diff --git a/docs/guides/chat/chat_configuration.md b/docs/guides/chat/chat_configuration.md index e28022bdaa..1dd60aade3 100644 --- a/docs/guides/chat/chat_configuration.md +++ b/docs/guides/chat/chat_configuration.md @@ -33,6 +33,8 @@ Expand **Advanced settings** below **Datasets**. It contains shared options foll The groups configure how each mode works. To choose the mode for a question, use the selector beside the message box; expanding a group in the settings panel does not switch the conversation's mode. +![Chat advanced settings with shared options and Naive and Agentic groups](https://raw.githubusercontent.com/infiniflow/ragflow-docs/main/images/chat_advanced_settings_groups.jpg) + ### Shared Options | Setting | Purpose and operation | diff --git a/docs/guides/data_source/overview_and_page_management.md b/docs/guides/data_source/overview_and_page_management.md index 93ac456b05..080a7054ba 100644 --- a/docs/guides/data_source/overview_and_page_management.md +++ b/docs/guides/data_source/overview_and_page_management.md @@ -47,7 +47,11 @@ Area description: the connected data source area is used to manage the connectio ### Set a Connected Data Source -Click the settings button on the right side of a connected data source to enter the settings page of that connection. The settings page is used to view and maintain the configuration of the current connection. It is suitable for use when a token expires, the synchronization scope changes, the refresh frequency needs to be adjusted, or the synchronization result is abnormal. +Click the settings button on the right side of a connected data source to enter the settings page of that connection. + +![Set a Connected Data Source](https://raw.githubusercontent.com/infiniflow/ragflow-docs/2ee87008723d56cb6ebf0e9c92f6ef2ad1a45254/images/Set_a_Connected_Data_Source.jpg) + +The settings page is used to view and maintain the configuration of the current connection. It is suitable for use when a token expires, the synchronization scope changes, the refresh frequency needs to be adjusted, or the synchronization result is abnormal. Common fields on the settings page include: @@ -62,8 +66,6 @@ Common fields on the settings page include: After changing settings, click **Test connection**, then **Save**. With no unsaved changes, the primary button may show **Stop** or **Resume**, depending on the connection status. Updated settings apply to subsequent synchronization tasks. -![Set a Connected Data Source](https://raw.githubusercontent.com/infiniflow/ragflow-docs/2ee87008723d56cb6ebf0e9c92f6ef2ad1a45254/images/Set_a_Connected_Data_Source.jpg) - ### View Connected Data Source Logs A log area is provided at the bottom of the data source settings page to view synchronization task records related to the connection. Logs can help determine whether synchronization has been executed, whether it failed, and the reason for failure. diff --git a/docs/guides/file/file.md b/docs/guides/file/file.md index 3f33cfd2a2..911d108213 100644 --- a/docs/guides/file/file.md +++ b/docs/guides/file/file.md @@ -31,7 +31,7 @@ RAGFlow file management lets you build your own file system through nested folde After clicking **Add File** in the upper-right corner of the page, select **Upload File** to open the upload window. The upload control contains two tabs: **File** and **Folder**. You can select one or more files, or upload an entire folder. -![Upload files](https://raw.githubusercontent.com/infiniflow/ragflow-docs/main/images/upload_file_2.jpg) +![Open the Upload File action](https://raw.githubusercontent.com/infiniflow/ragflow-docs/main/images/upload_file_1.jpg) ### Upload File @@ -41,7 +41,7 @@ After clicking **Add File** in the upper-right corner of the page, select **Uplo 4. Confirm the list of files to be uploaded. If you selected a file by mistake, click the delete button on the right side of the file row to remove it. 5. Click **Confirm** or **Save**, then wait for the upload progress to complete. -![Upload file 1](https://raw.githubusercontent.com/infiniflow/ragflow-docs/main/images/upload_file_1.jpg) +![Review selected files in the upload dialog](https://raw.githubusercontent.com/infiniflow/ragflow-docs/main/images/upload_file_2.jpg) ### Upload Folder diff --git a/docs/guides/knowledge_compilation/apply_knowledge_compilation_template.md b/docs/guides/knowledge_compilation/apply_knowledge_compilation_template.md index 08b9a1979d..0d92246d2d 100644 --- a/docs/guides/knowledge_compilation/apply_knowledge_compilation_template.md +++ b/docs/guides/knowledge_compilation/apply_knowledge_compilation_template.md @@ -21,7 +21,7 @@ Configuration steps: 3. Open **Compiler**, select the target template group under **Operator**, and choose an available compilation model. 4. Check node connections and required parameters, click **Save draft**, then **Publish** and confirm to create a pipeline version. -![Configure Ingestion Pipeline with CompilerOperator](https://raw.githubusercontent.com/infiniflow/ragflow-docs/main/images/configure_ingestion_pipeline_apply_knowledge_compilation_template.jpg) +![Configure the Compiler operator and model](https://raw.githubusercontent.com/infiniflow/ragflow-docs/main/images/pipeline_compiler_operator_model.jpg) Note: CompilationTemplate only defines "how to compile". A KnowledgeArtifact is generated only after the template is referenced in CompilerOperator and the document actually executes this Pipeline. @@ -33,7 +33,7 @@ Note: CompilationTemplate only defines "how to compile". A KnowledgeArtifact is 4. Open **Parsing mode**, expand the ingestion pipeline that contains **Compiler**, select its published version within that dropdown, and click **Save**. If it shows **No published versions**, publish the pipeline first. 5. Start parsing and check in the task logs whether Parser, Chunker, Compiler, and Indexer complete in sequence. -![Select the compilation pipeline in Dataset configuration](https://raw.githubusercontent.com/infiniflow/ragflow-docs/main/images/connect_the_pipeline_to_a_knowledge_base.jpg) +![Select the compilation pipeline in Dataset configuration](https://raw.githubusercontent.com/infiniflow/ragflow-docs/main/images/pipeline_dataset_published_version_tree.jpg) If CompilationTemplate is modified, completed documents are not automatically recompiled. You need to reparse or rerun the Pipeline according to the operations currently provided by the product before the new configuration can be applied. diff --git a/docs/guides/memory/connect_to_an_agent.md b/docs/guides/memory/connect_to_an_agent.md index 9c6b949529..8e966ee43f 100644 --- a/docs/guides/memory/connect_to_an_agent.md +++ b/docs/guides/memory/connect_to_an_agent.md @@ -33,4 +33,4 @@ A memory must be connected to an Agent before historical messages can be written 6. Save and run a test, and check whether the answer correctly references historical memories. -![Let an agent retrieve from memory](https://raw.githubusercontent.com/infiniflow/ragflow-docs/main/images/let_an_agent_retrieve_from_memory.jpg) +![Let an agent retrieve from memory](https://raw.githubusercontent.com/infiniflow/ragflow-docs/main/images/retrieve_from_memory.PNG) diff --git a/docs/guides/models/llm_api_key_setup.md b/docs/guides/models/llm_api_key_setup.md index 2844cb73c6..a8190cc735 100644 --- a/docs/guides/models/llm_api_key_setup.md +++ b/docs/guides/models/llm_api_key_setup.md @@ -44,7 +44,7 @@ To configure a model provider: 5. Verify models individually, or click **Verify all models** to verify every model currently shown by the active search and type filters. 6. Save the instance. -![Create instance](https://raw.githubusercontent.com/infiniflow/ragflow-docs/main/images/create_instance.jpeg) +![Create instance](https://raw.githubusercontent.com/infiniflow/ragflow-docs/main/images/create_instance.jpg) :::caution Do not expose your API Key. An incorrect Base URL causes model verification or model calls to fail. When using a compatible API, confirm whether the path must include `/v1`. @@ -86,9 +86,9 @@ To add a custom model: 6. Click **Confirm** to add the model. -![Add custom model1](https://raw.githubusercontent.com/infiniflow/ragflow-docs/main/images/add_custom_model_1.png) +![Add custom model1](https://raw.githubusercontent.com/infiniflow/ragflow-docs/main/images/add_custom_model_1.jpg) -![Add custom model2](https://raw.githubusercontent.com/infiniflow/ragflow-docs/main/images/add_custom_model_2.png) +![Add custom model2](https://raw.githubusercontent.com/infiniflow/ragflow-docs/main/images/add_custom_model_2.jpg) ### Verify Models @@ -112,7 +112,7 @@ At minimum, set the following defaults: If you have configured a rerank model, it is also recommended to set a default rerank model. Configure VLM, ASR, and TTS defaults as required by your business. -![Set default models](https://raw.githubusercontent.com/infiniflow/ragflow-docs/main/images/set_default_models.jpeg) +![Set default models](https://raw.githubusercontent.com/infiniflow/ragflow-docs/main/images/set_default_models.jpg) ### Decision Model