@nocobase/plugin-verification
Version:
User identity verification management, including SMS, TOTP authenticator, with extensibility.
2,883 lines (2,882 loc) • 254 kB
TypeScript
/**
* 非税收入条目
*/
export interface NonTaxItem {
/**
* 项目编码
*/
ItemID?: string;
/**
* 项目名称
*/
Name?: string;
/**
* 单位
*/
Unit?: string;
/**
* 数量
*/
Quantity?: string;
/**
* 标准
*/
Standard?: string;
/**
* 金额
*/
Total?: string;
}
/**
* 运单识别结果
*/
export interface TextWaybill {
/**
* 收件人姓名
*/
RecName: WaybillObj;
/**
* 收件人手机号
*/
RecNum: WaybillObj;
/**
* 收件人地址
*/
RecAddr: WaybillObj;
/**
* 寄件人姓名
*/
SenderName: WaybillObj;
/**
* 寄件人手机号
*/
SenderNum: WaybillObj;
/**
* 寄件人地址
*/
SenderAddr: WaybillObj;
/**
* 运单号
*/
WaybillNum: WaybillObj;
}
/**
* RecognizeOnlineTaxiItineraryOCR返回参数结构体
*/
export interface RecognizeOnlineTaxiItineraryOCRResponse {
/**
* 网约车行程单识别结果,具体内容请点击左侧链接。
*/
OnlineTaxiItineraryInfos?: Array<OnlineTaxiItineraryInfo>;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 混贴票据单张发票识别信息
*/
export interface InvoiceItem {
/**
* 识别结果。
OK:表示识别成功;FailedOperation.UnsupportedInvoice:表示不支持识别;
FailedOperation.UnKnowError:表示识别失败;
其它错误码见各个票据接口的定义。
*/
Code?: string;
/**
* 识别出的图片所属的票据类型。
-1:未知类型
0:出租车发票
1:定额发票
2:火车票
3:增值税发票
5:机票行程单
8:通用机打发票
9:汽车票
10:轮船票
11:增值税发票(卷票)
12:购车发票
13:过路过桥费发票
15:非税发票
16:全电发票
17:医疗发票
*/
Type?: number;
/**
* 该发票在原图片中的四点坐标。
*/
Polygon?: Polygon;
/**
* 识别出的图片在混贴票据图片中的旋转角度。
*/
Angle?: number;
/**
* 识别到的内容。
*/
SingleInvoiceInfos?: SingleInvoiceItem;
/**
* 发票处于识别图片或PDF文件中的页教,默认从1开始。
*/
Page?: number;
/**
* 发票详细类型,详见票据识别(高级版)接口文档说明中 SubType 返回值说明
*/
SubType?: string;
/**
* 发票类型描述,详见票据识别(高级版)接口文档说明中 TypeDescription 返回值说明
*/
TypeDescription?: string;
/**
* 切割单图文件,Base64编码后的切图后的图片文件,开启 EnableCutImage 后进行返回
*/
CutImage?: string;
/**
* 发票详细类型描述,详见上方 SubType 返回值说明
*/
SubTypeDescription?: string;
/**
* 该发票中所有字段坐标信息。包括字段英文名称、字段值所在位置四点坐标、字段所属行号,具体内容请点击左侧链接。
*/
ItemPolygon?: Array<ItemPolygonInfo>;
}
/**
* BankSlipOCR请求参数结构体
*/
export interface BankSlipOCRRequest {
/**
* 图片的 Base64 值。要求图片经Base64编码后不超过 7M,分辨率建议500*800以上,支持PNG、JPG、JPEG、BMP格式。
图片的 ImageUrl、ImageBase64 必须提供一个,如果都提供,只使用 ImageUrl。
*/
ImageBase64?: string;
/**
* 图片的 Url 地址。要求图片经Base64编码后不超过 7M,分辨率建议500*800以上,支持PNG、JPG、JPEG、BMP格式。
建议图片存储于腾讯云,可保障更高的下载速度和稳定性。
*/
ImageUrl?: string;
/**
* 是否开启PDF识别,默认值为true,开启后可同时支持图片和PDF的识别。
*/
IsPdf?: boolean;
/**
* 需要识别的PDF页面的对应页码,仅支持PDF单页识别,当上传文件为PDF且IsPdf参数值为true时有效,默认值为1。
*/
PdfPageNumber?: number;
}
/**
* BusinessCardOCR返回参数结构体
*/
export interface BusinessCardOCRResponse {
/**
* 名片识别结果,具体内容请点击左侧链接。
*/
BusinessCardInfos?: Array<BusinessCardInfo>;
/**
* 返回图像预处理后的图片,图像预处理未开启时返回内容为空。
*/
RetImageBase64?: string;
/**
* 图片旋转角度(角度制),文本的水平方向为0°;顺时针为正,逆时针为负。点击查看<a href="https://cloud.tencent.com/document/product/866/45139">如何纠正倾斜文本</a>
*/
Angle?: number;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 算式识别结果
*/
export interface TextArithmetic {
/**
* 识别出的文本行内容
*/
DetectedText: string;
/**
* 算式运算结果,true-正确 false-错误或非法参数
*/
Result: boolean;
/**
* 保留字段,暂不支持
*/
Confidence: number;
/**
* 原图文本行坐标,以四个顶点坐标表示(保留字段,暂不支持)
注意:此字段可能返回 null,表示取不到有效值。
*/
Polygon: Array<Coord>;
/**
* 保留字段,暂不支持
*/
AdvancedInfo: string;
/**
* 文本行旋转纠正之后在图像中的像素坐标,表示为(左上角x, 左上角y,宽width,高height)
*/
ItemCoord: ItemCoord;
/**
* 算式题型编号:
‘1’: 加减乘除四则
‘2’: 加减乘除已知结果求运算因子
‘3’: 判断大小
‘4’: 约等于估算
‘5’: 带余数除法
‘6’: 分数四则运算
‘7’: 单位换算
‘8’: 竖式加减法
‘9’: 竖式乘除法
‘10’: 脱式计算
‘11’: 解方程
*/
ExpressionType: string;
/**
* 错题推荐答案,算式运算结果正确返回为"",算式运算结果错误返回推荐答案 (注:暂不支持多个关系运算符(如1<10<7)、无关系运算符(如frac(1,2)+frac(2,3))、单位换算(如1元=100角)错题的推荐答案返回)
*/
Answer: string;
}
/**
* HKIDCardOCR请求参数结构体
*/
export interface HKIDCardOCRRequest {
/**
* 是否鉴伪。
*/
DetectFake: boolean;
/**
* 是否返回人像照片。
*/
ReturnHeadImage: boolean;
/**
* 图片的 Base64 值。
支持的图片格式:PNG、JPG、JPEG,暂不支持 GIF 格式。
支持的图片大小:所下载图片经Base64编码后不超过 7M。图片下载时间不超过 3 秒。
*/
ImageBase64?: string;
/**
* 图片的 Url 地址。
支持的图片格式:PNG、JPG、JPEG,暂不支持 GIF 格式。
支持的图片大小:所下载图片经 Base64 编码后不超过 3M。图片下载时间不超过 3 秒。
图片存储于腾讯云的 Url 可保障更高的下载速度和稳定性,建议图片存储于腾讯云。
非腾讯云存储的 Url 速度和稳定性可能受一定影响。
*/
ImageUrl?: string;
}
/**
* CarInvoiceOCR请求参数结构体
*/
export interface CarInvoiceOCRRequest {
/**
* 图片的 Base64 值。
支持的图片格式:PNG、JPG、JPEG,暂不支持 GIF 格式。
支持的图片大小:所下载图片经Base64编码后不超过 7M。图片下载时间不超过 3 秒。
图片的 ImageUrl、ImageBase64 必须提供一个,如果都提供,只使用 ImageUrl。
*/
ImageBase64?: string;
/**
* 图片的 Url 地址。
支持的图片格式:PNG、JPG、JPEG,暂不支持 GIF 格式。
支持的图片大小:所下载图片经 Base64 编码后不超过 7M。图片下载时间不超过 3 秒。
图片存储于腾讯云的 Url 可保障更高的下载速度和稳定性,建议图片存储于腾讯云。
非腾讯云存储的 Url 速度和稳定性可能受一定影响。
*/
ImageUrl?: string;
/**
* 是否开启PDF识别,默认值为true,开启后可同时支持图片和PDF的识别。
*/
IsPdf?: boolean;
/**
* 需要识别的PDF页面的对应页码,仅支持PDF单页识别,当上传文件为PDF且IsPdf参数值为true时有效,默认值为1。
*/
PdfPageNumber?: number;
}
/**
* 混贴票据单张发票识别信息
*/
export interface MixedInvoiceItem {
/**
* 识别结果。
OK:表示识别成功;FailedOperation.UnsupportedInvioce:表示不支持识别;
FailedOperation.UnKnowError:表示识别失败;
其它错误码见各个票据接口的定义。
*/
Code: string;
/**
* 识别出的图片所属的票据类型。
-1:未知类型
0:出租车发票
1:定额发票
2:火车票
3:增值税发票
5:机票行程单
8:通用机打发票
9:汽车票
10:轮船票
11:增值税发票(卷票)
12:购车发票
13:过路过桥费发票
15:非税发票
16:全电发票
*/
Type: number;
/**
* 识别出的图片在混贴票据图片中的位置信息。与Angel结合可以得出原图位置,组成RotatedRect((X+0.5\*Width,Y+0.5\*Height), (Width, Height), Angle),详情可参考OpenCV文档。
*/
Rect: Rect;
/**
* 识别出的图片在混贴票据图片中的旋转角度。
*/
Angle: number;
/**
* 识别到的内容。
*/
SingleInvoiceInfos: Array<SingleInvoiceInfo>;
/**
* 发票处于识别图片或PDF文件中的页教,默认从1开始。
*/
Page?: number;
}
/**
* RecognizeTravelCardOCR请求参数结构体
*/
export interface RecognizeTravelCardOCRRequest {
/**
* 图片的 Base64 值。
支持的图片格式:PNG、JPG、JPEG,暂不支持 GIF 格式。
支持的图片大小:所下载图片经Base64编码后不超过 7M。图片下载时间不超过 3 秒。
图片的 ImageUrl、ImageBase64 必须提供一个,如果都提供,只使用 ImageUrl。
*/
ImageBase64?: string;
/**
* 图片的 Url 地址。
支持的图片格式:PNG、JPG、JPEG,暂不支持 GIF 格式。
支持的图片大小:所下载图片经 Base64 编码后不超过 7M。图片下载时间不超过 3 秒。
图片存储于腾讯云的 Url 可保障更高的下载速度和稳定性,建议图片存储于腾讯云。
非腾讯云存储的 Url 速度和稳定性可能受一定影响。
*/
ImageUrl?: string;
}
/**
* TrainTicketOCR请求参数结构体
*/
export interface TrainTicketOCRRequest {
/**
* 图片的 Base64 值。
支持的图片格式:PNG、JPG、JPEG,暂不支持 GIF 格式。
支持的图片大小:所下载图片经Base64编码后不超过 7M。图片下载时间不超过 3 秒。
图片的 ImageUrl、ImageBase64 必须提供一个,如果都提供,只使用 ImageUrl。
*/
ImageBase64?: string;
/**
* 图片的 Url 地址。
支持的图片格式:PNG、JPG、JPEG,暂不支持 GIF 格式。
支持的图片大小:所下载图片经 Base64 编码后不超过 7M。图片下载时间不超过 3 秒。
图片存储于腾讯云的 Url 可保障更高的下载速度和稳定性,建议图片存储于腾讯云。
非腾讯云存储的 Url 速度和稳定性可能受一定影响。
*/
ImageUrl?: string;
/**
* 是否开启PDF识别,默认值为true,开启后可同时支持图片和PDF的识别。
*/
IsPdf?: boolean;
/**
* 需要识别的PDF页面的对应页码,仅支持PDF单页识别,当上传文件为PDF且IsPdf参数值为true时有效,默认值为1。
*/
PdfPageNumber?: number;
}
/**
* EstateCertOCR返回参数结构体
*/
export interface EstateCertOCRResponse {
/**
* 权利人
*/
Obligee: string;
/**
* 共有情况
*/
Ownership: string;
/**
* 坐落
*/
Location: string;
/**
* 不动产单元号
*/
Unit: string;
/**
* 权利类型
*/
Type: string;
/**
* 权利性质
*/
Property: string;
/**
* 用途
*/
Usage: string;
/**
* 面积
*/
Area: string;
/**
* 使用期限
*/
Term: string;
/**
* 权利其他状况,多行会用换行符\n连接。
*/
Other: string;
/**
* 图片旋转角度
*/
Angle: number;
/**
* 不动产权号
*/
Number: string;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* GeneralHandwritingOCR返回参数结构体
*/
export interface GeneralHandwritingOCRResponse {
/**
* 检测到的文本信息,具体内容请点击左侧链接。
*/
TextDetections: Array<TextGeneralHandwriting>;
/**
* 图片旋转角度(角度制),文本的水平方向为0°;顺时针为正,逆时针为负。点击查看<a href="https://cloud.tencent.com/document/product/866/45139">如何纠正倾斜文本</a>
*/
Angel: number;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* RecognizePhilippinesDrivingLicenseOCR请求参数结构体
*/
export interface RecognizePhilippinesDrivingLicenseOCRRequest {
/**
* 图片的 Base64 值。
支持的图片格式:PNG、JPG、JPEG,暂不支持 GIF 格式。
支持的图片大小:所下载图片经Base64编码后不超过 7M。图片下载时间不超过 3 秒。
图片的 ImageUrl、ImageBase64 必须提供一个,如果都提供,只使用 ImageUrl。
*/
ImageBase64?: string;
/**
* 图片的 Url 地址。
支持的图片格式:PNG、JPG、JPEG,暂不支持 GIF 格式。
支持的图片大小:所下载图片经 Base64 编码后不超过 7M。图片下载时间不超过 3 秒。
图片存储于腾讯云的 Url 可保障更高的下载速度和稳定性,建议图片存储于腾讯云。
非腾讯云存储的 Url 速度和稳定性可能受一定影响。
*/
ImageUrl?: string;
/**
* 是否返回人像照片。
*/
ReturnHeadImage?: boolean;
}
/**
* 还原文本信息
*/
export interface WordItem {
/**
* 文本块内容
*/
DetectedText?: string;
/**
* 四点坐标
*/
Coord?: Polygon;
}
/**
* MLIDPassportOCR请求参数结构体
*/
export interface MLIDPassportOCRRequest {
/**
* 图片的 Base64 值。要求图片经Base64编码后不超过 7M,分辨率建议500*800以上,支持PNG、JPG、JPEG、BMP格式。建议卡片部分占据图片2/3以上。
*/
ImageBase64: string;
/**
* 是否返回图片,默认false
*/
RetImage?: boolean;
}
/**
* 智能结构化元素组
*/
export interface ItemInfo {
/**
* key信息组
注意:此字段可能返回 null,表示取不到有效值。
*/
Key?: Key;
/**
* Value信息组
注意:此字段可能返回 null,表示取不到有效值。
*/
Value?: Value;
}
/**
* SmartStructuralOCRV2请求参数结构体
*/
export interface SmartStructuralOCRV2Request {
/**
* 图片的 Url 地址。
支持的图片格式:PNG、JPG、JPEG,暂不支持 GIF 格式。
支持的图片大小:所下载图片经 Base64 编码后不超过 7M。图片下载时间不超过 3 秒。
支持的图片像素:需介于20-10000px之间。
图片存储于腾讯云的 Url 可保障更高的下载速度和稳定性,建议图片存储于腾讯云。
非腾讯云存储的 Url 速度和稳定性可能受一定影响。
*/
ImageUrl?: string;
/**
* 图片的 Base64 值。
支持的图片格式:PNG、JPG、JPEG,暂不支持 GIF 格式。
支持的图片大小:所下载图片经Base64编码后不超过 7M。图片下载时间不超过 3 秒。
支持的图片像素:需介于20-10000px之间。
图片的 ImageUrl、ImageBase64 必须提供一个,如果都提供,只使用 ImageUrl。
*/
ImageBase64?: string;
/**
* 是否开启PDF识别,默认值为false,开启后可同时支持图片和PDF的识别。
*/
IsPdf?: boolean;
/**
* 需要识别的PDF页面的对应页码,仅支持PDF单页识别,当上传文件为PDF且IsPdf参数值为true时有效,默认值为1。
*/
PdfPageNumber?: number;
/**
* 自定义结构化功能需返回的字段名称,例:
若客户只想返回姓名、性别两个字段的识别结果,则输入
ItemNames=["姓名","性别"]
*/
ItemNames?: Array<string>;
/**
* 是否开启全文字段识别
*/
ReturnFullText?: boolean;
/**
* 配置id支持:
General -- 通用场景
OnlineTaxiItinerary -- 网约车行程单
RideHailingDriverLicense -- 网约车驾驶证
RideHailingTransportLicense -- 网约车运输证
WayBill -- 快递运单
AccountOpeningPermit -- 银行开户许可证
InvoiceEng -- 海外发票模版
*/
ConfigId?: string;
}
/**
* TextDetect返回参数结构体
*/
export interface TextDetectResponse {
/**
* 图片中是否包含文字。
*/
HasText: boolean;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 铁路电子客票信息
*/
export interface RailwayTicketInfo {
/**
* 电子发票类型
*/
TypeOfVoucher?: string;
/**
* 电子客票号
*/
ElectronicTicketNum?: string;
/**
* 开票日期
*/
DateOfIssue?: string;
/**
* 售票或退票类型
*/
TypeOfBusiness?: string;
/**
* 始发站
*/
DepartureStation?: string;
/**
* 始发站英文
*/
PhonicsOfDepartureStation?: string;
/**
* 到达站
*/
DestinationStation?: string;
/**
* 到达站英文
*/
PhonicsOfDestinationStation?: string;
/**
* 火车号
*/
TrainNumber?: string;
/**
* 火车出发日期
*/
TravelDate?: string;
/**
* 始发时间
*/
DepartureTime?: string;
/**
* 空调特点
*/
AirConditioningCharacteristics?: string;
/**
* 座位类型
*/
SeatLevel?: string;
/**
* 火车第几车
*/
Carriage?: string;
/**
* 座位号
*/
Seat?: string;
/**
* 票价
*/
Fare?: string;
/**
* 发票号码
*/
ElectronicInvoiceRailwayETicketNumber?: string;
/**
* 身份证号
*/
IdNumber?: string;
/**
* 姓名
*/
Name?: string;
/**
* 金额
*/
TotalAmountExcludingTax?: string;
/**
* 税率
*/
TaxRate?: string;
/**
* 税额
*/
TaxAmount?: string;
/**
* 购买方名称
*/
NameOfPurchaser?: string;
/**
* 统一社会信用代码
*/
UnifiedSocialCreditCodeOfPurchaser?: string;
/**
* 原发票号码
*/
NumberOfOriginalInvoice?: string;
}
/**
* TollInvoiceOCR返回参数结构体
*/
export interface TollInvoiceOCRResponse {
/**
* 过路过桥费发票识别结果,具体内容请点击左侧链接。
*/
TollInvoiceInfos?: Array<TollInvoiceInfo>;
/**
* 图片旋转角度(角度制),文本的水平方向为0°,顺时针为正,逆时针为负。
*/
Angle?: number;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* FinanBillSliceOCR返回参数结构体
*/
export interface FinanBillSliceOCRResponse {
/**
* 金融票据切片识别结果,具体内容请点击左侧链接。
*/
FinanBillSliceInfos?: Array<FinanBillSliceInfo>;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DriverLicenseOCR返回参数结构体
*/
export interface DriverLicenseOCRResponse {
/**
* 驾驶证正页姓名
*/
Name?: string;
/**
* 性别
*/
Sex?: string;
/**
* 国籍
*/
Nationality?: string;
/**
* 住址
*/
Address?: string;
/**
* 出生日期(YYYY-MM-DD)
*/
DateOfBirth?: string;
/**
* 初次领证日期(YYYY-MM-DD)
*/
DateOfFirstIssue?: string;
/**
* 准驾车型
*/
Class?: string;
/**
* 有效期开始时间(YYYY-MM-DD)
*/
StartDate?: string;
/**
* 有效期截止时间(新版驾驶证返回 YYYY-MM-DD,
老版驾驶证返回有效期限 X年)
*/
EndDate?: string;
/**
* 驾驶证正页证号
*/
CardCode?: string;
/**
* 档案编号
*/
ArchivesCode?: string;
/**
* 记录
*/
Record?: string;
/**
* Code 告警码列表和释义:
-9102 复印件告警
-9103 翻拍件告警
注:告警码可以同时存在多个
*/
RecognizeWarnCode?: Array<number | bigint>;
/**
* 告警码说明:
WARN_DRIVER_LICENSE_COPY_CARD 复印件告警
WARN_DRIVER_LICENSE_SCREENED_CARD 翻拍件告警
注:告警信息可以同时存在多个
*/
RecognizeWarnMsg?: Array<string>;
/**
* 发证单位
*/
IssuingAuthority?: string;
/**
* 状态(仅电子驾驶证支持返回该字段)
*/
State?: string;
/**
* 累积记分(仅电子驾驶证支持返回该字段)
*/
CumulativeScore?: string;
/**
* 当前时间(仅电子驾驶证支持返回该字段)
*/
CurrentTime?: string;
/**
* 生成时间(仅电子驾驶证支持返回该字段)
*/
GenerateTime?: string;
/**
* 驾驶证副页姓名
*/
BackPageName?: string;
/**
* 驾驶证副页证号
*/
BackPageCardCode?: string;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* WaybillOCR返回参数结构体
*/
export interface WaybillOCRResponse {
/**
* 检测到的文本信息,具体内容请点击左侧链接。
*/
TextDetections?: TextWaybill;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateAIFormTask请求参数结构体
*/
export interface CreateAIFormTaskRequest {
/**
* 多个文件的URL列表
*/
FileList: Array<SmartFormFileUrl>;
/**
* 备注信息1
*/
FirstNotes?: string;
/**
* 备注信息2
*/
SecondNotes?: string;
/**
* 文件类型
*/
FileType?: number;
}
/**
* 识别出来的单词信息包括单词(包括单词Character和单词置信度confidence)
*/
export interface Words {
/**
* 置信度 0 ~100
*/
Confidence: number;
/**
* 候选字Character
*/
Character: string;
}
/**
* 英文识别结果
*/
export interface TextDetectionEn {
/**
* 识别出的文本行内容。
*/
DetectedText: string;
/**
* 置信度 0 ~100。
*/
Confidence: number;
/**
* 文本行在原图中的四点坐标。
注意:此字段可能返回 null,表示取不到有效值。
*/
Polygon: Array<Coord>;
/**
* 此字段为扩展字段。目前EnglishOCR接口返回内容为空。
*/
AdvancedInfo: string;
/**
* 英文单词在原图中的四点坐标。
*/
WordCoordPoint: Array<WordCoordPoint>;
/**
* 候选字符集(包含候选字Character以及置信度Confidence)。
*/
CandWord: Array<CandWord>;
/**
* 识别出来的单词信息(包括单词Character和单词置信度confidence)
*/
Words: Array<Words>;
}
/**
* 电子发票(机票行程单)
*/
export interface ElectronicFlightTicketFull {
/**
* 旅客姓名
*/
UserName?: string;
/**
* 有效身份证件号码
*/
UserID?: string;
/**
* 签注
*/
Endorsement?: string;
/**
* GP单号
*/
GPOrder?: string;
/**
* 发票号码
*/
Number?: string;
/**
* 票价
*/
Fare?: string;
/**
* 燃油附加费
*/
FuelSurcharge?: string;
/**
* 增值税税率
*/
TaxRate?: string;
/**
* 增值税税额
*/
Tax?: string;
/**
* 民航发展基金
*/
DevelopmentFund?: string;
/**
* 其他税费
*/
OtherTax?: string;
/**
* 合计
*/
Total?: string;
/**
* 电子客票号码
*/
ElectronicTicketNum?: string;
/**
* 验证码
*/
VerificationCode?: string;
/**
* 提示信息
*/
PromptInformation?: string;
/**
* 保险费
*/
Insurance?: string;
/**
* 填开单位
*/
Issuer?: string;
/**
* 填开时间
*/
Date?: string;
/**
* 国内国际标识
*/
DomesticInternationalTag?: string;
/**
* 购买方名称
*/
Buyer?: string;
/**
* 销售方名称
*/
Seller?: string;
/**
* 统一社会信用代码
*/
BuyerTaxID?: string;
/**
* 机票详细信息元组
*/
FlightItems?: Array<FlightItemInfo>;
}
/**
* PermitOCR返回参数结构体
*/
export interface PermitOCRResponse {
/**
* 姓名
*/
Name?: string;
/**
* 英文姓名
*/
EnglishName?: string;
/**
* 证件号
*/
Number?: string;
/**
* 性别
*/
Sex?: string;
/**
* 有效期限
*/
ValidDate?: string;
/**
* 签发机关
*/
IssueAuthority?: string;
/**
* 签发地点
*/
IssueAddress?: string;
/**
* 出生日期
*/
Birthday?: string;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* InvoiceGeneralOCR请求参数结构体
*/
export interface InvoiceGeneralOCRRequest {
/**
* 图片的 Base64 值。
支持的图片格式:PNG、JPG、JPEG,暂不支持 GIF 格式。
支持的图片大小:所下载图片经Base64编码后不超过 7M。图片下载时间不超过 3 秒。
图片的 ImageUrl、ImageBase64 必须提供一个,如果都提供,只使用 ImageUrl。
*/
ImageBase64?: string;
/**
* 图片的 Url 地址。
支持的图片格式:PNG、JPG、JPEG,暂不支持 GIF 格式。
支持的图片大小:所下载图片经 Base64 编码后不超过 7M。图片下载时间不超过 3 秒。
图片存储于腾讯云的 Url 可保障更高的下载速度和稳定性,建议图片存储于腾讯云。
非腾讯云存储的 Url 速度和稳定性可能受一定影响。
*/
ImageUrl?: string;
/**
* 是否开启PDF识别,默认值为true,开启后可同时支持图片和PDF的识别。
*/
IsPdf?: boolean;
/**
* 需要识别的PDF页面的对应页码,仅支持PDF单页识别,当上传文件为PDF且IsPdf参数值为true时有效,默认值为1。
*/
PdfPageNumber?: number;
}
/**
* 矩形坐标
*/
export interface Rect {
/**
* 左上角x
*/
X: number;
/**
* 左上角y
*/
Y: number;
/**
* 宽度
*/
Width: number;
/**
* 高度
*/
Height: number;
}
/**
* 全部车牌信息
*/
export interface LicensePlateInfo {
/**
* 识别出的车牌号码。
*/
Number?: string;
/**
* 置信度,0 - 100 之间。
*/
Confidence?: number;
/**
* 文本行在原图片中的像素坐标框。
*/
Rect?: Rect;
/**
* 识别出的车牌颜色,目前支持颜色包括 “白”、“黑”、“蓝”、“绿“、“黄”、“黄绿”、“临牌”、“喷漆”、“其它”。
*/
Color?: string;
}
/**
* RideHailingTransportLicenseOCR请求参数结构体
*/
export interface RideHailingTransportLicenseOCRRequest {
/**
* 图片的 Base64 值。要求图片经Base64编码后不超过 7M,分辨率建议500*800以上,支持PNG、JPG、JPEG、BMP格式。建议卡片部分占据图片2/3以上。
图片的 ImageUrl、ImageBase64 必须提供一个,如果都提供,只使用 ImageUrl。
*/
ImageBase64?: string;
/**
* 图片的 Url 地址。要求图片经Base64编码后不超过 7M,分辨率建议500*800以上,支持PNG、JPG、JPEG、BMP格式。建议卡片部分占据图片2/3以上。图片下载时间不超过 3 秒。
建议图片存储于腾讯云,可保障更高的下载速度和稳定性。
*/
ImageUrl?: string;
}
/**
* FlightInvoiceOCR请求参数结构体
*/
export interface FlightInvoiceOCRRequest {
/**
* 图片的 Base64 值。
支持的图片格式:PNG、JPG、JPEG,暂不支持 GIF 格式。
支持的图片大小:所下载图片经Base64编码后不超过 7M。图片下载时间不超过 3 秒。
图片的 ImageUrl、ImageBase64 必须提供一个,如果都提供,只使用 ImageUrl。
*/
ImageBase64?: string;
/**
* 图片的 Url 地址。
支持的图片格式:PNG、JPG、JPEG,暂不支持 GIF 格式。
支持的图片大小:所下载图片经 Base64 编码后不超过 7M。图片下载时间不超过 3 秒。
图片存储于腾讯云的 Url 可保障更高的下载速度和稳定性,建议图片存储于腾讯云。
非腾讯云存储的 Url 速度和稳定性可能受一定影响。
*/
ImageUrl?: string;
/**
* 是否开启PDF识别,默认值为true,开启后可同时支持图片和PDF的识别。
*/
IsPdf?: boolean;
/**
* 需要识别的PDF页面的对应页码,仅支持PDF单页识别,当上传文件为PDF且IsPdf参数值为true时有效,默认值为1。
*/
PdfPageNumber?: number;
}
/**
* 数学公式识别结果
*/
export interface TextFormula {
/**
* 识别出的文本行内容
*/
DetectedText: string;
}
/**
* HmtResidentPermitOCR返回参数结构体
*/
export interface HmtResidentPermitOCRResponse {
/**
* 证件姓名
*/
Name?: string;
/**
* 性别
*/
Sex?: string;
/**
* 出生日期
*/
Birth?: string;
/**
* 地址
*/
Address?: string;
/**
* 身份证号
*/
IdCardNo?: string;
/**
* 0-正面
1-反面
*/
CardType?: number;
/**
* 证件有效期限
*/
ValidDate?: string;
/**
* 签发机关
*/
Authority?: string;
/**
* 签发次数
*/
VisaNum?: string;
/**
* 通行证号码
*/
PassNo?: string;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 增值税发票项目明细
*/
export interface VatInvoiceItem {
/**
* 行号
*/
LineNo: string;
/**
* 名称
*/
Name: string;
/**
* 规格
*/
Spec: string;
/**
* 单位
*/
Unit: string;
/**
* 数量
*/
Quantity: string;
/**
* 单价
*/
UnitPrice: string;
/**
* 不含税金额
*/
AmountWithoutTax: string;
/**
* 税率
*/
TaxRate: string;
/**
* 税额
*/
TaxAmount: string;
/**
* 税收分类编码
*/
TaxClassifyCode: string;
/**
* 运输工具类型
*/
VehicleType?: string;
/**
* 运输工具牌号
*/
VehicleBrand?: string;
/**
* 起始地
*/
DeparturePlace?: string;
/**
* 到达地
*/
ArrivalPlace?: string;
/**
* 运输货物名称
*/
TransportItemsName?: string;
/**
* 建筑服务发生地
*/
ConstructionPlace?: string;
/**
* 建筑项目名称
*/
ConstructionName?: string;
}
/**
* 机动车登记证书识别结果
*/
export interface VehicleRegCertInfo {
/**
* 识别出的字段名称(关键字),支持以下字段:
【注册登记页】
车辆型号、车辆识别代号/车架号、发动机号、制造厂名称、轴距、轮胎数、总质量、外廓尺寸、轴数、车辆出厂日期、发证日期、使用性质、车辆获得方式、车辆类型、国产/进口、燃料种类、车身颜色、发动机型号、车辆品牌、编号、转向形式、
机动车所有人1、身份证明名称1、号码1、登记机关1、登记日期1
机动车所有人2、身份证明名称2、号码2、登记机关2、登记日期2
机动车所有人3、身份证明名称3、号码3、登记机关3、登记日期3
机动车所有人4、身份证明名称4、号码4、登记机关4、登记日期4
机动车所有人5、身份证明名称5、号码5、登记机关5、登记日期5
机动车所有人6、身份证明名称6、号码6、登记机关6、登记日期6
机动车所有人7、身份证明名称7、号码7、登记机关7、登记日期7
【抵押登记页】
机动车登记证书编号、身份证明名称/号码、抵押权人姓名/名称、抵押登记日期。
*/
Name: string;
/**
* 识别出的字段名称对应的值,也就是字段name对应的字符串结果。
*/
Value: string;
}
/**
* 机票行程卡条目
*/
export interface FlightItem {
/**
* 出发航站楼
*/
TerminalGetOn?: string;
/**
* 到达航站楼
*/
TerminalGetOff?: string;
/**
* 承运人
*/
Carrier?: string;
/**
* 航班号
*/
FlightNumber?: string;
/**
* 座位等级
*/
Seat?: string;
/**
* 乘机日期
*/
DateGetOn?: string;
/**
* 乘机时间
*/
TimeGetOn?: string;
/**
* 出发站
*/
StationGetOn?: string;
/**
* 到达站
*/
StationGetOff?: string;
/**
* 免费行李
*/
Allow?: string;
/**
* 客票级别/客票类别
*/
FareBasis?: string;
}
/**
* value信息组
*/
export interface Value {
/**
* 自动识别的字段内容
*/
AutoContent?: string;
/**
* 四点坐标
注意:此字段可能返回 null,表示取不到有效值。
*/
Coord?: Polygon;
}
/**
* EnterpriseLicenseOCR返回参数结构体
*/
export interface EnterpriseLicenseOCRResponse {
/**
* 企业证照识别结果,具体内容请点击左侧链接。
*/
EnterpriseLicenseInfos?: Array<EnterpriseLicenseInfo>;
/**
* 图片旋转角度(角度制),文本的水平方向为0°,顺时针为正,逆时针为负。
*/
Angle?: number;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 印章信息
*/
export interface SealInfo {
/**
* 印章主体内容
*/
SealBody: string;
/**
* 印章坐标
*/
Location: Rect;
/**
* 印章其它文本内容
*/
OtherTexts: Array<string>;
/**
* 印章类型,表示为:
圆形印章:0
椭圆形印章:1
方形印章:2
菱形印章:3
三角形印章:4
*/
SealShape: string;
}
/**
* RecognizePhilippinesVoteIDOCR请求参数结构体
*/
export interface RecognizePhilippinesVoteIDOCRRequest {
/**
* 是否返回人像照片。
*/
ReturnHeadImage: boolean;
/**
* 图片的 Base64 值。
支持的图片格式:PNG、JPG、JPEG,暂不支持 GIF 格式。
支持的图片大小:所下载图片经Base64编码后不超过 7M。图片下载时间不超过 3 秒。
图片的 ImageUrl、ImageBase64 必须提供一个,如果都提供,只使用 ImageUrl。
*/
ImageBase64?: string;
/**
* 图片的 Url 地址。
支持的图片格式:PNG、JPG、JPEG,暂不支持 GIF 格式。
支持的图片大小:所下载图片经 Base64 编码后不超过 7M。图片下载时间不超过 3 秒。
图片存储于腾讯云的 Url 可保障更高的下载速度和稳定性,建议图片存储于腾讯云。
非腾讯云存储的 Url 速度和稳定性可能受一定影响。
*/
ImageUrl?: string;
}
/**
* 通用机打发票信息
*/
export interface InvoiceGeneralInfo {
/**
* 识别出的字段名称(关键字),支持以下字段识别(注:下划线表示一个字段):
发票代码、发票号码、日期、合计金额(小写)、合计金额(大写)、购买方识别号、销售方识别号、校验码、购买方名称、销售方名称、时间、种类、发票消费类型、省、市、是否有公司印章、发票名称、<span style="text-decoration:underline">购买方地址、电话</span>、<span style="text-decoration:underline">销售方地址、电话</span>、购买方开户行及账号、销售方开户行及账号、经办人取票用户、经办人支付信息、经办人商户号、经办人订单号、<span style="text-decoration:underline">货物或应税劳务、服务名称</span>、数量、单价、税率、税额、金额、单位、规格型号、合计税额、合计金额、备注、收款人、复核、开票人、密码区、行业分类
*/
Name: string;
/**
* 识别出的字段名称对应的值,也就是字段Name对应的字符串结果。
*/
Value: string;
/**
* 文本行在旋转纠正之后的图像中的像素坐标。
*/
Rect: Rect;
}
/**
* 增值税发票识别结果
*/
export interface TextVatInvoice {
/**
* 识别出的字段名称(关键字)。支持以下字段的识别:
发票代码、 发票号码、 打印发票代码、 打印发票号码、 开票日期、 购买方识别号、 小写金额、 价税合计(大写)、 销售方识别号、 校验码、 购买方名称、 销售方名称、 税额、 复核、 联次名称、 备注、 联次、 密码区、 开票人、 收款人、 (货物或应税劳务、服务名称)、省、 市、 服务类型、 通行费标志、 是否代开、 是否收购、 合计金额、 是否有公司印章、 发票消费类型、 车船税、 机器编号、 成品油标志、 税率、 合计税额、 (购买方地址、电话)、 (销售方地址、电话)、 单价、 金额、 销售方开户行及账号、 购买方开户行及账号、 规格型号、 发票名称、 单位、 数量、 校验码备选、 校验码后六位备选、发票号码备选、车牌号、类型、通行日期起、通行日期止、发票类型。
*/
Name: string;
/**
* 识别出的字段名称对应的值,也就是字段Name对应的字符串结果。
*/
Value: string;
/**
* 字段在原图中的中的四点坐标。
注意:此字段可能返回 null,表示取不到有效值。
注意:此字段可能返回 null,表示取不到有效值。
*/
Polygon: Polygon;
}
/**
* InstitutionOCR返回参数结构体
*/
export interface InstitutionOCRResponse {
/**
* 注册号
*/
RegId?: string;
/**
* 有效期
*/
ValidDate?: string;
/**
* 住所
*/
Location?: string;
/**
* 名称
*/
Name?: string;
/**
* 法定代表人
*/
LegalPerson?: string;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 机动车销售统一发票信息
*/
export interface VehicleInvoiceInfo {
/**
* 车辆类型
*/
CarType?: string;
/**
* 厂牌型号
*/
PlateModel?: string;
/**
* 产地
*/
ProduceAddress?: string;
/**
* 合格证号
*/
CertificateNo?: string;
/**
* 进口证明书号
*/
ImportNo?: string;
/**
* LSVCA2NP9HN0xxxxx
*/
VinNo?: string;
/**
* 完税证书号
*/
PayTaxesNo?: string;
/**
* 吨位
*/
Tonnage?: string;
/**
* 限乘人数
*/
LimitCount?: string;
/**
* 发动机号码
*/
EngineNo?: string;
/**
* 商检单号
*/
BizCheckFormNo?: string;
/**
* 主管税务机关代码
*/
TaxtationOrgCode?: string;
/**
* 主管税务机关名称
*/
TaxtationOrgName?: string;
/**
* 税率
*/
MotorTaxRate?: string;
/**
* 银行账号
*/
MotorBankName?: string;
/**
* 开户行
*/
MotorBankAccount?: string;
/**
* 销售地址
*/
SellerAddress?: string;
/**
* 销售电话
*/
SellerTel?: string;
/**
* 购方身份证
*/
BuyerNo?: string;
}
/**
* DriverLicenseOCR请求参数结构体
*/
export interface DriverLicenseOCRRequest {
/**
* 图片的 Base64 值。要求图片经Base64编码后不超过 7M,分辨率建议500*800以上,支持PNG、JPG、JPEG、BMP格式。建议卡片部分占据图片2/3以上。
图片的 ImageUrl、ImageBase64 必须提供一个,如果都提供,只使用 ImageUrl。
*/
ImageBase64?: string;
/**
* 图片的 Url 地址。要求图片经Base64编码后不超过 7M,分辨率建议500*800以上,支持PNG、JPG、JPEG、BMP格式。建议卡片部分占据图片2/3以上。图片下载时间不超过 3 秒。
建议图片存储于腾讯云,可保障更高的下载速度和稳定性。
*/
ImageUrl?: string;
/**
* FRONT 为驾驶证主页正面(有红色印章的一面),
BACK 为驾驶证副页正面(有档案编号的一面)。
DOUBLE 支持自动识别驾驶证正副页单面,和正副双面同框识别
默认值为:FRONT。
*/
CardSide?: string;
}
/**
* OtherInvoiceItem
*/
export interface OtherInvoiceItem {
/**
* 票面key值
*/
Name?: string;
/**
* 票面value值
*/
Value?: string;
}
/**
* 文字识别结果
*/
export interface TextDetection {
/**
* 识别出的文本行内容
*/
DetectedText: string;
/**
* 置信度 0 ~100
*/
Confidence: number;
/**
* 文本行坐标,以四个顶点坐标表示
注意:此字段可能返回 null,表示取不到有效值。
*/
Polygon: Array<Coord>;
/**
* 此字段为扩展字段。
GeneralBasicOcr接口返回段落信息Parag,包含ParagNo。
*/
AdvancedInfo: string;
/**
* 文本行在旋转纠正之后的图像中的像素坐标,表示为(左上角x, 左上角y,宽width,高height)
*/
ItemPolygon: ItemCoord;
/**
* 识别出来的单字信息包括单字(包括单字Character和单字置信度confidence), 支持识别的接口:GeneralBasicOCR、GeneralAccurateOCR
*/
Words: Array<DetectedWords>;
/**
* 单字在原图中的四点坐标, 支持识别的接口:GeneralBasicOCR、GeneralAccurateOCR
*/
WordCoordPoint: Array<DetectedWordCoordPoint>;
}
/**
* RecognizeTableOCR返回参数结构体
*/
export interface RecognizeTableOCRResponse {
/**
* 检测到的文本信息,具体内容请点击左侧链接。
*/
TableDetections?: Array<TableDetectInfo>;
/**
* Base64 编码后的 Excel 数据。
*/
Data?: string;
/**
* 图片为PDF时,返回PDF的总页数,默认为0
*/
PdfPageSize?: number;
/**
* 图片旋转角度(角度制),文本的水平方向为0°,统一以逆时针方向旋转,逆时针为负,角度范围为-360°至0°。
*/
Angle?: number;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 数学试题识别结果
*/
export interface TextEduPaper {
/**
* 识别出的字段名称(关键字)
*/
Item: string;
/**
* 识别出的字段名称对应的值,也就是字段Item对应的字符串结果
*/
DetectedText: string;
/**
* 文本行在旋转纠正之后的图像中的像素坐标,表示为(左上角x, 左上角y,宽width,高height)
*/
Itemcoord: ItemCoord;
}
/**
* 增值税发票项目信息
*/
export interface VatInvoiceItemInfo {
/**
* 项目名称
*/
Name?: string;
/**
* 规格型号
*/
Specification?: string;
/**
* 单位
*/
Unit?: string;
/**
* 数量
*/
Quantity?: string;
/**
* 单价
*/
Price?: string;
/**
* 金额
*/
Total?: string;
/**
* 税率
*/
TaxRate?: string;
/**
* 税额
*/
Tax?: string;
/**
* 通行日期起
*/
DateStart?: string;
/**
* 通行日期止
*/
DateEnd?: string;
/**
* 车牌号
*/
LicensePlate?: string;
/**
* 车辆类型
*/
VehicleType?: string;
/**
* 序号
*/
SerialNumber?: string;
}
/**
* QrcodeOCR返回参数结构体
*/
export interface QrcodeOCRResponse {
/**
* 二维码/条形码识别结果信息,具体内容请点击左侧链接。
*/
CodeResults?: Array<QrcodeResultsInfo>;
/**
* 图片大小,具体内容请点击左侧链接。
*/
ImgSize?: QrcodeImgSize;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 运单识别对象
*/
export interface WaybillObj {
/**
* 识别出的文本行内容
*/
Text: string;
}
/**
* 票据检测结果
*/
export interface InvoiceDetectInfo {
/**
* 识别出的图片在混贴票据图片中的旋转角度。
*/
Angle: number;
/**
* 识别出的图片所属的票据类型。
-1:未知类型
0:出租车发票
1:定额发票
2:火车票
3:增值税发票
4:客运限额发票
5:机票行程单
6:酒店账单
7:完税证明
8:通用机打发票
9:汽车票
10:轮船票
11:增值税发票(卷票 )
12:购车发票
13:过路过桥费发票
14:购物小票
*/
Type: number;
/**
* 识别出的图片在混贴票据图片中的位置信息。与Angel结合可以得出原图位置,组成RotatedRect((X+0.5\*Width,Y+0.5\*Height), (Width, Height), Angle),详情可参考OpenCV文档。
*/
Rect: Rect;
/**
* 入参 ReturnImage 为 True 时返回 Base64 编码后的图片。
注意:此字段可能返回 null,表示取不到有效值。
*/
Image: string;
}
/**
* MainlandPermitOCR请求参数结构体
*/
export interface MainlandPermitOCRRequest {
/**
* 图片的 Base64 值。
支持的图片格式:PNG、JPG、JPEG,暂不支持 GIF 格式。
支持的图片大小:所下载图片经Base64编码后不超过 7M。图片下载时间不超过 3 秒。
图片的 ImageUrl、ImageBase64 必须提供一个,如果都提供,只使用 ImageUrl。
*/
ImageBase64?: string;
/**
* 图片的 Url 地址。
支持的图片格式:PNG、JPG、JPEG,暂不支持 GIF 格式。
支持的图片大小:所下载图片经 Base64 编码后不超过 7M。图片下载时间不超过 3 秒。
图片存储于腾讯云的 Url 可保障更高的下载速度和稳定性,建议图片存储于腾讯云。
非腾讯云存储的 Url 速度和稳定性可能受一定影响。
*/
ImageUrl?: string;
/**
* 是否返回头像。默认不返回。
*/
RetProfile?: boolean;
/**
* 图片正反面
FRONT:正面、BACK:反面,默认为FRONT
*/
CardSide?: string;
}
/**
* 电子发票详细条目信息
*/
export interface VatElectronicItemInfo {
/**
* 项目名称
*/
Name?: string;
/**
* 数量
*/
Quantity?: string;
/**
* 规格型号
*/
Specification?: string;
/**
* 单价
*/
Price?: string;
/**
* 金额
*/
Total?: string;
/**
* 税率
*/
TaxRate?: string;
/**
* 税额
*/
Tax?: string;
/**
* 单位
*/
Unit?: string;
/**
* 运输工具类型
*/
VehicleType?: string;
/**
* 运输工具牌号
*/
VehicleBrand?: string;
/**
* 起始地
*/
DeparturePlace?: string;
/**
* 到达地
*/
ArrivalPlace?: string;
/**
* 运输货物名称,仅货物运输服务发票返回
*/
TransportItemsName?: string;
/**
* 建筑服务发生地,仅建筑发票返回
*/
PlaceOfBuildingService?: string;
/**
* 建筑项目名称,仅建筑发票返回
*/
BuildingName?: string;
/**
* 产权证书/不动产权证号,仅不动产经营租赁服务发票返回
*/
EstateNumber?: string;
/**
* 面积单位,仅不动产经营租赁服务发票返回
*/
AreaUnit?: string;
}
/**
* SmartStructuralOCRV2返回参数结构体
*/
export interface SmartStructuralOCRV2Response {
/**
* 图片旋转角度(角度制),文本的水平方向
为 0;顺时针为正,逆时针为负
*/
Angle?: number;
/**
* 配置结构化文本信息
*/
StructuralList?: Array<GroupInfo>;
/**
* 还原文本信息
*/
WordList?: Array<WordItem>;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* EnterpriseLicenseOCR请求参数结构体
*/
export interface EnterpriseLicenseOCRRequest {
/**
* 图片的 Base64 值。
支持的图片格式:PNG、JPG、JPEG,暂不支持 GIF 格式。
支持的图片大小:所下载图片经Base64编码后不超过 7M。图片下载时间不超过 3 秒。
图片的 ImageUrl、ImageBase64 必须提供一个,如果都提供,只使用 ImageUrl。
*/
ImageBase64?: string;
/**
* 图片的 Url 地址。
支持的图片格式:PNG、JPG、JPEG,暂不支持 GIF 格式。
支持的图片大小:所下载图片经 Base64 编码后不超过 7M。图片下载时间不超过 3 秒。
图片存储于腾讯云的 Url 可保障更高的下载速度和稳定性,建议图片存储于腾讯云。
非腾讯云存储的 Url 速度和稳定性可能受一定影响。
*/
ImageUrl?: string;
}
/**
* BankCardOCR请求参数结构体
*/
export interface BankCardOCRRequest {
/**
* 图片的 Base64 值。要求图片经Base64编码后不超过 7M,分辨率建议500*800以上,支持PNG、JPG、JPEG、BMP格式。建议卡片部分占据图片2/3以上。
图片的 ImageUrl、ImageBase64 必须提供一个,如果都提供,只使用 ImageUrl。
*/
ImageBase64?: string;
/**
* 图片的 Url 地址。要求图片经Base64编码后不超过 7M,分辨率建议500*800以上,支持PNG、JPG、JPEG、BMP格式。建议卡片部分占据图片2/3以上。
建议图片存储于腾讯云,可保障更高的下载速度和稳定性。
*/
ImageUrl?: string;
/**
* 是否返回预处理(精确剪裁对齐)后的银行卡图片数据,默认false。
*/
RetBorderCutImage?: boolean;
/**
* 是否返回卡号的切图图片数据,默认false。
*/
RetCardNoImage?: boolean;
/**
* 复印件检测开关,如果输入的图片是银行卡复印件图片则返回告警,默认false。
*/
EnableCopyCheck?: boolean;
/**
* 翻拍检测开关,如果输入的图片是银行卡翻拍图片则返回告警,默认false。
*/
EnableReshootCheck?: boolean;
/**
* 边框遮挡检测开关,如果输入的图片是银行卡边框被遮挡则返回告警,默认false。
*/
EnableBorderCheck?: boolean;
/**
* 是否返回图片质量分数(图片质量分数是评价一个图片的模糊程度的标准),默认false。
*/
EnableQualityValue?: boolean;
}
/**
* 智能结构化识别
*/
export interface StructuralItem {
/**
* 识别出的字段名称(关键字)。
*/
Name: string;
/**
* 识别出的字段名称对应的值。
*/
Value: string;
/**
* 置信度 0 ~100。
*/
Confidence: number;
/**
* 文本行在旋转纠正之后的图像中的像素
坐标。
*/
ItemCoord: ItemCoord;
/**
* 字段所在行号,下标从0开始,非行字段或未能识别行号的该值返回-1。
*/
Row: number;
}
/**
* 网约车行程单识别结果
*/
export interface OnlineTaxiItineraryInfo {
/**
* 识别出的字段名称(关键字),支持以下字段:
发票代码、 机打代码、 发票号码、 发动机号码、 合格证号、 机打号码、 价税合计(小写)、 销货单位名称、 身份证号码/组织机构代码、 购买方名称、 销售方纳税人识别号、 购买方纳税人识别号、主管税务机关、 主管税务机关代码、 开票日期、 不含税价(小写)、 吨位、增值税税率或征收率、 车辆识别代号/车架号码、 增值税税额、 厂牌型号、 省、 市、 发票消费类型、 销售方电话、 销售方账号、 产地、 进口证明书号、 车辆类型、 机器编号、备注、开票人、限乘人数、商检单号、销售方地址、销售方开户银行、价税合计、发票类型。
*/
Name: string;
/**
* 识别出的字段名称对应的值,也就是字段name对应的字符串结果。
*/
Value: string;
/**
* 字段所在行,下标从0开始,非行字段或未能识别行号的返回-1
*/
Row: number;
}
/**
* 机票详细信息元组
*/
export interface FlightItemInfo {
/**
* 出发站
*/
TerminalGetOn?: string;
/**
* 到达站
*/
TerminalGetOff?: string;
/**
* 承运人
*/
Carrier?: string;
/**
* 航班号
*/
FlightNumber?: string;
/**
* 座位等级
*/
Seat?: string;
/**
* 乘机日期
*/
DateGetOn?: string;
/**
* 乘机时间
*/
TimeGetOn?: string;
/**
* 客票级别/客票类别
*/
FareBasis?: string;
/**
* 免费行李额
*/
Allow?: string;
}
/**
* VehicleRegCertOCR请求参数结构体
*/
export interface VehicleRegCertOCRRequest {
/**
* 图片的 Base64 值。
支持的图片格式:PNG、JPG、JPEG,暂不支持 GIF 格式。
支持的图片大小:所下载图片经Base64编码后不超过 7M。图片下载时间不超过 3 秒。
图片的 ImageUrl、ImageBase64 必须提供一个,如果都提供,只使用 ImageUrl。
*/
ImageBase64?: string;
/**
* 图片的 Url 地址。
支持的图片格式:PNG、JPG、JPEG,暂不支持 GIF 格式。
支持的图片大小:所下载图片经 Base64 编码后不超过 7M。图片下载时间不超过 3 秒。
图片存储于腾讯云的 Url 可保障更高的下载速度和稳定性,建议图片存储于腾讯云。
非腾讯云存储的 Url 速度和稳定性可能受一定影响。
*/
ImageUrl?: string;
}
/**
* PropOwnerCertOCR返回参数结构体
*/
export interface PropOwnerCertOCRResponse {
/**
* 房地产权利人
*/
Owner?: string;
/**
* 共有情况
*/
Possession?: string;
/**
* 登记时间
*/
RegisterTime?: string;
/**
* 规划用途
*/
Purpose?: string;
/**
* 房屋性质
*/
Nature?: string;
/**
* 房地坐落
*/
Location?: string;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 金融票据整单识别单个字段的内容
*/
export interface FinanBillInfo {
/**
* 识别出的字段名称(关键字),支持以下字段:
【进账单】
日期、出票全称、出票账号、出票开户行、收款人全称、收款人账号、收款开户行、大写金额、小写金额、票据种类、票据张数、票据号码;
【支票】
开户银行、支票种类、凭证号码2、日期、大写金额、小写金额、付款行编号、密码、凭证号码1;
【银行承兑汇票】或【商业承兑汇票】
出票日期、行号1、行号2、出票人全称、出票人账号、付款行全称、收款人全称、收款人账号、收款人开户行、出票金额大写、出票金额小写、汇票到期日、付款行行号、付款行地址。
*/
Name: string;
/**
* 识别出的字段名称对应的值,也就是字段Name对应的字符串结果。
*/
Value: string;
}
/**
* TrainTicketOCR返回参数结构体
*/
export interface TrainTicketOCRResponse {
/**
* 编号
*/
TicketNum?: string;
/**
* 出发站
*/
StartStation?: string;
/**
* 到达站
*/
DestinationStation?: string;
/**
* 出发时间
*/
Date?: string;
/**
* 车次
*/
TrainNum?: string;
/**
* 座位号
*/
Seat?: string;
/**
* 姓名
*/
Name?: string;
/**
* 票价
*/
Price?: string;
/**
* 席别
*/
SeatCategory?: string;
/**
* 身份证号
*/
ID?: string;
/**
* 发票消费类型:交通
*/
InvoiceType?: string;
/**
* 序列号
*/
SerialNumber?: string;
/**
* 加收票价
*/
AdditionalCost?: string;
/**
* 手续费
*/
HandlingFee?: string;
/**
* 大写金额(票面有大写金额该字段才有值)
*/
LegalAmount?: string;
/**
* 售票站
*/
TicketStation?: string;
/**
* 原票价(一般有手续费的才有原始票价字段)
*/
OriginalPrice?: string;
/**
* 发票类型:火车票、火车票补票、火车票退票凭证
*/
InvoiceStyle?: string;
/**
* 收据号码
*/
ReceiptNumber?: string;
/**
* 仅供报销使用:1为是,0为否
*/
IsReceipt?: string;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* RecognizePhilippinesTinIDOCR返回参数结构体
*/
export interface RecognizePhilippinesTinIDOCRResponse {
/**
* 人像照片Base64后的结果
*/
HeadPortrait: TextDetectionResult;
/**
* 编码
*/
LicenseNumber: TextDetectionResult;
/**
* 姓名
*/
FullName: TextDetectionResult;
/**
* 地址
*/
Address: TextDetectionResult;
/**
* 生日
*/
Birthday: TextDetectionResult;
/**
* 发证日期
*/
IssueDate: TextDetectionResult;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 过路过桥费字段信息
*/
export interface TollInvoiceInfo {
/**
* 识别出的字段名称(关键字)。支持以下字段的识别:
发票代码、发票号码、日期、金额、入口、出口、时间、发票消费类型、高速标志。
*/
Name: string;
/**
* 识别出的字段名称对应的值,也就是字段Name对应的字符串结果。
*/
Value: string;
/**
* 文本行在旋转纠正之后的图像中的像素坐标。
*/
Rect: Rect;
}
/**
* 银行回单识别出的字段
*/
export interface BankSlipInfo {
/**
* 识别出的字段名称(关键字),支持以下字段:
付款开户行、收款开户行、付款账号、收款账号、回单类型、回单编号、币种、流水号、凭证号码、交易机构、交易金额、手续费、日期等字段信息。
*/
Name: string;
/**
* 识别出的字段名称对应的值,也就是字段Name对应的字符串结果。
*/
Value: string;
/**
* 文本行在旋转纠正之后的图像中的像素坐标。
*/
Rect: Rect;
}
/**
* ArithmeticOCR返回参数结构体
*/
export interface ArithmeticOCRResponse {
/**
* 检测到的文本信息,具体内容请点击左侧链接。
*/
TextDetections?: Array<TextArithmetic>;
/**
* 图片横屏的角度(90度或270度)
*/
Angle?: number;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* FormulaOCR返回参数结构体
*/
export interface FormulaOCRResponse {
/**
* 图片旋转角度(角度制),文本的水平方向为0°;顺时针为正,逆时针为负
*/
Angle?: number;
/**
* 检测到的文本信息,具体内容请点击左侧链接。
*/
FormulaInfos?: Array<TextFormula>;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 汽车票字段信息
*/
export interface BusInvoiceInfo {
/**
* 识别出的字段名称(关键字),支持以下字段:
发票代码、发票号码、日期、票价、始发地、目的地、姓名、时间、发票消费类型、身份证号、省、市、开票日期、乘车地点、检票口、客票类型、车型、座位号、车次。
*/
Name: string;
/**
* 识别出的字段名称对应的值,也就是字段Name对应的字符串结果。
*/
Value: string;
/**
* 文本行在旋转纠正之后的图像中的像素坐标。
*/
Rect: Rect;
}
/**
* SmartStructuralOCR请求参数结构体
*/
export interface SmartStructuralOCRRequest {
/**
* 图片的 Url 地址。
支持的图片格式:PNG、JPG、JPEG,暂不支持 GIF 格式。
支持的图片大小:所下载图片经 Base64 编码后不超过 7M。图片下载时间不超过 3 秒。
图片存储于腾讯云的 Url 可保障更高的下载速度和稳定性,建议图片存储于腾讯云。
非腾讯云存储的 Url 速度和稳定性可能受一定影响。
*/
ImageUrl?: string;
/**
* 图片的 Base64 值。
支持的图片格式:PNG、JPG、JPEG,暂不支持 GIF 格式。
支持的图片大小:所下载图片经Base64编码后不超过 7M。图片下载时间不超过 3 秒。
图片的 ImageUrl、ImageBase64 必须提供一个,如果都提供,只使用 ImageUrl。
*/
ImageBase64?: string;
/**
* 自定义结构化功能需返回的字段名称,例:
若客户只想返回姓名、性别两个字段的识别结果,则输入
ItemNames=["姓名","性别"]
*/
ItemNames?: Array<string>;
/**
* 是否开启PDF识别,默认值为false,开启后可同时支持图片和PDF的识别。
*/
IsPdf?: boolean;
/**
* 需要识别的PDF页面的对应页码,仅支持PDF单页识别,当上传文件为PDF且IsPdf参数值为true时有效,默认值为1。
*/
PdfPageNumber?: number;
/**
* 是否开启全文字段识别,默认值为false,开启后可返回全文字段识别结果。
*/
ReturnFullText?: boolean;
}
/**
* 单元格数据
*/
export interface TableCellInfo {
/**
* 单元格左上角的列索引
*/
ColTl: number;
/**
* 单元格左上角的行索引
*/
RowTl: number;
/**
* 单元格右下角的列索引
*/
ColBr: number;
/**
* 单元格右下角的行索引
*/
RowBr: number;
/**
* 单元格内识别出的字符串文本,若文本存在多行,以换行符"\n"隔开
*/
Text: string;
/**
* 单元格类型
*/
Type: string;
/**
* 单元格置信度
*/
Confidence: number;
/**
* 单元格在图像中的四点坐标
*/
Polygon: Array<Coord>;
}
/**
* GeneralHandwritingOCR请求参数结构体
*/
export interface GeneralHandwritingOCRRequest {
/**
* 图片的 Base64 值。
支持的图片格式:PNG、JPG、JPEG,暂不支持 GIF 格式。
支持的图片大小:所下载图片经Base64编码后不超过 7M。图片下载时间不超过 3 秒。
图片的 ImageUrl、ImageBase64 必须提供一个,如果都提供,只使用 ImageUrl。
*/
ImageBase64?: string;
/**
* 图片的 Url 地址。
支持的图片格式:PNG、JPG、JPEG,暂不支持 GIF 格式。
支持的图片大小:所下载图片经 Base64 编码后不超过7M。图片下载时间不超过 3 秒。
图片存储于腾讯云的 Url 可保障更高的下载速度和稳定性,建议图片存储于腾讯云。
非腾讯云存储的 Url 速度和稳定性可能受一定影响。
*/
ImageUrl?: string;
/**
* 场景字段,默认不用填写。
可选值:only_hw 表示只输出手写体识别结果,过滤印刷体。
*/
Scene?: string;
/**
* 是否开启单字的四点定位坐标输出,默认值为false。
*/
EnableWordPolygon?: boolean;
/**
* 文本检测开关,默认值为true。
设置为false表示直接进行单行识别,可适用于识别单行手写体签名场景。
*/
EnableDetectText?: boolean;
}
/**
* BizLicenseOCR请求参数结构体
*/
export interface BizLicenseOCRRequest {
/**
* 图片的 Base64 值。
支持的图片格式:PNG、JPG、JPEG,暂不支持 GIF 格式。
支持的图片大小:所下载图片经Base64编码后不超过 7M。图片下载时间不超过 3 秒。
图片的 ImageUrl、ImageBase64 必须提供一个,如果都提供,只使用 ImageUrl。
*/
ImageBase64?: string;
/**
* 图片的 Url 地址。
支持的图片格式:PNG、JPG、JPEG,暂不支持 GIF 格式。
支持的图片大小:所下载图片经 Base64 编码后不超过 7M。图片下载时间不超过 3 秒。
图片存储于腾讯云的 Url 可保障更高的下载速度和稳定性,建议图片存储于腾讯云。
非腾讯云存储的 Url 速度和稳定性可能受一定影响。
*/
ImageUrl?: string;
/**
* 是否返回黑白复印件告警码,默认为false
*/
EnableCopyWarn?: boolean;
}
/**
* MixedInvoiceDetect返回参数结构体
*/
export interface MixedInvoiceDetectResponse {
/**
* 检测出的票据类型列表,具体内容请点击左侧链接。
*/
InvoiceDetectInfos?: Array<InvoiceDetectInfo>;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* RecognizePhilippinesVoteIDOCR返回参数结构体
*/
export interface RecognizePhilippinesVoteIDOCRResponse {
/**
* 人像照片Base64后的结果
*/
HeadPortrait?: TextDetectionResult;
/**
* 菲律宾VoteID的VIN
*/
VIN?: TextDetectionResult;
/**
* 姓名
*/
FirstName?: TextDetectionResult;
/**
* 姓氏
*/
LastName?: TextDetectionResult;
/**
* 出生日期
*/
Birthday?: TextDetectionResult;
/**
* 婚姻状况
*/
CivilStatus?: TextDetectionResult;
/**
* 国籍
*/
Citizenship?: TextDetectionResult;
/**
* 地址
*/
Address?: TextDetectionResult;
/**
* 地区
*/
PrecinctNo?: TextDetectionResult;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 发票人员信息
*/
export interface VatInvoiceUserInfo {
/**
* 名称
*/
Name: string;
/**
* 纳税人识别号
*/
TaxId: string;
/**
* 地 址、电 话
*/
AddrTel: string;
/**
* 开户行及账号
*/
FinancialAccount: string;
}
/**
* 通用机打发票条目
*/
export interface GeneralMachineItem {
/**
* 项目名称
*/
Name?: string;
/**
* 规格型号
*/
Specification?: string;
/**
* 单位
*/
Unit?: string;
/**
* 数量
*/
Quantity?: string;
/**
* 单价
*/
Price?: string;
/**
* 金额
*/
Total?: string;
/**
* 税率
*/
TaxRate?: string;
/**
* 税额
*/
Tax?: string;
}
/**
* GeneralAccurateOCR返回参数结构体
*/
export interface GeneralAccurateOCRResponse {
/**
* 检测到的文本信息,包括文本行内容、置信度、文本行坐标以及文本行旋转纠正后的坐标,具体内容请点击左侧链接。
*/
TextDetections?: Array<TextDetection>;
/**
* 图片旋转角度(角度制),文本的水平方向为0°;顺时针为正,逆时针为负。点击查看<a href="https://cloud.tencent.com/document/product/866/45139">如何纠正倾斜文本</a>
* @deprecated
*/
Angel?: number;
/**
* 图片旋转角度(角度制),文本的水平方向为0°;顺时针为正,逆时针为负。点击查看<a href="https://cloud.tencent.com/document/product/866/45139">如何纠正倾斜文本</a>
*/
Angle?: number;
/**
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 电子发票(火车票)
*/
export interface ElectronicTrainTicketFull {
/**
* 电子发票类型
*/
TypeOfVoucher?: string;
/**
* 电子客票号
*/
ElectronicTicketNum?: string;
/**
* 开票日期
*/
Date?: string;
/**
* 始发站
*/
StationGetOn?: string;
/**
* 到达站
*/
StationGetOff?: string;
/**
* 火车号
*/
TrainNumber?: string;
/**
* 乘车日期
*/
DateGetOn?: string;
/**
* 始发时间
*/
TimeGetOn?: string;
/**
* 座位类型
*/
Seat?: string;
/**
* 座位号
*/
SeatNumber?: string;
/**
* 票价
*/
Fare?: string;
/**
* 发票号码
*/
Number?: string;
/**
* 身份证号
*/
UserID?: string;
/**
* 乘车人姓名
*/
UserName?: string;
/**
* 金额
*/
Total?: string;
/**
* 税率
*/
TaxRate?: string;
/**
* 税额
*/
Tax?: string;
/**
* 购买方名称
*/
Buyer?: string;
/**
* 统一社会信用代码
*/
BuyerTaxID?: string;
/**
* 原发票号码
*/
OriginalNumber?: string;
}
/**
* 汽车票
*/
export interface BusInvoice {
/**
* 发票名称
*/
Title?: string;
/**
* 是否存在二维码(1:有,0:无)
*/
QRCodeMark?: number;
/**
* 发票号码
*/
Number?: string;
/**
* 发票代码
*/
Code?: string;
/**
* 开票日期
*/
Date?: string;
/**
* 乘车时间
*/
TimeGetOn?: string;
/**
* 乘车日期
*/
DateGetOn?: string;
/**
* 出发车站
*/
StationGetOn?: string;
/**
* 到达车站
*/
StationGetOff?: string;
/**
* 票价
*/
Total?: string;
/**
* 姓名
*/
UserName?: string;
/**
* 消费类型
*/
Kind?: string;
/**
* 身份证号
*/
UserID?: string;
/**
* 省
*/
Province?: string;
/**
* 市
*/
City?: string;
/**
* 乘车地点
*/
PlaceGetOn?: string;
/**
* 检票口
*/
GateNumber?: string;
/**
* 客票类型
*/
TicketType?: string;
/**
* 车型
*/
VehicleType?: string;
/**
* 座位号
*/
SeatNumber?: string;
/**
* 车次
*/
TrainNumber?: string;
}
/**
* 定额发票
*/
export interface QuotaInvoice {
/**
* 发票名称
*/
Title?: string;
/**
* 发票代码
*/
Code?: string;
/**
* 发票号码
*/
Number?: string;
/**
* 价税合计(小写)
*/
Total?: string;
/**
* 价税合计(大写)
*/
TotalCn?: string;
/**
* 发票消费类型
*/
Kind?: string;
/**
* 省
*/
Province?: string;
/**
* 市
*/
City?: string;
/**
* 是否存在二维码(1:有,0:无)
*/
QRCodeMark?: number;
/**
* 是否有公司印章(0:没有,1:有)
*/
CompanySealMark?: number;
}
/**
* TaxiInvoiceOCR返回参数结构体
*/
export interface TaxiInvoiceOCRResponse {
/**
* 发票代码
*/
InvoiceNum?: string;
/**
* 发票号码
*/
InvoiceCode?: string;
/**
* 日期
*/
Date?: string;
/**
* 金额
*/
Fare?: string;
/**