文档

GetRuleDetail - 获取规则的明细信息

更新时间:

获取规则的明细信息。

接口说明

说明 一般和获取规则基本信息联合使用,先用 GetRule 获取规则 ID,再以规则 ID 为参数获取规则详情。

调试

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

授权信息

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

请求参数

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

完整 JSON 字符串信息,具体内容参见以下详细信息。

{"ruleIds":"123"}
BaseMeAgentIdlong

业务空间 Id

请求参数 Json 字符串信息

属性值类型是否必须说明
ruleIdsList<String>规则标识 ID,若指定此参数,则忽略其它参数
businessCategoryNameList<String>所属业务分类名称

返回参数

名称类型描述示例值
object

响应结果。

Codestring

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

200
Messagestring

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

successful
RequestIdstring

请求 ID

4987D326-83D9-4A42-B9A5-0B27F9B40539
Successboolean

请求是否成功。调用方可根据此字段来判断请求是否成功:

  • true 表示成功
  • false/null表示失败
true
Dataobject

返回结果

PageSizeinteger

每页条数。

10
PageNumberinteger

当前页。

1
Countinteger

总条数。

10
Conditionsobject []

所有条件的配置信息

ConditionInfoCidstring

条件的 ID

7
OperLambdastring

条件中算子的逻辑关系

7
Operatorsobject []

条件包含的算子

Typestring

算子类型

REGULAR_EXPRESSION
Oidstring

算子的 ID

8
OperNamestring

算子名称,描述。

operator demo
Paramobject

算子表达式具体内容

DifferentRoleboolean

用以时间间隔算子,判断时间间隔,为 true 则目标句子如果与本句是同一个角色说的话就不参与计算。

true
Regexstring

用于正则算子,正则表达式。

.*修改密码.*
TargetRolestring

用于判断重复算子,如果本句匹配上该正则表达式,那么匹配上的部份会在本句之前 target_role 指定的句子中查找。

客户
VelocityInMintinteger

语速检查算子中,每分钟的语速值(字数),用以判断本句的语速是否超过指定值。

280
Averageboolean

语速检查模式,可能值:true:检测整个对话的平均语速;false:检测单句话的语速。

true
KeywordExtensionboolean

关键词检查算子中,是否开启同义词扩展。

true
Scoreinteger

文本相似度算子的相似度值

80
NotRegexstring

正则表达式检查中,排除的正则表达式。

发一下|告诉我
CompareOperatorstring

大于还是小于,可能值:gt(大于);lt(小于),默认值:gt。

gt
DelayTimeinteger

抢话检查算子中,延时判定抢话情况,比如,设置为 1000,则表示同时一方开始说话 1000 毫秒后,再出现对话重叠才算作抢话,单位:毫秒

1000
KeywordMatchSizeinteger

关键词检查算子中,匹配关键字的数量,不同的检测类型与该参数取值的关系:包含任意一个关键字(取值为 1)、包含全部关键字(取值为-1)、包含任意 N 个关键字(取值为大于等于 1 并且小于等于关键字的个数正整数)、全部不包含(取值为 0)。默认值根据关键字检测类型(type 值)的不同而不同:HIT_ANY_KEYWORDS(1)、INCLUDE_KEYWORDS(-1)

3
HitTimeinteger

上下文重复算子中,表示第几次重复出现时才算违规,默认:1。

1
BeginTypestring

非正常挂机算子中使用,固定传 DIALOGUE。

DIALOGUE
Targetinteger

目标句子是当前句子的前多少句,为 0 时间间隔等于本句的结束时间-本句的开始时间。

1
MaxEmotionChangeValueinteger

能量检测算子中的能量值,取值范围:1-10。

8
Thresholdfloat

用于编辑距离和匹配予以算子,指定的阈值。

4
Frominteger

上下文重复算子中,表示重复的两句话间隔在几句以内时才算违规,默认:2,即从当前局往前数 2 句(包含)之内重复算违规。

3
FromEndboolean

用于时间间隔算子,判断时间间隔,指定时间间隔的计算方式是否用本句的结束时间减目标句子的结束时间。

true
MinWordSizeinteger

语速检查中,表示当一句话少于多少字时不检测。

4
InSentenceboolean

用以判断是否是单句还是整句。

true
Phrasestring

用于最小编辑距离算子,参考句子。

xxx
Similarity_thresholdfloat

弃用字段,请忽略。

90
CheckTypeinteger

能量检测中的检测方式,可能值:1(相邻句能量波动);2(最大能量跨度);3(能量范围检测),默认值:3。

1
Intervalinteger

用于时间间隔算子,时间间隔。

5000
ContextChatMatchboolean

关键词检查算子中,是否多句分析,用来指定分析方式,可能值:true 多句分析;false 单句分析,默认 false。详见下方的分析方式详细说明。

true
Excludesarray

上下文重复算子例外句子。

string

上下文重复算子中,例外句子列表,即例外句子重复出现时不算违规,默认:空。

[“好的”]
AntModelInfoarray

弃用字段,请忽略。

string

弃用字段,请忽略。

xx
Pvaluesarray

弃用字段,请忽略。

string

弃用字段,请忽略。

xx
Referencesarray

用于相似度匹配

string

用于相似度匹配,算子表达式具体内容。

[“优惠力度特别大”,”特别的优惠”]
SimilarlySentencesarray

文本相似度算子的示例语句集合

string

文本相似度算子的示例语句集合

[“优惠力度特别大”,”特别的优惠”]
OperKeyWordsarray

关键字列表

string

关键字列表

[“你好”,”您好”,”上午好”]
CheckRangeobject

条件的检查范围

Absoluteboolean

是否独立

true
Rolestring

角色,条件的作用角色范围

客服
Anchorobject

条件的锚定关系

HitTimeinteger

1~N代表条件第一(N)次命中,-1代表条件最后一次命中。

1
Locationstring
  • CURRENT:条件命中的当前句
  • BEFORE:命中句子之前
  • AFTER:命中句子之后
AFTER
AnchorCidstring

条件 ID,用于确定 anchor 的条件

7
Rangeobject

Role 和 Anchor 共同决定的范围。1~N表示由 anchor 和 role 共同限定的第 1(N)句,-1 表示由 anchor 和 role 共同限定的最后一句。

Tointeger

1~N表示由 anchor 和 role 共同限定的第 1(N)句,-1表示由 anchor 和 role 共同限定的最后一句。

10
Frominteger

1~N表示由 anchor 和 role 共同限定的第 1(N)句,-1表示由 anchor 和 role 共同限定的最后一句。

1
Rulesobject []

所有规则的配置信息

RuleLambdastring

规则中条件的逻辑关系

7&&!8
Ridstring

规则的 ID

4
BusinessCategoriesobject []

规则所属业务

BusinessNamestring

规则所属业务名称

业务A
ServiceTypeinteger

业务类型

1
Bidinteger

规则所属业务 BID,必须数字字符

264971810
Triggersarray

触发列表。

string

规则中需要返回内容的条件 ID。设置规则 ID 的话,命中结果后将会返回规则所命中的具体内容。

["7","8"]

示例

正常返回示例

JSON格式

{
  "Code": "200",
  "Message": "successful",
  "RequestId": "4987D326-83D9-4A42-B9A5-0B27F9B40539",
  "Success": true,
  "Data": {
    "PageSize": 10,
    "PageNumber": 1,
    "Count": 10,
    "Conditions": {
      "ConditionBasicInfo": [
        {
          "ConditionInfoCid": "7",
          "OperLambda": "7",
          "Operators": {
            "OperatorBasicInfo": [
              {
                "Type": "REGULAR_EXPRESSION",
                "Oid": "8",
                "OperName": "operator demo",
                "Param": {
                  "DifferentRole": true,
                  "Regex": ".*修改密码.*",
                  "TargetRole": "客户",
                  "VelocityInMint": 280,
                  "Average": true,
                  "KeywordExtension": true,
                  "Score": 80,
                  "NotRegex": "发一下|告诉我",
                  "CompareOperator": "gt",
                  "DelayTime": 1000,
                  "KeywordMatchSize": 3,
                  "HitTime": 1,
                  "BeginType": "DIALOGUE",
                  "Target": 1,
                  "MaxEmotionChangeValue": 8,
                  "Threshold": 4,
                  "From": 3,
                  "FromEnd": true,
                  "MinWordSize": 4,
                  "InSentence": true,
                  "Phrase": "xxx",
                  "Similarity_threshold": 90,
                  "CheckType": 1,
                  "Interval": 5000,
                  "ContextChatMatch": true,
                  "Excludes": {
                    "Excludes": [
                      "[“好的”]"
                    ]
                  },
                  "AntModelInfo": {
                    "AntModelInfo": [
                      "xx"
                    ]
                  },
                  "Pvalues": {
                    "Pvalues": [
                      "xx"
                    ]
                  },
                  "References": {
                    "Reference": [
                      "[“优惠力度特别大”,”特别的优惠”]"
                    ]
                  },
                  "SimilarlySentences": {
                    "SimilarlySentence": [
                      "[“优惠力度特别大”,”特别的优惠”]"
                    ]
                  },
                  "OperKeyWords": {
                    "OperKeyWord": [
                      "[“你好”,”您好”,”上午好”]"
                    ]
                  }
                }
              }
            ]
          },
          "CheckRange": {
            "Absolute": true,
            "Role": "客服",
            "Anchor": {
              "HitTime": 1,
              "Location": "AFTER",
              "AnchorCid": "7"
            },
            "Range": {
              "To": 10,
              "From": 1
            }
          }
        }
      ]
    },
    "Rules": {
      "RuleBasicInfo": [
        {
          "RuleLambda": "7&&!8",
          "Rid": "4",
          "BusinessCategories": {
            "BusinessCategoryBasicInfo": [
              {
                "BusinessName": "业务A",
                "ServiceType": 1,
                "Bid": 264971810
              }
            ]
          },
          "Triggers": {
            "Trigger": [
              "[\"7\",\"8\"]"
            ]
          }
        }
      ]
    }
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
2023-08-01API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2023-08-01API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2023-08-01API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2023-08-01API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2023-08-01API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2023-08-01API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2023-08-01API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2023-08-01API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2023-08-01API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2023-08-01API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2023-08-01API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2023-08-01API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2023-08-01API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2023-08-01API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2023-08-01API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2023-08-01API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2023-08-01API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2023-08-01API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2023-08-01API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2023-08-01API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
  • 本页导读 (0)
文档反馈