open-lark 0.14.0

Enterprise-grade Lark/Feishu Open API SDK with comprehensive Chinese documentation and advanced error handling
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
use reqwest::Method;
use serde::{Deserialize, Serialize};

use crate::{
    core::{
        api_req::ApiRequest,
        api_resp::{ApiResponseTrait, BaseResponse, ResponseFormat},
        config::Config,
        constants::AccessTokenType,
        endpoints::Endpoints,
        http::Transport,
        req_option::RequestOption,
        trait_system::Service,
        SDKResult,
    },
    service::ai::models::{
        BankCardInfo, BusinessCardInfo, BusinessLicenseInfo, ContractInfo, DrivingLicenseInfo,
        FileRecognizeRequest, IdCardInfo, RecognizeResponse, ResumeInfo, VatInvoiceInfo,
    },
};

/// 智能文档处理服务
pub struct DocumentAiService {
    pub config: Config,
}

/// 简历解析响应
#[derive(Debug, Serialize, Deserialize)]
pub struct ResumeParseResponse {
    /// 简历信息
    #[serde(flatten)]
    pub resume: RecognizeResponse<ResumeInfo>,
}

impl ApiResponseTrait for ResumeParseResponse {
    fn data_format() -> ResponseFormat {
        ResponseFormat::Data
    }
}

/// 身份证识别响应
#[derive(Debug, Serialize, Deserialize)]
pub struct IdCardRecognizeResponse {
    /// 身份证信息
    #[serde(flatten)]
    pub id_card: RecognizeResponse<IdCardInfo>,
}

impl ApiResponseTrait for IdCardRecognizeResponse {
    fn data_format() -> ResponseFormat {
        ResponseFormat::Data
    }
}

/// 驾驶证识别响应
#[derive(Debug, Serialize, Deserialize)]
pub struct DrivingLicenseRecognizeResponse {
    /// 驾驶证信息
    #[serde(flatten)]
    pub driving_license: RecognizeResponse<DrivingLicenseInfo>,
}

impl ApiResponseTrait for DrivingLicenseRecognizeResponse {
    fn data_format() -> ResponseFormat {
        ResponseFormat::Data
    }
}

/// 银行卡识别响应
#[derive(Debug, Serialize, Deserialize)]
pub struct BankCardRecognizeResponse {
    /// 银行卡信息
    #[serde(flatten)]
    pub bank_card: RecognizeResponse<BankCardInfo>,
}

impl ApiResponseTrait for BankCardRecognizeResponse {
    fn data_format() -> ResponseFormat {
        ResponseFormat::Data
    }
}

/// 营业执照识别响应
#[derive(Debug, Serialize, Deserialize)]
pub struct BusinessLicenseRecognizeResponse {
    /// 营业执照信息
    #[serde(flatten)]
    pub business_license: RecognizeResponse<BusinessLicenseInfo>,
}

impl ApiResponseTrait for BusinessLicenseRecognizeResponse {
    fn data_format() -> ResponseFormat {
        ResponseFormat::Data
    }
}

/// 增值税发票识别响应
#[derive(Debug, Serialize, Deserialize)]
pub struct VatInvoiceRecognizeResponse {
    /// 增值税发票信息
    #[serde(flatten)]
    pub vat_invoice: RecognizeResponse<VatInvoiceInfo>,
}

impl ApiResponseTrait for VatInvoiceRecognizeResponse {
    fn data_format() -> ResponseFormat {
        ResponseFormat::Data
    }
}

/// 合同字段提取响应
#[derive(Debug, Serialize, Deserialize)]
pub struct ContractFieldExtractionResponse {
    /// 合同信息
    #[serde(flatten)]
    pub contract: RecognizeResponse<ContractInfo>,
}

impl ApiResponseTrait for ContractFieldExtractionResponse {
    fn data_format() -> ResponseFormat {
        ResponseFormat::Data
    }
}

/// 名片识别响应
#[derive(Debug, Serialize, Deserialize)]
pub struct BusinessCardRecognizeResponse {
    /// 名片信息
    #[serde(flatten)]
    pub business_card: RecognizeResponse<BusinessCardInfo>,
}

impl ApiResponseTrait for BusinessCardRecognizeResponse {
    fn data_format() -> ResponseFormat {
        ResponseFormat::Data
    }
}

/// 通用证件识别响应
#[derive(Debug, Serialize, Deserialize)]
pub struct GenericDocumentResponse {
    /// 识别结果
    pub data: serde_json::Value,
    /// 置信度
    #[serde(skip_serializing_if = "Option::is_none")]
    pub confidence: Option<f64>,
}

impl ApiResponseTrait for GenericDocumentResponse {
    fn data_format() -> ResponseFormat {
        ResponseFormat::Data
    }
}

impl DocumentAiService {
    pub fn new(config: Config) -> Self {
        Self { config }
    }

    /// 识别文件中的简历信息
    ///
    /// 该接口用于解析简历文件,提取关键信息如姓名、联系方式、教育经历、工作经历等。
    ///
    /// # 参数
    ///
    /// - `request`: 文件识别请求参数
    /// - `option`: 可选的请求配置
    pub async fn parse_resume(
        &self,
        request: FileRecognizeRequest,
        option: Option<RequestOption>,
    ) -> SDKResult<BaseResponse<ResumeParseResponse>> {
        let api_req = ApiRequest {
            http_method: Method::POST,
            api_path: Endpoints::DOCUMENT_AI_RESUME_PARSE.to_string(),
            supported_access_token_types: vec![AccessTokenType::Tenant, AccessTokenType::User],
            body: serde_json::to_vec(&request)?,
            ..Default::default()
        };

        Transport::request(api_req, &self.config, option).await
    }

    /// 识别文件中的身份证
    ///
    /// 该接口用于识别身份证图片,提取身份证上的关键信息。
    ///
    /// # 参数
    ///
    /// - `request`: 文件识别请求参数
    /// - `option`: 可选的请求配置
    pub async fn recognize_id_card(
        &self,
        request: FileRecognizeRequest,
        option: Option<RequestOption>,
    ) -> SDKResult<BaseResponse<IdCardRecognizeResponse>> {
        let api_req = ApiRequest {
            http_method: Method::POST,
            api_path: Endpoints::DOCUMENT_AI_ID_CARD_RECOGNIZE.to_string(),
            supported_access_token_types: vec![AccessTokenType::Tenant, AccessTokenType::User],
            body: serde_json::to_vec(&request)?,
            ..Default::default()
        };

        Transport::request(api_req, &self.config, option).await
    }

    /// 识别文件中的驾驶证
    ///
    /// 该接口用于识别驾驶证图片,提取驾驶证上的关键信息。
    ///
    /// # 参数
    ///
    /// - `request`: 文件识别请求参数
    /// - `option`: 可选的请求配置
    pub async fn recognize_driving_license(
        &self,
        request: FileRecognizeRequest,
        option: Option<RequestOption>,
    ) -> SDKResult<BaseResponse<DrivingLicenseRecognizeResponse>> {
        let api_req = ApiRequest {
            http_method: Method::POST,
            api_path: Endpoints::DOCUMENT_AI_DRIVING_LICENSE_RECOGNIZE.to_string(),
            supported_access_token_types: vec![AccessTokenType::Tenant, AccessTokenType::User],
            body: serde_json::to_vec(&request)?,
            ..Default::default()
        };

        Transport::request(api_req, &self.config, option).await
    }

    /// 识别文件中的银行卡
    ///
    /// 该接口用于识别银行卡图片,提取银行卡上的关键信息。
    ///
    /// # 参数
    ///
    /// - `request`: 文件识别请求参数
    /// - `option`: 可选的请求配置
    pub async fn recognize_bank_card(
        &self,
        request: FileRecognizeRequest,
        option: Option<RequestOption>,
    ) -> SDKResult<BaseResponse<BankCardRecognizeResponse>> {
        let api_req = ApiRequest {
            http_method: Method::POST,
            api_path: Endpoints::DOCUMENT_AI_BANK_CARD_RECOGNIZE.to_string(),
            supported_access_token_types: vec![AccessTokenType::Tenant, AccessTokenType::User],
            body: serde_json::to_vec(&request)?,
            ..Default::default()
        };

        Transport::request(api_req, &self.config, option).await
    }

    /// 识别文件中的营业执照
    ///
    /// 该接口用于识别营业执照图片,提取营业执照上的关键信息。
    ///
    /// # 参数
    ///
    /// - `request`: 文件识别请求参数
    /// - `option`: 可选的请求配置
    pub async fn recognize_business_license(
        &self,
        request: FileRecognizeRequest,
        option: Option<RequestOption>,
    ) -> SDKResult<BaseResponse<BusinessLicenseRecognizeResponse>> {
        let api_req = ApiRequest {
            http_method: Method::POST,
            api_path: Endpoints::DOCUMENT_AI_BUSINESS_LICENSE_RECOGNIZE.to_string(),
            supported_access_token_types: vec![AccessTokenType::Tenant, AccessTokenType::User],
            body: serde_json::to_vec(&request)?,
            ..Default::default()
        };

        Transport::request(api_req, &self.config, option).await
    }

    /// 识别文件中的增值税发票
    ///
    /// 该接口用于识别增值税发票图片,提取发票上的关键信息。
    ///
    /// # 参数
    ///
    /// - `request`: 文件识别请求参数
    /// - `option`: 可选的请求配置
    pub async fn recognize_vat_invoice(
        &self,
        request: FileRecognizeRequest,
        option: Option<RequestOption>,
    ) -> SDKResult<BaseResponse<VatInvoiceRecognizeResponse>> {
        let api_req = ApiRequest {
            http_method: Method::POST,
            api_path: Endpoints::DOCUMENT_AI_VAT_INVOICE_RECOGNIZE.to_string(),
            supported_access_token_types: vec![AccessTokenType::Tenant, AccessTokenType::User],
            body: serde_json::to_vec(&request)?,
            ..Default::default()
        };

        Transport::request(api_req, &self.config, option).await
    }

    /// 提取文件中的合同字段
    ///
    /// 该接口用于识别合同文档,提取合同中的关键字段信息。
    ///
    /// # 参数
    ///
    /// - `request`: 文件识别请求参数
    /// - `option`: 可选的请求配置
    pub async fn extract_contract_fields(
        &self,
        request: FileRecognizeRequest,
        option: Option<RequestOption>,
    ) -> SDKResult<BaseResponse<ContractFieldExtractionResponse>> {
        let api_req = ApiRequest {
            http_method: Method::POST,
            api_path: Endpoints::DOCUMENT_AI_CONTRACT_FIELD_EXTRACTION.to_string(),
            supported_access_token_types: vec![AccessTokenType::Tenant, AccessTokenType::User],
            body: serde_json::to_vec(&request)?,
            ..Default::default()
        };

        Transport::request(api_req, &self.config, option).await
    }

    /// 识别文件中的名片
    ///
    /// 该接口用于识别名片图片,提取名片上的关键信息。
    ///
    /// # 参数
    ///
    /// - `request`: 文件识别请求参数
    /// - `option`: 可选的请求配置
    pub async fn recognize_business_card(
        &self,
        request: FileRecognizeRequest,
        option: Option<RequestOption>,
    ) -> SDKResult<BaseResponse<BusinessCardRecognizeResponse>> {
        let api_req = ApiRequest {
            http_method: Method::POST,
            api_path: Endpoints::DOCUMENT_AI_BUSINESS_CARD_RECOGNIZE.to_string(),
            supported_access_token_types: vec![AccessTokenType::Tenant, AccessTokenType::User],
            body: serde_json::to_vec(&request)?,
            ..Default::default()
        };

        Transport::request(api_req, &self.config, option).await
    }

    /// 识别文件中的机动车发票
    ///
    /// 该接口用于识别机动车发票图片。
    ///
    /// # 参数
    ///
    /// - `request`: 文件识别请求参数
    /// - `option`: 可选的请求配置
    pub async fn recognize_vehicle_invoice(
        &self,
        request: FileRecognizeRequest,
        option: Option<RequestOption>,
    ) -> SDKResult<BaseResponse<GenericDocumentResponse>> {
        let api_req = ApiRequest {
            http_method: Method::POST,
            api_path: Endpoints::DOCUMENT_AI_VEHICLE_INVOICE_RECOGNIZE.to_string(),
            supported_access_token_types: vec![AccessTokenType::Tenant, AccessTokenType::User],
            body: serde_json::to_vec(&request)?,
            ..Default::default()
        };

        Transport::request(api_req, &self.config, option).await
    }

    /// 识别文件中的健康证
    ///
    /// 该接口用于识别健康证图片。
    ///
    /// # 参数
    ///
    /// - `request`: 文件识别请求参数
    /// - `option`: 可选的请求配置
    pub async fn recognize_health_certificate(
        &self,
        request: FileRecognizeRequest,
        option: Option<RequestOption>,
    ) -> SDKResult<BaseResponse<GenericDocumentResponse>> {
        let api_req = ApiRequest {
            http_method: Method::POST,
            api_path: Endpoints::DOCUMENT_AI_HEALTH_CERTIFICATE_RECOGNIZE.to_string(),
            supported_access_token_types: vec![AccessTokenType::Tenant, AccessTokenType::User],
            body: serde_json::to_vec(&request)?,
            ..Default::default()
        };

        Transport::request(api_req, &self.config, option).await
    }

    /// 识别文件中的港澳居民来往内地通行证
    ///
    /// 该接口用于识别港澳居民来往内地通行证图片。
    ///
    /// # 参数
    ///
    /// - `request`: 文件识别请求参数
    /// - `option`: 可选的请求配置
    pub async fn recognize_hkm_mainland_travel_permit(
        &self,
        request: FileRecognizeRequest,
        option: Option<RequestOption>,
    ) -> SDKResult<BaseResponse<GenericDocumentResponse>> {
        let api_req = ApiRequest {
            http_method: Method::POST,
            api_path: Endpoints::DOCUMENT_AI_HKM_MAINLAND_TRAVEL_PERMIT_RECOGNIZE.to_string(),
            supported_access_token_types: vec![AccessTokenType::Tenant, AccessTokenType::User],
            body: serde_json::to_vec(&request)?,
            ..Default::default()
        };

        Transport::request(api_req, &self.config, option).await
    }

    /// 识别文件中的台湾居民来往大陆通行证
    ///
    /// 该接口用于识别台湾居民来往大陆通行证图片。
    ///
    /// # 参数
    ///
    /// - `request`: 文件识别请求参数
    /// - `option`: 可选的请求配置
    pub async fn recognize_tw_mainland_travel_permit(
        &self,
        request: FileRecognizeRequest,
        option: Option<RequestOption>,
    ) -> SDKResult<BaseResponse<GenericDocumentResponse>> {
        let api_req = ApiRequest {
            http_method: Method::POST,
            api_path: Endpoints::DOCUMENT_AI_TW_MAINLAND_TRAVEL_PERMIT_RECOGNIZE.to_string(),
            supported_access_token_types: vec![AccessTokenType::Tenant, AccessTokenType::User],
            body: serde_json::to_vec(&request)?,
            ..Default::default()
        };

        Transport::request(api_req, &self.config, option).await
    }

    /// 识别文件中的中国护照
    ///
    /// 该接口用于识别中国护照图片。
    ///
    /// # 参数
    ///
    /// - `request`: 文件识别请求参数
    /// - `option`: 可选的请求配置
    pub async fn recognize_chinese_passport(
        &self,
        request: FileRecognizeRequest,
        option: Option<RequestOption>,
    ) -> SDKResult<BaseResponse<GenericDocumentResponse>> {
        let api_req = ApiRequest {
            http_method: Method::POST,
            api_path: Endpoints::DOCUMENT_AI_CHINESE_PASSPORT_RECOGNIZE.to_string(),
            supported_access_token_types: vec![AccessTokenType::Tenant, AccessTokenType::User],
            body: serde_json::to_vec(&request)?,
            ..Default::default()
        };

        Transport::request(api_req, &self.config, option).await
    }

    /// 识别文件中的行驶证
    ///
    /// 该接口用于识别行驶证图片。
    ///
    /// # 参数
    ///
    /// - `request`: 文件识别请求参数
    /// - `option`: 可选的请求配置
    pub async fn recognize_vehicle_license(
        &self,
        request: FileRecognizeRequest,
        option: Option<RequestOption>,
    ) -> SDKResult<BaseResponse<GenericDocumentResponse>> {
        let api_req = ApiRequest {
            http_method: Method::POST,
            api_path: Endpoints::DOCUMENT_AI_VEHICLE_LICENSE_RECOGNIZE.to_string(),
            supported_access_token_types: vec![AccessTokenType::Tenant, AccessTokenType::User],
            body: serde_json::to_vec(&request)?,
            ..Default::default()
        };

        Transport::request(api_req, &self.config, option).await
    }

    /// 识别文件中的火车票
    ///
    /// 该接口用于识别火车票图片。
    ///
    /// # 参数
    ///
    /// - `request`: 文件识别请求参数
    /// - `option`: 可选的请求配置
    pub async fn recognize_train_invoice(
        &self,
        request: FileRecognizeRequest,
        option: Option<RequestOption>,
    ) -> SDKResult<BaseResponse<GenericDocumentResponse>> {
        let api_req = ApiRequest {
            http_method: Method::POST,
            api_path: Endpoints::DOCUMENT_AI_TRAIN_INVOICE_RECOGNIZE.to_string(),
            supported_access_token_types: vec![AccessTokenType::Tenant, AccessTokenType::User],
            body: serde_json::to_vec(&request)?,
            ..Default::default()
        };

        Transport::request(api_req, &self.config, option).await
    }

    /// 识别文件中的出租车发票
    ///
    /// 该接口用于识别出租车发票图片。
    ///
    /// # 参数
    ///
    /// - `request`: 文件识别请求参数
    /// - `option`: 可选的请求配置
    pub async fn recognize_taxi_invoice(
        &self,
        request: FileRecognizeRequest,
        option: Option<RequestOption>,
    ) -> SDKResult<BaseResponse<GenericDocumentResponse>> {
        let api_req = ApiRequest {
            http_method: Method::POST,
            api_path: Endpoints::DOCUMENT_AI_TAXI_INVOICE_RECOGNIZE.to_string(),
            supported_access_token_types: vec![AccessTokenType::Tenant, AccessTokenType::User],
            body: serde_json::to_vec(&request)?,
            ..Default::default()
        };

        Transport::request(api_req, &self.config, option).await
    }

    /// 识别文件中的食品生产许可证
    ///
    /// 该接口用于识别食品生产许可证图片。
    ///
    /// # 参数
    ///
    /// - `request`: 文件识别请求参数
    /// - `option`: 可选的请求配置
    pub async fn recognize_food_produce_license(
        &self,
        request: FileRecognizeRequest,
        option: Option<RequestOption>,
    ) -> SDKResult<BaseResponse<GenericDocumentResponse>> {
        let api_req = ApiRequest {
            http_method: Method::POST,
            api_path: Endpoints::DOCUMENT_AI_FOOD_PRODUCE_LICENSE_RECOGNIZE.to_string(),
            supported_access_token_types: vec![AccessTokenType::Tenant, AccessTokenType::User],
            body: serde_json::to_vec(&request)?,
            ..Default::default()
        };

        Transport::request(api_req, &self.config, option).await
    }

    /// 识别文件中的食品经营许可证
    ///
    /// 该接口用于识别食品经营许可证图片。
    ///
    /// # 参数
    ///
    /// - `request`: 文件识别请求参数
    /// - `option`: 可选的请求配置
    pub async fn recognize_food_manage_license(
        &self,
        request: FileRecognizeRequest,
        option: Option<RequestOption>,
    ) -> SDKResult<BaseResponse<GenericDocumentResponse>> {
        let api_req = ApiRequest {
            http_method: Method::POST,
            api_path: Endpoints::DOCUMENT_AI_FOOD_MANAGE_LICENSE_RECOGNIZE.to_string(),
            supported_access_token_types: vec![AccessTokenType::Tenant, AccessTokenType::User],
            body: serde_json::to_vec(&request)?,
            ..Default::default()
        };

        Transport::request(api_req, &self.config, option).await
    }
}

impl Service for DocumentAiService {
    fn config(&self) -> &Config {
        &self.config
    }

    fn service_name() -> &'static str {
        "document_ai"
    }

    fn service_version() -> &'static str {
        "v1"
    }
}