GYH commited on
Commit
3b1b360
·
1 Parent(s): 2436df2

Update api_md document/rm (#894)

Browse files

### What problem does this PR solve?

Update api_md document/rm
#717

### Type of change

- [x] Documentation Update

Files changed (1) hide show
  1. docs/references/api.md +24 -0
docs/references/api.md CHANGED
@@ -444,3 +444,27 @@ Get document list based on the knowledge base name and corresponding parameters.
444
  }
445
 
446
  ```
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
444
  }
445
 
446
  ```
447
+
448
+ ## Delete document
449
+
450
+ Delete document by document id or document name.
451
+ ### Path: /api/document/rm/
452
+ ### Method: POST
453
+
454
+ ### Parameter:
455
+
456
+ | Name | Type | Optional | Description |
457
+ |-------------|--------|----------|----------------------------|
458
+ | `doc_names` | List | Yes | The list of document name. |
459
+ | `doc_ids` | List | Yes | The list of document id. |
460
+
461
+
462
+ ### Response
463
+ ```json
464
+ {
465
+ "data": true,
466
+ "retcode": 0,
467
+ "retmsg": "success"
468
+ }
469
+
470
+ ```