api_ai_id_card_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"
)

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

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

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

// MockAIRecognizeAiidCard mock AIRecognizeAiidCard method
func (r *Mock) MockAIRecognizeAiidCard(f func(ctx context.Context, request *RecognizeAiidCardReq, options ...MethodOptionFunc) (*RecognizeAiidCardResp, *Response, error)) {
	r.mockAIRecognizeAiidCard = f
}

// UnMockAIRecognizeAiidCard un-mock AIRecognizeAiidCard method
func (r *Mock) UnMockAIRecognizeAiidCard() {
	r.mockAIRecognizeAiidCard = nil
}

// RecognizeAiidCardReq ...
type RecognizeAiidCardReq struct {
	File io.Reader `json:"file,omitempty"` // 识别身份证的源文件, 示例值: file binary
}

// RecognizeAiidCardResp ...
type RecognizeAiidCardResp struct {
	IDCard *RecognizeAiidCardRespIDCard `json:"id_card,omitempty"` // 身份证信息
}

// RecognizeAiidCardRespIDCard ...
type RecognizeAiidCardRespIDCard struct {
	Entities []*RecognizeAiidCardRespIDCardEntity `json:"entities,omitempty"` // 识别的实体列表
	Side     int64                                `json:"side,omitempty"`     // 正反面, 1为身份证-姓名页, 0为身份证-国徽页
	Conners  []int64                              `json:"conners,omitempty"`  // 四角坐标[x0, y0, x1, y1, x2, y2, x3, y3]
}

// RecognizeAiidCardRespIDCardEntity ...
type RecognizeAiidCardRespIDCardEntity struct {
	Type  string `json:"type,omitempty"`  // 识别的字段种类, 可选值有: identity_code: 公民身份号码, identity_name: 姓名, address: 住址, valid_date_start: 有效期起始时间, valid_date_end: 有效期终止时间（“长期”识别为“长期”）, gender: 性别, race: 民族, issued_by: 签发机关, birth: 出生日期
	Value string `json:"value,omitempty"` // 识别出字段的文本信息
}

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