Modifying Document Directories

Function

Modify document directories for a knowledge base.

URI

PUT /v1/{project_id}/applications/{application_id}/uni-search/{repo_id}/directory/{directory_id}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
directory_id	Yes	String	Directory ID. The value can contain a maximum of 64 characters.
project_id	Yes	String	Definition: Project ID. For details about how to obtain the project ID, see Obtaining a Project ID. Constraints: N/A Value range: The value can contain 1 to 64 characters. Only digits, letters, hyphens (-), and underscores (_) are allowed. The value must start with a letter. Default value: N/A
application_id	Yes	String	Definition: Application ID. For details about how to obtain the application ID, see Obtaining an Application ID. Constraints: Character string Value range: The value can contain 1 to 64 characters. Only digits, letters, hyphens (-), and underscores (_) are allowed. The value must start with a letter. Default value: N/A
repo_id	Yes	String	Definition: Knowledge base ID. How to obtain: Log in to the KooSearch experience platform. In the navigation tree on the left, choose Knowledge Bases to view knowledge base IDs. Each knowledge base has a unique ID stored in the vector database. Constraints: N/A Value range: Length: 1 to 64 characters. The value can contain only digits, letters, hyphens (-), and underscores (_). Default value: N/A

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition: Token used for API authentication. For details about how to obtain the token, see Obtaining an IAM User Token. Constraints: N/A Value range: N/A Default value: N/A

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
name	No	String	Definition: Directory name. Constraints: N/A Value range: 1 to 64 characters. Default value: N/A
parent_id	No	String	Definition: ID of the parent directory. Constraints: N/A Value range: 1 to 64 characters. Default value: N/A

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
directory_id	String	Definition: Directory ID. Value range: N/A

Status code: 400

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Definition: Error Code. Value range: N/A
error_msg	String	Definition: Error message. Value range: N/A

Status code: 500

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Definition: Error Code. Value range: N/A
error_msg	String	Definition: Error message. Value range: N/A

Example Requests

Modify document directories for a knowledge base.

/v1/{project_id}/applications/{application_id}/uni-search/{repo_id}/directory/{directory_id}

{
  "name" : "New nodes",
  "parent_id" : "4d119341-c949-40e1-bce2-5983ae1ad888"
}