更新切片

更新时间:
复制 MD 格式

使用 UpdateChunks 接口批量更新切片的标题、内容或状态。

前提条件

  • 已创建 AgentStorage 实例且状态为 normal,并获取实例访问地址(endpoint)和实例名。

  • 已创建 API Key。

  • 待更新的切片所属知识库与文档已存在。

请求参数

参数

类型

说明

knowledgeBaseName

string

知识库名称(必填)

subspace

string

子空间名称。开启 subspace 时必填

chunks

list<object>

要更新的切片列表(必填)。单次最多 10 个

chunks[].docId

string

文档 ID。与 `ossKey` 二选一

chunks[].ossKey

string

OSS 路径。与 `docId` 二选一

chunks[].chunkId

int

切片 ID(必填)

chunks[].title

string

更新标题,最大 100 Token

chunks[].content

string

更新内容,默认最大 512 Token,按服务端统计的 Token 数计算;如实例另有配额配置,以实际配置为准

chunks[].status

string

修改状态:`active`(可检索)或 `inactive`(不可检索)

请求示例

使用 API Key 认证时,通过 x-ots-instancename 和 x-ots-apikey 请求头传入实例名和 API Key。

curl -X POST https://<endpoint>/UpdateChunks \
  -H "x-ots-instancename: <instance-name>" \
  -H "x-ots-apikey: <your-api-key>" \
  -H "Content-Type: application/json" \
  -d '{
  "knowledgeBaseName": "product_docs_kb",
  "subspace": "default",
  "chunks": [
    {"ossKey": "oss://example-bucket/docs/manual.pdf", "chunkId": 0, "status": "inactive"},
    {"ossKey": "oss://example-bucket/docs/manual.pdf", "chunkId": 1, "title": "更新后的标题", "content": "更新后的内容"}
  ]
}'

响应

字段

类型

说明

updateDetails[].docId

string

文档 ID

updateDetails[].ossKey

string

OSS 路径

updateDetails[].chunkId

int

切片 ID

updateDetails[].updateStatus

string

succeed` 或 `failed

updateDetails[].failureReason

string

失败原因,仅 failed 时