@zhizai/cli 0.0.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.
@@ -0,0 +1,466 @@
1
+ # 智在记录 · 团队
2
+
3
+ 团队与成员的增删改查。纯团队运维可跳过动态模版管线。删除团队/成员、加人前必须向用户确认。
4
+
5
+ ## 统一结果判定
6
+
7
+ 先看 HTTP:`400`/`401`/`406` → 无权限(检查 `ZHIZAI_REC_API_KEY`)。再看 JSON:`resultCode == "0"` 为成功。
8
+
9
+ ```json
10
+ {
11
+ "resultCode": "0",
12
+ "resultMsg": "success",
13
+ "resultObject": {},
14
+ "stack": "",
15
+ "errorInfos": null,
16
+ "guidance": null
17
+ }
18
+ ```
19
+
20
+ 对用户:可用 `resultMsg` 短句;禁止展示完整 Key、`stack`、未脱敏 `errorInfos`。限流 ≤2 次/秒。
21
+
22
+ `ZHIZAI_BASE_URL` = `https://openapi.zzjilu.com/api/v1`。Header:`Authorization: ${ZHIZAI_REC_API_KEY}`(无 Bearer)。
23
+
24
+
25
+ ## 意图路由
26
+
27
+ | 意图 | 接口 |
28
+ |---|---|
29
+ | 添加团队 | `POST /team/addTeam` |
30
+ | 更新团队 | `POST /team/updateTeam` |
31
+ | 删除团队 | `GET /team/deleteTeam`(仅无子团队) |
32
+ | 团队树 | `POST /team/queryTeamTree` |
33
+ | 成员分页 | `POST /team/queryTeamMemberPage` |
34
+ | 添加成员 | `POST /team/addTeamMember`(`phone` 必填) |
35
+ | 删除成员 | `GET /team/deleteTeamMember` |
36
+
37
+ ## 使用注意
38
+
39
+ - 展示成员 `phone`/`email` 时脱敏;勿整表无差别导出。
40
+ - `memberType=team` 时传 `memberTeamId`;默认 `person`。
41
+ - 头像可用 `uploadSingleFile` 得到的 `fileId`。
42
+
43
+ ## 接口协议
44
+
45
+ ### POST `/team/addTeam` 添加团队
46
+
47
+ **接口说明**:添加团队
48
+
49
+ #### 请求参数
50
+
51
+ | 参数名 | 类型 | 必填 | 说明 |
52
+ | --- | --- | --- | --- |
53
+ | parentTeamId | Long | 否 | 父级团队ID(不传则创建根团队) |
54
+ | teamName | string | 是 | 团队名称 |
55
+ | description | string | 否 | 团队描述 |
56
+ | sortOrder | Long | 否 | 排序 |
57
+ | avatarFileId | string | 否 | 团队头像文件ID |
58
+
59
+ #### 请求示例
60
+
61
+ ```bash
62
+ curl --request POST \
63
+ --url https://openapi.zzjilu.com/api/v1/team/addTeam\
64
+ --header 'Authorization: your api-key' \
65
+ --header 'content-type: application/json' \
66
+ --data '{
67
+ "parentTeamId": 0,
68
+ "teamName": "",
69
+ "description": "",
70
+ "sortOrder": 0
71
+ }'
72
+ ```
73
+
74
+ #### 响应参数
75
+
76
+ | 参数名 | 类型 | 必填 | 说明 |
77
+ | --- | --- | --- | --- |
78
+ | resultCode | string | 是 | 结果码 |
79
+ | resultMsg | string | 是 | 结果信息 |
80
+ | resultObject | Long | 是 | 返回数据 |
81
+ | stack | string | 是 | 异常堆栈信息 |
82
+ | errorInfos | null | 是 | 错误信息列表(为null) |
83
+ | guidance | null | 是 | 引导信息(为null) |
84
+
85
+ #### 响应示例
86
+
87
+ ```json
88
+ {
89
+ "resultCode": "0",
90
+ "resultMsg": "success",
91
+ "resultObject": 6218980040421376,
92
+ "stack": "",
93
+ "errorInfos": null,
94
+ "guidance": null
95
+ }
96
+ ```
97
+
98
+ ### POST `/team/queryTeamMemberPage` 查询团队成员列表(分页)
99
+
100
+ **接口说明**:查询团队成员列表(分页)
101
+
102
+ #### 请求参数
103
+
104
+ | 参数名 | 类型 | 必填 | 说明 |
105
+ | --- | --- | --- | --- |
106
+ | pageNum | Integer | 否 | 页数,默认 1 |
107
+ | pageSize | Integer | 否 | 每页数量,默认 20 |
108
+ | teamId | Long | 是 | 团队ID |
109
+ | keyword | string | 否 | 搜索关键词(姓名、组织、部门) |
110
+ | querySubTeamFlag | boolean | 否 | 是否查询子团队,默认false,true:则查询当前团队及所有子团队的数据 |
111
+
112
+ #### 请求示例
113
+
114
+ ```bash
115
+ curl --request POST \
116
+ --url https://openapi.zzjilu.com/api/v1/team/queryTeamMemberPage\
117
+ --header 'Authorization: your api-key' \
118
+ --header 'content-type: application/json' \
119
+ --data '{
120
+ "pageNum": 0,
121
+ "pageSize": 0,
122
+ "teamId": 0,
123
+ "keyword": "",
124
+ "querySubTeamFlag": true
125
+ }'
126
+ ```
127
+
128
+ #### 响应参数
129
+
130
+ | 参数名 | 类型 | 必填 | 说明 |
131
+ | --- | --- | --- | --- |
132
+ | resultCode | string | 是 | 状态码,0 表示成功, 其它均为失败 |
133
+ | resultMsg | string | 是 | 提示信息 |
134
+ | resultObject | object | 是 | 分页结果对象 |
135
+ | stack | string | 是 | 异常堆栈信息 |
136
+
137
+ #### 响应示例
138
+
139
+ ```json
140
+ {
141
+ "resultCode": "",
142
+ "resultMsg": "",
143
+ "resultObject": {
144
+ "total": 0,
145
+ "list": [
146
+ {
147
+ "id": 0,
148
+ "teamId": 0,
149
+ "memberType": "",
150
+ "memberTeamId": 0,
151
+ "memberPersonId": 0,
152
+ "memberName": "",
153
+ "role": "",
154
+ "position": "",
155
+ "isManager": "",
156
+ "displayOrder": 0,
157
+ "employeeId": "",
158
+ "email": "",
159
+ "phone": "",
160
+ "organization": "",
161
+ "department": "",
162
+ "avatarFileId": "",
163
+ "joinDate": "",
164
+ "subFlag": true
165
+ }
166
+ ],
167
+ "pageNum": 0,
168
+ "pageSize": 0,
169
+ "size": 0,
170
+ "startRow": 0,
171
+ "endRow": 0,
172
+ "pages": 0,
173
+ "prePage": 0,
174
+ "nextPage": 0,
175
+ "isFirstPage": true,
176
+ "isLastPage": true,
177
+ "hasPreviousPage": true,
178
+ "hasNextPage": true,
179
+ "navigatePages": 0,
180
+ "navigatepageNums": [],
181
+ "navigateFirstPage": 0,
182
+ "navigateLastPage": 0
183
+ },
184
+ "stack": ""
185
+ }
186
+ ```
187
+
188
+ ### GET `/team/deleteTeam` 删除团队
189
+
190
+ **接口说明**:删除团队(只能删除没有子团队的团队)
191
+
192
+ #### 请求参数
193
+
194
+ | 参数名 | 类型 | 必填 | 说明 |
195
+ | --- | --- | --- | --- |
196
+ | teamId | Long | 是 | 团队ID |
197
+
198
+ #### 请求示例
199
+
200
+ ```bash
201
+ curl --request GET \
202
+ --url https://openapi.zzjilu.com/api/v1/team/deleteTeam?teamId=0\
203
+ --header 'Authorization: your api-key'
204
+ ```
205
+
206
+ #### 响应参数
207
+
208
+ | 参数名 | 类型 | 必填 | 说明 |
209
+ | --- | --- | --- | --- |
210
+ | resultCode | string | 是 | 状态码,0 表示成功, 其它均为失败 |
211
+ | resultMsg | string | 是 | 提示信息 |
212
+ | resultObject | null | 是 | 返回数据对象(为null) |
213
+ | stack | string | 是 | 异常堆栈信息 |
214
+
215
+ #### 响应示例
216
+
217
+ ```json
218
+ {
219
+ "resultCode": "0",
220
+ "resultMsg": "success",
221
+ "resultObject": null,
222
+ "stack": ""
223
+ }
224
+ ```
225
+
226
+ ### POST `/team/addTeamMember` 添加团队成员
227
+
228
+ **接口说明**:添加团队成员
229
+
230
+ #### 请求参数
231
+
232
+ | 参数名 | 类型 | 必填 | 说明 |
233
+ | --- | --- | --- | --- |
234
+ | teamId | Long | 是 | 团队ID |
235
+ | memberType | string | 否 | 成员类型:team-子团队,person-个人(默认person) |
236
+ | memberTeamId | Long | 否 | 子团队ID(memberType=team时有效) |
237
+ | memberPersonId | Long | 否 | 个人ID(memberType=person时有效) |
238
+ | memberName | string | 否 | 在团队中显示的名称(可自定义) |
239
+ | role | string | 否 | 角色 |
240
+ | position | string | 否 | 职位/职级 |
241
+ | permissions | string | 否 | 权限配置(json格式) |
242
+ | isManager | string | 否 | 是否是管理者(true-是,false-否) |
243
+ | employeeId | string | 否 | 工号 |
244
+ | email | string | 否 | 邮箱 |
245
+ | phone | string | 是 | 手机号 |
246
+ | avatarFileId | string | 否 | 头像文件ID |
247
+
248
+ #### 请求示例
249
+
250
+ ```bash
251
+ curl --request POST \
252
+ --url https://openapi.zzjilu.com/api/v1/team/addTeamMember\
253
+ --header 'Authorization: your api-key' \
254
+ --header 'content-type: application/json' \
255
+ --data '{
256
+ "teamId": 0,
257
+ "memberType": "person",
258
+ "memberName": "",
259
+ "employeeId": "",
260
+ "email": "",
261
+ "phone": ""
262
+ }'
263
+ ```
264
+
265
+ #### 响应参数
266
+
267
+ | 参数名 | 类型 | 必填 | 说明 |
268
+ | --- | --- | --- | --- |
269
+ | resultCode | string | 是 | 结果码 |
270
+ | resultMsg | string | 是 | 结果信息 |
271
+ | resultObject | Long | 是 | 返回数据(团队成员ID) |
272
+ | stack | string | 是 | 异常堆栈信息 |
273
+ | errorInfos | null | 是 | 错误信息列表(为null) |
274
+ | guidance | null | 是 | 引导信息(为null) |
275
+
276
+ #### 响应示例
277
+
278
+ ```json
279
+ {
280
+ "resultCode": "0",
281
+ "resultMsg": "success",
282
+ "resultObject": 1234567890123456800,
283
+ "stack": "",
284
+ "errorInfos": null,
285
+ "guidance": null
286
+ }
287
+ ```
288
+
289
+ ### GET `/team/deleteTeamMember` 删除团队成员
290
+
291
+ **接口说明**:删除团队成员
292
+
293
+ #### 请求参数
294
+
295
+ | 参数名 | 类型 | 必填 | 说明 |
296
+ | --- | --- | --- | --- |
297
+ | memberId | Long | 是 | 团队成员ID |
298
+
299
+ #### 请求示例
300
+
301
+ ```bash
302
+ curl --request GET \
303
+ --url 'https://openapi.zzjilu.com/api/v1/team/deleteTeamMember?memberId=12345' \
304
+ --header 'Authorization: your api-key'
305
+ ```
306
+
307
+ #### 响应参数
308
+
309
+ | 参数名 | 类型 | 必填 | 说明 |
310
+ | --- | --- | --- | --- |
311
+ | resultCode | string | 是 | 状态码,0 表示成功, 其它均为失败 |
312
+ | resultMsg | string | 是 | 提示信息 |
313
+ | resultObject | null | 是 | 返回数据对象(为null) |
314
+ | stack | string | 是 | 异常堆栈信息 |
315
+ | errorInfos | array | 否 | 错误信息列表 |
316
+ | guidance | string | 否 | 引导信息 |
317
+
318
+ #### 响应示例
319
+
320
+ ```json
321
+ {
322
+ "resultCode": "0",
323
+ "resultMsg": "success",
324
+ "resultObject": null,
325
+ "stack": "",
326
+ "errorInfos": null,
327
+ "guidance": null
328
+ }
329
+ ```
330
+
331
+ ### POST `/team/updateTeam` 更新团队
332
+
333
+ **接口说明**:更新团队
334
+
335
+ #### 请求参数
336
+
337
+ | 参数名 | 类型 | 必填 | 说明 |
338
+ | --- | --- | --- | --- |
339
+ | teamId | Long | 是 | 团队ID |
340
+ | teamName | string | 否 | 团队名称 |
341
+ | description | string | 否 | 团队描述 |
342
+ | sortOrder | Long | 否 | 排序 |
343
+ | avatarFileId | string | 否 | 团队头像文件ID |
344
+
345
+ #### 请求示例
346
+
347
+ ```bash
348
+ curl --request POST \
349
+ --url https://openapi.zzjilu.com/api/v1/team/updateTeam\
350
+ --header 'Authorization: your api-key' \
351
+ --header 'content-type: application/json' \
352
+ --data '{
353
+ "teamId": 0,
354
+ "teamName": "",
355
+ "description": "",
356
+ "sortOrder": 0
357
+ }'
358
+ ```
359
+
360
+ #### 响应参数
361
+
362
+ | 参数名 | 类型 | 必填 | 说明 |
363
+ | --- | --- | --- | --- |
364
+ | resultCode | string | 是 | 结果码 |
365
+ | resultMsg | string | 是 | 结果信息 |
366
+ | resultObject | null | 是 | 返回数据对象(为null) |
367
+ | stack | string | 是 | 异常堆栈信息 |
368
+ | errorInfos | null | 是 | 错误信息列表(为null) |
369
+ | guidance | null | 是 | 引导信息(为null) |
370
+
371
+ #### 响应示例
372
+
373
+ ```json
374
+ {
375
+ "resultCode": "0",
376
+ "resultMsg": "success",
377
+ "resultObject": null,
378
+ "stack": "",
379
+ "errorInfos": null,
380
+ "guidance": null
381
+ }
382
+ ```
383
+
384
+ ### POST `/team/queryTeamTree` 查询团队树
385
+
386
+ **接口说明**:查询团队树形结构
387
+
388
+ #### 请求参数
389
+
390
+ | 参数名 | 类型 | 必填 | 说明 |
391
+ | --- | --- | --- | --- |
392
+ | keyword | string | 否 | 搜索关键词(组织或成员名称) |
393
+ | parentTeamId | Long | 否 | 父团队ID(不传则查询根团队) |
394
+
395
+ #### 请求示例
396
+
397
+ ```bash
398
+ curl --request POST \
399
+ --url https://openapi.zzjilu.com/api/v1/team/queryTeamTree\
400
+ --header 'Authorization: your api-key' \
401
+ --header 'content-type: application/json' \
402
+ --data '{
403
+ "keyword": "",
404
+ "parentTeamId": 0
405
+ }'
406
+ ```
407
+
408
+ #### 响应参数
409
+
410
+ | 参数名 | 类型 | 必填 | 说明 |
411
+ | --- | --- | --- | --- |
412
+ | resultCode | string | 是 | 状态码,0 表示成功, 其它均为失败 |
413
+ | resultMsg | string | 是 | 提示信息 |
414
+ | resultObject | array | 是 | 团队树数据集合 |
415
+ | stack | string | 是 | 异常堆栈信息 |
416
+
417
+ #### 响应示例
418
+
419
+ ```json
420
+ {
421
+ "resultCode": "0",
422
+ "resultMsg": "success",
423
+ "resultObject": [
424
+ {
425
+ "teamId": 0,
426
+ "memberTeamId": 0,
427
+ "employeeId": null,
428
+ "userId": 0,
429
+ "teamCode": "",
430
+ "teamName": "",
431
+ "fullTeamName": "",
432
+ "description": "",
433
+ "avatarFileId": "",
434
+ "teamLevel": 0,
435
+ "memberCount": 0,
436
+ "phone": "",
437
+ "isFriend": true,
438
+ "authorize": true,
439
+ "subFlag": true,
440
+ "sortOrder": 0,
441
+ "children": [
442
+ {
443
+ "teamId": 0,
444
+ "memberTeamId": 0,
445
+ "employeeId": null,
446
+ "userId": 0,
447
+ "teamCode": "",
448
+ "teamName": "",
449
+ "fullTeamName": "",
450
+ "description": "",
451
+ "avatarFileId": "",
452
+ "teamLevel": 0,
453
+ "memberCount": 0,
454
+ "phone": "",
455
+ "isFriend": true,
456
+ "authorize": true,
457
+ "subFlag": true,
458
+ "sortOrder": 0,
459
+ "children": []
460
+ }
461
+ ]
462
+ }
463
+ ],
464
+ "stack": ""
465
+ }
466
+ ```
@@ -0,0 +1,19 @@
1
+ ---
2
+ name: zhizai-auth
3
+ description: 安装和连接智在记录,完成 API Key 配置、环境诊断与 CLI 升级。用户说安装、连接、登录、检查为什么不能用时使用。
4
+ ---
5
+
6
+ # 智在记录连接与诊断
7
+
8
+ 通过官方 `zhizai` CLI 完成真实操作。机器调用优先使用 `-o json`。
9
+
10
+ ## 路由
11
+
12
+ | 意图 | 命令 |
13
+ |---|---|
14
+ | 登录 | `zhizai auth login --api-key <key>` |
15
+ | 查看状态 | `zhizai auth status` |
16
+ | 退出 | `zhizai auth logout` |
17
+ | 诊断 | `zhizai doctor -o json` |
18
+ | 能力契约 | `zhizai capabilities -o json` |
19
+ | 安装 Skill | `zhizai setup` |
@@ -0,0 +1,12 @@
1
+ ---
2
+ name: zhizai-knowledge
3
+ description: 查询和管理智在记录笔记集。
4
+ ---
5
+
6
+ # 智在记录笔记集
7
+
8
+ | 意图 | 命令 |
9
+ |---|---|
10
+ | 笔记集操作 | `zhizai knowledge -o json` |
11
+
12
+ 字段说明见 `skills/zhiji-open-platform/references/knowledge.md`。
@@ -0,0 +1,12 @@
1
+ ---
2
+ name: zhizai-msg
3
+ description: 发送消息与查询录音卡使用情况。
4
+ ---
5
+
6
+ # 智在记录消息与录音卡
7
+
8
+ | 意图 | 命令 |
9
+ |---|---|
10
+ | 消息与录音卡 | `zhizai msg -o json` |
11
+
12
+ 字段说明见 `skills/zhiji-open-platform/references/msg-device.md`。
@@ -0,0 +1,21 @@
1
+ ---
2
+ name: zhizai-note
3
+ description: 使用智在记录 CLI 查询、创建、更新和删除笔记,上传文件并查看处理进度。
4
+ ---
5
+
6
+ # 智在记录笔记
7
+
8
+ 通过官方 `zhizai` CLI 完成真实操作。参数与字段说明见仓库内 `skills/zhiji-open-platform/references/note.md`。
9
+
10
+ ## 路由
11
+
12
+ | 意图 | 命令 |
13
+ |---|---|
14
+ | 笔记列表 | `zhizai notes -o json` |
15
+ | 笔记详情 | `zhizai note get <id> -o json` |
16
+ | 创建笔记 | `zhizai note create` |
17
+ | 更新笔记 | `zhizai note update` |
18
+ | 删除笔记 | `zhizai note delete` |
19
+ | 处理进度 | `zhizai note status <id> -o json` |
20
+ | 上传文件 | `zhizai file upload <path>` |
21
+ | 问答总结 | `zhizai ask "<问题>" -o json` |
@@ -0,0 +1,12 @@
1
+ ---
2
+ name: zhizai-scene
3
+ description: 查询智在记录总结场景与知识卡。
4
+ ---
5
+
6
+ # 智在记录场景
7
+
8
+ | 意图 | 命令 |
9
+ |---|---|
10
+ | 场景与知识卡 | `zhizai scene -o json` |
11
+
12
+ 字段说明见 `skills/zhiji-open-platform/references/scene.md`。
@@ -0,0 +1,12 @@
1
+ ---
2
+ name: zhizai-team
3
+ description: 管理智在记录团队与成员。
4
+ ---
5
+
6
+ # 智在记录团队
7
+
8
+ | 意图 | 命令 |
9
+ |---|---|
10
+ | 团队操作 | `zhizai team -o json` |
11
+
12
+ 危险操作须先确认。字段说明见 `skills/zhiji-open-platform/references/team.md`。