文档

GetRuleV4Str - 获取规则详情(新版质检)

目前该API接口已标记为弃用,推荐使用替代API:Qualitycheck(2019-01-15) - GetRuleV4

GetRuleV4兼容SDK1.0的版本,返回类型为String,如果您使用是SDK2.0,请使用GetRuleV4接口.

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
RuleIdlong

规则 ID。

1
IsSchemeDatainteger

是否为新版质检,0:旧版质检;1:新版质检。默认为 1

1

返回参数

名称类型描述示例值
object

PlainResult

Datastring

返回结果

{ "data": { "count": 1, "rules": [ { "qualityCheckType": 0, "hitNumScore": false, "isHitNumScore": 0, "expectedScore": 0.7, "ruleScoreType": 3, "scoreType": 3, "isOnline": 0, "configType": 1, "rid": "47162", "type": -1, "autoReview": 3, "lambda": "a", "fullCycle": 1, "ruleType": 1, "hitNumScoreInfo": [], "scoreNum": 3, "lastUpdateEmpid": "1", "createEmpid": "1", "level": 2, "scoreRuleHitType": 0, "isDelete": 0, "targetType": 10, "triggers": [ "a" ], "ridLong": 47162, "meet": 1, "scoreNumType": 0, "createTime": 1700728895000, "name": "规则A", "lastUpdateTime": 1701055545000, "status": 1 } ], "conditions": [ { "check_range": {}, "lambda": "125637", "operators": [ { "param": { "keywordMatchSize": 1, "keywords": [ "你好" ], "in_sentence": false, "contextChatMatch": false, "near_dialogue": false, "useEasAlgorithm": false }, "oid": "125637", "id": 125637, "type": "HIT_ANY_KEYWORDS" } ], "cname": "", "name": "", "id": 124832, "rid": "47162", "cid": "a" } ], "totalCount": 1 } }
RequestIdstring

请求 Id。

96138D8D-XXXX-4E41-XXXX-77AED1088BBD
Successboolean

请求是否成功,调用方可根据此字段来判断请求是否成功:true 表示成功;false/null 表示失败。

true
Codestring

结果代码,200 表示成功,若为别的值则表示失败,调用方可根据此字段判断失败原因。

200
Messagestring

出错时表示出错详情,成功时为 successful。

successful
HttpStatusCodeinteger

HTTP 状态码。

200

示例

正常返回示例

JSON格式

{
  "Data": "{\n    \"data\": {\n        \"count\": 1,\n        \"rules\": [\n            {\n                \"qualityCheckType\": 0,\n                \"hitNumScore\": false,\n                \"isHitNumScore\": 0,\n                \"expectedScore\": 0.7,\n                \"ruleScoreType\": 3,\n                \"scoreType\": 3,\n                \"isOnline\": 0,\n                \"configType\": 1,\n                \"rid\": \"47162\",\n                \"type\": -1,\n                \"autoReview\": 3,\n                \"lambda\": \"a\",\n                \"fullCycle\": 1,\n                \"ruleType\": 1,\n                \"hitNumScoreInfo\": [],\n                \"scoreNum\": 3,\n                \"lastUpdateEmpid\": \"1\",\n                \"createEmpid\": \"1\",\n                \"level\": 2,\n                \"scoreRuleHitType\": 0,\n                \"isDelete\": 0,\n                \"targetType\": 10,\n                \"triggers\": [\n                    \"a\"\n                ],\n                \"ridLong\": 47162,\n                \"meet\": 1,\n                \"scoreNumType\": 0,\n                \"createTime\": 1700728895000,\n                \"name\": \"规则A\",\n                \"lastUpdateTime\": 1701055545000,\n                \"status\": 1\n            }\n        ],\n        \"conditions\": [\n            {\n                \"check_range\": {},\n                \"lambda\": \"125637\",\n                \"operators\": [\n                    {\n                        \"param\": {\n                            \"keywordMatchSize\": 1,\n                            \"keywords\": [\n                                \"你好\"\n                            ],\n                            \"in_sentence\": false,\n                            \"contextChatMatch\": false,\n                            \"near_dialogue\": false,\n                            \"useEasAlgorithm\": false\n                        },\n                        \"oid\": \"125637\",\n                        \"id\": 125637,\n                        \"type\": \"HIT_ANY_KEYWORDS\"\n                    }\n                ],\n                \"cname\": \"\",\n                \"name\": \"\",\n                \"id\": 124832,\n                \"rid\": \"47162\",\n                \"cid\": \"a\"\n            }\n        ],\n        \"totalCount\": 1\n    }\n}",
  "RequestId": "96138D8D-XXXX-4E41-XXXX-77AED1088BBD",
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "HttpStatusCode": 200
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-12-07OpenAPI 变更为 deprecated,即将下线看变更集
变更项变更内容
API 弃用说明(deprecated)OpenAPI 变更为 deprecated,即将下线
  • 本页导读 (0)
文档反馈