DeleteIndex - Alibaba Cloud Model Studio - Alibaba Cloud Documentation Center

Deletes a specified knowledge base permanently.

Operation description

Before you call this operation, make sure that your knowledge base is created and is not deleted. That is, the primary key ID of the knowledge base IndexId is valid.
If a knowledge base is being called by an application, disassociate the knowledge base before you can delete it. To disassociate the knowledge base, you must use the console. For more information, see Create a knowledge base.
After you delete a knowledge base, it cannot be recovered. We recommend that you proceed with caution.
Imported documents are not deleted from the Data Management if you call this operation.
This interface is idempotent.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
sfm:DeleteIndex	none	All Resources ``	none	none

Request syntax

POST /{WorkspaceId}/index/delete HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
IndexId	string	Yes	The primary key ID of the knowledge base, which is the `Data.Id` parameter returned by the CreateIndex operation.	f89ie0fj5a
WorkspaceId	string	Yes	The ID of the workspace to which the knowledge base belongs. You can click the Workspace Details icon in the upper-left corner on the homepage of the console to view the workspace ID.	ws_3AXoiweeTyTd03IN

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
Code	string	HTTP status code	Index.InvalidParameter
Message	string	The error message.	Required parameter(%s) missing or invalid, please check the request parameters.
RequestId	string	The request ID.	17204B98-xxxx-4F9A-8464-2446A84821CA
Status	string	The status code.	200
Success	boolean	Indications whether the API call is successful. Valid values: true false	true

Examples

Sample success responses

JSONformat

{
  "Code": "Index.InvalidParameter",
  "Message": "Required parameter(%s) missing or invalid, please check the request parameters.",
  "RequestId": "17204B98-xxxx-4F9A-8464-2446A84821CA",
  "Status": "200",
  "Success": true
}

Error codes

For a list of error codes, visit the Service error codes.