DeleteFile - 删除文档_大模型服务平台百炼(Model Studio)-阿里云帮助中心

永久性删除指定的非结构化文档。

接口说明

本接口用于删除数据管理中相应的文档，不会影响已构建好的知识库。如果您需要删除知识库中的文档，请调用 DeleteIndexDocument 接口。
本接口仅能删除状态为解析失败（PARSE_FAILED）或解析完成（PARSE_SUCCESS）的文档。
本接口具有幂等性。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
sfm:DeleteFile	delete	全部资源 *	无	无

请求语法

DELETE /{WorkspaceId}/datacenter/file/{FileId}/

请求参数

名称	类型	必填	描述	示例值
FileId	string	是	文档的主键 ID，即 AddFile 接口返回的`FileId`。您也可以在数据管理页面，单击文件名称旁的 ID 图标获取。	file_9a65732555b54d5ea10796ca5742ba22_xxxxxxxx
WorkspaceId	string	是	文档所属的业务空间 ID。在百炼的控制台首页，单击页面左上角业务空间详情图标获取。	llm-3shx2gu255oxxxx

返回参数

名称	类型	描述	示例值
	object	Schema of Response
Code	string	错误状态码。	InvalidParameter
Data	object	接口业务数据字段。
FileId	string	文档主键 ID。	file_9a65732555b54d5ea10796ca5742ba22_xxxxxxxx
Message	string	错误信息。	Current file status does not support delete.
RequestId	string	请求 ID。	17204B98-xxxx-4F9A-8464-2446A84821CA
Status	string	接口返回的状态码。	200
Success	boolean	接口调用是否成功，可能值为： true：成功。 false：失败。	true

示例

正常返回示例

JSON格式

{
  "Code": "InvalidParameter",
  "Data": {
    "FileId": "file_9a65732555b54d5ea10796ca5742ba22_xxxxxxxx"
  },
  "Message": "Current file status does not support delete.",
  "RequestId": "17204B98-xxxx-4F9A-8464-2446A84821CA",
  "Status": "200",
  "Success": true
}

错误码

访问错误中心查看更多错误码。