Skip to content

RAGFlow is an agent-native database: a Retrieval-Augmented Generation (RAG) engine that grew into context infrastructure.

docs(api): spell the recommendation endpoint the way the server registers it (#18764)

MarMar Labsd3542463c962
diff --git a/api/apps/backward_compat.py b/api/apps/backward_compat.py
index 3b4c682919..82b20994f5 100644
--- a/api/apps/backward_compat.py
+++ b/api/apps/backward_compat.py
@@ -41,7 +41,7 @@ Deprecated APIs and their replacements:
- GET /api/v1/document/download/{doc_id} -> GET /api/v1/agents/attachments/{doc_id}/download
- GET /v1/document/download/{attachment_id} -> GET /api/v1/agents/attachments/{attachment_id}/download
- GET /v1/system/healthz -> GET /api/v1/system/healthz
-- POST /api/v1/sessions/related_questions -> POST /api/v1/chat/recommandation
+- POST /api/v1/sessions/related_questions -> POST /api/v1/chat/recommendation
- PUT (chunk update) -> PATCH (chunk update)
"""
diff --git a/docs/references/http_api_reference.md b/docs/references/http_api_reference.md
index 6eaf6dc4e7..51aca8135e 100644
--- a/docs/references/http_api_reference.md
+++ b/docs/references/http_api_reference.md
@@ -36,7 +36,7 @@ The following v0.24.0 REST API paths are deprecated. They remain available throu
| **POST** `/api/v1/chats_openai/{chat_id}/chat/completions` | **POST** `/api/v1/openai/{chat_id}/chat/completions` |
| **PUT** `/api/v1/chats/{chat_id}/sessions/{session_id}` | **PATCH** `/api/v1/chats/{chat_id}/sessions/{session_id}` |
| **POST** `/api/v1/chats/{chat_id}/completions` | **POST** `/api/v1/chat/completions` |
-| **POST** `/api/v1/sessions/related_questions` | **POST** `/api/v1/chat/recommandation` |
+| **POST** `/api/v1/sessions/related_questions` | **POST** `/api/v1/chat/recommendation` |
| **PUT** `/api/v1/datasets/{dataset_id}/documents/{document_id}/chunks/{chunk_id}` | **PATCH** `/api/v1/datasets/{dataset_id}/documents/{document_id}/chunks/{chunk_id}` |
| **GET** `/v1/system/healthz` | **GET** `/api/v1/system/healthz` |
| **POST** `/v1/document/upload_info` | **POST** `/api/v1/documents/upload` |
@@ -5425,7 +5425,7 @@ Failure:
### Generate related questions
-**POST** `/api/v1/chat/recommandation`
+**POST** `/api/v1/chat/recommendation`
Generates five to ten alternative question strings from the user's original query to retrieve more relevant search results.
@@ -5444,7 +5444,7 @@ The chat model autonomously determines the number of questions to generate based
#### Request
- Method: POST
-- URL: `/api/v1/chat/recommandation`
+- URL: `/api/v1/chat/recommendation`
- Headers:
- `'content-Type: application/json'`
- `'Authorization: Bearer <YOUR_LOGIN_TOKEN>'`
@@ -5456,7 +5456,7 @@ The chat model autonomously determines the number of questions to generate based
```bash
curl --request POST \
- --url http://{address}/api/v1/chat/recommandation \
+ --url http://{address}/api/v1/chat/recommendation \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <YOUR_LOGIN_TOKEN>' \
--data '{