DeleteFile_大模型服务平台百炼_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

  • 暂不支持通过 API 删除结构化文档。如需删除数据表或表中特定的数据,请前往应用数据操作。
  • 本接口用于删除应用数据中相应的非结构化文档,不会影响已构建好的知识库。如果您需要删除知识库中的非结构化文档,请调用 DeleteIndexDocument 接口。
  • RAM 用户(子账号)需要首先获取百炼的数据权限(需要AliyunBailianDataFullAccess,已包括 sfm:DeleteFile 权限点),然后才能调用本接口,详见为 RAM 用户授予数据权限。阿里云账号(主账号)可直接调用无须授权。建议您通过最新版百炼 SDK来调用本接口。
  • 本接口仅能删除状态为解析失败(PARSE_FAILED)或解析完成(PARSE_SUCCESS)的文档。
  • 本接口具有幂等性。

限流说明: 本接口频繁调用会被限流,频率请勿超过 10 次/秒。如遇限流,请稍后重试。

流控信息

当前云产品API请求速率暂未透出。

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

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

请求语法

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

路径参数

字段名称字段详情
FileIdstring

文档 ID,即 AddFile 接口返回的FileId。您也可以在应用数据页面,单击文件名称旁的 ID 图标获取。

示例值:file_9a65732555b54d5ea10796ca5742ba22_xxxxxxxx参考取值来源:
    AddFile
    ListFile
    UpdateFileTag
WorkspaceIdstring

文档所属的业务空间 ID。获取方式请参见如何使用业务空间

示例值:llm-3shx2gu255oxxxx

返回参数

字段名称字段详情
Codestring

错误状态码。

示例值:InvalidParameter
Dataobject

接口业务数据字段。

Messagestring

错误信息。

示例值:Current file status does not support delete.
RequestIdstring

请求 ID。

示例值:17204B98-xxxx-4F9A-8464-2446A84821CA
Statusstring

接口返回的状态码。

示例值:200
Successboolean

接口调用是否成功,可能值为:展开详情

示例值:true

返回示例

变更历史

暂无变更历史

相关示例