tencent cloud

DescribeQA
Last updated: 2025-10-30 21:48:42
DescribeQA
Last updated: 2025-10-30 21:48:42

1. API Description

Domain name for API request: lke.intl.tencentcloudapi.com.

This API is used to query Q&A details.

A maximum of 100 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

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: DescribeQA.
Version Yes String Common Params. The value used for this API: 2023-11-30.
Region Yes String Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-jakarta.
QaBizId Yes String Q&A business ID.
BotBizId Yes String Application ID.

3. Output Parameters

Parameter Name Type Description
QaBizId String Q&A business ID.
Question String Question.
Answer String Answer.
CustomParam String Custom parameter.
Source Integer Source:
1 - Q&A pairs generated from documents.
2 - Q&A pairs imported in batches.
3 - Q&A pairs input manually one by one.
SourceDesc String Source description.
UpdateTime String Update time.
Status Integer Status
1 - pending verification; 2 - not released; 3 - releasing; 4 - released; 5 - release failed; 6 - not approved; 7 - under review; 8 - review failed, 9 - review failed, pending manual review after appeal; 11 - review failed, manual review not passed after appeal; 12 - expired; 13 - excessive invalid; 14 - excessive invalid recovered; 19 - learning; 20 - learning failed.
StatusDesc String Status description.
CateBizId String Category ID.
IsAllowAccept Boolean Whether verification is allowed.
IsAllowDelete Boolean Whether deletion is allowed.
IsAllowEdit Boolean Whether editing is allowed.
DocBizId String Document ID.
FileName String Document name.
FileType String Document type.
SegmentBizId String Segment ID.
PageContent String Segment content.
Highlights Array of Highlight Segment highlight content.
OrgData String Segment content.
AttrRange Integer Applicable scope of label.
AttrLabels Array of AttrLabel Label.
ExpireStart String Effective start time, unix timestamp.
ExpireEnd String Effective end time, unix timestamp. 0 indicates permanent validity.
SimilarQuestions Array of SimilarQuestion Similar question list information.
QaAuditStatus Integer Review status of Q&A text: 1 - review failed.
PicAuditStatus Integer Review status of image in Q&A: 1-review failed.
VideoAuditStatus Integer Review status of video in Q&A: 1 - review failed.
QuestionDesc String Question description.
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.

4. Example

Example1 Get Q&A Details

Get Q&A details.

Input Example

POST / HTTP/1.1
Host: lke.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeQA
<Common request parameters>

{
    "QaBizId": "162734",
    "BotBizId": "1714970520775950336"
}

Output Example

{
    "Response": {
"Answer": "**Nezha: Birth of the Demon Child** (also known as **Nezha II: Birth of the Demon Child**, abbreviated as **Nezha 2**)"        "AttrLabels": [],
        "AttrRange": 1,
        "CateBizId": "0",
        "DocBizId": "0",
        "FileName": "",
        "FileType": "",
        "Highlights": [],
        "IsAllowAccept": false,
        "IsAllowDelete": true,
        "IsAllowEdit": true,
        "OrgData": "",
        "PageContent": "",
        "QaBizId": "162734",
        Question": "Nezha 2"
        "RequestId": "9e3ce8ca-6175-4925-b24d-6555c8dc6084",
        "SegmentBizId": "0",
        "Source": 3,
        SourceDesc": "manual entry"
        "Status": 2,
        StatusDesc": "to be released"
        "UpdateTime": "1701939988"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

There is no error code related to the API business logic. For other error codes, please see Common Error Codes.

Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback