2.2.2-Query Folders or Datasets In Knowledge Base

1. Overview

• Interface name: Get folders or datasets under the knowledge base

• Version number: v1.0.0

2. Information

• Request method: GET

• Request URL: https://DOMAIN/openapi/v1/knowledge/folder/

• Domain: Refer to "Service address description"

3. Request parameters

Request header http header field:

Parameter name	Type	Required	Description
Content-Type	string	Yes	Fixedapplication/json
cybertron-robot-key	string	Yes	Robot key
cybertron-robot-token	string	Yes	Robot token

Request body field:

Parameter name	Type	Required	Description
username	string	Yes	User account
knowledge_base_id	string	Yes	Knowledge Base id
page	int	Yes	Number of pages, default is 1
pagesize	int	No	The number of results returned per page, default is 10

4. Response field description

HTTP status code: 200 OK

Response field description:

Field Name	Type	Description
code	string	"000000" is normal, other exceptions
message	string	Status description
data	object	message body
total	int	Total record number
page	int	Current page number
pagesize	int	Total pages
results	array	content
id	int	Knowledge base id, subsequent knowledge import and other interfaces need to be used
name	string	folder or dataset name
description	string	Description
count	int	Number of elements
folder_type	int	folder type (1: text dataset 2: QA dataset 3: folder)
update_time	string	update time
status	int	status
is_system_create	bool	Whether to create system
updateor	string	updater

5. Example

Request Example:

curl 'https://_DOMAIN_/openapi/v1/knowledge/folder/?username=[e-mail]&knowledge_base_id=5700&page=1&pagesize=10' \
-H 'Content-Type: application/json' \
-H 'cybertron-robot-key: l8ia2IOc************Z724%2BU%3D' \
-H 'cybertron-robot-token: MTc0Mzk5************************************************cGRCUTg9' \
-X GET -d '{}'

Response example:

{
    "code": "000000",
    "message": "ok",
    "data": {
        "total": 16,
        "page": 1,
        "pagesize": 2,
        "results": [
            {
                "id": 2939,
                "name": "Second-level folder",
                "description": "1",
                "count": 0,
                "folder_type": 3,
                "update_time": "2024-07-24 14:21:21",
                "status": 2,
                "is_system_create": false,
                "updateor": "zhengdong.zhou"
            },
            {
                "id": 2936,
                "name": "Interface Test_QA Dataset",
                "description": "",
                "count": 0,
                "folder_type": 2,
                "update_time": "2024-07-24 14:15:16",
                "status": 2,
                "is_system_create": false,
                "updateor": "zhengdong.zhou"
            }
        ]
    }
}