UpdateChunk - 修改切片

修改知识库中指定文本切片的内容(content)和标题(title),并设置是否参与知识库检索。

接口说明

  • 关键限制:本接口仅支持文档搜索类知识库,不支持数据查询和图片问答类知识库。
  • 权限要求
    • RAM 用户(子账号):需先获取阿里云百炼的 API 权限(可使用AliyunBailianDataFullAccess策略,该策略已包含本接口所需的 sfm:UpdateChunk 权限点),并加入一个业务空间后,才能调用本接口。
    • 阿里云账号(主账号):默认拥有权限,可直接调用。
  • 调用方式:推荐使用最新版阿里云百炼 SDK调用,SDK 已封装复杂的签名计算逻辑,可简化您的调用过程。
  • 生效延迟:更新后通常立即生效,高峰期可能稍有延迟(秒级)。
  • 幂等性:本接口具有幂等性。对已成功更新的文本切片进行重复操作时,接口将返回成功响应。

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

调试

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

授权信息

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

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

请求语法

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

请求参数

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

知识库 ID,即通过 CreateIndex 接口创建时返回的Data.Id,或在知识库页面获取。

79c0alxxxx
DataIdstring

文件 ID,即 AddFile 接口返回的FileId,也可在阿里云百炼控制台的应用数据-文件页签,单击对应文件旁的 ID 图标获取。

doc_c134aa2073204a5d936d870bf960f56axxxxxxxx
ChunkIdstring

需要修改的文本切片 ID,可通过 ListChunks 接口获取,其值位于返回结果中 Node.Metadata._id 字段。

llm-5ip55o1zrzxx_09fe52x_xxxxx_033b551e10024029992e79767b151fxx_10024xx_0
IsDisplayedChunkContentboolean

指定此文本切片是否参与知识库检索。可能值:

  • true:参与。
  • false:不参与。

默认值为 true。

true
contentstring

文本切片的新内容。内容长度必须在 10 到 6000 个字符之间,且不能超过创建知识库时设定的最大分段长度。

在哲学中所获得的确定性类型不是科学的确定性(即对每个人的理智来说都一样的确定性),而是一种要在人类的整体本质中才能获得的亲证。哲学的每一形态都不同于科学,因为所有的哲学都没有得到一致的认可...
WorkspaceIdstring

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

llm-3z7uw7fwz0vexxxx
titlestring

文本切片的新标题。长度限制为 0-50 个字符,允许传入空字符串。如果传入空字符串,将清空已有标题;如果不传此参数,则保持原标题不变。

什么是哲学

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。

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

错误状态码。

Messagestring

错误信息。

Successboolean

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

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

请求成功返回的业务数据。

true
Statusstring

接口返回的状态码。

200

示例

正常返回示例

JSON格式

{
  "RequestId": "35A267BF-xxxx-54DB-8394-AA3B0742D833\n",
  "Code": "",
  "Message": "",
  "Success": true,
  "Data": true,
  "Status": 200
}

错误码

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