资讯 社区 文档
技术能力
语音技术
文字识别
人脸与人体
图像技术
语言与知识
视频技术

接口说明

通用文字识别(标准版)

用户向服务请求识别某张图中的所有文字。

    """ 读取文件 """
   def get_file_content(filePath):
      with open(filePath, "rb") as fp:
         return fp.read()

   image = get_file_content('文件路径')
   url = "https://www.x.com/sample.jpg"
   pdf_file = get_file_content('文件路径')
	
   # 调用通用文字识别(标准版)
   res_image = client.basicGeneral(image)
   res_url = client.basicGeneralUrl(url)
   res_pdf = client.basicGeneralPdf(pdf_file)
   print(res_image)
   print(res_url)
   print(res_pdf)
   
   # 如果有可选参数
   options = {}
   options["language_type"] = "CHN_ENG"
   options["detect_direction"] = "true"
   options["detect_language"] = "true"
   options["probability"] = "true"
   res_image = client.basicGeneral(image, options)
   res_url = client.basicGeneralUrl(url, options)
   res_pdf = client.basicGeneralPdf(pdf_file, options)
   print(res_image)
   print(res_url)
   print(res_pdf)
   

通用文字识别 请求参数详情

参数 是否必选 类型 可选值范围 说明
image 和 url/pdf_file 三选一 string - 图像数据,base64编码后进行urlencode,要求base64编码和urlencode后大小不超过4M,最短边至少15px,最长边最大4096px,支持jpg/jpeg/png/bmp格式
优先级:image > url > pdf_file,当image字段存在时,url、pdf_file字段失效
url 和 image/pdf_file 三选一 string - 图片完整url,url长度不超过1024字节,url对应的图片base64编码后大小不超过4M,最短边至少15px,最长边最大4096px,支持jpg/jpeg/png/bmp格式
优先级:image > url > pdf_file,当image字段存在时,url字段失效
请注意关闭URL防盗链
pdf_file 和 image/url 三选一 string - PDF文件,base64编码后进行urlencode,要求base64编码和urlencode后大小不超过4M,最短边至少15px,最长边最大4096px
优先级:image > url > pdf_file,当image、url字段存在时,pdf_file字段失效
pdf_file_num string - 需要识别的PDF文件的对应页码,当 pdf_file 参数有效时,识别传入页码的对应页面内容,若不传入,则默认识别第 1 页
language_type string CHN_ENG
ENG
JAP
KOR
FRE
SPA
POR
GER
ITA
RUS
识别语言类型,默认为CHN_ENG
可选值包括:
- CHN_ENG:中英文混合
- ENG:英文
- JAP:日语
- KOR:韩语
- FRE:法语
- SPA:西班牙语
- POR:葡萄牙语
- GER:德语
- ITA:意大利语
- RUS:俄语
detect_direction string true/false 是否检测图像朝向,默认不检测,即:false。朝向是指输入图像是正常方向、逆时针旋转90/180/270度。可选值包括:
- true:检测朝向;
- false:不检测朝向。
detect_language string true/false 是否检测语言,默认不检测。当前支持(中文、英语、日语、韩语)
paragraph string true/false 是否输出段落信息
probability string true/false 是否返回识别结果中每一行的置信度

通用文字识别 返回数据参数详情

字段 是否必选 类型 说明
direction int32 图像方向,当 detect_direction=true 时返回该字段。
- - 1:未定义,
- 0:正向,
- 1:逆时针90度,
- 2:逆时针180度,
- 3:逆时针270度
log_id uint64 唯一的log id,用于问题定位
words_result_num uint32 识别结果数,表示words_result的元素个数
words_result array[] 识别结果数组
+ words string 识别结果字符串
+ probability object 识别结果中每一行的置信度值,包含average:行置信度平均值,variance:行置信度方差,min:行置信度最小值,当 probability=true 时返回该字段
paragraphs_result array[] 段落检测结果,当 paragraph=true 时返回该字段
+ words_result_idx array[] 一个段落包含的行序号,当 paragraph=true 时返回该字段
language int32 当 detect_language=true 时返回该字段
pdf_file_size string 传入PDF文件的总页数,当 pdf_file 参数有效时返回该字段

通用文字识别 返回示例

{
"log_id": 2471272194,
"words_result_num": 2,
"words_result":
    [
        {"words": " TSINGTAO"},
        {"words": "青島睥酒"}
    ]
}

通用文字识别(高精度版)

用户向服务请求识别某张图中的所有文字,相对于通用文字识别该产品精度更高,但是识别耗时会稍长。

   """ 读取文件 """
   def get_file_content(filePath):
      with open(filePath, "rb") as fp:
         return fp.read()

   image = get_file_content('文件路径')
   url = "https://www.x.com/sample.jpg"
   pdf_file = get_file_content('文件路径')
   
	# 调用通用文字识别(高精度版)
   res_image = client.basicAccurate(image)
   res_url = client.basicAccurateUrl(url)
   res_pdf = client.basicAccuratePdf(pdf_file)
   print(res_image)
   print(res_url)
   print(res_pdf)

	# 如果有可选参数
   options = {}
   options["detect_direction"] = "true"
   options["probability"] = "true"
   res_image = client.basicAccurate(image, options)
   res_url = client.basicAccurateUrl(url, options)
   res_pdf = client.basicAccuratePdf(pdf_file, options)   
   print(res_image)
   print(res_url)
   print(res_pdf)   

通用文字识别(高精度版) 请求参数详情

参数 是否必选 类型 可选值范围 说明
image 和 url/pdf_file 三选一 string - 图像数据,base64编码后进行urlencode,要求base64编码和urlencode后大小不超过10M,最短边至少15px,最长边最大8192px,支持jpg/jpeg/png/bmp格式
优先级:image > url > pdf_file,当image字段存在时,url、pdf_file字段失效
url 和 image/pdf_file 三选一 string - 图片完整url,url长度不超过1024字节,url对应的图片base64编码后大小不超过10M,最短边至少15px,最长边最大8192px,支持jpg/jpeg/png/bmp格式
优先级:image > url > pdf_file,当image字段存在时,url字段失效
请注意关闭URL防盗链
pdf_file 和 image/url 三选一 string - PDF文件,base64编码后进行urlencode,要求base64编码和urlencode后大小不超过10M,最短边至少15px,最长边最大8192px
优先级:image > url > pdf_file,当image、url字段存在时,pdf_file字段失效
pdf_file_num string - 需要识别的PDF文件的对应页码,当 pdf_file 参数有效时,识别传入页码的对应页面内容,若不传入,则默认识别第 1 页
language_type string auto_detect
CHN_ENG
ENG
JAP
KOR
FRE
SPA
POR
GER
ITA
RUS
DAN
DUT
MAL
SWE
IND
POL
ROM
TUR
GRE
HUN
识别语言类型,默认为CHN_ENG
可选值包括:
- auto_detect:自动检测语言,并识别
- CHN_ENG:中英文混合
- ENG:英文
- JAP:日语
- KOR:韩语
- FRE:法语
- SPA:西班牙语
- POR:葡萄牙语
- GER:德语
- ITA:意大利语
- RUS:俄语
- DAN:丹麦语
- DUT:荷兰语
- MAL:马来语
- SWE:瑞典语
- IND:印尼语
- POL:波兰语
- ROM:罗马尼亚语
- TUR:土耳其语
- GRE:希腊语
- HUN:匈牙利语
- THA:泰语
- VIE:越南语
- ARA:阿拉伯语
- HIN:印地语
detect_direction string true/false 是否检测图像朝向,默认不检测,即:false。朝向是指输入图像是正常方向、逆时针旋转90/180/270度。可选值包括:
- true:检测朝向;
- false:不检测朝向
paragraph string true/false 是否输出段落信息
probability string true/false 是否返回识别结果中每一行的置信度

通用文字识别(高精度版) 返回数据参数详情

字段 是否必选 类型 说明
log_id uint64 唯一的log id,用于问题定位
direction int32 图像方向,当 detect_direction=true 时返回该字段。
- - 1:未定义,
- 0:正向,
- 1:逆时针90度,
- 2:逆时针180度,
- 3:逆时针270度
words_result array[] 识别结果数组
words_result_num uint32 识别结果数,表示words_result的元素个数
+ words string 识别结果字符串
paragraphs_result array[] 段落检测结果,当 paragraph=true 时返回该字段
+ words_result_idx array[] 一个段落包含的行序号,当 paragraph=true 时返回该字段
+ probability object 识别结果中每一行的置信度值,包含average:行置信度平均值,variance:行置信度方差,min:行置信度最小值,当 probability=true 时返回该字段
pdf_file_size string 传入PDF文件的总页数,当 pdf_file 参数有效时返回该字段

通用文字识别(高精度版) 返回示例

参考通用文字识别(标准版)返回示例

通用文字识别(标准含位置版)

用户向服务请求识别某张图中的所有文字,并返回文字在图中的位置信息。

   """ 读取文件 """
   def get_file_content(filePath):
      with open(filePath, "rb") as fp:
         return fp.read()

   image = get_file_content('文件路径')
   url = "https://www.x.com/sample.jpg"
   pdf_file = get_file_content('文件路径')
   
	# 调用通用文字识别(标准含位置信息版)
   res_image = client.general(image)
   res_url = client.generalUrl(url)
   res_pdf = client.generalPdf(pdf_file)
   print(res_image)
   print(res_url)
   print(res_pdf)   

	# 如果有可选参数
   options = {}
   options["recognize_granularity"] = "big"
   options["language_type"] = "CHN_ENG"
   options["detect_direction"] = "true"
   options["detect_language"] = "true"
   options["vertexes_location"] = "true"
   options["probability"] = "true"
   res_image = client.general(image, options)
   res_url = client.generalUrl(url, options)
   res_pdf = client.generalPdf(pdf_file, options)   
   print(res_image)
   print(res_url)
   print(res_pdf)

通用文字识别(标准含位置版) 请求参数详情

参数 是否必选 类型 可选值范围 说明
image 和 url/pdf_file 三选一 string - 图像数据,base64编码后进行urlencode,要求base64编码和urlencode后大小不超过4M,最短边至少15px,最长边最大4096px,支持jpg/jpeg/png/bmp格式
优先级:image > url > pdf_file,当image字段存在时,url、pdf_file字段失效
url 和 image/pdf_file 三选一 string - 图片完整url,url长度不超过1024字节,url对应的图片base64编码后大小不超过4M,最短边至少15px,最长边最大4096px,支持jpg/jpeg/png/bmp格式
优先级:image > url > pdf_file,当image字段存在时,url字段失效
请注意关闭URL防盗链
pdf_file 和 image/url 三选一 string - PDF文件,base64编码后进行urlencode,要求base64编码和urlencode后大小不超过4M,最短边至少15px,最长边最大4096px
优先级:image > url > pdf_file,当image、url字段存在时,pdf_file字段失效
pdf_file_num string - 需要识别的PDF文件的对应页码,当 pdf_file 参数有效时,识别传入页码的对应页面内容,若不传入,则默认识别第 1 页
recognize_granularity string big/small 是否定位单字符位置,big:不定位单字符位置,默认值;small:定位单字符位置
language_type string CHN_ENG
ENG
JAP
KOR
FRE
SPA
POR
GER
ITA
RUS
识别语言类型,默认为CHN_ENG
可选值包括:
- CHN_ENG:中英文混合
- ENG:英文
- JAP:日语
- KOR:韩语
- FRE:法语
- SPA:西班牙语
- POR:葡萄牙语
- GER:德语
- ITA:意大利语
- RUS:俄语
detect_direction string true/false 是否检测图像朝向,默认不检测,即:false。朝向是指输入图像是正常方向、逆时针旋转90/180/270度。可选值包括:
- true:检测朝向;
- false:不检测朝向。
detect_language string true/false 是否检测语言,默认不检测。当前支持(中文、英语、日语、韩语)
paragraph string true/false 是否输出段落信息
vertexes_location string true/false 是否返回文字外接多边形顶点位置,不支持单字位置。默认为false
probability string true/false 是否返回识别结果中每一行的置信度

通用文字识别(标准含位置版) 返回数据参数详情

字段 是否必选 类型 说明
direction int32 图像方向,当 detect_direction=true 时返回该字段。
- - 1:未定义,
- 0:正向,
- 1:逆时针90度,
- 2:逆时针180度,
- 3:逆时针270度
log_id uint64 唯一的log id,用于问题定位
words_result array[] 识别结果数组
words_result_num uint32 识别结果数,表示words_result的元素个数
+ words string 识别结果字符串
+ location array[] 位置数组(坐标0点为左上角)
++ left uint32 表示定位位置的长方形左上顶点的水平坐标
++ top uint32 表示定位位置的长方形左上顶点的垂直坐标
++ width uint32 表示定位位置的长方形的宽度
++ height uint32 表示定位位置的长方形的高度
language int32 当 detect_language=true 时返回该字段
paragraphs_result array[] 段落检测结果,当 paragraph=true 时返回该字段
+ words_result_idx array[] 一个段落包含的行序号,当 paragraph=true 时返回该字段
++ x uint32 水平坐标(坐标0点为左上角)
++ y uint32 垂直坐标(坐标0点为左上角)
+ chars array[] 单字符结果,当 recognize_granularity=small 时返回该字段
++ char string 单字符识别结果,当 recognize_granularity=small 时返回该字段
++ location array[] 位置数组(坐标0点为左上角),当 recognize_granularity=small 时返回该字段
+++ left uint32 表示定位位置的长方形左上顶点的水平坐标,当 recognize_granularity=small 时返回该字段
+++ top uint32 表示定位位置的长方形左上顶点的垂直坐标,当 recognize_granularity=small 时返回该字段
+++ width uint32 表示定位定位位置的长方形的宽度,当 recognize_granularity=small 时返回该字段
+++ height uint32 表示位置的长方形的高度,当 recognize_granularity=small 时返回该字段
+ probability object 识别结果中每一行的置信度值,包含average:行置信度平均值,variance:行置信度方差,min:行置信度最小值,当 probability=true 时返回该字段
pdf_file_size string 传入PDF文件的总页数,当 pdf_file 参数有效时返回该字段

通用文字识别(含位置信息版) 返回示例

{
"log_id": 3523983603,
"direction": 0, //detect_direction=true时存在
"words_result_num": 2,
"words_result": [
    {
        "location": {
            "left": 35,
            "top": 53,
            "width": 193,
            "height": 109
        },
        "words": "感动",
        "chars": [    //recognize_granularity=small时存在
            {
                "location": {
                    "left": 56,
                    "top": 65,
                    "width": 69,
                    "height": 88
                },
                "char": "感"
            },
            {
                "location": {
                    "left": 140,
                    "top": 65,
                    "width": 70,
                    "height": 88
                },
                "char": "动"
            }
        ]
    }
    ...
]
}

通用文字识别(高精度含位置版)

用户向服务请求识别某张图中的所有文字,并返回文字在图片中的坐标信息,相对于通用文字识别(含位置信息版)该产品精度更高,但是识别耗时会稍长。

    """ 读取文件 """
   def get_file_content(filePath):
      with open(filePath, "rb") as fp:
         return fp.read()

   image = get_file_content('文件路径')
   url = "https://www.x.com/sample.jpg"
   pdf_file = get_file_content('文件路径')
   
	# 调用通用文字识别(高精度含位置版)
   res_image = client.accurate(image)
   res_url = client.accurateUrl(url)
   res_pdf = client.accuratePdf(pdf_file)   
   print(res_image)
   print(res_url)
   print(res_pdf)

	# 如果有可选参数
   options = {}
   options["recognize_granularity"] = "big"
   options["detect_direction"] = "true"
   options["vertexes_location"] = "true"
   options["probability"] = "true"
   res_image = client.accurate(image, options)
   res_url = client.accurateUrl(url, options)
   res_pdf = client.accuratePdf(pdf_file, options)
   print(res_image)
   print(res_url)
   print(res_pdf)
   

通用文字识别(高精度含位置版) 请求参数详情

参数 是否必选 类型 可选值范围 说明
image 和 url/pdf_file 三选一 string - 图像数据,base64编码后进行urlencode,要求base64编码和urlencode后大小不超过10M,最短边至少15px,最长边最大8192px,支持jpg/jpeg/png/bmp格式
优先级:image > url > pdf_file,当image字段存在时,url、pdf_file字段失效
url 和 image/pdf_file 三选一 string - 图片完整url,url长度不超过1024字节,url对应的图片base64编码后大小不超过10M,最短边至少15px,最长边最大8192px,支持jpg/jpeg/png/bmp格式
优先级:image > url > pdf_file,当image字段存在时,url字段失效
请注意关闭URL防盗链
pdf_file 和 image/url 三选一 string - PDF文件,base64编码后进行urlencode,要求base64编码和urlencode后大小不超过10M,最短边至少15px,最长边最大8192px
优先级:image > url > pdf_file,当image、url字段存在时,pdf_file字段失效
pdf_file_num string - 需要识别的PDF文件的对应页码,当 pdf_file 参数有效时,识别传入页码的对应页面内容,若不传入,则默认识别第 1 页
language_type string auto_detect
CHN_ENG
ENG
JAP
KOR
FRE
SPA
POR
GER
ITA
RUS
DAN
DUT
MAL
SWE
IND
POL
ROM
TUR
GRE
HUN
识别语言类型,默认为CHN_ENG
可选值包括:
- auto_detect:自动检测语言,并识别
- CHN_ENG:中英文混合
- ENG:英文
- JAP:日语
- KOR:韩语
- FRE:法语
- SPA:西班牙语
- POR:葡萄牙语
- GER:德语
- ITA:意大利语
- RUS:俄语
- DAN:丹麦语
- DUT:荷兰语
- MAL:马来语
- SWE:瑞典语
- IND:印尼语
- POL:波兰语
- ROM:罗马尼亚语
- TUR:土耳其语
- GRE:希腊语
- HUN:匈牙利语
- THA:泰语
- VIE:越南语
- ARA:阿拉伯语
- HIN:印地语
eng_granularity string word/letter 表示识别语言类型为「中英文(CHN_ENG)」的情况下,英文的单字符结果是按照单词(word)维度输出还是字母(letter)维度输出,当 recognize_granularity=small 时生效
recognize_granularity string big/small 是否定位单字符位置,big:不定位单字符位置,默认值;small:定位单字符位置
detect_direction string true/false 是否检测图像朝向,默认不检测,即:false。朝向是指输入图像是正常方向、逆时针旋转90/180/270度。可选值包括:
- true:检测朝向;
- false:不检测朝向。
vertexes_location string true/false 是否返回文字外接多边形顶点位置,不支持单字位置。默认为false
paragraph string true/false 是否输出段落信息
probability string true/false 是否返回识别结果中每一行的置信度

通用文字识别(高精度含位置版) 返回数据参数详情

字段 是否必选 类型 说明
log_id uint64 唯一的log id,用于问题定位
direction int32 图像方向,当 detect_direction=true 时返回该字段。
- - 1:未定义,
- 0:正向,
- 1:逆时针90度,
- 2:逆时针180度,
- 3:逆时针270度
words_result array[] 识别结果数组
words_result_num uint32 识别结果数,表示words_result的元素个数
+ words string 识别结果字符串
+ location array[] 位置数组(坐标0点为左上角)
++ left uint32 表示定位位置的长方形左上顶点的水平坐标
++ top uint32 表示定位位置的长方形左上顶点的垂直坐标
++ width uint32 表示定位位置的长方形的宽度
++ height uint32 表示定位位置的长方形的高度
paragraphs_result array[] 段落检测结果,当 paragraph=true 时返回该字段
+ words_result_idx array[] 一个段落包含的行序号,当 paragraph=true 时返回该字段
++ x uint32 水平坐标(坐标0点为左上角)
++ y uint32 垂直坐标(坐标0点为左上角)
+ chars array[] 单字符结果,当 recognize_granularity=small 时返回该字段
++ char string 单字符识别结果,当 recognize_granularity=small 时返回该字段
++ location array[] 位置数组(坐标0点为左上角),当 recognize_granularity=small 时返回该字段
+++ left uint32 表示定位位置的长方形左上顶点的水平坐标,当 recognize_granularity=small 时返回该字段
+++ top uint32 表示定位位置的长方形左上顶点的垂直坐标,当 recognize_granularity=small 时返回该字段
+++ width uint32 表示定位定位位置的长方形的宽度,当 recognize_granularity=small 时返回该字段
+++ height uint32 表示定位位置的长方形的高度,当 recognize_granularity=small 时返回该字段
+ probability object 识别结果中每一行的置信度值,包含average:行置信度平均值,variance:行置信度方差,min:行置信度最小值,当 probability=true 时返回该字段
pdf_file_size string 传入PDF文件的总页数,当 pdf_file 参数有效时返回该字段

通用文字识别(含位置高精度版) 返回示例

{
"log_id": 3523983603,
"direction": 0, //detect_direction=true时存在
"words_result_num": 2,
"words_result": [
    {
        "location": {
            "left": 35,
            "top": 53,
            "width": 193,
            "height": 109
        },
        "words": "感动",
        "chars": [    //recognize_granularity=small时存在
            {
                "location": {
                    "left": 56,
                    "top": 65,
                    "width": 69,
                    "height": 88
                },
                "char": "感"
            },
            {
                "location": {
                    "left": 140,
                    "top": 65,
                    "width": 70,
                    "height": 88
                },
                "char": "动"
            }
        ]
    }
    ...
]
}

通用文字识别(含生僻字版)

【该服务已停止更新,如需更好的识别效果请使用通用文字识别(高精度版 / 高精度含位置版),此两项服务已扩充字库,可支持生僻字识别】字库范围更大,支持对图片中的生僻字进行识别

通用文字识别(含生僻字版) 返回数据参数详情

字段 是否必选 类型 说明
direction int32 图像方向,当detect_direction=true时存在。
- -1:未定义,
- 0:正向,
- 1: 逆时针90度,
- 2:逆时针180度,
- 3:逆时针270度
log_id uint64 唯一的log id,用于问题定位
words_result array() 识别结果数组
words_result_num uint32 识别结果数,表示words_result的元素个数
+words string 识别结果字符串
probability object 识别结果中每一行的置信度值,包含average:行置信度平均值,variance:行置信度方差,min:行置信度最小值
+ average number 行置信度平均值
+ variance number 行置信度方差
+ min number 行置信度最小值

通用文字识别(含生僻字版) 返回示例

{
"log_id": 2471272194,
"words_result_num": 2,
"words_result":
    [
        {"words": " TSINGTAO"},
        {"words": "青島睥酒"}
    ]
}

网络图片文字识别

用户向服务请求识别一些网络上背景复杂,特殊字体的文字。

   """ 读取文件 """
   def get_file_content(filePath):
      with open(filePath, "rb") as fp:
         return fp.read()

   image = get_file_content('文件路径')
   url = "https://www.x.com/sample.jpg"
   pdf_file = get_file_content('文件路径')
	
   # 调用网络图片文字识别
   res_image = client.webImage(image)
   res_url = client.webImageUrl(url)
   res_pdf = client.webImagePdf(pdf_file)
   print(res_image)
   print(res_url)
   print(res_pdf)   

	# 如果有可选参数
   options = {}
   options["detect_direction"] = "true"
   options["detect_language"] = "true"
   res_image = client.webImage(image, options)
   res_url = client.webImageUrl(url, options)
   res_pdf = client.webImagePdf(pdf_file, options)   
   print(res_image)
   print(res_url)
   print(res_pdf)

网络图片文字识别 请求参数详情

参数 是否必选 类型 可选值范围 说明
image 和 url/pdf_file 三选一 string - 图像数据,base64编码后进行urlencode,要求base64编码和urlencode后大小不超过4M,最短边至少15px,最长边最大4096px,支持jpg/jpeg/png/bmp格式
优先级:image > url > pdf_file,当image字段存在时,url、pdf_file字段失效
url 和 image/pdf_file 三选一 string - 图片完整url,url长度不超过1024字节,url对应的图片base64编码后大小不超过4M,最短边至少15px,最长边最大4096px,支持jpg/jpeg/png/bmp格式
优先级:image > url > pdf_file,当image字段存在时,url字段失效
请注意关闭URL防盗链
pdf_file 和 image/url 三选一 string - PDF文件,base64编码后进行urlencode,要求base64编码和urlencode后大小不超过4M,最短边至少15px,最长边最大4096px
优先级:image > url > pdf_file,当image、url字段存在时,pdf_file字段失效
pdf_file_num string - 需要识别的PDF文件的对应页码,当 pdf_file 参数有效时,识别传入页码的对应页面内容,若不传入,则默认识别第 1 页
detect_direction string true/false 是否检测图像朝向,默认不检测,即:false。朝向是指输入图像是正常方向、逆时针旋转90/180/270度。可选值包括:
- true:检测朝向;
- false:不检测朝向。
detect_language string true/false 是否检测语言,默认不检测。当前支持(中文、英语、日语、韩语)

网络图片文字识别 返回数据参数详情

字段 是否必选 类型 说明
direction int32 图像方向,当 detect_direction=true 时返回该字段。
- - 1:未定义,
- 0:正向,
- 1:逆时针90度,
- 2:逆时针180度,
- 3:逆时针270度
log_id uint64 唯一的log id,用于问题定位
words_result array[] 定位和识别结果数组
words_result_num uint32 识别结果数,表示words_result的元素个数
+ words string 识别结果字符串
probability object 识别结果中每一行的置信度值,包含average:行置信度平均值,variance:行置信度方差,min:行置信度最小值
pdf_file_size string 传入PDF文件的总页数,当 pdf_file 参数有效时返回该字段

网络图片文字识别 返回示例

{
"log_id": 2471272194,
"words_result_num": 2,
"words_result":
    [
        {"words": " TSINGTAO"},
        {"words": "青島睥酒"}
    ]
}

身份证识别

用户向服务请求识别身份证,身份证识别包括正面和背面。

    """ 读取图片 """
    def get_file_content(filePath):
        with open(filePath, 'rb') as fp:
            return fp.read()

    image = get_file_content('example.jpg')
    url = "https://www.x.com/sample.jpg"
    
    idCardSide = "back"

    # 调用身份证识别
    res_image = client.idcard(image, idCardSide)
    res_url = client.idcardUrl(url, idCardSide)    
    print(res_image)
    print(res_url)
    
    # 如果有可选参数
    options = {}
    options["detect_direction"] = "true"
    options["detect_risk"] = "false"
    res_image = client.idcard(image, idCardSide, options)
    res_url = client.idcardUrl(url, idCardSide, options)    
    print(res_image)
    print(res_url)    

身份证识别 请求参数详情

参数 是否必选 类型 可选值范围 说明
image 和url二选一 string - 图像数据,base64编码后进行urlencode,要求base64编码和urlencode后大小不超过4M,最短边至少15px,最长边最大4096px,支持jpg/jpeg/png/bmp格式
url 和image二选一 string - 图片完整URL,URL长度不超过1024字节,URL对应的图片base64编码后大小不超过4M,最短边至少15px,最长边最大4096px,支持jpg/jpeg/png/bmp格式,当image字段存在时url字段失效
请注意关闭URL防盗链
id_card_side string front/back -front:身份证含照片的一面
-back:身份证带国徽的一面
自动检测身份证正反面,如果传参指定方向与图片相反,支持正常识别,返回参数image_status字段为"reversed_side"
detect_direction string true/false 是否检测图像朝向,默认不检测,即:false。朝向是指输入图像是正常方向、逆时针旋转90/180/270度。可选值包括:
- true:检测朝向;
- false:不检测朝向
detect_risk string true/false 是否开启身份证风险类型(身份证复印件、临时身份证、身份证翻拍、修改过的身份证)检测功能,默认不开启,即:false。
- true:开启,请查看返回参数risk_type;
- false:不开启
detect_quality string true/false 是否开启身份证质量类型(边框/四角不完整、头像或关键字段被遮挡/马赛克)检测功能,默认不开启,即:false。
- true:开启,请查看返回参数card_quality;
- false:不开启
detect_photo string true/false 是否检测头像内容,默认不检测。可选值:true-检测头像并返回头像的 base64 编码及位置信息
detect_card string true/false 是否检测身份证进行裁剪,默认不检测。可选值:true-检测身份证并返回证照的 base64 编码及位置信息

身份证识别 返回数据参数详情

字段 是否必选 类型 说明
direction int32 图像方向,当 detect_direction=true 时返回该字段。
- - 1:未定义,
- 0:正向,
- 1:逆时针90度,
- 2:逆时针180度,
- 3:逆时针270度
image_status string normal-识别正常
reversed_side-身份证正反面颠倒
non_idcard-上传的图片中不包含身份证
blurred-身份证模糊
other_type_card-其他类型证照
over_exposure-身份证关键字段反光或过曝
over_dark-身份证欠曝(亮度过低)
unknown-未知状态
risk_type string 输入参数 detect_risk = true 时,则返回该字段识别身份证风险类型:
normal-正常身份证;
copy-复印件;
temporary-临时身份证;
screen-翻拍;
unknown-其他未知情况
edit_tool string 如果参数 detect_risk = true 时,则返回此字段。如果检测身份证被编辑过,该字段指定编辑软件名称,如:Adobe Photoshop CC 2014 (Macintosh),如果没有被编辑过则返回值无此参数
card_quality object 输入参数 detect_quality = true 时,则返回该字段识别身份证质量类型:
IsClear - 是否清晰;
IsComplete - 是否边框/四角完整;
IsNoCover - 是否头像、关键字段无遮挡/马赛克。
及对应的概率:IsComplete_propobility、IsNoCover_propobility、IsClear_propobility,值在0-1之间,值越大表示图像质量越好。
默认阈值:当 IsComplete_propobility 超过0.5时,IsComplete返回1,低于0.5,则返回0。IsNoCover_propobility、IsClear_propobility 同上
log_id uint64 唯一的log id,用于问题定位
photo string 当请求参数 detect_photo = true时返回,头像切图的 base64 编码(无编码头,需自行处理)
photo_location object 当请求参数 detect_photo = true时返回,头像的位置信息(坐标0点为左上角)
card_image string 当请求参数 detect_card = true时返回,身份证裁剪切图的 base64 编码(无编码头,需自行处理)
card_location object 当请求参数 detect_card = true时返回,身份证裁剪切图的位置信息(坐标0点为左上角)
idcard_number_type string 用于校验身份证号码、性别、出生是否一致,输出结果及其对应关系如下:
- 1: 身份证正面所有字段全为空
0: 身份证证号不合法,此情况下不返回身份证证号
1: 身份证证号和性别、出生信息一致
2: 身份证证号和性别、出生信息都不一致
3: 身份证证号和出生信息不一致
4: 身份证证号和性别信息不一致
words_result array[] 定位和识别结果数组
words_result_num uint32 识别结果数,表示words_result的元素个数
+ location array[] 位置数组(坐标0点为左上角)
++ left uint32 表示定位位置的长方形左上顶点的水平坐标
++ top uint32 表示定位位置的长方形左上顶点的垂直坐标
++ width uint32 表示定位位置的长方形的宽度
++ height uint32 表示定位位置的长方形的高度
+ words string 识别结果字符串

身份证识别 返回示例

{
    "log_id": 2648325511,
    "direction": 0,
    "image_status": "normal",
    "idcard_type": "normal",
    "edit_tool": "Adobe Photoshop CS3 Windows",
    "words_result": {
        "住址": {
            "location": {
                "left": 267,
                "top": 453,
                "width": 459,
                "height": 99
            },
            "words": "南京市江宁区弘景大道3889号"
        },
        "公民身份号码": {
            "location": {
                "left": 443,
                "top": 681,
                "width": 589,
                "height": 45
            },
            "words": "330881199904173914"
        },
        "出生": {
            "location": {
                "left": 270,
                "top": 355,
                "width": 357,
                "height": 45
            },
            "words": "19990417"
        },
        "姓名": {
            "location": {
                "left": 267,
                "top": 176,
                "width": 152,
                "height": 50
            },
            "words": "伍云龙"
        },
        "性别": {
            "location": {
                "left": 269,
                "top": 262,
                "width": 33,
                "height": 52
            },
            "words": "男"
        },
        "民族": {
            "location": {
                "left": 492,
                "top": 279,
                "width": 30,
                "height": 37
            },
            "words": "汉"
        }
    },
    "words_result_num": 6
}

银行卡识别

识别银行卡并返回卡号和发卡行。

    """ 读取图片 """
    def get_file_content(filePath):
        with open(filePath, 'rb') as fp:
            return fp.read()

    image = get_file_content('example.jpg')
    url = "https://www.x.com/sample.jpg"    

    # 调用银行卡识别
    res_image = client.bankcard(image)
    res_url = client.bankcardUrl(url)    
    print(res_image)
    print(res_url)    

银行卡识别 请求参数详情

参数 类型 是否必须 说明
image string 和url二选一 图像数据,base64编码后进行urlencode,需去掉编码头(data:image/jpeg;base64, )
要求base64编码和urlencode后大小不超过4M,最短边至少15px,最长边最大4096px,支持jpg/jpeg/png/bmp格式
url string 和image二选一 图片完整URL,URL长度不超过1024字节,URL对应的图片base64编码后大小不超过4M,最短边至少15px,最长边最大4096px,支持jpg/jpeg/png/bmp格式,当image字段存在时url字段失效
请注意关闭URL防盗链
detect_direction string true/false 是否检测图像朝向,默认检测,即:true。可选值包括true - 检测朝向;false - 不检测朝向。朝向是指输入图像是正常方向、逆时针旋转90/180/270度。

银行卡识别 返回数据参数详情

参数 类型 是否必须 说明
log_id uint64 请求标识码,随机数,唯一。
direction int32 图像方向,当 detect_direction = true 时,返回该参数。
- - 1:未定义;
- 0:正向;
- 1:逆时针90度;
- 2:逆时针180度;
- 3:逆时针270度
result object 返回结果
+ bank_card_number string 银行卡卡号
+ valid_date string 有效期
+ bank_card_type uint32 银行卡类型,0:不能识别; 1:借记卡; 2:贷记卡(原信用卡大部分为贷记卡); 3:准贷记卡; 4:预付费卡
+ bank_name string 银行名,不能识别时为空
+ holder_name string 持卡人姓名,不能识别时为空

银行卡识别 返回示例

{
    "log_id": 1447188951,
    "result": {
        "bank_card_number": "622500000000000",
        "bank_name": "招商银行",
        "bank_card_type": 1
    }
}

驾驶证识别

对机动车驾驶证所有关键字段进行识别。

    """ 读取图片 """
    def get_file_content(filePath):
        with open(filePath, 'rb') as fp:
            return fp.read()

    image = get_file_content('example.jpg')
    url = "https://www.x.com/sample.jpg"
    
    # 调用驾驶证识别
    res_image = client.drivingLicense(image)
    res_url = client.drivingLicenseUrl(url)    
    print(res_image)
    print(res_url)

    # 如果有可选参数
    options = {}
    options["detect_direction"] = "true"
    res_image = client.drivingLicense(image, options)
    res_url = client.drivingLicenseUrl(url, options)    
    print(res_image)
    print(res_url)

驾驶证识别 请求参数详情

参数 是否必选 类型 可选值范围 说明
image 和image二选一 string - 图像数据,base64编码后进行urlencode,要求base64编码和urlencode后大小不超过4M,最短边至少15px,最长边最大4096px,支持jpg/jpeg/png/bmp格式
url 和image二选一 string - 图片完整URL,URL长度不超过1024字节,URL对应的图片base64编码后大小不超过4M,最短边至少15px,最长边最大4096px,支持jpg/jpeg/png/bmp格式,当image字段存在时url字段失效
请注意关闭URL防盗链
detect_direction string true/false - false:默认值,不检测朝向,朝向是指输入图像是正常方向、逆时针旋转90/180/270度
- true:检测朝向
driving_license_side string front/back - front:默认值,识别驾驶证正页
- back:识别驾驶证副页
unified_valid_period bool true/false - false: 默认值,不进行归一化处理
- true: 归一化格式输出驾驶证的「有效起始日期」+「有效期限」及「有效期限」+「至」两种输出格式归一化为「有效起始日期」+「失效日期」
quality_warn string true/false 是否开启质量检测功能,仅在驾驶证正页识别时生效,
- false:默认值,不输出质量告警信息
- true: 输出驾驶证遮挡、不完整质量告警信息
risk_warn string true/false 是否开启风险检测功能,
- false:默认值,不输出风险告警信息
- true:开启,输出驾驶证复印、翻拍、PS等告警信息

驾驶证识别 返回数据参数详情

字段 是否必选 类型 说明
log_id uint64 唯一的log id,用于问题定位
direction int32 图像方向,当 detect_direction=true 时返回该字段。
- - 1:未定义,
- 0:正向,
- 1:逆时针90度,
- 2:逆时针180度,
- 3:逆时针270度
words_result_num uint32 识别结果数,表示words_result的元素个数
words_result object 识别结果
+ words string 识别结果字符串
warn_infos array[] 当输入参数 driving_license_side=front,且 quality_warn=true 时输出,
- shield:驾驶证证照存在遮挡告警提示
- incomplete:驾驶证证照边框不完整告警提示
risk_type string 当输入参数 risk_warn=true 时返回识出的驾驶证的类型:normal-正常驾驶证;copy-复印件;screen-翻拍
edit_tool string 当输入参数 risk_warn=true 时返回,如果检测驾驶证被编辑过,该字段指定编辑软件名称,如:Adobe Photoshop CC 2014 (Macintosh),如果没有被编辑过则返回值为空

返回示例(驾驶证正页)

{
    "words_result": {
        "姓名": {
            "words": "王桃桃"
        },
        "至": {
            "words": "20210518"
        },
        "出生日期": {
            "words": "19880929"
        },
        "证号": {
            "words": "210282198809294228"
        },
        "住址": {
            "words": "辽宁省大连市甘井子区"
        },
        "初次领证日期": {
            "words": "20150518"
        },
        "国籍": {
            "words": "中国"
        },
        "准驾车型": {
            "words": "C1"
        },
        "性别": {
            "words": "女"
        },
        "有效期限": {
            "words": "20150518"
        },
        "发证单位": {
			"words": "北京市公安局公安交通管理局"
        }
    "log_id": 1321746413993852928,
    "words_result_num": 11,
    "direction": -1
}

返回示例(驾驶证副页)

{
    "words_result": {
        "姓名": {
            "words": "万万"
        },
        "记录": {
            "words": "请于每个记分周期结束后三十日接受审验。无记分的,免予本次审验。"
        },
        "证号": {
            "words": "513601198209290000"
        },
        "档案编号": {
            "words": "511600001169"
        }
    },
    "direction": 0,
    "words_result_num": 4,
    "log_id": 1483000040398531214
}

行驶证识别

对机动车行驶证正本所有关键字段进行识别。

    """ 读取图片 """
    def get_file_content(filePath):
        with open(filePath, 'rb') as fp:
            return fp.read()

    image = get_file_content('example.jpg')
    url = "https://www.x.com/sample.jpg"
    
    # 调用行驶证识别
    res_image = client.vehicleLicense(image)
    res_url = client.vehicleLicenseUrl(url)    
    print(res_image)
    print(res_url)    

    # 如果有可选参数
    options = {}
    options["detect_direction"] = "true"
    options["accuracy"] = "normal"
    res_image = client.vehicleLicense(image, options)
    res_url = client.vehicleLicenseUrl(url, options)    
    print(res_image)
    print(res_url)    

行驶证识别 请求参数详情

参数 是否必选 类型 可选值范围 说明
image 和image二选一 string - 图像数据,base64编码后进行urlencode,要求base64编码和urlencode后大小不超过4M,最短边至少15px,最长边最大4096px,支持jpg/jpeg/png/bmp格式
url 和image二选一 string - 图片完整URL,URL长度不超过1024字节,URL对应的图片base64编码后大小不超过4M,最短边至少15px,最长边最大4096px,支持jpg/jpeg/png/bmp格式,当image字段存在时url字段失效
请注意关闭URL防盗链
detect_direction string true/false - false:默认值不进行图像方向自动矫正
- true: 开启图像方向自动矫正功能,可对旋转 90/180/270 度的图片进行自动矫正并识别
vehicle_license_side string front/back - front:默认值,识别行驶证主页
- back:识别行驶证副页
unified string true/false - false:默认值,不进行归一化处理
- true:对输出字段进行归一化处理,将新/老版行驶证的“注册登记日期/注册日期”统一为”注册日期“进行输出
quality_warn string true/false 是否开启质量检测功能,仅在行驶证正页识别时生效,
- false:默认值,不输出质量告警信息
- true: 输出行驶证遮挡、不完整质量告警信息
risk_warn string true/false 是否开启风险检测功能,
- false:默认值,不输出风险告警信息
- true:开启,输出行驶证复印、翻拍、PS等告警信息

行驶证识别 返回数据参数详情

字段 必选 类型 说明
log_id uint64 唯一的log id,用于问题定位
direction int32 图像方向,当 detect_direction=true 时返回该字段。
- - 1:未定义,
- 0:正向,
- 1:逆时针90度,
- 2:逆时针180度,
- 3:逆时针270度
words_result_num uint32 识别结果数,表示words_result的元素个数
words_result object 识别结果
+ words string 识别结果字符串
warn_infos array[] 当输入参数 vehicle_license_side=front,且 quality_warn=true 时输出,
- shield:行驶证证照存在遮挡告警提示
- incomplete:行驶证证照边框不完整告警提示
risk_type string 当输入参数 risk_warn=true 时返回识出的行驶证的类型:normal-正常行驶证;copy-复印件;screen-翻拍
edit_tool string 当输入参数 risk_warn=true 时返回,如果检测行驶证被编辑过,该字段指定编辑软件名称,如:Adobe Photoshop CC 2014 (Macintosh),如果没有被编辑过则返回值为空

行驶证识别 返回示例

{
  "errno": 0,
  "msg": "success",
  "data": {
    "words_result_num": 10,
    "words_result": {
      "品牌型号": {
        "words": "保时捷GT37182RUCRE"
      },
      "发证日期": {
        "words": "20160104"
      },
      "使用性质": {
        "words": "非营运"
      },
      "发动机号码": {
        "words": "20832"
      },
      "号牌号码": {
        "words": "苏A001"
      },
      "所有人": {
        "words": "圆圆"
      },
      "住址": {
        "words": "南京市江宁区弘景大道"
      },
      "注册日期": {
        "words": "20160104"
      },
      "车辆识别代号": {
        "words": "HCE58"
      },
      "车辆类型": {
        "words": "小型轿车"
      }
    }
  }
}

车牌识别

识别机动车车牌,并返回号牌号码和车牌颜色。

    """ 读取图片 """
    def get_file_content(filePath):
        with open(filePath, 'rb') as fp:
            return fp.read()

    image = get_file_content('example.jpg')
    url = "https://www.x.com/sample.jpg"
    
    # 调用车牌识别
    res_image = client.licensePlate(image)
    res_url = client.licensePlateUrl(url)    
    print(res_image)
    print(res_url)    
    
    # 如果有可选参数
    options = {}
    options["multi_detect"] = "true"
    res_image = client.licensePlate(image, options)
    res_url = client.licensePlateUrl(url, options)    
    print(res_image)
    print(res_url)    

车牌识别 请求参数详情

参数名称 是否必选 类型 可选值范围 默认值 说明
image string 图像数据,base64编码,要求base64编码后大小不超过4M,最短边至少15px,最长边最大4096px,支持jpg/png/bmp格式
multi_detect string true
false
false 是否检测多张车牌,默认为false,当置为true的时候可以对一张图片内的多张车牌进行识别

车牌识别 返回数据参数详情

参数 类型 是否必须 说明
log_id uint64 请求标识码,随机数,唯一。
Color string 车牌颜色
number string 车牌号码

车牌识别 返回示例

{
    "log_id": 3583925545,
    "words_result": {
        "color": "blue",
        "number": "苏HS7766"
    }
}

营业执照识别

识别营业执照,并返回关键字段的值,包括单位名称、法人、地址、有效期、证件编号、社会信用代码等。

    """ 读取图片 """
    def get_file_content(filePath):
        with open(filePath, 'rb') as fp:
            return fp.read()

    image = get_file_content('example.jpg')
    url = "https://www.x.com/sample.jpg"
    
    # 调用营业执照识别
    res_image = client.businessLicense(image)
    res_url = client.businessLicenseUrl(url)    
    print(res_image)
    print(res_url)

营业执照识别 请求参数详情

参数 类型 是否必须 说明
image string 和url二选一 图像数据,base64编码后进行urlencode,要求base64编码和urlencode后大小不超过4M,最短边至少15px,最长边最大4096px,支持jpg/jpeg/png/bmp格式
url string 和image二选一 图片完整URL,URL长度不超过1024字节,URL对应的图片base64编码后大小不超过4M,最短边至少15px,最长边最大4096px,支持jpg/jpeg/png/bmp格式,当image字段存在时url字段失效
请注意关闭URL防盗链
detect_direction string 此参数新版本无需传,支持自动检测图像旋转角度;朝向是指输入图像是正常方向、逆时针旋转90/180/270度
accuracy string 此参数新版本无需传,可选值:normal,high
risk_warn string 是否开启风险类型功能,默认不开启,即:false。
- false:不开启
- true:开启

营业执照识别 返回数据参数详情

参数 是否必须 类型 说明
log_id uint64 请求标识码,随机数,唯一。
direction uint32 图像方向,当图像旋转时,返回该参数。
- - 1:未定义,
- 0:正向,
- 1:逆时针90度,
- 2:逆时针180度,
- 3:逆时针270度
risk_type string 当输入参数 risk_warn=true 时返回识出的营业执照的类型:normal-正常营业执照;copy-复印件;screen-翻拍;scan-扫描
words_result_num uint32 识别结果数,表示words_result的元素个数
words_result object 识别结果
+ location object 位置数组(坐标0点为左上角)
++ left uint32 表示定位位置的长方形左上顶点的水平坐标
++ top uint32 表示定位位置的长方形左上顶点的垂直坐标
++ width uint32 表示定位位置的长方形的宽度
++ height uint32 表示定位位置的长方形的高度
+ words string 识别结果字符串

营业执照识别 返回示例

{
    "log_id": 490058765,
    "words_result": {
        "单位名称": {
            "location": {
                "left": 500,
                "top": 479,
                "width": 618,
                "height": 54
            },
            "words": "袁氏财团有限公司"
        },
        "法人": {
            "location": {
                "left": 938,
                "top": 557,
                "width": 94,
                "height": 46
            },
            "words": "袁运筹"
        },
        "地址": {
            "location": {
                "left": 503,
                "top": 644,
                "width": 574,
                "height": 57
            },
            "words": "江苏省南京市中山东路19号"
        },
        "有效期": {
            "location": {
                "left": 779,
                "top": 1108,
                "width": 271,
                "height": 49
            },
            "words": "2015年02月12日"
        },
        "证件编号": {
            "location": {
                "left": 1219,
                "top": 357,
                "width": 466,
                "height": 39
            },
            "words": "苏餐证字(2019)第666602666661号"
        },
        "社会信用代码": {
            "location": {
                "left": 0,
                "top": 0,
                "width": 0,
                "height": 0
            },
            "words": "无"
        }
    },
    "words_result_num": 6
}

通用票据识别

用户向服务请求识别医疗票据、增值税发票、出租车票、保险保单等票据类图片中的所有文字,并返回文字在图中的位置信息。

    """ 读取图片 """
    def get_file_content(filePath):
        with open(filePath, 'rb') as fp:
            return fp.read()

    image = get_file_content('example.jpg')
    url = "https://www.x.com/sample.jpg"
    
    # 调用通用票据识别
    res_image = client.receipt(image)
    res_url = client.receiptUrl(url)    
    print(res_image)
    print(res_url)

    # 如果有可选参数
    options = {}
    options["recognize_granularity"] = "big"
    options["probability"] = "true"
    options["accuracy"] = "normal"
    options["detect_direction"] = "true"
    res_image = client.receipt(image, options)
    res_url = client.receiptUrl(url, options)    
    print(res_image)
    print(res_url)    

通用票据识别 请求参数详情

参数 是否必选 类型 可选值范围 说明
image 和url二选一 string - 图像数据,base64编码后进行urlencode,要求base64编码和urlencode后大小不超过4M,最短边至少15px,最长边最大4096px,支持jpg/jpeg/png/bmp格式
url 和image二选一 string - 图片完整URL,URL长度不超过1024字节,URL对应的图片base64编码后大小不超过4M,最短边至少15px,最长边最大4096px,支持jpg/jpeg/png/bmp格式,当image字段存在时url字段失效
请注意关闭URL防盗链
recognize_granularity string big/small 是否定位单字符位置,big:不定位单字符位置,默认值;small:定位单字符位置
probability string true/false 是否返回识别结果中每一行的置信度
accuracy string normal/缺省 normal:使用快速服务;缺省或其它值:使用高精度服务
detect_direction string true/false 是否检测图像朝向,默认不检测,即:false。可选值包括:
- true:检测朝向;
- false:不检测朝向,朝向是指输入图像是正常方向、逆时针旋转90/180/270度

通用票据识别 返回数据参数详情

字段 是否必选 类型 说明
log_id uint64 唯一的log id,用于问题定位
words_result_num uint32 识别结果数,表示words_result的元素个数
words_result array[] 定位和识别结果数组
+ location object{} 位置数组(坐标0点为左上角)
++ left uint32 表示定位位置的长方形左上顶点的水平坐标
++ top uint32 表示定位位置的长方形左上顶点的垂直坐标
++ width uint32 表示定位位置的长方形的宽度
++ height uint32 表示定位位置的长方形的高度
+ words string 识别结果字符串
+ chars array[] 单字符结果,recognize_granularity=small 时存在
++ char string 单字符识别结果
++ location object{} 位置数组(坐标0点为左上角)
+++ left uint32 表示定位位置的长方形左上顶点的水平坐标
+++ top uint32 表示定位位置的长方形左上顶点的垂直坐标
+++ width uint32 表示定位定位位置的长方形的宽度
+++ height uint32 表示位置的长方形的高度
+ probability float 识别结果中每一行的置信度值,包含average:行置信度平均值,variance:行置信度方差,min:行置信度最小值

通用票据识别 返回示例

{
    "log_id": 2661573626,
    "words_result": [
        {
            "location": {
                "left": 10,
                "top": 3,
                "width": 121,
                "height": 24
            },
            "words": "姓名:小明明",
            "chars": [
                {
                    "location": {
                        "left": 16,
                        "top": 6,
                        "width": 17,
                        "height": 20
                    },
                    "char": "姓"
                }
                ...
            ]
        },
        {
            "location": {
                "left": 212,
                "top": 3,
                "width": 738,
                "height": 24
            },
            "words": "卡号/病案号:105353990标本编号:150139071送检科室:血液透析门诊病房",
            "chars": [
                {
                    "location": {
                        "left": 218,
                        "top": 6,
                        "width": 18,
                        "height": 21
                    },
                    "char": "卡"
                }
                ...
            ]
        }
    ],
    "words_result_num": 2
}

自定义模板文字识别

自定义模板文字识别,是针对百度官方没有推出相应的模板,但是当用户需要对某一类卡证/票据(如房产证、军官证、火车票等)进行结构化的提取内容时,可以使用该产品快速制作模板,进行识别。

    # 读取图片
    def get_file_content(filePath):
        with open(filePath, 'rb') as fp:
            return fp.read()
    image = get_file_content('aa.jpg')

    # 必填参数
    options = {}
    # key固定为templateSign 后面给页面提供的 模板ID(templateSign) 的值即可
    options["templateSign"] = ""
    # 调用自定义模板文字识别
    res_image = client.custom(image, options)
    print(res_image)

自定义模板文字识别 请求参数详情

参数名称 是否必选 类型 说明
image string 图像数据,base64编码,要求base64编码后大小不超过4M,最短边至少15px,最长边最大4096px,支持jpg/png/bmp格式
options object 用于传入额外参数,如templateSign、classifierId
+ templateSign string 您在自定义文字识别平台制作的模板的ID
+ classifierId string 分类器Id。这个参数和templateSign至少存在一个,优先使用templateSign。存在templateSign时,表示使用指定模板;如果没有templateSign而有classifierId,表示使用分类器去判断使用哪个模板

自定义模板文字识别 返回数据参数详情

字段 是否必选 类型 说明
error_code number number 0代表成功,如果有错误码返回可以参考下方错误码列表排查问题
error_msg string 具体的失败信息,可以参考下方错误码列表排查问题
data jsonObject 识别返回的结果

自定义模板文字识别 返回示例

{
    "isStructured": true,
    "ret": [
        {
            "charset": [
                {
                    "rect": {
                        "top": 183,
                        "left": 72,
                        "width": 14,
                        "height": 28
                    },
                    "word": "5"
                },
                {
                    "rect": {
                        "top": 183,
                        "left": 90,
                        "width": 14,
                        "height": 28
                    },
                    "word": "4"
                },
                {
                    "rect": {
                        "top": 183,
                        "left": 103,
                        "width": 15,
                        "height": 28
                    },
                    "word": "."
                },
                {
                    "rect": {
                        "top": 183,
                        "left": 116,
                        "width": 14,
                        "height": 28
                    },
                    "word": "5"
                },
                {
                    "rect": {
                        "top": 183,
                        "left": 133,
                        "width": 19,
                        "height": 28
                    },
                    "word": "元"
                }
            ],
            "word_name": "票价",
            "word": "54.5元"
        },
        {
            "charset": [
                {
                    "rect": {
                        "top": 144,
                        "left": 35,
                        "width": 14,
                        "height": 28
                    },
                    "word": "2"
                },
                {
                    "rect": {
                        "top": 144,
                        "left": 53,
                        "width": 14,
                        "height": 28
                    },
                    "word": "0"
                },
                {
                    "rect": {
                        "top": 144,
                        "left": 79,
                        "width": 14,
                        "height": 28
                    },
                    "word": "1"
                },
                {
                    "rect": {
                        "top": 144,
                        "left": 97,
                        "width": 14,
                        "height": 28
                    },
                    "word": "7"
                }
            ]
    ]
}

试卷分析与识别

可对文档版面进行分析,输出图、表、标题、文本的位置,并输出分版块内容的OCR识别结果,支持中、英两种语言,手写、印刷体混排多种场景。

    """ 读取图片 """
    def get_file_content(filePath):
        with open(filePath, 'rb') as fp:
            return fp.read()

    image = get_file_content('example.jpg')
    url = "https://www.x.com/sample.jpg"
    pdf_file = get_file_content('文件路径')    

    # 调用试卷分析与识别
    res_image = client.docAnalysis(image)
    res_url = client.docAnalysisUrl(url)
    res_pdf = client.docAnalysisPdf(pdf_file)    
    print(res_image)
    print(res_url)
    print(res_pdf)    

识别结果 请求参数详情

参数 是否必选 类型 可选值范围 说明
image 和 url/pdf_file 三选一 string - 图像数据,base64编码后进行urlencode,要求base64编码和urlencode后大小不超过4M,最短边至少15px,最长边最大4096px,支持jpg/jpeg/png/bmp格式
优先级:image > url > pdf_file,当image字段存在时,url、pdf_file字段失效
url 和 image/pdf_file 三选一 string - 图片完整url,url长度不超过1024字节,url对应的图片base64编码后大小不超过4M,最短边至少15px,最长边最大4096px,支持jpg/jpeg/png/bmp格式
优先级:image > url > pdf_file,当image字段存在时,url字段失效
请注意关闭URL防盗链
pdf_file 和 image/url 三选一 string - PDF文件,base64编码后进行urlencode,要求base64编码和urlencode后大小不超过4M,最短边至少15px,最长边最大4096px
优先级:image > url > pdf_file,当image、url字段存在时,pdf_file字段失效
pdf_file_num string - 需要识别的PDF文件的对应页码,当 pdf_file 参数有效时,识别传入页码的对应页面内容,若不传入,则默认识别第 1 页
language_type string CHN_ENG/ ENG 识别语言类型,默认为CHN_ENG
可选值包括:
= CHN_ENG:中英文
= ENG:英文
result_type string big/small 返回识别结果是按单行结果返回,还是按单字结果返回,默认为big。
= big:返回行识别结果
= small:返回行识别结果之上还会返回单字结果
detect_direction string true/false 是否检测图像朝向,默认不检测,即:false。朝向是指输入图像是正常方向、逆时针旋转90/180/270度。其中,
0 :正向
1:逆时针旋转90度
2:逆时针旋转180度
3:逆时针旋转270度
line_probability string true/false 是否返回每行识别结果的置信度。默认为false
words_type string handwring_only/ handprint_mix 文字类型。
默认:印刷文字识别
= handwring_only:手写文字识别
= handprint_mix: 手写印刷混排识别
layout_analysis string true/false 是否分析文档版面:包括图、表、标题、段落的分析输出

识别结果 返回数据参数详情

字段 是否必选 类型 说明
log_id uint64 唯一的log id,用于问题定位
img_direction int32 detect_direction=true 时返回。检测到的图像朝向,0 :正向; 1:逆时针旋转90度;2:逆时针旋转180度;3:逆时针旋转270度
results_num uint32 识别结果数,表示results的元素个数
results array[] 识别结果数组
+ words_type string 文字属性(手写、印刷),handwriting 手写,print 印刷
+ words array[] 整行的识别结果数组。
++ line_probability array[] line_probability=true 时返回。识别结果中每一行的置信度值,包含average:行置信度平均值,min:行置信度最小值
+++ average float 行置信度
+++ min float 整行中单字的最低置信度
++ word float 整行的识别结果
++ words_location array[] 整行的矩形框坐标。位置数组(坐标0点为左上角)
+++ left uint32 表示定位位置的长方形左上顶点的水平坐标
+++ top uint32 表示定位位置的长方形左上顶点的垂直坐标
+++ width uint32 表示定位定位位置的长方形的宽度
+++ height uint32 表示位置的长方形的高度
+ chars array[] result_type=small 时返回。单字符结果数组
++ char string result_type=small 时返回。每个单字的内容
++ chars_location array[] 每个单字的矩形框坐标。位置数组(坐标0点为左上角)
+++ left uint32 表示定位位置的长方形左上顶点的水平坐标
+++ top uint32 表示定位位置的长方形左上顶点的垂直坐标
+++ width uint32 表示定位定位位置的长方形的宽度
+++ height uint32 表示位置的长方形的高度
layouts_num uint32 版面分析结果数,表示layout的元素个数
layouts array[] 文档版面信息数组,包含表格、图、段落文本、标题等标签;标签的坐标位置;段落文本和表格内文本内容对应的行序号ID
+ layout string 版面分析的标签结果。表格:table, 图:figure, 文本:text, 标题:title
+ layout_location array[] 文档版面信息标签的位置,四个顶点: 左上,右上,右下,左下
++ x uint32 水平坐标(坐标0点为左上角)
++ y uint32 水平坐标(坐标0点为左上角)
+ layout_idx array[] 文档版面信息中的文本在results结果中的位置:版面文本标签对应的行序号ID为n,则此标签中的文本在results结果中第n+1条展示)
pdf_file_size string 传入PDF文件的总页数,当 pdf_file 参数有效时返回该字段

仪器仪表盘读数识别

适用于不同品牌、不同型号的仪器仪表盘读数识别,广泛适用于各类血糖仪、血压仪、燃气表、电表等,可识别表盘上的数字、英文、符号,支持液晶屏、字轮表等表型。

    """ 读取图片 """
    def get_file_content(filePath):
        with open(filePath, 'rb') as fp:
            return fp.read()

    image = get_file_content('example.jpg')
    url = "https://www.x.com/sample.jpg"
    
    # 调用仪器仪表盘读数识别
    res_image = client.meter(image)
    res_url = client.meterUrl(url)    
    print(res_image)
    print(res_url)
    
    # 如果有可选参数
    options={}
    options['poly_location']='true'
    res_image = client.meter(image, options)
    res_url = client.meterUrl(url, options)
    print(res_image)
    print(res_url)    

识别结果 请求参数详情

参数 是否必选 类型 可选值范围 说明
image 和url二选一 string - 图像数据,base64编码后进行urlencode,要求base64编码和urlencode后大小不超过4M,最短边至少15px,最长边最大4096px。支持jpg/jpeg/png/bmp格式.注意:图片的base64编码是不包含图片头的,如(data:image/jpg;base64,)
url 和image二选一 string - 图片完整URL,URL长度不超过1024字节,URL对应的图片base64编码后大小不超过4M,最短边至少15px,最长边最大4096px,支持jpg/jpeg/png/bmp格式,当image字段存在时url字段失效
请注意关闭URL防盗链
probability string true/false 是否返回每行识别结果的置信度。默认为false
poly_location string true/false 位置信息返回形式,默认:false
false:只给出识别结果所在长方形位置信息
true:除了默认的识别文字所在长方形的位置信息,还会给出文字所在区域的最小外接旋转矩形的4个点坐标信息

识别结果 返回数据参数详情

字段 是否必选 类型 说明
log_id uint64 唯一的log id,用于问题定位
words_result array[] 识别结果数组
words_result_num uint32 识别结果数,表示words_result的元素个数
+ words string 识别结果字符串
+ location array[] 识别结果所在长方形位置信息
++ left uint32 表示定位位置的长方形左上顶点的水平坐标
++ top uint32 表示定位位置的长方形左上顶点的垂直坐标
++ width uint32 表示定位位置的长方形的宽度
++ height uint32 表示定位位置的长方形的高度
+ probability string probability=true 时存在。识别结果中每一行的置信度值,包含average:行置信度平均值,variance:行置信度方差,min:行置信度最小值
+ poly_location array[] poly_location=true 时存在。文字所在区域的外接四边形的4个点坐标信息

返回示例

{
    "log_id": "1392680790663364608",
	"words_result_num": 5
	"words_result": [
		{
			"words": "5.8",
			"location": {
				"top": 150,
				"left": 370,
				"width": 87,
				"height": 79
			}
		},
		{
			"words": "mmol/L",
			"location": {
				"top": 241,
				"left": 402,
				"width": 52,
				"height": 12
			}
		},
		{
			"words": "10:38",
			"location": {
				"top": 115,
				"left": 347,
				"width": 42,
				"height": 21
			}
		},
		{
			"words": "12-11",
			"location": {
				"top": 116,
				"left": 410,
				"width": 36,
				"height": 20
			}
		},
		{
			"words": "am",
			"location": {
				"top": 115,
				"left": 391,
				"width": 12,
				"height": 5
			}
		}
	],
}

网络图片文字识别(含位置版)

支持识别艺术字体或背景复杂的文字内容,除文字信息外,还可返回每行文字的位置信息、行置信度,以及单字符内容和位置等。

    """ 读取图片 """
    def get_file_content(filePath):
        with open(filePath, 'rb') as fp:
            return fp.read()

    image = get_file_content('example.jpg')
    url = "https://www.x.com/sample.jpg"
    pdf_file = get_file_content('文件路径')    

    # 调用网络图片文字识别(含位置版)
    res_image = client.webimageLoc(image)
    res_url = client.webimageLocUrl(url)
    res_pdf = client.webimageLocPdf(pdf_file)    
    print(res_image)
    print(res_url)
    print(res_pdf)
    
    # 如果有可选参数
    options={}
    options['probability']='true'
    res_image = client.webimageLoc(image, options)
    res_url = client.webimageLocUrl(url, options)
    res_pdf = client.webimageLocPdf(pdf_file, options)
    print(res_image)
    print(res_url)
    print(res_pdf)    

网络图片文字识别(含位置版) 请求参数详情

参数 是否必选 类型 可选值范围 说明
image 和 url/pdf_file 三选一 string - 图像数据,base64编码后进行urlencode,要求base64编码和urlencode后大小不超过4M,最短边至少15px,最长边最大4096px,支持jpg/jpeg/png/bmp格式
优先级:image > url > pdf_file,当image字段存在时,url、pdf_file字段失效
url 和 image/pdf_file 三选一 string - 图片完整url,url长度不超过1024字节,url对应的图片base64编码后大小不超过4M,最短边至少15px,最长边最大4096px,支持jpg/jpeg/png/bmp格式
优先级:image > url > pdf_file,当image字段存在时,url字段失效
请注意关闭URL防盗链
pdf_file 和 image/url 三选一 string - PDF文件,base64编码后进行urlencode,要求base64编码和urlencode后大小不超过4M,最短边至少15px,最长边最大4096px
优先级:image > url > pdf_file,当image、url字段存在时,pdf_file字段失效
pdf_file_num string - 需要识别的PDF文件的对应页码,当 pdf_file 参数有效时,识别传入页码的对应页面内容,若不传入,则默认识别第 1 页
detect_direction string true/false 是否检测图像朝向,默认不检测,即:false。朝向是指输入图像是正常方向、逆时针旋转90/180/270度。可选值包括:
- true:检测朝向;
- false:不检测朝向
probability string true/false 是否返回每行识别结果的置信度。默认为false
poly_location string true/false 是否返回文字所在区域的外接四边形的4个点坐标信息。默认为false
recognize_granularity string big/small 是否定位单字符位置,big:不定位单字符位置,默认值;small:定位单字符位置

识别结果 返回数据参数详情

字段 是否必选 类型 说明
log_id uint64 唯一的log id,用于问题定位
direction int32 图像方向,当 detect_direction=true 时返回该字段。检测到的图像朝向:
- - 1:未定义;
- 0 :正向;
- 1:逆时针旋转90度;
- 2:逆时针旋转180度;
- 3:逆时针旋转270度
words_result array[] 识别结果数组
words_result_num uint32 识别结果数,表示words_result的元素个数
+ words string 整行的识别结果
+ location object 整行的矩形框坐标。位置数组(坐标0点为左上角)
++ left uint32 表示定位位置的长方形左上顶点的水平坐标
++ top uint32 表示定位位置的长方形左上顶点的垂直坐标
++ width uint32 表示定位位置的长方形的宽度
++ height uint32 表示定位位置的长方形的高度
+ probability string 当 probability=true 时返回该字段。识别结果中每一行的置信度值,包含average:行置信度平均值,variance:行置信度方差,min:行置信度最小值
+ poly_location array[] 当 probability=true 时返回该字段。文字所在区域的外接矩形的4个点坐标信息
++ x uint32 水平坐标(坐标0点为左上角)
++ y uint32 垂直坐标(坐标0点为左上角)
+ chars array[] 单字符结果,当 recognize_granularity=small 时返回该字段
++ char string 单字符识别结果
++ location object 每个单字的矩形框坐标。位置数组(坐标0点为左上角)
+++ left uint32 表示定位位置的长方形左上顶点的水平坐标
+++ top uint32 表示定位位置的长方形左上顶点的垂直坐标
+++ width uint32 表示定位定位位置的长方形的宽度
+++ height uint32 表示定位定位位置的长方形的高度
pdf_file_size string 传入PDF文件的总页数,当 pdf_file 参数有效时返回该字段
返回示例
{
    "log_id": 1390656223866519552,
    "words_result_num": 3,
    "words_result": [
        {
            "words": "梦想起航",
            "location": {
                "top": 328,
                "left": 1079,
                "width": 56,
                "height": 262
            },
        },
        {
            "words": "前往下一个目的地",
            "location": {
                "top": 329,
                "left": 1160,
                "width": 63,
                "height": 446
            },
        },
        {
            "words": "开始新的旅程",
            "location": {
                "top": 455,
                "left": 1246,
                "width": 63,
                "height": 340
            },
        }
    ],
}

增值税发票识别

支持对增值税普票、专票、卷票、电子发票、区块链发票的所有字段进行结构化识别,包括发票基本信息、销售方及购买方信息、商品信息、价税信息等,其中五要素识别准确率超过 99.9%; 同时,支持对增值税卷票的 21 个关键字段进行识别,包括发票类型、发票代码、发票号码、机打号码、机器编号、收款人、销售方名称、销售方纳税人识别号、开票日期、购买方名称、购买方纳税人识别号、项目、单价、数量、金额、税额、合计金额(小写)、合计金额(大写)、校验码、省、市,四要素平均识别准确率可达95%以上。

    """ 读取图片 """
    def get_file_content(filePath):
        with open(filePath, 'rb') as fp:
            return fp.read()

    image = get_file_content('example.jpg')
    url = "https://www.x.com/sample.jpg"
    pdf_file = get_file_content('文件路径')
    
    # 调用增值税发票识别
    res_image = client.vatInvoice(image)
    res_url = client.vatInvoiceUrl(url)
    res_pdf = client.vatInvoicePdf(pdf_file)
    print(res_image)
    print(res_url)
    print(res_pdf)
    
    # 如果有可选参数
    options={}
    options['type']='roll'
    res_image = client.vatInvoice(image, options)
    res_url = client.vatInvoiceUrl(url, options)
    res_pdf = client.vatInvoicePdf(pdf_file, options)
    print(res_image)
    print(res_url)
    print(res_pdf)

请求参数详情

参数 是否必选 类型 可选值范围 说明
image 和 url/pdf_file 三选一 string - 图像数据,base64编码后进行urlencode,要求base64编码和urlencode后大小不超过4M,最短边至少15px,最长边最大4096px,支持jpg/jpeg/png/bmp格式
优先级:image > url > pdf_file,当image字段存在时,url、pdf_file字段失效
url 和 image/pdf_file 三选一 string - 图片完整url,url长度不超过1024字节,url对应的图片base64编码后大小不超过4M,最短边至少15px,最长边最大4096px,支持jpg/jpeg/png/bmp格式
优先级:image > url > pdf_file,当image字段存在时,url字段失效
请注意关闭URL防盗链
pdf_file 和 image/url 三选一 string - PDF文件,base64编码后进行urlencode,要求base64编码和urlencode后大小不超过4M,最短边至少15px,最长边最大4096px
优先级:image > url > pdf_file,当image、url字段存在时,pdf_file字段失效
pdf_file_num string - 需要识别的PDF文件的对应页码,当 pdf_file 参数有效时,识别传入页码的对应页面内容,若不传入,则默认识别第 1 页
type string normal/roll 进行识别的增值税发票类型,默认为 normal,可缺省
- normal:可识别增值税普票、专票、电子发票
- roll:可识别增值税卷票
返回参数
字段 是否必选 类型 说明
log_id uint64 唯一的log id,用于问题定位
pdf_file_size string 传入PDF文件的总页数,当 pdf_file 参数有效时返回该字段
words_result_num uint32 识别结果数,表示words_result的元素个数
words_result object{} 识别结果
+ ServiceType string 发票消费类型。不同消费类型输出:餐饮、电器设备、通讯、服务、日用品食品、医疗、交通、其他
+ InvoiceType string 发票种类。不同类型发票输出:普通发票、专用发票、电子普通发票、电子专用发票、通行费电子普票、区块链发票、通用机打电子发票
+ InvoiceTypeOrg string 发票名称
+ InvoiceCode string 发票代码
+ InvoiceNum string 发票号码
+ InvoiceCodeConfirm string 发票代码的辅助校验码,一般业务情景可忽略
+ InvoiceNumConfirm string 发票号码的辅助校验码,一般业务情景可忽略
+ MachineNum string 机打号码。仅增值税卷票含有此参数
+ MachineCode string 机器编号。仅增值税卷票含有此参数
+ CheckCode string 校验码。增值税专票无此参数
+ InvoiceDate string 开票日期
+ PurchaserName string 购方名称
+ PurchaserRegisterNum string 购方纳税人识别号
+ PurchaserAddress string 购方地址及电话
+ PurchaserBank string 购方开户行及账号
+ Password string 密码区
+ Province string
+ City string
+ SheetNum string 联次信息。专票第一联到第三联分别输出:第一联:记账联、第二联:抵扣联、第三联:发票联;普通发票第一联到第二联分别输出:第一联:记账联、第二联:发票联
+ Agent string 是否代开
+ CommodityName array[] 货物名称
++ row uint32 行号
++ word string 内容
+ CommodityType array[] 规格型号
++ row uint32 行号
++ word string 内容
+ CommodityUnit array[] 单位
++ row uint32 行号
++ word string 内容
+ CommodityNum array[] 数量
++ row uint32 行号
++ word string 内容
+ CommodityPrice array[] 单价
++ row uint32 行号
++ word string 内容
+ CommodityAmount array[] 金额
++ row uint32 行号
++ word string 内容
+ CommodityTaxRate array[] 税率
++ row uint32 行号
++ word string 内容
+ CommodityTax array[] 税额
++ row uint32 行号
++ word string 内容
+ CommodityPlateNum array[] 车牌号。仅通行费增值税电子普通发票含有此参数
++ row uint32 行号
++ word string 内容
+ CommodityVehicleType array[] 类型。仅通行费增值税电子普通发票含有此参数
++ row uint32 行号
++ word string 内容
+ CommodityStartDate array[] 通行日期起。仅通行费增值税电子普通发票含有此参数
++ row uint33 行号
++ word string 内容
+ CommodityEndDate array[] 通行日期止。仅通行费增值税电子普通发票含有此参数
++ row uint33 行号
++ word string 内容
+ OnlinePay String 电子支付标识。仅区块链发票含有此参数
+ SellerName string 销售方名称
+ SellerRegisterNum string 销售方纳税人识别号
+ SellerAddress string 销售方地址及电话
+ SellerBank string 销售方开户行及账号
+ TotalAmount uint32 合计金额
+ TotalTax uint32 合计税额
+ AmountInWords string 价税合计(大写)
+ AmountInFiguers uint32 价税合计(小写)
+ Payee string 收款人
+ Checker string 复核
+ NoteDrawer string 开票人
+ Remarks string 备注

返回示例

{	
  "log_id": "5425496231209218858",
	"words_result_num": 29,
	"words_result": {
		"InvoiceNum": "14641426",
		"SellerName": "上海易火广告传媒有限公司",
		"CommodityTaxRate": [
			{
				"word": "6%",
				"row": "1"
			}
		],
		"SellerBank": "中国银行南翔支行446863841354",
		"Checker": ":沈园园",
		"TotalAmount": "94339.62",
		"CommodityAmount": [
			{
				"word": "94339.62",
				"row": "1"
			}
		],
		"InvoiceDate": "2016年06月02日",
		"CommodityTax": [
			{
				"word": "5660.38",
				"row": "1"
			}
		],
		"PurchaserName": "百度时代网络技术(北京)有限公司",
		"CommodityNum": [
			{
				"word": "",
				"row": "1"
			}
		],
        "Province": "上海",
        "City": "",
        "SheetNum": "第三联",
        "Agent": "否",
		"PurchaserBank": "招商银行北京分行大屯路支行8661820285100030",
		"Remarks": "告传",
		"Password": "074/45781873408>/6>8>65*887676033/51+<5415>9/32--852>1+29<65>641-5>66<500>87/*-34<943359034>716905113*4242>",
		"SellerAddress": ":嘉定区胜辛南路500号15幢1161室55033753",
		"PurchaserAddress": "北京市海淀区东北旺西路8号中关村软件园17号楼二属A2010-59108001",
		"InvoiceCode": "3100153130",
		"CommodityUnit": [
			{
				"word": "",
				"row": "1"
			}
		],
		"Payee": ":徐蓉",
		"PurchaserRegisterNum": "110108787751579",
		"CommodityPrice": [
			{
				"word": "",
				"row": "1"
			}
		],
		"NoteDrawer": "沈园园",
		"AmountInWords": "壹拾万圆整",
		"AmountInFiguers": "100000.00",
		"TotalTax": "5660.38",
		"InvoiceType": "专用发票",
		"SellerRegisterNum": "913101140659591751",
		"CommodityName": [
			{
				"word": "信息服务费",
				"row": "1"
			}
		],
		"CommodityType": [
			{
				"word": "",
				"row": "1"
			}
		]
	}
}

出租车票识别

支持识别全国各大城市出租车票的 16 个关键字段,包括发票号码、代码、车号、日期、总金额、燃油附加费、叫车服务费、省、市、单价、里程、上车时间、下车时间等。

	""" 读取文件 """
   def get_file_content(filePath):
      with open(filePath, "rb") as fp:
         return fp.read()
   
   image = get_file_content('文件路径')
   url = "https//www.x.com/sample.jpg" 
   pdf_file = get_file_content('文件路径') 
   
   # 调用出租车票识别
   res_image = client.taxiReceipt(image)
   res_url = client.taxiReceiptUrl(url)
   res_pdf = client.taxiReceiptPdf(pdf_file)
   print(res_image)
   print(res_url)
   print(res_pdf)   
   
   # 如果有可选参数
   options={}
   options['pdf_file_num'] = '1'
   res_image = client.taxiReceipt(image, options)
   res_url = client.taxiReceiptUrl(url, options)
   res_pdf = client.taxiReceiptPdf(pdf_file, options)   
   print(res_image)
   print(res_url)
   print(res_pdf)

请求参数详情

参数 是否必须 类型 可选值范围 说明
image 和 url/pdf_file 三选一 string - 图像数据,base64编码后进行urlencode,要求base64编码和urlencode后大小不超过4M,最短边至少15px,最长边最大4096px,支持jpg/jpeg/png/bmp格式
优先级:image > url > pdf_file,当image字段存在时,url、pdf_file字段失效
url 和 image/pdf_file 三选一 string - 图片完整url,url长度不超过1024字节,url对应的图片base64编码后大小不超过4M,最短边至少15px,最长边最大4096px,支持jpg/jpeg/png/bmp格式
优先级:image > url > pdf_file,当image字段存在时,url字段失效
请注意关闭URL防盗链
pdf_file 和 image/url 三选一 string - PDF文件,base64编码后进行urlencode,要求base64编码和urlencode后大小不超过4M,最短边至少15px,最长边最大4096px
优先级:image > url > pdf_file,当image、url字段存在时,pdf_file字段失效
pdf_file_num string - 需要识别的PDF文件的对应页码,当 pdf_file 参数有效时,识别传入页码的对应页面内容,若不传入,则默认识别第 1 页
返回参数
参数 是否必须 类型 说明
log_id uint64 请求标识码,随机数,唯一。
words_result_num uint32 识别结果数,表示words_result的元素个数
words_result object{} 识别结果数组
+ InvoiceCode string 发票代号
+ InvoiceNum string 发票号码
+ TaxiNum string 车牌号
+ Date string 日期
+ Time string 上下车时间
+ PickupTime string 上车时间
+ DropoffTime string 下车时间
+ Fare string 金额
+ FuelOilSurcharge string 燃油附加费
+ CallServiceSurcharge string 叫车服务费
+ TotalFare string 总金额
+ Location string 开票城市
+ Province string
+ City string
+ PricePerkm string 单价
+ Distance string 里程
pdf_file_size string 传入PDF文件的总页数,当 pdf_file 参数有效时返回该字段

返回示例

{
	"log_id":2034039896,
	"words_result_num":6,
	"words_result":
	{
		"Date":"2017-11-26",
		"Fare":"¥153.30元",
		"InvoiceCode":"111001681009",
		"InvoiceNum":"90769610",
		"TaxiNum":"BV2062",
		"Time":"20:42-21:07",
		"FuelOilSurcharge": "¥0.00",
		"CallServiceSurcharge": "¥0.00",
        "Province": "浙江省",
        "City": "杭州市",
        "PricePerkm": "2.50元/KM",
        "Distance": "4.5KM"
	}
}

VIN码识别

支持对车辆挡风玻璃处的车架号码进行识别。

	""" 读取文件 """
   def get_file_content(filePath):
      with open(filePath, "rb") as fp:
         return fp.read()
   
   image = get_file_content('文件路径')
   url = "https://www.x.com/sample.jpg" 
   
   # 调用VIN码识别
   res_image = client.vinCode(image)
   res_url = client.vinCodeUrl(url)
   print(res_image)
   print(res_url)
   
   # 如果有可选参数
   options={}
   res_image = client.vinCode(image, options)
   res_url = client.vinCodeUrl(url, options)
   print(res_image)
   print(res_url)

请求参数详情

参数 是否必选 类型 可选值范围 说明
image 和url二选一 string - 图像数据,base64编码后进行urlencode,要求base64编码和urlencode后大小不超过4M,最短边至少15px,最长边最大4096px,支持jpg/jpeg/png/bmp格式
url 和image二选一 string - 图片完整URL,URL长度不超过1024字节,URL对应的图片base64编码后大小不超过4M,最短边至少15px,最长边最大4096px,支持jpg/jpeg/png/bmp格式,当image字段存在时url字段失效
请注意关闭URL防盗链

返回参数

字段 是否必选 类型 说明
log_id uint64 唯一的log id,用于问题定位
words_result_num int 识别结果数,表示words_result的元素个数
words_result array[] 定位和识别结果数组
+ location object 位置数组(坐标0点为左上角)
++ left uint32 表示定位位置的长方形左上顶点的水平坐标
++ top uint32 表示定位位置的长方形左上顶点的垂直坐标
++ width uint32 表示定位位置的长方形的宽度
++ height uint32 表示定位位置的长方形的高度
+ words string VIN码识别结果

返回示例

{
	"log_id": 246589877,
	"words_result": [
		{
			"location": {
				"left": 124,
				"top": 11,
				"width": 58,
				"height": 359
			},
			"words": "LFV2A11K8D4010942"
		}
	],
	"words_result_num": 1
}

火车票识别

支持对红、蓝火车票的13个关键字段进行结构化识别,包括车票号码、始发站、目的站、车次、日期、票价、席别、姓名、座位号、身份证号、售站、序列号、时间。

	""" 读取文件 """
   def get_file_content(filePath):
      with open(filePath, "rb") as fp:
         return fp.read()
   
   image = get_file_content('文件路径')
   url = "https//www.x.com/sample.jpg" 
   pdf_file = get_file_content('文件路径')   
   
   # 调用火车票识别
   res_image = client.trainTicket(image)
   res_url = client.trainTicketUrl(url)
   res_pdf = client.trainTicketPdf(pdf_file)   
   print(res_image)
   print(res_url)
   print(res_pdf)   
   
   # 如果有可选参数
   options={}
   res_image = client.trainTicket(image, options)
   res_url = client.trainTicketUrl(url, options)
   res_pdf = client.trainTicketPdf(pdf_file, options)   
   print(res_image)
   print(res_url)
   print(res_pdf)   
   

请求参数详情

参数 是否必须 类型 可选值范围 说明
image 和 url/pdf_file 三选一 string - 图像数据,base64编码后进行urlencode,要求base64编码和urlencode后大小不超过4M,最短边至少15px,最长边最大4096px,支持jpg/jpeg/png/bmp格式
优先级:image > url > pdf_file,当image字段存在时,url、pdf_file字段失效
url 和 image/pdf_file 三选一 string - 图片完整url,url长度不超过1024字节,url对应的图片base64编码后大小不超过4M,最短边至少15px,最长边最大4096px,支持jpg/jpeg/png/bmp格式
优先级:image > url > pdf_file,当image字段存在时,url字段失效
请注意关闭URL防盗链
pdf_file 和 image/url 三选一 string - PDF文件,base64编码后进行urlencode,要求base64编码和urlencode后大小不超过4M,最短边至少15px,最长边最大4096px
优先级:image > url > pdf_file,当image、url字段存在时,pdf_file字段失效
pdf_file_num string - 需要识别的PDF文件的对应页码,当 pdf_file 参数有效时,识别传入页码的对应页面内容,若不传入,则默认识别第 1 页
返回参数
参数 是否必须 类型 说明
log_id uint64 请求标识码,唯一,用于调用失败后进行问题定位
direction int32 图像方向
- 0:正向,
- 1:逆时针90度,
- 2:逆时针180度,
- 3:逆时针270度
words_result object{} 识别结果
words_result_num uint32 识别结果数,表示words_result的元素个数
+ ticket_num string 车票号
+ starting_station string 始发站
+ train_num string 车次号
+ destination_station string 到达站
+ date string 出发日期
+ ticket_rates string 车票金额
+ seat_category string 席别
+ name string 乘客姓名
+ id_num string 身份证号
+ serial_number string 序列号
+ sales_station string 售站
+ time string 时间
+ seat_num string 座位号
pdf_file_size string 传入PDF文件的总页数,当 pdf_file 参数有效时返回该字段
返回示例
{
	"log_id": "12317512659",
	"direction": 1,
	"words_result_num": 13,
	"words_result": {
		"id_num": "2302051998****156X",
		"name": "裴一丽",
		"ticket_rates": "¥54.5元",
		"destination_station": "天津站",
		"seat_category": "二等座",
		"sales_station": "北京南",
		"ticket_num": "F05706",
		"seat_num": "02车03C号",
		"time": "09:36",
		"date": "2019年04月03日",
		"serial_number": "10010300067846",
		"train_num": "C255",
		"starting_station": "北京南站"
	}
}

数字识别

对图片中的数字进行提取和识别,自动过滤非数字内容,仅返回数字内容及其位置信息,识别准确率超过99%。

	""" 读取文件 """
   def get_file_content(filePath):
      with open(filePath, "rb") as fp:
         return fp.read()
   
   image = get_file_content('文件路径')
   url = "https://www.x.com/sample.jpg"   
   
   # 调用数字识别
   res_image = client.numbers(image)
   res_url = client.numbersUrl(url)   
   print(res_image)
   print(res_url)   
   
   # 如果有可选参数
   options={}
   options['recognize_granularity']='small'
   res_image = client.numbers(image, options)
   res_url = client.numbersUrl(url, options)   
   print(res_image)
   print(res_url)   

请求参数详情

参数 是否必选 类型 可选值范围 说明
image 和url二选一 string - 图像数据,base64编码后进行urlencode,需去掉编码头(data:image/jpeg;base64, )
要求base64编码和urlencode后大小不超过4M,最短边至少15px,最长边最大4096px,支持jpg/jpeg/png/bmp格式
url 和image二选一 string - 图片完整URL,URL长度不超过1024字节,URL对应的图片base64编码后大小不超过4M,最短边至少15px,最长边最大4096px,支持jpg/jpeg/png/bmp格式,当image字段存在时url字段失效
请注意关闭URL防盗链
recognize_granularity string big/small 是否定位单字符位置,big:不定位单字符位置,默认值;small:定位单字符位置
detect_direction string true/false 是否检测图像朝向,默认不检测,即:false。朝向是指输入图像是正常方向、逆时针旋转90/180/270度。 可选值包括
- true:检测朝向;
- false:不检测朝向

返回说明

返回参数

字段 是否必选 类型 说明
log_id uint64 唯一的log id,用于问题定位
words_result_num uint32 识别结果数,表示words_result的元素个数
words_result array[] 定位和识别结果数组
+ location object 位置数组(坐标0点为左上角)
++ left uint32 表示定位位置的长方形左上顶点的水平坐标
++ top uint32 表示定位位置的长方形左上顶点的垂直坐标
++ width uint32 表示定位位置的长方形的宽度
++ height uint32 表示定位位置的长方形的高度
+ words string 识别结果字符串
+ chars array[] 单字符结果,当 recognize_granularity=small 时返回该字段
++ char string 单字符识别结果
++ location object 位置数组(坐标0点为左上角)
+++ left uint32 表示定位位置的长方形左上顶点的水平坐标
+++ top uint32 表示定位位置的长方形左上顶点的垂直坐标
+++ width uint32 表示定位定位位置的长方形的宽度
+++ height uint32 表示位置的长方形的高度

返回示例

{
    "log_id": 620759800,
    "words_result": [
        {
            "location": {
                "left": 56,
                "top": 0,
                "width": 21,
                "height": 210
            },
            "words": "3"
        }
    ],
    "words_result_num": 1
}

飞机行程单识别

支持对飞机行程单的24个字段进行结构化识别,包括电子客票号、印刷序号、姓名、始发站、目的站、航班号、日期、时间、票价、身份证号、承运人、民航发展基金、保险费、燃油附加费、其他税费、合计金额、填开日期、订票渠道、客票级别、座位等级、销售单位号、签注、免费行李、验证码。 同时,支持单张行程单上的多航班信息识别。

	""" 读取文件 """
   def get_file_content(filePath):
      with open(filePath, "rb") as fp:
         return fp.read()
   
   image = get_file_content('文件路径')
   url = "https//www.x.com/sample.jpg" 
   pdf_file = get_file_content('文件路径')   
   
   # 调用飞机行程单识别
   res_image = client.airTicket(image)
   res_url = client.airTicketUrl(url)
   res_pdf = client.airTicketPdf(pdf_file)   
   print(res_image)
   print(res_url)
   print(res_pdf)   
   
   # 如果有可选参数
   options={}
   options["multi_detect"] = "false"
   res_image = client.airTicket(image, options)
   res_url = client.airTicketUrl(url, options)
   res_pdf = client.airTicketPdf(pdf_file, options)   
   print(res_image)
   print(res_url)
   print(res_pdf)   

请求参数详情

参数 是否必选 类型 可选值范围 说明
image 和 url/pdf_file 三选一 string - 图像数据,base64编码后进行urlencode,要求base64编码和urlencode后大小不超过4M,最短边至少15px,最长边最大4096px,支持jpg/jpeg/png/bmp格式
优先级:image > url > pdf_file,当image字段存在时,url、pdf_file字段失效
url 和 image/pdf_file 三选一 string - 图片完整url,url长度不超过1024字节,url对应的图片base64编码后大小不超过4M,最短边至少15px,最长边最大4096px,支持jpg/jpeg/png/bmp格式
优先级:image > url > pdf_file,当image字段存在时,url字段失效
请注意关闭URL防盗链
pdf_file 和 image/url 三选一 string - PDF文件,base64编码后进行urlencode,要求base64编码和urlencode后大小不超过4M,最短边至少15px,最长边最大4096px
优先级:image > url > pdf_file,当image、url字段存在时,pdf_file字段失效
pdf_file_num string - 需要识别的PDF文件的对应页码,当 pdf_file 参数有效时,识别传入页码的对应页面内容,若不传入,则默认识别第 1 页
multi_detect string true/false 控制是否开启多航班信息识别功能,默认值:false
- true:开启多航班信息识别功能,开启后返回结果中对应字段格式将改为数组类型
- false: 不开启,仅识别单一航班信息

返回参数详情

字段 是否必选 类型 说明
log_id uint64 唯一的log id,用于问题定位
words_result_num uint32 识别结果数,表示words_result的元素个数
words_result object{} 识别结果
+ name string 姓名
+ starting_station string 始发站
+ destination_station string 目的站
+ flight string 航班号
+ date string 日期
+ ticket_number string 电子客票号码
+ fare string 票价
+ dev_fund string 民航发展基金/基建费
+ fuel_surcharge string 燃油附加费
+ other_tax string 其他税费
+ ticket_rates string 合计金额
+ issued_date string 填开日期
+ id_num string 身份证号
+ carrier string 承运人
+ time string 时间
+ issued_by string 订票渠道
+ serial_number string 印刷序号
+ insurance string 保险费
+ fare_basis string 客票级别
+ class string 座位等级
+ agent_code string 销售单位号
+ endorsement string 签注
+ allow string 免费行李
+ ck string 验证码
pdf_file_size string 传入PDF文件的总页数,当 pdf_file 参数有效时返回该字段

返回示例

// 识别单航班信息(multi_detect=false,或参数缺省)
{
    "log_id": 7306800033425229106,
    "direction": 0,
    "words_result_num": 18,
    "words_result": {
        "insurance": "20.00",
        "date": "2019-10-22",
        "allow": "20K",
        "flight": "CA6589",
        "issued_by": "中国国际航空服务有限公司",
        "starting_station": "武汉",
        "fare": "260.00",
        "endorsement": "不得签转改期退转",
        "ticket_rates": "350.00",
        "ck": "5866",
        "serial_number": "51523588676",
        "ticket_number": "7843708871196",
        "fuel_surcharge": "EXEMPT",
        "carrier": "南航",
        "issued_date": "2019-10-30",
        "other_tax": "",
        "fare_basis": "NREOW",
        "id_num": "411201123909020877",
        "destination_station": "合肥",
        "name": "郭达",
        "agent_code": "BJS19197300025",
        "time": "21:25",
        "class": "N",
        "dev_fund": "50.00"
    }
}

// 识别多航班信息(multi_detect=true)
{
    "words_result": {
        "log_id": "1280814270572920832",
        "words_result_num": 18
        "insurance": [
            {
                "word": "XXX"
            }
        ],
        "date": [
            {
                "word": "2019-10-18"
            },
            {
                "word": "2019-10-21"
            }
        ],
        "flight": [
            {
                "word": "CZ3565"
            },
            {
                "word": "CZ3566"
            }
        ],
        "issued_by": [
            {
                "word": "上海携程旅行社有限公司"
            }
        ],
        "starting_station": [
            {
                "word": "北京"
            }
        ],
        "fare": [
            {
                "word": "1080.00"
            }
        ],
        "ticket_rates": [
            {
                "word": "1420.00"
            }
        ],
        "serial_number": [
            {
                "word": "45956029770"
            }
        ],
        "ticket_number": [
            {
                "word": "7849648364314"
            }
        ],
        "fuel_surcharge": [
            {
                "word": "240.00"
            }
        ],
        "carrier": [
            {
                "word": "南航"
            },
            {
                "word": "南航"
            }
        ],
        "issued_date": [
            {
                "word": "2019-09-18"
            }
        ],
        "other_tax": [],
        "id_num": [
            {
                "word": "0789654700"
            }
        ],
        "destination_station": [
            {
                "word": "深圳"
            },
            {
                "word": "北京"
            }
        ],
        "name": [
            {
                "word": "姚佳"
            }
        ],
        "time": [
            {
                "word": "13:55"
            },
            {
                "word": "16:30"
            }
        ],
        "dev_fund": [
            {
                "word": "100.00"
            }
        ]
    },
}

二维码识别

对图片中的二维码、条形码进行检测和识别,返回存储的文字信息。

	""" 读取文件 """
   def get_file_content(filePath):
      with open(filePath, "rb") as fp:
         return fp.read()
   
   image = get_file_content('文件路径')
   url = "https://www.x.com/sample.jpg" 
   
   # 调用二维码识别
   res_image = client.qrcode(image)
   res_url = client.qrcodeUrl(url)
   print(res_image)
   print(res_url)
   

请求参数详情

参数 是否必选 类型 可选值范围 说明
image 和url二选一 string - 图像数据,base64编码后进行urlencode,需去掉编码头(data:image/jpeg;base64, )
要求base64编码和urlencode后大小不超过4M,最短边至少15px,最长边最大4096px,支持jpg/jpeg/png/bmp格式
url 和image二选一 string - 图片完整URL,URL长度不超过1024字节,URL对应的图片base64编码后大小不超过4M,最短边至少15px,最长边最大4096px,支持jpg/jpeg/png/bmp格式,当image字段存在时url字段失效
请注意关闭URL防盗链

返回参数详情

字段 是否必选 类型 说明
log_id uint64 唯一的log id,用于问题定位
codes_result_num uint32 识别结果数,表示codes_result的元素个数
codes_result array[] 定位和识别结果数组
+ type string 识别码类型条码类型包括:9种条形码(UPC_A、UPC_E、EAN_13、EAN_8、CODE_39、CODE_93、CODE_128、ITF、CODABAR),4种二维码(QR_CODE、DATA_MATRIX、AZTEC、PDF_417)
+ text string 条形码识别内容,暂时只限于识别中英文结果

返回示例

{
    "log_id": 863402790,
    "codes_result": [
        {
            "type": "QR_CODE",
            "text": [
                "中国",
                "北京"
            ]
        }
    ],
    "codes_result_num": 1
}
示例2(多个图的情况):
{
    "log_id": 1508509437,
    "codes_result": [
        {
            "type": "QR_CODE",
            "text": [
                "HTTP://Q8R.HK/YELZ0"
            ]
        },
        {
            "type": "PDF_417",
            "text": [
                "PDF417偼丄TL-30偱撉傒庢傝壜擻偱偡丅"
            ]
        },
        {
            "type": "CODABAR",
            "text": [
                "000800"
            ]
        },
        {
            "type": "CODE_39",
            "text": [
                "1234567890"
            ]
        },
        {
            "type": "AZTEC",
            "text": [
                "www.tec-it.com"
            ]
        },
        {
            "type": "DATA_MATRIX",
            "text": [
                "Wikipedia, the free encyclopedia"
            ]
        },
        {
            "type": "CODE_93",
            "text": [
                "123456789"
            ]
        },
        {
            "type": "CODE_128",
            "text": [
                "50090500019191"
            ]
        },
        {
            "type": "EAN_8",
            "text": [
                "12345670"
            ]
        },
        {
            "type": "EAN_13",
            "text": [
                "6901234567892"
            ]
        },
        {
            "type": "UPC_E",
            "text": [
                "01234565"
            ]
        }
    ],
    "codes_result_num": 11
}

手写文字识别

支持对图片中的手写中文、手写数字进行检测和识别,针对不规则的手写字体进行专项优化,识别准确率可达90%以上。

	""" 读取文件 """
   def get_file_content(filePath):
      with open(filePath, "rb") as fp:
         return fp.read()
   
   image = get_file_content('文件路径')
   url = "https://www.x.com/sample.jpg" 
   pdf_file = get_file_content('文件路径') 
   
   # 调用手写文字识别
   res_image = client.handwriting(image)
   res_url = client.handwritingUrl(url)
   res_pdf = client.handwritingPdf(pdf_file)   
   print(res_image)
   print(res_url)
   print(res_pdf)   
   
   # 如果有可选参数
   options={}
   options["recognize_granularity"] = "true"
   options["detect_direction"] = "true"
   options["probability"] = "true"
   res_image = client.handwriting(image, options)
   res_url = client.handwritingUrl(url, options)
   res_pdf = client.handwritingPdf(pdf_file, options)   
   print(res_image)
   print(res_url)
   print(res_pdf)   

请求参数详情

参数 是否必选 类型 可选值范围 说明
image 和 url/pdf_file 三选一 string - 图像数据,base64编码后进行urlencode,要求base64编码和urlencode后大小不超过4M,最短边至少15px,最长边最大4096px,支持jpg/jpeg/png/bmp格式
优先级:image > url > pdf_file,当image字段存在时,url、pdf_file字段失效
url 和 image/pdf_file 三选一 string - 图片完整url,url长度不超过1024字节,url对应的图片base64编码后大小不超过4M,最短边至少15px,最长边最大4096px,支持jpg/jpeg/png/bmp格式
优先级:image > url > pdf_file,当image字段存在时,url字段失效
请注意关闭URL防盗链
pdf_file 和 image/url 三选一 string - PDF文件,base64编码后进行urlencode,要求base64编码和urlencode后大小不超过4M,最短边至少15px,最长边最大4096px
优先级:image > url > pdf_file,当image、url字段存在时,pdf_file字段失效
pdf_file_num string - 需要识别的PDF文件的对应页码,当 pdf_file 参数有效时,识别传入页码的对应页面内容,若不传入,则默认识别第 1 页
recognize_granularity string big/small 是否定位单字符位置,big:不定位单字符位置,默认值;small:定位单字符位置
probability string true/false 是否返回识别结果中每一行的置信度,默认为false,不返回置信度
detect_direction string true/false 是否检测图像朝向,默认不检测,即:false。朝向是指输入图像是正常方向、逆时针旋转90/180/270度。可选值包括:
true:检测朝向;
false:不检测朝向

返回参数详情

字段 是否必选 类型 说明
log_id uint64 唯一的log id,用于问题定位
words_result_num uint32 识别结果数,表示words_result的元素个数
words_result array[] 定位和识别结果数组
+ location object 位置数组(坐标0点为左上角)
++ left uint32 表示定位位置的长方形左上顶点的水平坐标
++ top uint32 表示定位位置的长方形左上顶点的垂直坐标
++ width uint32 表示定位位置的长方形的宽度
++ height uint32 表示定位位置的长方形的高度
+ words string 识别结果字符串
+ chars array[] 单字符结果,当 recognize_granularity=small 时存返回该字段
++ char string 单字符识别结果
++ candidates array[] 单字符识别结果的候选词内容
+++ word string 单字符识别结果的候选词文字
+++ prob string 单字符识别结果的候选词置信度
++ location object 位置数组(坐标0点为左上角)
+++ left uint32 表示定位位置的长方形左上顶点的水平坐标
+++ top uint32 表示定位位置的长方形左上顶点的垂直坐标
+++ width uint32 表示定位定位位置的长方形的宽度
+++ height uint32 表示位置的长方形的高度
probability object 当 probability=true 时返回该字段,表示识别结果中每一行的置信度值,包含:
- average: 行置信度平均值
- variance:行置信度方差
- min:行置信度最小值
direction int32 图像方向,当 detect_direction=true 时返回该字段。
- - 1:未定义,
- 0:正向,
- 1:逆时针90度,
- 2:逆时针180度,
- 3:逆时针270度
pdf_file_size string 传入PDF文件的总页数,当 pdf_file 参数有效时返回该字段

返回示例

{
    "log_id": 620759800,
    "words_result": [
        {
            "location": {
                "left": 56,
                "top": 0,
                "width": 21,
                "height": 210
            },
            "words": "3"
        }
    ],
    "words_result_num": 1
}

护照识别

支持对中国大陆护照个人资料页所有15个字段进行结构化识别,包括国家码、护照号、姓名、姓名拼音、性别、出生地点、出生日期、签发地点(不支持境外签发地)、签发日期、有效期、签发机关、护照类型、国籍、MRZCode1、MRZCode2。

	""" 读取文件 """
   def get_file_content(filePath):
      with open(filePath, "rb") as fp:
         return fp.read()
   
   image = get_file_content('文件路径')
   url = "https://www.x.com/sample.jpg" 
   
   # 调用护照识别
   res_image = client.passport(image)
   res_url = client.passportUrl(url)
   print(res_image)
   print(res_url)

请求参数详情

参数 是否必选 类型 可选值范围 说明
image 和url二选一 string - 图像数据,base64编码后进行urlencode,需去掉编码头(data:image/jpeg;base64, )
要求base64编码和urlencode后大小不超过4M,最短边至少15px,最长边最大4096px,支持jpg/jpeg/png/bmp格式
url 和image二选一 string - 图片完整URL,URL长度不超过1024字节,URL对应的图片base64编码后大小不超过4M,最短边至少15px,最长边最大4096px,支持jpg/jpeg/png/bmp格式,当image字段存在时url字段失效
请注意关闭URL防盗链

返回参数详情

字段 是否必选 类型 说明
log_id uint64 唯一的log id,用于问题定位
words_result_num uint32 识别结果数,表示words_result的元素个数
words_result object 识别结果
+ location uint32 水平坐标
++ top uint32 表示定位位置的长方形左上顶点的垂直坐标
++ left uint32 表示定位位置的长方形左上顶点的水平坐标
++ height uint32 表示定位位置的长方形的高度
++ width uint32 表示定位位置的长方形的宽度
+ words string 识别内容

返回示例

{
    "log_id": 7377468409496932872,
    "words_result_num": 14,
    "words_result": {
        "国家码": {
            "location": {
                "width": 59,
                "top": 200,
                "left": 762,
                "height": 26
            },
            "words": "CHN"
        },
        "护照签发地点": {
            "location": {
                "width": 236,
                "top": 505,
                "left": 558,
                "height": 43
            },
            "words": "山东/SHANDONG"
        },
        "MRZCode2": {
            "location": {
                "width": 1252,
                "top": 797,
                "left": 145,
                "height": 88
            },
            "words": "E898657303CHNSDMO7O2<<<<<<<<<<<<<"
        },
        "有效期至": {
            "location": {
                "width": 287,
                "top": 528,
                "left": 955,
                "height": 46
            },
            "words": "20261004"
        },
        "签发机关": {
            "location": {
                "width": 271,
                "top": 583,
                "left": 552,
                "height": 42
            },
            "words": "出入境管理局"
        },
        "MRZCode1": {
            "location": {
                "width": 1201,
                "top": 781,
                "left": 162,
                "height": 45
            },
            "words": "PONSUN<<JIAJIA<<<<<<<<<<<<<<<<<<<<<<<<<<"
        },
        "护照号码": {
            "location": {
                "width": 237,
                "top": 215,
                "left": 994,
                "height": 48
            },
            "words": "E89865730"
        },
        "签发日期": {
            "location": {
                "width": 279,
                "top": 453,
                "left": 955,
                "height": 46
            },
            "words": "20161005"
        },
        "出生地点": {
            "location": {
                "width": 216,
                "top": 429,
                "left": 564,
                "height": 43
            },
            "words": "山东/SHANDONG"
        },
        "姓名": {
            "location": {
                "width": 159,
                "top": 247,
                "left": 581,
                "height": 34
            },
            "words": "孙嘉佳"
        },
        "姓名拼音": {
            "location": {
                "width": 229,
                "top": 279,
                "left": 578,
                "height": 41
            },
            "words": "SUN,JIAJIA"
        },
        "国籍": {
            "location": {
                "width": 209,
                "top": 366,
                "left": 695,
                "height": 42
            },
            "words": "中国/CHINESE"
        },
        "生日": {
            "location": {
                "width": 202,
                "top": 382,
                "left": 950,
                "height": 39
            },
            "words": "19950723"
        },
        "性别": {
            "location": {
                "width": 73,
                "top": 357,
                "left": 570,
                "height": 34
            },
            "words": "男/M"
        }
    }
}

通用机打发票识别

支持对国家/地方税务局发行的横/竖版通用机打发票的23个关键字段进行结构化识别,包括发票类型、发票号码、发票代码、开票日期、合计金额大写、合计金额小写、商品名称、商品单位、商品单价、商品数量、商品金额、机打代码、机打号码、校验码、销售方名称、销售方纳税人识别号、购买方名称、购买方纳税人识别号、合计税额等。

	""" 读取文件 """
   def get_file_content(filePath):
      with open(filePath, "rb") as fp:
         return fp.read()
   
   image = get_file_content('文件路径')
   url = "https://www.x.com/sample.jpg" 
   pdf_file = get_file_content('文件路径')
   
   # 调用通用机打发票识别
   res_image = client.invoice(image)
   res_url = client.invoiceUrl(url)
   res_pdf = client.invoicePdf(pdf_file)   
   print(res_image)
   print(res_url)
   print(res_pdf)   
   
   # 如果有可选参数
   options={}
   options["location"] = "true"
   res_image = client.invoice(image, options)
   res_url = client.invoiceUrl(url, options)
   res_pdf = client.invoicePdf(pdf_file, options)   
   print(res_image)
   print(res_url)
   print(res_pdf)   

请求参数详情

参数 是否必选 类型 可选值范围 说明
image 和 url/pdf_file 三选一 string - 图像数据,base64编码后进行urlencode,要求base64编码和urlencode后大小不超过4M,最短边至少15px,最长边最大4096px,支持jpg/jpeg/png/bmp格式
优先级:image > url > pdf_file,当image字段存在时,url、pdf_file字段失效
url 和 image/pdf_file 三选一 string - 图片完整url,url长度不超过1024字节,url对应的图片base64编码后大小不超过4M,最短边至少15px,最长边最大4096px,支持jpg/jpeg/png/bmp格式
优先级:image > url > pdf_file,当image字段存在时,url字段失效
请注意关闭URL防盗链
pdf_file 和 image/url 三选一 string - PDF文件,base64编码后进行urlencode,要求base64编码和urlencode后大小不超过4M,最短边至少15px,最长边最大4096px
优先级:image > url > pdf_file,当image、url字段存在时,pdf_file字段失效
pdf_file_num string - 需要识别的PDF文件的对应页码,当 pdf_file 参数有效时,识别传入页码的对应页面内容,若不传入,则默认识别第 1 页

返回参数详情

字段 是否必选 类型 说明
log_id uint64 唯一的log id,用于问题定位
direction int32 图像方向。
- - 1:未定义,
- 0:正向,
- 1:逆时针90度,
- 2:逆时针180度,
- 3:逆时针270度
words_result_num uint32 识别结果数,表示words_result的元素个数
words_result object{} 识别结果
+ InvoiceType string 发票类型
+ InvoiceCode string 发票代码
+ InvoiceNum string 发票号码
+ InvoiceDate string 开票日期
+ AmountInFiguers string 合计金额小写
+ AmountInWords string 合计金额大写
+ CommodityName array[] 商品名称
++ row unit32 行号
++ word string 内容
+ CommodityUnit array[] 商品单位
++ row unit32 行号
++ word string 内容
+ CommodityPrice array[] 商品单价
++ row unit32 行号
++ word string 内容
+ CommodityNum array[] 商品数量
++ row unit32 行号
++ word string 内容
+ CommodityAmount array[] 商品金额
++ row unit32 行号
++ word string 内容
+ IndustrySort string 行业分类
+ MachineNum string 机打号码
+ CheckCode string 校验码
+ SellerName string 销售方名称
+ SellerRegisterNum string 销售方纳税人识别号
+ PurchaserName string 购买方名称
+ PurchaserRegisterNum string 购买方纳税人识别号
+ TotalTax string 合计税额
+ Province string
+ City string
+ Time string 时间
+ SheetNum string 联次
pdf_file_size string 传入PDF文件的总页数,当 pdf_file 参数有效时返回该字段

返回示例

{
    "log_id": 4423022131715883558,
    "direction": 0,
    "words_result_num": 22,
    "words_result": {
        "City": "",
        "InvoiceNum": "01445096",
        "SellerName": "百度餐饮店",
        "IndustrSort": "生活服务",
        "Province": "广东省",
        "CommodityAmount": [
            {
                "word": "183.00",
                "row": "1"
            }
        ],
        "InvoiceDate": "2020年07月28日",
        "PurchaserName": "中信建投证券股份有限公司",
        "CommodityNum": [],
        "InvoiceCode": "144001901511",
        "CommodityUnit": [],
        "SheetNum": "",
        "PurchaserRegisterNum": "9144223008453480X9",
        "Time": "",
        "CommodityPrice": [],
        "AmountInFiguers": "183.00",
        "AmountInWords": "壹佰捌拾叁元整",
        "CheckCode": "61042119820421061301",
        "TotalTax": "183.00",
        "InvoiceType": "广东通用机打发票",
        "SellerRegisterNum": "61042119820421061301",
        "CommodityName": [
            {
                "word": "餐费",
                "row": "1"
            }
        ]
    }
}

户口本识别

支持对户口本内常住人口登记卡的全部 22 个字段进行结构化识别,包括户号、姓名、与户主关系、性别、出生地、民族、出生日期、身份证号、本市县其他住址、曾用名、籍贯、宗教信仰、身高、血型、文化程度、婚姻状况、兵役状况、服务处所、职业、何时由何地迁往本市、何时由何地迁往本址、登记日期。

   """ 读取文件 """
   def get_file_content(filePath):
      with open(filePath, "rb") as fp:
         return fp.read()
   
   image = get_file_content('文件路径')
   url = "https://www.x.com/sample.jpg" 
   
   # 调用户口本识别
   res_image = client.householdRegister(image)
   res_url = client.householdRegisterUrl(url)
   print(res_image)
   print(res_url)

请求参数详情

参数 是否必选 类型 可选值范围 说明
image 和image二选一 string - 图像数据,base64编码后进行urlencode,要求base64编码和urlencode后大小不超过4M,最短边至少15px,最长边最大4096px,支持jpg/jpeg/png/bmp格式
url 和image二选一 string - 图片完整URL,URL长度不超过1024字节,URL对应的图片base64编码后大小不超过4M,最短边至少15px,最长边最大4096px,支持jpg/jpeg/png/bmp格式,当image字段存在时url字段失效
请注意关闭URL防盗链

返回参数详情

字段 是否必选 类型 说明
log_id uint64 唯一的log id,用于问题定位
words_result_num int 识别结果数,表示words_result的元素个数
words_result object{} 识别结果
Name object{} 姓名
+ words string 所属字段的具体内容,以下各字段均含有此元素
Relationship object{} 户主或与户主关系
Sex object{} 性别
BirthAddress object{} 出生地
Nation object{} 民族
Birthday object{} 生日
CardNo object{} 身份证号
HouseholdNum object{} 户号
FormerName object{} 曾用名
Hometown object{} 籍贯
OtherAddress object{} 本市(县)其他住址
Belief object{} 宗教信仰
Height object{} 身高
BloodType object{} 血型
Education object{} 文化程度
MaritalStatus object{} 婚姻状况
VeteranStatus object{} 兵役状况
WorkAddress object{} 服务处所
Career object{} 职业
WWToCity object{} 何时由何地迁来本市(县)
WWHere object{} 何时由何地迁往本址
Date object{} 登记日期

返回示例

 {
    "log_id": 1301870459,
    "words_result": {
        "BirthAddress": {
            "words": "河南洛阳市郊区"
        },
        "Birthday": {
            "words": "2016-07-28"
        },
        "CardNo": {
            "words": "410311201607282825"
        },
        "Name": {
            "words": "孙翌晨"
        },
        "Nation": {
            "words": "汉族"
        },
        "Relationship": {
            "words": "户主"
        },
        "Sex": {
            "words": "男"
        },
    },
    "words_result_num": 7
}

机动车销售发票识别

支持对机动车销售发票的26个关键字段进行结构化识别,包括发票代码、发票号码、开票日期、机器编号、购买方名称、购买方身份证号码/组织机构代码、车辆类型、厂牌型号、产地、合格证号、发动机号码、车架号码、价税合计、价税合计小写、销货单位名称、电话、纳税人识别号、账号、地址、开户银行、税率、税额、主管税务机关及代码、不含税价格、限乘人数。

   """ 读取文件 """
   def get_file_content(filePath):
      with open(filePath, "rb") as fp:
         return fp.read()
   
   image = get_file_content('文件路径')
   url = "https://www.x.com/sample.jpg" 
   
   # 调用机动车销售发票识别
   res_image = client.vehicleInvoice(image)
   res_url = client.vehicleInvoiceUrl(url)
   print(res_image)
   print(res_url)

请求参数详情

参数 是否必选 类型 可选值范围 说明
image 和url二选一 string - 图像数据,base64编码后进行urlencode,需去掉编码头(data:image/jpeg;base64, )
要求base64编码和urlencode后大小不超过4M,最短边至少15px,最长边最大4096px,支持jpg/jpeg/png/bmp格式
url 和image二选一 string - 图片完整URL,URL长度不超过1024字节,URL对应的图片base64编码后大小不超过4M,最短边至少15px,最长边最大4096px,支持jpg/jpeg/png/bmp格式,当image字段存在时url字段失效
请注意关闭URL防盗链

返回参数详情

字段 是否必选 类型 说明
log_id uint64 唯一的log id,用于问题定位
words_result_num uint32 识别结果数,表示words_result的元素个数
words_result array[] 识别结果数组
+ InvoiceCode string 发票代码/机打代码
+ InvoiceNum string 发票号码/机打号码
+ InvoiceDate string 开票日期
+ MachineCode string 机器编号
+ Purchaser string 购买方名称
+ PurchaserCode string 购买方身份证号码/组织机构代码
+ VehicleType string 车辆类型
+ ManuModel string 厂牌型号
+ Origin string 产地
+ CertificateNum string 合格证号
+ EngineNum string 发动机号码
+ VinNum string 车架号码
+ PriceTax string 价税合计
+ PriceTaxLow string 价税合计小写
+ Saler string 销货单位名称
+ SalerPhone string 销货单位电话
+ SalerCode string 销货单位纳税人识别号
+ SalerAccountNum string 销货单位账号
+ SalerAddress string 销货单位地址
+ SalerBank string 销货单位开户银行
+ TaxRate string 税率
+ Tax string 税额
+ TaxAuthor string 主管税务机关
+ TaxAuthorCode string 主管税务机关代码
+ Price string 不含税价格
+ LimitPassenger string 限乘人数

返回示例

{
    "log_id": 283449393728149457,
    "words_result_num": 26,
    "words_result": {
        "InvoiceNum": "00875336",
        "Saler": "深圳市新能源汽车销售有限公司",
        "LimitPassenger": "5",
        "MachineCode": "669745967911",
        "VinNum": "LJLGTCRP1J4007581",
        "TaxRate": "16%",
        "PriceTaxLow": "106100.00",
        "InvoiceDate": "2018-11-29",
        "Price": "¥91465.52",
        "SalerBank": "中国工商银行股份有限公司深圳岭园支行",
        "TaxAuthor": "国家锐务总局深圳市龙岗区税务局第五税务所",
        "ManuModel": "江淮牌HFC7007EYBD6",
        "CertificateNum": "WCH0794J0976801",
        "Purchaser": "苏子潇",
        "VehicleType": "纯电动轿车",
        "InvoiceCode": "14975047560",
        "PriceTax": "壹拾万陆仟壹佰圆整",
        "SalerPhone": "0755-83489306",
        "SalerAddress": "深圳市龙岗区龙岗街道百世国际汽车城",
        "Origin": "安徽省合肥市",
        "EngineNum": "18958407",
        "Tax": "14634.48",
        "PurchaserCode": "5135934475603742222",
        "TaxAuthorCode": "14037589413",
        "SalerAccountNum": "中国工商银行股份有限公司深圳岭园支行",
        "SalerCode": "9144928346458292278H"
    }
}

车辆合格证识别

支持对车辆合格证的23个关键字段进行结构化识别,包括合格证编号、发证日期、车辆制造企业名、车辆品牌、车辆名称、车辆型号、车架号、车身颜色、发动机型号、发动机号、燃料种类、排量、功率、排放标准、轮胎数、轴距、轴数、转向形式、总质量、整备质量、驾驶室准乘人数、最高设计车速、车辆制造日期。

   """ 读取文件 """
   def get_file_content(filePath):
      with open(filePath, "rb") as fp:
         return fp.read()
   
   image = get_file_content('文件路径')
   url = "https://www.x.com/sample.jpg" 
   
   # 调用车辆合格证
   res_image = client.vehicleCertificate(image)
   res_url = client.vehicleCertificateUrl(url)
   print(res_image)
   print(res_url)

请求参数详情

参数 是否必选 类型 可选值范围 说明
image 和url二选一 string - 图像数据,base64编码后进行urlencode,需去掉编码头(data:image/jpeg;base64, )
要求base64编码和urlencode后大小不超过4M,最短边至少15px,最长边最大4096px,支持jpg/jpeg/png/bmp格式
url 和image二选一 string - 图片完整URL,URL长度不超过1024字节,URL对应的图片base64编码后大小不超过4M,最短边至少15px,最长边最大4096px,支持jpg/jpeg/png/bmp格式,当image字段存在时url字段失效
请注意关闭URL防盗链

返回参数详情

字段 是否必选 类型 说明
log_id uint64 唯一的log id,用于问题定位
words_result_num uint32 识别结果数,表示words_result的元素个数
words_result array[] 识别结果数组
+ CertificationNo string 合格证编号
+ CertificateDate string 发证日期
+ Manufacturer string 车辆制造企业名
+ CarBrand string 车辆品牌
+ CarName string 车辆名称
+ CarModel string 车辆型号
+ VinNo string 车架号
+ CarColor string 车身颜色
+ EngineType string 发动机型号
+ EngineNo string 发动机号
+ FuelType string 燃料种类
+ Displacement string 排量
+ Power string 功率
+ EmissionStandard string 排放标准
+ TyreNum string 轮胎数
+ Wheelbase string 轴距
+ AxleNum string 轴数
+ SteeringType string 转向形式
+ TotalWeight string 总质量
+ SaddleMass string 整备质量
+ LimitPassenger string 驾驶室准乘人数
+ SpeedLimit string 最高设计车速
+ ManufactureDate string 车辆制造日期

返回示例

{
    "log_id": 14814098736243057,
    "words_result_num": 23,
    "words_result": {
        "ManufactureDate": "2016年10月13日",
        "CarColor": "红",
        "LimitPassenger": "2",
        "EngineType": "WP12.460E50",
        "TotalWeight": "25000",
        "Power": "338",
        "CertificationNo": "WEK29JX98645437",
        "FuelType": "汽油",
        "Manufacturer": "陕西汽车集团有限责任公司",
        "SteeringType": "方向盘",
        "Wheelbase": "3175+1350",
        "SpeedLimit": "105",
        "EngineNo": "1418K129178",
        "SaddleMass": "8600",
        "AxleNum": "3",
        "CarModel": "SX4250MC4",
        "VinNo": "LZGJHYD83JX197344",
        "CarBrand": "陕汽牌",
        "EmissionStandard": "GB17691-2005国V,GB3847-2005",
        "Displacement": "11596",
        "CertificateDate": "2018年11月28日",
        "CarName": "牵引汽车",
        "TyreNum": "10"
    }
}

网约车行程单识别

对各大主要服务商的网约车行程单进行结构化识别,包括滴滴打车、花小猪打车、高德地图、曹操出行、阳光出行,支持识别服务商、行程开始时间、行程结束时间、车型、总金额等16 个关键字段。

	""" 读取文件 """
   def get_file_content(filePath):
      with open(filePath, "rb") as fp:
         return fp.read()
   
   image = get_file_content('文件路径')
   url = "https://www.x.com/sample.jpg" 
   pdf_file = get_file_content('文件路径')
   
   # 调用网约车行程单识别
   res_image = client.onlineTaxiItinerary(image)
   res_url = client.onlineTaxiItineraryUrl(url)
   res_pdf = client.onlineTaxiItineraryPdf(pdf_file)
   print(res_image)
   print(res_url)
   print(res_pdf)
   
   # 如果有可选参数
   options={}
   options["pdf_file_num"] = "1"
   res_pdf = client.onlineTaxiItineraryPdf(image, options)
   print(res_pdf)

请求参数详情

参数 是否必选 类型 说明
image 和url二选一 string 图像数据,base64编码后进行urlencode,base64编码去除编码头(data:image/jpeg;base64),要求base64编码和urlencode后大小不超过4M,最短边至少15px,最长边最大4096px,支持jpg/jpeg/png/bmp格式
url 和image二选一 string 图片完整URL,URL长度不超过1024字节,URL对应的图片base64编码后大小不超过4M,最短边至少15px,最长边最大4096px,支持jpg/jpeg/png/bmp格式,当image字段存在时url字段失效,请注意关闭URL防盗链
pdf_file 和 image/url 三选一 string PDF文件,base64编码后进行urlencode,要求base64编码和urlencode后大小不超过4M,最短边至少15px,最长边最大4096px
优先级:image > url > pdf_file,当image、url字段存在时,pdf_file字段失效
pdf_file_num string 需要识别的PDF文件的对应页码,当 pdf_file 参数有效时,识别传入页码的对应页面内容,若不传入,则默认识别第 1 页
返回参数详情
字段 是否必选 类型 说明
log_id uint64 唯一的log id,用于问题定位
words_result_num uint32 识别结果数,表示words_result的元素个数
words_result object 识别结果
+ ServiceProvider string 服务商
+ StartTime string 行程开始时间
+ EndTime string 行程结束时间
+ Phone string 行程人手机号
+ ApplicationDate string 申请日期
+ TotalFare string 总金额
+ ItemNum array 行程信息中包含的行程数量
+ Items array 行程信息
++ ItemId string 行程信息的对应序号
++ PickupTime string 上车时间
++ PickupDate string 上车日期
++ CarType string 车型
++ Distance string 里程
++ StartPlace string 起点
++ DestinationPlace string 终点
++ City string 城市
++ Fare string 金额
pdf_file_size string 传入PDF文件的总页数,当 pdf_file 参数有效时返回该字段

返回示例

{
    "log_id": 1385196013945356288,
    "words_result_num": 7
    "words_result": {
        "TotalFare": "2316",
        "EndTime": "2020-07-30 19:00",
        "Phone": "13000000000",
        "ServiceProvider": "滴滴企业版",
        "StartTime": "2020-07-01 16:00",
        "ApplicationDate": "2017-12-08",
        "ItemId": "3"
        "items": [
            {
                "ItemId": "1",
                "StartPlace": "鱼化寨地铁-D口",
                "PickupTime": "16:00",
                "CarType": "快车",
                "City": "西安市",
                "Distance": "9.7",
                "PickupDate": "20-07-01",
                "DestinationPlace": "创新港",
                "Fare": "20.86"
            },
            {
                "ItemId": "2",
                "StartPlace": "科学园东门",
                "PickupTime": "14:56",
                "CarType": "快车",
                "City": "西安市",
                "Distance": "91",
                "PickupDate": "20-07-02",
                "DestinationPlace": "鱼化寨地铁站",
                "Fare": "18.58"
            },
            {
                "ItemId": "3",
                "StartPlace": "中俄丝路创新园东门",
                "PickupTime": "19:00",
                "CarType": "快车",
                "City": "西安市",
                "Distance": "9.1",
                "PickupDate": "20-07-30",
                "DestinationPlace": "新门地铁站",
                "Fare": "20.38"
            },
        ],
     },   
}

磅单识别

结构化识别磅单的车牌号、打印时间、毛重、皮重、净重、发货单位、收货单位、单号8个关键字段,现阶段仅支持识别印刷体磅单。

	""" 读取文件 """
   def get_file_content(filePath):
      with open(filePath, "rb") as fp:
         return fp.read()
   
   image = get_file_content('文件路径')
   url = "https://www.x.com/sample.jpg" 
   pdf_file = get_file_content('文件路径')
   
   # 调用磅单识别
   res_image = client.weightNote(image)
   res_url = client.weightNoteUrl(url)
   res_pdf = client.weightNotePdf(pdf_file)
   print(res_image)
   print(res_url)
   print(res_pdf)
   
   # 如果有可选参数
   options={}
   options["pdf_file_num"] = "1"
   options["probability"] = "false"
   res_image = client.weightNote(image, options)
   res_url = client.weightNoteUrl(url, options)
   res_pdf = client.weightNotePdf(image, options)
   print(res_image)
   print(res_url)
   print(res_pdf)

请求参数详情

参数 是否必选 类型 可选值范围 说明
image 和 url/pdf_file 三选一 string - 图像数据,base64编码后进行urlencode,要求base64编码和urlencode后大小不超过4M,最短边至少15px,最长边最大4096px,支持jpg/jpeg/png/bmp格式
url 和 image/pdf_file 三选一 string - 图片完整url,url长度不超过1024字节,url对应的图片base64编码后大小不超过4M,最短边至少15px,最长边最大4096px,支持jpg/jpeg/png/bmp格式,当image字段存在时url字段失效
请注意关闭URL防盗链
pdf_file 和 image/url 三选一 string - PDF文件,base64编码后进行urlencode,要求base64编码和urlencode后大小不超过4M,最短边至少15px,最长边最大4096px
优先级:image > url > pdf_file,当image、url字段存在时,pdf_file字段失效
pdf_file_num string - 需要识别的PDF文件的对应页码,当 pdf_file 参数有效时,识别传入页码的对应页面内容,若不传入,则默认识别第 1 页
probability true/false - 是否返回字段识别结果的置信度,默认为 false,可缺省
- false:不返回字段识别结果的置信度
- true:返回字段识别结果的置信度,包括字段识别结果中各字符置信度的平均值(average)和最小值(min)

返回参数详情

字段 是否必输出 类型 说明
log_id uint64 调用日志id,用于问题定位
words_result object 识别结果
words_result_num uint32 识别结果数,表示words_result的元素个数
+ PlateNum object 车牌号
+ PrintTime object 打印时间
+ CrossWeight object 毛重
+ TareWeight object 皮重
+ NetWeight object 净重
+ SendingCompany object 发货单位
+ ReceivingCompany object 收货单位
+ DeliveryNumber object 单号
++ word string 字段识别结果,以上各字段均包含此参数
++ probability object 字段识别结果置信度,当请求参数 probability=true 时,以上各字段均包含此参数
+++ average float 字段识别结果中各字符的置信度平均值
+++ min float 字段识别结果中各字符的置信度最小值
pdf_file_size string 传入PDF文件的总页数,当 pdf_file 参数有效时返回该字段

返回示例

{
    "words_result": [
        {
            "TareWeight": [
            {
                    "word": "14.20"
                }
            ],
            "CrossWeight": [
                {
                    "word": "50.70"
                }
            ],
            "PlateNum": [
                {
                    "word": "京A12356"
                }
            ],
            "SendingCompany": [
             {
                    "word": "宣化县耿矿煤业有限公司"
                }
            ],
            "DeliveryNumber": [
             {
                    "word": "278933000"
                }
            ],
            "ReceivingCompany": [
                {
                    "word": "宁夏市京裕达实业公司"
                }
            ],
            "PrintTime": [
                {
                    "word": "2020年1月1日"
                }
            ],
            "NetWeight": [
                {
                    "word": "36.50"
                }
            ]
        }
    ],
    "words_result_num": 1,
    "log_id": 1428311410130160734
}

医疗费用明细识别

支持识别全国医疗费用明细的姓名、日期、病人ID、总金额等关键字段,支持识别费用明细项目清单,包含项目类型、项目名称、单价、数量、规格、金额,其中北京地区识别效果最佳。

	""" 读取文件 """
   def get_file_content(filePath):
      with open(filePath, "rb") as fp:
         return fp.read()
   
   image = get_file_content('文件路径')
   url = "https://www.x.com/sample.jpg" 
   pdf_file = get_file_content('文件路径')
   
   # 调用医疗费用明细识别
   res_image = client.medicalDetail(image)
   res_url = client.medicalDetailUrl(url)
   print(res_image)
   print(res_url)
   
   # 如果有可选参数
   options={}
   options["location"] = "1"
   options["probability"] = "false"
   res_image = client.medicalDetail(image, options)
   res_url = client.medicalDetailUrl(url, options)
   print(res_image)
   print(res_url)

请求参数详情

参数 是否必选 类型 可选值范围 说明
image 和url二选一 string - 图像数据,base64编码后进行urlencode,要求base64编码和urlencode后大小不超过10M,最短边至少15px,最长边最大8192px,支持jpg/jpeg/png/bmp格式
url 和image二选一 string - 图片完整url,url长度不超过1024字节,url对应的图片base64编码后大小不超过10M,最短边至少15px,最长边最大8192px,支持jpg/jpeg/png/bmp格式,当image字段存在时url字段失效
请注意关闭URL防盗链
location true/false - 是否返回字段的位置信息,默认为 false,可缺省
- false:不返回字段位置信息
- true:返回字段的位置信息,包括上边距(top)、左边距(left)、宽度(width)、高度(height)
probability true/false - 是否返回字段识别结果的置信度,默认为 false,可缺省
- false:不返回字段识别结果的置信度
- true:返回字段识别结果的置信度,包括字段识别结果中各字符置信度的平均值(average)和最小值(min)

返回参数详情

字段 是否必输出 类型 说明
log_id uint64 调用日志id,用于问题定位
words_result object 识别结果
words_result_num uint32 识别结果数,表示words_result的元素个数
+ Name object 姓名
+ Date object 日期
+ PatientID object 病人ID
+ TotalAmount object 总金额
+ word string 字段识别结果,以上各字段均包含此参数
++ location object 字段位置信息,当请求参数 location=true 时,以上各字段均包含此参数
+++ top uint32 字段的上边距
+++ left uint32 字段的左边距
+++ height uint32 字段的高度
+++ width uint32 字段的宽度
++ probability object 字段识别结果置信度,当请求参数 probability=true 时,以上各字段均包含此参数
+++ average float 字段识别结果中各字符的置信度平均值
+++ min float 字段识别结果中各字符的置信度最小值
+ CostDetail array[] 项目明细

CostDetail字段包含多个Array,每个数组包含多个object,见以下参数

字段 说明
++ word_name 字段名,包括:项目类型、项目名称、单价、数量、规格、金额
++ word word_name字段对应的识别结果

返回示例

{ 
    "log_id": 1397090241579319296,
    "words_result_num": 5,
    "words_result": {
       "PatientID": {
            "word": "23683829"
        },
        "TotalAmount": {
            "word": "600.00"
        },
        "Date": {
            "word": "2020年11月04日"
        },
        "Name": {
            "word": "范浩"
        },
        "CostDetail": [
            [
                {
                    "word_name": "清单项目名称",
                    "word": "普通过敏原(新)筛查"
                },
                {
                    "word_name": "单价",
                    "word": "580.00"
                },
                {
                    "word_name": "数量",
                    "word": "1.00"
                },
                {
                    "word_name": "金额",
                    "word": "580.00"
                },
                {
                    "word_name": "规格",
                    "word": "次"
                },
                {
                    "word_name": "项目类型",
                    "word": "化验费"
                }
            ],
            [
                {
                    "word_name": "清单项目名称",
                    "word": "总IgE测定"
                },
                {
                    "word_name": "单价",
                    "word": "20.00"
                },
                {
                    "word_name": "数量",
                    "word": "1.00"
                },
                {
                    "word_name": "金额",
                    "word": "20.00"
                },
                {
                    "word_name": "规格",
                    "word": "次"
                },
                {
                    "word_name": "项目类型",
                    "word": "化验费"
                }
            ]
        ],
    },
}

办公文档识别

可对办公类文档版面进行分析,输出图、表、标题、文本的位置,并输出分版块内容的OCR识别结果,支持中、英两种语言,手写、印刷体混排多种场景。

	""" 读取文件 """
   def get_file_content(filePath):
      with open(filePath, "rb") as fp:
         return fp.read()

   image = get_file_content('文件路径')
   url = "https://www.x.com/sample.jpg"
   pdf_file = get_file_content('文件路径')
   
	# 调用办公文档识别
   res_image = client.doc_analysis_office(image)
   res_url = client.doc_analysis_officeUrl(url)
   res_pdf = client.doc_analysis_officePdf(pdf_file)
   print(res_image)
   print(res_url)
   print(res_pdf)

	# 如果有可选参数
   options = {}
   options["probability"] = "true"
   options["result_type"] = "small"
   res_image = client.doc_analysis_office(image, options)
   res_url = client.doc_analysis_officeUrl(url, options)
   res_pdf = client.doc_analysis_officePdf(pdf_file, options)
   print(res_image)
   print(res_url)
   print(res_pdf)

请求参数详情

参数 是否必选 类型 可选值范围 说明
image 和 url/pdf_file 三选一 string - 图像数据,base64编码后进行urlencode,要求base64编码和urlencode后大小不超过4M,最短边至少15px,最长边最大4096px,支持jpg/jpeg/png/bmp格式
优先级:image > url > pdf_file,当image字段存在时,url、pdf_file字段失效
url 和 image/pdf_file 三选一 string - 图片完整url,url长度不超过1024字节,url对应的图片base64编码后大小不超过4M,最短边至少15px,最长边最大4096px,支持jpg/jpeg/png/bmp格式
优先级:image > url > pdf_file,当image字段存在时,url字段失效
请注意关闭URL防盗链
pdf_file 和 image/url 三选一 string - PDF文件,base64编码后进行urlencode,要求base64编码和urlencode后大小不超过4M,最短边至少15px,最长边最大4096px
优先级:image > url > pdf_file,当image、url字段存在时,pdf_file字段失效
pdf_file_num string - 需要识别的PDF文件的对应页码,当 pdf_file 参数有效时,识别传入页码的对应页面内容,若不传入,则默认识别第 1 页
language_type string CHN_ENG/ ENG 识别语言类型,默认为CHN_ENG
可选值包括:
=CHN_ENG:中英文
=ENG:英文
result_type string big/small 返回识别结果是按单行结果返回,还是按单字结果返回,默认为big。
=big:返回行识别结果
=small:返回行识别结果之上还会返回单字结果
detect_direction string true/false 是否检测图像朝向,默认不检测,即:false。朝向是指输入图像是正常方向、逆时针旋转90/180/270度。其中,
0 :正向
1:逆时针旋转90度
2:逆时针旋转180度
3:逆时针旋转270度
line_probability string true/false 是否返回每行识别结果的置信度。默认为false
disp_line_poly string true/false 是否返回每行的四角点坐标。默认为false
words_type string handwring_only/ handprint_mix 文字类型。
默认:印刷文字识别
= handwring_only:手写文字识别
= handprint_mix: 手写印刷混排识别
layout_analysis string true/false 是否分析文档版面:包括layout(图、表、标题、段落、目录);attribute(栏、页眉、页脚、页码、脚注)的分析输出
erase_seal string true/false 是否先擦除水印、印章后再识别文档