AI/ragflow
1
0
Fork 0
mirror of https://git.mirrors.martin98.com/https://github.com/infiniflow/ragflow.git synced 2025-08-14 17:35:53 +08:00
Code Issues Packages Projects Releases Wiki Activity

Add api.md:/api/list_kb_docs/ description (#881)

Browse Source 
### What problem does this PR solve?

Add api.md:/api/list_kb_docs/ description
#717 

### Type of change

- [x] Documentation Update
This commit is contained in:
GYH 2024-05-22 17:37:11 +08:00 committed by GitHub
parent 17489e6c6c
commit 43412571f7
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 40 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
docs/references/api.md
View File

@ -404,3 +404,43 @@ Get the chunks of the document based on doc_name or doc_id.
}
```
## Get document list from knowledge base
Get document list based on the knowledge base name and corresponding parameters.
### Path: /api/list_kb_docs/
### Method: POST
### Parameter:
| Name | Type | Optional | Description |
|-------------|--------|----------|----------------------------------------------------------------------|
| `kb_name` | string | No | The name of the knowledge base, from which you get the document list. |
| `page` | int | Yes | The number of pages, default:1. |
| `page_size` | int | Yes | The number of docs for each page, default:15. |
| `orderby` | string | Yes | `chunk_num`, `create_time`, or `size`, default:`create_time` |
| `desc` | bool | Yes | Default:True. |
| `keywords` | string | Yes | Keyword of the document name. |
### Response
```json
{
"data": {
"docs": [
{
"doc_id": "bad89a84168c11ef9ce40242ac120006",
"doc_name": "test.xlsx"
},
{
"doc_id": "641a9b4013f111efb53f0242ac120006",
"doc_name": "1111.pdf"
}
],
"total": 2
},
"retcode": 0,
"retmsg": "success"
}
```