api_ai_chinese_passport_recognize.go

// Code generated by lark_sdk_gen. DO NOT EDIT.
/**
 * Copyright 2022 chyroc
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package lark

import (
	"context"
	"io"
)

// RecognizeAIChinesePassport 中国护照识别接口, 支持JPG/JPEG/PNG/BMP四种文件类型的一次性的识别。
//
// 单租户限流: 10QPS, 同租户下的应用没有限流, 共享本租户的 10QPS 限流
//
// doc: https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/ai/document_ai-v1/chinese_passport/recognize
func (r *AIService) RecognizeAIChinesePassport(ctx context.Context, request *RecognizeAIChinesePassportReq, options ...MethodOptionFunc) (*RecognizeAIChinesePassportResp, *Response, error) {
	if r.cli.mock.mockAIRecognizeAIChinesePassport != nil {
		r.cli.Log(ctx, LogLevelDebug, "[lark] AI#RecognizeAIChinesePassport mock enable")
		return r.cli.mock.mockAIRecognizeAIChinesePassport(ctx, request, options...)
	}

	req := &RawRequestReq{
		Scope:                 "AI",
		API:                   "RecognizeAIChinesePassport",
		Method:                "POST",
		URL:                   r.cli.openBaseURL + "/open-apis/document_ai/v1/chinese_passport/recognize",
		Body:                  request,
		MethodOption:          newMethodOption(options),
		NeedTenantAccessToken: true,
		IsFile:                true,
	}
	resp := new(recognizeAIChinesePassportResp)

	response, err := r.cli.RawRequest(ctx, req, resp)
	return resp.Data, response, err
}

// MockAIRecognizeAIChinesePassport mock AIRecognizeAIChinesePassport method
func (r *Mock) MockAIRecognizeAIChinesePassport(f func(ctx context.Context, request *RecognizeAIChinesePassportReq, options ...MethodOptionFunc) (*RecognizeAIChinesePassportResp, *Response, error)) {
	r.mockAIRecognizeAIChinesePassport = f
}

// UnMockAIRecognizeAIChinesePassport un-mock AIRecognizeAIChinesePassport method
func (r *Mock) UnMockAIRecognizeAIChinesePassport() {
	r.mockAIRecognizeAIChinesePassport = nil
}

// RecognizeAIChinesePassportReq ...
type RecognizeAIChinesePassportReq struct {
	File io.Reader `json:"file,omitempty"` // 识别的中国护照源文件, 示例值: file binary
}

// RecognizeAIChinesePassportResp ...
type RecognizeAIChinesePassportResp struct {
	ChinesePassport *RecognizeAIChinesePassportRespChinesePassport `json:"chinese_passport,omitempty"` // 中国护照信息
}

// RecognizeAIChinesePassportRespChinesePassport ...
type RecognizeAIChinesePassportRespChinesePassport struct {
	Entities []*RecognizeAIChinesePassportRespChinesePassportEntitie `json:"entities,omitempty"` // 识别出的实体类型
}

// RecognizeAIChinesePassportRespChinesePassportEntitie ...
type RecognizeAIChinesePassportRespChinesePassportEntitie struct {
	Type  string `json:"type,omitempty"`  // 识别的字段种类, 可选值有: full_name_cn: 中文姓名, full_name_en: 英文格式姓名, date_of_birth: 出生日期, date_of_expiry: 有效期至, place_of_issue: 签发地点, passport_number: 护照号码
	Value string `json:"value,omitempty"` // 识别出字段的文本信息
}

// recognizeAIChinesePassportResp ...
type recognizeAIChinesePassportResp struct {
	Code  int64                           `json:"code,omitempty"` // 错误码, 非 0 表示失败
	Msg   string                          `json:"msg,omitempty"`  // 错误描述
	Data  *RecognizeAIChinesePassportResp `json:"data,omitempty"`
	Error *ErrorDetail                    `json:"error,omitempty"`
}