1. 接口说明

名片识别,通过全球领先的OCR(光学字符识别 Optical Character Recognition)技术,对纸质名片进行识别,返回名片上的姓名、手机、电话、公司、部门、职位、传真、邮箱、网站、地址等关键信息,可以省去用户手动录入的过程,自动完成名片信息的结构化和数据的采集,可以很方便对接客户的后台数据系统,给用户带来极大的便利。该名片识别接口支持中文(简体和繁体)名片、英文名片,接口可以自动识别名片语种。

2. 接口地址

POST http://webapi.xfyun.cn/v1/service/v1/ocr/business_card HTTP/1.1
Content-Type:application/x-www-form-urlencoded; charset=utf-8

3. 请求参数

在 Http Request Header 中配置授权认证参数,见【接口描述-授权认证。 其中 X-Param 为各配置参数组成的JSON串经BASE64编码之后的字符串,原始JSON串各字段说明如下:

参数 类型 必须 说明 示例
engine_type string 引擎类型,固定为business_card business_card
pic_required string 是否返回切边增强图像。当为”1“时返回,当省略或为其他值时不返回。返回的json结果中切边增强图片数据格式详见返回值说明。 1
imei string 手机序列号 12345678
osid string 操作系统版本 Android
ua string 厂商|全称|机型信息|操作系统版本|分辨率 vivo|vivoY67L|PD1612|ANDROID6.0|720*1280

X-Param生成示例:

原始JSON串:
{
    "engine_type": "business_card"
}
BASE64编码(即X-Param):
eyJlbmdpbmVfdHlwZSI6ICJidXNpbmVzc19jYXJkIn0=

在 Http Request Body 中配置以下参数:

参数 类型 必须 说明 示例
image string 图像数据,base64编码后进行urlencode,要求base64编码和urlencode后大小不超过4M,仅支持jpg格式,推荐 jpg 文件设置为:尺寸 1024×768,图像质量 75 以上,位深度 24。 exSI6ICJlbiIsCgkgICAgInBvc2l0aW9uIjogImZhbHNlIgoJf...

注: base64编码后大小会增加约1/3

4. 返回值

返回值为json串,各字段如下:

参数 类型 说明
code string 结果码(具体见错误码)
data json 详见data说明
desc string 描述
sid string 会话ID
biz_card_pic string 名片切边增强图像,jpg/jpeg格式,二进制数据Base64编码(使用前注意解码)

其中sid字段主要用于追查问题,如果出现问题,可以提供sid给讯飞技术人员帮助确认问题。

data各字段说明如下:

参数 说明
formatted_name 显示完整姓名
name 一个结构化的表示形式,表示人的姓氏,名字或其他信息
address 一个结构化的标示形式,表示物理地址
label 个人或对象的物理邮件投递或交付地址
telephone 电话号码,电话通信的规范数字字符串
email 电子邮件通讯地址
title 代表个人在公司或组织内的职位,职能或其他相关属性
role 包含了个人在组织内的职业,业务或部门类别的信息
organization 单位或组织的可选名称
comment 在 JSON 格式中包含的其他注释或补充信息
url 包含一个URL的值
sns 社交帐户,例如微信
im 及时聊天帐户,例如 QQ

每一个参数的赋值都是一个 JSON 的数组,数组包含了与这个键值相关的对象或字符串的值。对象含有两个键值:item 和 position。Item 的值是一个 JSON 对象或字符串。Position的值是一个字符串,表示这个属性在名片上的矩形位置。

示例如下:

失败:

{
    "code": "10106",
    "desc": "invalid parameter|invalid X-Appid",
    "data": "",
    "sid": "wcr0000bb3f@ch3d5c059d83b3477200"
}

成功

{
"biz_card_pic":"...the Base64 encoded pic data, too long to show....",
"code": "0",
"data": {
    "address": [{
        "item": {
            "country": "中国",
            "locality": "合肥",
            "street": "望江西路666号",
            "type": ["work"]
        },
        "position": "923,884,2373,884,2373,978,923,978"
    }],
    "email": [{
        "item": "lisi@iflytek.com",
        "position": "925,754,1809,754,1809,845,925,845"
    }],
    "formatted_name": [{
        "item": "李四",
        "position": "1687,1527,2074,1527,2074,1651,1687,1651"
    }],
    "label": [{
        "item": {
            "address": "安徽省合肥市高新区望江西路666号讯飞大厦",
            "type": ["work"]
        },
        "position": "923,884,2373,884,2373,978,923,978"
    }],
    "name": [{
        "item": {
            "family_name": "李",
            "given_name": "四"
        },
        "position": "0,0,0,0,0,0,0,0"
    }],
    "organization": [{
        "item": {
            "name": "科大讯飞股份有限公司"
        },
        "position": "686,1004,1809,1004,1809,1092,686,1092"
    }],
    "rotation_angle": "0",
    "telephone": [{
        "item": {
            "number": "18888888888",
            "type": ["cellular", "voice"]
        },
        "position": "3146,773,3757,773,3757,858,3146,858"
    }, {
        "item": {
            "number": "02155663009p8021",
            "type": ["work", "voice"]
        },
        "position": "2917,895,3746,895,3746,981,2917,981"
    }, {
        "item": {
            "number": "4006083063",
            "type": ["work", "voice"]
        },
        "position": "3114,648,3762,648,3762,736,3114,736"
    }],
    "title": [{
        "item": "技术支持经理",
        "position": "2129,1527,2607,1527,2607,1651,2129,1651"
    }],
    "url": [{
        "item": "www.iflytek.com",
        "position": "917,637,1586,637,1586,721,917,721"
    }]
},
"desc": "success",
"sid": "wcr00000004@dx11730e797d37000100"
}

5. 调用示例

python2.7 脚本示例

说明:将脚本中IMAGE_PATH, API_KEY, APPID, 换成相应的图片路径,讯飞开放平台提供的apiKey,讯飞开放平台应用的appid即可,运行脚本可打印相应结果,保存切边增强图像。

#!/usr/bin/python
#coding:UTF-8
import time
import json
import hashlib
import base64
import requests

def getBody(file):
   f = open(file,"rb")
   data = f.read()
   base64_image = base64.b64encode(data)
   return {'image': base64_image}

def getHeader():
   apiKey = 'API_KEY'
   param = {"engine_type":"business_card","pic_required":"1"}
   x_param = base64.b64encode(json.dumps(param).replace(' ', ''))
   x_time = str(int(time.time()))
   x_checksum = hashlib.md5(apiKey + str(x_time) + x_param)
   x_checksum = x_checksum.hexdigest()
   x_header = {'X-Appid'    : 'APPID',
                   'X-CurTime'  : x_time,
                   'X-Param'    : x_param,
                   'X-CheckSum' : x_checksum}
   return x_header

URL = 'http://webapi.xfyun.cn/v1/service/v1/ocr/business_card'
start = time.time()
r = requests.post(URL,headers=getHeader(),data=getBody("IMAGE_PATH"))
print r.headers
print ('content length: %d' % len(r.content))
resultJson = bytes(r.content)
data = json.loads(resultJson)
picBytes = base64.b64decode(data['biz_card_pic'])
timestamp = time.time()
timestruct = time.localtime(timestamp)
timeStr=time.strftime('%H %M %S', timestruct)
with open('testdata_'+timeStr+'.jpg', 'wb') as f:
   f.write(picBytes)
print "done"
print time.time()-start
Copyright © iflytek.com 2018 all right reserved,powered by Gitbook该文件修订时间: 2018-11-03 10:26:45

results matching ""

    No results matching ""