1. 接口描述
接口请求域名： lowcode.tencentcloudapi.com 。
知识库文档搜索接口
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：SearchDocList。 |
| Version | 是 | String | 公共参数，本接口取值：2021-01-08。 |
| Region | 否 | String | 公共参数，本接口不需要传递此参数。 |
| EnvId | 是 | String | 环境ID 示例值：lowcode-xxx |
| CollectionView | 否 | String | 知识库名称 示例值：collection_view |
| SearchKey | 否 | String | 搜索模式 示例值：id |
| SearchValue | 否 | String | 搜索值 示例值：value |
| PageNo | 否 | Integer | 页码 示例值：1 |
| PageSize | 否 | Integer | 页大小 示例值：10 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Data | SearchDocRsp | 知识库文档搜索数据 示例值：{ "DocInfos": [ ], "Total": 0 } |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 知识库文档搜索接口
根据关键字搜索知识库文档
输入示例
POST / HTTP/1.1
Host: lowcode.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: SearchDocList
<公共请求参数>
{
"EnvId": "prod-1",
"CollectionView": "view",
"SearchKey": "key",
"SearchValue": "value",
"PageNo": 1,
"PageSize": 1
}输出示例
{
"Response": {
"Data": {
"DocInfos": [
{
"CollectionViewName": "name",
"DocSetId": "00-11",
"DocSetName": "abc.md",
"DocType": ".md",
"FileTitle": "title",
"FileMetaData": "{\"key\":\"value\"}",
"DocDesc": "desc",
"FileSize": 0
}
],
"Total": 10
},
"RequestId": "1cc82948-244f-4812-bb2a-25a8a473d312"
}
}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: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
该接口暂无业务逻辑相关的错误码，其他错误码详见 公共错误码。
