帮你快速理解、总结文档立即下载

查询 QA 详情

最近更新时间:2026-09-14 20:50:15
我的收藏

1. 接口描述

接口请求域名: adp.tencentcloudapi.com 。

查询 QA 详情

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeQA。
Version String 公共参数,本接口取值:2026-05-20。
Region String 公共参数,详见产品支持的 地域列表
KbId String

所属知识库 ID


示例值:2097880104242874048
QaId String

QA ID


示例值:2097880162191295680

3. 输出参数

参数名称 类型 描述
HighlightList Array of QASegmentHighlight

分片高亮信息

PageContent String

分片内容


示例值:数据5:
:
王大力

98

李二虎

99

赵二狗

90
QuestionDescription String

问题描述


示例值:成绩
SimilarQuestionList Array of SimilarQuestion

相似问列表

Summary QASummary

基础信息


注意:此字段可能返回 null,表示取不到有效值。
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询 QA 详情

查询 QA 详情

输入示例

POST / HTTP/1.1
Host: adp.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeQA
<公共请求参数>

{
    "KbId": "2097880104242874048",
    "QaId": "2097880162191295680"
}

输出示例

{
    "Response": {
        "Summary": {
            "QaId": "2097880162191295680",
            "Metadata": {
                "Question": "qa_batch_q2_adp_qta_piCYLj",
                "Answer": "答案2",
                "QaCharCount": "29",
                "QaSize": "33",
                "RefFieldNameList": []
            },
            "CategoryPath": {
                "CategoryId": "2097880106271627712",
                "CategoryIdPath": [
                    "0"
                ],
                "CategoryNamePath": [
                    "全部分类"
                ]
            },
            "Lifecycle": {
                "CreateTime": "1789008582",
                "UpdateTime": "1789008625",
                "ExpirationPolicy": {
                    "EffectivePeriod": {
                        "StartTime": "1789008595",
                        "EndTime": "1789094967"
                    }
                },
                "Status": 8,
                "StatusDesc": "导入完成",
                "StatusMessage": ""
            },
            "KnowledgeScope": {
                "EffectiveDomain": 4,
                "LabelRefList": []
            },
            "OperatorInfo": {
                "Modifier": {
                    "UserId": "13351",
                    "UserName": ""
                },
                "Permission": {
                    "CanEdit": true,
                    "CanDelete": true,
                    "CanAccept": false
                }
            },
            "SourceInfo": {
                "SourceType": 3,
                "SourceDesc": "手动录入",
                "DocId": "0",
                "FileName": "",
                "FileType": "",
                "DocEffectiveDomain": 0
            },
            "SimilarQuestion": {
                "SimilarQuestionCount": 0,
                "SimilarQuestionTips": ""
            }
        },
        "SimilarQuestionList": [],
        "QuestionDescription": "",
        "PageContent": "",
        "HighlightList": [],
        "RequestId": "cf2c1e16-54c7-4b15-ae40-96b3f55932db"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码