From 1e5c5abe58715ed6d86b998d5df12f8b9b5012d6 Mon Sep 17 00:00:00 2001 From: GYH <43509927+guoyuhao2330@users.noreply.github.com> Date: Thu, 23 May 2024 15:19:58 +0800 Subject: [PATCH] Update api_md document/rm (#894) ### What problem does this PR solve? Update api_md document/rm #717 ### Type of change - [x] Documentation Update --- docs/references/api.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/docs/references/api.md b/docs/references/api.md index b0012531b..974c87d4d 100644 --- a/docs/references/api.md +++ b/docs/references/api.md @@ -444,3 +444,27 @@ Get document list based on the knowledge base name and corresponding parameters. } ``` + +## Delete document + +Delete document by document id or document name. +### Path: /api/document/rm/ +### Method: POST + +### Parameter: + +| Name | Type | Optional | Description | +|-------------|--------|----------|----------------------------| +| `doc_names` | List | Yes | The list of document name. | +| `doc_ids` | List | Yes | The list of document id. | + + +### Response +```json +{ + "data": true, + "retcode": 0, + "retmsg": "success" +} + +```