ReplaceKnowledgeBaseSourceFile - 替换指定的企业知识库中的FILE资源并触发重新解析

更新时间:
复制 MD 格式

用于替换指定的企业知识库中的FILE资源并触发重新解析。

接口说明

请求说明

该 API 允许用户更新企业自建知识库中特定的 FILE 类型的数据源,并通过提供新的文件路径和公开访问 URL 来触发系统对该数据源的重新解析。支持同步或异步模式下的操作执行,其中同步模式下客户端将等待直到解析过程完成。

  • forceSync 参数控制是否采用同步方式处理请求,默认为 false,即以异步方式进行。

  • 当不提供 fileName 或其值为空时,新上传的文件将保留原有的文件名。

  • 必须确保提供的 filePath 和 filePublicUrl 是有效的且指向同一个文件实体。

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求语法

POST /openapi/replaceKnowledgeBaseSourceFile HTTP/1.1

请求参数

名称

类型

必填

描述

示例值

tenantId

string

否

租户 ID,公共参数;winnexo-cli 通过 --tenant-id 显式传入。

10000

sourceId

string

是

待替换的企业知识库 FILE 数据源 ID。

exampleSourceId

filePath

string

是

替换后的文件 OSS 持久化地址。

string_value

filePublicUrl

string

是

新文件的公开访问 URL(可能携带临时签名)。

https://example.com/winnexo/resource

fileRecordId

string

是

替换后的文件记录 ID。

exampleFileRecordId

fileName

string

否

新文件名(可选;不传或空字符串时保持原文件名)。

example.pdf

forceSync

boolean

否

是否同步等待重新解析完成;默认 false,异步入队。

false

返回参数

名称

类型

描述

示例值

object

替换企业知识库资源文件并重新解析

code

string

状态码。

200

message

string

状态码描述。

ok

requestId

string

请求追踪 ID。

019FF406-1B10-0065-A97D-2D1920C2A03D

sourceId

string

数据源 ID。

exampleSourceId

name

string

文件名。

示例名称.pdf

sourceType

string

数据源类型。

string_value

status

string

任务状态:提交即返回 Running。

READY

fileRecordId

string

替换后的文件记录 ID。

exampleFileRecordId

filePath

string

替换后的文件 OSS 持久化地址。

string_value

filePublicUrl

string

替换后的文件 OSS 持久化地址。

https://example.com/winnexo/resource

示例

正常返回示例

JSON格式

{
  "code": "200",
  "message": "ok",
  "requestId": "019FF406-1B10-0065-A97D-2D1920C2A03D",
  "sourceId": "exampleSourceId",
  "name": "示例名称.pdf",
  "sourceType": "string_value",
  "status": "READY",
  "fileRecordId": "exampleFileRecordId",
  "filePath": "string_value",
  "filePublicUrl": "https://example.com/winnexo/resource"
}

错误码

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

变更历史

更多信息,参考变更详情变更详情。