1. 接口描述
接口请求域名: lke.tencentcloudapi.com 。
问答详情
默认接口请求频率限制:100次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeQA。 |
Version | 是 | String | 公共参数,本接口取值:2023-11-30。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
QaBizId | 是 | String | QA业务ID 示例值:1903999940055016768 |
BotBizId | 是 | String | 应用ID 示例值:1887842680054218000 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
QaBizId | String | QA业务ID 示例值:1903999940055016768 |
Question | String | 问题 示例值:哪吒2 |
Answer | String | 答案 示例值:《哪吒之魔童闹海》(亦称《哪吒贰之魔童闹海》,简称《哪吒2》 |
CustomParam | String | 自定义参数 |
Source | Integer | 来源 1-文档生成问答对 2-批量导入问答对 3-单条手动录入问答对 示例值:3 |
SourceDesc | String | 来源描述 示例值:手动录入 |
UpdateTime | String | 更新时间 示例值:1742783938 |
Status | Integer | 状态 1-未校验 2-未发布 3-发布中 4-已发布 5-发布失败 6-不采纳 7-审核中 8-审核失败 9-审核失败申诉后人工审核中 11-审核失败申诉后人工审核不通过 12-已过期 13-超量失效 14-超量失效恢复 19-学习中 20-学习失败 示例值:2 |
StatusDesc | String | 状态描述 示例值:未发布 |
CateBizId | String | 分类ID 示例值:1887842680872108032 |
IsAllowAccept | Boolean | 是否允许校验 |
IsAllowDelete | Boolean | 是否允许删除 |
IsAllowEdit | Boolean | 是否允许编辑 |
DocBizId | String | 文档id |
FileName | String | 文档名称 |
FileType | String | 文档类型 |
SegmentBizId | String | 分片ID |
PageContent | String | 分片内容 |
Highlights | Array of Highlight | 分片高亮内容 |
OrgData | String | 分片内容 |
AttrRange | Integer | 标签适用范围 |
AttrLabels | Array of AttrLabel | 标签 |
ExpireStart | String | 有效开始时间,unix时间戳 |
ExpireEnd | String | 有效结束时间,unix时间戳,0代表永久有效 |
SimilarQuestions | Array of SimilarQuestion | 相似问列表信息 |
QaAuditStatus | Integer | 问题和答案文本审核状态 1审核失败 |
PicAuditStatus | Integer | 答案中的图片审核状态 1审核失败 |
VideoAuditStatus | Integer | 答案中的视频审核状态 1审核失败 |
QuestionDesc | String | 问题描述 |
IsDisabled | Boolean | 问答是否停用,false:未停用,true已停用 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取QA详情
获取QA详情
输入示例
POST / HTTP/1.1
Host: lke.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeQA
<公共请求参数>
{
"BotBizId": "1887842680054218752",
"QaBizId": "1903999940055016768"
}
输出示例
{
"Response": {
"Answer": "《**哪吒之魔童闹海**》(亦称《**哪吒贰之魔童闹海**》,简称《**哪吒2**》)。",
"AttrLabels": [],
"AttrRange": 1,
"CateBizId": "1887842680872108032",
"CustomParam": "",
"DocBizId": "0",
"ExpireEnd": "0",
"ExpireStart": "1742783934",
"FileName": "",
"FileType": "",
"Highlights": [],
"IsAllowAccept": false,
"IsAllowDelete": true,
"IsAllowEdit": true,
"OrgData": "",
"PageContent": "",
"PicAuditStatus": 0,
"QaAuditStatus": 0,
"QaBizId": "1903999940055016768",
"Question": "哪吒2",
"QuestionDesc": "",
"RequestId": "7250f0e2-6d40-476a-aa15-0b5a51269a05",
"SegmentBizId": "0",
"SimilarQuestions": [],
"Source": 3,
"SourceDesc": "手动录入",
"Status": 2,
"StatusDesc": "待发布",
"UpdateTime": "1742783970",
"VideoAuditStatus": 0
}
}
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. 错误码
该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码。