2.2.3-Modify Folders or Datasets In Knowledge Base

1. Overview

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

• Version number: v1.0.0

2. Information

• Request method: PUT

• 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
name	string	Yes	Dataset or folder name
folder_id	int	Yes	Dataset or folder id
description	string	No	Dataset or folder description
query_examples	string	No	Dataset or folder query examples

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
parent	int	Dataset or folder parent id
knowledge_base	int	Knowledge base id, subsequent knowledge import and other interfaces need to be used
id	int	Dataset or folder id
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)
status	int	status
is_system_create	bool	Whether to create system
updateor	string	updater
root_id	int	Root directory id
editor	string	editor
is_delete	bool	is delete

5. Example

Request Example:

curl --location --request PUT 'https://_DOMAIN_/openapi/v1/knowledge/folder/' \
--header 'cybertron-robot-key: l8ia2IOc************Z724%2BU%3D' \
--header 'cybertron-robot-token: MTc0Mzk5************************************************cGRCUTg9' \
--header 'Content-Type: application/json' \
--data '{
    "username": "[e-mail]",
    "knowledge_base_id": "1178",
    "name": "test_interface",
    "folder_id": 4548,
    "description": "test interface",
    "query_examples": "hi"
    }'

Response example:

{    
    "code": "000000",
    "message": "ok",
    "data": {
        "id": 4548,
        "parent": null,
        "knowledge_base": 1178,
        "name": "test_interface",
        "description": "test interface",
        "count": 0,
        "folder_type": 3,
        "root_id": 4548,
        "query_examples": "hi",
        "status": 2,
        "is_system_create": false,
        "creator": 61,
        "editor": null,
        "is_delete": false
    }