1. 接口描述
接口请求域名： lkeap.tencentcloudapi.com 。
用于检索知识库中的文档和问答对内容。 使用场景：适用于查询长期存储在知识库中的文档和问答对，比如产品手册、用户指南等内容的检索。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：RetrieveKnowledge。 |
| Version | 是 | String | 公共参数，本接口取值：2024-05-22。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| KnowledgeBaseId | 是 | String | 知识库ID。 示例值：1840331836752986944 |
| Query | 是 | String | 用于检索的文本。 示例值：国庆放几天假 |
| RetrievalMethod | 否 | String | 检索方法，默认使用HYBRID混合检索。- SEMANTIC：语义检索- FULL_TEXT：全文检索- HYBRID：混合检索示例值：SEMANTIC |
| RetrievalSetting | 否 | RetrievalSetting | 检索设置。 示例值：{"TopK":3,"ScoreThreshold":0.7} |
| AttributeLabels.N | 否 | Array of LabelItem | 标签过滤。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Records | Array of RetrievalRecord | 检索结果 示例值：[{"Metadata":{"Type":"DOC","ResultSource":"SEMANTIC","ChunkPageNumbers":[1,2]},"Title":"example.pdf","Content":"国庆放7天假"}] |
| TotalCount | Integer | 检索结果数量 示例值：3 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 语义检索
语义检索
输入示例
POST / HTTP/1.1
Host: lkeap.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: RetrieveKnowledge
<公共请求参数>
{
"KnowledgeBaseId": "49019910106",
"Query": "国庆节放几天假",
"RetrievalMethod": "SEMANTIC",
"RetrievalSetting": {
"TopK": 3,
"ScoreThreshold": 0.7
}
}输出示例
{
"Response": {
"Records": [
{
"Metadata": {
"Type": "DOC",
"ResultSource": "SEMANTIC",
"ChunkPageNumbers": [
1
]
},
"Title": "example.pdf",
"Content": "国庆放七天假"
}
],
"TotalCount": 1,
"RequestId": "d422c101-96e6-4aeb-b51c-0ccb551a5a52"
}
}示例2 语义检索（问答对）
RetrievalSetting.Type参数为QA时，仅检索问答对。
输入示例
POST / HTTP/1.1
Host: lkeap.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: RetrieveKnowledge
<公共请求参数>
{
"KnowledgeBaseId": "49019910106",
"Query": "国庆节放几天假",
"RetrievalMethod": "SEMANTIC",
"RetrievalSetting": {
"Type": "QA"
}
}输出示例
{
"Response": {
"Records": [
{
"Metadata": {
"Type": "QA",
"ResultSource": "SEMANTIC"
},
"Title": "",
"Content": "国庆放七天假"
}
],
"TotalCount": 1,
"RequestId": "d422c101-96e6-4aeb-b51c-0ccb551a5a52"
}
}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. 错误码
该接口暂无业务逻辑相关的错误码，其他错误码详见 公共错误码。
