DescribeAttributeLabel

Last updated:2025-10-30 21:48:47

DescribeAttributeLabel

Last updated: 2025-10-30 21:48:47

1. API Description

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

This API is used to query attribute label 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: DescribeAttributeLabel.
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.
BotBizId	Yes	String	Application ID.
AttributeBizId	Yes	String	Attribute ID.
Limit	Yes	Integer	Quantity loaded each time.
LoginUin	No	String	Log in to user's root account (required in integrator mode).
LoginSubAccountUin	No	String	Log in to user's sub-account (required in integrator mode).
Query	No	String	Query a label or similar labels.
LastLabelBizId	No	String	The label ID of the scroll loading cursor.
QueryScope	No	String	Query scope: all (or leave it blank): standard words and similar words standard: standard words similar: similar words

3. Output Parameters

Parameter Name	Type	Description
AttributeBizId	String	Attribute ID.
AttrKey	String	Attribute identifier.
AttrName	String	Attribute name.
LabelNumber	String	Quantity of labels.
Labels	Array of AttributeLabel	Label name.
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 Query Knowledge Labels

Query a knowledge label

Input Example

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

{
    "BotBizId": "1696822786072117248",
    "AttributeBizId": "1734549420823662592",
    "LastLabelBizId": "1734549420823662593",
    "Limit": 1
}

Output Example

{
    "Response": {
        "AttrKey": "test",
        "AttrName": "EPIAI Label"
        "AttributeBizId": "1734549420823662592",
        "LabelNumber": "1",
        "Labels": [],
        "RequestId": "99ff53c2-120a-4d0a-b54d-760a65852cd6"
    }
}

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

Tencent Cloud CLI 3.0

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

Feedback

tencent cloud