From 7fb6a120676244e74694efc6839f7d826c9023a6 Mon Sep 17 00:00:00 2001 From: Wang Qi Date: Fri, 24 Apr 2026 20:36:47 +0800 Subject: [PATCH] Update API document (#14364) ### What problem does this PR solve? Update API document ### Type of change - [ ] Documentation Update --- AGENTS.md | 2 +- CLAUDE.md | 2 +- docs/develop/build_docker_image.mdx | 2 +- docs/references/http_api_reference.md | 8 ++++---- 4 files changed, 7 insertions(+), 7 deletions(-) diff --git a/AGENTS.md b/AGENTS.md index 82d23b9903..b558df135a 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -35,7 +35,7 @@ The project uses **uv** for dependency management. 1. **Setup Environment**: ```bash uv sync --python 3.12 --all-extras - uv run download_deps.py + uv run python3 download_deps.py ``` 2. **Run Server**: diff --git a/CLAUDE.md b/CLAUDE.md index f42613a669..81888ba3d7 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -52,7 +52,7 @@ RAGFlow is an open-source RAG (Retrieval-Augmented Generation) engine based on d ```bash # Install Python dependencies uv sync --python 3.12 --all-extras -uv run download_deps.py +uv run python3 download_deps.py pre-commit install # Start dependent services diff --git a/docs/develop/build_docker_image.mdx b/docs/develop/build_docker_image.mdx index 7e8462813c..f19cc07810 100644 --- a/docs/develop/build_docker_image.mdx +++ b/docs/develop/build_docker_image.mdx @@ -36,7 +36,7 @@ This image is approximately 2 GB in size and relies on external LLM and embeddin ```bash git clone https://github.com/infiniflow/ragflow.git cd ragflow/ -uv run download_deps.py +uv run python3 download_deps.py docker build -f Dockerfile.deps -t infiniflow/ragflow_deps . docker build -f Dockerfile -t infiniflow/ragflow:nightly . ``` diff --git a/docs/references/http_api_reference.md b/docs/references/http_api_reference.md index 06e1a3a47b..a76fd2274e 100644 --- a/docs/references/http_api_reference.md +++ b/docs/references/http_api_reference.md @@ -7323,16 +7323,16 @@ or --- -### Convert files to documents and link them to datasets +### Links files to datasets and convert to documents -**POST** `/v1/file2document/convert` +**POST** `/api/v1/files/link-to-datasets` Converts files to documents and links them to specified datasets. #### Request - Method: POST -- URL: `/v1/file2document/convert` +- URL: `/api/v1/files/link-to-datasets` - Headers: - `'Content-Type: application/json'` - `'Authorization: Bearer '` @@ -7344,7 +7344,7 @@ Converts files to documents and links them to specified datasets. ```bash curl --request POST \ - --url http://{address}/v1/file2document/convert \ + --url http://{address}/api/v1/files/link-to-datasets \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer ' \ --data '{