1. 接口描述
接口请求域名： lowcode.tencentcloudapi.com 。
获取知识库下文档详情
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeKnowledgeDocumentSetDetail。 |
| Version | 是 | String | 公共参数，本接口取值：2021-01-08。 |
| Region | 否 | String | 公共参数，本接口不需要传递此参数。 |
| CollectionView | 是 | String | 知识库标识 示例值：qinmyku873d0a9 |
| DocumentSetName | 否 | String | 文件名 示例值： my-test.md |
| DocumentSetId | 否 | String | 文件id 示例值：1232343434511 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Data | DescribeKnowledgeDocumentSetDetailRsp | 新增文件返回信息 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取知识库下文档详情
获取知识库下文档详情
输入示例
POST / HTTP/1.1
Host: lowcode.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeKnowledgeDocumentSetDetail
<公共请求参数>
{
"CollectionView": "gqtianTest222666",
"DocumentSetId": "1248479222486937399296"
}输出示例
{
"Response": {
"Data": {
"Count": 1,
"DocumentSet": {
"DocumentSetId": "1248479222486937399296",
"FileTitle": "kent测试文件",
"FileMetaData": "{\"url\": \"https://ww.com\", \"total\": 3}",
"DocumentSetInfo": {
"ByteLength": 46,
"CreateTime": "2024-06-07 11:31:45",
"IndexedProgress": 100,
"IndexedStatus": "Ready",
"Keywords": "",
"LastUpdateTime": "2024-06-07 11:31:46",
"TextLength": 20
},
"DocumentSetName": "jackzlqin.md",
"Name": "",
"Author": "",
"SplitterPreprocess": {
"AppendKeywordsToChunk": false,
"AppendTitleToChunk": true
},
"Text": "1. 入门微搭的技术文档\n2. 学习微搭",
"TextPrefix": "1. 入门微搭的技术文档\n2. 学习微搭......"
}
},
"RequestId": "b404ff44-6bc3-4f60-8185-2ff4d9be5b63"
}
}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
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameter | 参数错误。 |
