@satorijs/adapter-lark 3.8.6 → 3.9.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (121) hide show
  1. package/lib/bot.d.ts +1 -1
  2. package/lib/content.d.ts +433 -0
  3. package/lib/http.d.ts +1 -1
  4. package/lib/index.cjs +2792 -1719
  5. package/lib/index.d.ts +4 -2
  6. package/lib/internal.d.ts +37 -0
  7. package/lib/message.d.ts +2 -0
  8. package/lib/types/acs.d.ts +177 -0
  9. package/lib/types/admin.d.ts +270 -0
  10. package/lib/types/aily.d.ts +221 -0
  11. package/lib/types/apaas.d.ts +499 -0
  12. package/lib/types/application.d.ts +406 -0
  13. package/lib/types/approval.d.ts +779 -0
  14. package/lib/types/attendance.d.ts +957 -0
  15. package/lib/types/auth.d.ts +86 -0
  16. package/lib/types/authen.d.ts +191 -0
  17. package/lib/types/baike.d.ts +239 -0
  18. package/lib/types/bitable.d.ts +691 -0
  19. package/lib/types/board.d.ts +19 -0
  20. package/lib/types/calendar.d.ts +653 -0
  21. package/lib/types/cardkit.d.ts +139 -0
  22. package/lib/types/compensation.d.ts +54 -0
  23. package/lib/types/contact.d.ts +1137 -0
  24. package/lib/types/corehr.d.ts +4391 -0
  25. package/lib/types/docs.d.ts +23 -0
  26. package/lib/types/document_ai.d.ts +257 -0
  27. package/lib/types/docx.d.ts +380 -0
  28. package/lib/types/drive.d.ts +1053 -0
  29. package/lib/types/ehr.d.ts +32 -0
  30. package/lib/types/event.d.ts +9 -18
  31. package/lib/types/helpdesk.d.ts +746 -0
  32. package/lib/types/hire.d.ts +3150 -0
  33. package/lib/types/human_authentication.d.ts +27 -0
  34. package/lib/types/im.d.ts +1300 -0
  35. package/lib/types/index.d.ts +16432 -34
  36. package/lib/types/lingo.d.ts +254 -0
  37. package/lib/types/mail.d.ts +680 -0
  38. package/lib/types/mdm.d.ts +42 -0
  39. package/lib/types/minutes.d.ts +31 -0
  40. package/lib/types/moments.d.ts +18 -0
  41. package/lib/types/okr.d.ts +205 -0
  42. package/lib/types/optical_char_recognition.d.ts +17 -0
  43. package/lib/types/passport.d.ts +45 -0
  44. package/lib/types/payroll.d.ts +50 -0
  45. package/lib/types/performance.d.ts +413 -0
  46. package/lib/types/personal_settings.d.ts +87 -0
  47. package/lib/types/report.d.ts +57 -0
  48. package/lib/types/search.d.ts +216 -0
  49. package/lib/types/security_and_compliance.d.ts +24 -0
  50. package/lib/types/sheets.d.ts +326 -0
  51. package/lib/types/speech_to_text.d.ts +39 -0
  52. package/lib/types/task.d.ts +1153 -0
  53. package/lib/types/tenant.d.ts +23 -0
  54. package/lib/types/translation.d.ts +37 -0
  55. package/lib/types/vc.d.ts +948 -0
  56. package/lib/types/verification.d.ts +14 -0
  57. package/lib/types/wiki.d.ts +240 -0
  58. package/lib/types/workplace.d.ts +43 -0
  59. package/lib/utils.d.ts +143 -7
  60. package/package.json +6 -4
  61. package/src/bot.ts +19 -3
  62. package/src/{types/message/content.ts → content.ts} +1 -0
  63. package/src/http.ts +1 -3
  64. package/src/index.ts +4 -2
  65. package/src/internal.ts +143 -0
  66. package/src/message.ts +13 -11
  67. package/src/types/acs.ts +236 -0
  68. package/src/types/admin.ts +328 -0
  69. package/src/types/aily.ts +288 -0
  70. package/src/types/apaas.ts +646 -0
  71. package/src/types/application.ts +520 -0
  72. package/src/types/approval.ts +924 -0
  73. package/src/types/attendance.ts +1153 -0
  74. package/src/types/auth.ts +114 -0
  75. package/src/types/authen.ts +220 -0
  76. package/src/types/baike.ts +306 -0
  77. package/src/types/bitable.ts +879 -0
  78. package/src/types/board.ts +31 -0
  79. package/src/types/calendar.ts +817 -0
  80. package/src/types/cardkit.ts +182 -0
  81. package/src/types/compensation.ts +79 -0
  82. package/src/types/contact.ts +1411 -0
  83. package/src/types/corehr.ts +5297 -0
  84. package/src/types/docs.ts +33 -0
  85. package/src/types/document_ai.ts +352 -0
  86. package/src/types/docx.ts +471 -0
  87. package/src/types/drive.ts +1321 -0
  88. package/src/types/ehr.ts +43 -0
  89. package/src/types/event.ts +15 -21
  90. package/src/types/helpdesk.ts +925 -0
  91. package/src/types/hire.ts +3918 -0
  92. package/src/types/human_authentication.ts +38 -0
  93. package/src/types/im.ts +1605 -0
  94. package/src/types/index.ts +17754 -39
  95. package/src/types/lingo.ts +321 -0
  96. package/src/types/mail.ts +851 -0
  97. package/src/types/mdm.ts +57 -0
  98. package/src/types/minutes.ts +46 -0
  99. package/src/types/moments.ts +28 -0
  100. package/src/types/okr.ts +261 -0
  101. package/src/types/optical_char_recognition.ts +27 -0
  102. package/src/types/passport.ts +61 -0
  103. package/src/types/payroll.ts +69 -0
  104. package/src/types/performance.ts +524 -0
  105. package/src/types/personal_settings.ts +116 -0
  106. package/src/types/report.ts +77 -0
  107. package/src/types/search.ts +268 -0
  108. package/src/types/security_and_compliance.ts +33 -0
  109. package/src/types/sheets.ts +425 -0
  110. package/src/types/speech_to_text.ts +54 -0
  111. package/src/types/task.ts +1464 -0
  112. package/src/types/tenant.ts +36 -0
  113. package/src/types/translation.ts +52 -0
  114. package/src/types/vc.ts +1197 -0
  115. package/src/types/verification.ts +23 -0
  116. package/src/types/wiki.ts +313 -0
  117. package/src/types/workplace.ts +59 -0
  118. package/src/utils.ts +160 -8
  119. package/src/types/api.ts +0 -30848
  120. package/src/types/internal.ts +0 -84
  121. package/src/types/message/index.ts +0 -97
@@ -0,0 +1,114 @@
1
+ import { BaseResponse, Internal } from '../internal'
2
+
3
+ declare module '../internal' {
4
+ interface Internal {
5
+ /**
6
+ * 自建应用获取 tenant_access_token
7
+ * @see https://open.feishu.cn/document/ukTMukTMukTM/ukDNz4SO0MjL5QzM/auth-v3/auth/tenant_access_token_internal
8
+ */
9
+ tenantAccessTokenInternalAuth(body: TenantAccessTokenInternalAuthRequest): Promise<TenantAccessTokenInternalAuthResponse>
10
+ /**
11
+ * 自建应用获取 app_access_token
12
+ * @see https://open.feishu.cn/document/ukTMukTMukTM/ukDNz4SO0MjL5QzM/auth-v3/auth/app_access_token_internal
13
+ */
14
+ appAccessTokenInternalAuth(body: AppAccessTokenInternalAuthRequest): Promise<AppAccessTokenInternalAuthResponse>
15
+ /**
16
+ * 重新获取 app_ticket
17
+ * @see https://open.feishu.cn/document/ukTMukTMukTM/ukDNz4SO0MjL5QzM/auth-v3/auth/app_ticket_resend
18
+ */
19
+ appTicketResendAuth(body: AppTicketResendAuthRequest): Promise<void>
20
+ /**
21
+ * 商店应用获取 app_access_token
22
+ * @see https://open.feishu.cn/document/ukTMukTMukTM/ukDNz4SO0MjL5QzM/auth-v3/auth/app_access_token
23
+ */
24
+ appAccessTokenAuth(body: AppAccessTokenAuthRequest): Promise<AppAccessTokenAuthResponse>
25
+ /**
26
+ * 商店应用获取 tenant_access_token
27
+ * @see https://open.feishu.cn/document/ukTMukTMukTM/ukDNz4SO0MjL5QzM/auth-v3/auth/tenant_access_token
28
+ */
29
+ tenantAccessTokenAuth(body: TenantAccessTokenAuthRequest): Promise<TenantAccessTokenAuthResponse>
30
+ }
31
+ }
32
+
33
+ export interface TenantAccessTokenInternalAuthRequest {
34
+ /** 应用唯一标识,创建应用后获得 */
35
+ app_id: string
36
+ /** 应用秘钥,创建应用后获得 */
37
+ app_secret: string
38
+ }
39
+
40
+ export interface AppAccessTokenInternalAuthRequest {
41
+ /** 应用唯一标识,创建应用后获得 */
42
+ app_id: string
43
+ /** 应用秘钥,创建应用后获得 */
44
+ app_secret: string
45
+ }
46
+
47
+ export interface AppTicketResendAuthRequest {
48
+ /** 应用唯一标识,创建应用后获得 */
49
+ app_id: string
50
+ /** 应用秘钥,创建应用后获得 */
51
+ app_secret: string
52
+ }
53
+
54
+ export interface AppAccessTokenAuthRequest {
55
+ /** 应用唯一标识,创建应用后获得 */
56
+ app_id: string
57
+ /** 应用秘钥,创建应用后获得 */
58
+ app_secret: string
59
+ /** 平台定时推送给应用的临时凭证,通过事件监听机制获得 */
60
+ app_ticket: string
61
+ }
62
+
63
+ export interface TenantAccessTokenAuthRequest {
64
+ /** 应用唯一标识,创建应用 */
65
+ app_access_token: string
66
+ /** 应用秘钥,创建应用后获得 */
67
+ tenant_key: string
68
+ }
69
+
70
+ export interface TenantAccessTokenInternalAuthResponse extends BaseResponse {
71
+ /** 访问 token */
72
+ tenant_access_token?: string
73
+ /** app_access_token 过期时间 */
74
+ expire?: number
75
+ }
76
+
77
+ export interface AppAccessTokenInternalAuthResponse extends BaseResponse {
78
+ /** 访问 token */
79
+ app_access_token?: string
80
+ /** app_access_token 过期时间 */
81
+ expire?: number
82
+ }
83
+
84
+ export interface AppAccessTokenAuthResponse extends BaseResponse {
85
+ /** 访问 token */
86
+ app_access_token?: string
87
+ /** app_access_token 过期时间 */
88
+ expire?: number
89
+ }
90
+
91
+ export interface TenantAccessTokenAuthResponse extends BaseResponse {
92
+ /** 访问 token */
93
+ tenant_access_token?: string
94
+ /** app_access_token 过期时间 */
95
+ expire?: number
96
+ }
97
+
98
+ Internal.define({
99
+ '/auth/v3/tenant_access_token/internal': {
100
+ POST: { name: 'tenantAccessTokenInternalAuth', type: 'raw-json' },
101
+ },
102
+ '/auth/v3/app_access_token/internal': {
103
+ POST: { name: 'appAccessTokenInternalAuth', type: 'raw-json' },
104
+ },
105
+ '/auth/v3/app_ticket/resend': {
106
+ POST: 'appTicketResendAuth',
107
+ },
108
+ '/auth/v3/app_access_token': {
109
+ POST: { name: 'appAccessTokenAuth', type: 'raw-json' },
110
+ },
111
+ '/auth/v3/tenant_access_token': {
112
+ POST: { name: 'tenantAccessTokenAuth', type: 'raw-json' },
113
+ },
114
+ })
@@ -0,0 +1,220 @@
1
+ import { Internal } from '../internal'
2
+
3
+ declare module '../internal' {
4
+ interface Internal {
5
+ /**
6
+ * 获取用户信息
7
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/authen-v1/user_info/get
8
+ */
9
+ getAuthenUserInfo(): Promise<GetAuthenUserInfoResponse>
10
+ /**
11
+ * 获取 user_access_token
12
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/authen-v1/oidc-access_token/create
13
+ */
14
+ createAuthenOidcAccessToken(body: CreateAuthenOidcAccessTokenRequest): Promise<CreateAuthenOidcAccessTokenResponse>
15
+ /**
16
+ * 刷新 user_access_token
17
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/authen-v1/oidc-refresh_access_token/create
18
+ */
19
+ createAuthenOidcRefreshAccessToken(body: CreateAuthenOidcRefreshAccessTokenRequest): Promise<CreateAuthenOidcRefreshAccessTokenResponse>
20
+ /**
21
+ * 获取 user_access_token(v1 版本)
22
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/authen-v1/access_token/create
23
+ */
24
+ createAuthenAccessToken(body: CreateAuthenAccessTokenRequest): Promise<CreateAuthenAccessTokenResponse>
25
+ /**
26
+ * 刷新 user_access_token(v1 版本)
27
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/authen-v1/refresh_access_token/create
28
+ */
29
+ createAuthenRefreshAccessToken(body: CreateAuthenRefreshAccessTokenRequest): Promise<CreateAuthenRefreshAccessTokenResponse>
30
+ }
31
+ }
32
+
33
+ export interface CreateAuthenOidcAccessTokenRequest {
34
+ /** 授权类型,**固定值** */
35
+ grant_type: string
36
+ /** 登录预授权码 */
37
+ code: string
38
+ }
39
+
40
+ export interface CreateAuthenOidcRefreshAccessTokenRequest {
41
+ /** 授权类型,**固定值**: */
42
+ grant_type: string
43
+ /** 刷新 `user_access_token` 需要的凭证<br>获取user_access_token`接口和本接口均返回 `refresh_token`,**每次请求,请注意使用最新获取到的`refresh_token`** */
44
+ refresh_token: string
45
+ }
46
+
47
+ export interface CreateAuthenAccessTokenRequest {
48
+ /** 授权类型,**固定值** */
49
+ grant_type: string
50
+ /** 登录预授权码,调用[获取登录预授权码](https://open.feishu.cn/document/ukTMukTMukTM/ukzN4UjL5cDO14SO3gTN)接口获取 */
51
+ code: string
52
+ }
53
+
54
+ export interface CreateAuthenRefreshAccessTokenRequest {
55
+ /** 授权类型,**固定值**: */
56
+ grant_type: string
57
+ /** 刷新 `user_access_token` 需要的凭证<br>获取user_access_token`接口和本接口均返回 `refresh_token`,**每次请求,请注意使用最新获取到的`refresh_token`** */
58
+ refresh_token: string
59
+ }
60
+
61
+ export interface GetAuthenUserInfoResponse {
62
+ /** 用户姓名 */
63
+ name?: string
64
+ /** 用户英文名称 */
65
+ en_name?: string
66
+ /** 用户头像 */
67
+ avatar_url?: string
68
+ /** 用户头像 72x72 */
69
+ avatar_thumb?: string
70
+ /** 用户头像 240x240 */
71
+ avatar_middle?: string
72
+ /** 用户头像 640x640 */
73
+ avatar_big?: string
74
+ /** 用户在应用内的唯一标识 */
75
+ open_id?: string
76
+ /** 用户统一ID */
77
+ union_id?: string
78
+ /** 用户邮箱 */
79
+ email?: string
80
+ /** 企业邮箱,请先确保已在管理后台启用飞书邮箱服务 */
81
+ enterprise_email?: string
82
+ /** 用户 user_id */
83
+ user_id?: string
84
+ /** 用户手机号 */
85
+ mobile?: string
86
+ /** 当前企业标识 */
87
+ tenant_key?: string
88
+ /** 用户工号 */
89
+ employee_no?: string
90
+ }
91
+
92
+ export interface CreateAuthenOidcAccessTokenResponse {
93
+ /** user_access_token,用于获取用户资源和访问某些open api */
94
+ access_token: string
95
+ /** 刷新用户 `access_token` 时使用的 token */
96
+ refresh_token?: string
97
+ /** token 类型,固定值 */
98
+ token_type: string
99
+ /** `access_token`的有效期,单位: 秒,一般是两个小时左右,需要以返回结果为准 */
100
+ expires_in?: number
101
+ /** `refresh_token` 的有效期,单位: 秒,一般是30天左右,需要以返回结果为准 */
102
+ refresh_expires_in?: number
103
+ /** 用户授予app的权限全集 */
104
+ scope?: string
105
+ }
106
+
107
+ export interface CreateAuthenOidcRefreshAccessTokenResponse {
108
+ /** user_access_token,用于获取用户资源和访问某些open api */
109
+ access_token: string
110
+ /** 刷新用户 `access_token` 时使用的 token */
111
+ refresh_token?: string
112
+ /** token 类型,固定值 */
113
+ token_type: string
114
+ /** `access_token`的有效期,单位: 秒,一般是两个小时左右,需要以返回结果为准 */
115
+ expires_in?: number
116
+ /** `refresh_token` 的有效期,单位: 秒,一般是30天左右,需要以返回结果为准 */
117
+ refresh_expires_in?: number
118
+ /** 用户授予app的权限全集 */
119
+ scope?: string
120
+ }
121
+
122
+ export interface CreateAuthenAccessTokenResponse {
123
+ /** user_access_token,用于获取用户资源 */
124
+ access_token?: string
125
+ /** token 类型 */
126
+ token_type?: string
127
+ /** `access_token`的有效期,单位: 秒 */
128
+ expires_in?: number
129
+ /** 用户姓名 */
130
+ name?: string
131
+ /** 用户英文名称 */
132
+ en_name?: string
133
+ /** 用户头像 */
134
+ avatar_url?: string
135
+ /** 用户头像 72x72 */
136
+ avatar_thumb?: string
137
+ /** 用户头像 240x240 */
138
+ avatar_middle?: string
139
+ /** 用户头像 640x640 */
140
+ avatar_big?: string
141
+ /** 用户在应用内的唯一标识 */
142
+ open_id?: string
143
+ /** 用户统一ID */
144
+ union_id?: string
145
+ /** 用户邮箱 */
146
+ email?: string
147
+ /** 企业邮箱,请先确保已在管理后台启用飞书邮箱服务 */
148
+ enterprise_email?: string
149
+ /** 用户 user_id */
150
+ user_id?: string
151
+ /** 用户手机号 */
152
+ mobile?: string
153
+ /** 当前企业标识 */
154
+ tenant_key?: string
155
+ /** `refresh_token` 的有效期,单位: 秒 */
156
+ refresh_expires_in?: number
157
+ /** 刷新用户 `access_token` 时使用的 token */
158
+ refresh_token?: string
159
+ /** 用户当前登录态session的唯一标识,为空则不返回 */
160
+ sid?: string
161
+ }
162
+
163
+ export interface CreateAuthenRefreshAccessTokenResponse {
164
+ /** user_access_token,用于获取用户资源 */
165
+ access_token?: string
166
+ /** token 类型 */
167
+ token_type?: string
168
+ /** `access_token`的有效期,单位: 秒 */
169
+ expires_in?: number
170
+ /** 用户姓名 */
171
+ name?: string
172
+ /** 用户英文名称 */
173
+ en_name?: string
174
+ /** 用户头像 */
175
+ avatar_url?: string
176
+ /** 用户头像 72x72 */
177
+ avatar_thumb?: string
178
+ /** 用户头像 240x240 */
179
+ avatar_middle?: string
180
+ /** 用户头像 640x640 */
181
+ avatar_big?: string
182
+ /** 用户在应用内的唯一标识 */
183
+ open_id?: string
184
+ /** 用户统一ID */
185
+ union_id?: string
186
+ /** 用户邮箱 */
187
+ email?: string
188
+ /** 企业邮箱,请先确保已在管理后台启用飞书邮箱服务 */
189
+ enterprise_email?: string
190
+ /** 用户 user_id */
191
+ user_id?: string
192
+ /** 用户手机号 */
193
+ mobile?: string
194
+ /** 当前企业标识 */
195
+ tenant_key?: string
196
+ /** `refresh_token` 的有效期,单位: 秒 */
197
+ refresh_expires_in?: number
198
+ /** 刷新用户 `access_token` 时使用的 token */
199
+ refresh_token?: string
200
+ /** 用户当前登录态session的唯一标识,为空则不返回 */
201
+ sid?: string
202
+ }
203
+
204
+ Internal.define({
205
+ '/authen/v1/user_info': {
206
+ GET: 'getAuthenUserInfo',
207
+ },
208
+ '/authen/v1/oidc/access_token': {
209
+ POST: 'createAuthenOidcAccessToken',
210
+ },
211
+ '/authen/v1/oidc/refresh_access_token': {
212
+ POST: 'createAuthenOidcRefreshAccessToken',
213
+ },
214
+ '/authen/v1/access_token': {
215
+ POST: 'createAuthenAccessToken',
216
+ },
217
+ '/authen/v1/refresh_access_token': {
218
+ POST: 'createAuthenRefreshAccessToken',
219
+ },
220
+ })
@@ -0,0 +1,306 @@
1
+ import { Classification, ClassificationFilter, Draft, Entity, EntityWord, MatchInfo, OuterInfo, Phrase, RelatedMeta, Term } from '.'
2
+ import { Internal, Pagination } from '../internal'
3
+
4
+ declare module '../internal' {
5
+ interface Internal {
6
+ /**
7
+ * 创建草稿
8
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/draft/create
9
+ */
10
+ createBaikeDraft(body: CreateBaikeDraftRequest, query?: CreateBaikeDraftQuery): Promise<CreateBaikeDraftResponse>
11
+ /**
12
+ * 更新草稿
13
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/draft/update
14
+ */
15
+ updateBaikeDraft(draft_id: string, body: UpdateBaikeDraftRequest, query?: UpdateBaikeDraftQuery): Promise<UpdateBaikeDraftResponse>
16
+ /**
17
+ * 创建免审词条
18
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/entity/create
19
+ */
20
+ createBaikeEntity(body: CreateBaikeEntityRequest, query?: CreateBaikeEntityQuery): Promise<CreateBaikeEntityResponse>
21
+ /**
22
+ * 更新免审词条
23
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/entity/update
24
+ */
25
+ updateBaikeEntity(entity_id: string, body: UpdateBaikeEntityRequest, query?: UpdateBaikeEntityQuery): Promise<UpdateBaikeEntityResponse>
26
+ /**
27
+ * 获取词条详情
28
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/entity/get
29
+ */
30
+ getBaikeEntity(entity_id: string, query?: GetBaikeEntityQuery): Promise<GetBaikeEntityResponse>
31
+ /**
32
+ * 获取词条列表
33
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/entity/list
34
+ */
35
+ listBaikeEntity(query?: ListBaikeEntityQuery): Promise<ListBaikeEntityResponse>
36
+ /**
37
+ * 精准搜索词条
38
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/entity/match
39
+ */
40
+ matchBaikeEntity(body: MatchBaikeEntityRequest): Promise<MatchBaikeEntityResponse>
41
+ /**
42
+ * 模糊搜索词条
43
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/entity/search
44
+ */
45
+ searchBaikeEntity(body: SearchBaikeEntityRequest, query?: SearchBaikeEntityQuery): Promise<SearchBaikeEntityResponse>
46
+ /**
47
+ * 词条高亮
48
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/entity/highlight
49
+ */
50
+ highlightBaikeEntity(body: HighlightBaikeEntityRequest): Promise<HighlightBaikeEntityResponse>
51
+ /**
52
+ * 提取潜在的词条
53
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/entity/extract
54
+ */
55
+ extractBaikeEntity(body: ExtractBaikeEntityRequest): Promise<ExtractBaikeEntityResponse>
56
+ /**
57
+ * 获取词典分类
58
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/classification/list
59
+ */
60
+ listBaikeClassification(query?: Pagination): Promise<ListBaikeClassificationResponse>
61
+ /**
62
+ * 上传图片
63
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/file/upload
64
+ */
65
+ uploadBaikeFile(form: UploadBaikeFileForm): Promise<UploadBaikeFileResponse>
66
+ /**
67
+ * 下载图片
68
+ * @see https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/file/download
69
+ */
70
+ downloadBaikeFile(file_token: string): Promise<ArrayBuffer>
71
+ }
72
+ }
73
+
74
+ export interface CreateBaikeDraftRequest {
75
+ /** 实体词 Id */
76
+ id?: string
77
+ /** 词条名 */
78
+ main_keys: Term[]
79
+ /** 别名 */
80
+ aliases?: Term[]
81
+ /** 详情描述 */
82
+ description?: string
83
+ /** 相关数据 */
84
+ related_meta?: RelatedMeta
85
+ /** 外部 id 关联数据 */
86
+ outer_info?: OuterInfo
87
+ /** 富文本格式(当填写富文本内容时,description字段将会失效可不填写),支持的格式参考[企业百科指南](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/overview)中的释义部分 */
88
+ rich_text?: string
89
+ }
90
+
91
+ export interface CreateBaikeDraftQuery {
92
+ /** 此次调用中使用的用户ID的类型 */
93
+ user_id_type?: 'user_id' | 'union_id' | 'open_id'
94
+ }
95
+
96
+ export interface UpdateBaikeDraftRequest {
97
+ /** 实体词 Id */
98
+ id?: string
99
+ /** 词条名 */
100
+ main_keys: Term[]
101
+ /** 别名 */
102
+ aliases?: Term[]
103
+ /** 详情描述 */
104
+ description?: string
105
+ /** 相关数据 */
106
+ related_meta?: RelatedMeta
107
+ /** 富文本格式(当填写富文本内容时,description字段将会失效可不填写),支持的格式参考[企业百科指南](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/overview)中的释义部分 */
108
+ rich_text?: string
109
+ }
110
+
111
+ export interface UpdateBaikeDraftQuery {
112
+ /** 此次调用中使用的用户ID的类型 */
113
+ user_id_type?: 'user_id' | 'union_id' | 'open_id'
114
+ }
115
+
116
+ export interface CreateBaikeEntityRequest {
117
+ /** 词条名 */
118
+ main_keys: Term[]
119
+ /** 别名 */
120
+ aliases?: Term[]
121
+ /** 详情描述 */
122
+ description?: string
123
+ /** 相关数据 */
124
+ related_meta?: RelatedMeta
125
+ /** 外部 id 关联数据 */
126
+ outer_info?: OuterInfo
127
+ /** 富文本格式(当填写富文本内容时,description字段将会失效可不填写),支持的格式参考[企业百科指南](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/overview)中的释义部分 */
128
+ rich_text?: string
129
+ }
130
+
131
+ export interface CreateBaikeEntityQuery {
132
+ /** 此次调用中使用的用户ID的类型 */
133
+ user_id_type?: 'user_id' | 'union_id' | 'open_id'
134
+ }
135
+
136
+ export interface UpdateBaikeEntityRequest {
137
+ /** 词条名 */
138
+ main_keys: Term[]
139
+ /** 别名 */
140
+ aliases?: Term[]
141
+ /** 详情描述 */
142
+ description?: string
143
+ /** 相关数据 */
144
+ related_meta?: RelatedMeta
145
+ /** 外部 id 关联数据 */
146
+ outer_info?: OuterInfo
147
+ /** 富文本格式(当填写富文本内容时,description字段将会失效可不填写),支持的格式参考[企业百科指南](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/baike-v1/overview)中的释义部分 */
148
+ rich_text?: string
149
+ }
150
+
151
+ export interface UpdateBaikeEntityQuery {
152
+ /** 此次调用中使用的用户ID的类型 */
153
+ user_id_type?: 'user_id' | 'union_id' | 'open_id'
154
+ }
155
+
156
+ export interface GetBaikeEntityQuery {
157
+ /** 外部系统 */
158
+ provider?: string
159
+ /** 词条在外部系统中对应的唯一 ID */
160
+ outer_id?: string
161
+ /** 此次调用中使用的用户ID的类型 */
162
+ user_id_type?: 'user_id' | 'union_id' | 'open_id'
163
+ }
164
+
165
+ export interface ListBaikeEntityQuery extends Pagination {
166
+ /** 相关外部系统【可用来过滤词条数据】 */
167
+ provider?: string
168
+ /** 此次调用中使用的用户ID的类型 */
169
+ user_id_type?: 'user_id' | 'union_id' | 'open_id'
170
+ }
171
+
172
+ export interface MatchBaikeEntityRequest {
173
+ /** 搜索关键词,将与词条名、别名进行精准匹配 */
174
+ word: string
175
+ }
176
+
177
+ export interface SearchBaikeEntityRequest {
178
+ /** 搜索关键词 */
179
+ query?: string
180
+ /** 分类筛选 */
181
+ classification_filter?: ClassificationFilter
182
+ /** 词条的创建来源,1:用户主动创建,2:批量导入,3:官方词,4:OpenAPI 创建 */
183
+ sources?: number[]
184
+ /** 创建者 */
185
+ creators?: string[]
186
+ }
187
+
188
+ export interface SearchBaikeEntityQuery extends Pagination {
189
+ /** 此次调用中使用的用户ID的类型 */
190
+ user_id_type?: 'user_id' | 'union_id' | 'open_id'
191
+ }
192
+
193
+ export interface HighlightBaikeEntityRequest {
194
+ /** 需要识别百科词条的内容(不超过1000字) */
195
+ text: string
196
+ }
197
+
198
+ export interface ExtractBaikeEntityRequest {
199
+ /** 需要被提取百科实体词的文本(不会过滤租户已成为百科词条的内容) */
200
+ text?: string
201
+ }
202
+
203
+ export interface UploadBaikeFileForm {
204
+ /** 文件名称,当前仅支持上传图片且图片格式为以下六种:icon、bmp、gif、png、jpeg、webp */
205
+ name: string
206
+ /** 二进制文件内容,高宽像素在 320-4096 像素之间,大小在 3KB-10MB 的图片 */
207
+ file: Blob
208
+ }
209
+
210
+ export interface CreateBaikeDraftResponse {
211
+ draft?: Draft
212
+ }
213
+
214
+ export interface UpdateBaikeDraftResponse {
215
+ draft?: Draft
216
+ }
217
+
218
+ export interface CreateBaikeEntityResponse {
219
+ entity?: Entity
220
+ }
221
+
222
+ export interface UpdateBaikeEntityResponse {
223
+ entity?: Entity
224
+ }
225
+
226
+ export interface GetBaikeEntityResponse {
227
+ /** 实体词 */
228
+ entity?: Entity
229
+ }
230
+
231
+ export interface ListBaikeEntityResponse {
232
+ entities?: Entity[]
233
+ /** 分页标记,当还有下一页时会返回新的 page_token,否则 page_token 为空 */
234
+ page_token?: string
235
+ }
236
+
237
+ export interface MatchBaikeEntityResponse {
238
+ /** 匹配结果 */
239
+ results?: MatchInfo[]
240
+ }
241
+
242
+ export interface SearchBaikeEntityResponse {
243
+ /** 数据数组 */
244
+ entities?: Entity[]
245
+ /** 分页标记,当还有下一页时会返回新的 page_token,否则 page_token 为空 */
246
+ page_token?: string
247
+ }
248
+
249
+ export interface HighlightBaikeEntityResponse {
250
+ /** 返回识别到的实体词信息 */
251
+ phrases?: Phrase[]
252
+ }
253
+
254
+ export interface ExtractBaikeEntityResponse {
255
+ /** 文本中可能的成为百科词条的实体词 */
256
+ entity_word: EntityWord[]
257
+ }
258
+
259
+ export interface ListBaikeClassificationResponse {
260
+ items?: Classification[]
261
+ /** 分页标记,当还有下一页时会返回新的 page_token,否则 page_token 为空 */
262
+ page_token?: string
263
+ }
264
+
265
+ export interface UploadBaikeFileResponse {
266
+ /** 文件 token */
267
+ file_token?: string
268
+ }
269
+
270
+ Internal.define({
271
+ '/baike/v1/drafts': {
272
+ POST: 'createBaikeDraft',
273
+ },
274
+ '/baike/v1/drafts/{draft_id}': {
275
+ PUT: 'updateBaikeDraft',
276
+ },
277
+ '/baike/v1/entities': {
278
+ POST: 'createBaikeEntity',
279
+ GET: 'listBaikeEntity',
280
+ },
281
+ '/baike/v1/entities/{entity_id}': {
282
+ PUT: 'updateBaikeEntity',
283
+ GET: 'getBaikeEntity',
284
+ },
285
+ '/baike/v1/entities/match': {
286
+ POST: 'matchBaikeEntity',
287
+ },
288
+ '/baike/v1/entities/search': {
289
+ POST: 'searchBaikeEntity',
290
+ },
291
+ '/baike/v1/entities/highlight': {
292
+ POST: 'highlightBaikeEntity',
293
+ },
294
+ '/baike/v1/entities/extract': {
295
+ POST: 'extractBaikeEntity',
296
+ },
297
+ '/baike/v1/classifications': {
298
+ GET: 'listBaikeClassification',
299
+ },
300
+ '/baike/v1/files/upload': {
301
+ POST: { name: 'uploadBaikeFile', multipart: true },
302
+ },
303
+ '/baike/v1/files/{file_token}/download': {
304
+ GET: { name: 'downloadBaikeFile', type: 'binary' },
305
+ },
306
+ })