1. 合同上传

1.1. 调用地址

https://api.regenai.com/v1/contract/upload

1.2. 请求方式

POST

1.3. 请求数据类型

multipart/form-data

1.4. 返回类型

JSON

1.5. 请求参数

名称 变量名 必填 类型 示例值 描述
Key app_key true String c5ed72329fece2fe0010a437505b01cb 分配的key
令牌 token true String 7007bd1257dce8d47489166a7c77a926 授权令牌
时间戳 timestamp true String 1522374165 timestamp 为January 1 1970 00:00:00 GMT 到现在的秒数
合同文件 file_list false Binary   文件集合 List pdf/word只支持单文件
文件链接 file_url_list false List<span><String http://t.cn/EbhjOOq 文件链接地址
文件Base64数据 file_data_list false List<span><String   文件Base64数据
文件名称 file_name false String   指定文件名称
命名空间 name_space false String   同一个用户下区分使用不同的使用者
是否是内置合同 prebuild false boolean   是否是内置合同类型 默认为true
合同类型 type false String   合同类型
内置合同类型：
contract 购销合同 默认
lease_contract 租赁合同
自建模型：平台中的模型类型

1.5.1. 请求说明

  • 支持的图片类型: jpg, jpeg, png及pdf, doc, docx. pdf/word格式文件只支持单个上传, 文件总大小不能超过50M.
  • token 的值计算方式为：md5($appkey+$timestamp+$appSecret)
    • token=md5("c5ed72329fece2fe0010a437505b01cb+1522374165+5c9597f3c8245907ea71a89d9d39d08e")=7007bd1257dce8d47489166a7c77a926
  • 生成token时，字符串连接中的“+”是必需的，缺少这个符号会无法验证通过验证

1.6. 返回值

1.6.1. 正确返回参数

名称 变量名 必填 类型 示例值 描述
返回状态码 result true int 0或1 请求状态. 1:成功, 0:失败
回复 response true json    

1.6.2. 正确返回样例

{
    "result": 1,
    "message": "success",
    "response": {
        "data": {
            "uid": "5d24522e1daf4aa7a47b01da46ea6105",
            "name": "76.额敏县住房和城乡建设局2392165754.pdf",
            "status": "PENDING",  // PENDING:等待处理, PROGRESS:处理中, SUCCESS:处理成功, FAILED:处理失败 , EXCEEDED:过期
            "type": "contract",
            "page_count": 0,
            "created_at": "2022-06-21 15:27:14"
        }
    }
}

2. 查询文件提取状态

2.1. 调用地址

https://api.regenai.com/v1/contract/query

2.2. 请求方式

POST

2.3. 请求数据类型

multipart/form-data 或 application/x-www-form-urlencoded

2.4. 返回类型

JSON

2.5. 请求参数

名称 变量名 必填 类型 示例值 描述
Key app_key true String c5ed72329fece2fe0010a437505b01cb 分配的key
令牌 token true String 7007bd1257dce8d47489166a7c77a926 授权令牌
时间戳 timestamp true String 1522374165 timestamp 为January 1 1970 00:00:00 GMT 到现在的秒数
合同文件标识 contract_uid true String 5d24522e1daf4aa7a47b01da46ea6105 合同文件UID
命名空间 name_space false String   命名空间

2.6. 返回值

2.6.1. 正确返回参数

名称 变量名 必填 类型 示例值 描述
返回状态码 result true int 0或1 请求状态. 1:成功, 0:失败
回复 response true json    

2.6.2. 正确返回样例

{
    "result": 1,
    "message": "success",
    "response": {
        "data": {
            "uid": "5d24522e1daf4aa7a47b01da46ea6105",
            "name": "xxx建设局.pdf",
            "status": "SUCCESS",  // PENDING:等待处理, PROGRESS:处理中, SUCCESS:处理成功, FAILED:处理失败 , EXCEEDED:过期
            "type": "contract",
            "page_count": 35,
            "created_at": "2022-06-21 15:27:15"
        }
    }
}

3. 获取文件提取结果

3.1. 调用地址

https://api.regenai.com/v1/contract/result

3.2. 请求方式

POST

3.3. 请求数据类型

multipart/form-data 或 application/x-www-form-urlencoded

3.4. 返回类型

JSON

3.5. 请求参数

名称 变量名 必填 类型 示例值 描述
Key app_key true String c5ed72329fece2fe0010a437505b01cb 分配的key
令牌 token true String 7007bd1257dce8d47489166a7c77a926 授权令牌
时间戳 timestamp true String 1522374165 timestamp 为January 1 1970 00:00:00 GMT 到现在的秒数
合同文件标识 contract_uid true String 5d24522e1daf4aa7a47b01da46ea6105 合同文件UID
命名空间 name_space false String   命名空间

3.6. 返回值

3.6.1. 正确返回参数

名称 变量名 必填 类型 示例值 描述
返回状态码 result true int 0或1 请求状态. 1:成功, 0:失败
回复 response true json    

3.6.2. 正确返回样例

{
    "result": 1,
    "message": "success",
    "response": {
        "data": {
            "uid": "646b6710c****",
            "name": "XXX合同.pdf",
            "status": "SUCCESS",
            "type": "contract",
            "page_count": 1,
            "created_at": "2022-06-23 13:41:53",
            "combination_items": [    -- 注释： 组合字段
            {
                "id": "dddb145f579c49d5b3832c5aa2b4b43c",
                "combination_name": "付款信息",
                "items": {
                    "付款节点": [
                        "在签订合同并收到履约保证金后"
                    ],
                    "付款比例": [
                        "30%"
                    ],
                    "付款金额（小写）": [
                        "380700"
                    ],
                    "付款金额（大写）": [
                        "人民币叁拾捌万零柒佰元整"
                    ]
                },
                "index": 1
            }],
            "report": {
                // 注释： 提取的合同目录
                "contents": [
                    {
                        "level": 1,
                        "text": "一、X合同文件",
                        "rows": [
                            {
                                "text": "一、X合同文件",
                                "region": [
                                    143,
                                    435,
                                    290,
                                    454
                                ],
                                "page": 0
                            }
                        ]
                    }
                ],
                // 提取的合同页面信息
                "page_infos": [
                    {
                        "page": 0,
                        "height": 1144,
                        "width": 785,
                        "orientation": 0,
                        "path": "https://XXX.oss-cn-hangzhou.aliyuncs.com/xxx",
                        "lines": [
                            {
                                "text": "合同格式",
                                "region": [
                                    274,
                                    159,
                                    515,
                                    197
                                ],
                                "words": [
                                    {
                                        "text": "合",
                                        "region": [
                                            278,
                                            159,
                                            310,
                                            197
                                        ]
                                    }
                                ]
                            }
                        ]
                    }
                ],
                // 提取合同中的关键信息
                "items": [
                    {
                        "id": "3160ccff204d4450a4a6ade5380ff8a4",
                        "key": "party_name",   --主字段名称
                        "name": "甲方公司名称",
                        "group": "A",   --类型（INFO: 基础字段 ；A：甲方；B：乙方；PAYMENTS：付款信息）
                        "index": 3,     --序号（group 为PAYMENTS时字段序号）
                        "type": 1,
                        "select": false,
                        "values": [
                            {
                                "result": "xxx管理局",
                                "texts": [
                                    {
                                        "text": "xxx管理局",
                                        "region": [
                                            182,
                                            125,
                                            343,
                                            151
                                        ],
                                        "page": 0
                                    }
                                ]
                            }
                        ]
                    }
                ]
            }
        }
    }
}

3.7. 购销合同字段定义

字段名-key 字段名-group 字段描述
party_name A 甲方公司名称
party_name B 乙方公司名称
party_address A 甲方通信地址
party_address B 乙方通信地址
title 合同名称
code 合同编号
amount 合同总金额小写
currency_code 币种
amount_cn 合同总金额大写
payment_date PAYMENTS 付款节点
payment_ratio PAYMENTS 付款比例
payment_amount PAYMENTS 付款金额（小写）
payment_amount_cn PAYMENTS 付款金额（大写）
date_effective 合同生效日期
date_expired 合同终止日期
date_valid 合同有效期
delivery_party 交货单位
delivery_place 交货地点
delivery_date 交货时间
acceptance_method 验收方法
acceptance_date 验收时间
transportation_method 运输方式
transportation_cost 运输费用
vat_rate 增值税税率
invoice_type 发票类型
security_deposit_amount 保证金金额小写
security_deposit_amount_cn 保证金金额大写
security_deposit_ratio 保证金比例
security_deposit_return_date 保证金归还节点
arbitration 争议仲裁地
tax_id A 甲方纳税人识别号
tax_id B 乙方纳税人识别号
invoicing_address A 甲方注册地址
invoicing_address B 乙方注册地址
party_phone A 甲方登记电话
party_phone B 乙方登记电话
opening_bank A 甲方开户行
opening_bank B 乙方开户行
bank_account_name A 甲方银行账号名称
bank_account_name B 乙方银行账号名称
bank_account A 甲方银行账号
bank_account B 乙方银行账号
default_content 违约内容
zip_code A 甲方邮政编码
zip_code B 乙方邮政编码
legal_person A 甲方法人
legal_person B 乙方法人
contact_person A 甲方业务联系人
contact_person B 乙方业务联系人
contact_phone A 甲方业务联系人电话
contact_phone B 乙方业务联系人电话
contact_email A 甲方业务联系人邮箱
contact_email B 乙方业务联系人邮箱
date_signature A 甲方签署日期
date_signature B 乙方签署日期
delegate_signature A 甲方法人或代表是否签字
delegate_signature B 乙方法人或代表是否签字
party_seal A 甲方公章
party_seal B 乙方公章
legal_seal A 甲方法人章
legal_seal B 乙方法人章
contract_seal A 甲方合同章
contract_seal B 乙方合同章
seam_seal 骑缝章
seal 印章

3.8. 租赁合同字段定义

字段名-key 字段名-group 字段描述
party_name B 承租方
party_name A 出租方
party_address A 甲方联系地址
party_address B 乙方联系地址
contact_phone A 甲方联系人电话
contact_phone B 乙方联系人电话
lease_address 租赁地址
lease_area 租赁面积
code 合同编号
date_signature A 甲方签署日期
date_signature B 乙方签署日期
date_valid 合同有效期
date_effective 合同起始时间
lease_date_valid 租赁期限
lease_date_effective 租赁起始时间
lease_date_expired 租赁终止时间
amount 租赁费用
amount_cn 租赁费用（大写）
amount_per_period PAYMENTS 每期金额
amount_cn_per_period PAYMENTS 每期金额大写
deposit_amount 押金
deposit_amount_cn 押金（大写）
security_deposit_amount 履约保证金
security_deposit_amount_cn 履约保证金（大写）
payment_method 付款方式
payment_cycle 支付周期
payment_date 支付节点
default_amount A 甲方违约金
default_amount_cn A 甲方违约金（大写）
default_amount B 乙方违约金
default_amount_cn B 乙方违约金（大写）
party_signatory A 甲方签署人
party_signatory B 乙方签署人

results matching ""

    No results matching ""