@thinkingai/ae-cli 6.1.12 → 6.1.13
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 +0 -2
- package/README.zh.md +0 -2
- package/dist/{auth-NN55553T.js → auth-GBMV6TEJ.js} +2 -2
- package/dist/{auth-GDV3H5I4.js → auth-NDSXE54J.js} +4 -4
- package/dist/{capability-DRLGDVS4.js → capability-TAMDRZYV.js} +18 -8
- package/dist/{capability-P6GK3AQH.js → capability-U7TDEEEG.js} +18 -8
- package/dist/{chunk-GJJA4CQZ.js → chunk-3FY3RJ26.js} +0 -4
- package/dist/{chunk-GS2P7LFD.js → chunk-5XUSIK27.js} +2 -2
- package/dist/{chunk-7KQWSBSL.js → chunk-753BUTNZ.js} +3 -3
- package/dist/{chunk-VTXHDCBW.js → chunk-AFXA7BRK.js} +2 -2
- package/dist/chunk-IBH3LDAH.js +556 -0
- package/dist/{chunk-RBNKI5ZW.js → chunk-JUW4AJXN.js} +2 -2
- package/dist/{chunk-TS6BUGUY.js → chunk-QATA32VR.js} +3 -3
- package/dist/{chunk-Z3OXWCIA.js → chunk-S5NTSDBS.js} +2 -2
- package/dist/chunk-UIHQJK5E.js +556 -0
- package/dist/{chunk-VKD5WQKN.js → chunk-VLWOLBGZ.js} +142 -24
- package/dist/{chunk-YTG6Q75E.js → chunk-WZRX4KOH.js} +25 -3
- package/dist/{chunk-YV52FB5G.js → chunk-ZQKDZXDO.js} +1 -1
- package/dist/{cli-token-GL5MS5FK.js → cli-token-4UPER74P.js} +3 -3
- package/dist/{chunk-6A2FUCIS.js → client-L2YDMHQ6.js} +5 -6
- package/dist/{config-4VZNLBKF.js → config-OL2LWGBV.js} +4 -33
- package/dist/index.js +25 -38
- package/dist/{memory-RWJW4XFO.js → memory-MUP7PPL7.js} +4 -4
- package/dist/{memory-VO2ZJCRT.js → memory-U4O5PMXH.js} +4 -4
- package/dist/{metadata-YGTHR2XJ.js → metadata-UORZTW3T.js} +21 -11
- package/dist/{metadata-ZRN2GHPN.js → metadata-VVQ3AQT5.js} +21 -11
- package/dist/{model-CLUIK3K5.js → model-JTUEO5M4.js} +2 -2
- package/dist/{sync-3REDHGY6.js → sync-MOSFNBVR.js} +5 -5
- package/dist/{te-agent-XNPELAKX.js → te-agent-IFKZDHZI.js} +25 -18
- package/dist/{te-analysis-GJI5FZUL.js → te-analysis-KOKHJJPE.js} +1225 -450
- package/dist/{te-analysis-N2BRDJZ5.js → te-analysis-LLOCCBJ4.js} +1225 -450
- package/dist/{te-community-SQXKE5OO.js → te-community-HNKVTERD.js} +207 -12
- package/dist/{te-community-TYSNU3NQ.js → te-community-IWE5B7W6.js} +208 -12
- package/dist/{te-dataops-OWIADNSM.js → te-dataops-KQPYNAE3.js} +262 -145
- package/dist/{te-dataops-5TM7WZDI.js → te-dataops-KXCEB4CS.js} +262 -145
- package/dist/{te-engage-L72HWRGO.js → te-engage-BRLSRVQT.js} +565 -16
- package/dist/{te-engage-QWM4GFS7.js → te-engage-HE4OPZIT.js} +565 -16
- package/dist/{te-experiment-2T2HEZML.js → te-experiment-K5US7RMG.js} +6 -6
- package/dist/{te-experiment-PVEY7AEZ.js → te-experiment-WA7TFMEL.js} +6 -6
- package/dist/{te-kb-VRMEY3D4.js → te-kb-OIH3T6CS.js} +4 -4
- package/dist/{te-system-XGS5EQIQ.js → te-system-AZ3URMUO.js} +515 -11
- package/dist/{te-team-BZRDV2CM.js → te-team-GZPU6UWA.js} +5 -5
- package/dist/{update-HEDXGOJH.js → update-TOBFXF2V.js} +4 -4
- package/package.json +5 -5
- package/skills/ae-agent/SKILL.md +3 -3
- package/skills/ae-agent/references/list-skill-references.md +4 -4
- package/skills/ae-agent/references/read-skill-reference.md +10 -7
- package/skills/ae-agent/references/upload-skill-reference.md +11 -9
- package/skills/ae-analysis/SKILL.md +15 -12
- package/skills/ae-analysis/metadata_resolution.md +150 -0
- package/skills/ae-analysis/references/adhoc_export.md +17 -2
- package/skills/ae-analysis/references/adhoc_run.md +12 -8
- package/skills/ae-analysis/references/ai_models.md +31 -5
- package/skills/ae-analysis/references/analysis_data_retrieval.md +104 -16
- package/skills/ae-analysis/references/analysis_drilldown_contract.md +4 -4
- package/skills/ae-analysis/references/analysis_gateway_assets.md +12 -10
- package/skills/ae-analysis/references/artifact_download.md +4 -3
- package/skills/ae-analysis/references/asset_abnormal_list.md +5 -3
- package/skills/ae-analysis/references/asset_authentication_list.md +5 -3
- package/skills/ae-analysis/references/asset_search.md +5 -3
- package/skills/ae-analysis/references/bi_panel_page_data_export.md +1 -1
- package/skills/ae-analysis/references/bi_panel_page_data_run.md +4 -4
- package/skills/ae-analysis/references/catalog_export.md +28 -0
- package/skills/ae-analysis/references/catalog_list.md +44 -0
- package/skills/ae-analysis/references/command_index.md +72 -63
- package/skills/ae-analysis/references/dashboard_report_data_run.md +11 -4
- package/skills/ae-analysis/references/datatable_version_list.md +5 -3
- package/skills/ae-analysis/references/drilldown_entities_run.md +4 -4
- package/skills/ae-analysis/references/drilldown_events_run.md +2 -2
- package/skills/ae-analysis/references/drilldown_user_events_export.md +1 -1
- package/skills/ae-analysis/references/drilldown_user_events_run.md +2 -2
- package/skills/ae-analysis/references/entity_detail_run.md +4 -4
- package/skills/ae-analysis/references/entity_id_import_options.md +1 -1
- package/skills/ae-analysis/references/event_detail_run.md +4 -4
- package/skills/ae-analysis/references/event_export.md +21 -0
- package/skills/ae-analysis/references/event_list.md +7 -6
- package/skills/ae-analysis/references/exchange_rule_list.md +5 -3
- package/skills/ae-analysis/references/history_tag_data_drilldown_export.md +4 -2
- package/skills/ae-analysis/references/history_tag_data_drilldown_run.md +2 -2
- package/skills/ae-analysis/references/history_tag_data_run.md +2 -2
- package/skills/ae-analysis/references/metric_export.md +21 -0
- package/skills/ae-analysis/references/metric_list.md +8 -7
- package/skills/ae-analysis/references/property_export.md +21 -0
- package/skills/ae-analysis/references/property_list.md +9 -8
- package/skills/ae-analysis/references/query_context_get.md +20 -0
- package/skills/ae-analysis/references/query_create_result_cluster.md +1 -1
- package/skills/ae-analysis/references/report_change_log_list.md +1 -1
- package/skills/ae-analysis/references/report_create.md +3 -3
- package/skills/ae-analysis/references/report_data_run.md +8 -8
- package/skills/ae-analysis/references/report_update.md +3 -3
- package/skills/ae-analysis/references/report_version_rollback.md +1 -1
- package/skills/ae-analysis/references/rule_list.md +6 -4
- package/skills/ae-analysis/references/run_inspect.md +8 -5
- package/skills/ae-analysis/references/run_wait.md +37 -0
- package/skills/ae-analysis/references/user_cluster_export.md +13 -0
- package/skills/ae-analysis/references/user_cluster_list.md +6 -2
- package/skills/ae-analysis/references/user_cluster_member_export.md +5 -3
- package/skills/ae-analysis/references/user_cluster_member_list.md +4 -4
- package/skills/ae-analysis/references/user_tag_export.md +13 -0
- package/skills/ae-analysis/references/user_tag_list.md +6 -2
- package/skills/ae-analysis/references/user_tag_member_export.md +5 -3
- package/skills/ae-analysis/references/user_tag_member_list.md +4 -4
- package/skills/ae-analysis/references/virtual_property_create.md +2 -2
- package/skills/ae-community/SKILL.md +2 -2
- package/skills/ae-dataops/SKILL.md +4 -3
- package/skills/ae-dataops/references/dataops-flow-create.md +47 -3
- package/skills/ae-engage/SKILL.md +46 -6
- package/skills/ae-engage/references/build-task-save-guide.md +12 -0
- package/skills/ae-engage/references/cancel-query-run.md +31 -0
- package/skills/ae-engage/references/config-item-analysis-report.md +14 -1
- package/skills/ae-engage/references/config-item-strategy-comparison.md +11 -1
- package/skills/ae-engage/references/config-item-trigger-report.md +15 -1
- package/skills/ae-engage/references/flow-metric-detail-report.md +134 -0
- package/skills/ae-engage/references/flow-metric-update.md +77 -0
- package/skills/ae-engage/references/flow-metric-user.md +118 -0
- package/skills/ae-engage/references/flow-node-metric-user.md +122 -0
- package/skills/ae-engage/references/flow-node-user.md +122 -0
- package/skills/ae-engage/references/push-record-query.md +32 -1
- package/skills/ae-engage/references/save-task.md +9 -0
- package/skills/ae-engage/references/task-data-detail.md +9 -2
- package/skills/ae-engage/references/task-metric-detail.md +9 -2
- package/skills/ae-engage/references/task-submit-approval.md +3 -0
- package/skills/ae-experiment/references/save_experiment.md +4 -0
- package/skills/ae-experiment-design/SKILL.md +1 -1
- package/skills/ae-experiment-design/references/platform-operations.md +1 -1
- package/skills/ae-experiment-insight/references/platform-operations.md +1 -1
- package/skills/ae-metadata/SKILL.md +2 -1
- package/skills/ae-metadata/references/metadata_data_table_download.md +10 -2
- package/skills/ae-metadata/references/metadata_data_table_list.md +5 -2
- package/skills/ae-system/SKILL.md +66 -3
- package/dist/chunk-DT6Y3TD7.js +0 -232
- package/dist/chunk-MVDZ7DBQ.js +0 -231
- package/dist/chunk-NBPKWKRA.js +0 -51
- package/dist/client-DAIPF7XN.js +0 -23
- package/dist/raw-52B4UKO4.js +0 -71
- package/dist/te-meta-53BVXPFI.js +0 -95
- package/dist/te-meta-TOCBPBXI.js +0 -95
|
@@ -10,14 +10,14 @@ Command:
|
|
|
10
10
|
|
|
11
11
|
```bash
|
|
12
12
|
ae-cli analysis report update --project-id <project_id> --report-id <report_id> --report-version <version> --report-name "New name"
|
|
13
|
-
ae-cli analysis report update --project-id <project_id> --report-id <report_id> --report-version <version> --model-type event --definition '{...}'
|
|
13
|
+
ae-cli analysis report update --project-id <project_id> --report-id <report_id> --report-version <version> --model-type event --definition '{...}' [--resolutions '<confirmed_resolution_json>']
|
|
14
14
|
```
|
|
15
15
|
|
|
16
|
-
Input sends `project_id`, `report_id`, `version` from CLI `--report-version`, and at least one of `report_name`, `report_desc`, or `definition`. Read `version` from `analysis report get` before updating. `model_type` is required when `definition` is provided
|
|
16
|
+
Input sends `project_id`, `report_id`, `version` from CLI `--report-version`, and at least one of `report_name`, `report_desc`, or `definition`. Read `version` from `analysis report get` before updating. `model_type` is required when `definition` is provided; `resolutions` is allowed only with that unchanged definition and is not supported with `model_type=tag`.
|
|
17
17
|
|
|
18
18
|
Output is the gateway envelope. `data` contains update status, `report_id`, and the normalized AI QP definition when a definition was updated.
|
|
19
19
|
|
|
20
|
-
When a definition is supplied, update and its `--validate` / `--dry-run` paths use the same compiler contract. `AI_QP_COMPILE_FAILED` preserves
|
|
20
|
+
When a definition is supplied, update and its `--validate` / `--dry-run` paths use the same compiler contract. `AI_QP_COMPILE_FAILED` preserves the full structured error array. The report is not changed on this failure; follow [`../metadata_resolution.md`](../metadata_resolution.md), keep the definition unchanged, and retry with `--resolutions` only after confirmation.
|
|
21
21
|
|
|
22
22
|
For the shortest safe update, read the current `version` exactly once with `analysis report get` immediately before the write; do not reuse a version from an older list or conversation turn. If a SQL dynamic parameter definition changed, query the saved default before applying an override so default persistence and override behavior are verified separately.
|
|
23
23
|
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
Use when the user explicitly wants to rollback one report to a previous history version.
|
|
4
4
|
|
|
5
|
-
Do not use without first
|
|
5
|
+
Do not use without first choosing an item with `can_rollback=true` from `report-change-log list` or receiving an exact user-provided version. Pass the selected item's `target_version`; do not infer it from `version` or `original_version`.
|
|
6
6
|
|
|
7
7
|
Command:
|
|
8
8
|
|
|
@@ -7,18 +7,20 @@ Do not use it to discover rule field syntax; use `rule-schema` for construction
|
|
|
7
7
|
Command:
|
|
8
8
|
|
|
9
9
|
```bash
|
|
10
|
-
ae-cli analysis-governance rule list --project-id <project_id>
|
|
10
|
+
ae-cli analysis-governance rule list --project-id <project_id> --limit 50 --offset 0
|
|
11
11
|
ae-cli analysis-governance rule list --dry-run --project-id <project_id>
|
|
12
12
|
```
|
|
13
13
|
|
|
14
|
-
Capability id:
|
|
14
|
+
Capability id: `governance.rule.list`.
|
|
15
15
|
|
|
16
|
-
Input sends project_id
|
|
16
|
+
Input sends `project_id`, optional `payload`, `limit`, and `offset`. Payload keys must follow the common-service snake_case input schema; do not send camelCase aliases.
|
|
17
17
|
|
|
18
|
-
Output
|
|
18
|
+
Output always uses the directory envelope: `data.items[]`, `total`, `limit`, `offset`, `has_more`, and `next_offset`. Resolve a real `rule_id` from `items` before update or delete.
|
|
19
19
|
|
|
20
20
|
## Parameters
|
|
21
21
|
| Parameter | Required | Description |
|
|
22
22
|
|---|---|---|
|
|
23
23
|
| --project-id | Yes | Numeric project ID. |
|
|
24
24
|
| --payload | No | Optional snake_case object carrying the same fields. Use this for complex governance filters or backend-shaped payloads. |
|
|
25
|
+
| `--limit` / `-l` | No | Page size. Default: 50, maximum: 200. |
|
|
26
|
+
| `--offset` / `-o` | No | Zero-based page offset. Default: 0. |
|
|
@@ -4,7 +4,7 @@ Inspect an async analysis capability-gateway run returned by export commands.
|
|
|
4
4
|
|
|
5
5
|
Use for `analysis adhoc export`, `analysis report-data export`, `analysis dashboard-report-data export`, `analysis bi-panel-page-data export`, and other analysis exports that return `run_id`.
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
Legacy transport `request_id` values are outside this skill's execution path. This command accepts only the capability-gateway `run_id`; if the caller has only a legacy request ID, report that it cannot be inspected or canceled here.
|
|
8
8
|
|
|
9
9
|
Input:
|
|
10
10
|
|
|
@@ -20,9 +20,12 @@ Input sends `run_id`.
|
|
|
20
20
|
|
|
21
21
|
Output is the gateway run descriptor with run status, artifact status, and error fields when the run failed. Keep the `run_id` from the same export result; do not invent or reuse it across artifacts.
|
|
22
22
|
|
|
23
|
-
|
|
23
|
+
State interpretation:
|
|
24
24
|
|
|
25
|
-
- Continue
|
|
26
|
-
- Treat `
|
|
27
|
-
- Treat
|
|
25
|
+
- Continue only while run or artifact status is `RUNNING`.
|
|
26
|
+
- Treat only run `SUCCEEDED` plus artifact `COMPLETED` as downloadable success.
|
|
27
|
+
- Treat run or artifact `FAILED`/`CANCELED` as terminal failure.
|
|
28
28
|
- After success, download with `ae-cli analysis artifact download --run-id <run_id> --artifact-id <artifact_id> --output <file>`.
|
|
29
|
+
|
|
30
|
+
For managed polling and resumability, use `ae-cli analysis run wait --run-id
|
|
31
|
+
<run_id> [--output <file>]` instead of scripting an unbounded inspect loop.
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
# analysis run wait
|
|
2
|
+
|
|
3
|
+
Resume client-side waiting for an asynchronous run and optionally download its
|
|
4
|
+
completed artifact.
|
|
5
|
+
|
|
6
|
+
Use this after an export was submitted without `--wait`, or when a previous
|
|
7
|
+
wait was interrupted, detached, reached its client or server deadline, or
|
|
8
|
+
stopped after persistent transient network failures. Do not use it for
|
|
9
|
+
synchronous `run` results, and do not treat it as a cancellation command.
|
|
10
|
+
|
|
11
|
+
```bash
|
|
12
|
+
ae-cli analysis run wait --run-id <run_id> [--wait-timeout-seconds <n>] [--output <file>] [--force]
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
Input:
|
|
16
|
+
|
|
17
|
+
- `--run-id`: exact run ID returned by the original async export.
|
|
18
|
+
- `--wait-timeout-seconds`: optional local wait bound, `1..21600`; default
|
|
19
|
+
`600`. Expiry does not cancel the remote run.
|
|
20
|
+
- `--output`: optional destination. When present, download begins only after
|
|
21
|
+
run `SUCCEEDED` and artifact `COMPLETED`.
|
|
22
|
+
- `--force`: optional atomic replacement of an existing `--output`; invalid
|
|
23
|
+
without `--output`.
|
|
24
|
+
|
|
25
|
+
The command polls with repeated short inspect requests and internal adaptive
|
|
26
|
+
backoff. Local waiting stops at the earlier of `--wait-timeout-seconds` and the
|
|
27
|
+
server lifecycle deadline, with a short artifact-materialization grace. Ctrl-C
|
|
28
|
+
or a local wait failure never cancels the remote run. The error returns the
|
|
29
|
+
latest lifecycle state plus `remote_run_canceled=false` and `resume_command`.
|
|
30
|
+
Use `analysis query cancel --run-id <run_id>` only when cancellation is
|
|
31
|
+
explicitly intended.
|
|
32
|
+
|
|
33
|
+
Without `--output`, the response is the successful terminal run descriptor.
|
|
34
|
+
With `--output`, success additionally guarantees a complete atomically
|
|
35
|
+
published local file and returns `output_path`, `bytes`, and content headers.
|
|
36
|
+
Run/artifact failure, unknown protocol states, 404, or authorization failure
|
|
37
|
+
returns a non-zero structured error; do not turn those outcomes into success.
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
# analysis user-cluster export
|
|
2
|
+
|
|
3
|
+
Export every matching accessible user cluster without pagination.
|
|
4
|
+
|
|
5
|
+
```bash
|
|
6
|
+
ae-cli analysis user-cluster export \
|
|
7
|
+
--project-id <project_id> \
|
|
8
|
+
--output <temporary_path>/clusters.jsonl
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
Capability id: `analysis.user_cluster.export`.
|
|
12
|
+
|
|
13
|
+
Optional filters are `--queries`, `--fields`, and `--authenticated-only`. `--limit`, `--offset`, and `--all` are not accepted. The CLI requires a `.jsonl` output path and writes an adjacent `.meta.json` completeness and identity sidecar. Search the file locally; do not load the full snapshot into model context.
|
|
@@ -2,7 +2,9 @@
|
|
|
2
2
|
|
|
3
3
|
List accessible user clusters for discovery. Use this before any get/update/delete/member command; do not invent `cluster_name`.
|
|
4
4
|
|
|
5
|
-
Flags: `--project-id` required. Optional: `--
|
|
5
|
+
Flags: `--project-id` required. Optional: `--queries`, `--fields`, `--limit`, `--offset`, `--authenticated-only`.
|
|
6
|
+
|
|
7
|
+
`--queries` is a JSON array of 1-20 keywords and uses OR matching. Default `--limit` is 50; maximum is 200.
|
|
6
8
|
|
|
7
9
|
`--offset` is only for stable asset browsing. It is not a member-data pagination strategy.
|
|
8
10
|
When `has_more=true`, continue only with the returned `next_offset`; do not calculate the next page locally.
|
|
@@ -10,6 +12,8 @@ When `has_more=true`, continue only with the returned `next_offset`; do not calc
|
|
|
10
12
|
Output is a paged cluster inventory, not cluster members or definition-build results.
|
|
11
13
|
|
|
12
14
|
```bash
|
|
13
|
-
ae-cli analysis user-cluster list --project-id <project_id> --
|
|
15
|
+
ae-cli analysis user-cluster list --project-id <project_id> --queries '["retained","retention"]' --limit 50
|
|
14
16
|
ae-cli analysis user-cluster list --project-id <project_id> --fields '["cluster_name","display_name","users_num"]' --limit 50 --offset 0
|
|
15
17
|
```
|
|
18
|
+
|
|
19
|
+
For a complete catalog, use [`user_cluster_export.md`](user_cluster_export.md).
|
|
@@ -1,12 +1,14 @@
|
|
|
1
1
|
# analysis user-cluster-member export
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Stream the native full cluster-member download as an async gzip artifact. Read `analysis_data_retrieval.md` first.
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
Do not use this command for an inline sample or filtered keyword search; use `user-cluster-member run` for preview behavior.
|
|
6
|
+
|
|
7
|
+
Flags: `--project-id`, `--cluster-name` required. Optional: `--property-names`, `--request-id`, `--artifact-format jsonl|csv`, `--timeout-seconds`. The default format is `jsonl`.
|
|
6
8
|
|
|
7
9
|
If you provide `--request-id`, use `cli_<32 lowercase hex>`. Omit it unless you need to correlate logs or cancel a known running query.
|
|
8
10
|
|
|
9
|
-
Export does not accept `--offset
|
|
11
|
+
Export does not accept `--offset`, `--fields`, `--query`, or `--use-cache`. Common executes the native full-download SQL once and streams result rows directly as `jsonl.gz` or `csv.gz`; it does not concatenate preview pages. The existing full-download ceiling still applies.
|
|
10
12
|
|
|
11
13
|
```bash
|
|
12
14
|
ae-cli analysis user-cluster-member export --project-id <project_id> --cluster-name retained_users --artifact-format jsonl
|
|
@@ -4,16 +4,16 @@ Run a bounded inline cluster member query. Read `analysis_data_retrieval.md` bef
|
|
|
4
4
|
|
|
5
5
|
Do not use it for complete/unknown-size membership retrieval or cluster metadata. Output contains at most the requested inline limit and has no caller pagination contract.
|
|
6
6
|
|
|
7
|
-
Flags: `--project-id`, `--cluster-name` required. Optional: `--property-names`, `--fields`, `--query`, `--use-cache`, `--request-id`, `--
|
|
7
|
+
Flags: `--project-id`, `--cluster-name` required. Optional: `--property-names`, `--fields`, `--query`, `--use-cache`, `--request-id`, `--preview-rows`, `--timeout-seconds`.
|
|
8
8
|
|
|
9
9
|
When `--fields` is omitted, each member row returns `#user_id`, `#account_id`, and `#distinct_id`. Cluster members do not expose tag-only fields such as `tag_value` or `tag_date`. The sync timeout defaults to 120 seconds and accepts an explicit value up to 180 seconds.
|
|
10
|
-
|
|
10
|
+
Omit `--preview-rows` to return at most 1000 rows, matching the UI member query. Explicit values must be between 1 and 100000; use a smaller preview when only a sample is needed.
|
|
11
11
|
|
|
12
12
|
If you provide `--request-id`, use `cli_<32 lowercase hex>`. Omit it unless you need to correlate logs or cancel a known running query.
|
|
13
13
|
|
|
14
14
|
For full or unknown-size member data, use `user-cluster-member export`; the list command has no next-page contract.
|
|
15
15
|
|
|
16
16
|
```bash
|
|
17
|
-
ae-cli analysis user-cluster-member list --project-id <project_id> --cluster-name retained_users --
|
|
18
|
-
ae-cli analysis user-cluster-member list --project-id <project_id> --cluster-name retained_users --property-names '["country"]' --fields '["#user_id","#account_id","#distinct_id","country"]' --query US --
|
|
17
|
+
ae-cli analysis user-cluster-member list --project-id <project_id> --cluster-name retained_users --preview-rows 100
|
|
18
|
+
ae-cli analysis user-cluster-member list --project-id <project_id> --cluster-name retained_users --property-names '["country"]' --fields '["#user_id","#account_id","#distinct_id","country"]' --query US --preview-rows 50
|
|
19
19
|
```
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
# analysis user-tag export
|
|
2
|
+
|
|
3
|
+
Export every matching accessible user tag without pagination.
|
|
4
|
+
|
|
5
|
+
```bash
|
|
6
|
+
ae-cli analysis user-tag export \
|
|
7
|
+
--project-id <project_id> \
|
|
8
|
+
--output <temporary_path>/tags.jsonl
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
Capability id: `analysis.user_tag.export`.
|
|
12
|
+
|
|
13
|
+
Optional filters are `--queries`, `--fields`, and `--authenticated-only`. `--limit`, `--offset`, and `--all` are not accepted. The CLI requires a `.jsonl` output path and writes an adjacent `.meta.json` completeness and identity sidecar. Search the file locally; do not load the full snapshot into model context.
|
|
@@ -2,7 +2,9 @@
|
|
|
2
2
|
|
|
3
3
|
List accessible user tags for discovery. Use this before get/update/delete/member/history-tag commands; do not invent `tag_name`.
|
|
4
4
|
|
|
5
|
-
Flags: `--project-id` required. Optional: `--
|
|
5
|
+
Flags: `--project-id` required. Optional: `--queries`, `--fields`, `--limit`, `--offset`, `--authenticated-only`.
|
|
6
|
+
|
|
7
|
+
`--queries` is a JSON array of 1-20 keywords and uses OR matching. Default `--limit` is 50; maximum is 200.
|
|
6
8
|
|
|
7
9
|
`--offset` is only for stable asset browsing. It is not a tag-member pagination strategy.
|
|
8
10
|
When `has_more=true`, continue only with the returned `next_offset`; do not calculate the next page locally.
|
|
@@ -12,6 +14,8 @@ Output is a paged tag inventory whose identifier is `tag_name`, the same field c
|
|
|
12
14
|
Tags never accept `cluster_name`; that field belongs only to user clusters. Do not retry a tag command by substituting one identifier for the other.
|
|
13
15
|
|
|
14
16
|
```bash
|
|
15
|
-
ae-cli analysis user-tag list --project-id <project_id> --
|
|
17
|
+
ae-cli analysis user-tag list --project-id <project_id> --queries '["level","tier"]' --limit 50
|
|
16
18
|
ae-cli analysis user-tag list --project-id <project_id> --fields '["tag_name","display_name","users_num"]' --limit 50 --offset 0
|
|
17
19
|
```
|
|
20
|
+
|
|
21
|
+
For a complete catalog, use [`user_tag_export.md`](user_tag_export.md).
|
|
@@ -1,12 +1,14 @@
|
|
|
1
1
|
# analysis user-tag-member export
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Stream the native full tag-member download as an async gzip artifact. Read `analysis_data_retrieval.md` first.
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
Do not use this command for an inline sample or filtered keyword search; use `user-tag-member run` for preview behavior.
|
|
6
|
+
|
|
7
|
+
Flags: `--project-id`, `--tag-name` required. Optional: `--snapshot-date`, `--property-names`, `--request-id`, `--artifact-format jsonl|csv`, `--timeout-seconds`. The default format is `jsonl`.
|
|
6
8
|
|
|
7
9
|
If you provide `--request-id`, use `cli_<32 lowercase hex>`. Omit it unless you need to correlate logs or cancel a known running query.
|
|
8
10
|
|
|
9
|
-
Export does not accept `--offset`. Common
|
|
11
|
+
Export does not accept `--offset`, `--fields`, `--query`, or `--use-cache`. Common executes the native current-tag or history-tag full-download SQL once and streams result rows directly as `jsonl.gz` or `csv.gz`; it does not concatenate preview pages. The existing full-download ceiling still applies.
|
|
10
12
|
|
|
11
13
|
```bash
|
|
12
14
|
ae-cli analysis user-tag-member export --project-id <project_id> --tag-name user_level --artifact-format jsonl
|
|
@@ -4,16 +4,16 @@ Run a bounded inline tag member query. Read `analysis_data_retrieval.md` before
|
|
|
4
4
|
|
|
5
5
|
Do not use it for complete/unknown-size membership retrieval or history statistics. Output contains at most the requested inline limit and has no caller pagination contract.
|
|
6
6
|
|
|
7
|
-
Flags: `--project-id`, `--tag-name` required. Optional: `--snapshot-date`, `--property-names`, `--fields`, `--query`, `--use-cache`, `--request-id`, `--
|
|
7
|
+
Flags: `--project-id`, `--tag-name` required. Optional: `--snapshot-date`, `--property-names`, `--fields`, `--query`, `--use-cache`, `--request-id`, `--preview-rows`, `--timeout-seconds`.
|
|
8
8
|
|
|
9
9
|
When `--fields` is omitted, each member row returns `#user_id`, `#account_id`, `#distinct_id`, and the stable logical `tag_value`. Internal calculated tag column names are never part of the public response. The sync timeout defaults to 120 seconds and accepts an explicit value up to 180 seconds.
|
|
10
|
-
|
|
10
|
+
Omit `--preview-rows` to return at most 1000 rows, matching the UI member query. Explicit values must be between 1 and 100000; use a smaller preview when only a sample is needed.
|
|
11
11
|
|
|
12
12
|
If you provide `--request-id`, use `cli_<32 lowercase hex>`. Omit it unless you need to correlate logs or cancel a known running query.
|
|
13
13
|
|
|
14
14
|
For full or unknown-size member data, use `user-tag-member export`; the list command has no next-page contract.
|
|
15
15
|
|
|
16
16
|
```bash
|
|
17
|
-
ae-cli analysis user-tag-member list --project-id <project_id> --tag-name user_level --
|
|
18
|
-
ae-cli analysis user-tag-member list --project-id <project_id> --tag-name user_level --snapshot-date 2026-07-01 --property-names '["country"]' --fields '["#user_id","#account_id","#distinct_id","tag_value","country"]' --
|
|
17
|
+
ae-cli analysis user-tag-member list --project-id <project_id> --tag-name user_level --preview-rows 100
|
|
18
|
+
ae-cli analysis user-tag-member list --project-id <project_id> --tag-name user_level --snapshot-date 2026-07-01 --property-names '["country"]' --fields '["#user_id","#account_id","#distinct_id","tag_value","country"]' --preview-rows 50
|
|
19
19
|
```
|
|
@@ -11,7 +11,7 @@ Command:
|
|
|
11
11
|
```bash
|
|
12
12
|
ae-cli analysis-meta virtual-property create --project-id <project_id> --property-name '#vp@demo' --table-type event --select-type string --sql-expression 'event_name' --sql-event-relation-type relation_default
|
|
13
13
|
ae-cli analysis-meta virtual-property create --project-id <project_id> --property-name '#vp@demo' --property-desc demo --table-type event --select-type string --sql-expression "CASE WHEN status = 1 THEN 'active' ELSE 'inactive' END" --sql-event-relation-type relation_by_setting --related-events '[{"eventName":"purchase"}]' --property-remark demo
|
|
14
|
-
ae-cli analysis-meta virtual-property create --project-id <project_id> --sql-expression '<sql>' --v-prop '{
|
|
14
|
+
ae-cli analysis-meta virtual-property create --project-id <project_id> --sql-expression '<sql>' --v-prop '{"property":{"column_name":"#vp@demo","table_type":"event","select_type":"string"}}' --properties '[...]'
|
|
15
15
|
ae-cli analysis-meta virtual-property create --project-id <project_id> --sql-expression '<sql>' --v-prop '{...}' --dry-run
|
|
16
16
|
```
|
|
17
17
|
|
|
@@ -26,7 +26,7 @@ Output is a successful gateway envelope with no business data.
|
|
|
26
26
|
|---|---|---|
|
|
27
27
|
| `--project-id` | Yes | Numeric project ID. |
|
|
28
28
|
| `--sql-expression` | Yes | SQL expression used to calculate the virtual property. |
|
|
29
|
-
| `--v-prop` | No | Full virtual property JSON object with `property.column_name`, `table_type`, and `select_type`.
|
|
29
|
+
| `--v-prop` | No | Full virtual property JSON object with `property.column_name`, `property.table_type`, and `property.select_type`. All three fields belong inside `property`; use typed property flags unless an exact DTO is already available. |
|
|
30
30
|
| `--property-name` | No | Virtual property name. Must start with `#vp@`. Required when `--v-prop` is omitted. |
|
|
31
31
|
| `--property-desc` | No | Virtual property display name. |
|
|
32
32
|
| `--table-type` | No | Property table type: `event` or `user`. Required when `--v-prop` is omitted. |
|
|
@@ -42,7 +42,7 @@ Safety constraints:
|
|
|
42
42
|
- Never invent command names, flags, JSON payloads, `project_id`, resource IDs, field names, event names, property names, metric definitions, or date formats. Read the matching command reference and discover real project metadata first.
|
|
43
43
|
- **NEVER fabricate or guess resource names** (reports, dashboards, events, properties, metrics, clusters, tags, alerts). Always use list commands to discover real resources first. If a resource is not found after fuzzy search and full list fallback, explicitly tell the user "resource not found" and stop - do not proceed with fabricated names.
|
|
44
44
|
|
|
45
|
-
**Community** commands use the domain `community` (this skill). Other AE domains include: `analysis` (analysis and audience), `
|
|
45
|
+
**Community** commands use the domain `community` (this skill). Other AE domains include: `analysis` (analysis and audience), `analysis-meta` (metadata), and `operation` (operations).
|
|
46
46
|
|
|
47
47
|
---
|
|
48
48
|
|
|
@@ -262,7 +262,7 @@ Commands below are shown **without** the `ae-cli community` prefix; all use the
|
|
|
262
262
|
|
|
263
263
|
## Composite scenario skills
|
|
264
264
|
|
|
265
|
-
Structured multi-step
|
|
265
|
+
Structured multi-step report workflows — open the linked reference for the complete ae-cli command sequence.
|
|
266
266
|
|
|
267
267
|
| Skill | Purpose |
|
|
268
268
|
|-------|---------|
|
|
@@ -17,7 +17,7 @@ The AE Data Development and Operations domain provides capabilities for data war
|
|
|
17
17
|
|------------|----------------|------------------------------|
|
|
18
18
|
| `dataops_repo` | Space discovery | — |
|
|
19
19
|
| `dataops_datatable` | Data table and view management | `dataops-table` |
|
|
20
|
-
| `dataops_flow` | Flow creation and orchestration | `dataops-flow-create` |
|
|
20
|
+
| `dataops_flow` | Flow creation, node deletion, and orchestration | `dataops-flow-create` |
|
|
21
21
|
| `dataops_flow` | Flow execution and monitoring | `dataops-flow-monitor` |
|
|
22
22
|
| `dataops_operations` | Operations instance search, details, and task logs | `dataops-flow-monitor` |
|
|
23
23
|
| `dataops_ide` | Data exploration and SQL queries | `dataops-query` |
|
|
@@ -89,7 +89,7 @@ You must understand the following key concepts before use, otherwise errors are
|
|
|
89
89
|
### Flow Lifecycle
|
|
90
90
|
|
|
91
91
|
```
|
|
92
|
-
Create DEV Flow → Create/Update DEV SQL, Integration, or
|
|
92
|
+
Create DEV Flow → Create/Update DEV SQL, Integration, Workflow Instance Check, or Task Instance Check Tasks → Configure Dependencies/Schedule → Preview Release → Release to PROD → PROD Manual Execution / Operations Troubleshooting
|
|
93
93
|
```
|
|
94
94
|
|
|
95
95
|
### CRON Format (6 fields)
|
|
@@ -112,7 +112,7 @@ Choose the appropriate scenario skill based on user intent to get complete step-
|
|
|
112
112
|
|
|
113
113
|
| User Intent | Trigger Skill | Keywords |
|
|
114
114
|
|-------------|---------------|----------|
|
|
115
|
-
| Create flow, add nodes, configure schedule, release | `dataops-flow-create` | create flow, new workflow, configure schedule, add task node, release, cron, scheduled execution |
|
|
115
|
+
| Create flow, add or delete nodes, configure schedule, release | `dataops-flow-create` | create flow, new workflow, configure schedule, add task node, delete task node, release, cron, scheduled execution |
|
|
116
116
|
| View execution status, troubleshoot failures, view logs | `dataops-flow-monitor` | execute flow, running instance, monitor, logs, stop, DAG, troubleshoot |
|
|
117
117
|
| Search operation instances across a space | `dataops-flow-monitor` | operations instance, flow instance search, status statistics, owner statistics |
|
|
118
118
|
| Create datasource, configure sync solution, execute sync | `dataops-integration` | datasource, sync, integration, field mapping, data ingestion, MySQL, ClickHouse, DatabricksJdbc |
|
|
@@ -159,6 +159,7 @@ Detailed creation/configuration commands live in [`references/dataops-flow-creat
|
|
|
159
159
|
|
|
160
160
|
Key constraints:
|
|
161
161
|
- Create and update tasks in DEV, preview/release before PROD execution.
|
|
162
|
+
- Treat `+delete_task` as high-risk: verify the target with `+get_flow_overview`, preview with `--dry-run`, and use `--yes` only after explicit user confirmation. Deletion affects DEV; release the flow to apply it to PROD.
|
|
162
163
|
- `+execute_flow` always runs PROD; it returns `executeId` for early stop.
|
|
163
164
|
- Prefer `flowInstanceId` from operations search for stable inspection and troubleshooting.
|
|
164
165
|
- Reference workspace parameters in task SQL as `${paramKey}`.
|
|
@@ -63,7 +63,9 @@ ae-cli dataops_flow +update_integration_task --spaceCode "${spaceCode}" \
|
|
|
63
63
|
|
|
64
64
|
Use `dataops_integration +list_sync_solutions` or `+get_sync_detail` to find the `syncId` first. These commands expose workflow `OFFLINE_SYNC` tasks only; app sync tasks are not part of this flow.
|
|
65
65
|
|
|
66
|
-
### Step 4: Create or Modify
|
|
66
|
+
### Step 4: Create or Modify Instance Check Tasks
|
|
67
|
+
|
|
68
|
+
#### Workflow instance check
|
|
67
69
|
|
|
68
70
|
`checkItems` is a flat JSON array. Every item contains only `flowCode`, `left`, `right`, and `checkTimeUnit` (`DAY`, `HOUR`, or `MINUTE`). One `AND` or `OR` relation applies to the entire array; nested groups are not supported. For the current workflow, `left` and `right` are at least `1`; for another workflow they may be `0`; `right` must not exceed `left`.
|
|
69
71
|
|
|
@@ -80,6 +82,23 @@ ae-cli dataops_flow +update_workflow_instance_check_task --spaceCode "${spaceCod
|
|
|
80
82
|
|
|
81
83
|
Create defaults are `relation=AND`, `checkInterval=5`, `checkTime=3`, `failRetryTimes=3`, `failRetryInterval=5`, and `failRetryUnit=MINUTE`. On update, omitted check scalars, dependencies, and retry fields keep their current values.
|
|
82
84
|
|
|
85
|
+
#### Task instance check
|
|
86
|
+
|
|
87
|
+
Each task instance `checkItems` entry contains only `flowCode`, `taskCode`, `left`, `right`, and `checkTimeUnit`. The nested `checkItems[].taskCode` identifies a target task inside that item's `flowCode`. On update, the top-level `--taskCode` identifies the TASK_CHECK node to update; it is not a target task code. Use `+get_flow_overview` to discover target task codes. Checking the TASK_CHECK node itself is supported.
|
|
88
|
+
|
|
89
|
+
```bash
|
|
90
|
+
ae-cli dataops_flow +create_task_instance_check_task --spaceCode "${spaceCode}" \
|
|
91
|
+
--flowCode ${flowCode} --taskName "Wait for target tasks" \
|
|
92
|
+
--checkItems '[{"flowCode":10037355068544,"taskCode":10380350567040,"left":1,"right":1,"checkTimeUnit":"DAY"},{"flowCode":10037355068545,"taskCode":10380350567041,"left":0,"right":0,"checkTimeUnit":"HOUR"}]' \
|
|
93
|
+
--relation OR
|
|
94
|
+
|
|
95
|
+
ae-cli dataops_flow +update_task_instance_check_task --spaceCode "${spaceCode}" \
|
|
96
|
+
--flowCode ${flowCode} --taskCode ${taskCheckNodeCode} \
|
|
97
|
+
--checkItems '[{"flowCode":10037355068544,"taskCode":10380350567040,"left":1,"right":1,"checkTimeUnit":"DAY"}]'
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
Task instance check create defaults are `relation=AND`, `checkInterval=10`, and `checkTime=3`; retry defaults are `3`, `5`, and `MINUTE`. `checkItems` is required and replaces the complete target list. On update, omitted check scalars, dependencies, and retry fields keep their current values.
|
|
101
|
+
|
|
83
102
|
### Step 5: Modify SQL Task Content
|
|
84
103
|
|
|
85
104
|
```bash
|
|
@@ -89,6 +108,24 @@ ae-cli dataops_flow +update_sql_task --spaceCode "${spaceCode}" \
|
|
|
89
108
|
--sql "SELECT * FROM dwd_user"
|
|
90
109
|
```
|
|
91
110
|
|
|
111
|
+
### Delete a Task Node
|
|
112
|
+
|
|
113
|
+
Verify the target with `+get_flow_overview` before any deletion. Preview the request first, then execute it only after explicit user confirmation:
|
|
114
|
+
|
|
115
|
+
```bash
|
|
116
|
+
ae-cli dataops_flow +get_flow_overview --spaceCode "${spaceCode}" \
|
|
117
|
+
--flowCode ${flowCode}
|
|
118
|
+
|
|
119
|
+
ae-cli dataops_flow +delete_task --spaceCode "${spaceCode}" \
|
|
120
|
+
--flowCode ${flowCode} --taskCode ${taskCode} --dry-run
|
|
121
|
+
|
|
122
|
+
# Run only after explicit user confirmation
|
|
123
|
+
ae-cli dataops_flow +delete_task --spaceCode "${spaceCode}" \
|
|
124
|
+
--flowCode ${flowCode} --taskCode ${taskCode} --yes
|
|
125
|
+
```
|
|
126
|
+
|
|
127
|
+
`+delete_task` deletes exactly one non-placeholder task node in DEV. It removes attached DAG edges but does not reconnect upstream and downstream nodes. It may terminate running DEV debug executions that include the node and does not repair cross-flow `TASK_CHECK` references. A published PROD node remains until the flow is released again. Repeated deletion, a task from another flow, or an internal placeholder returns an error.
|
|
128
|
+
|
|
92
129
|
### Step 6: Add Task Dependencies (DAG connections)
|
|
93
130
|
|
|
94
131
|
```bash
|
|
@@ -153,6 +190,9 @@ ae-cli dataops_operations +get_task_instance_detail --spaceCode "${spaceCode}" \
|
|
|
153
190
|
| `+update_integration_task` | Rebind DEV integration sync task to a sync solution | `--spaceCode` `--flowCode` `--taskCode` `--syncId` `[--preTasks]` `[--failRetryTimes]` `[--failRetryInterval]` `[--failRetryUnit]` |
|
|
154
191
|
| `+create_workflow_instance_check_task` | Create DEV workflow instance check task | `--spaceCode` `--flowCode` `--taskName` `--checkItems` `[--relation]` `[--checkInterval]` `[--checkTime]` `[--preTasks]` `[retry flags]` `[--remark]` |
|
|
155
192
|
| `+update_workflow_instance_check_task` | Update DEV workflow instance check task | `--spaceCode` `--flowCode` `--taskCode` `--checkItems` `[--relation]` `[--checkInterval]` `[--checkTime]` `[--preTasks]` `[retry flags]` |
|
|
193
|
+
| `+create_task_instance_check_task` | Create DEV task instance check task | `--spaceCode` `--flowCode` `--taskName` `--checkItems` `[--relation]` `[--checkInterval]` `[--checkTime]` `[--preTasks]` `[retry flags]` `[--remark]` |
|
|
194
|
+
| `+update_task_instance_check_task` | Update DEV task instance check task | `--spaceCode` `--flowCode` `--taskCode` `--checkItems` `[--relation]` `[--checkInterval]` `[--checkTime]` `[--preTasks]` `[retry flags]` |
|
|
195
|
+
| `+delete_task` | Delete one DEV task node after confirmation | `--spaceCode` `--flowCode` `--taskCode` `--yes` |
|
|
156
196
|
| `+add_task_relation` | Add DEV dependency | `--spaceCode` `--flowCode` `--preTaskCode` `--taskCode` |
|
|
157
197
|
| `+save_schedule_config` | Save DEV schedule config | `--spaceCode` `--flowCode` `--enabled` `[--cron]` |
|
|
158
198
|
| `+get_task_params` | View DEV task parameter list | `--spaceCode` `--flowCode` `--taskCode` |
|
|
@@ -169,14 +209,16 @@ ae-cli dataops_operations +get_task_instance_detail --spaceCode "${spaceCode}" \
|
|
|
169
209
|
- **Schedule config**: `+save_schedule_config` requires `--spaceCode`, `--flowCode`, and `--enabled`. `--cron` is required only when `--enabled true`; omit it when disabling scheduling. It returns `action/result/status`; `result` includes `enabled`, `flow`, `message`, and `cron` only when enabled.
|
|
170
210
|
- **Release preview**: `+preview_release_flow` requires `--spaceCode` and `--flowCode`; it has no optional flags. It returns `flowCode`, `releaseStatus`, `message`, and `changes`. Each change may include `scheduleConfigChange` and `tasks`; task entries may include `changed`, `contentCompare`, and `targetTable`.
|
|
171
211
|
- **Release**: `+release_flow` requires `--spaceCode` and `--flowCode`; it has no optional flags. It returns `action/result/status`; `result` includes `flowCode`, `releaseStatus`, `message`, optional `packageCode`, and optional `changes`. Each change may include `scheduleConfigChange` and `tasks`; task entries include `changed`.
|
|
172
|
-
- **Task dependencies**: `--preTasks` is a JSON array of upstream task codes on SQL, integration, and
|
|
173
|
-
- **Retry policy**:
|
|
212
|
+
- **Task dependencies**: `--preTasks` is a JSON array of upstream task codes on SQL, integration, workflow instance check, and task instance check create/update commands. Omit `--preTasks` on update to preserve existing dependencies; pass `--preTasks '[]'` to clear them; pass a non-empty array to replace them.
|
|
213
|
+
- **Retry policy**: All four task types accept `--failRetryTimes`, `--failRetryInterval`, and `--failRetryUnit`. Create defaults to `3`, `5`, and `MINUTE`. Update preserves every omitted retry field. `MINUTE` is the only supported unit.
|
|
174
214
|
- **SQL task creation**: `+create_sql_task` requires `--spaceCode`, `--flowCode`, `--taskName`, and `--sql`; SQL hooks, dependencies, retry policy, and remark are optional. It returns `action/result/status`; `result` includes `flowCode`, `taskCode`, `taskName`, `taskType=TRINO_SQL`, and `sqlSaved=true`.
|
|
175
215
|
- **SQL task update**: `+update_sql_task` requires `--spaceCode`, `--flowCode`, `--taskCode`, and `--sql`; omitted SQL hooks, dependencies, and retry fields keep existing values. It returns `action/result/status`; `result` includes `sqlSaved`, `flowCode`, `taskCode`, `taskType=TRINO_SQL`, and `task`.
|
|
176
216
|
- **Task dependency**: `+add_task_relation` requires `--spaceCode`, `--flowCode`, `--preTaskCode`, and `--taskCode`. `preTaskCode` is upstream and `taskCode` is downstream. It returns `action/result/status`; `result` includes `status`, `flowCode`, `preTaskCode`, `taskCode`, and `message`.
|
|
177
217
|
- **Task parameters**: `+get_task_params` requires `--spaceCode`, `--flowCode`, and `--taskCode`; it has no optional flags. It queries DEV and returns `data` as an array. Items include fields such as `paramKey`, `paramType`, `paramDataType`, `paramFrom`, and built-in flags like `isBd`.
|
|
178
218
|
- **Integration task creation**: `+create_integration_task` requires `--spaceCode`, `--flowCode`, `--taskName`, and `--syncId`; dependencies, retry policy, and remark are optional. It returns `action/result/status`; `result` includes `syncTaskSaved`, `flowCode`, `taskCode`, `taskName`, `taskType=OFFLINE_SYNC`, `syncId`, and `nextAction`.
|
|
179
219
|
- **Workflow instance check tasks**: `checkItems` is required and replaces the complete check item list. Create defaults `relation/checkInterval/checkTime` to `AND/5/3`; update preserves omitted scalar values. This command creates `FLOW_CHECK`, not task-instance `TASK_CHECK`.
|
|
220
|
+
- **Task instance check tasks**: `checkItems` is required and replaces the complete check item list. Each item identifies a target using `flowCode` and `taskCode`. Create defaults `relation/checkInterval/checkTime` to `AND/10/3`; update preserves omitted scalar values. This command creates `TASK_CHECK`.
|
|
221
|
+
- **Task deletion**: `+delete_task` requires `--spaceCode`, `--flowCode`, and `--taskCode`. It is a `high-risk-write`: inspect the node with `+get_flow_overview`, run `--dry-run`, obtain explicit confirmation, and then pass `--yes`. It changes DEV only; release the flow to apply deletion to PROD.
|
|
180
222
|
|
|
181
223
|
## Transport Status
|
|
182
224
|
|
|
@@ -186,6 +228,8 @@ Owning module: gaia-mcp workflow
|
|
|
186
228
|
|
|
187
229
|
Current transport: DataOps CLI REST
|
|
188
230
|
|
|
231
|
+
Covered workflow tools: `flow_create_workflow_instance_check_task`, `flow_update_workflow_instance_check_task`, `flow_create_task_instance_check_task`, `flow_update_task_instance_check_task`, and `flow_delete_task`
|
|
232
|
+
|
|
189
233
|
Gateway target: TBD after DataOps workflow Gateway schema review
|
|
190
234
|
|
|
191
235
|
Review after: 2026-10-27
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: ae-engage
|
|
3
3
|
version: 1.0.0
|
|
4
|
-
description: "AE Engage capability gateway: config center, flows, push/config channels, strategies, templates, task management, and
|
|
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
|
|
|
7
7
|
# ae-engage
|
|
@@ -33,7 +33,7 @@ Safety constraints:
|
|
|
33
33
|
|
|
34
34
|
## Overview
|
|
35
35
|
|
|
36
|
-
The `ae-engage` package provides Hermes Engage capabilities across config items, flows, channel settings, and
|
|
36
|
+
The `ae-engage` package provides Hermes Engage capabilities across config items, flows, channel settings, task data, and query lifecycle. Use capability-gateway commands through `ae-cli engage-flow|engage-task|engage-setting|engage-scene|engage-query <resource> <action>`; low-frequency reports use the L3 references below.
|
|
37
37
|
|
|
38
38
|
Typical use cases include:
|
|
39
39
|
|
|
@@ -175,6 +175,10 @@ ae-cli engage-task task get --project-id 1 --task-id task_123
|
|
|
175
175
|
# Submit a saved draft task for approval
|
|
176
176
|
ae-cli engage-task task submit-approval --project-id 1 --task-id task_123
|
|
177
177
|
|
|
178
|
+
# Query task reports through the Hermes inline task-data capabilities
|
|
179
|
+
ae-cli engage-task effect query --project-id 1 --task-id task_123 --start-time 2026-04-01 --end-time 2026-04-07 --metric-id-list '["metric_1"]'
|
|
180
|
+
ae-cli engage-task data-detail query --project-id 1 --task-id task_123 --detail-type time --start-time 2026-04-01 --end-time 2026-04-07
|
|
181
|
+
|
|
178
182
|
```
|
|
179
183
|
|
|
180
184
|
For L3 task reports, read `references/task-data-overview.md`, `references/task-data-detail.md`,
|
|
@@ -219,8 +223,29 @@ ae-cli engage-task task submit-approval --project-id 1 --task-id task_id_123
|
|
|
219
223
|
|
|
220
224
|
# Query the node schema
|
|
221
225
|
ae-cli engage-flow node-config schema --project-id 1 --node-type message_push
|
|
226
|
+
ae-cli engage-flow metric update --project-id 1 --flow-id flow_id_123 --metric-map '<metric_map_json>'
|
|
227
|
+
|
|
228
|
+
# Query or export newly exposed flow report surfaces
|
|
229
|
+
ae-cli engage-flow report metric-detail run --project-id 1 --flow-id flow_id_123 --node-uuid node_uuid_123 --start-time 2026-04-01 --end-time 2026-04-07 --limit 100 --timeout-seconds 120
|
|
230
|
+
ae-cli engage-flow report metric-detail export --project-id 1 --flow-id flow_id_123 --node-uuid node_uuid_123 --start-time 2026-04-01 --end-time 2026-04-07 --artifact-format csv --timeout-seconds 21600
|
|
231
|
+
ae-cli engage-flow metric-user run --project-id 1 --flow-id flow_id_123 --indicator-name entry --start-time 2026-04-01 --end-time 2026-04-07 --limit 100 --timeout-seconds 120
|
|
232
|
+
ae-cli engage-flow metric-user export --project-id 1 --flow-id flow_id_123 --indicator-name entry --start-time 2026-04-01 --end-time 2026-04-07 --artifact-format csv --timeout-seconds 21600
|
|
233
|
+
ae-cli engage-flow node-user run --project-id 1 --flow-id flow_id_123 --node-uuid node_uuid_123 --indicator-name entry --start-time 2026-04-01 --end-time 2026-04-07 --limit 100 --timeout-seconds 120
|
|
234
|
+
ae-cli engage-flow node-user export --project-id 1 --flow-id flow_id_123 --node-uuid node_uuid_123 --indicator-name entry --start-time 2026-04-01 --end-time 2026-04-07 --artifact-format csv --timeout-seconds 21600
|
|
235
|
+
ae-cli engage-flow node-metric-user run --project-id 1 --flow-id flow_id_123 --node-uuid node_uuid_123 --indicator-name metric_setting_id_123 --start-time 2026-04-01 --end-time 2026-04-07 --limit 100 --timeout-seconds 120
|
|
236
|
+
ae-cli engage-flow node-metric-user export --project-id 1 --flow-id flow_id_123 --node-uuid node_uuid_123 --indicator-name metric_setting_id_123 --start-time 2026-04-01 --end-time 2026-04-07 --artifact-format csv --timeout-seconds 21600
|
|
222
237
|
```
|
|
223
238
|
|
|
239
|
+
User-detail `run` commands are for bounded inline rows and accept `--request-id`, `--limit`, and `--timeout-seconds`; metric-detail `run` returns the report object. Export commands accept `--request-id`, `--artifact-format csv|jsonl` (default `jsonl`), and `--timeout-seconds`, then return `run_id` and `artifact_id`; poll with `ae-cli engage-query run inspect --run-id RUN_ID`, then download with `ae-cli engage-query artifact download --run-id RUN_ID --artifact-id ARTIFACT_ID --output ./artifact.jsonl.gz`. Cancel running async work with `ae-cli engage-query query cancel --run-id RUN_ID`.
|
|
240
|
+
|
|
241
|
+
For flow report/user-detail commands, read the matching reference before composing non-trivial input:
|
|
242
|
+
|
|
243
|
+
- Flow canvas custom metric configuration: `references/flow-metric-update.md`
|
|
244
|
+
- Metric-detail report object or flattened report export: `references/flow-metric-detail-report.md`
|
|
245
|
+
- Users behind a process-level metric segment: `references/flow-metric-user.md`
|
|
246
|
+
- Users behind a node-level data segment: `references/flow-node-user.md`
|
|
247
|
+
- Users behind a node-level metric segment: `references/flow-node-metric-user.md`
|
|
248
|
+
|
|
224
249
|
### 5. scene (scene management / config center)
|
|
225
250
|
|
|
226
251
|
New capability-gateway command group `engage-scene` covers the config center: config items, params, groups, preset/related metrics, config channels, strategies, and templates. Complex DTOs are passed with `--payload` (native camelCase JSON).
|
|
@@ -442,6 +467,7 @@ More detailed single-command guidance is available in the business-oriented `ref
|
|
|
442
467
|
- `references/add-approver.md` / `references/approver-list.md` (`engage-setting.approval-approver.{add,list}`)
|
|
443
468
|
- `references/whitelist-list.md` / `references/whitelist.md` (`engage-setting.whitelist.{list,add,update,delete,verify}`)
|
|
444
469
|
- `references/cancel-query-by-request-id.md` (`engage-setting.query.cancel`, L3)
|
|
470
|
+
- `references/cancel-query-run.md` (`engage-query.query.cancel`)
|
|
445
471
|
- `references/push-language.md` (`engage-setting.push-language.{get,set}`)
|
|
446
472
|
- `references/client-param.md` (`engage-setting.client-param.{create,update,delete,list}`)
|
|
447
473
|
- `references/config-table.md` (`engage-setting.config-table.{upload,save,list,query-data,update-data,delete}`)
|
|
@@ -480,6 +506,9 @@ More detailed single-command guidance is available in the business-oriented `ref
|
|
|
480
506
|
- `references/group-list.md` (`engage-task.group.list`)
|
|
481
507
|
- `references/task-delete.md` (`engage-task.task.delete`)
|
|
482
508
|
- `references/task-submit-approval.md` (`engage-task.task.submit-approval`)
|
|
509
|
+
- `references/task-data-detail.md` (`engage-task data-detail query`; capability `engage-task.task-data.detail`)
|
|
510
|
+
- `references/task-metric-detail.md` (`engage-task effect query`; capability `engage-task.task-data.metric-detail`)
|
|
511
|
+
- `references/flow-metric-update.md` (`engage-flow metric update`; capability `engage-flow.metric.update`)
|
|
483
512
|
|
|
484
513
|
This split documentation structure is easier to extend later, because commands with more complex object inputs can stay centralized in the `references/` root directory.
|
|
485
514
|
|
|
@@ -491,7 +520,11 @@ This split documentation structure is easier to extend later, because commands w
|
|
|
491
520
|
|
|
492
521
|
### task
|
|
493
522
|
|
|
494
|
-
`operation-log query` / `push-record query` / `segment-list *` / `ops *` / `metric *` / `race release` / `channel-ref stats` / `group *` / `task delete` / `task modify-group` / `task submit-approval` / `task get` / `task list` / `task stats` / `task build-save-guide` / `task save` / `task manage` (via `engage-task`), plus L3 capabilities `engage-task.task-data.{overview,detail,metric-detail,experiment-report}`
|
|
523
|
+
`operation-log query` / `push-record query` / `segment-list *` / `ops *` / `metric *` / `race release` / `channel-ref stats` / `group *` / `task delete` / `task modify-group` / `task submit-approval` / `task get` / `task list` / `task stats` / `task build-save-guide` / `task save` / `task manage` / `effect query` / `data-detail query` (via `engage-task`), plus L3 capabilities `engage-task.task-data.{overview,detail,metric-detail,experiment-report}`
|
|
524
|
+
|
|
525
|
+
### query
|
|
526
|
+
|
|
527
|
+
`run inspect` / `artifact download` / `query cancel` (via `engage-query`), capability ID `engage-query.query.cancel`
|
|
495
528
|
|
|
496
529
|
### config
|
|
497
530
|
|
|
@@ -511,7 +544,7 @@ Legacy config MCP commands are migrated into the `scene` L2 group and the three
|
|
|
511
544
|
|
|
512
545
|
### flow
|
|
513
546
|
|
|
514
|
-
`operation-log query` / `version list` / `flow update-remark` / `flow save` / `node-config schema` / `flow get` / `flow list` / `flow manage` / `node-config validate` / `flow delete` / `flow modify-base-info` (via `engage-flow`), plus L3 capabilities `engage-flow.report.{node-overview,process,node-detail,ab-split-node}`
|
|
547
|
+
`operation-log query` / `version list` / `flow update-remark` / `flow save` / `node-config schema` / `flow get` / `flow list` / `flow manage` / `node-config validate` / `flow delete` / `flow modify-base-info` / `metric update` / `report metric-detail run` / `report metric-detail export` / `metric-user run` / `metric-user export` / `node-user run` / `node-user export` / `node-metric-user run` / `node-metric-user export` (via `engage-flow`), plus L3 capabilities `engage-flow.report.{node-overview,process,node-detail,ab-split-node}`
|
|
515
548
|
|
|
516
549
|
## Date Format
|
|
517
550
|
|
|
@@ -532,8 +565,10 @@ For task draft creation or update, use this workflow:
|
|
|
532
565
|
1. `ae-cli engage-setting channel list --project-id <projectId>`
|
|
533
566
|
2. `ae-cli engage-task task build-save-guide --project-id <projectId> --req '{...}'`
|
|
534
567
|
3. For a custom audience, pass the Analysis semantic contract as
|
|
535
|
-
`targetConfig.definitionRequest`.
|
|
536
|
-
`
|
|
568
|
+
`targetConfig.definitionRequest`. For an event-triggered task, use semantic
|
|
569
|
+
`triggerConfig.triggerDefinition` and
|
|
570
|
+
always include `periodTimeSymbol` (`TS01`, `TS02`, `TS03`, or `TS04`) on its primary A rule.
|
|
571
|
+
Use semantic `completionIndicatorDef.completionIndicators[].eventDefinition`. Build shapes from
|
|
537
572
|
`ae-analysis` user-cluster / audience models. For existing-cluster audiences
|
|
538
573
|
(`targetClusterType=2`), use `analysis user-cluster get`. For event-triggered tasks, pass
|
|
539
574
|
`channelType`, `triggerType`, and `eventTriggerType` to `build-save-guide`, then use its
|
|
@@ -546,6 +581,11 @@ For task draft creation or update, use this workflow:
|
|
|
546
581
|
5. `ae-cli engage-task task submit-approval --project-id <projectId> --task-id <taskId>`
|
|
547
582
|
|
|
548
583
|
`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`.
|
|
584
|
+
When `enableExp=true`, capability `engage-task.task.build-save-guide` enriches the handoff so
|
|
585
|
+
`groupContentList` association fields
|
|
586
|
+
(`expGroupName`/`expGroupType`/`percentageInExperiment`/`order`) stay aligned with
|
|
587
|
+
`expConfig.expGroupList`; only replace `contentList[].content`. Capability `engage-task.task.save`
|
|
588
|
+
rejects misaligned experiment content with `TASK_EXPERIMENT_GROUP_CONTENT_INVALID`.
|
|
549
589
|
|
|
550
590
|
`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).
|
|
551
591
|
|