DeleteIndexDocument

Deletes one or more documents from a specified unstructured knowledge base permanently. You cannot use the API to delete structured documents, see the Usage notes section of this topic.

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.
• Only documents with the INSERT_ERROR and FINISH states can be deleted. To query the status of documents in a specified knowledge base, call the ListIndexDocuments operation.
• After you delete a document, it cannot be recovered and the Retrieve operation cannot query information about the document. 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:
  • For mandatory resource types, indicate with a prefix of * .
  • 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:DeleteIndexDocument	delete	* All Resources *	none	none

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
WorkspaceId	string	Yes	The ID of the workspace to which the knowledge base belongs. To view the workspace ID, you can click the Workspace Details icon in the upper-left corner on the homepage of the console.	ws_3Nt27MYcoK191ISp
IndexId	string	Yes	The primary key ID of the knowledge base, which is the Data.Id parameter returned by the CreateIndex operation.	79c0aly8zw
DocumentIds	array	Yes	The list of the primary key IDs of the documents.
	string	Yes	The primary key ID of the document. To view the ID, you can click the ID icon next to the file name on the Data Management page.	file_5f03dfea56da4050ab68d61871fc4cb3_10151493

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
Code	string	HTTP status code	Index.InvalidParameter
Data	object	The parameters returned by the operation.
DeletedDocument	array	The list of primary key IDs of documents that are deleted.
deleted	string	The primary key ID of the document.	file_5f03dfea56da4050ab68d61871fc4cb3_10151493
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",
  "Data": {
    "DeletedDocument": [
      "file_5f03dfea56da4050ab68d61871fc4cb3_10151493"
    ]
  },
  "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.