Properties

$accessTokenUrl

$accessTokenUrl : string

获取access token url

Type

string

$reportUrl

$reportUrl : string

反馈接口

Type

string

$appId

$appId : string

appId

Type

string

$apiKey

$apiKey : string

apiKey

Type

string

$secretKey

$secretKey : string

secretKey

Type

string

$scope

$scope : array

权限

Type

array

$generalBasicUrl

$generalBasicUrl : string

通用文字识别 general_basic api url

Type

string

$accurateBasicUrl

$accurateBasicUrl : string

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

Type

string

$generalUrl

$generalUrl : string

通用文字识别(含位置信息版) general api url

Type

string

$accurateUrl

$accurateUrl : string

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

Type

string

$generalEnhancedUrl

$generalEnhancedUrl : string

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

Type

string

$webImageUrl

$webImageUrl : string

网络图片文字识别 web_image api url

Type

string

$idcardUrl

$idcardUrl : string

身份证识别 idcard api url

Type

string

$bankcardUrl

$bankcardUrl : string

银行卡识别 bankcard api url

Type

string

$drivingLicenseUrl

$drivingLicenseUrl : string

驾驶证识别 driving_license api url

Type

string

$vehicleLicenseUrl

$vehicleLicenseUrl : string

行驶证识别 vehicle_license api url

Type

string

$licensePlateUrl

$licensePlateUrl : string

车牌识别 license_plate api url

Type

string

$businessLicenseUrl

$businessLicenseUrl : string

营业执照识别 business_license api url

Type

string

$receiptUrl

$receiptUrl : string

通用票据识别 receipt api url

Type

string

$customUrl

$customUrl : string

自定义模版文字识别 custom api url

Type

string

$formUrl

$formUrl : string

表格文字识别同步接口 form api url

Type

string

$tableRecognizeUrl

$tableRecognizeUrl : string

表格文字识别 table_recognize api url

Type

string

$tableResultGetUrl

$tableResultGetUrl : string

表格识别结果 table_result_get api url

Type

string

Methods

__construct()

__construct(string  $appId, string  $apiKey, string  $secretKey) 

Parameters

string $appId
string $apiKey
string $secretKey

getVersion()

getVersion() : string

查看版本

Returns

string

setConnectionTimeoutInMillis()

setConnectionTimeoutInMillis(integer  $ms) 

连接超时

Parameters

integer $ms

毫秒

setSocketTimeoutInMillis()

setSocketTimeoutInMillis(integer  $ms) 

响应超时

Parameters

integer $ms

毫秒

setProxies()

setProxies(  $proxies) : string

代理

Parameters

$proxies

Returns

string

report()

report(  $feedback) : array

反馈

Parameters

$feedback

Returns

array

basicGeneral()

basicGeneral(string  $image, array  $options = array()) : array

通用文字识别接口

Parameters

string $image
  • 图像数据,base64编码,要求base64编码后大小不超过4M,最短边至少15px,最长边最大4096px,支持jpg/png/bmp格式
array $options
  • 可选参数对象,key: value都为string类型

Returns

array

basicGeneralUrl()

basicGeneralUrl(string  $url, array  $options = array()) : array

通用文字识别接口

Parameters

string $url
  • 图片完整URL,URL长度不超过1024字节,URL对应的图片base64编码后大小不超过4M,最短边至少15px,最长边最大4096px,支持jpg/png/bmp格式,当image字段存在时url字段失效
array $options
  • 可选参数对象,key: value都为string类型

Returns

array

basicAccurate()

basicAccurate(string  $image, array  $options = array()) : array

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

Parameters

string $image
  • 图像数据,base64编码,要求base64编码后大小不超过4M,最短边至少15px,最长边最大4096px,支持jpg/png/bmp格式
array $options
  • 可选参数对象,key: value都为string类型

Returns

array

general()

general(string  $image, array  $options = array()) : array

通用文字识别(含位置信息版)接口

Parameters

string $image
  • 图像数据,base64编码,要求base64编码后大小不超过4M,最短边至少15px,最长边最大4096px,支持jpg/png/bmp格式
array $options
  • 可选参数对象,key: value都为string类型

Returns

array

generalUrl()

generalUrl(string  $url, array  $options = array()) : array

通用文字识别(含位置信息版)接口

Parameters

string $url
  • 图片完整URL,URL长度不超过1024字节,URL对应的图片base64编码后大小不超过4M,最短边至少15px,最长边最大4096px,支持jpg/png/bmp格式,当image字段存在时url字段失效
array $options
  • 可选参数对象,key: value都为string类型

Returns

array

accurate()

accurate(string  $image, array  $options = array()) : array

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

Parameters

string $image
  • 图像数据,base64编码,要求base64编码后大小不超过4M,最短边至少15px,最长边最大4096px,支持jpg/png/bmp格式
array $options
  • 可选参数对象,key: value都为string类型

Returns

array

enhancedGeneral()

enhancedGeneral(string  $image, array  $options = array()) : array

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

Parameters

string $image
  • 图像数据,base64编码,要求base64编码后大小不超过4M,最短边至少15px,最长边最大4096px,支持jpg/png/bmp格式
array $options
  • 可选参数对象,key: value都为string类型

Returns

array

enhancedGeneralUrl()

enhancedGeneralUrl(string  $url, array  $options = array()) : array

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

Parameters

string $url
  • 图片完整URL,URL长度不超过1024字节,URL对应的图片base64编码后大小不超过4M,最短边至少15px,最长边最大4096px,支持jpg/png/bmp格式,当image字段存在时url字段失效
array $options
  • 可选参数对象,key: value都为string类型

Returns

array

webImage()

webImage(string  $image, array  $options = array()) : array

网络图片文字识别接口

Parameters

string $image
  • 图像数据,base64编码,要求base64编码后大小不超过4M,最短边至少15px,最长边最大4096px,支持jpg/png/bmp格式
array $options
  • 可选参数对象,key: value都为string类型

Returns

array

webImageUrl()

webImageUrl(string  $url, array  $options = array()) : array

网络图片文字识别接口

Parameters

string $url
  • 图片完整URL,URL长度不超过1024字节,URL对应的图片base64编码后大小不超过4M,最短边至少15px,最长边最大4096px,支持jpg/png/bmp格式,当image字段存在时url字段失效
array $options
  • 可选参数对象,key: value都为string类型

Returns

array

idcard()

idcard(string  $image, string  $idCardSide, array  $options = array()) : array

身份证识别接口

Parameters

string $image
  • 图像数据,base64编码,要求base64编码后大小不超过4M,最短边至少15px,最长边最大4096px,支持jpg/png/bmp格式
string $idCardSide
  • front:身份证含照片的一面;back:身份证带国徽的一面
array $options
  • 可选参数对象,key: value都为string类型

Returns

array

bankcard()

bankcard(string  $image, array  $options = array()) : array

银行卡识别接口

Parameters

string $image
  • 图像数据,base64编码,要求base64编码后大小不超过4M,最短边至少15px,最长边最大4096px,支持jpg/png/bmp格式
array $options
  • 可选参数对象,key: value都为string类型

Returns

array

drivingLicense()

drivingLicense(string  $image, array  $options = array()) : array

驾驶证识别接口

Parameters

string $image
  • 图像数据,base64编码,要求base64编码后大小不超过4M,最短边至少15px,最长边最大4096px,支持jpg/png/bmp格式
array $options
  • 可选参数对象,key: value都为string类型

Returns

array

vehicleLicense()

vehicleLicense(string  $image, array  $options = array()) : array

行驶证识别接口

Parameters

string $image
  • 图像数据,base64编码,要求base64编码后大小不超过4M,最短边至少15px,最长边最大4096px,支持jpg/png/bmp格式
array $options
  • 可选参数对象,key: value都为string类型

Returns

array

licensePlate()

licensePlate(string  $image, array  $options = array()) : array

车牌识别接口

Parameters

string $image
  • 图像数据,base64编码,要求base64编码后大小不超过4M,最短边至少15px,最长边最大4096px,支持jpg/png/bmp格式
array $options
  • 可选参数对象,key: value都为string类型

Returns

array

businessLicense()

businessLicense(string  $image, array  $options = array()) : array

营业执照识别接口

Parameters

string $image
  • 图像数据,base64编码,要求base64编码后大小不超过4M,最短边至少15px,最长边最大4096px,支持jpg/png/bmp格式
array $options
  • 可选参数对象,key: value都为string类型

Returns

array

receipt()

receipt(string  $image, array  $options = array()) : array

通用票据识别接口

Parameters

string $image
  • 图像数据,base64编码,要求base64编码后大小不超过4M,最短边至少15px,最长边最大4096px,支持jpg/png/bmp格式
array $options
  • 可选参数对象,key: value都为string类型

Returns

array

custom()

custom(string  $image, string  $templateSign, array  $options = array()) : array

自定义模版文字识别接口

Parameters

string $image
  • 图像数据,base64编码,要求base64编码后大小不超过4M,最短边至少15px,最长边最大4096px,支持jpg/png/bmp格式
string $templateSign
  • 您在自定义文字识别平台制作的模版的ID
array $options
  • 可选参数对象,key: value都为string类型

Returns

array

form()

form(string  $image, array  $options = array()) : array

表格文字识别同步接口接口

Parameters

string $image
  • 图像数据,base64编码,要求base64编码后大小不超过4M,最短边至少15px,最长边最大4096px,支持jpg/png/bmp格式
array $options
  • 可选参数对象,key: value都为string类型

Returns

array

tableRecognitionAsync()

tableRecognitionAsync(string  $image, array  $options = array()) : array

表格文字识别接口

Parameters

string $image
  • 图像数据,base64编码,要求base64编码后大小不超过4M,最短边至少15px,最长边最大4096px,支持jpg/png/bmp格式
array $options
  • 可选参数对象,key: value都为string类型

Returns

array

getTableRecognitionResult()

getTableRecognitionResult(string  $requestId, array  $options = array()) : array

表格识别结果接口

Parameters

string $requestId
  • 发送表格文字识别请求时返回的request id
array $options
  • 可选参数对象,key: value都为string类型

Returns

array

tableRecognition()

tableRecognition(string  $image,   $options = array(),   $timeout = 10000) : array

同步请求

Parameters

string $image

图像读取

$options
$timeout

Returns

array

proccessRequest()

proccessRequest(string  $url, array  $params, array  $data, array  $headers) 

处理请求参数

Parameters

string $url
array $params
array $data
array $headers

request()

request(string  $url, mixed  $data,   $headers = array()) : mixed

Api 请求

Parameters

string $url
mixed $data
$headers

Returns

mixed

multi_request()

multi_request(string  $url, mixed  $data) : mixed

Api 多个并发请求

Parameters

string $url
mixed $data

Returns

mixed

validate()

validate(string  $url, array  $data) : \mix

格式检查

Parameters

string $url
array $data

Returns

\mix

proccessResult()

proccessResult(  $content) : mixed

格式化结果

Parameters

$content

string

Returns

mixed

isPermission()

isPermission(array  $authObj) : boolean

判断认证是否有权限

Parameters

array $authObj

Returns

boolean

getAuthFilePath()

getAuthFilePath() : string

返回 access token 路径

Returns

string

writeAuthObj()

writeAuthObj(array  $obj) : void

写入本地文件

Parameters

array $obj

readAuthObj()

readAuthObj() : array

读取本地缓存

Returns

array

auth()

auth(boolean  $refresh = false) : array

认证

Parameters

boolean $refresh

是否刷新

Returns

array

getAuthHeaders()

getAuthHeaders(string  $method, string  $url,   $params = array(),   $headers = array()) : array

Parameters

string $method

HTTP method

string $url
$params
$headers

Returns

array