# 图片文档还原 API 文档

# 接口说明

• 图片文档还原（Picture Document Reconstruction），基于深度神经网络模型的端到端文档重建技术，可以识别文档、合同等形式的图片，生成保留内容格式的docx、pptx或xlsx文档。该产品目前为体验版，对于无线、少线表格的识别效果稍弱，仅供免费试用，暂不商用。
  

• 部分接口demo如下，其他开发语言请参照 接口调用流程 进行开发，也欢迎热心的开发者到 讯飞开放平台社区 (opens new window) 分享你们的demo。
  图片文档还原 demo java语言 (opens new window)
  图片文档还原 demo python语言 (opens new window)

• 集成图片文档还原API时，需按照以下要求:

# 鉴权说明

在调用业务接口时，请求方需要对请求进行签名，服务端通过签名来校验请求的合法性。 通过在请求地址后面加上鉴权相关参数的方式，参数具体如下： 示例url：

ws://ws-api.xf-yun.com/v1/private/ma008db16?host=ws-api.xf-yun.com&date=Thu%2C+24+Mar+2022+03%3A47%3A02+GMT&authorization=YXBpX2tleT0iMWRhYTM5NGJkZDRkYjhkNTVkNTJkMzg3MmY4NGFlZGEiLCBhbGdvcml0aG09ImhtYWMtc2hhMjU2IiwgaGVhZGVycz0iaG9zdCBkYXRlIHJlcXVlc3QtbGluZSIsIHNpZ25hdHVyZT0iSlBRRnhHWE83TmpMSkoxZnd5dS9FSHF0L2tnZmUxb0tJNktQMkRoMmE3TT0i

鉴权参数：

• date参数生成规则：

date必须是UTC+0或GMT时区，RFC1123格式(Thu, 24 Mar 2022 03:47:02 GMT)。
服务端会对date进行时钟偏移检查，最大允许300秒的偏差，超出偏差的请求都将被拒绝。

• authorization参数生成格式：

1）获取接口密钥APIKey 和 APISecret。
在讯飞开放平台控制台，创建一个应用后打开图片文档还原页面可以获取，均为32位字符串。
2）参数authorization base64编码前（authorization_origin）的格式如下。

api_key="$api_key",algorithm="hmac-sha256",headers="host date request-line",signature="$signature"

其中 api_key 是在控制台获取的APIKey，algorithm 是加密算法（仅支持hmac-sha256），headers 是参与签名的参数（见下方注释）。
signature 是使用加密算法对参与签名的参数签名后并使用base64编码的字符串，详见下方。

注： headers是参与签名的参数，请注意是固定的参数名（"host date request-line"），而非这些参数的值。

3）signature的原始字段(signature_origin)规则如下。

signature原始字段由 host，date，request-line三个参数按照格式拼接成，
拼接的格式为(\n为换行符,’:’后面有一个空格)：

host: $host\ndate: $date\n$request-line

假设

请求url =  wss://ws-api.xf-yun.com/v1/private/ma008db16
date = "Thu, 24 Mar 2022 03:51:59 GMT"

那么 signature原始字段(signature_origin)则为：

host: ws-api.xf-yun.com
date: Thu, 24 Mar 2022 03:51:59 GMT
GET /v1/private/ma008db16 HTTP/1.1

4）使用hmac-sha256算法结合apiSecret对signature_origin签名，获得签名后的摘要signature_sha。

signature_sha=hmac-sha256(signature_origin,$apiSecret)

其中 apiSecret 是在控制台获取的APISecret

5）使用base64编码对signature_sha进行编码获得最终的signature。

signature=base64(signature_sha)

假设

APISecret = "apisecretXXXXXXXXXXXXXXXXXXXXXXX"	
date = "Thu, 24 Mar 2022 03:51:59 GMT"

则signature为

signature="NcfeJm5UkdVDGr+VAUqrqW+wMGlNyAfGXrM5sPmeXSA="

6）根据以上信息拼接authorization base64编码前（authorization_origin）的字符串，示例如下。

api_key="apikeyXXXXXXXXXXXXXXXXXXXXXXXXXX", algorithm="hmac-sha256", headers="host date request-line", signature="NcfeJm5UkdVDGr+VAUqrqW+wMGlNyAfGXrM5sPmeXSA="

注： headers是参与签名的参数，请注意是固定的参数名（"host date request-line"），而非这些参数的值。

7）最后再对authorization_origin进行base64编码获得最终的authorization参数。

authorization = base64(authorization_origin)
示例结果为：
authorization=YXBpX2tleT0iYXBpa2V5WFhYWFhYWFhYWFhYWFhYWFhYWFhYWFhYWFgiLCBhbGdvcml0aG09ImhtYWMtc2hhMjU2IiwgaGVhZGVycz0iaG9zdCBkYXRlIHJlcXVlc3QtbGluZSIsIHNpZ25hdHVyZT0iTmNmZUptNVVrZFZER3IrVkFVcXJxVyt3TUdsTnlBZkdYck01c1BtZVhTQT0i

# 鉴权结果

如果鉴权失败，则根据不同错误类型返回不同HTTP Code状态码，同时携带错误描述信息，详细错误说明如下：

时钟偏移校验失败示例：

HTTP/1.1 403 Forbidden
Date: Mon, 30 Nov 2020 02:34:33 GMT
Content-Length: 116
Content-Type: text/plain; charset=utf-8
{
    "message": "HMAC signature does not match, a valid date or x-date header is required for HMAC Authentication"
}

# 请求参数

在调用业务接口时，都需要在 Http Request Body 中配置以下参数，请求数据均为json字符串。
请求参数示例：

{
    "header": {
        "app_id": "your_app_id",
        "status": 2,
    },
    "parameter": {
        "s15282f39": {
            "category": "ch_en_public_cloud",
            "result": {
                "encoding": "utf8",
                "compress": "raw",
                "format": "plain"
            }
        },
        "s5eac762f": {
            "result_type": "0",
            "result": {
                "encoding": "utf8",
                "compress": "raw",
                "format": "plain"
            }
        }
    },
    "payload": {
        "test": {
            "encoding": "jpg",
            "image": "iVBORw0KGgoAAAANSUhE......",
            "status": 3
        }
    }
}

请求参数说明：

# 返回结果

如出现错误码，可到 这里 (opens new window) 查询。
返回参数示例：

{
	"header": {
		"code": 0,
		"message": "success",
		"sid": "aso00109045@hu17fb99c78420207882",
		"status": 1
	},
	"payload": {
		"result": {
			"format": "plain",
			"encoding": "utf8",
			"text": "UEsDBBQAAAAIA......",
			"compress": "raw"
		}
	}
}

返回参数说明：

# 常见问题

# 图片文档还原的主要功能是什么？

答：可以识别文档、合同等形式的图片，生成保留内容格式的docx、pptx或xlsx文档。

# 图片文档还原支持什么语言？

答：目前支持中英文内容的识别。

# 图片文档还原对图片有什么要求吗？

答：图片格式支持jpg格式、jpeg格式、png格式、bmp格式，且需保证图像文件大小base64编码后不超过10MB。

# 图片文档还原支持什么应用平台？

答：目前支持WebAPI应用平台。