DeleteChunk - 删除切片

从指定的非结构化/结构化知识库中永久删除一个或多个文本切片。

接口说明

  • RAM 用户(子账号)需要首先获取阿里云百炼的 API 权限(需要AliyunBailianDataFullAccess,已包括 sfm:DeleteChunk 权限点),然后才能调用本接口。阿里云账号(主账号)可直接调用无须授权。建议您通过最新版阿里云百炼 SDK来调用本接口。
  • 本接口具有幂等性。

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

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
sfm:DeleteChunkdelete
*全部资源
*

请求语法

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

请求参数

名称类型必填描述示例值
PipelineIdstring

知识库 ID,即 CreateIndex 接口返回的Data.Id

79c0alxxxx
WorkspaceIdstring

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

llm-3z7uw7fwz0vexxxx
ChunkIdsarray

待删除文本切片 ID 列表(单次最多传入 10 个文本切片 ID)。

string

文本切片 ID,即 ListChunks 接口返回的 Node 对象里Metadata中的_id字段。

llm-5ip55o1zrzxx_09fe52x_xxxxx_033b551e10024029992e79767b151fxx_10024xx_0

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。

35A267BF-xxxx-54DB-8394-AA3B0742D833
Codestring

错误状态码。

InvalidParameter
Messagestring

错误信息。

Required parameter(%s) missing or invalid, please check the request parameters.
Successboolean

接口调用是否成功,可能值:

  • true:成功。
  • false:失败。
true
Databoolean

接口业务数据字段。

true
Statusstring

接口返回的状态码。

200

示例

正常返回示例

JSON格式

{
  "RequestId": "35A267BF-xxxx-54DB-8394-AA3B0742D833\n",
  "Code": "InvalidParameter\n",
  "Message": "Required parameter(%s) missing or invalid, please check the request parameters.\n",
  "Success": true,
  "Data": true,
  "Status": 200
}

错误码

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