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
use reqwest::Method;
use serde::{Deserialize, Serialize};

use crate::{
    core::{
        api_req::ApiRequest,
        api_resp::{ApiResponseTrait, BaseResponse, ResponseFormat},
        config::Config,
        constants::AccessTokenType,
        endpoints::{
            EndpointBuilder, LINGO_ENTITY_CREATE, LINGO_ENTITY_GET, LINGO_ENTITY_HIGHLIGHT,
            LINGO_ENTITY_MATCH, LINGO_ENTITY_SEARCH, LINGO_ENTITY_UPDATE,
        },
        http::Transport,
        req_option::RequestOption,
        SDKResult,
    },
    service::lingo::models::{
        Entity, EntityMatchResult, EntitySearchResult, HighlightResult, OuterInfo, PageResponse,
        RelatedMeta,
    },
};

/// 词条管理服务
pub struct EntityService {
    pub config: Config,
}

impl EntityService {
    /// 创建词条管理服务实例
    pub fn new(config: Config) -> Self {
        Self { config }
    }

    /// 创建免审词条
    ///
    /// 通过此接口创建的词条,无需经过词典管理员审核,直接写入词库。
    ///
    /// # Arguments
    ///
    /// * `request` - 词条创建请求
    /// * `option` - 请求选项,可选
    ///
    /// # Returns
    ///
    /// 返回创建的词条信息
    pub async fn create_entity(
        &self,
        request: EntityCreateRequest,
        option: Option<RequestOption>,
    ) -> SDKResult<BaseResponse<EntityCreateResponse>> {
        let api_req = ApiRequest {
            http_method: Method::POST,
            api_path: LINGO_ENTITY_CREATE.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
    }

    /// 更新免审词条
    ///
    /// 通过此接口更新已有词条,无需经过词典管理员审核,直接写入词库。
    ///
    /// # Arguments
    ///
    /// * `entity_id` - 词条ID
    /// * `request` - 词条更新请求
    /// * `option` - 请求选项,可选
    ///
    /// # Returns
    ///
    /// 返回更新后的词条信息
    pub async fn update_entity(
        &self,
        entity_id: &str,
        request: EntityUpdateRequest,
        option: Option<RequestOption>,
    ) -> SDKResult<BaseResponse<EntityUpdateResponse>> {
        let api_req = ApiRequest {
            http_method: Method::PUT,
            api_path: EndpointBuilder::replace_param(LINGO_ENTITY_UPDATE, "{entity_id}", entity_id),
            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
    }

    /// 删除免审词条
    ///
    /// 通过词条ID删除已有词条。
    ///
    /// # Arguments
    ///
    /// * `entity_id` - 词条ID
    /// * `option` - 请求选项,可选
    ///
    /// # Returns
    ///
    /// 返回删除结果
    pub async fn delete_entity(
        &self,
        entity_id: &str,
        option: Option<RequestOption>,
    ) -> SDKResult<BaseResponse<EntityDeleteResponse>> {
        let api_req = ApiRequest {
            http_method: Method::DELETE,
            api_path: EndpointBuilder::replace_param(LINGO_ENTITY_UPDATE, "{entity_id}", entity_id),
            supported_access_token_types: vec![AccessTokenType::Tenant, AccessTokenType::User],
            body: vec![],
            ..Default::default()
        };

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

    /// 获取词条详情
    ///
    /// 通过词条ID获取词条的详细信息。
    ///
    /// # Arguments
    ///
    /// * `entity_id` - 词条ID
    /// * `option` - 请求选项,可选
    ///
    /// # Returns
    ///
    /// 返回词条详细信息
    pub async fn get_entity(
        &self,
        entity_id: &str,
        option: Option<RequestOption>,
    ) -> SDKResult<BaseResponse<EntityGetResponse>> {
        let api_req = ApiRequest {
            http_method: Method::GET,
            api_path: EndpointBuilder::replace_param(LINGO_ENTITY_GET, "{entity_id}", entity_id),
            supported_access_token_types: vec![AccessTokenType::Tenant, AccessTokenType::User],
            body: vec![],
            ..Default::default()
        };

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

    /// 获取词条列表
    ///
    /// 分页获取词条列表,支持多种筛选条件。
    ///
    /// # Arguments
    ///
    /// * `request` - 词条列表查询请求
    /// * `option` - 请求选项,可选
    ///
    /// # Returns
    ///
    /// 返回词条列表
    pub async fn list_entities(
        &self,
        request: EntityListRequest,
        option: Option<RequestOption>,
    ) -> SDKResult<BaseResponse<EntityListResponse>> {
        let mut api_req = ApiRequest {
            http_method: Method::GET,
            api_path: LINGO_ENTITY_CREATE.to_string(),
            supported_access_token_types: vec![AccessTokenType::Tenant, AccessTokenType::User],
            body: vec![],
            ..Default::default()
        };

        // 添加查询参数
        if let Some(page_token) = request.page_token {
            api_req.query_params.insert("page_token", page_token);
        }

        if let Some(page_size) = request.page_size {
            api_req
                .query_params
                .insert("page_size", page_size.to_string());
        }

        if let Some(repo_id) = request.repo_id {
            api_req.query_params.insert("repo_id", repo_id);
        }

        if let Some(classification_id) = request.classification_id {
            api_req
                .query_params
                .insert("classification_id", classification_id);
        }

        if let Some(creator) = request.creator {
            api_req.query_params.insert("creator", creator);
        }

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

    /// 精准搜索词条
    ///
    /// 传入关键词,与词条的名称和别名精准匹配。
    ///
    /// # Arguments
    ///
    /// * `request` - 词条精准搜索请求
    /// * `option` - 请求选项,可选
    ///
    /// # Returns
    ///
    /// 返回匹配的词条列表
    pub async fn match_entities(
        &self,
        request: EntityMatchRequest,
        option: Option<RequestOption>,
    ) -> SDKResult<BaseResponse<EntityMatchResponse>> {
        let api_req = ApiRequest {
            http_method: Method::POST,
            api_path: LINGO_ENTITY_MATCH.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
    }

    /// 模糊搜索词条
    ///
    /// 传入关键词,对词条的名称、别名和释义等信息进行模糊匹配。
    ///
    /// # Arguments
    ///
    /// * `request` - 词条模糊搜索请求
    /// * `option` - 请求选项,可选
    ///
    /// # Returns
    ///
    /// 返回搜索结果列表
    pub async fn search_entities(
        &self,
        request: EntitySearchRequest,
        option: Option<RequestOption>,
    ) -> SDKResult<BaseResponse<EntitySearchResponse>> {
        let api_req = ApiRequest {
            http_method: Method::POST,
            api_path: LINGO_ENTITY_SEARCH.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
    }

    /// 词条高亮
    ///
    /// 传入一段文本,返回文本中匹配到的词条位置信息,可用于高亮显示。
    ///
    /// # Arguments
    ///
    /// * `request` - 词条高亮请求
    /// * `option` - 请求选项,可选
    ///
    /// # Returns
    ///
    /// 返回高亮信息
    pub async fn highlight_entities(
        &self,
        request: EntityHighlightRequest,
        option: Option<RequestOption>,
    ) -> SDKResult<BaseResponse<EntityHighlightResponse>> {
        let api_req = ApiRequest {
            http_method: Method::POST,
            api_path: LINGO_ENTITY_HIGHLIGHT.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
    }
}

/// 词条创建请求
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct EntityCreateRequest {
    /// 主名称
    pub main_keys: Vec<String>,
    /// 别名
    #[serde(skip_serializing_if = "Option::is_none")]
    pub aliases: Option<Vec<String>>,
    /// 词条释义富文本
    pub description: String,
    /// 分类ID
    #[serde(skip_serializing_if = "Option::is_none")]
    pub classification_id: Option<String>,
    /// 外链(用于跳转到释义页面)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub outer_info: Option<OuterInfo>,
    /// 相关词条ID列表
    #[serde(skip_serializing_if = "Option::is_none")]
    pub related_meta: Option<RelatedMeta>,
    /// 词库ID
    #[serde(skip_serializing_if = "Option::is_none")]
    pub repo_id: Option<String>,
}

/// 词条创建响应
#[derive(Debug, Serialize, Deserialize)]
pub struct EntityCreateResponse {
    /// 创建的词条信息
    pub entity: Entity,
}

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

/// 词条更新请求
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct EntityUpdateRequest {
    /// 主名称
    #[serde(skip_serializing_if = "Option::is_none")]
    pub main_keys: Option<Vec<String>>,
    /// 别名
    #[serde(skip_serializing_if = "Option::is_none")]
    pub aliases: Option<Vec<String>>,
    /// 词条释义富文本
    #[serde(skip_serializing_if = "Option::is_none")]
    pub description: Option<String>,
    /// 分类ID
    #[serde(skip_serializing_if = "Option::is_none")]
    pub classification_id: Option<String>,
    /// 外链(用于跳转到释义页面)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub outer_info: Option<OuterInfo>,
    /// 相关词条ID列表
    #[serde(skip_serializing_if = "Option::is_none")]
    pub related_meta: Option<RelatedMeta>,
}

/// 词条更新响应
#[derive(Debug, Serialize, Deserialize)]
pub struct EntityUpdateResponse {
    /// 更新后的词条信息
    pub entity: Entity,
}

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

/// 词条删除响应
#[derive(Debug, Serialize, Deserialize)]
pub struct EntityDeleteResponse {
    /// 删除成功标识
    pub success: bool,
}

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

/// 词条详情查询响应
#[derive(Debug, Serialize, Deserialize)]
pub struct EntityGetResponse {
    /// 词条详细信息
    pub entity: Entity,
}

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

/// 词条列表查询请求
#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct EntityListRequest {
    /// 页码标记
    #[serde(skip_serializing_if = "Option::is_none")]
    pub page_token: Option<String>,
    /// 每页数量
    #[serde(skip_serializing_if = "Option::is_none")]
    pub page_size: Option<i32>,
    /// 词库ID
    #[serde(skip_serializing_if = "Option::is_none")]
    pub repo_id: Option<String>,
    /// 分类ID
    #[serde(skip_serializing_if = "Option::is_none")]
    pub classification_id: Option<String>,
    /// 创建者ID
    #[serde(skip_serializing_if = "Option::is_none")]
    pub creator: Option<String>,
}

/// 词条列表查询响应
#[derive(Debug, Serialize, Deserialize)]
pub struct EntityListResponse {
    /// 词条列表
    #[serde(flatten)]
    pub entities: PageResponse<Entity>,
}

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

/// 词条精准搜索请求
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct EntityMatchRequest {
    /// 搜索词
    pub word: String,
    /// 词库ID
    #[serde(skip_serializing_if = "Option::is_none")]
    pub repo_id: Option<String>,
}

/// 词条精准搜索响应
#[derive(Debug, Serialize, Deserialize)]
pub struct EntityMatchResponse {
    /// 匹配结果列表
    pub results: Vec<EntityMatchResult>,
}

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

/// 词条模糊搜索请求
#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct EntitySearchRequest {
    /// 搜索关键词
    pub query: String,
    /// 分类ID
    #[serde(skip_serializing_if = "Option::is_none")]
    pub classification_id: Option<String>,
    /// 词库ID
    #[serde(skip_serializing_if = "Option::is_none")]
    pub repo_id: Option<String>,
    /// 搜索来源
    #[serde(skip_serializing_if = "Option::is_none")]
    pub sources: Option<Vec<String>>,
    /// 页码标记
    #[serde(skip_serializing_if = "Option::is_none")]
    pub page_token: Option<String>,
    /// 每页数量
    #[serde(skip_serializing_if = "Option::is_none")]
    pub page_size: Option<i32>,
}

/// 词条模糊搜索响应
#[derive(Debug, Serialize, Deserialize)]
pub struct EntitySearchResponse {
    /// 搜索结果列表
    #[serde(flatten)]
    pub results: PageResponse<EntitySearchResult>,
}

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

/// 词条高亮请求
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct EntityHighlightRequest {
    /// 要高亮的文本
    pub text: String,
    /// 词库ID
    #[serde(skip_serializing_if = "Option::is_none")]
    pub repo_id: Option<String>,
}

/// 词条高亮响应
#[derive(Debug, Serialize, Deserialize)]
pub struct EntityHighlightResponse {
    /// 高亮结果
    pub result: HighlightResult,
}

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