文档比对

更新时间：2024-02-19

接口描述

文档比对API版产品，精准比对文档的增删改差异，快速定位并高亮显示差异原文，支持导出完整的比对报告，大幅提升比对准确性和效率。如需直接使用在线工具，可到智能文档分析平台使用。在线工具和API版的额度为共享互通。

文档比对API版为异步接口，需要先调用提交请求接口获取 taskID，然后调用获取结果接口进行结果轮询，建议提交请求后5～10秒开始轮询。

提交请求接口

在线调试

您可以在示例代码中心中调试该接口，可进行签名验证、查看在线调用的请求内容和返回结果、示例代码的自动生成。

请求说明

请求示例

HTTP 方法：POST

请求URL： https://aip.baidubce.com/file/2.0/brain/online/v1/textdiff/create_task

URL参数：

参数	值
access_token	通过API Key和Secret Key获取的access_token,参考“Access Token获取”

Header如下：

参数	值
Content-Type	multipart/form-data

Body中放置请求参数，参数详情如下：

请求参数

参数	是否必选	类型	可选值范围	说明
baseFile	和 baseFile/baseFileURL 二选一	file	-	文件数据，主版比对文档，支持BMP/JPEG/JPG/PNG/TIF/TIFF格式图片及Word/WPS/PDF/OFD格式文档，仅支持上传一篇文件，文件大小不超过10M 优先级： baseFile > baseFileURL，当baseFile字段存在时，baseFileURL字段失效
compareFile	和 compareFile/compareFileURL 二选一	file	-	文件数据，副版比对文档，支持BMP/JPEG/JPG/PNG/TIF/TIFF格式图片及Word/WPS/PDF/OFD格式文档，文件大小不超过10M 优先级： compareFile > compareFileURL，当compareFile字段存在时，compareFileURL字段失效
baseFileURL	和 baseFile/baseFileURL 二选一	string	-	文件完整URL，仅支持BOS公网访问，URL长度不超过1024字节，支持BMP/JPEG/JPG/PNG/TIF/TIFF格式图片及Word/WPS/PDF/OFD格式文档，仅支持上传一篇文件，文件大小不超过10M 优先级： baseFile > baseFileURL，当baseFile字段存在时，baseFileURL字段失效请注意关闭URL防盗链
compareFileURL	和 compareFile/compareFileURL 二选一	string	-	文件完整URL，仅支持BOS公网访问，URL长度不超过1024字节，支持BMP/JPEG/JPG/PNG/TIF/TIFF格式图片及Word/WPS/PDF/OFD格式文档，仅支持上传一篇文件，文件大小不超过10M 优先级： compareFile > compareFileURL，当compareFile字段存在时，compareFileURL字段失效请注意关闭URL防盗链
param	否	dict	-	文档比对特殊差异识别参数。默认为false。将指定参数以json格式传递。例如，传递参数{"sealRecognition":true,"handWritingRecognition":true}将分别启用印章识别与手写体识别功能
+ sealRecognition	否	bool	true/false	是否识别印章信息（识别印章信息有额外的时间开销）。默认为false
+ fullWidthHalfWidthRecognition	否	bool	true/false	是否识别中英文符号差异。默认为false
+ fontFamilyRecognition	否	bool	true/false	是否识别字体差异。默认为false
+ fontSizeRecognition	否	bool	true/false	是否识别字号差异。默认为false
+ handWritingRecognition	否	bool	true/false	是否识别手写体差异。默认为false

请求代码示例

提示一：使用示例代码前，请记得替换其中的示例Token、文档地址或Base64信息。

提示二：目前仅提供Python语言，如需其他语言示例可参考 示例代码中心 。

Python

import requests
import os

'''
文档比对-提交请求
'''


request_host = "https://aip.baidubce.com/file/2.0/brain/online/v1/textdiff/create_task"
# 二进制方式打开图片文件
f1 = '[本地文件-主版比对文档]'
f2 = '[本地文件-副版比对文档]'
body = {
    "baseFile": (os.path.basename(f1), open(f1, 'rb'), "multipart/form-data"),
    "compareFile": (os.path.basename(f2), open(f2, 'rb'), "multipart/form-data"),
}

params = {
    "sealRecognition": False,
    "handWritingRecognition": False
}
access_token = '[调用鉴权接口获取的token]'
request_url = f"{request_host}?access_token={access_token}"
response = requests.post(request_url, params=params, files=body)
if response:
    print(response.json())

返回说明

返回参数

字段	类型	说明
log_id	uint64	唯一的log id，用于问题定位
error_code	int	错误码
error_msg	string	错误描述信息
result	dict	返回的结果列表
+ taskId	string	该请求生成的taskId，后续使用该taskId获取比对结果

返回示例

成功返回示例：

{
    "error_code": 0,
    "error_msg": "",
    "log_id": "259575694341050368",
    "result": {
        "taskId": "textreview-task-xnejhkwvcz5qpr3c"
    }
}

失败返回示例（详细的错误码说明见API文档-错误码）：

{
    "error_code": 282003,
    "error_msg": "missing parameters",
    "log_id": "259909120864665600"
}

获取结果接口