Domain name for API request: adp.intl.tencentcloudapi.com.
Knowledge retrieval
A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: SearchKnowledge. |
| Version | Yes | String | Common Params. The value used for this API: 2026-05-20. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| AdvancedConfig | Yes | SearchAdvancedConfig | Advanced search configuration |
| Input | Yes | SearchInput | Retrieval input |
| Context | No | SearchContext | Retrieval context |
| SearchBilling | No | SearchBilling | Billing information |
| Parameter Name | Type | Description |
|---|---|---|
| KnowledgeList | Array of KnowledgeResult | Search results list |
| TokenUsageList | Array of TokenUsage | token consumption statistics |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
POST / HTTP/1.1
Host: adp.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: SearchKnowledge
<Common request parameters>
{
"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": "What is a lungfish"
},
"Context": {
"CallSource": 5
}
}{
"Response": {
"KnowledgeList": [
{
"Confidence": 0.5791762,
"KnowledgeType": 2,
"RecallTypeList": [
2
],
"ResultPayload": {
"GraphData": "",
"ImageUrlList": [],
"SheetInfo": ""
},
"ResultType": 0,
"SimilarQuestionExtra": {
"Content": "",
"SimilarQuestionId": "0"
},
"SnippetProfile": {
"Content": "Document name: Lungfish\nDocument fragment: Lungfish are an ancient type of fish with unique physiological structures and survival abilities, belonging to the order Dipnoi under the subclass Sarcopterygii of the class Osteichthyes. They first appeared around 400 million years ago during the Devonian period and are one of the oldest existing fish species.\n\n\nMain features\n\n\nRespiration: Lungfish have two respiratory organs: gills and lungs. In water, they breathe mainly through gills; when the water dries up, they can use a specialized swim bladder (called a \"lung\") to breathe air directly.\n\n\nMorphology: Lungfish have a slender body, with thick and powerful pectoral and pelvic fins that allow them to walk on the bottom. Their scales are small and their body is eel-like, helping them move flexibly through dense aquatic vegetation.\n\n\nSurvival ability: Lungfish can survive in dry environments. When rivers dry up, they drill into the mud, form a cocoon-like structure, breathe through the lungs and internal nostrils, and wait for the rainy season to return.\n\n\nDistribution and types\n\n\nDistribution: Existing lungfish are mainly distributed in the freshwater environments of South America, Africa, and Australia.\n\n\nTypes: The order Dipnoi includes two main families: Lepidosirenidae and Protopteridae. Among them, the Australian lungfish, South American lungfish, and African lungfish are common types.\n\n\nLiving habits\n\n\nDiet: Lungfish feed on crustaceans, mollusks, and worms. They have a powerful bite force and can prey on shelled invertebrates.\n\n\nReproduction: Lungfish have diverse reproduction methods. Some species lay eggs in aquatic plants, and the larvae have no external gills and develop without metamorphosis; other species require metamorphosis, and the larvae\n\n\nProtection status\n\n\nDue to their unique physiological features and important scientific research value, lungfish are listed in \"Appendix I, Appendix II, and Appendix III of the Convention on International Trade in Endangered Species of Wild Fauna and Flora\" and are subject to international protection.\n"
"DocId": "2079848099272955712",
"DocName": "Lungfish.txt",
"KbId": "2079847931153870720",
"KnowledgeId": "2079848160140695360",
"Question": "",
"Title": "Lungfish"
},
"SourceInfo": {
"IsBigData": false,
"IsShared": false,
"KbName": ""
}
}
],
"TokenUsageList": [
{
"CompletionTokens": 0,
"ModelName": "Youtu/youtu-embedding",
"PromptTokens": 16,
"TotalTokens": 16
}
],
"RequestId": "e06aa6d0-1811-480b-b21d-900bc835e6da"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
There is no error code related to the API business logic. For other error codes, please see Common Error Codes.
文档反馈