跳到主要内容

合同智能相关回调

一. 合同风险审查完成回调通知​

1. 回调触发时机​

在合同风险审查任务完成之后进行回调

2. 回调消息类型​

FlowRiskIdentify

3. 其他说明​

会出现回调的审查完成状态类型

审查状态对应Status
成功Succeed
失败Failed

4. 回调结构体​

MsgData结构体定义

参数名称参数类型参数描述
ApplicationIdString第三方应用的应用编
TaskIdString合同风险审查任务ID，为32位字符串
StatusString合同风险审查任务状态
MessageString审查任务失败附带的消息
RisksArray of Risk风险点信息列表

Risk结构体定义

参数名称参数类型参数描述
IdString风险id
TypeString风险类型名称
DescriptionString风险描述
LevelInteger风险等级，取值 0 高风险, 1 中风险, 2 低风险
RiskyTextIndexInteger有风险的文本内容如果在文中出现过多次，那么此风险点应该对应第几次出现。从0开始。如果没有风险文本内容，index为-1.
PositionTextRange需要在文档上添加风险相关comment的段落位置，适用于类型为doc/docx的文档
FieldRiskField风险文本的坐标范围和页号信息，适用于类型为pdf或平台发起的合同文档

TextRange结构体定义

适用类型为DOC/DOCX的合同风险文本定位（左闭右开区间）

参数名称参数类型参数描述
BeginInteger范围起始下标，-1表示位置不存在
EndInteger范围结束下标，-1表示位置不存在

RiskField结构体定义

适用类型为PDF或平台发起的合同（FLOW）风险文本的坐标范围, 页号信息

参数名称参数类型参数描述
PageNumberInteger页号
BoundingBoxBoundingBox坐标范围bbox，采用coco style

BoundingBox结构体定义

pdf合同风险点的位置信息 | 参数名称 | 参数类型 | 参数描述 | | --------- | --------- | ----- | | X | Float | 横坐标，左上为原点 | | Y | Float | 纵坐标，左上为原点 | | Width | Float | 宽 | | Height | Float | 高 |

5. 示例​

示例一: 合同风险审查任务执行成功

{
    "MsgId": "yDCZYUUckpyo4dwoUusiyOcknVwAZYLC",
    "MsgType": "FlowRiskIdentify",
    "MsgVersion": "ThirdPartyApp",
    "MsgData": {
        "ApplicationId": "yDRsaUUgyg1cqxe1Uy8lsS7E3YdC6Egb",
        "TaskId": "yDCZYUUckpyo4dwtUusiyOczKTgg4sI9",
        "Status": "Succeed",
        "Risks": [
            {
                "Id": "0",
                "Type": "MISSING_LEASING_PERIOD",
                "Description": "租赁总时长缺失，请检查是否定义了总时长。\n修改示例：\n租赁期限：本合同的租赁期限为1年，自2024年1月1日起至2025年1月1日止。",
                "Level": 2,
                "RiskyText": "",
                "RiskyTextIndex": 0,
                "Position": {
                    "Begin": -1,
                    "End": -1
                }
            },
            {
                "Id": "1",
                "Type": "MISSING_LEASING_BEGIN_DATE",
                "Description": "租赁开始日期缺失，请检查是否定义了开始时间。\n修改示例：\n租赁期限：本合同的租赁期限为1年，自2024年1月1日起至2025年1月1日止。",
                "Level": 2,
                "RiskyText": "",
                "RiskyTextIndex": 0,
                "Position": {
                    "Begin": -1,
                    "End": -1
                }
            },
            {
                "Id": "2",
                "Type": "MISSING_LEASING_END_DATE",
                "Description": "租赁结束日期缺失，请检查是否定义了结束时间。\n修改示例：\n租赁期限：本合同的租赁期限为1年，自2024年1月1日起至2025年1月1日止。",
                "Level": 2,
                "RiskyText": "",
                "RiskyTextIndex": 0,
                "Position": {
                    "Begin": -1,
                    "End": -1
                }
            },
            {
                "Id": "3",
                "Type": "MISSING_TOTAL_RENT",
                "Description": "租赁总租金缺失，请检查租赁总租金是否存在。\n修改示例：\n租金总额为[租金总额]元人民币，乙方应按照[支付方式]的方式支付租金。",
                "Level": 2,
                "RiskyText": "",
                "RiskyTextIndex": 0,
                "Position": {
                    "Begin": -1,
                    "End": -1
                }
            }
        ],
        "Message": ""
    }
}

示例二: 合同风险审查任务执行失败

{
    "MsgId": "yDCZYUUckpyo4dwoUusiyOcknVwAZYLC",
    "MsgType": "FlowRiskIdentify",
    "MsgVersion": "ThirdPartyApp",
    "MsgData": {
        "ApplicationId": "yDRsaUUgyg1cqxe1Uy8lsS7E3YdC6Egb",
        "TaskId": "yDCZYUUckpyo4dwtUusiyOczKTgg4sI9",
        "Status": "Failed",
        "Risks": [],
        "Message": "合同风险审查任务执行失败"
    }
}