tencentcloud-sdk-nodejs

/** * TableOCR请求参数结构体 */ export interface TableOCRRequest { /** * 图片的 Base64 值。支持的图片格式：PNG、JPG、JPEG，暂不支持 GIF 格式。支持的图片大小：所下载图片经Base64编码后不超过 3M。图片下载时间不超过 3 秒。图片的 ImageUrl、ImageBase64 必须提供一个，如果都提供，只使用 ImageUrl。 */ ImageBase64?: string; /** * 图片的 Url 地址。支持的图片格式：PNG、JPG、JPEG，暂不支持 GIF 格式。支持的图片大小：所下载图片经 Base64 编码后不超过 3M。图片下载时间不超过 3 秒。图片存储于腾讯云的 Url 可保障更高的下载速度和稳定性，建议图片存储于腾讯云。非腾讯云存储的 Url 速度和稳定性可能受一定影响。 */ ImageUrl?: string; } /** * 门头照识别结果 */ export interface StoreInfo { /** * 识别出的字段名称(关键字)，如商店名称 */ Name?: string; /** * 识别出的字段名称对应的值，也就是字段Name对应的字符串结果。 */ Value?: string; /** * 文本行在旋转纠正之后的图像中的像素坐标 */ Rect?: Rect; } /** * 非税收入条目 */ export interface NonTaxItem { /** * 项目编码 */ ItemID?: string; /** * 项目名称 */ Name?: string; /** * 单位 */ Unit?: string; /** * 数量 */ Quantity?: string; /** * 标准 */ Standard?: string; /** * 金额 */ Total?: string; } /** * 用于展示抽取出的信息 */ export interface FieldsInfo { /** * 用户自定义的提取字段名。 */ KeyName?: string; /** * 用户自定义的提取字段名的提示词。 */ KeyPrompt?: string; /** * 出参字段对应的值。注意：此字段可能返回 null，表示取不到有效值。 */ KeyValue?: string; /** * 出参类型。注：与入参对应同个值。 */ KeyType?: number; /** * 文本行坐标，以四个顶点坐标表示。注：仅当入参EnableCoord不为null时生效，默认是false。 */ Polygon?: CoordList; /** * 嵌套FieldsInfo结构，仅当KeyType=1时有效。 */ SubItems?: Array<SubItemGroup>; } /** * 表格识别结果 */ export interface TextTable { /** * 单元格左上角的列索引 */ ColTl?: number; /** * 单元格左上角的行索引 */ RowTl?: number; /** * 单元格右下角的列索引 */ ColBr?: number; /** * 单元格右下角的行索引 */ RowBr?: number; /** * 单元格文字 */ Text?: string; /** * 单元格类型，包含body（表格主体）、header（表头）、footer（表尾）三种 */ Type?: string; /** * 置信度 0 ~100 */ Confidence?: number; /** * 文本行坐标，以四个顶点坐标表示 */ Polygon?: Array<Coord>; /** * 此字段为扩展字段 */ AdvancedInfo?: 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：医疗发票 18：完税凭证 19：海关缴款书 20：银行回单 */ 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; /** * 该发票中所有字段坐标信息。包括字段英文名称、字段值所在位置四点坐标、字段所属行号，具体内容请点击左侧链接。字段在原始图的坐标可以根据Polygon转换得出。 */ ItemPolygon?: Array<ItemPolygonInfo>; /** * 二维码数据。 */ QRCode?: string; /** * 印章信息 */ InvoiceSealInfo?: InvoiceSealInfo; } /** * HKIDCardOCR请求参数结构体 */ export interface HKIDCardOCRRequest { /** * 是否返回人像照片。 */ ReturnHeadImage?: boolean; /** * 是否鉴伪。 * @deprecated */ DetectFake?: boolean; /** * 图片的 Base64 值。支持的图片格式：PNG、JPG、JPEG，暂不支持 GIF 格式。支持的图片大小：所下载图片经Base64编码后不超过 10M。图片下载时间不超过 3 秒。 */ ImageBase64?: string; /** * 图片的 Url 地址。支持的图片格式：PNG、JPG、JPEG，暂不支持 GIF 格式。支持的图片大小：所下载图片经 Base64 编码后不超过 10M。图片下载时间不超过 3 秒。图片存储于腾讯云的 Url 可保障更高的下载速度和稳定性，建议图片存储于腾讯云。非腾讯云存储的 Url 速度和稳定性可能受一定影响。 */ ImageUrl?: string; } /** * 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。 */ RequestId?: string; } /** * VinOCR返回参数结构体 */ export interface VinOCRResponse { /** * 检测到的车辆 VIN 码。 */ Vin?: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 港澳台居住证信息返回 */ export interface ResidencePermitInfo { /** * 姓名（人像面） */ Name?: ContentInfo; /** * 性别（人像面） */ Sex?: ContentInfo; /** * 民族（人像面） */ Nation?: ContentInfo; /** * 出生日期（人像面） */ Birth?: ContentInfo; /** * 地址（人像面） */ Address?: ContentInfo; /** * 公民身份号码（人像面） */ IdNum?: ContentInfo; /** * 发证机关（国徽面） */ Authority?: ContentInfo; /** * 证件有效期（国徽面） */ ValidDate?: ContentInfo; /** * WarnInfos，告警信息 */ WarnInfos?: CardWarnInfo; /** * IdCard，裁剪后身份证照片的base64编码，请求 EnableCropImage 时返回； */ CardImage?: ContentInfo; /** * Portrait，身份证头像照片的base64编码，请求 EnablePortrait 时返回； */ PortraitImage?: ContentInfo; /** * 通行证号码，港澳台居住证国徽面返回该字段 */ PassNum?: ContentInfo; /** * 签发次数，港澳台居住证国徽面返回该字段 */ IssueNum?: ContentInfo; } /** * BankCardOCR请求参数结构体 */ export interface BankCardOCRRequest { /** * 图片的 Base64 值。要求图片经Base64编码后不超过 10M，分辨率建议500*800以上，支持PNG、JPG、JPEG、BMP格式。建议卡片部分占据图片2/3以上。图片的 ImageUrl、ImageBase64 必须提供一个，如果都提供，只使用 ImageUrl。 */ ImageBase64?: string; /** * 图片的 Url 地址。要求图片经Base64编码后不超过 10M，分辨率建议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; } /** * VatInvoiceVerifyNew返回参数结构体 */ export interface VatInvoiceVerifyNewResponse { /** * 增值税发票、购车发票、全电发票的基础要素字段信息。 */ Invoice?: VatInvoice; /** * 机动车销售统一发票详细字段信息。 */ VehicleInvoiceInfo?: VehicleInvoiceInfo; /** * 二手车销售统一发票详细字段信息。 */ UsedVehicleInvoiceInfo?: UsedVehicleInvoiceInfo; /** * 通行费发票详细字段信息。 */ PassInvoiceInfoList?: Array<PassInvoiceInfo>; /** * 全电发票（铁路电子客票）详细字段信息。 */ ElectronicTrainTicket?: ElectronicTrainTicket; /** * 全电发票（航空运输电子客票行程单）详细字段信息。 */ ElectronicAirTransport?: ElectronicAirTransport; /** * 财政发票详细字段信息 */ FinancialBill?: FinancialBill; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CarInvoiceOCR请求参数结构体 */ export interface CarInvoiceOCRRequest { /** * 图片的 Base64 值。支持的图片格式：PNG、JPG、JPEG，暂不支持 GIF 格式。支持的图片大小：所下载图片经Base64编码后不超过 10M。图片下载时间不超过 3 秒。图片的 ImageUrl、ImageBase64 必须提供一个，如果都提供，只使用 ImageUrl。 */ ImageBase64?: string; /** * 图片的 Url 地址。支持的图片格式：PNG、JPG、JPEG，暂不支持 GIF 格式。支持的图片大小：所下载图片经 Base64 编码后不超过 10M。图片下载时间不超过 3 秒。图片存储于腾讯云的 Url 可保障更高的下载速度和稳定性，建议图片存储于腾讯云。非腾讯云存储的 Url 速度和稳定性可能受一定影响。 */ ImageUrl?: string; /** * 是否开启PDF识别，默认值为true，开启后可同时支持图片和PDF的识别。 */ IsPdf?: boolean; /** * 需要识别的PDF页面的对应页码，仅支持PDF单页识别，当上传文件为PDF且IsPdf参数值为true时有效，默认值为1。 */ PdfPageNumber?: number; } /** * DescribeQuestionMarkAgentJob返回参数结构体 */ export interface DescribeQuestionMarkAgentJobResponse { /** * 任务执行错误码。当任务状态不为 FAIL 时，该值为""。 */ ErrorCode?: string; /** * 任务执行错误信息。当任务状态不为 FAIL 时，该值为""。 */ ErrorMessage?: string; /** * 任务状态。WAIT：等待中，RUN：执行中，FAIL：任务失败，DONE：任务成功 */ JobStatus?: string; /** * 图片旋转角度(角度制)，文本的水平方向为 0；顺时针为正，逆时针为负。 */ Angle?: number; /** * 试题批改信息 */ MarkInfos?: Array<MarkInfo>; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 坐标数组 */ export interface CoordList { /** * 左上角坐标。 */ TopLeft?: Coord; /** * 右上角坐标。 */ TopRight?: Coord; /** * 左下角坐标。 */ BottomLeft?: Coord; /** * 右下角坐标。 */ BottomRight?: Coord; } /** * ExtractDocMulti请求参数结构体 */ export interface ExtractDocMultiRequest { /** * 图片/PDF的 Url 地址。要求图片经Base64编码后不超过10M，分辨率建议600*800以上，支持PNG、JPG、JPEG、BMP、PDF格式。图片下载时间不超过 3 秒。图片存储于腾讯云的 Url 可保障更高的下载速度和稳定性，建议图片存储于腾讯云。非腾讯云存储的 Url 速度和稳定性可能受一定影响。 */ ImageUrl?: string; /** * 图片/PDF的 Base64 值。要求Base64不超过10M，分辨率建议600*800以上，支持PNG、JPG、JPEG、BMP、PDF格式。图片的 ImageUrl、ImageBase64 必须提供一个，如果都提供，只使用 ImageUrl。 */ ImageBase64?: string; /** * 需要识别的PDF页面的对应页码，仅支持PDF单页识别，默认值为前3页。 */ PdfPageNumber?: number; /** * 自定义结构化功能需返回的字段名称，例：若客户想新增返回姓名、性别两个字段的识别结果，则输入ItemNames=["姓名","性别"] */ ItemNames?: Array<string>; /** * true：仅输出自定义字段 false：输出默认字段+自定义字段默认true */ ItemNamesShowMode?: boolean; /** * 是否开启全文字段识别 */ ReturnFullText?: boolean; /** * 配置id支持： General -- 通用场景 InvoiceEng -- 国际invoice模板 WayBillEng --海运订单模板 CustomsDeclaration -- 进出口报关单 WeightNote -- 磅单 MedicalMeter -- 血压仪表识别 BillOfLading -- 海运提单 EntrustmentBook -- 海运托书 Statement -- 对账单识别模板 BookingConfirmation -- 配舱通知书识别模板 AirWayBill -- 航空运单识别模板 Table -- 表格模板 SteelLabel -- 实物标签识别模板 CarInsurance -- 车辆保险单识别模板 MultiRealEstateCertificate -- 房产材料识别模板 MultiRealEstateMaterial -- 房产证明识别模板 HongKongUtilityBill -- 中国香港水电煤单识别模板 OverseasCheques -- 海外支票 RegistrationCertificate -- 备案证 GridPhoto -- 电网系统照片 SignaturePage -- 签署页 SalesDeliveryNote -- 销售发货单 */ ConfigId?: string; /** * 是否开启全文字段坐标值的识别 */ EnableCoord?: boolean; /** * 是否开启父子key识别，默认是 */ OutputParentKey?: boolean; /** * 模板的单个属性配置 */ ConfigAdvanced?: ConfigAdvanced; /** * cn时，添加的key为中文 en时，添加的key为英语 */ OutputLanguage?: string; } /** * QuestionSplitLayoutOCR请求参数结构体 */ export interface QuestionSplitLayoutOCRRequest { /** * 图片/PDF的 Url 地址。要求图片经Base64编码后不超过10M，分辨率建议600*800以上，支持PNG、JPG、JPEG、BMP、PDF格式。图片下载时间不超过 3 秒。图片存储于腾讯云的 Url 可保障更高的下载速度和稳定性，建议图片存储于腾讯云。非腾讯云存储的 Url 速度和稳定性可能受一定影响。 */ ImageUrl?: string; /** * 图片/PDF的 Base64 值。要求Base64不超过10M，分辨率建议600*800以上，支持PNG、JPG、JPEG、BMP、PDF格式。图片的 ImageUrl、ImageBase64 必须提供一个，如果都提供，只使用 ImageUrl。 */ ImageBase64?: string; /** * 是否开启PDF识别，默认值为false，开启后可同时支持图片和PDF的识别。 */ IsPdf?: boolean; /** * 需要识别的PDF页面的对应页码，仅支持PDF单页识别，当上传文件为PDF且IsPdf参数值为true时有效，默认值为1。 */ PdfPageNumber?: number; /** * 是否开启切边增强和弯曲矫正,默认为false不开启 */ EnableImageCrop?: boolean; /** * false: 使用当前默认模型返回结构化信息更全面，但检测精度一般 true: 使用多模态推理模型，速度更快精度更高，但只返回题目最外层边框 API默认false, demo默认使用的是true */ UseNewModel?: boolean; } /** * DescribeMarkEssayAgentJob返回参数结构体 */ export interface DescribeMarkEssayAgentJobResponse { /** * 图片旋转角度(角度制)，文本的水平方向为 0；顺时针为正，逆时针为负。 */ Angle?: number; /** * 配置结构化文本信息。 */ SentenceSuggests?: Array<MarkEssaySuggestions>; /** * 任务执行错误码。当任务状态不为 FAIL 时，该值为""。 */ ErrorCode?: string; /** * 任务执行错误信息。当任务状态不为 FAIL 时，该值为""。 */ ErrorMessage?: string; /** * 任务状态。WAIT：等待中，RUN：执行中，FAIL：任务失败，DONE：任务成功 */ JobStatus?: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 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。 */ RequestId?: string; } /** * ExtractDocMultiPro请求参数结构体 */ export interface ExtractDocMultiProRequest { /** * 图片/PDF的 Url 地址。要求图片经Base64编码后不超过10M，分辨率建议600*800以上，支持PNG、JPG、JPEG、BMP、PDF格式。图片下载时间不超过 3 秒。图片存储于腾讯云的 Url 可保障更高的下载速度和稳定性，建议图片存储于腾讯云。非腾讯云存储的 Url 速度和稳定性可能受一定影响。 */ ImageUrl?: string; /** * 图片/PDF的 Base64 值。要求Base64不超过10M，分辨率建议600*800以上，支持PNG、JPG、JPEG、BMP、PDF格式。图片的 ImageUrl、ImageBase64 必须提供一个，如果都提供，只使用 ImageUrl。 */ ImageBase64?: string; /** * 需要识别的PDF页面的对应页码，仅支持PDF单页识别，当上传文件为PDF且IsPdf参数值为true时有效，默认值为前3页。 */ PdfPageNumber?: number; /** * 自定义结构化功能需返回的字段名称，例：若客户想新增返回姓名、性别两个字段的识别结果，则输入ItemNames=["姓名","性别"] */ ItemNames?: Array<string>; /** * true：仅输出自定义字段 flase：输出默认字段+自定义字段默认true */ ItemNamesShowMode?: boolean; /** * 是否开启全文字段识别 */ ReturnFullText?: boolean; /** * 配置id支持： DispatchWeightNote -- 磅单发货单识别模板 ReceiptWeightNote -- 磅单收货单识别模板默认：DispatchWeightNote */ ConfigId?: string; /** * 是否开启全文字段坐标值的识别 */ EnableCoord?: boolean; /** * 是否开启父子key识别，默认是 */ OutputParentKey?: boolean; /** * 模板的单个属性配置 */ ConfigAdvanced?: ConfigAdvanced; } /** * 还原文本信息 */ export interface WordItem { /** * 文本块内容 */ DetectedText?: string; /** * 四点坐标 */ Coord?: Polygon; /** * 描述性信息 */ AdvancedInfo?: string; /** * 单词的四点坐标 */ WordCoord?: Array<WordPolygon>; } /** * MLIDPassportOCR请求参数结构体 */ export interface MLIDPassportOCRRequest { /** * 图片的 Base64 值。要求图片经Base64编码后不超过 10M，分辨率建议500*800以上，支持PNG、JPG、JPEG、BMP、PDF格式。建议卡片部分占据图片2/3以上。 */ ImageBase64?: string; /** * 是否返回图片，默认false */ RetImage?: boolean; /** * 图片的 Url 地址。要求图片经Base64编码后不超过 10M，分辨率建议500*800以上，支持PNG、JPG、JPEG、BMP、PDF格式。建议卡片部分占据图片2/3以上。图片下载时间不超过 3 秒。建议图片存储于腾讯云，可保障更高的下载速度和稳定性。 */ ImageUrl?: string; } /** * 海外发票 */ export interface OverseasInvoice { /** * 发票名称 */ Title?: string; /** * 识别出的字段名称(关键字) */ Content?: Array<OtherInvoiceItem>; } /** * 文档智能元素组 */ export interface ItemInfo { /** * key信息组 注意：此字段可能返回 null，表示取不到有效值。 */ Key?: Key; /** * Value信息组 注意：此字段可能返回 null，表示取不到有效值。 */ Value?: Value; /** * 返回这个字段是否比对审核通过默认值：false */ AuditResult?: boolean; } /** * TextDetect返回参数结构体 */ export interface TextDetectResponse { /** * 图片中是否包含文字。 */ HasText?: boolean; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 完税凭证 */ export interface TaxPayment { /** * 发票名称 */ Title?: string; /** * 识别出的字段名称(关键字)，支持以下字段：税号、纳税人识别号、纳税人名称、金额合计大写、金额合计小写、填发日期、税务机关、填票人。示例值：纳税人识别号 */ Content?: Array<OtherInvoiceItem>; /** * 表格。 */ TableItems?: Array<OtherInvoiceList>; } /** * GetOCRToken返回参数结构体 */ export interface GetOCRTokenResponse { /** * token值 */ OCRToken?: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 身份证ocr信息结果 */ export interface IDCardInfoResult { /** * 警告代码注意：此字段可能返回 null，表示取不到有效值。 */ WarnCodes?: Array<number | bigint>; /** * 地址（人像面）注意：此字段可能返回 null，表示取不到有效值。 */ Address?: string; /** * 发证机关（国徽面）注意：此字段可能返回 null，表示取不到有效值。 */ Authority?: string; /** * 出生日期（人像面）注意：此字段可能返回 null，表示取不到有效值。 */ Birth?: string; /** * 身份证号（人像面）注意：此字段可能返回 null，表示取不到有效值。 */ IdNum?: string; /** * 名字（人像面）注意：此字段可能返回 null，表示取不到有效值。 */ Name?: string; /** * 民族（人像面）注意：此字段可能返回 null，表示取不到有效值。 */ Nation?: string; /** * 性别（人像面）注意：此字段可能返回 null，表示取不到有效值。 */ Sex?: string; /** * 证件有效期（国徽面）注意：此字段可能返回 null，表示取不到有效值。 */ ValidDate?: string; /** * 请求的id 注意：此字段可能返回 null，表示取不到有效值。 */ RequestId?: string; /** * 错误码注意：此字段可能返回 null，表示取不到有效值。 */ ErrorCode?: string; /** * 错误信息注意：此字段可能返回 null，表示取不到有效值。 */ ErrorMessage?: string; /** * 原图地址 */ ImageUrl?: string; /** * 身份证头像照片的地址（人像面） */ PortraitUrl?: string; /** * 整型错误码 */ IntErrorCode?: number; } /** * 其他票Table */ export interface OtherInvoiceList { /** * 列表 */ OtherInvoiceItemList?: Array<OtherInvoiceItem>; } /** * 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 翻拍件告警 -9104 反光告警 -9105 模糊告警 -9106 边框不完整告警 注：告警码可以同时存在多个 */ RecognizeWarnCode?: Array<number | bigint>; /** * 告警码说明： WARN_DRIVER_LICENSE_COPY_CARD 复印件告警 WARN_DRIVER_LICENSE_SCREENED_CARD 翻拍件告警 WARN_DRIVER_LICENSE_REFLECTION 反光告警 WARN_DRIVER_LICENSE_BLUR 模糊告警 WARN_DRIVER_LICENSE_BORDER_INCOMPLETE 边框不完整告警 注：告警信息可以同时存在多个 */ RecognizeWarnMsg?: Array<string>; /** * 发证单位 */ IssuingAuthority?: string; /** * 状态（仅电子驾驶证支持返回该字段） */ State?: string; /** * 累积记分（仅电子驾驶证支持返回该字段） */ CumulativeScore?: string; /** * 当前时间（仅电子驾驶证支持返回该字段） */ CurrentTime?: string; /** * 生成时间（仅电子驾驶证支持返回该字段） */ GenerateTime?: string; /** * 驾驶证副页姓名 */ BackPageName?: string; /** * 驾驶证副页证号 */ BackPageCardCode?: string; /** * 驾驶证类型 电子驾驶证：Electronic 普通驾驶证：Normal */ DriverLicenseType?: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * WaybillOCR返回参数结构体 */ export interface WaybillOCRResponse { /** * 检测到的文本信息，具体内容请点击左侧链接。 */ TextDetections?: TextWaybill; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 识别出来的单词信息包括单词（包括单词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>; /** * 机票开具状态 */ InvoiceStatus?: string; } /** * ClassifyStoreName请求参数结构体 */ export interface ClassifyStoreNameRequest { /** * 图片的 Base64 值。支持的图片格式：PNG、JPG、JPEG，暂不支持 GIF 格式。支持的图片大小：所下载图片经Base64编码后不超过 10M。图片下载时间不超过 3 秒。支持的图片像素：需介于20-10000px之间。图片的 ImageUrl、ImageBase64 必须提供一个，如果都提供，只使用 ImageUrl。 */ ImageBase64?: string; /** * 图片的 Url 地址。支持的图片格式：PNG、JPG、JPEG，暂不支持 GIF 格式。支持的图片大小：所下载图片经 Base64 编码后不超过 10M。图片下载时间不超过 3 秒。支持的图片像素：需介于20-10000px之间。图片存储于腾讯云的 Url 可保障更高的下载速度和稳定性，建议图片存储于腾讯云。非腾讯云存储的 Url 速度和稳定性可能受一定影响。 */ ImageUrl?: string; /** * 是否输出具体场景标签。注：开启后耗时会增加。 */ SceneType?: boolean; /** * 输入商户名称，辅助判断具体场景标签。注：仅SceneType配置为true时支持。 */ StoreInfo?: string; } /** * 矩形坐标 */ export interface Rect { /** * 左上角x */ X?: number; /** * 左上角y */ Y?: number; /** * 宽度单位：px */ Width?: number; /** * 高度单位：px */ Height?: number; } /** * 海关缴款书 */ export interface CustomsPaymentReceipt { /** * 发票名称 */ Title?: string; /** * 识别出的字段名称(关键字)，支持以下字段：税号、纳税人识别号、纳税人名称、金额合计大写、金额合计小写、填发日期、税务机关、填票人。示例值：纳税人识别号 */ Content?: Array<OtherInvoiceItem>; /** * 海关缴款书常用字段 */ CommonContent?: Array<OtherInvoiceItem>; } /** * QuestionSplitOCR请求参数结构体 */ export interface QuestionSplitOCRRequest { /** * 图片/PDF的 Url 地址。要求图片经Base64编码后不超过10M，分辨率建议600*800以上，支持PNG、JPG、JPEG、BMP、PDF格式。图片下载时间不超过 3 秒。图片存储于腾讯云的 Url 可保障更高的下载速度和稳定性，建议图片存储于腾讯云。非腾讯云存储的 Url 速度和稳定性可能受一定影响。 */ ImageUrl?: string; /** * 图片/PDF的 Base64 值。要求Base64不超过10M，分辨率建议600*800以上，支持PNG、JPG、JPEG、BMP、PDF格式。图片的 ImageUrl、ImageBase64 必须提供一个，如果都提供，只使用 ImageUrl。 */ ImageBase64?: string; /** * 是否开启PDF识别，默认值为false，开启后可同时支持图片和PDF的识别。 */ IsPdf?: boolean; /** * 需要识别的PDF页面的对应页码，仅支持PDF单页识别，当上传文件为PDF且IsPdf参数值为true时有效，默认值为1。 */ PdfPageNumber?: number; /** * 是否开启切边增强和弯曲矫正,默认为false不开启 */ EnableImageCrop?: boolean; /** * 是否只返回检测框，默认false */ EnableOnlyDetectBorder?: boolean; /** * false: 使用当前默认模型(结构化信息更全面，但手写答案坐标精度一般) true: 使用多模态推理模型，推理效果更强（题目框选、手写答案坐标定位能力更优，但不返回题目选项和题目类型信息） API默认false, demo默认使用的是true */ UseNewModel?: boolean; } /** * FlightInvoiceOCR请求参数结构体 */ export interface FlightInvoiceOCRRequest { /** * 图片的 Base64 值。支持的图片格式：PNG、JPG、JPEG，暂不支持 GIF 格式。支持的图片大小：所下载图片经Base64编码后不超过 10M。图片下载时间不超过 3 秒。图片的 ImageUrl、ImageBase64 必须提供一个，如果都提供，只使用 ImageUrl。 */ ImageBase64?: string; /** * 图片的 Url 地址。支持的图片格式：PNG、JPG、JPEG，暂不支持 GIF 格式。支持的图片大小：所下载图片经 Base64 编码后不超过 10M。图片下载时间不超过 3 秒。图片存储于腾讯云的 Url 可保障更高的下载速度和稳定性，建议图片存储于腾讯云。非腾讯云存储的 Url 速度和稳定性可能受一定影响。 */ ImageUrl?: string; /** * 是否开启PDF识别，默认值为true，开启后可同时支持图片和PDF的识别。 */ IsPdf?: boolean; /** * 需要识别的PDF页面的对应页码，仅支持PDF单页识别，当上传文件为PDF且IsPdf参数值为true时有效，默认值为1。 */ PdfPageNumber?: number; } /** * 数学公式识别结果 */ export interface TextFormula { /** * 识别出的文本行内容 */ DetectedText?: string; } /** * MLIDCardOCR请求参数结构体 */ export interface MLIDCardOCRRequest { /** * 图片的 Base64 值。支持的图片格式：PNG、JPG、JPEG，暂不支持 GIF 格式。支持的图片大小：所下载图片经Base64编码后不超过 10M。图片下载时间不超过 3 秒。 */ ImageBase64?: string; /** * 卡证背面图片的 Base64 值。支持的图片格式：PNG、JPG、JPEG，暂不支持 GIF 格式。支持的图片大小：所下载图片经Base64编码后不超过 10M。图片下载时间不超过 3 秒。图片的 ImageUrl、ImageBase64 必须提供一个，如果都提供，只使用 ImageUrl。 */ BackImageBase64?: string; /** * 图片的 Url 地址。( 中国地区之外不支持这个字段 )支持的图片格式：PNG、JPG、JPEG，暂不支持 GIF 格式。支持的图片大小：所下载图片经 Base64 编码后不超过 10M。图片下载时间不超过 3 秒。图片存储于腾讯云的 Url 可保障更高的下载速度和稳定性，建议图片存储于腾讯云。非腾讯云存储的 Url 速度和稳定性可能受一定影响。 */ ImageUrl?: string; /** * 卡证背面图片的 Url 地址。支持的图片格式：PNG、JPG、JPEG，暂不支持 GIF 格式。支持的图片大小：所下载图片经 Base64 编码后不超过 10M。图片下载时间不超过 3 秒。图片存储于腾讯云的 Url 可保障更高的下载速度和稳定性，建议图片存储于腾讯云。非腾讯云存储的 Url 速度和稳定性可能受一定影响。 */ BackImageUrl?: string; /** * 是否返回图片，默认false */ RetImage?: boolean; } /** * 增值税发票项目明细 */ 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; } /** * IDCardOCR返回参数结构体 */ export interface IDCardOCRResponse { /** * 姓名（人像面） */ Name?: string; /** * 性别（人像面） */ Sex?: string; /** * 民族（人像面） */ Nation?: string; /** * 出生日期（人像面） */ Birth?: string; /** * 地址（人像面） */ Address?: string; /** * 身份证号（人像面） */ IdNum?: string; /** * 发证机关（国徽面） */ Authority?: string; /** * 证件有效期（国徽面） */ ValidDate?: string; /** * 扩展信息，不请求则不返回，具体输入参考示例3和示例4。 IdCard，裁剪后身份证照片的base64编码，请求 Config.CropIdCard 时返回； Portrait，身份证头像照片的base64编码，请求 Config.CropPortrait 时返回； Quality，图片质量分数，请求 Config.Quality 时返回（取值范围：0 ~ 100，分数越低越模糊，建议阈值≥50）; BorderCodeValue，身份证边框不完整告警阈值分数，请求 Config.BorderCheckWarn时返回（取值范围：0 ~ 100，分数越低边框遮挡可能性越低，建议阈值≤50）; WarnInfos，告警信息，Code 告警码列表和释义： -9109 身份证有效日期不合法告警， -9101 身份证边框不完整告警， -9102 身份证复印件告警（黑白及彩色复印件）, -9108 身份证复印件告警（仅黑白复印件）， -9103 身份证翻拍告警， -9105 身份证框内遮挡告警， -9104 临时身份证告警， -9106 身份证疑似存在PS痕迹告警， -9107 身份证反光告警， -9110 电子身份证告警（仅CardWarnType参数为Advanced时）， -9111 水印告警 */ AdvancedInfo?: string; /** * 反光点覆盖区域详情结果，具体内容请点击左侧链接 */ ReflectDetailInfos?: Array<ReflectDetailInfo>; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: 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; /** * 页数注意：此字段可能返回 null，表示取不到有效值。 */ PageIndex?: string; } /** * EnterpriseLicenseOCR返回参数结构体 */ export interface EnterpriseLicenseOCRResponse { /** * 企业证照识别结果，具体内容请点击左侧链接。 */ EnterpriseLicenseInfos?: Array<EnterpriseLicenseInfo>; /** * 图片旋转角度（角度制），文本的水平方向为0°，顺时针为正，逆时针为负。 */ Angle?: number; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 银行回单 */ export interface BankSlip { /** * 银行回单信息注意：此字段可能返回 null，表示取不到有效值。 */ BankSlipInfos?: Array<BankSlipInfo>; /** * 银行回单信息常用字段 */ CommonBankSlipInfos?: Array<BankSlipInfo>; } /** * QuestionOCR返回参数结构体 */ export interface QuestionOCRResponse { /** * 检测到的文本信息 */ QuestionInfo?: Array<QuestionInfo>; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 印章信息 */ export interface SealInfo { /** * 印章主体内容 */ SealBody: string; /** * 印章坐标 */ Location: Rect; /** * 印章其它文本内容 */ OtherTexts: Array<string>; /** * 印章类型，表示为: 圆形印章：0 椭圆形印章：1 方形印章：2 菱形印章：3 三角形印章：4 */ SealShape: 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; } /** * 增值税发票识别结果 */ export interface TextVatInvoice { /** * 识别出的字段名称（关键字）。支持以下字段的识别：发票代码、发票号码、打印发票代码、打印发票号码、开票日期、购买方识别号、小写金额、价税合计(大写)、销售方识别号、校验码、购买方名称、销售方名称、税额、复核、联次名称、备注、联次、密码区、开票人、收款人、（货物或应税劳务、服务名称）、省、市、服务类型、通行费标志、是否代开、是否收购、合计金额、是否有公司印章、发票消费类型、车船税、机器编号、成品油标志、税率、合计税额、（购买方地址、电话）、（销售方地址、电话）、单价、金额、销售方开户行及账号、购买方开户行及账号、规格型号、发票名称、单位、数量、校验码备选、校验码后六位备选、发票号码备选、车牌号、类型、通行日期起、通行日期止、发票类型。 */ Name?: string; /** * 识别出的字段名称对应的值，也就是字段Name对应的字符串结果。 */ Value?: string; /** * 字段在原图中的中的四点坐标。注意：此字段可能返回 null，表示取不到有效值。注意：此字段可能返回 null，表示取不到有效值。 */ Polygon?: Polygon; } /** * 机动车销售统一发票信息 */ 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编码后不超过 10M，分辨率建议500*800以上，支持PNG、JPG、JPEG、BMP格式。建议卡片部分占据图片2/3以上。图片的 ImageUrl、ImageBase64 必须提供一个，如果都提供，只使用 ImageUrl。 */ ImageBase64?: string; /** * 图片的 Url 地址。要求图片经Base64编码后不超过 10M，分辨率建议500*800以上，支持PNG、JPG、JPEG、BMP格式。建议卡片部分占据图片2/3以上。图片下载时间不超过 3 秒。建议图片存储于腾讯云，可保障更高的下载速度和稳定性。 */ ImageUrl?: string; /** * FRONT 为驾驶证主页正面（有红色印章的一面）， BACK 为驾驶证副页正面（有档案编号的一面）。 DOUBLE 支持自动识别驾驶证正副页单面，和正副双面同框识别 默认值为：FRONT。 */ CardSide?: string; } /** * VerifyBizLicenseEnterprise3返回参数结构体 */ export interface VerifyBizLicenseEnterprise3Response { /** * 0 成功，计费 1 系统异常，不计费 2 查询无结果，不计费 */ StatusCode?: number; /** * 验证结果 1：三要素完全匹配 0：三要素不完全匹配 仅StatusCode为0时返回 */ VerifyResult?: number; /** * 企业状态枚举值：<ul><li>1：开业（在营）/ 在营</li><li>2：迁出 / 非在营</li><li>3：注销</li><li>4：吊销</li><li>5：撤销</li><li>6：停业</li><li>7：撤销登记</li><li>0：其他</li><li>/：无法查询</li></ul>企业状态当VerifyType参数为ENT_2META时，可返回： 0-7, / 当VerifyType参数为ENT_3META时，可返回 1，2 */ OperatingStatus?: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: 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>; /** * 语种信息。注：仅ConfigID配置为MulOCR时支持。zh:中文; en:英文; tha:泰语; may:印尼语; jap:日语; kor:韩语; spa:西班牙语; fre:法语; ger:德语; por:葡萄牙语; vie:越南语; may:马来语; rus:俄语; ita:意大利语; hol:荷兰语; swe:瑞典语; fin:芬兰语; nor:挪威语; hun:匈牙利语; ara:阿拉伯语; hi:印地语。 */ Language?: string; } /** * RecognizeTableOCR返回参数结构体 */ export interface RecognizeTableOCRResponse { /** * 检测到的文本信息，具体内容请点击左侧链接。 */ TableDetections?: Array<TableDetectInfo>; /** * Base64 编码后的 Excel 数据。 */ Data?: string; /** * 图片为PDF时，返回PDF的总页数，默认为0 */ PdfPageSize?: number; /** * 图片旋转角度（角度制），文本的水平方向为0°，统一以逆时针方向旋转，逆时针为负，角度范围为-360°至0°。 */ Angle?: number; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 数学试题识别结果 */ export interface TextEduPaper { /** * 识别出的字段名称（关键字） */ Item?: string; /** * 识别出的字段名称对应的值，也就是字段Item对应的字符串结果 */ DetectedText?: string; /** * 文本行在旋转纠正之后的图像中的像素坐标，表示为（左上角x, 左上角y，宽width，高height） */ Itemcoord?: ItemCoord; } /** * QrcodeOCR返回参数结构体 */ export interface QrcodeOCRResponse { /** * 二维码/条形码识别结果信息，具体内容请点击左侧链接。 */ CodeResults?: Array<QrcodeResultsInfo>; /** * 图片大小，具体内容请点击左侧链接。 */ ImgSize?: QrcodeImgSize; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 海关进/出口货物报关单 */ export interface CustomsDeclaration { /** * 发票名称 */ Title?: string; /** * 识别出的字段名称(关键字) */ Content?: Array<OtherInvoiceItem>; } /** * 运单识别对象 */ export interface WaybillObj { /** * 识别出的文本行内容 */ Text?: string; } /** * 英文OCR识别出的单词在原图中的四点坐标数组 */ export interface WordCoordPoint { /** * 英文OCR识别出的每个单词在原图中的四点坐标。 */ WordCoordinate: Array<Coord>; } /** * HKIDCardOCR返回参数结构体 */ export interface HKIDCardOCRResponse { /** * 中文姓名 */ CnName?: string; /** * 英文姓名 */ EnName?: string; /** * 中文姓名对应电码 */ TelexCode?: string; /** * 性别：“男M”或“女F” */ Sex?: string; /** * 出生日期 */ Birthday?: string; /** * 永久性居民身份证。 0：非永久； 1：永久； -1：未知。 */ Permanent?: number; /** * 身份证号码 */ IdNum?: string; /** * 证件符号，出生日期下的符号，例如"***AZ" */ Symbol?: string; /** * 首次签发日期 */ FirstIssueDate?: string; /** * 最近领用日期 */ CurrentIssueDate?: string; /** * 真假判断。 0：无法判断（图像模糊、不完整、反光、过暗等导致无法判断）； 1：假； 2：真。注意：此字段可能返回 null，表示取不到有效值。 * @deprecated */ FakeDetectResult?: number; /** * Base64编码的证件左侧人像大图注意：此字段可能返回 null，表示取不到有效值。 */ HeadImage?: string; /** * Base64编码的证件右侧人像小图注意：此字段可能返回 null，表示取不到有效值。 */ SmallHeadImage?: string; /** * 该字段已废弃，将固定返回空数组，不建议使用。 * @deprecated */ WarningCode?: Array<number | bigint>; /** * 该字段仅对国际站请求起作用，国内站该字段将固定返回空数组。国际站告警码如下：告警码-9101 证件边框不完整告警-9102 证件复印件告警-9103 证件翻拍告警-9104 证件PS告警-9107 证件反光告警-9108 证件模糊告警-9109 告警能力未开通 */ WarnCardInfos?: Array<number | bigint>; /** * 证件透明视窗内的文本信息 */ WindowEmbeddedText?: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * MainlandPermitOCR请求参数结构体 */ export interface MainlandPermitOCRRequest { /** * 图片的 Base64 值。支持的图片格式：PNG、JPG、JPEG，暂不支持 GIF 格式。支持的图片大小：所下载图片经Base64编码后不超过 10M。图片下载时间不超过 3 秒。图片的 ImageUrl、ImageBase64 必须提供一个，如果都提供，只使用 ImageUrl。 */ ImageBase64?: string; /** * 图片的 Url 地址。支持的图片格式：PNG、JPG、JPEG，暂不支持 GIF 格式。支持的图片大小：所下载图片经 Base64 编码后不超过 10M。图片下载时间不超过 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; /** * 出行人，仅旅客运输服务发票返回 */ Traveler?: string; /** * 有效身份证件号，仅旅客运输服务发票返回 */ TravelerID?: string; /** * 出行日期，仅旅客运输服务发票返回 */ TravelDate?: string; /** * 等级，仅旅客运输服务发票返回 */ TravelLevel?: string; } /** * 单词坐标信息 */ export interface WordPolygon { /** * 文本块内容 */ DetectedText?: string; /** * 四点坐标 */ Coord?: Polygon; } /** * EnglishOCR请求参数结构体 */ export interface EnglishOCRRequest { /** * 图片的 Base64 值。支持的图片格式：PNG、JPG、JPEG，暂不支持 GIF 格式。支持的图片大小：所下载图片经Base64编码后不超过 7M。图片下载时间不超过 3 秒。像素须介于20-10000px之间。图片的 ImageUrl、ImageBase64 必须提供一个，如果都提供，只使用 ImageUrl。 */ ImageBase64?: string; /** * 图片的 Url 地址。支持的图片格式：PNG、JPG、JPEG，暂不支持 GIF 格式。支持的图片大小：所下载图片经 Base64 编码后不超过 7M。图片下载时间不超过 3 秒。像素须介于20-10000px之间。图片存储于腾讯云的 Url 可保障更高的下载速度和稳定性，建议图片存储于腾讯云。非腾讯云存储的 Url 速度和稳定性可能受一定影响。 */ ImageUrl?: string; /** * 单词四点坐标开关，开启可返回图片中单词的四点坐标。该参数默认值为false。 */ EnableCoordPoint?: boolean; /** * 候选字开关，开启可返回识别时多个可能的候选字（每个候选字对应其置信度）。该参数默认值为false。 */ EnableCandWord?: boolean; /** * 预处理开关，功能是检测图片倾斜的角度，将原本倾斜的图片矫正。该参数默认值为true。 */ Preprocess?: boolean; } /** * VehicleLicenseOCR请求参数结构体 */ export interface VehicleLicenseOCRRequest { /** * 图片的 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; /** * FRONT为行驶证主页正面（有红色印章的一面），BACK 为拖拉机行驶证副页正面识别 */ TractorCardSide?: string; } /** * QuestionSplitOCR返回参数结构体 */ export interface QuestionSplitOCRResponse { /** * 检测到的文本信息 */ QuestionInfo?: Array<QuestionInfo>; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * TableOCR返回参数结构体 */ export interface TableOCRResponse { /** * 检测到的文本信息，具体内容请点击左侧链接 */ TextDetections?: Array<TextTable>; /** * Base64 编码后的 Excel 数据。 */ Data?: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * RecognizeStoreName请求参数结构体 */ export interface RecognizeStoreNameRequest { /** * 图片的 Base64 值。支持的图片格式：PNG、JPG、JPEG，暂不支持 GIF 格式。支持的图片大小：所下载图片经Base64编码后不超过 10M。图片下载时间不超过 3 秒。支持的图片像素：需介于20-10000px之间。图片的 ImageUrl、ImageBase64 必须提供一个，如果都提供，只使用 ImageUrl。 */ ImageBase64?: string; /** * 图片的 Url 地址。支持的图片格式：PNG、JPG、JPEG，暂不支持 GIF 格式。支持的图片大小：所下载图片经 Base64 编码后不超过 10M。图片下载时间不超过 3 秒。支持的图片像素：需介于20-10000px之间。图片存储于腾讯云的 Url 可保障更高的下载速度和稳定性，建议图片存储于腾讯云。非腾讯云存储的 Url 速度和稳定性可能受一定影响。 */ ImageUrl?: string; } /** * 文档智能识别 */ export interface StructuralItem { /** * 识别出的字段名称(关键字)。 */ Name?: string; /** * 识别出的字段名称对应的值。 */ Value?: string; /** * 置信度 0 ~100。 */ Confidence?: number; /** * 文本行在旋转纠正之后的图像中的像素坐标。 */ ItemCoord?: ItemCoord; /** * 字段所在行号，下标从0开始，非行字段或未能识别行号的该值返回-1。 */ Row?: number; } /** * 票据检测结果 */ 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; } /** * VerifyScenePhoto返回参数结构体 */ export interface VerifyScenePhotoResponse { /** * 区域篡改提示 */ Tamper?: SceneWarnInfo; /** * AIGC合成提示 */ Synthesis?: SceneWarnInfo; /** * 屏幕翻拍提示 */ RemakeScreen?: SceneWarnInfo; /** * 截图提示 */ Screenshot?: SceneWarnInfo; /** * 文字水印提示 */ TextWatermark?: SceneWarnInfo; /** * 水印内容，当未检测到文字水印时不返回，返回多组水印时以 | 分隔。 */ WatermarkContent?: string; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 机票详细信息元组 */ export interface FlightItemInfo { /** * 出发站 */ TerminalGetOn?: string; /** * 到达站 */ TerminalGetOff?: string; /** * 承运人 */ Carrier?: string; /** * 航班号 */ FlightNumber?: string; /** * 座位等级 */ Seat?: string; /** * 乘机日期 */ DateGetOn?: string; /** * 乘机时间 */ TimeGetOn?: string; /** * 客票级别/客票类别 */ FareBasis?: string; /** * 免费行李额 */ Allow?: string; /** * 客票生效日期 */ DateStart?: string; /** * 有效截止日期 */ DateEnd?: string; } /** * RecognizeAgent返回参数结构体 */ export interface RecognizeAgentResponse { /** * 返回内容。详见ListInfo。 */ Response?: Array<ListInfo>; /** * 图片旋转角度(角度制)，文本的水平方向为 0；顺时针为正，逆时针为负。 */ Angle?: number; /** * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: 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。 */ RequestId?: string; } /** * 公式识别结果 */ export interface TextFormulaInfo { /** * 识别出的文本行内容 */ DetectedText?: string; /** * 识别出的文本行内容坐标 */ Coord?: Polygon; } /** * 银行回单识别出的字段 */ export interface BankSlipInfo { /** * 识别出的字段名称(关键字)，支持以下字段：付款开户行、收款开户行、付款账号、收款账号、回单类型、回单编号、币种、流水号、凭证号码、交易机构、交易金额、手续费、日期等字段信息。 */ Name?: string; /** * 识别出的字段名称对应的值，也就是字段Name对应的字符串结果。