1. 接口描述
接口请求域名: lke.tencentcloudapi.com 。
修改应用请求结构体
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:ModifyApp。 |
Version | 是 | String | 公共参数,本接口取值:2023-11-30。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
AppBizId | 是 | String | 应用 ID |
AppType | 是 | String | 应用类型;knowledge_qa-知识问答管理;summary-知识摘要;classifys-知识标签提取 |
BaseConfig | 是 | BaseConfig | 应用基础配置 |
AppConfig | 是 | AppConfig | 应用配置 |
LoginSubAccountUin | 否 | String | 登录用户子账号(集成商模式必填) 示例值:6000005624511 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
AppBizId | String | 应用App 注意:此字段可能返回 null,表示取不到有效值。 |
UpdateTime | String | 更新时间 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 修改应用
修改应用
输入示例
POST / HTTP/1.1
Host: lke.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyApp
<公共请求参数>
{
"AppBizId": "1801166480814637056",
"AppType": "knowledge_qa",
"BaseConfig": {
"Avatar": "头像",
"Desc": "应用描述",
"Name": "我的应用"
},
"AppConfig": {
"KnowledgeQa": {
"Greeting": "欢迎语",
"Model": {
"Name": "cs-normal",
"IsUseContext": true,
"HistoryLimit": 1,
"AliasName": "精调知识大模型标准版",
"ContextLimit": 0,
"Desc": "",
"TokenBalance": 0,
"Temperature": "0.5",
"TopP": "0.5"
},
"Output": {
"Method": 1,
"BareAnswer": "针对您这个问题,我暂时还无法进行回答,请换一个问题吧。",
"UseGeneralKnowledge": false
},
"Pattern": "standard",
"Plugins": [
{
"PluginId": "3ad9ddae-587e-4bcc-ae07-ad13bfb1aaca",
"ToolId": "0ca8d482-1e77-462b-bc21-xddd7c8f052f69"
}
],
"RoleDescription": "角色:客服\n技能:提供客户支持、解决技术问题\n说法风格:耐心、友好\n性格特点:专业、细心\n角色限制:只能回答与产品或服务相关的问题",
"Search": [
{
"Confidence": 0.2,
"DocTopN": 3,
"IsEnabled": true,
"QaTopN": 0,
"ReplyFlexibility": 0,
"ResourceStatus": 0,
"ShowSearchEngine": false,
"Type": "doc",
"UseSearchEngine": false
},
{
"Confidence": 0.9,
"DocTopN": 0,
"IsEnabled": true,
"QaTopN": 2,
"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": "taskflow",
"UseSearchEngine": false
},
{
"Confidence": 0,
"DocTopN": 0,
"IsEnabled": true,
"QaTopN": 0,
"ReplyFlexibility": 0,
"ResourceStatus": 2,
"ShowSearchEngine": false,
"Type": "search",
"UseSearchEngine": true
}
],
"SearchRange": {
"ApiVarAttrInfos": [
{
"ApiVarId": "7a6d67e0-eff1-406b-b092-3b8072c19570",
"AttrBizId": "18537d934840613760"
}
],
"Condition": "and"
},
"SearchStrategy": {
"StrategyType": 0,
"TableEnhancement": false
},
"Workflow": {
"IsEnabled": true,
"UsePdl": false
},
"SingleWorkflow": {
"WorkflowId": "单工作流ID"
},
"ThoughtModel": {
"AliasName": "精调Function-call模型",
"ContextLimit": 0,
"Desc": "",
"HistoryLimit": 0,
"IsUseContext": false,
"Name": "function-call-pro",
"TokenBalance": 0,
"Temperature": "0.5",
"TopP": "0.5"
}
}
}
}
输出示例
{
"Response": {
"AppBizId": "198848848484848",
"RequestId": "dwec-adsdsdsd-sfsfdsfsf"
}
}
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. 错误码
该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码。