Dynamic Release Record (2026)
Domain name for API request: wedata.intl.tencentcloudapi.com.
[Filter criteria] {template Name, query usage with Keyword fuzzy matching} {template type, 1. system template 2. custom template} {quality detection dimensions (QualityDims), 1. accuracy 2. uniqueness 3. integrity 4. consistency 5. timeliness 6. validity} [Sorting field] {citation sorting type, sort ASC or DESC based on the number of references}.
A maximum of 20 requests can be initiated per second for this API.
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: ListQualityRuleTemplates. |
| Version | Yes | String | Common Params. The value used for this API: 2025-08-06. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| ProjectId | Yes | String | Workspace ID. |
| PageNumber | No | Integer | Current page, which is 1 by default. |
| PageSize | No | Integer | Number of records per page, which is 10 by default. |
| OrderFields.N | No | Array of OrderField | Common sort. Supported sorting fields:. CitationCount - sort by number of references. UpdateTime - sort by update time. Sorting order:. 1 - ascending (ASC). 2 - descending (DESC). |
| Filters.N | No | Array of Filter | Universal filter criteria. 1. Id Description: template ID. Value: unique identifier of the template. 2. Keyword Description: search by keyword, supports template name fuzzy search. Value: string. 3. Type Description: template type. Value: 1 - system template; 2 - custom template; support multiple values (OR relationship). 4. QualityDim Describes the quality detection dimension. Valid values: 1 - accuracy; 2 - uniqueness; 3 - integrity; 4 - consistency; 5 - timeliness; 6 - validity. support multiple values (OR relationship). 5. SourceObjectType Describes the applicable source data object type for rule. Value: 1 - constant; 2 - offline table level; 3 - offline field level; 4 - database level. supports multiple values (OR relationship). 6. SourceEngineTypes Description: specifies the source data engine type to which the template applies. Value: 1 - MySQL; 2 - Hive; 4 - Spark; 8 - Livy; 16 - DLC; 32 - Gbase; 64 - TCHouse-P; 128 - Doris; 256 - TCHouse-D; 512 - EMR_StarRocks; 1024 - TCHouse-X. supports multiple values (OR relationship). |
| Parameter Name | Type | Description |
|---|---|---|
| Data | QualityRuleTemplatePage | Result |
| 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. |
Paging query rule template
POST / HTTP/1.1
Host: wedata.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ListQualityRuleTemplates
<Common request parameters>
{
"PageNumber": 1,
"PageSize": 10,
"ProjectId": "1464962169590902784"
}{
"Response": {
"Data": {
"Items": [
{
"CitationCount": 0,
"CompareType": 1,
"DatasourceTypes": [
2,
3
],
"Description": "A common metric in machine learning used to monitor the shift in the distribution of a feature or model score over time.",
"MultiSourceFlag": false,
"Name": "Population Stability Index (PSI)",
"QualityDim": 1,
"ResolvedSqlExpression": {
"ParamExpressions": null,
"SystemTemplateExpressions": [
"BASELINE_TABLE",
"FEATURE_COLUMN",
"BASELINE_DB"
],
"TableExpressions": null
},
"RuleTemplateId": 6514,
"SourceContent": null,
"SourceEngineTypes": [
2,
4,
16
],
"SourceObjectDataType": 3,
"SourceObjectType": 2,
"SqlExpression": null,
"SubQualityDim": 0,
"Type": 1,
"UpdateTime": null,
"UserId": 1,
"UserIdStr": null,
"UserName": null,
"WhereFlag": false
},
{
"CitationCount": 0,
"CompareType": 1,
"DatasourceTypes": [
2,
3
],
"Description": "measures the minimum \"work\" required to transform one distribution into another. less sensitive to sharp changes in distribution shapes.",
"MultiSourceFlag": false,
"Name": "wasserstein distance",
"QualityDim": 1,
"ResolvedSqlExpression": {
"ParamExpressions": null,
"SystemTemplateExpressions": [
"BASELINE_TABLE",
"FEATURE_COLUMN",
"BASELINE_DB"
],
"TableExpressions": null
},
"RuleTemplateId": 6513,
"SourceContent": null,
"SourceEngineTypes": [
2,
4,
16
],
"SourceObjectDataType": 3,
"SourceObjectType": 2,
"SqlExpression": null,
"SubQualityDim": 0,
"Type": 1,
"UpdateTime": null,
"UserId": 1,
"UserIdStr": null,
"UserName": null,
"WhereFlag": false
},
{
"CitationCount": 0,
"CompareType": 1,
"DatasourceTypes": [
2,
3
],
"Description": "a symmetric and bounded measure of the similarity between two probability distributions, based on kl divergence. range is [0, 1].",
"MultiSourceFlag": false,
"Name": "jensen-shannon divergence",
"QualityDim": 1,
"ResolvedSqlExpression": {
"ParamExpressions": null,
"SystemTemplateExpressions": [
"BASELINE_TABLE",
"FEATURE_COLUMN",
"BASELINE_DB"
],
"TableExpressions": null
},
"RuleTemplateId": 6512,
"SourceContent": null,
"SourceEngineTypes": [
2,
4,
16
],
"SourceObjectDataType": 3,
"SourceObjectType": 2,
"SqlExpression": null,
"SubQualityDim": 0,
"Type": 1,
"UpdateTime": null,
"UserId": 1,
"UserIdStr": null,
"UserName": null,
"WhereFlag": false
},
{
"CitationCount": 0,
"CompareType": 1,
"DatasourceTypes": [
2,
3
],
"Description": "measures the maximum absolute difference between the two probability distributions at any point.",
"MultiSourceFlag": false,
"Name": "l-infinity distance",
"QualityDim": 1,
"ResolvedSqlExpression": {
"ParamExpressions": null,
"SystemTemplateExpressions": [
"BASELINE_TABLE",
"FEATURE_COLUMN",
"BASELINE_DB"
],
"TableExpressions": null
},
"RuleTemplateId": 6511,
"SourceContent": null,
"SourceEngineTypes": [
2,
4,
16
],
"SourceObjectDataType": 3,
"SourceObjectType": 2,
"SqlExpression": null,
"SubQualityDim": 0,
"Type": 1,
"UpdateTime": null,
"UserId": 1,
"UserIdStr": null,
"UserName": null,
"WhereFlag": false
},
{
"CitationCount": 0,
"CompareType": 1,
"DatasourceTypes": [
2,
3
],
"Description": "measures the largest possible difference between the probabilities that two distributions can assign to the same event.",
"MultiSourceFlag": false,
"Name": "total variation distance",
"QualityDim": 1,
"ResolvedSqlExpression": {
"ParamExpressions": null,
"SystemTemplateExpressions": [
"BASELINE_TABLE",
"FEATURE_COLUMN",
"BASELINE_DB"
],
"TableExpressions": null
},
"RuleTemplateId": 6510,
"SourceContent": null,
"SourceEngineTypes": [
2,
4,
16
],
"SourceObjectDataType": 3,
"SourceObjectType": 2,
"SqlExpression": null,
"SubQualityDim": 0,
"Type": 1,
"UpdateTime": null,
"UserId": 1,
"UserIdStr": null,
"UserName": null,
"WhereFlag": false
},
{
"CitationCount": 0,
"CompareType": 1,
"DatasourceTypes": [
2,
3
],
"Description": "used to test if two one-dimensional continuous probability distributions differ significantly.",
"MultiSourceFlag": false,
"Name": "kolmogorov-smirnov test (ks test)",
"QualityDim": 1,
"ResolvedSqlExpression": {
"ParamExpressions": null,
"SystemTemplateExpressions": [
"BASELINE_TABLE",
"FEATURE_COLUMN",
"BASELINE_DB"
],
"TableExpressions": null
},
"RuleTemplateId": 6509,
"SourceContent": null,
"SourceEngineTypes": [
2,
4,
16
],
"SourceObjectDataType": 3,
"SourceObjectType": 2,
"SqlExpression": null,
"SubQualityDim": 0,
"Type": 1,
"UpdateTime": null,
"UserId": 1,
"UserIdStr": null,
"UserName": null,
"WhereFlag": false
},
{
"CitationCount": 0,
"CompareType": 1,
"DatasourceTypes": [
2,
3
],
"Description": "used to test if there is a significant difference between two categorical distributions.",
"MultiSourceFlag": false,
"Name": "chi-squared test",
"QualityDim": 1,
"ResolvedSqlExpression": {
"ParamExpressions": null,
"SystemTemplateExpressions": [
"BASELINE_TABLE",
"FEATURE_COLUMN",
"BASELINE_DB"
],
"TableExpressions": null
},
"RuleTemplateId": 6508,
"SourceContent": null,
"SourceEngineTypes": [
2,
4,
16
],
"SourceObjectDataType": 3,
"SourceObjectType": 2,
"SqlExpression": null,
"SubQualityDim": 0,
"Type": 1,
"UpdateTime": null,
"UserId": 1,
"UserIdStr": null,
"UserName": null,
"WhereFlag": false
},
{
"CitationCount": 0,
"CompareType": 7,
"DatasourceTypes": [
2,
3
],
"Description": "requires that the probability of receiving a positive outcome is equal across different groups.",
"MultiSourceFlag": false,
"Name": "statistical parity",
"QualityDim": 1,
"ResolvedSqlExpression": {
"ParamExpressions": null,
"SystemTemplateExpressions": [
"PROTECTION_VALUE",
"COMPARISON_COLUMN",
"PREDICTION_COLUMN",
"POSITIVE_VALUE"
],
"TableExpressions": null
},
"RuleTemplateId": 6507,
"SourceContent": null,
"SourceEngineTypes": [
2,
4,
16
],
"SourceObjectDataType": 3,
"SourceObjectType": 2,
"SqlExpression": null,
"SubQualityDim": 0,
"Type": 1,
"UpdateTime": null,
"UserId": 1,
"UserIdStr": null,
"UserName": null,
"WhereFlag": false
},
{
"CitationCount": 0,
"CompareType": 7,
"DatasourceTypes": [
2,
3
],
"Description": "requires that the true positive rate (recall) is equal across different groups.",
"MultiSourceFlag": false,
"Name": "equal opportunity",
"QualityDim": 1,
"ResolvedSqlExpression": {
"ParamExpressions": null,
"SystemTemplateExpressions": [
"PROTECTION_VALUE",
"COMPARISON_COLUMN",
"PREDICTION_COLUMN",
"LABEL_COLUMN",
"POSITIVE_VALUE"
],
"TableExpressions": null
},
"RuleTemplateId": 6506,
"SourceContent": null,
"SourceEngineTypes": [
2,
4,
16
],
"SourceObjectDataType": 3,
"SourceObjectType": 2,
"SqlExpression": null,
"SubQualityDim": 0,
"Type": 1,
"UpdateTime": null,
"UserId": 1,
"UserIdStr": null,
"UserName": null,
"WhereFlag": false
},
{
"CitationCount": 0,
"CompareType": 7,
"DatasourceTypes": [
2,
3
],
"Description": "requires that the false positive rate (fpr) is equal across different groups.",
"MultiSourceFlag": false,
"Name": "predictive equality",
"QualityDim": 1,
"ResolvedSqlExpression": {
"ParamExpressions": null,
"SystemTemplateExpressions": [
"PROTECTION_VALUE",
"COMPARISON_COLUMN",
"PREDICTION_COLUMN",
"LABEL_COLUMN",
"POSITIVE_VALUE"
],
"TableExpressions": null
},
"RuleTemplateId": 6505,
"SourceContent": null,
"SourceEngineTypes": [
2,
4,
16
],
"SourceObjectDataType": 3,
"SourceObjectType": 2,
"SqlExpression": null,
"SubQualityDim": null,
"Type": 1,
"UpdateTime": null,
"UserId": 1,
"UserIdStr": null,
"UserName": null,
"WhereFlag": false
}
],
"TotalCount": 180
},
"RequestId": "40900661-28b4-4126-8023-0d4247a5194d"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| FailedOperation | Operation failed. |
| InvalidParameter.InvalidFilterParameter | Incorrect query filter parameter. |
| UnauthorizedOperation.UserNotInProject | The user is not a member of the current project. |
Esta página foi útil?
Você também pode entrar em contato com a Equipe de vendas ou Enviar um tíquete em caso de ajuda.
comentários