1. 接口描述
接口请求域名： lke.tencentcloudapi.com 。
获取企业下应用详情
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeApp。 |
| Version | 是 | String | 公共参数，本接口取值：2023-11-30。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| AppBizId | 是 | String | 应用ID |
| AppType | 否 | String | 应用类型；knowledge_qa-知识问答管理；summary-知识摘要；classifys-知识标签提取 |
| IsRelease | 否 | Boolean | 是否发布后的配置 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| AppBizId | String | 应用 ID |
| AppType | String | 应用类型；knowledge_qa-知识问答管理；summary-知识摘要；classifys-知识标签提取 示例值：knowledge_qa |
| AppTypeDesc | String | 应用类型说明 |
| BaseConfig | BaseConfig | 应用类型说明 |
| AppConfig | AppConfig | 应用配置 |
| AvatarInAppeal | Boolean | 头像是否在申诉中 |
| RoleInAppeal | Boolean | 角色描述是否在申诉中 |
| NameInAppeal | Boolean | 名称是否在申诉中 |
| GreetingInAppeal | Boolean | 欢迎语是否在申诉中 |
| BareAnswerInAppeal | Boolean | 未知问题回复语是否在申诉中 |
| AppKey | String | 应用appKey |
| AppStatus | Integer | 应用状态，1：未上线，2：运行中，3：停用 |
| AppStatusDesc | String | 状态说明 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 DescribeApp
获取企业下应用详情
输入示例
POST / HTTP/1.1
Host: lke.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeApp
<公共请求参数>
{
"AppBizId": "应用ID",
"AppType": "knowledge_qa"
}输出示例
{
"Response": {
"AppBizId": "应用ID",
"AppConfig": {
"KnowledgeQa": {
"Greeting": "欢迎语",
"Model": {
"AliasName": "精调知识大模型高级版",
"ContextLimit": 0,
"Desc": "应用描述",
"HistoryLimit": 5,
"IsUseContext": true,
"Name": "cs-normal-70b",
"TokenBalance": 0,
"Temperature": "0.5",
"TopP": "0.5"
},
"Output": {
"BareAnswer": "保守回复语",
"Method": 1,
"QuestionClarifyKeywords": [],
"ShowQuestionClarify": false,
"UseGeneralKnowledge": true,
"UseQuestionClarify": false,
"UseRecommended": false
},
"Pattern": "standard",
"Plugins": [
{
"Inputs": [
{
"DefaultValue": "",
"Desc": "用户的query",
"IsRequired": true,
"Name": "Query",
"SubParams": [],
"Type": 0
}
],
"IsBindingKnowledge": true,
"PluginIcon": "https://qidian-qbot-1251316161.cos.ap-guangzhou.myqcloud.com/public/插件.png",
"PluginId": "3ad9ddae-587e-4bcc-ae07-ad13bfb1aaca",
"PluginName": "知识库问答",
"ToolDesc": "大模型结合知识库内容回答用户问题",
"ToolId": "0ca8d482-1e77-462b-bc21-xddd7c8f052f69",
"ToolName": "KnowledgeRetrievalAnswer"
}
],
"RoleDescription": "角色描述",
"Search": [
{
"Confidence": 0.7,
"DocTopN": 0,
"IsEnabled": true,
"QaTopN": 3,
"ReplyFlexibility": 1,
"ResourceStatus": 0,
"ShowSearchEngine": false,
"Type": "qa",
"UseSearchEngine": false
},
{
"Confidence": 0,
"DocTopN": 0,
"IsEnabled": false,
"QaTopN": 0,
"ReplyFlexibility": 0,
"ResourceStatus": 0,
"ShowSearchEngine": false,
"Type": "search",
"UseSearchEngine": false
},
{
"Confidence": 0.2,
"DocTopN": 5,
"IsEnabled": true,
"QaTopN": 0,
"ReplyFlexibility": 0,
"ResourceStatus": 0,
"ShowSearchEngine": false,
"Type": "doc",
"UseSearchEngine": false
},
{
"Confidence": 0,
"DocTopN": 0,
"IsEnabled": false,
"QaTopN": 0,
"ReplyFlexibility": 0,
"ResourceStatus": 0,
"ShowSearchEngine": false,
"Type": "taskflow",
"UseSearchEngine": false
}
],
"SearchRange": {
"ApiVarAttrInfos": [
{
"ApiVarId": "自定义变量ID",
"AttrBizId": "标签ID"
}
],
"Condition": "and"
},
"Workflow": {
"IsEnabled": true,
"UsePdl": false
},
"SearchStrategy": {
"StrategyType": 0,
"TableEnhancement": false
},
"SingleWorkflow": {
"IsEnable": false,
"Status": "单工作流状态",
"WorkflowDesc": "单工作流描述",
"WorkflowId": "单工作流ID",
"WorkflowName": "单工作流名称"
},
"ThoughtModel": {
"AliasName": "精调Function-call模型",
"ContextLimit": 0,
"Desc": "",
"HistoryLimit": 0,
"IsUseContext": false,
"Name": "function-call-pro",
"Temperature": "0.5",
"TokenBalance": 0,
"TopP": "0.5"
}
}
},
"AppKey": "应用秘钥",
"AppStatus": 2,
"AppStatusDesc": "运行中",
"AppType": "knowledge_qa",
"AppTypeDesc": "知识库问答",
"AvatarInAppeal": false,
"BareAnswerInAppeal": false,
"BaseConfig": {
"Avatar": "头像",
"Desc": "",
"Name": "我的智能应用"
},
"GreetingInAppeal": false,
"NameInAppeal": false,
"RequestId": "485126ca-468c-497b-ab96-b939a8e125bd",
"RoleInAppeal": false
}
}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. 错误码
该接口暂无业务逻辑相关的错误码，其他错误码详见 公共错误码。
