腾讯云微搭低代码上传知识库文档

1. 接口描述

接口请求域名： lowcode.tencentcloudapi.com 。

更新知识库

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：UploadKnowledgeDocumentSet。
Version	是	String	公共参数，本接口取值：2021-01-08。
Region	否	String	公共参数，本接口不需要传递此参数。
EnvId	是	String	环境ID 示例值：lowcode-sdf
CollectionView	是	String	知识库标识示例值：qinmyku873d0a9
FileName	是	String	状态;ENABLED启用；NOT_ENABLED不启用示例值：my-test.md
CosUrl	是	String	腾讯云文件存储位置的可读地址示例值：http://example.myqcloud.com/file.txt
DocumentType	否	String	文件类型，例如: .docx, .md 示例值：.md
DocumentDesc	否	String	对文件的描述示例值：一个md文件
FileTitle	否	String	文件标题示例值：文件标题
FileMetaData	否	String	文件元信息，为jsonstring 示例值：{"url":"","title":"标题"}
DocumentSetId	否	String	文件id 示例值：id

3. 输出参数

参数名称	类型	描述
Data	UploadKnowledgeDocumentSetRsp	新增文件返回信息
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 UploadKnowledgeDocumentSet

上传知识库文档

输入示例

POST / HTTP/1.1
Host: lowcode.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UploadKnowledgeDocumentSet
<公共请求参数>

{
    "EnvId": "lowcode-1gk9y5ik310a94df",
    "CollectionView": "qinmyku873d0a97",
    "CosUrl": "https://6c6f-lowcode-5g5llxbq5bc9299e-1300677802.tcb.qcloud.la/weda-uploader/5e471ea6d1891cced441b68df1022023-新手指引.md",
    "FileName": "jackzlqin-test1.md",
    "DocumentDesc": "test-qin-11",
     "FileTitle":"kent测试文件",
    "FileMetaData":"{\"url\":\"https://ww.com\",\"total\":3}",
    "DocumentSetId":"1258635496046329856"
}

输出示例

{
    "Response": {
        "Data": {
            "DocumentSetId": "1248563007152455680",
            "DocumentSetName": "jackzqlin-test.md",
            "FileTitle": "kent测试文件",
            "FileMetaData": "{\"url\":\"https://ww.com\",\"total\":3}"
        },
        "RequestId": "0f27f7a7-2d8a-456a-8de9-2e794f3f8e74"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
InvalidParameter	参数错误。