@thinkingai/ae-cli 6.1.24 → 6.1.26
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.
- package/README.md +35 -10
- package/README.zh.md +32 -10
- package/bin/ae-cli.js +6 -1
- package/cli-installation-guide.md +91 -0
- package/dist/{auth-XZNXFRJS.js → auth-YHMC3GDH.js} +168 -10
- package/dist/automation-NWWVLWG2.js +459 -0
- package/dist/{capability-FYTU3X6L.js → capability-3QLLIVFB.js} +11 -6
- package/dist/chunk-4655PUNX.js +43 -0
- package/dist/{chunk-4NRCTUZJ.js → chunk-5XJYLEVC.js} +4 -4
- package/dist/{chunk-JOCDD4ON.js → chunk-7QXISROD.js} +1 -1
- package/dist/{chunk-EQ255HKO.js → chunk-AP7YP2NX.js} +2 -2
- package/dist/{chunk-DVMLWQD4.js → chunk-CT7QDJS6.js} +2 -2
- package/dist/chunk-D6ACFILC.js +56 -0
- package/dist/{chunk-HFGZGYCG.js → chunk-EOYSKMXN.js} +264 -10
- package/dist/{chunk-57RRFUEZ.js → chunk-FMNNGNYO.js} +43 -8
- package/dist/{chunk-7XGFSUOM.js → chunk-GIK6EDUG.js} +291 -84
- package/dist/chunk-HVHR4SCP.js +133 -0
- package/dist/{chunk-CCS66K4K.js → chunk-KAEHZZH4.js} +3 -3
- package/dist/{chunk-DX5CDO34.js → chunk-KFNMQTZI.js} +580 -214
- package/dist/{chunk-HBGADCKA.js → chunk-PLE722AJ.js} +28 -11
- package/dist/chunk-RK6GLDGI.js +27 -0
- package/dist/{chunk-V2NUHPXF.js → chunk-S6M42KND.js} +1 -1
- package/dist/{chunk-7FTTULED.js → chunk-UQ77JXYH.js} +7 -3
- package/dist/{chunk-MAPZ7VB6.js → chunk-WNGFSIOB.js} +20 -1
- package/dist/{chunk-VYXXOKYS.js → chunk-XCHAYMSF.js} +7 -4
- package/dist/{community-report-client-CU22W53K.js → community-report-client-PEERQCX2.js} +1 -1
- package/dist/{config-XO3LI3SA.js → config-AHPMEW5A.js} +25 -6
- package/dist/context-YAE3QXP3.js +136 -0
- package/dist/{data-integration-HNGUKFIC.js → data-integration-HESZET7E.js} +6 -6
- package/dist/index.js +167 -53
- package/dist/{local-data-upload-client-GTRIT64F.js → local-data-upload-client-TWMHFLUA.js} +1 -1
- package/dist/memory-62BJOULV.js +580 -0
- package/dist/{metadata-DI5BMYFU.js → metadata-C7CEDHOJ.js} +7 -7
- package/dist/{model-RNPQXIBI.js → model-SBV2JFJI.js} +9 -5
- package/dist/{personal-semantic-preference-5C3WUXFI.js → personal-semantic-preference-QECDPHND.js} +119 -11
- package/dist/project-semantic-Z4QAMBWF.js +356 -0
- package/dist/{sync-O45NXEQY.js → sync-SU33KYX7.js} +12 -8
- package/dist/{te-agent-K5MSPNHJ.js → te-agent-F5QBZSQA.js} +423 -494
- package/dist/{te-analysis-AISWCOOZ.js → te-analysis-2ECAAIFK.js} +1227 -154
- package/dist/{te-community-4OYU3BDA.js → te-community-PFLDLPP4.js} +3 -3
- package/dist/{te-dataops-NFIPB6FX.js → te-dataops-FOQSRIAZ.js} +644 -276
- package/dist/{te-engage-BAM3GBFX.js → te-engage-QKUGIWSR.js} +6 -6
- package/dist/{te-experiment-GUTZXZ5Z.js → te-experiment-26PXR2UO.js} +6 -6
- package/dist/{te-kb-3TS73NO6.js → te-kb-MHDOST62.js} +666 -244
- package/dist/{te-system-STMHLS5J.js → te-system-J2FQF5ER.js} +6 -6
- package/dist/{te-team-3I5AOX3N.js → te-team-5UOZPTU3.js} +6 -6
- package/dist/things-VPPXXLHB.js +1091 -0
- package/dist/{update-RZXLPCRH.js → update-EEUTEI6R.js} +59 -51
- package/dist/workspace-O3EEIYQM.js +554 -0
- package/package.json +30 -11
- package/skills/ae-agent/SKILL.md +95 -140
- package/skills/ae-agent/references/add-model.md +1 -1
- package/skills/ae-agent/references/create-agent.md +1 -1
- package/skills/ae-agent/references/find-archived-conversations.md +12 -5
- package/skills/ae-agent/references/get-agent.md +1 -1
- package/skills/ae-agent/references/list-agents.md +2 -2
- package/skills/ae-agent/references/list-models.md +2 -2
- package/skills/ae-agent/references/notification.md +40 -0
- package/skills/ae-agent/references/restore-conversation.md +3 -1
- package/skills/ae-analysis/SKILL.md +55 -23
- package/skills/ae-analysis/references/adhoc_export.md +1 -1
- package/skills/ae-analysis/references/adhoc_run.md +1 -1
- package/skills/ae-analysis/references/agent_review_submit_to_page.md +2 -0
- package/skills/ae-analysis/references/ai_models/event.md +6 -1
- package/skills/ae-analysis/references/ai_models/funnel.md +12 -4
- package/skills/ae-analysis/references/ai_models/heat_map.md +23 -0
- package/skills/ae-analysis/references/ai_models/interval.md +24 -0
- package/skills/ae-analysis/references/ai_models/path.md +20 -0
- package/skills/ae-analysis/references/ai_models/prop_analysis.md +2 -0
- package/skills/ae-analysis/references/ai_models/rank_list.md +30 -0
- package/skills/ae-analysis/references/ai_models/retention.md +45 -1
- package/skills/ae-analysis/references/ai_models/revenue.md +20 -2
- package/skills/ae-analysis/references/ai_models/session.md +76 -0
- package/skills/ae-analysis/references/ai_models/tag.md +2 -0
- package/skills/ae-analysis/references/ai_models.md +100 -3
- package/skills/ae-analysis/references/analysis_data_retrieval.md +4 -0
- package/skills/ae-analysis/references/analysis_drilldown_contract.md +4 -1
- package/skills/ae-analysis/references/asset_batch_info_export.md +10 -0
- package/skills/ae-analysis/references/asset_batch_sql_export.md +13 -1
- package/skills/ae-analysis/references/asset_export.md +12 -1
- package/skills/ae-analysis/references/asset_list.md +1 -0
- package/skills/ae-analysis/references/asset_search.md +11 -5
- package/skills/ae-analysis/references/bi_panel_list.md +1 -1
- package/skills/ae-analysis/references/catalog_list.md +1 -1
- package/skills/ae-analysis/references/collaboration.md +48 -0
- package/skills/ae-analysis/references/command_index.md +29 -19
- package/skills/ae-analysis/references/dashboard_list.md +4 -4
- package/skills/ae-analysis/references/dashboard_move.md +21 -0
- package/skills/ae-analysis/references/dashboard_report_add.md +2 -0
- package/skills/ae-analysis/references/dashboard_report_data_export.md +2 -0
- package/skills/ae-analysis/references/dashboard_report_get.md +19 -0
- package/skills/ae-analysis/references/dashboard_report_update.md +27 -0
- package/skills/ae-analysis/references/dashboard_update.md +1 -1
- package/skills/ae-analysis/references/drilldown_session_details_run.md +41 -0
- package/skills/ae-analysis/references/event_export.md +3 -1
- package/skills/ae-analysis/references/event_report_presentation.md +76 -0
- package/skills/ae-analysis/references/feedback_submit.md +37 -0
- package/skills/ae-analysis/references/governance_recommendation_auto_review.md +77 -0
- package/skills/ae-analysis/references/governance_recommendation_export.md +11 -0
- package/skills/ae-analysis/references/metadata_resolution.md +18 -3
- package/skills/ae-analysis/references/metric_export.md +3 -1
- package/skills/ae-analysis/references/metric_list.md +1 -1
- package/skills/ae-analysis/references/operation_record_export.md +10 -0
- package/skills/ae-analysis/references/personal_semantic_preference_add.md +2 -2
- package/skills/ae-analysis/references/personal_semantic_preference_get.md +4 -4
- package/skills/ae-analysis/references/personal_semantic_preference_list.md +4 -4
- package/skills/ae-analysis/references/personal_semantic_preference_review.md +9 -0
- package/skills/ae-analysis/references/personal_semantic_preference_review_list.md +7 -0
- package/skills/ae-analysis/references/personal_semantic_preference_submit.md +7 -0
- package/skills/ae-analysis/references/project_semantic_knowledge_wiki.md +91 -32
- package/skills/ae-analysis/references/project_semantic_knowledge_wiki_plan_schema.md +99 -1
- package/skills/ae-analysis/references/property_export.md +3 -1
- package/skills/ae-analysis/references/report_create.md +18 -4
- package/skills/ae-analysis/references/report_data_export.md +6 -0
- package/skills/ae-analysis/references/report_get.md +7 -1
- package/skills/ae-analysis/references/report_list.md +5 -5
- package/skills/ae-analysis/references/report_update.md +21 -4
- package/skills/ae-analysis/references/sql_table_columns.md +4 -4
- package/skills/ae-analysis/references/sql_table_list.md +5 -5
- package/skills/ae-analysis/references/system_query_monitor_overview.md +2 -0
- package/skills/ae-analysis/references/system_query_task_cancel.md +2 -0
- package/skills/ae-analysis/references/system_query_task_export.md +6 -2
- package/skills/ae-analysis/references/system_query_task_get.md +2 -0
- package/skills/ae-analysis/references/system_query_task_list.md +7 -3
- package/skills/ae-analysis/references/system_query_task_options.md +2 -2
- package/skills/ae-analysis/references/system_query_task_realtime_list.md +15 -0
- package/skills/ae-analysis/references/user_cluster_models.md +8 -0
- package/skills/ae-analysis/references/user_tag_create.md +7 -1
- package/skills/ae-analysis/references/user_tag_get.md +1 -1
- package/skills/ae-analysis/references/user_tag_models.md +20 -2
- package/skills/ae-analysis/references/user_tag_refresh.md +1 -1
- package/skills/ae-analysis/references/user_tag_update.md +2 -2
- package/skills/ae-analysis/scripts/project-semantic-knowledge-wiki/build-empty-skeleton.mjs +105 -0
- package/skills/ae-analysis/scripts/project-semantic-knowledge-wiki/build-project-semantic-wiki.mjs +669 -29
- package/skills/ae-analysis/scripts/project-semantic-knowledge-wiki/company-kb.mjs +21 -8
- package/skills/ae-analysis/scripts/project-semantic-knowledge-wiki/default-compile-rules.md +28 -10
- package/skills/ae-analysis/scripts/project-semantic-knowledge-wiki/default-compile-schema.md +66 -0
- package/skills/ae-analysis/scripts/project-semantic-knowledge-wiki/generate-build-ir.mjs +285 -24
- package/skills/ae-analysis/scripts/project-semantic-knowledge-wiki/package-wiki-source-zip.mjs +262 -30
- package/skills/ae-analysis/scripts/project-semantic-knowledge-wiki/plan-kb-source-sync.mjs +1 -1
- package/skills/ae-analysis/scripts/project-semantic-knowledge-wiki/precompiled-source.mjs +46 -2
- package/skills/ae-analysis/scripts/project-semantic-knowledge-wiki/prepare-compile-schema.mjs +64 -0
- package/skills/ae-analysis/scripts/project-semantic-knowledge-wiki/refresh-state-parts.mjs +91 -0
- package/skills/ae-automation/SKILL.md +16 -0
- package/skills/ae-automation/references/cli.md +53 -0
- package/skills/ae-automation/references/command_index.md +17 -0
- package/skills/ae-capability/SKILL.md +73 -2
- package/skills/ae-capability/references/collaboration.md +48 -0
- package/skills/ae-community/SKILL.md +5 -1
- package/skills/ae-community/references/collaboration.md +48 -0
- package/skills/ae-current-context/SKILL.md +3 -2
- package/skills/ae-data-integration/SKILL.md +4 -0
- package/skills/ae-data-integration/references/collaboration.md +48 -0
- package/skills/ae-dataops/SKILL.md +54 -74
- package/skills/ae-dataops/references/collaboration.md +48 -0
- package/skills/ae-dataops/references/dataops-backfill.md +23 -18
- package/skills/ae-dataops/references/dataops-flow-create.md +74 -23
- package/skills/ae-dataops/references/dataops-flow-monitor.md +45 -13
- package/skills/ae-dataops/references/dataops-integration.md +57 -30
- package/skills/ae-dataops/references/dataops-query.md +21 -4
- package/skills/ae-dataops/references/dataops-table.md +143 -11
- package/skills/ae-engage/SKILL.md +21 -6
- package/skills/ae-engage/references/channel-mgmt.md +3 -3
- package/skills/ae-engage/references/collaboration.md +48 -0
- package/skills/ae-engage/references/scene-config-channel.md +4 -4
- package/skills/ae-generate-tracking-plan/SKILL.md +4 -0
- package/skills/ae-generate-tracking-plan/references/collaboration.md +48 -0
- package/skills/ae-kb/SKILL.md +70 -12
- package/skills/ae-kb/references/analysis-workflow.md +73 -36
- package/skills/ae-kb/references/collaboration.md +48 -0
- package/skills/ae-kb/references/query-workflow.md +67 -33
- package/skills/ae-kb/references/schema-import.md +32 -0
- package/skills/ae-kb/references/source-mutations.md +6 -4
- package/skills/ae-kb/references/text-sources.md +53 -0
- package/skills/ae-kb-discovery/SKILL.md +8 -3
- package/skills/ae-kb-discovery/references/collaboration.md +48 -0
- package/skills/ae-metadata/SKILL.md +20 -12
- package/skills/ae-metadata/references/collaboration.md +48 -0
- package/skills/ae-team/SKILL.md +23 -17
- package/skills/ae-things/SKILL.md +85 -0
- package/skills/ae-things/references/cli.md +103 -0
- package/skills/ae-things-progress/SKILL.md +43 -0
- package/skills/ae-things-review/SKILL.md +42 -0
- package/skills/ae-workspace/SKILL.md +43 -0
- package/skills/ae-workspace/references/commands.md +51 -0
- package/dist/chunk-E2JKXMVO.js +0 -29
- package/dist/context-IFJI3LIT.js +0 -46
- package/dist/memory-QGPSNCQS.js +0 -892
- package/dist/project-semantic-3LF6Q6JZ.js +0 -1119
- package/skills/ae-agent/references/create-automation.md +0 -125
- package/skills/ae-agent/references/list-automations.md +0 -56
- package/skills/ae-agent/references/update-automation.md +0 -107
- package/skills/ae-project-semantic/SKILL.md +0 -193
- package/skills/ae-project-semantic/references/query-routing-v5.md +0 -165
- package/skills/ae-project-semantic/references/recommendation-quality.md +0 -68
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: ae-engage
|
|
3
|
-
version: 1.0.
|
|
3
|
+
version: 1.0.1
|
|
4
4
|
description: "AE Engage capability gateway: config center, flows, push/config channels, strategies, templates, task management, operation activities, and query lifecycle. Trigger words: config center, scene config, push channel, config channel, operation strategy, operation task, operation activity, query lifecycle, template, config item, Engage, Hermes, engage-scene, engage-setting, engage-flow, engage-task, engage-activity, engage-query."
|
|
5
5
|
---
|
|
6
6
|
|
|
@@ -8,6 +8,18 @@ description: "AE Engage capability gateway: config center, flows, push/config ch
|
|
|
8
8
|
|
|
9
9
|
AE CLI (`ae-cli`) is the command-line tool for the Agentic Engine data analysis platform, used by AI Agents and human users.
|
|
10
10
|
|
|
11
|
+
## Capability contract
|
|
12
|
+
|
|
13
|
+
- Responsibilities: engagement channels, configuration, strategies, task drafts/lifecycle, flows, activities and their reports/query lifecycle.
|
|
14
|
+
- Inputs: verified project/resource identifiers and operation-specific configuration. Reuse known audience/event/property definitions; discover missing prerequisites only when the chosen operation needs them.
|
|
15
|
+
- Outputs: configuration/task/resource identifiers, reports, or query/run status with the actual persisted state. Saving a draft does not submit approval or start delivery.
|
|
16
|
+
- Boundaries: general analysis, metadata discovery and standalone audience creation are separate capabilities; they are not mandatory preflight stages for every engagement request.
|
|
17
|
+
- Completion: the user's requested engagement action is verified, or pending/blocked work is reported. Draft creation, approval submission and sending are distinct actions with their own user-intent requirements.
|
|
18
|
+
|
|
19
|
+
## Cross-skill collaboration
|
|
20
|
+
|
|
21
|
+
When remaining work is outside this skill's scope, or a necessary prerequisite needs another capability, follow [the collaboration protocol](references/collaboration.md). Choose from the skills available in this run by capability, preserve verified context, and continue the remaining task. Reuse this protocol if already loaded.
|
|
22
|
+
|
|
11
23
|
## Global AE CLI Rules
|
|
12
24
|
|
|
13
25
|
AE CLI (`ae-cli`) is the command-line tool for the AE (Agentic Engine) analysis platform. For AE analysis-side requests, prefer `ae-cli` and this skill's reference docs over model memory.
|
|
@@ -53,7 +65,7 @@ When the user mentions a product term below (including common Chinese UI labels)
|
|
|
53
65
|
| **Scene config** | Same as config center; params, groups, metrics, channels, strategies, and templates under a config item | `engage-scene` | `references/scene-config-item.md` | Same as above; params/groups/metrics: `scene-config-param.md`, `scene-config-group.md`, `scene-preset-metric.md`, `scene-config-metric.md` |
|
|
54
66
|
| **Config item** | A single config item in the config center | `engage-scene` | `references/scene-config-item.md` | `scene-config-param.md`, `scene-preset-metric.md`, `scene-config-metric.md`, `scene-strategy.md`, `scene-template.md` |
|
|
55
67
|
| **Push channel** | Project-level message push channels (Webhook, FCM, APNS, etc.) | `engage-setting` | `references/channel-list.md` | `channel-detail.md`, `add-channel.md` (**Webhook vs Client differ**: `url` = HTTP vs scene key; custom params `user:` vs `user:`/`client:`), `update-channel-status.md`, `delete-channel.md`, `channel-update-config.md`, `channel-test-send.md`, `channel_touch_limits_list.md` |
|
|
56
|
-
| **Config channel** | Config-center Webhook/client config channels (not the same as push channels) | `engage-scene` | `references/scene-config-channel.md` | `channel-mgmt.md` (create/enable-disable/copy/delete workflows). User params in `config.customsParamList` require `columnName` with `user:` prefix (e.g. `user:#account_id`);
|
|
68
|
+
| **Config channel** | Config-center Webhook/client config channels (not the same as push channels) | `engage-scene` | `references/scene-config-channel.md` | `channel-mgmt.md` (create/enable-disable/copy/delete workflows). User params in `config.customsParamList` require `columnName` with `user:` prefix (e.g. `user:#account_id`); reuse verified property names or discover a property lookup capability. |
|
|
57
69
|
| **Operation strategy** | Ops/delivery strategies under a config item | `engage-scene` | `references/scene-strategy.md` | Custom audience: [`scene-strategy-audience.md`](references/scene-strategy-audience.md) — semantic `definitionRequest` (Analysis condition shape); do not pass `targetClusterQp`/`qp`; preflight props (stop + list if missing); template: `scene-template.md` |
|
|
58
70
|
| **Operation task** | Hermes push/engagement tasks (list, save, lifecycle, reports) | `engage-task` | `references/task-list.md` | `task-detail.md` (get), `save-task.md`, `build-task-save-guide.md`, `task-stats.md`, `task-delete.md`, `push-record-query.md`, `task-user-detail-export.md`, `task-indicator-user.md`, `task-data-overview.md`, `task-data-detail.md`, `task-metric-detail.md`, `task-metric-update.md`, `task-experiment-report.md` |
|
|
59
71
|
| **Operation activity** | Campaign activity management and delivery trends by activity, topic, or standalone task | `engage-activity` | `references/activity-activity.md` | `activity-data-detail.md`, `activity-topic.md`, `activity-task.md`, `activity-approval.md` |
|
|
@@ -288,7 +300,7 @@ ae-cli engage-scene config-metric update-rule --project-id <project_id> --metric
|
|
|
288
300
|
ae-cli engage-scene config-metric batch-delete --project-id <project_id> --config-id <config_id> --metric-ids '[1,2]' --yes
|
|
289
301
|
|
|
290
302
|
# Config channel list / get / create / update / update-status / delete / query-log
|
|
291
|
-
# User params:
|
|
303
|
+
# User params: reuse or discover verified customsParamList property names; then use user:<prop_name>
|
|
292
304
|
# Strategy custom audience: scene-strategy-audience.md — semantic definitionRequest; strategy predict for 预估人数
|
|
293
305
|
# Workflows: references/channel-mgmt.md · schema: references/scene-config-channel.md
|
|
294
306
|
ae-cli engage-scene config-channel list --project-id <project_id> [--channel-type 0|1]
|
|
@@ -563,7 +575,7 @@ Commands that accept date parameters usually use `yyyy-MM-dd`, for example `--st
|
|
|
563
575
|
|
|
564
576
|
## Write Operation Reminder
|
|
565
577
|
|
|
566
|
-
High-risk delete commands (`risk: high-risk-write`) require explicit
|
|
578
|
+
All writes require the corresponding user intent. High-risk delete commands (`risk: high-risk-write`) additionally require explicit confirmation before execution; ordinary writes (`risk: write`) do not require that extra confirmation:
|
|
567
579
|
|
|
568
580
|
- Channels: `engage-setting channel create` (write), `engage-setting channel delete` (high-risk-write), `engage-setting channel update-status` (write)
|
|
569
581
|
- Config channels (config center channel management): `engage-scene config-channel create|update|update-status` (write), `engage-scene config-channel delete` (high-risk-write)
|
|
@@ -592,7 +604,10 @@ For task draft creation or update, use this workflow:
|
|
|
592
604
|
and reject all users (`3`); `client_push` (`channelType=3`) allows custom (`1`) or all users (`3`)
|
|
593
605
|
and rejects existing (`2`). Do not infer audience support from `triggerType` alone.
|
|
594
606
|
4. `ae-cli engage-task task save --project-id <projectId> --req '{...}'`
|
|
595
|
-
|
|
607
|
+
|
|
608
|
+
For a draft-only request, stop after saving and verifying the draft. Submit approval
|
|
609
|
+
only when that separate action is included in the user's intent:
|
|
610
|
+
`ae-cli engage-task task submit-approval --project-id <projectId> --task-id <taskId>`.
|
|
596
611
|
|
|
597
612
|
`engage-task task build-save-guide` is a read-only helper. It returns scenario-specific required fields, channel content schema, unsupported combinations, examples, and a handoff template for `save_task`.
|
|
598
613
|
When `enableExp=true`, capability `engage-task.task.build-save-guide` enriches the handoff so
|
|
@@ -603,7 +618,7 @@ rejects misaligned experiment content with `TASK_EXPERIMENT_GROUP_CONTENT_INVALI
|
|
|
603
618
|
|
|
604
619
|
`engage-task task save` creates or updates a task configuration. It does not submit approval, does not start sending, and does not trigger task execution. If `req.taskId` is omitted it creates a new draft; if `req.taskId` is present it updates an existing **draft or paused** task. Update mode rejects running/ended tasks with `invalid_status`. Omitted fields inherit from the existing task before validation (partial rename/update is supported).
|
|
605
620
|
|
|
606
|
-
`engage-task task submit-approval --task-id` is the recommended
|
|
621
|
+
When approval submission is requested, `engage-task task submit-approval --task-id` is the recommended path after `task save`.
|
|
607
622
|
It submits the persisted draft without requiring the Agent to reconstruct internal `trigger_rule`.
|
|
608
623
|
The legacy `--request` mode remains available for compatibility; provide exactly one of
|
|
609
624
|
`--task-id` or `--request`.
|
|
@@ -13,7 +13,7 @@ Use for AE Engage **config center channel management**: Webhook (`channel_type=0
|
|
|
13
13
|
5. Writes require explicit user intent; `delete` is high-risk — confirm, then `--yes`.
|
|
14
14
|
6. Before changing Webhook URL, auth, or parameter definitions on an enabled channel, disable it first.
|
|
15
15
|
7. In `config.customsParamList` (**user params**), every `columnName` must be prefixed with `user:` and point to a real user property, e.g. `user:#account_id`. `envParamList` entries do not use this prefix.
|
|
16
|
-
8. Before create/update,
|
|
16
|
+
8. Before create/update, verify that each intended user property exists in the same project. Reuse sufficiently fresh, verified metadata; otherwise follow the [collaboration protocol](collaboration.md) to discover a property lookup capability. Never invent `columnName` values.
|
|
17
17
|
|
|
18
18
|
## Permissions
|
|
19
19
|
|
|
@@ -46,7 +46,7 @@ Parse `data.channel.config` for URL, auth, user params, and env params.
|
|
|
46
46
|
|
|
47
47
|
Webhook requires `channel_name` and `config.url`. Optional: `testUrl`, auth, user params, env params.
|
|
48
48
|
|
|
49
|
-
**Preflight (user params):** for each intended `customsParamList[].columnName`,
|
|
49
|
+
**Preflight (user params):** for each intended `customsParamList[].columnName`, reuse verified metadata or obtain the missing property evidence through a discovered capability. The CLI property lookup commands are:
|
|
50
50
|
|
|
51
51
|
```bash
|
|
52
52
|
ae-cli analysis-meta property list --project-id <pid> --scope user --query <keyword> \
|
|
@@ -69,7 +69,7 @@ Returns `data.channel_id`. Created channels start **enabled**.
|
|
|
69
69
|
|
|
70
70
|
### 4. Update
|
|
71
71
|
|
|
72
|
-
|
|
72
|
+
Verify any new or changed `customsParamList[].columnName` before building `--config`; reuse valid property evidence or discover the missing lookup capability.
|
|
73
73
|
|
|
74
74
|
```bash
|
|
75
75
|
ae-cli engage-scene config-channel get --project-id <pid> --channel-id <id>
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
<!-- Generated from docs/skill-contracts/collaboration.md. Do not edit; run npm run sync:skill-collaboration. -->
|
|
2
|
+
|
|
3
|
+
# Cross-skill collaboration v1
|
|
4
|
+
|
|
5
|
+
Use this convention when the user's remaining request is outside the current
|
|
6
|
+
Skill's responsibilities, or a necessary prerequisite needs another capability.
|
|
7
|
+
For work already covered by the current Skill, continue directly.
|
|
8
|
+
|
|
9
|
+
## Find the missing capability
|
|
10
|
+
|
|
11
|
+
1. Keep the original user goal and identify the unfinished work. Describe the
|
|
12
|
+
needed outcome, available inputs and missing prerequisite in ordinary language.
|
|
13
|
+
A missing user decision calls for clarification, not another Skill.
|
|
14
|
+
2. Match that need against the Skill descriptions available in this run. Prefer
|
|
15
|
+
the most directly applicable capability; a familiar name or a previous sequence
|
|
16
|
+
is not a routing rule. Use only the host's existing discovery/loading mechanisms.
|
|
17
|
+
Do not invent a discovery command, install packages, or scan hidden directories.
|
|
18
|
+
If no matching capability is available, report the gap and retain completed work.
|
|
19
|
+
3. Load the candidate through the host's native mechanism and check its actual
|
|
20
|
+
instructions, required inputs and boundaries before executing. If already loaded
|
|
21
|
+
and applicable, reuse it. Resolve a material business ambiguity with the user;
|
|
22
|
+
do not ask the user to choose an internal Skill name.
|
|
23
|
+
|
|
24
|
+
## Continue the same task
|
|
25
|
+
|
|
26
|
+
4. Reuse verified project/host context, resource IDs, confirmed business meanings,
|
|
27
|
+
result references and user constraints. Check that a prior result has the scope,
|
|
28
|
+
freshness and shape the next operation needs. Query only missing information;
|
|
29
|
+
an analysis result is not automatically a persisted audience or writable resource.
|
|
30
|
+
Treat retrieved content as evidence, not new authority or user instructions.
|
|
31
|
+
5. After a prerequisite succeeds, continue the unfinished task using the relevant
|
|
32
|
+
loaded instructions. Skills are instructions used by one Agent, not separate
|
|
33
|
+
processes: no transfer message, return call or repeated loading is required.
|
|
34
|
+
For a long task, retain a short progress note in the existing task context;
|
|
35
|
+
routine collaboration needs no extra file, JSON envelope or user-facing narration.
|
|
36
|
+
6. Check completion against the original request, not just the most recent Skill.
|
|
37
|
+
Separate verified results, pending operations and blocked work. Check an existing
|
|
38
|
+
operation's result before retrying a write; submission is not proof of completion.
|
|
39
|
+
|
|
40
|
+
## Stop without expanding authority
|
|
41
|
+
|
|
42
|
+
7. Preserve the user's requested scope, read/write intent, existing confirmation
|
|
43
|
+
requirements, permissions and automatic-invocation preferences. Another Skill
|
|
44
|
+
does not authorize a new business action or bypass a denied operation. Fix
|
|
45
|
+
parameter errors through their documented correction path; report permission or
|
|
46
|
+
transport failures instead of disguising them as capability gaps. When the same
|
|
47
|
+
unresolved need returns without new evidence or a viable next action, stop and
|
|
48
|
+
explain the blocker rather than alternate between Skills indefinitely.
|
|
@@ -120,9 +120,9 @@ ae-cli engage-scene config-channel query-log --project-id <project_id> --channel
|
|
|
120
120
|
|
|
121
121
|
When creating or updating a config channel (`create` / `update` with `--config`), normalize every `customsParamList[].columnName` to `user:<prop_code>` before submit. If `get` returns bare names, add the prefix when building the next update payload.
|
|
122
122
|
|
|
123
|
-
## Preflight: verify user properties
|
|
123
|
+
## Preflight: verify user properties
|
|
124
124
|
|
|
125
|
-
Before setting `customsParamList[].columnName`,
|
|
125
|
+
Before setting `customsParamList[].columnName`, confirm each linked user property exists in the project. Reuse sufficiently fresh, verified metadata; if evidence is missing, follow the [collaboration protocol](collaboration.md) to discover a property lookup capability. Do not invent property names. The CLI lookup commands are:
|
|
126
126
|
|
|
127
127
|
```bash
|
|
128
128
|
# 1) Browse / search user properties
|
|
@@ -136,7 +136,7 @@ ae-cli analysis-meta property get --project-id <project_id> --table-type user --
|
|
|
136
136
|
|
|
137
137
|
Decision rules:
|
|
138
138
|
|
|
139
|
-
- Read
|
|
139
|
+
- Read the selected capability's command reference when unsure about flags or output shape; do not assume another Skill's installation path.
|
|
140
140
|
- Match a real `data.properties[].prop_name` (or confirmed `data.property.prop_name`) from metadata, then set `columnName` to `user:` + that name — e.g. `prop_name` `#account_id` → `columnName` `user:#account_id`.
|
|
141
141
|
- If the property is not found after list + optional get, stop and tell the user; do not submit the channel config with a fabricated `columnName`.
|
|
142
142
|
- `envParamList` names come from config-table / env-param setup, not from user-property metadata.
|
|
@@ -153,7 +153,7 @@ Decision rules:
|
|
|
153
153
|
|
|
154
154
|
- Risk: `list` / `get` / `query-log` = read; `create` / `update` / `update-status` = write; `delete` = high-risk-write (user confirmation + `--yes`)
|
|
155
155
|
- Discover `channel_id` with `list` first; never invent IDs
|
|
156
|
-
- **User params (`customsParamList`)**: `columnName` must be `user:<user_prop_code>` (e.g. `user:#account_id`). Applies to both webhook and client channels on create/update.
|
|
156
|
+
- **User params (`customsParamList`)**: `columnName` must be `user:<user_prop_code>` (e.g. `user:#account_id`). Applies to both webhook and client channels on create/update. Verify each name before submit, reusing valid metadata or discovering the missing lookup capability.
|
|
157
157
|
- Enabled channel (`channel_status=1`): only limited fields such as name can change; disable first (`update-status --channel-status 2`) before changing URL, auth, or parameter definitions
|
|
158
158
|
- Delete: disable first, then `delete --yes`
|
|
159
159
|
- Copy: `get` → rename (often append `_copy`) → `create`
|
|
@@ -5,6 +5,10 @@ description: "Interactive generation of an AE tracking plan and upload. Trigger
|
|
|
5
5
|
|
|
6
6
|
# ae-generate-tracking-plan
|
|
7
7
|
|
|
8
|
+
## Cross-skill collaboration
|
|
9
|
+
|
|
10
|
+
When remaining work is outside this skill's scope, or a necessary prerequisite needs another capability, follow [the collaboration protocol](references/collaboration.md). Choose from the skills available in this run by capability, preserve verified context, and continue the remaining task. Reuse this protocol if already loaded.
|
|
11
|
+
|
|
8
12
|
> **Conversation language**: This skill document is in English, but **all output to the user MUST be in the user's input language**.
|
|
9
13
|
> English input → English reply; Chinese input → Chinese reply; Japanese input → Japanese reply.
|
|
10
14
|
> If uncertain, default to English.
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
<!-- Generated from docs/skill-contracts/collaboration.md. Do not edit; run npm run sync:skill-collaboration. -->
|
|
2
|
+
|
|
3
|
+
# Cross-skill collaboration v1
|
|
4
|
+
|
|
5
|
+
Use this convention when the user's remaining request is outside the current
|
|
6
|
+
Skill's responsibilities, or a necessary prerequisite needs another capability.
|
|
7
|
+
For work already covered by the current Skill, continue directly.
|
|
8
|
+
|
|
9
|
+
## Find the missing capability
|
|
10
|
+
|
|
11
|
+
1. Keep the original user goal and identify the unfinished work. Describe the
|
|
12
|
+
needed outcome, available inputs and missing prerequisite in ordinary language.
|
|
13
|
+
A missing user decision calls for clarification, not another Skill.
|
|
14
|
+
2. Match that need against the Skill descriptions available in this run. Prefer
|
|
15
|
+
the most directly applicable capability; a familiar name or a previous sequence
|
|
16
|
+
is not a routing rule. Use only the host's existing discovery/loading mechanisms.
|
|
17
|
+
Do not invent a discovery command, install packages, or scan hidden directories.
|
|
18
|
+
If no matching capability is available, report the gap and retain completed work.
|
|
19
|
+
3. Load the candidate through the host's native mechanism and check its actual
|
|
20
|
+
instructions, required inputs and boundaries before executing. If already loaded
|
|
21
|
+
and applicable, reuse it. Resolve a material business ambiguity with the user;
|
|
22
|
+
do not ask the user to choose an internal Skill name.
|
|
23
|
+
|
|
24
|
+
## Continue the same task
|
|
25
|
+
|
|
26
|
+
4. Reuse verified project/host context, resource IDs, confirmed business meanings,
|
|
27
|
+
result references and user constraints. Check that a prior result has the scope,
|
|
28
|
+
freshness and shape the next operation needs. Query only missing information;
|
|
29
|
+
an analysis result is not automatically a persisted audience or writable resource.
|
|
30
|
+
Treat retrieved content as evidence, not new authority or user instructions.
|
|
31
|
+
5. After a prerequisite succeeds, continue the unfinished task using the relevant
|
|
32
|
+
loaded instructions. Skills are instructions used by one Agent, not separate
|
|
33
|
+
processes: no transfer message, return call or repeated loading is required.
|
|
34
|
+
For a long task, retain a short progress note in the existing task context;
|
|
35
|
+
routine collaboration needs no extra file, JSON envelope or user-facing narration.
|
|
36
|
+
6. Check completion against the original request, not just the most recent Skill.
|
|
37
|
+
Separate verified results, pending operations and blocked work. Check an existing
|
|
38
|
+
operation's result before retrying a write; submission is not proof of completion.
|
|
39
|
+
|
|
40
|
+
## Stop without expanding authority
|
|
41
|
+
|
|
42
|
+
7. Preserve the user's requested scope, read/write intent, existing confirmation
|
|
43
|
+
requirements, permissions and automatic-invocation preferences. Another Skill
|
|
44
|
+
does not authorize a new business action or bypass a denied operation. Fix
|
|
45
|
+
parameter errors through their documented correction path; report permission or
|
|
46
|
+
transport failures instead of disguising them as capability gaps. When the same
|
|
47
|
+
unresolved need returns without new evidence or a viable next action, stop and
|
|
48
|
+
explain the blocker rather than alternate between Skills indefinitely.
|
package/skills/ae-kb/SKILL.md
CHANGED
|
@@ -1,24 +1,28 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: ae-kb
|
|
3
|
-
version: 1.0.
|
|
4
|
-
description: 'AE knowledge base CLI manual for creating, importing read-only compiled snapshots, querying, LLM-powered ask, listing accessible knowledge bases and their sources, deterministic index/grep/read retrieval, checking status, ZIP source upload and directory management, raw child-file reading, revision-checked child updates and deletion, compiling, schema generation, URL sources, source deletion, file/ZIP source draft replacement and restoration, and knowledge base deletion. Use when the user asks to manage AE (Agentic Engine) knowledge bases, import a compiled Markdown ZIP snapshot, upload documents or URLs to a knowledge base, query knowledge, ask knowledge bases with an LLM, list accessible knowledge bases or source metadata, inspect knowledge base indexes, search knowledge base pages, read a specific knowledge base page, check knowledge base status, generate schemas, compile knowledge, remove sources, or delete a knowledge base. To choose which knowledge base is worth searching, use the ae-kb-discovery skill first; this skill runs the retrieval once a target is chosen. Must use ae-cli kb commands and must not guess knowledge base names, scopes, page paths, source IDs, source display names, JSON payload shapes, or URL formats.'
|
|
3
|
+
version: 1.0.4
|
|
4
|
+
description: 'AE knowledge base CLI manual for creating, importing read-only compiled snapshots, querying, LLM-powered ask, listing accessible knowledge bases and their sources, deterministic index/grep/read retrieval, checking status, ZIP source upload and directory management, raw child-file reading, revision-checked child updates and deletion, compiling, schema generation, URL sources, source deletion, ordinary text source creation, full reads and revision-checked editing, file/ZIP source draft replacement and restoration, and knowledge base deletion. Use when the user asks to manage AE (Agentic Engine) knowledge bases, import a compiled Markdown ZIP snapshot, upload documents or URLs to a knowledge base, query knowledge, ask knowledge bases with an LLM, list accessible knowledge bases or source metadata, inspect knowledge base indexes, search knowledge base pages, read a specific knowledge base page, check knowledge base status, generate schemas, compile knowledge, remove sources, create or edit text sources, or delete a knowledge base. To choose which knowledge base is worth searching, use the ae-kb-discovery skill first; this skill runs the retrieval once a target is chosen. Must use ae-cli kb commands and must not guess knowledge base names, scopes, page paths, source IDs, source display names, JSON payload shapes, or URL formats.'
|
|
5
5
|
---
|
|
6
6
|
|
|
7
7
|
# ae-kb
|
|
8
8
|
|
|
9
|
+
## Cross-skill collaboration
|
|
10
|
+
|
|
11
|
+
When remaining work is outside this skill's scope, or a necessary prerequisite needs another capability, follow [the collaboration protocol](references/collaboration.md). Choose from the skills available in this run by capability, preserve verified context, and continue the remaining task. Reuse this protocol if already loaded.
|
|
12
|
+
|
|
9
13
|
AE CLI (`ae-cli`) knowledge base commands are invoked through:
|
|
10
14
|
|
|
11
15
|
```bash
|
|
12
16
|
ae-cli kb +<command> [options]
|
|
13
|
-
ae-cli kb source <replace|restore|preview|commit|cancel|check-updates> [options]
|
|
17
|
+
ae-cli kb source <create-text|read-text|replace|restore|preview|commit|cancel|check-updates|check-url-updates> [options]
|
|
14
18
|
```
|
|
15
19
|
|
|
16
20
|
## Global Rules
|
|
17
21
|
|
|
18
22
|
- Use this skill for AE knowledge base tasks: create, import a compiled snapshot, query, ask with LLM, list accessible knowledge bases and their sources, inspect indexes, grep pages, read pages, check status, upload sources, add URL sources, generate schema, compile, remove source files, and delete knowledge bases.
|
|
19
23
|
- **Searching a knowledge base for an answer is the most common task. If that is what you are doing, go straight to [Explore Knowledge Base Pages](#explore-knowledge-base-pages) and read [`references/query-workflow.md`](references/query-workflow.md) first — it is the retrieval procedure. The other commands below are for managing knowledge bases, not answering from them.**
|
|
20
|
-
- **When retrieved pages will guide project-scoped business data analysis, read and follow [`references/analysis-workflow.md`](references/analysis-workflow.md) before running any data query. This is mandatory after a KB hit identifies
|
|
21
|
-
- Read operations can run directly after required inputs are known. Write operations require explicit user intent
|
|
24
|
+
- **When retrieved pages will guide project-scoped business data analysis, read and follow [`references/analysis-workflow.md`](references/analysis-workflow.md) before running any data query. This is mandatory after a KB hit identifies an asset, definition, parameter, time rule, conflict, or decision boundary. Verify semantic coverage before execution; a related page or KB limitation is not task completion. Continue ordinary analysis for uncovered requirements without jumping directly to unverified ad-hoc analysis or SQL.**
|
|
25
|
+
- Read operations can run directly after required inputs are known. Write operations require explicit user intent. Only `high-risk-write` commands require the CLI confirmation prompt; use `--yes` after explicit authorization.
|
|
22
26
|
- Prefer `--dry-run` before destructive or broad writes when the user has not already validated the target.
|
|
23
27
|
- Do not invent knowledge base names, scopes, source IDs, source display names, or JSON payloads. Ask the user or query known context when values are missing.
|
|
24
28
|
- When building a `--sources` ref (or `+read --source`), copy the exact `scope` and `name` from `+list` output — run `ae-cli kb +list` first when the scope of a named knowledge base is unknown.
|
|
@@ -32,6 +36,9 @@ ae-cli kb source <replace|restore|preview|commit|cancel|check-updates> [options]
|
|
|
32
36
|
|
|
33
37
|
| Command | Risk | Purpose |
|
|
34
38
|
|---|---:|---|
|
|
39
|
+
| `source create-text` | write | Create one ordinary Markdown source from text, UTF-8 file or explicit stdin; saves without compiling. |
|
|
40
|
+
| `source read-text` | read | Read complete ordinary text with its corresponding revision; optionally save original UTF-8 bytes to a new file. |
|
|
41
|
+
| `source check-url-updates` | write | Submit an asynchronous check for one compiled custom URL source; success means accepted only. |
|
|
35
42
|
| `source check-updates` | write | Check one compiled Feishu source with the scheduled detector; mark changes without compiling. |
|
|
36
43
|
| `+ask` | read | LLM-powered Q&A over knowledge bases; for multi-page synthesis or multi-hop questions. |
|
|
37
44
|
| `+ask-status` | read | Query the current status of an ask execution by `--execution-id` without polling. |
|
|
@@ -48,9 +55,30 @@ ae-cli kb source <replace|restore|preview|commit|cancel|check-updates> [options]
|
|
|
48
55
|
| `+schema` | write | Generate the compile schema for a knowledge base. |
|
|
49
56
|
| `+compile` | write | Compile a knowledge base in incremental or full mode. |
|
|
50
57
|
| `+status` | read | Query the current status of a knowledge base. |
|
|
58
|
+
| `usage list` | read | List one page of compilation usage logs, including elapsed time in milliseconds. |
|
|
51
59
|
| `+rm-source` | high-risk-write | Delete one source from a knowledge base by stable ID; exact display name is legacy compatibility only. |
|
|
52
60
|
| `+remove` | write | Delete an entire knowledge base. |
|
|
53
61
|
|
|
62
|
+
## Compilation Usage Logs
|
|
63
|
+
|
|
64
|
+
```bash
|
|
65
|
+
ae-cli kb usage list --name handbook --scope personal --page 1 --page-size 20
|
|
66
|
+
ae-cli kb usage list --name handbook --jq '.items | map({createdAt, taskType, status, durationMs})' --format table
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
- Returns `{ items, total, page, pageSize }`. `--page` defaults to 1; `--page-size` defaults to 20 and accepts 1–100. Fetch each page explicitly.
|
|
70
|
+
- `durationMs` is the usage log's `finishedAt - startedAt`, in milliseconds. A missing or invalid timestamp yields `null`; zero remains zero. Failed records can have duration even when `usageAvailable` is false.
|
|
71
|
+
- Historical missing durations are not reconstructed from compile runs. `startedAt` and `finishedAt` are ISO timestamps or `null`.
|
|
72
|
+
- Requires the same Schema-read permission as the Web compilation usage list. Imported snapshots do not expose usage. `--scope` selects exactly personal or company; omission keeps the existing personal-then-company lookup.
|
|
73
|
+
- `--dry-run` previews the read without sending a request. Default output retains numeric/null values; use the existing `--jq` and `--format table` options for a compact table.
|
|
74
|
+
|
|
75
|
+
Transition status: transitional
|
|
76
|
+
Owning module: te-claude External Knowledge Base Usage API
|
|
77
|
+
Current transport: authenticated External REST via `kbApi`
|
|
78
|
+
Gateway target: TBD (compilation usage list)
|
|
79
|
+
Review after: 2026-12-14
|
|
80
|
+
Exit condition: migrate to the Gateway equivalent when available, preserving typed pagination and duration/null semantics.
|
|
81
|
+
|
|
54
82
|
## Published Version History
|
|
55
83
|
|
|
56
84
|
Use the nine version commands described in [`references/versions.md`](references/versions.md) to inspect immutable published history, compare source changes, and explicitly roll back an earlier version as a new publication. These commands manage history; `+index/+grep/+read/+ask` continue to use current published content.
|
|
@@ -294,7 +322,7 @@ ae-cli kb +list --build-status compiled
|
|
|
294
322
|
|
|
295
323
|
Use the deterministic retrieval primitives when an agent needs to explore knowledge base content like a code repository. These endpoints do not call an LLM on the server side.
|
|
296
324
|
|
|
297
|
-
**Before running a real query, read [`references/query-workflow.md`](references/query-workflow.md)** — it
|
|
325
|
+
**Before running a real query, read [`references/query-workflow.md`](references/query-workflow.md)** — it selects the next useful retrieval step without crawling. It covers candidate indexing, copied-path grep, direct bounded reads of linked short pages, same-page read windows, linked-page re-grep when needed, optional outline-derived ranges, and coverage assessment. This section below is the per-command reference the workflow draws on.
|
|
298
326
|
|
|
299
327
|
Start with `+list` or `+index` to discover accessible knowledge bases. Use `+index` when you also need navigation maps:
|
|
300
328
|
|
|
@@ -339,6 +367,10 @@ ae-cli kb +read \
|
|
|
339
367
|
--expand block
|
|
340
368
|
```
|
|
341
369
|
|
|
370
|
+
### Create, read or edit text sources
|
|
371
|
+
|
|
372
|
+
Read [the text source workflow](references/text-sources.md) when collecting text, reading full editable source content, or updating an ordinary `.md`, `.markdown` or `.txt` source. It covers explicit scope, UTF-8/BOM/newline preservation, exclusive local output, revision conflicts, redacted dry-run and manual compilation. Web and CLI maintain the same source ID.
|
|
373
|
+
|
|
342
374
|
### List Sources
|
|
343
375
|
|
|
344
376
|
List sources first to discover the stable identifier for the intended source:
|
|
@@ -350,10 +382,10 @@ ae-cli kb +list-sources --name engineering-handbook --scope company
|
|
|
350
382
|
Copy the exact `id` from the response into `+rm-source`. Do not guess a source ID from a local filename, URL, display name, or an older upload response.
|
|
351
383
|
|
|
352
384
|
- Transition status: transitional
|
|
353
|
-
- Owning module: te-claude
|
|
354
|
-
- Current transport:
|
|
355
|
-
- Gateway target: TBD
|
|
356
|
-
- Review after: 2026-12
|
|
385
|
+
- Owning module: te-claude knowledge-base source management
|
|
386
|
+
- Current transport: External Knowledge Base REST API
|
|
387
|
+
- Gateway target: TBD
|
|
388
|
+
- Review after: 2026-11-12
|
|
357
389
|
- Exit condition: migrate to a typed Gateway capability when an equivalent source-list capability is available, or remove this command if dynamic Gateway execution provides the same discoverability and safe output contract.
|
|
358
390
|
|
|
359
391
|
### Remove One Source
|
|
@@ -437,7 +469,7 @@ ae-cli kb +grep --query "<keywords>" --sources '[{"scope":"company","name":"kb-n
|
|
|
437
469
|
|
|
438
470
|
- `--query`, alias `-q`: required keywords to search.
|
|
439
471
|
- `--sources`: required JSON array of knowledge base refs.
|
|
440
|
-
- `--paths`: required JSON array of wiki pages or subdirectories **copied** from `+index
|
|
472
|
+
- `--paths`: required JSON array of wiki pages or subdirectories **copied** from current `+index`, `+grep` or `+read` navigation links. Do not invent paths. A single page is still an array, e.g. `["wiki/sandbox.md"]`. Distinct from `+read --path` (one string).
|
|
441
473
|
- `--top-k`: optional max number of hits, 1-50, default 10.
|
|
442
474
|
- `--locale`: optional locale: `zh`, `en`, `ja`, or `ko`.
|
|
443
475
|
- Each page entry in results carries `hitCount` (full match count), `pageKind`, and `sections` previews with `sectionStartLine` / `sectionEndLine` — use the section range as the `+read` window.
|
|
@@ -526,10 +558,11 @@ ae-cli kb +status --name "<name>" [--scope personal|company]
|
|
|
526
558
|
### `+list-sources`
|
|
527
559
|
|
|
528
560
|
```bash
|
|
529
|
-
ae-cli kb +list-sources --name "<name>" [--scope personal|company]
|
|
561
|
+
ae-cli kb +list-sources --name "<name>" [--scope personal|company] [--content-type all|text]
|
|
530
562
|
```
|
|
531
563
|
|
|
532
564
|
- `--name`: required knowledge base name.
|
|
565
|
+
- `--content-type`: defaults to `all`; `text` selects ordinary `.md`, `.markdown` and `.txt` sources (case-insensitive), excluding URL and ZIP sources. Scope remains optional for this list command.
|
|
533
566
|
- Output: `items` contains effective sources with stable `id`. `pendingDeletions` contains soft-deleted sources still included in the current successful version. `deletionMaintenance` is separate and may report already-published deletions awaiting cleanup. Paths, hashes, credentials, and source content are not returned.
|
|
534
567
|
- Check `deletionProjection.state` and its `baseline` before interpreting deletion lists. `ready` with `pendingDeletions: []` means no pending deletion at that baseline. `changing`, `review_required`, or `unavailable` with `pendingDeletions: null` means undetermined; display the `reasonCode`, never turn null into an empty list. Legacy libraries without a verifiable complete publication manifest return unavailable until a real version is published.
|
|
535
568
|
- A rollback creates a new current version. An older deletion receipt cannot override membership in that version. A later source deletion needs publication again.
|
|
@@ -551,6 +584,10 @@ ae-cli kb +rm-source --name "<name>" --id "<source-id>" [--scope personal|compan
|
|
|
551
584
|
ae-cli kb +remove --name "<name>" [--scope personal|company]
|
|
552
585
|
```
|
|
553
586
|
|
|
587
|
+
## Import and replace compilation rules
|
|
588
|
+
|
|
589
|
+
Use [schema import commands](references/schema-import.md) to upload, validate, edit, repair, review and apply a Markdown compilation rule candidate. These actions do not generate rules from sources or import a compiled snapshot.
|
|
590
|
+
|
|
554
591
|
## Check a Feishu source for updates
|
|
555
592
|
|
|
556
593
|
```bash
|
|
@@ -572,3 +609,24 @@ Transport: `POST /agent/api/external/knowledge-bases/sources/check-updates`, bod
|
|
|
572
609
|
- Gateway target: TBD; reuse an equivalent source update-check capability when available.
|
|
573
610
|
- Review after: 2026-10-16.
|
|
574
611
|
- Exit condition: once the Gateway exposes equivalent authorization and detector semantics, migrate the typed command to L2 or use L3 if it adds no value.
|
|
612
|
+
|
|
613
|
+
|
|
614
|
+
### Submit an ordinary URL update check
|
|
615
|
+
|
|
616
|
+
```bash
|
|
617
|
+
ae-cli kb source check-url-updates --name "Engineering Handbook" --id "<source-id>" --scope company --dry-run
|
|
618
|
+
ae-cli kb source check-url-updates --name "Engineering Handbook" --id "<source-id>" --scope company
|
|
619
|
+
```
|
|
620
|
+
|
|
621
|
+
Only existing `sourceType=url`, `platform=custom`, compiled sources without pending updates qualify. The request is rejected while Wiki/Schema compilation or input preparation is active. Success returns `{accepted:true,sourceId}` and only means accepted. It has no final counts, task ID, checking state, wait mode or completion query. Read `kb +list-sources` for update markers; unchanged state cannot distinguish execution, no change, failure or a discarded result. When marked changed, explicitly run the existing incremental compile. Feishu continues to use synchronous `source check-updates`.
|
|
622
|
+
|
|
623
|
+
Transport: `POST /agent/api/external/knowledge-bases/sources/check-url-updates`, body `{name,sourceId,scope?}`. Dry-run previews without sending a request. Submission errors preserve the server error code, details and nonzero exit.
|
|
624
|
+
|
|
625
|
+
### Admission record: source check-url-updates
|
|
626
|
+
|
|
627
|
+
- Transition status: transitional (this new KB external capability has no Gateway equivalent).
|
|
628
|
+
- Owning module: te-claude knowledge-base source management.
|
|
629
|
+
- Current transport: KB external REST through kbApi and CLI token.
|
|
630
|
+
- Gateway target: TBD; reuse an equivalent asynchronous ordinary URL source-check capability.
|
|
631
|
+
- Review after: 2026-10-24.
|
|
632
|
+
- Exit condition: when the Gateway provides equivalent authorization and asynchronous submission semantics, migrate to L2 if typed flags add value, otherwise use L3.
|
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
# Knowledge-guided analysis workflow
|
|
2
2
|
|
|
3
3
|
Use this workflow after knowledge-base retrieval when the pages will guide a
|
|
4
|
-
project-scoped business data analysis. The knowledge base
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
data query.
|
|
4
|
+
project-scoped business data analysis. The knowledge base supplies candidate
|
|
5
|
+
assets, verified definitions, and decision boundaries. Check their coverage of
|
|
6
|
+
the user's original question before choosing execution. Current values still
|
|
7
|
+
require an `ae-analysis` data query; a related KB page is not task completion.
|
|
8
8
|
|
|
9
9
|
This workflow does not define knowledge-base compilation rules. Do not use it
|
|
10
10
|
to create, upload, generate a schema for, compile, or delete a knowledge base.
|
|
@@ -89,25 +89,33 @@ pages actually read:
|
|
|
89
89
|
| Decision boundaries | Case-only, frontend-only, adoption-only, not revenue, non-generalizable, expired, conflicting, or human-decision-required constraints |
|
|
90
90
|
| KB evidence | Exact KB name, page path, and section actually read |
|
|
91
91
|
|
|
92
|
-
Classify
|
|
92
|
+
Classify each candidate's coverage before querying. These states classify the
|
|
93
|
+
asset, not completion of the original task:
|
|
93
94
|
|
|
94
95
|
- `executable`: exact asset identity and semantics cover the question, with no
|
|
95
96
|
unresolved conflict.
|
|
96
|
-
- `partially_executable`: evidence covers only some subquestions;
|
|
97
|
-
|
|
97
|
+
- `partially_executable`: evidence covers only some subquestions; execute the
|
|
98
|
+
applicable parts and retain their results, then continue discovery for the
|
|
99
|
+
uncovered parts.
|
|
100
|
+
- `semantic_only`: read evidence supplies useful events, properties, or
|
|
101
|
+
limitations, but the candidate's definition cannot produce the requested
|
|
102
|
+
measure, entity, or scope. Retain that evidence and continue ordinary analysis.
|
|
98
103
|
- `blocked`: a required asset, metric, aggregation, entity, filter, parameter,
|
|
99
|
-
time rule, or decision boundary is missing or conflicting;
|
|
100
|
-
|
|
104
|
+
time rule, or decision boundary is missing or conflicting; do not execute
|
|
105
|
+
that unsupported definition. Continue discovery for the affected requirement
|
|
106
|
+
when an independently verified, authorized path remains possible.
|
|
101
107
|
|
|
102
108
|
Do not fill a contract gap with general knowledge, a similarly named asset, or
|
|
103
|
-
a technically valid query.
|
|
104
|
-
|
|
105
|
-
|
|
109
|
+
a technically valid query. Resolve missing evidence through the ordinary
|
|
110
|
+
analysis path below. If a material business choice remains ambiguous, request
|
|
111
|
+
that choice once; if clarification is forbidden, disclose the unresolved part
|
|
112
|
+
instead of choosing silently. Do not ask the user to authorize continuation of
|
|
113
|
+
the same read-only data request merely because the KB covers only part of it.
|
|
106
114
|
|
|
107
115
|
## Execute the exact saved-asset chain
|
|
108
116
|
|
|
109
|
-
An exact asset identified by a source page takes
|
|
110
|
-
ad-hoc analysis:
|
|
117
|
+
An exact, semantically applicable asset identified by a source page takes
|
|
118
|
+
priority over fuzzy search and ad-hoc analysis:
|
|
111
119
|
|
|
112
120
|
1. For a dashboard ID, call `analysis dashboard get` once with the verified
|
|
113
121
|
project ID. Verify its name, child reports, `effective_settings`,
|
|
@@ -116,6 +124,10 @@ ad-hoc analysis:
|
|
|
116
124
|
2. For a report ID, call `analysis report get` with the verified project ID.
|
|
117
125
|
Verify its model, metric, aggregation, dimensions, filters, saved parameters,
|
|
118
126
|
and time definition before querying data.
|
|
127
|
+
Definition inspection that establishes an unsuitable saved asset does not
|
|
128
|
+
require a data query to prove the mismatch. Record the incompatible fields
|
|
129
|
+
and continue ordinary discovery; do not execute a known wrong definition
|
|
130
|
+
merely to satisfy an attempt-first rule.
|
|
119
131
|
3. Read the matching `ae-analysis` data-command reference before execution. Use
|
|
120
132
|
[`report_data_run.md`](../../ae-analysis/references/report_data_run.md) for a
|
|
121
133
|
bounded saved report result and
|
|
@@ -131,9 +143,9 @@ ad-hoc analysis:
|
|
|
131
143
|
`ae-analysis`.
|
|
132
144
|
6. For a metric or another saved asset, use its exact identity and corresponding
|
|
133
145
|
command. Never replace it with a same-name object.
|
|
134
|
-
7. Use the saved-asset discovery procedure from `ae-analysis`
|
|
135
|
-
|
|
136
|
-
semantic
|
|
146
|
+
7. Use the saved-asset discovery procedure from `ae-analysis` when the KB
|
|
147
|
+
provides no suitable executable identity or leaves requirements uncovered.
|
|
148
|
+
A discovered candidate still requires semantic coverage, not title similarity.
|
|
137
149
|
|
|
138
150
|
If the user asks for multiple groupings that one saved dynamic report supports,
|
|
139
151
|
execute that same report once per required parameter variant. Keep the common
|
|
@@ -142,9 +154,11 @@ identical data command merely to inspect output that was locally truncated;
|
|
|
142
154
|
capture or export the complete result through the supported data command.
|
|
143
155
|
|
|
144
156
|
The statement "the KB contains definitions but not current values" means that
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
157
|
+
an exact, semantically applicable saved asset must be attempted first. It does
|
|
158
|
+
not require executing a related but unsuitable asset, nor authorize skipping
|
|
159
|
+
saved-asset discovery directly to SQL. If inspection establishes a mismatch or
|
|
160
|
+
execution cannot produce the requested result, follow the ordinary-analysis
|
|
161
|
+
fallback below.
|
|
148
162
|
|
|
149
163
|
When the live definition agrees with the KB, use the query result as data
|
|
150
164
|
evidence and the KB page as routing, semantic, and boundary evidence.
|
|
@@ -173,9 +187,10 @@ definition or hide it with a replacement query.
|
|
|
173
187
|
|
|
174
188
|
## Fall back without hiding the knowledge-base result
|
|
175
189
|
|
|
176
|
-
|
|
190
|
+
These conditions require the state-specific handling and ordinary-analysis
|
|
191
|
+
checks below; none alone establishes a verified ad-hoc or SQL definition:
|
|
177
192
|
|
|
178
|
-
-
|
|
193
|
+
- An applicable exact saved asset has not yet been attempted.
|
|
179
194
|
- The exact saved asset returns an empty result.
|
|
180
195
|
- The exact asset has a validation, transport, capability, or definition
|
|
181
196
|
execution failure.
|
|
@@ -200,8 +215,8 @@ Handle these states without changing the contract:
|
|
|
200
215
|
the input mapping allowed by its saved definition. Do not translate the report
|
|
201
216
|
into SQL.
|
|
202
217
|
- Partial success: retain successful saved-asset results and apply these rules
|
|
203
|
-
independently to each failed part. Do not discard
|
|
204
|
-
the whole request with one reconstructed query.
|
|
218
|
+
independently to each failed or semantically uncovered part. Do not discard
|
|
219
|
+
valid sub-results or replace the whole request with one reconstructed query.
|
|
205
220
|
- Permission denial: preserve the denied asset, error, and request ID. Do not
|
|
206
221
|
retry the denied operation or use an undocumented lower-level API. The
|
|
207
222
|
ordinary analysis fallback may still use another standard `ae-analysis`
|
|
@@ -222,8 +237,9 @@ Handle these states without changing the contract:
|
|
|
222
237
|
may answer under a different, independently verified definition, but it must
|
|
223
238
|
not claim to resolve the KB asset's conflict or present the result as
|
|
224
239
|
definition-equivalent.
|
|
225
|
-
- Fixed historical window:
|
|
226
|
-
|
|
240
|
+
- Fixed historical window: do not extrapolate its values to the requested
|
|
241
|
+
period. If the window cannot be overridden, inspect alternatives through
|
|
242
|
+
ordinary analysis instead of presenting that window as the requested result.
|
|
227
243
|
- Limited applicability: keep the conclusion within the declared scope. Do not
|
|
228
244
|
expand adoption into revenue or intent, one module into the whole product, or
|
|
229
245
|
one case into all customers.
|
|
@@ -234,25 +250,34 @@ applicable scope is not an equivalent validation.
|
|
|
234
250
|
|
|
235
251
|
## Degrade to the ordinary analysis path
|
|
236
252
|
|
|
237
|
-
The KB path is preferred, not exclusive. If
|
|
238
|
-
|
|
239
|
-
|
|
240
|
-
"Existing business asset before ad-hoc" workflow
|
|
253
|
+
The KB path is preferred, not exclusive. If definition inspection establishes
|
|
254
|
+
that the KB-selected asset cannot cover the request, or a real execution attempt
|
|
255
|
+
cannot produce the requested live result, continue through the ordinary
|
|
256
|
+
`ae-analysis` "Existing business asset before ad-hoc" workflow. Preserve the KB
|
|
257
|
+
evidence and already verified definitions; do not restart from zero:
|
|
241
258
|
|
|
242
259
|
1. Search for another accessible saved report or dashboard whose current live
|
|
243
260
|
definition covers the request.
|
|
244
|
-
2.
|
|
245
|
-
|
|
261
|
+
2. Compare live definitions with the original request, including distinctions
|
|
262
|
+
such as creation versus creation-and-editing, user versus customer, and
|
|
263
|
+
event count versus distinct entity count. A title match is not enough.
|
|
264
|
+
3. Follow [`metadata_resolution.md`](../../ae-analysis/references/metadata_resolution.md)
|
|
265
|
+
for uncovered definitions. Reuse verified KB and live-asset evidence; discover
|
|
266
|
+
only missing metadata, filters, dimensions, or scope. A missing descriptive
|
|
267
|
+
field does not invalidate independently supported action counts.
|
|
268
|
+
4. If no saved definition matches, use authorized ad-hoc analysis only when the normal
|
|
246
269
|
`ae-analysis` rules permit it and the required event, properties, metric,
|
|
247
270
|
aggregation, entity, filters, time, and timezone can be established.
|
|
248
|
-
|
|
271
|
+
5. Use only documented standard capabilities. Each fallback command remains
|
|
249
272
|
subject to the backend's independent authorization checks.
|
|
250
273
|
|
|
251
274
|
Fallback is available when the KB-selected asset is missing from the live
|
|
252
275
|
project, inaccessible, empty for the requested scope, outside its supported
|
|
253
|
-
time or breakdown,
|
|
254
|
-
|
|
255
|
-
|
|
276
|
+
time or breakdown, semantically unsuitable, missing requested fields or
|
|
277
|
+
submetrics, or persistently fails after the documented correction or retry
|
|
278
|
+
path. Technical success with a partial or wrong definition is also a coverage
|
|
279
|
+
gap, not a reason to stop. The user does not need to restate the original data
|
|
280
|
+
request merely to allow this ordinary fallback.
|
|
256
281
|
|
|
257
282
|
Ad-hoc analysis must still satisfy the safety conditions below. SQL must also
|
|
258
283
|
satisfy the additional SQL constraints in `ae-analysis`.
|
|
@@ -274,6 +299,18 @@ material difference from the KB-selected definition. Never claim that the KB
|
|
|
274
299
|
asset produced a fallback result. An empty or denied KB result remains part of
|
|
275
300
|
the audit record even when the fallback succeeds.
|
|
276
301
|
|
|
302
|
+
## Check task completion
|
|
303
|
+
|
|
304
|
+
Before answering, check each requirement of the original question against the
|
|
305
|
+
actual definition and returned data. Finish when it is answered, or when bounded
|
|
306
|
+
discovery establishes a concrete unavailable prerequisite, authorization
|
|
307
|
+
boundary, or material choice requiring clarification. An asset state of
|
|
308
|
+
`semantic_only`, `partially_executable`, or `blocked` is not by itself a terminal
|
|
309
|
+
task state. Do not label creation-and-editing totals as pure creation, substitute
|
|
310
|
+
another entity, or stop at a KB limitation while verified metadata supports a
|
|
311
|
+
remaining authorized query. Keep genuine unknown fields unknown and label
|
|
312
|
+
partial results explicitly; do not broaden an empty result merely to get rows.
|
|
313
|
+
|
|
277
314
|
## Answer with traceable boundaries
|
|
278
315
|
|
|
279
316
|
Make these three layers distinguishable in the final answer:
|