mirror of
https://github.com/infiniflow/ragflow.git
synced 2026-02-06 18:45:08 +08:00
revert white-space changes in docs (#12557)
### What problem does this PR solve?
Trailing white-spaces in commit 6814ace1aa
got automatically trimmed by code editor may causes documentation
typesetting broken.
Mostly for double spaces for soft line breaks.
### Type of change
- [x] Documentation Update
This commit is contained in:
Jimmy Ben Klieve
@ -5,7 +5,6 @@ sidebar_custom_props: {
|
||||
sidebarIcon: LucideCog
|
||||
}
|
||||
---
|
||||
|
||||
# Configuration
|
||||
|
||||
Configurations for deploying RAGFlow via Docker.
|
||||
|
||||
@ -5,7 +5,6 @@ sidebar_custom_props: {
|
||||
categoryIcon: LucideBookA
|
||||
}
|
||||
---
|
||||
|
||||
# Contribution guidelines
|
||||
|
||||
General guidelines for RAGFlow's community contributors.
|
||||
|
||||
@ -5,7 +5,6 @@ sidebar_custom_props: {
|
||||
categoryIcon: LucideKey
|
||||
}
|
||||
---
|
||||
|
||||
# Acquire RAGFlow API key
|
||||
|
||||
An API key is required for the RAGFlow server to authenticate your HTTP/Python or MCP requests. This documents provides instructions on obtaining a RAGFlow API key.
|
||||
|
||||
@ -5,7 +5,6 @@ sidebar_custom_props: {
|
||||
categoryIcon: LucidePackage
|
||||
}
|
||||
---
|
||||
|
||||
# Build RAGFlow Docker image
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
@ -5,7 +5,6 @@ sidebar_custom_props: {
|
||||
categoryIcon: LucideMonitorPlay
|
||||
}
|
||||
---
|
||||
|
||||
# Launch service from source
|
||||
|
||||
A guide explaining how to set up a RAGFlow service from its source code. By following this guide, you'll be able to debug using the source code.
|
||||
|
||||
@ -5,7 +5,6 @@ sidebar_custom_props: {
|
||||
categoryIcon: LucideTvMinimalPlay
|
||||
}
|
||||
---
|
||||
|
||||
# Launch RAGFlow MCP server
|
||||
|
||||
Launch an MCP server from source or via Docker.
|
||||
|
||||
@ -6,7 +6,6 @@ sidebar_custom_props: {
|
||||
}
|
||||
|
||||
---
|
||||
|
||||
# RAGFlow MCP client examples
|
||||
|
||||
Python and curl MCP client examples.
|
||||
|
||||
@ -5,7 +5,6 @@ sidebar_custom_props: {
|
||||
categoryIcon: LucideToolCase
|
||||
}
|
||||
---
|
||||
|
||||
# RAGFlow MCP tools
|
||||
|
||||
The MCP server currently offers a specialized tool to assist users in searching for relevant information powered by RAGFlow DeepDoc technology:
|
||||
|
||||
@ -5,7 +5,6 @@ sidebar_custom_props: {
|
||||
categoryIcon: LucideShuffle
|
||||
}
|
||||
---
|
||||
|
||||
# Switch document engine
|
||||
|
||||
Switch your doc engine from Elasticsearch to Infinity.
|
||||
|
||||
@ -5,7 +5,6 @@ sidebar_custom_props: {
|
||||
sidebarIcon: LucideCircleQuestionMark
|
||||
}
|
||||
---
|
||||
|
||||
# FAQs
|
||||
|
||||
Answers to questions about general features, troubleshooting, usage, and more.
|
||||
|
||||
@ -5,7 +5,6 @@ sidebar_custom_props: {
|
||||
categoryIcon: LucideSquareTerminal
|
||||
}
|
||||
---
|
||||
|
||||
# Admin CLI
|
||||
|
||||
The RAGFlow Admin CLI is a command-line-based system administration tool that offers administrators an efficient and flexible method for system interaction and control. Operating on a client-server architecture, it communicates in real-time with the Admin Service, receiving administrator commands and dynamically returning execution results.
|
||||
|
||||
@ -5,8 +5,6 @@ sidebar_custom_props: {
|
||||
categoryIcon: LucideActivity
|
||||
}
|
||||
---
|
||||
|
||||
|
||||
# Admin Service
|
||||
|
||||
The Admin Service is the core backend management service of the RAGFlow system, providing comprehensive system administration capabilities through centralized API interfaces for managing and controlling the entire platform. Adopting a client-server architecture, it supports access and operations via both a Web UI and an Admin CLI, ensuring flexible and efficient execution of administrative tasks.
|
||||
|
||||
@ -5,7 +5,6 @@ sidebar_custom_props: {
|
||||
categoryIcon: LucidePalette
|
||||
}
|
||||
---
|
||||
|
||||
# Admin UI
|
||||
|
||||
The RAGFlow Admin UI is a web-based interface that provides comprehensive system status monitoring and user management capabilities.
|
||||
|
||||
@ -5,7 +5,6 @@ sidebar_custom_props: {
|
||||
categoryIcon: RagAiAgent
|
||||
}
|
||||
---
|
||||
|
||||
# Agent component
|
||||
|
||||
The component equipped with reasoning, tool usage, and multi-agent collaboration capabilities.
|
||||
|
||||
@ -5,7 +5,6 @@ sidebar_custom_props: {
|
||||
categoryIcon: LucideMessageSquareDot
|
||||
}
|
||||
---
|
||||
|
||||
# Await response component
|
||||
|
||||
A component that halts the workflow and awaits user input.
|
||||
|
||||
@ -5,7 +5,6 @@ sidebar_custom_props: {
|
||||
categoryIcon: LucideHome
|
||||
}
|
||||
---
|
||||
|
||||
# Begin component
|
||||
|
||||
The starting component in a workflow.
|
||||
|
||||
@ -5,7 +5,6 @@ sidebar_custom_props: {
|
||||
categoryIcon: LucideSwatchBook
|
||||
}
|
||||
---
|
||||
|
||||
# Categorize component
|
||||
|
||||
A component that classifies user inputs and applies strategies accordingly.
|
||||
|
||||
@ -5,7 +5,6 @@ sidebar_custom_props: {
|
||||
categoryIcon: LucideBlocks
|
||||
}
|
||||
---
|
||||
|
||||
# Title chunker component
|
||||
|
||||
A component that splits texts into chunks by heading level.
|
||||
|
||||
@ -5,7 +5,6 @@ sidebar_custom_props: {
|
||||
categoryIcon: LucideBlocks
|
||||
}
|
||||
---
|
||||
|
||||
# Token chunker component
|
||||
|
||||
A component that splits texts into chunks, respecting a maximum token limit and using delimiters to find optimal breakpoints.
|
||||
|
||||
@ -5,7 +5,6 @@ sidebar_custom_props: {
|
||||
categoryIcon: LucideCodeXml
|
||||
}
|
||||
---
|
||||
|
||||
# Code component
|
||||
|
||||
A component that enables users to integrate Python or JavaScript codes into their Agent for dynamic data processing.
|
||||
|
||||
@ -5,7 +5,6 @@ sidebar_custom_props: {
|
||||
categoryIcon: RagSql
|
||||
}
|
||||
---
|
||||
|
||||
# Execute SQL tool
|
||||
|
||||
A tool that execute SQL queries on a specified relational database.
|
||||
|
||||
@ -5,7 +5,6 @@ sidebar_custom_props: {
|
||||
categoryIcon: RagHTTP
|
||||
}
|
||||
---
|
||||
|
||||
# HTTP request component
|
||||
|
||||
A component that calls remote services.
|
||||
|
||||
@ -5,7 +5,6 @@ sidebar_custom_props: {
|
||||
categoryIcon: LucideListPlus
|
||||
}
|
||||
---
|
||||
|
||||
# Indexer component
|
||||
|
||||
A component that defines how chunks are indexed.
|
||||
|
||||
@ -5,7 +5,6 @@ sidebar_custom_props: {
|
||||
categoryIcon: LucideRepeat2
|
||||
}
|
||||
---
|
||||
|
||||
# Iteration component
|
||||
|
||||
A component that splits text input into text segments and iterates a predefined workflow for each one.
|
||||
|
||||
@ -5,7 +5,6 @@ sidebar_custom_props: {
|
||||
categoryIcon: LucideMessageSquareReply
|
||||
}
|
||||
---
|
||||
|
||||
# Message component
|
||||
|
||||
A component that sends out a static or dynamic message.
|
||||
|
||||
@ -5,7 +5,6 @@ sidebar_custom_props: {
|
||||
categoryIcon: LucideFilePlay
|
||||
}
|
||||
---
|
||||
|
||||
# Parser component
|
||||
|
||||
A component that sets the parsing rules for your dataset.
|
||||
|
||||
@ -5,7 +5,6 @@ sidebar_custom_props: {
|
||||
categoryIcon: LucideFolderSearch
|
||||
}
|
||||
---
|
||||
|
||||
# Retrieval component
|
||||
|
||||
A component that retrieves information from specified datasets.
|
||||
|
||||
@ -5,7 +5,6 @@ sidebar_custom_props: {
|
||||
categoryIcon: LucideSplit
|
||||
}
|
||||
---
|
||||
|
||||
# Switch component
|
||||
|
||||
A component that evaluates whether specified conditions are met and directs the follow of execution accordingly.
|
||||
|
||||
@ -5,7 +5,6 @@ sidebar_custom_props: {
|
||||
categoryIcon: LucideType
|
||||
}
|
||||
---
|
||||
|
||||
# Text processing component
|
||||
|
||||
A component that merges or splits texts.
|
||||
|
||||
@ -5,7 +5,6 @@ sidebar_custom_props: {
|
||||
categoryIcon: LucideFileStack
|
||||
}
|
||||
---
|
||||
|
||||
# Transformer component
|
||||
|
||||
A component that uses an LLM to extract insights from the chunks.
|
||||
|
||||
@ -5,7 +5,6 @@ sidebar_custom_props: {
|
||||
categoryIcon: LucideBookOpenText
|
||||
}
|
||||
---
|
||||
|
||||
# Introduction to agents
|
||||
|
||||
Key concepts, basic operations, a quick view of the agent editor.
|
||||
|
||||
@ -5,7 +5,6 @@ sidebar_custom_props: {
|
||||
categoryIcon: LucideMonitorDot
|
||||
}
|
||||
---
|
||||
|
||||
# Embed agent into webpage
|
||||
|
||||
You can use iframe to embed an agent into a third-party webpage.
|
||||
|
||||
@ -5,7 +5,6 @@ sidebar_custom_props: {
|
||||
categoryIcon: LucideCodesandbox
|
||||
}
|
||||
---
|
||||
|
||||
# Sandbox quickstart
|
||||
|
||||
A secure, pluggable code execution backend designed for RAGFlow and other applications requiring isolated code execution environments.
|
||||
|
||||
@ -5,7 +5,6 @@ sidebar_custom_props: {
|
||||
categoryIcon: LucideSearch
|
||||
}
|
||||
---
|
||||
|
||||
# Search
|
||||
|
||||
Conduct an AI search.
|
||||
|
||||
@ -5,7 +5,6 @@ sidebar_custom_props: {
|
||||
categoryIcon: LucideScanSearch
|
||||
}
|
||||
---
|
||||
|
||||
# Implement deep research
|
||||
|
||||
Implements deep research for agentic reasoning.
|
||||
|
||||
@ -5,7 +5,6 @@ sidebar_custom_props: {
|
||||
categoryIcon: LucideVariable
|
||||
}
|
||||
---
|
||||
|
||||
# Set variables
|
||||
|
||||
Set variables to be used together with the system prompt for your LLM.
|
||||
|
||||
@ -5,7 +5,6 @@ sidebar_custom_props: {
|
||||
categoryIcon: LucideBot
|
||||
}
|
||||
---
|
||||
|
||||
# Start AI chat
|
||||
|
||||
Initiate an AI-powered chat with a configured chat assistant.
|
||||
|
||||
@ -5,7 +5,6 @@ sidebar_custom_props: {
|
||||
categoryIcon: SiGoogledrive
|
||||
}
|
||||
---
|
||||
|
||||
# Add Google Drive
|
||||
|
||||
## 1. Create a Google Cloud Project
|
||||
|
||||
@ -5,7 +5,6 @@ sidebar_custom_props: {
|
||||
categoryIcon: LucideFileCodeCorner
|
||||
}
|
||||
---
|
||||
|
||||
# Auto-extract metadata
|
||||
|
||||
Automatically extract metadata from uploaded files.
|
||||
|
||||
@ -5,7 +5,6 @@ sidebar_custom_props: {
|
||||
categoryIcon: LucideSlidersHorizontal
|
||||
}
|
||||
---
|
||||
|
||||
# Auto-keyword Auto-question
|
||||
import APITable from '@site/src/components/APITable';
|
||||
|
||||
|
||||
@ -5,7 +5,6 @@ sidebar_custom_props: {
|
||||
categoryIcon: LucideGroup
|
||||
}
|
||||
---
|
||||
|
||||
# Configure child chunking strategy
|
||||
|
||||
Set parent-child chunking strategy to improve retrieval.
|
||||
|
||||
@ -5,7 +5,6 @@ sidebar_custom_props: {
|
||||
categoryIcon: LucideCog
|
||||
}
|
||||
---
|
||||
|
||||
# Configure dataset
|
||||
|
||||
Most of RAGFlow's chat assistants and Agents are based on datasets. Each of RAGFlow's datasets serves as a knowledge source, *parsing* files uploaded from your local machine and file references generated in RAGFlow's File system into the real 'knowledge' for future AI chats. This guide demonstrates some basic usages of the dataset feature, covering the following topics:
|
||||
|
||||
@ -5,7 +5,6 @@ sidebar_custom_props: {
|
||||
categoryIcon: LucideWandSparkles
|
||||
}
|
||||
---
|
||||
|
||||
# Construct knowledge graph
|
||||
|
||||
Generate a knowledge graph for your dataset.
|
||||
|
||||
@ -5,7 +5,6 @@ sidebar_custom_props: {
|
||||
categoryIcon: LucideToggleRight
|
||||
}
|
||||
---
|
||||
|
||||
# Enable Excel2HTML
|
||||
|
||||
Convert complex Excel spreadsheets into HTML tables.
|
||||
|
||||
@ -5,7 +5,6 @@ sidebar_custom_props: {
|
||||
categoryIcon: LucideNetwork
|
||||
}
|
||||
---
|
||||
|
||||
# Enable RAPTOR
|
||||
|
||||
A recursive abstractive method used in long-context knowledge retrieval and summarization, balancing broad semantic understanding with fine details.
|
||||
|
||||
@ -5,7 +5,6 @@ sidebar_custom_props: {
|
||||
categoryIcon: LucideTableOfContents
|
||||
}
|
||||
---
|
||||
|
||||
# Extract table of contents
|
||||
|
||||
Extract table of contents (TOC) from documents to provide long context RAG and improve retrieval.
|
||||
|
||||
@ -5,7 +5,6 @@ sidebar_custom_props: {
|
||||
categoryIcon: LucideCode
|
||||
}
|
||||
---
|
||||
|
||||
# Manage metadata
|
||||
|
||||
Manage metadata for your dataset and for your individual documents.
|
||||
|
||||
@ -5,7 +5,6 @@ sidebar_custom_props: {
|
||||
categoryIcon: LucideTextSearch
|
||||
}
|
||||
---
|
||||
|
||||
# Run retrieval test
|
||||
|
||||
Conduct a retrieval test on your dataset to check whether the intended chunks can be retrieved.
|
||||
|
||||
@ -5,7 +5,6 @@ sidebar_custom_props: {
|
||||
categoryIcon: LucideFileText
|
||||
}
|
||||
---
|
||||
|
||||
# Select PDF parser
|
||||
|
||||
Select a visual model for parsing your PDFs.
|
||||
|
||||
@ -5,7 +5,6 @@ sidebar_custom_props: {
|
||||
categoryIcon: LucideListChevronsUpDown
|
||||
}
|
||||
---
|
||||
|
||||
# Set context window size
|
||||
|
||||
Set context window size for images and tables to improve long-context RAG performances.
|
||||
|
||||
@ -5,7 +5,6 @@ sidebar_custom_props: {
|
||||
categoryIcon: LucideCode
|
||||
}
|
||||
---
|
||||
|
||||
# Set metadata
|
||||
|
||||
Manually add metadata to an uploaded file
|
||||
|
||||
@ -5,7 +5,6 @@ sidebar_custom_props: {
|
||||
categoryIcon: LucideStickyNote
|
||||
}
|
||||
---
|
||||
|
||||
# Set page rank
|
||||
|
||||
Create a step-retrieval strategy using page rank.
|
||||
|
||||
@ -5,7 +5,6 @@ sidebar_custom_props: {
|
||||
categoryIcon: LucideTags
|
||||
}
|
||||
---
|
||||
|
||||
# Use tag set
|
||||
|
||||
Use a tag set to auto-tag chunks in your datasets.
|
||||
|
||||
@ -5,7 +5,6 @@ sidebar_custom_props: {
|
||||
categoryIcon: LucideFolderDot
|
||||
}
|
||||
---
|
||||
|
||||
# Files
|
||||
|
||||
RAGFlow's file management allows you to upload files individually or in bulk. You can then link an uploaded file to multiple target datasets. This guide showcases some basic usages of the file management feature.
|
||||
|
||||
@ -5,7 +5,6 @@ sidebar_custom_props: {
|
||||
categoryIcon: LucideMonitorCog
|
||||
}
|
||||
---
|
||||
|
||||
# Deploy local models
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
@ -5,7 +5,6 @@ sidebar_custom_props: {
|
||||
categoryIcon: LucideKey
|
||||
}
|
||||
---
|
||||
|
||||
# Configure model API key
|
||||
|
||||
An API key is required for RAGFlow to interact with an online AI model. This guide provides information about setting your model API key in RAGFlow.
|
||||
|
||||
@ -5,7 +5,6 @@ sidebar_custom_props: {
|
||||
categoryIcon: LucideLogOut
|
||||
}
|
||||
---
|
||||
|
||||
# Join or leave a team
|
||||
|
||||
Accept an invitation to join a team, decline an invitation, or leave a team.
|
||||
|
||||
@ -5,7 +5,6 @@ sidebar_custom_props: {
|
||||
categoryIcon: LucideUserCog
|
||||
}
|
||||
---
|
||||
|
||||
# Manage team members
|
||||
|
||||
Invite or remove team members.
|
||||
|
||||
@ -5,7 +5,6 @@ sidebar_custom_props: {
|
||||
categoryIcon: LucideShare2
|
||||
}
|
||||
---
|
||||
|
||||
# Share Agent
|
||||
|
||||
Share an Agent with your team members.
|
||||
|
||||
@ -5,7 +5,6 @@ sidebar_custom_props: {
|
||||
categoryIcon: LucideShare2
|
||||
}
|
||||
---
|
||||
|
||||
# Share chat assistant
|
||||
|
||||
Sharing chat assistant is currently exclusive to RAGFlow Enterprise, but will be made available in due course.
|
||||
@ -5,7 +5,6 @@ sidebar_custom_props: {
|
||||
categoryIcon: LucideShare2
|
||||
}
|
||||
---
|
||||
|
||||
# Share dataset
|
||||
|
||||
Share a dataset with team members.
|
||||
|
||||
@ -5,7 +5,6 @@ sidebar_custom_props: {
|
||||
categoryIcon: LucideShare2
|
||||
}
|
||||
---
|
||||
|
||||
# Share models
|
||||
|
||||
Sharing models is currently exclusive to RAGFlow Enterprise.
|
||||
@ -5,7 +5,6 @@ sidebar_custom_props: {
|
||||
categoryIcon: LucideLocateFixed
|
||||
}
|
||||
---
|
||||
|
||||
# Tracing
|
||||
|
||||
Observability & Tracing with Langfuse.
|
||||
|
||||
@ -5,7 +5,6 @@ sidebar_custom_props: {
|
||||
categoryIcon: LucideArrowBigUpDash
|
||||
}
|
||||
---
|
||||
|
||||
# Upgrading
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
@ -5,7 +5,6 @@ sidebar_custom_props: {
|
||||
sidebarIcon: LucideRocket
|
||||
}
|
||||
---
|
||||
|
||||
# Get started
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
@ -5,7 +5,6 @@ sidebar_custom_props: {
|
||||
categoryIcon: LucideCaseUpper
|
||||
}
|
||||
---
|
||||
|
||||
# Glossary
|
||||
|
||||
Definitions of key terms and basic concepts related to RAGFlow.
|
||||
|
||||
@ -5,7 +5,6 @@ sidebar_custom_props: {
|
||||
categoryIcon: LucideGlobe
|
||||
}
|
||||
---
|
||||
|
||||
# HTTP API
|
||||
|
||||
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).
|
||||
|
||||
@ -5,7 +5,6 @@ sidebar_custom_props: {
|
||||
categoryIcon: SiPython
|
||||
}
|
||||
---
|
||||
|
||||
# Python API
|
||||
|
||||
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).
|
||||
|
||||
@ -5,7 +5,6 @@ sidebar_custom_props: {
|
||||
categoryIcon: LucideBox
|
||||
}
|
||||
---
|
||||
|
||||
# Supported models
|
||||
|
||||
import APITable from '@site/src/components/APITable';
|
||||
|
||||
@ -5,7 +5,6 @@ sidebar_custom_props: {
|
||||
sidebarIcon: LucideClipboardPenLine
|
||||
}
|
||||
---
|
||||
|
||||
# Releases
|
||||
|
||||
Key features, improvements and bug fixes in the latest releases.
|
||||
|
||||
Reference in New Issue
Block a user