1. 接口描述
接口请求域名: adp.tencentcloudapi.com 。
知识检索
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:SearchKnowledge。 |
| Version | 是 | String | 公共参数,本接口取值:2026-05-20。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
| AdvancedConfig | 是 | SearchAdvancedConfig | 检索高级配置 |
| Input | 是 | SearchInput | 检索输入 |
| Context | 否 | SearchContext | 检索上下文 |
| SearchBilling | 否 | SearchBilling | 计费信息 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| KnowledgeList | Array of KnowledgeResult | 检索结果列表 |
| TokenUsageList | Array of TokenUsage | 消耗的 token 统计 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 知识检索
输入示例
POST / HTTP/1.1
Host: adp.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: SearchKnowledge
<公共请求参数>
{
"AdvancedConfig": {
"FinalRerankConfig": {
"ModelName": "Youtu/youtu-reranker-llm"
},
"KbRetrievalList": [
{
"DbRetrievalConfig": {
"Enabled": true
},
"DocRetrievalConfig": {
"Confidence": 0.2,
"Enabled": true,
"TopN": 5
},
"KbId": "2067622575842400832",
"QaRetrievalConfig": {
"Confidence": 0.7,
"Enabled": true,
"TopN": 3
},
"RerankConfig": {
"Enabled": true,
"ModelName": "Youtu/youtu-reranker-llm"
},
"StrategyType": 0,
"TextToSqlModel": {
"Alias": "DeepSeek-V4-Flash",
"HistoryLimit": 0,
"ModelId": "Deepseek/deepseek-v4-flash"
}
}
],
"KnowledgeType": 1,
"RecallCount": 13
},
"Input": {
"Question": "什么是肺鱼"
},
"Context": {
"CallSource": 5
}
}
输出示例
{
"Response": {
"KnowledgeList": [
{
"Confidence": 0.5791762,
"KnowledgeType": 2,
"RecallTypeList": [
2
],
"ResultPayload": {
"GraphData": "",
"ImageUrlList": [],
"SheetInfo": ""
},
"ResultType": 0,
"SimilarQuestionExtra": {
"Content": "",
"SimilarQuestionId": "0"
},
"SnippetProfile": {
"Content": "文档名:肺鱼\n文档片段:肺鱼是一类具有独特生理结构和生存能力的古老鱼类,属于硬骨鱼纲肉鳍鱼亚纲肺鱼目。它们最早出现在距今约4亿年前的泥盆纪时期,是现存最古老的鱼类之一。\n\n\n主要特征\n\n\n呼吸方式:肺鱼具有鳃和肺两个呼吸器官。在水中,它们主要通过鳃呼吸;在水体干涸时,可以利用特化的鱼鳔(称为“肺”)直接呼吸空气。\n\n\n形态结构:肺鱼的体态修长,胸鳍和腹鳍肥厚有力,可以在水底行走。它们的鳞片细小,身体呈鳗状,有助于在水草丛生的环境中灵活穿梭。\n\n\n生存能力:肺鱼能够在干旱的环境中生存。当河水干涸时,它们会钻入泥土中,形成茧状结构,通过肺部和内鼻孔呼吸,等待雨季到来。\n\n\n分布与种类\n\n\n分布:现存的肺鱼主要分布在南美洲、非洲和澳大利亚的淡水环境中。\n\n\n种类:肺鱼目包括两个主要的科——美洲肺鱼科和非洲肺鱼科。其中,澳洲肺鱼、美洲肺鱼和非洲肺鱼是较为常见的种类。\n\n\n生活习性\n\n\n食性:肺鱼以甲壳类、软体动物和蠕虫等为食,具有强大的咬合力,能够捕食带壳的无脊椎动物。\n\n\n繁殖:肺鱼的繁殖方式多样,有的种类会在水生植物中产卵,幼鱼无外鳃,发育无需经过变态;而有的种类则需要经过变态,幼鱼\n\n\n保护现状\n\n\n肺鱼因其独特的生理特性和重要的科研价值,被列入《濒危野生动植物种国际贸易公约附录Ⅰ、附录Ⅱ和附录Ⅲ》,受到国际保护。\n",
"DocId": "2079848099272955712",
"DocName": "肺鱼.txt",
"KbId": "2079847931153870720",
"KnowledgeId": "2079848160140695360",
"Question": "",
"Title": "肺鱼"
},
"SourceInfo": {
"IsBigData": false,
"IsShared": false,
"KbName": ""
}
}
],
"TokenUsageList": [
{
"CompletionTokens": 0,
"ModelName": "Youtu/youtu-embedding",
"PromptTokens": 16,
"TotalTokens": 16
}
],
"RequestId": "e06aa6d0-1811-480b-b21d-900bc835e6da"
}
}
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. 错误码
该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码。