RegisterKnowledgeBaseFile - 注册知识库 OSS 文件

更新时间:
复制 MD 格式

注册知识库 OSS 文件

调试

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

调试

授权信息

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

请求语法

POST  HTTP/1.1

请求参数

名称

类型

必填

描述

示例值

RegionId

string

知识库所在的地域 ID。

cn-beijing

KnowledgeBaseId

string

知识库 ID。

pkb-2ze123456789abcd

FilePath

string

已上传文件的 OSS Object Key,不包含 oss://BucketName/ 前缀。

pks-2ze123456789abcd/pkb-2ze123456789abcd/example.pdf

返回参数

名称

类型

描述

示例值

object

Schema of Response

FileId

string

文件 ID,由服务端按照 OSS 原生文件的 ETL 规则生成。

3566626f-3cc5-57a3-904c-e777b39baa3d

FileName

string

文件名。

example.pdf

FilePath

string

已注册文件的 OSS Object Key。

pks-2ze123456789abcd/pkb-2ze123456789abcd/example.pdf

Idempotent

boolean

是否命中已有的幂等记录。取值:true(是);false(否)。

false

RequestId

string

请求 ID。

9C3E5A7B-12D4-4F68-9A01-2B3C4D5E6F70

Status

string

文件处理状态。

DISPATCHED

示例

正常返回示例

JSON格式

{
  "FileId": "3566626f-3cc5-57a3-904c-e777b39baa3d",
  "FileName": "example.pdf",
  "FilePath": "pks-2ze123456789abcd/pkb-2ze123456789abcd/example.pdf",
  "Idempotent": false,
  "RequestId": "9C3E5A7B-12D4-4F68-9A01-2B3C4D5E6F70",
  "Status": "DISPATCHED"
}

错误码

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

变更历史

更多信息,参考变更详情