mirror of
https://github.com/infiniflow/ragflow.git
synced 2026-06-29 15:31:05 +08:00
Update API document (#14364)
### What problem does this PR solve? Update API document ### Type of change - [ ] Documentation Update
This commit is contained in:
@@ -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**:
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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 .
|
||||
```
|
||||
|
||||
@@ -7323,16 +7323,16 @@ or
|
||||
##### Request example
|
||||
|
||||
```bash
|
||||
curl --request POST \
|
||||
curl --request POST \
|
||||
--url http://{address}/api/v1/files/link-to-datasets \
|
||||
--header 'Content-Type: application/json' \
|
||||
--header 'Content-Type: application/json' \
|
||||
--header 'Authorization: Bearer <YOUR_API_KEY>' \
|
||||
--data '{
|
||||
"file_ids": ["file_id_1", "file_id_2"],
|
||||
"kb_ids": ["dataset_id_1", "dataset_id_2"]
|
||||
}'
|
||||
```
|
||||
|
||||
|
||||
##### Request parameters
|
||||
|
||||
- `"file_ids"`: (*Body parameter*), `list[string]`, *Required*
|
||||
@@ -7344,7 +7344,7 @@ Converts files to documents and links them to specified datasets.
|
||||
|
||||
Success:
|
||||
|
||||
```json
|
||||
```json
|
||||
{
|
||||
"code": 0,
|
||||
"data": [
|
||||
|
||||
Reference in New Issue
Block a user