@thinkingai/ae-cli 6.0.55 → 6.0.57
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 -6
- package/README.zh.md +35 -6
- package/bin/ae-cli.js +5 -0
- package/bin/runtime-capabilities.json +5 -0
- package/cli-installation-guide.md +24 -3
- package/dist/{auth-RQBO6MTY.js → auth-YEIJLBFY.js} +61 -19
- package/dist/{automation-VAAQBM7Y.js → automation-NAR5DDGL.js} +94 -38
- package/dist/{capability-JRIFC4AJ.js → capability-P7DD4Q73.js} +50 -21
- package/dist/{chunk-5XJYLEVC.js → chunk-72NJKS7O.js} +4 -4
- package/dist/chunk-752BSLZC.js +222 -0
- package/dist/{chunk-RGYPSEYD.js → chunk-7ABK2PEJ.js} +3 -3
- package/dist/{chunk-Q5US7JC5.js → chunk-7JAVT5TK.js} +3 -3
- package/dist/{chunk-GHXZK54S.js → chunk-H3K5UGYC.js} +41 -13
- package/dist/{chunk-OP44TT4H.js → chunk-IN7KKL6K.js} +4 -2
- package/dist/{chunk-VZZNLV3I.js → chunk-JCWM2TYP.js} +61 -15
- package/dist/{chunk-S6M42KND.js → chunk-JEUXDY3B.js} +1 -1
- package/dist/{chunk-ZL7SGNIA.js → chunk-JNVVJ273.js} +58 -46
- package/dist/chunk-N6XBLRB7.js +105 -0
- package/dist/{chunk-AP7YP2NX.js → chunk-OAWPT7VP.js} +2 -2
- package/dist/{chunk-7KU2WNQE.js → chunk-QEMQKVHW.js} +37 -15
- package/dist/{chunk-CT7QDJS6.js → chunk-QVRIDN42.js} +2 -2
- package/dist/{chunk-RPBOAQQQ.js → chunk-QZUVLFNR.js} +1 -1
- package/dist/{chunk-3YVEAZUN.js → chunk-RJHGDWSC.js} +32 -21
- package/dist/{chunk-374V5R6N.js → chunk-TKVVACEJ.js} +6 -4
- package/dist/chunk-TULINOLS.js +2283 -0
- package/dist/chunk-YVG6QD3V.js +233 -0
- package/dist/{chunk-WNGFSIOB.js → chunk-Z3Q2AEIN.js} +237 -86
- package/dist/chunk-ZGIYG473.js +132 -0
- package/dist/{community-report-client-PEERQCX2.js → community-report-client-TJVCLZ3K.js} +1 -1
- package/dist/compat-check-PMEGUPZU.js +32 -0
- package/dist/{config-SICKWZ2A.js → config-VWVPR4WW.js} +43 -10
- package/dist/{context-NGVFPCBK.js → context-F6FCGTF3.js} +4 -4
- package/dist/{data-integration-BCLQFTGU.js → data-integration-6UAZO4GG.js} +207 -24
- package/dist/evaluation-4LO2O4AF.js +3714 -0
- package/dist/index.js +343 -79
- package/dist/{local-data-upload-client-TWMHFLUA.js → local-data-upload-client-KCMG6J62.js} +1 -1
- package/dist/{memory-CQKH2JAV.js → memory-HHPX3NF2.js} +6 -6
- package/dist/{metadata-EMFGUI2W.js → metadata-HEQQEEG3.js} +17 -9
- package/dist/{model-VX5M2CJ6.js → model-7UHGWYVR.js} +4 -4
- package/dist/{personal-semantic-preference-SLWVVYZ4.js → personal-semantic-preference-V4L6ZWR2.js} +7 -6
- package/dist/{project-semantic-DPSZBKQD.js → project-semantic-NKHKJX6M.js} +7 -6
- package/dist/{sync-RZIAV37C.js → sync-ZJMXCRIN.js} +8 -7
- package/dist/{te-agent-AORRE2FM.js → te-agent-WBKIFEQD.js} +757 -94
- package/dist/{te-analysis-ISXKJKRT.js → te-analysis-ADX7RKO4.js} +578 -94
- package/dist/{te-community-42M7ICDO.js → te-community-PREDRXG3.js} +722 -228
- package/dist/{te-dataops-BNKNZ4F2.js → te-dataops-ITWJHO2U.js} +9 -6
- package/dist/{te-engage-BZE3MBKT.js → te-engage-VE2NUH5V.js} +7 -6
- package/dist/{te-kb-ULATOTQ3.js → te-kb-WSMOW7WS.js} +407 -83
- package/dist/{te-system-UGHVKBVV.js → te-system-YM657FKO.js} +6 -6
- package/dist/{te-team-YA6SNOJ3.js → te-team-T2WRLOOD.js} +64 -41
- package/dist/{things-DTCOQIQB.js → things-6QOMFXOG.js} +7 -7
- package/dist/{update-ESNYKUVR.js → update-I4MOUYOX.js} +11 -7
- package/dist/{workspace-JEOHKFPX.js → workspace-LYDAP647.js} +6 -6
- package/package.json +25 -11
- package/skills/ae-agent/SKILL.md +20 -3
- package/skills/ae-agent/references/command_index.md +8 -0
- package/skills/ae-agent/references/resource-package.md +57 -0
- package/skills/ae-analysis/SKILL.md +23 -10
- package/skills/ae-analysis/references/adhoc_export.md +1 -1
- package/skills/ae-analysis/references/agent_review_preflight.md +55 -10
- package/skills/ae-analysis/references/agent_review_priorities_comparisons.md +5 -3
- package/skills/ae-analysis/references/agent_review_submit_to_page.md +60 -24
- package/skills/ae-analysis/references/ai_models/event.md +58 -2
- package/skills/ae-analysis/references/ai_models/rank_list.md +1 -0
- package/skills/ae-analysis/references/ai_models/retention.md +2 -0
- package/skills/ae-analysis/references/ai_models/revenue.md +2 -0
- package/skills/ae-analysis/references/analysis_data_export.md +11 -1
- package/skills/ae-analysis/references/asset_batch_info_export.md +2 -2
- package/skills/ae-analysis/references/asset_batch_sql_export.md +2 -2
- package/skills/ae-analysis/references/asset_export.md +1 -1
- package/skills/ae-analysis/references/bi_panel_page_data_export.md +1 -1
- package/skills/ae-analysis/references/check_export.md +1 -1
- package/skills/ae-analysis/references/command_index.md +39 -26
- package/skills/ae-analysis/references/dashboard_report_data_export.md +2 -0
- package/skills/ae-analysis/references/dashboard_report_get.md +6 -2
- package/skills/ae-analysis/references/dashboard_report_update.md +24 -5
- package/skills/ae-analysis/references/feedback_submit.md +1 -1
- package/skills/ae-analysis/references/governance_recommendation_export.md +40 -18
- package/skills/ae-analysis/references/governance_recommendation_run_update.md +13 -0
- package/skills/ae-analysis/references/live_data_export.md +1 -1
- package/skills/ae-analysis/references/metric_create.md +29 -0
- package/skills/ae-analysis/references/metric_get.md +2 -0
- package/skills/ae-analysis/references/metric_update.md +2 -0
- package/skills/ae-analysis/references/operation_record_export.md +1 -1
- package/skills/ae-analysis/references/plan_change_log_export.md +1 -1
- package/skills/ae-analysis/references/plan_export.md +1 -1
- package/skills/ae-analysis/references/project_info_get.md +4 -0
- package/skills/ae-analysis/references/project_member_group_add_members.md +35 -0
- package/skills/ae-analysis/references/project_member_group_create.md +25 -0
- package/skills/ae-analysis/references/project_member_group_delete.md +34 -0
- package/skills/ae-analysis/references/project_member_group_list.md +29 -0
- package/skills/ae-analysis/references/project_member_group_members.md +28 -0
- package/skills/ae-analysis/references/project_member_group_remove_members.md +35 -0
- package/skills/ae-analysis/references/project_member_group_rename.md +26 -0
- package/skills/ae-analysis/references/project_semantic_knowledge_wiki.md +9 -1
- package/skills/ae-analysis/references/project_semantic_knowledge_wiki_plan_schema.md +6 -1
- package/skills/ae-analysis/references/report_data_export.md +1 -1
- package/skills/ae-analysis/references/scenario_append.md +31 -0
- package/skills/ae-analysis/references/scenario_begin.md +11 -0
- package/skills/ae-analysis/references/scenario_collect.md +43 -0
- package/skills/ae-analysis/references/scenario_evaluation.md +18 -0
- package/skills/ae-analysis/references/scenario_get.md +15 -0
- package/skills/ae-analysis/references/scenario_list.md +64 -0
- package/skills/ae-analysis/scripts/project-semantic-knowledge-wiki/build-project-semantic-wiki.mjs +73 -4
- package/skills/ae-analysis/scripts/project-semantic-knowledge-wiki/company-kb.mjs +14 -1
- package/skills/ae-analysis/scripts/project-semantic-knowledge-wiki/default-compile-schema.md +5 -1
- package/skills/ae-analysis/scripts/project-semantic-knowledge-wiki/execution-contract.mjs +173 -0
- package/skills/ae-analysis/scripts/project-semantic-knowledge-wiki/generate-build-ir.mjs +109 -64
- package/skills/ae-automation/SKILL.md +2 -2
- package/skills/ae-automation/references/cli.md +18 -1
- package/skills/ae-capability/SKILL.md +7 -3
- package/skills/ae-community/SKILL.md +77 -27
- package/skills/ae-community/references/community-analyzing-theme-comment.md +10 -8
- package/skills/ae-community/references/community-data-quality.md +68 -0
- package/skills/ae-community/references/community-query-evidence.md +85 -0
- package/skills/ae-community/references/community-scenario-capabilities.md +137 -0
- package/skills/ae-community/references/community-weekly-report.md +6 -3
- package/skills/ae-community/references/get_channel_info.md +7 -4
- package/skills/ae-community/references/get_comment_tag_analysis.md +3 -3
- package/skills/ae-community/references/get_comments_summary.md +4 -4
- package/skills/ae-community/references/get_corpus_tags.md +3 -3
- package/skills/ae-community/references/get_daily_summary.md +3 -3
- package/skills/ae-community/references/get_hot_topics.md +3 -3
- package/skills/ae-community/references/get_livestream_analysis.md +3 -3
- package/skills/ae-community/references/get_livestream_detail.md +4 -4
- package/skills/ae-community/references/get_livestream_list.md +3 -3
- package/skills/ae-community/references/get_livestream_overview.md +3 -3
- package/skills/ae-community/references/get_livestream_room_metrics.md +3 -3
- package/skills/ae-community/references/get_livestream_rooms.md +3 -3
- package/skills/ae-community/references/get_overview_metrics.md +3 -3
- package/skills/ae-community/references/get_post_detail.md +4 -4
- package/skills/ae-community/references/get_risk_content.md +5 -5
- package/skills/ae-community/references/get_sentiment_overview.md +4 -4
- package/skills/ae-community/references/get_tag_trends.md +3 -3
- package/skills/ae-community/references/get_topic_detail.md +3 -3
- package/skills/ae-community/references/list_sources.md +28 -0
- package/skills/ae-community/references/list_spaces.md +39 -0
- package/skills/ae-community/references/search_posts.md +21 -7
- package/skills/ae-data-integration/SKILL.md +6 -4
- package/skills/ae-data-integration/references/error-handling.md +1 -0
- package/skills/ae-data-integration/references/handoff.md +1 -1
- package/skills/ae-data-integration/references/sink-upload.md +11 -0
- package/skills/ae-data-integration/references/source-inspect.md +2 -1
- package/skills/ae-data-integration/references/transform.md +1 -1
- package/skills/ae-data-integration/references/ue-mapping.md +1 -1
- package/skills/ae-evaluation/SKILL.md +83 -0
- package/skills/ae-evaluation/references/access-and-members.md +55 -0
- package/skills/ae-evaluation/references/connections.md +78 -0
- package/skills/ae-evaluation/references/datasets.md +57 -0
- package/skills/ae-evaluation/references/evaluators.md +81 -0
- package/skills/ae-evaluation/references/files.md +33 -0
- package/skills/ae-evaluation/references/integrations.md +39 -0
- package/skills/ae-evaluation/references/runs.md +160 -0
- package/skills/ae-evaluation/references/schedules.md +31 -0
- package/skills/ae-kb/SKILL.md +33 -6
- package/skills/ae-kb/references/publication.md +81 -0
- package/skills/ae-kb/references/query-workflow.md +14 -1
- package/skills/ae-metadata/SKILL.md +3 -2
- package/skills/ae-metadata/references/metadata_data_table_download.md +7 -1
- package/skills/ae-metadata/references/metadata_data_table_get.md +37 -0
- package/skills/ae-team/SKILL.md +2 -2
- package/skills/ae-team/references/run-start.md +1 -0
- package/skills/ae-team/references/run-watch.md +7 -5
- package/skills/ae-things/SKILL.md +53 -51
- package/skills/ae-things/references/cli.md +56 -54
- package/skills/ae-things-progress/SKILL.md +20 -20
- package/skills/ae-things-review/SKILL.md +19 -19
- package/dist/chunk-6VNIR4AP.js +0 -1422
- package/dist/chunk-CI24BDR2.js +0 -43
|
@@ -87,14 +87,70 @@ Formula metric example:
|
|
|
87
87
|
Formula rules:
|
|
88
88
|
|
|
89
89
|
- Write **bare aliases** only in `formula` (e.g. `"revenue / users"` or `"pay / dau"`).
|
|
90
|
-
- **Do not** write `alias.Axxx` (e.g. `"pay.A103"` / `"revenue.A103"`).
|
|
90
|
+
- **Do not** write `alias.Axxx` (e.g. `"pay.A103"` / `"revenue.A103"`). Event aggregation codes come from that dependency's `aggregation`; saved-metric dependencies retain their own definition. The builder expands aliases to native event or saved-metric tokens.
|
|
91
91
|
- Verify the complete formula through one analysis query and inspect its resolved definition and result before saving it. Reuse that result; a formula does not require a removed QP builder.
|
|
92
92
|
|
|
93
|
+
## Formula operand filters
|
|
94
|
+
|
|
95
|
+
For a new or intentionally rewritten formula, put each operand's conditions in that dependency's `filters`; `relation` joins its filters and defaults to `and`. These use the generic filter shape (`field`, `operator`, `values`, or an `items`/`relation` group), not the event-only `event_property_name` shape. Resolve event properties against that dependency's event. For example, only the numerator below requires the spring festival and `win=true`; the denominator remains unfiltered:
|
|
96
|
+
|
|
97
|
+
```json
|
|
98
|
+
{
|
|
99
|
+
"time_range": {"mode": "previous", "unit": "day", "value": 7},
|
|
100
|
+
"metrics": [{
|
|
101
|
+
"formula": "completed / participants",
|
|
102
|
+
"dependencies": [
|
|
103
|
+
{
|
|
104
|
+
"alias": "completed", "event": "activity_dungeon", "aggregation": "total_count",
|
|
105
|
+
"relation": "and",
|
|
106
|
+
"filters": [
|
|
107
|
+
{"field": {"type": "event_property", "name": "festival_name"}, "operator": "eq", "values": ["spring"]},
|
|
108
|
+
{"field": {"type": "event_property", "name": "win"}, "operator": "is_true"}
|
|
109
|
+
]
|
|
110
|
+
},
|
|
111
|
+
{"alias": "participants", "event": "char_login", "aggregation": "total_count"}
|
|
112
|
+
]
|
|
113
|
+
}]
|
|
114
|
+
}
|
|
115
|
+
```
|
|
116
|
+
|
|
117
|
+
Replace the example events and properties with verified project metadata. Use `is_true` / `is_false` without `values` for boolean conditions; do not encode `win=true` as `eq` with `[true]` or `["true"]`.
|
|
118
|
+
|
|
119
|
+
- To filter only the denominator, add `filters` only to its dependency. To give both sides different conditions, populate each dependency independently. One alias's filters apply to all its repeated occurrences; use different aliases for different filters on the same event. Binding follows expression occurrence order, not the order of `dependencies` and not deduplicated event names.
|
|
120
|
+
- Do not move operand filters to root `definition.filters` or to the formula metric's common `filters`: these are shared calculation scopes, not a substitute for numerator/denominator conditions. Keep any intentionally supplied common filters independent of the dependency conditions; never copy an operand's conditions there as a fallback.
|
|
121
|
+
- Compound groups use `{"relation":"and|or","items":[...]}`. Saved-report writes still obey the shared one-compound-level boundary; ad-hoc queries keep recursive support.
|
|
122
|
+
- Filters on a saved metric dependency are not supported; the server rejects them rather than ignoring them. Preserve that metric's existing definition or use an explicitly verified ordinary event dependency. Do not expand or replace a saved metric merely to bypass this restriction.
|
|
123
|
+
- Before using this shape on an older host, check its capability schema for dependency `filters` / `relation`. A new CLI alone does not add server compiler support. If unsupported, report the deployment prerequisite; never silently omit the operand filters.
|
|
124
|
+
- Choose one formula representation. Native `formulation` or non-empty `custom_filters` must not be mixed with non-empty authoring `dependencies`; conflicting input is rejected rather than losing saved conditions or native UI metadata. For an unchanged saved formula, preserve all returned native fields and omit `dependencies`. To intentionally reauthor it, supply a complete reviewed formula/dependency definition and remove conflicting native fields; do not claim this preserves arbitrary native metadata. A supported `format` and display metadata may be kept.
|
|
125
|
+
|
|
126
|
+
### Saved metrics as formula operands
|
|
127
|
+
|
|
128
|
+
An event-report formula can reference verified saved metrics directly, without expanding their event definitions. Use each metric's discovered `metric_name` in the dependency's `event` field; it is not a metric ID or a numbered report measure. The compiler resolves the visible metric and preserves its calculation definition. Write only bare aliases in the expression:
|
|
129
|
+
|
|
130
|
+
```json
|
|
131
|
+
{
|
|
132
|
+
"time_range": {"mode":"previous","unit":"day","value":7},
|
|
133
|
+
"metrics": [{
|
|
134
|
+
"formula":"third / total",
|
|
135
|
+
"dependencies":[
|
|
136
|
+
{"alias":"third","event":"<verified_third_party_metric_name>"},
|
|
137
|
+
{"alias":"total","event":"<verified_total_metric_name>"}
|
|
138
|
+
]
|
|
139
|
+
}]
|
|
140
|
+
}
|
|
141
|
+
```
|
|
142
|
+
|
|
143
|
+
Replace placeholders with confirmed metric names from the current project. Omit `aggregation`, `property`, and `percentile` for saved-metric operands: the metric already owns these choices. Do not add dummy `total_count` or `sum` to satisfy a validation error. A mixed formula may combine this saved-metric shape with an ordinary event dependency that supplies its real aggregation and required property/percentile. Missing, inaccessible, or ambiguous metadata must follow compiler guidance; do not silently replace a saved metric with an event or inline a different calculation.
|
|
144
|
+
|
|
145
|
+
A saved metric's own filters belong to its calculation; this is different from adding new `filters` to a saved-metric dependency, which remains unsupported. When creating a filtered metric for later formula reuse, follow [`metric_create.md`](../metric_create.md#saved-metric-filters) and verify its saved conditions with `analysis-meta metric get`. Reuse that verified metric by name without expanding or stripping its definition. To divide filtered replies by all replies, keep the filtered metric only in the numerator and use an independently verified unfiltered metric or event in the denominator; moving its conditions to the formula's common filters changes both sides.
|
|
146
|
+
|
|
147
|
+
This is a formula inside an event analysis/report, not `analysis-meta metric create`, and it does not imply saved-metric dependency support for retention or other models. Existing saved-formula round-trip rules below still apply.
|
|
148
|
+
|
|
93
149
|
Saved formula report round-trip rules:
|
|
94
150
|
|
|
95
151
|
- `analysis report get` can return saved formula metrics with `custom_filters`, `formulation`, `custom_event_desc`, `event_desc`, `format`, `event_type`, `event_split_indexes`, `quota_time_ranges`, `quota_entities`, and `event_uuid`. These are saved-report round-trip fields, not the authoring shape for a new formula.
|
|
96
152
|
- When updating an existing report from its returned `definition`, preserve all of those fields unchanged unless the user explicitly requests that formula behavior to change. `custom_filters[*].index` binds each numerator/denominator occurrence to its own filter set, including repeated event/aggregation tokens.
|
|
97
|
-
- For a display-name-only change, modify only `display_name`. Do not convert the saved formula to `formula + dependencies
|
|
153
|
+
- For a display-name-only change, modify only `display_name`. Do not convert the saved formula to `formula + dependencies`; reauthoring is a different operation and cannot preserve arbitrary native metadata automatically. Mixed representations are rejected as described above.
|
|
98
154
|
- Continue to use the `formula + dependencies` shape above when authoring a new formula metric.
|
|
99
155
|
|
|
100
156
|
Saved report filter round-trip rules:
|
|
@@ -31,6 +31,7 @@ Use for ranking users/entities by an event metric.
|
|
|
31
31
|
- `accompanying_properties` is an array of field dimensions. The main `rank_dimension` and accompanying properties support `array_grouping`, `time_granularity`, and historical tag/cluster date policies. Numeric buckets, funnel steps, and retention sources are not rank-list options.
|
|
32
32
|
- For formula ranking, set `rank_formula` to a formula metric definition. Omit the mutually exclusive regular metric fields `rank_event`, `rank_aggregation`, `rank_property`, `rank_filters`, `rank_relation`, and `rank_quota_entities`; put formula filters inside `rank_formula.filters`. Keep the outer `order_by` as `ASC` or `DESC`.
|
|
33
33
|
- Formula dependencies and accompanying metrics use the same aggregation restrictions as the primary metric, including the exclusion of `percentile`. Preserve saved formula metadata returned by report reads.
|
|
34
|
+
- Both `rank_formula` and accompanying formulas support [operand-specific filters](event.md#formula-operand-filters) in each dependency's `filters` / `relation`, using generic `field` leaves. Keep these separate from the formula's common filters and the definition's global filters; rank-list aggregation and saved-metric restrictions still apply.
|
|
34
35
|
|
|
35
36
|
```json
|
|
36
37
|
{
|
|
@@ -86,6 +86,8 @@ Place this object inside `retention`. `combine_operator` belongs to `initial_dat
|
|
|
86
86
|
|
|
87
87
|
Both roles support `formula` and `dependencies` with the same retention aggregation restrictions. Use bare aliases for new formulas. Preserve returned `formulation` and `custom_filters` when updating a saved formula; they carry the native dependency metadata and filters. Metric `filters` use event-only leaves and support recursive `items`/`relation` groups.
|
|
88
88
|
|
|
89
|
+
For conditions on just one formula operand, use that dependency's `filters` / `relation` as described in [formula operand filters](event.md#formula-operand-filters). Dependency leaves use the generic `field` shape, unlike the simultaneous metric's event-only filters. Do not replace operand conditions with shared metric filters; retain retention's aggregation and saved-metric restrictions.
|
|
90
|
+
|
|
89
91
|
`relation_event_property_name` supplies a shared relation property. `initial_relation_event_property_name` and `return_relation_event_property_name` override it for the two cohort events; both must resolve whenever either is configured. A `return_users` metric can override `relation_event_property_name` for its own event. All relation properties must have compatible types; relation overrides do not apply to `initial_date`.
|
|
90
92
|
|
|
91
93
|
## Grouping and summary settings
|
|
@@ -44,3 +44,5 @@ Both `revenue_metric` and `cost_metric` accept a formula with alias dependencies
|
|
|
44
44
|
```
|
|
45
45
|
|
|
46
46
|
Number formats are `float`, `float3`, `float4`, `integer`, and `percent`. Saved formulas may contain an expanded `formula`, `formulation`, and `custom_filters`; preserve that metadata on updates. Event and regular-metric filters support recursive `items`/`relation` groups using event-property leaves. `first_day_of_week` is between 1 (Monday) and 7 (Sunday).
|
|
47
|
+
|
|
48
|
+
Formula dependency `filters` / `relation` support [operand-specific conditions](event.md#formula-operand-filters) using the generic `field` shape. Put revenue/cost numerator and denominator conditions in their own dependencies, not in the formula metric's mutually exclusive `filters` / `relation`. Revenue aggregation and saved-metric restrictions still apply.
|
|
@@ -10,7 +10,15 @@ ceilings.
|
|
|
10
10
|
|
|
11
11
|
`--artifact-format` selects the logical row format, not compression. Read the returned `format`, `compression`, `file_name`, `content_type`, and `content_encoding`; analysis query exports are currently gzip-compressed even when the logical format is `jsonl` or `csv`.
|
|
12
12
|
|
|
13
|
-
|
|
13
|
+
Omit `--timeout-seconds` to use the server default (normally 21600 seconds / 6 hours). Common analysis-query and asset-governance exports use the deployment's async default, which may exceed 6 hours. The analysis-query typed flag still accepts explicit values only in `1..21600` (asset-governance typed flags retain `1..7200`); inspect the selected capability for the server default and maximum. If its schema allows a larger explicit value, use `capability run` with `timeout_seconds`. Other export families retain their own server policies; do not assume this deployment setting applies to every export.
|
|
14
|
+
|
|
15
|
+
Read `effective_timeout_seconds`, `timeout_source`, and `deadline_at` from the returned run descriptor for the actual deadline.
|
|
16
|
+
|
|
17
|
+
The member's natural-day quota counts each Gateway capability `execute` call eligible for usage statistics: the user is identifiable and statistics are enabled. Eligibility follows Gateway usage recording, regardless of business purpose or database engine (including MySQL and Trino). Report reads/saves, metadata reads, asset-governance exports, business data queries, cache hits, and failures that reach `execute` all count. This includes invalid input schemas, permission denials, unknown capability IDs, and accepted work that later fails or times out. A local CLI validation failure that never reaches Gateway `execute` does not count.
|
|
18
|
+
|
|
19
|
+
Each repeated `execute` call counts, even with identical input or when a handler reuses an existing run. Gateway provides no general `client_request_id` idempotency guarantee. Resume the existing run through its status/download endpoints instead of submitting it again. Gateway capability-discovery list/inspect endpoints, validate/dry-run endpoints, and independent run-status/artifact-download HTTP endpoints do not enter capability execution and do not count. This applies to `analysis run inspect`, `analysis run wait` polling, and `analysis artifact download`. Business `list`/`get` commands still count when they execute a capability; the operation's name does not change its route. Pagination, cancellation, or another operation invoked through capability execution does count; for example, both `analysis query cancel` and `capability run analysis.query.cancel` enter `execute`.
|
|
20
|
+
|
|
21
|
+
`QUERY_DAILY_LIMIT_EXCEEDED` (HTTP 429) requires waiting until reset or contacting an administrator. A call blocked at the daily limit does not increase the used quota, but remains eligible for failed-call usage auditing. `QUERY_QUOTA_UNAVAILABLE` means quota enforcement is unavailable and fails explicitly. Do not retry with another identity to bypass either error. Usage persistence is asynchronous and best effort: quota and usage recording share eligibility, but the quota counter need not equal the number of persisted usage rows.
|
|
14
22
|
|
|
15
23
|
Choose one lifecycle form:
|
|
16
24
|
|
|
@@ -36,6 +44,8 @@ or a persistent transient network failure stops only local waiting; it never
|
|
|
36
44
|
cancels the remote run. Resume with the returned `resume_command` or printed
|
|
37
45
|
`analysis run wait` command.
|
|
38
46
|
|
|
47
|
+
A server run can outlive one local wait window. Resume the same run instead of submitting it again.
|
|
48
|
+
|
|
39
49
|
Waiting succeeds only for `status=SUCCEEDED` plus
|
|
40
50
|
`artifact_status=COMPLETED`. Run or artifact `FAILED`/`CANCELED` is terminal and
|
|
41
51
|
returns a non-zero error. Unknown states, authorization failures, and 404s fail
|
|
@@ -12,7 +12,7 @@ ae-cli analysis-governance asset batch-info-export --project-id <project_id> --n
|
|
|
12
12
|
|
|
13
13
|
Capability id: governance.asset.batch_export_info.
|
|
14
14
|
|
|
15
|
-
Input sends `project_id` and `node_ids`. Optional `request_id`, `format` (only `xlsx`), and `timeout_seconds`
|
|
15
|
+
Input sends `project_id` and `node_ids`. Optional `request_id`, `format` (only `xlsx`), and `timeout_seconds` may be supplied through `--payload`; inspect the capability for the server default/range. The explicit `--timeout-seconds` flag retains its `1..7200` range. The CLI merges the snake_case object from `--payload` into these top-level Gateway fields; explicit flags override matching payload fields. `--project-id` owns the project identity and cannot be supplied or overridden by payload. Required business fields must exist in the final merged input.
|
|
16
16
|
|
|
17
17
|
Output `data` is an async XLSX descriptor with `run_id`, `artifact_id`, status, and expiry fields. Inspect and download the returned artifact IDs.
|
|
18
18
|
|
|
@@ -29,6 +29,6 @@ This capability starts an asynchronous artifact export. Use `--wait --output <pa
|
|
|
29
29
|
|
|
30
30
|
- `--artifact-format xlsx` selects the logical data format. Follow the returned descriptor for compression and content type.
|
|
31
31
|
- `--request-id cli_<32 lowercase hex>` assigns a stable request identifier.
|
|
32
|
-
- `--timeout-seconds` accepts 1
|
|
32
|
+
- Omit `--timeout-seconds` to use the server-provided default. This typed CLI accepts explicit values in `1..7200`; inspect this capability for the deployment default/max. Use `capability run` with a larger explicit `timeout_seconds` only when its schema permits it.
|
|
33
33
|
- `--wait-timeout-seconds` controls how long this CLI invocation waits; it does not change the server runtime limit.
|
|
34
34
|
- Explicit flags override corresponding `--payload` fields; omitted options preserve payload values.
|
|
@@ -14,7 +14,7 @@ ae-cli analysis-governance asset batch-sql-export --project-id <project_id> --no
|
|
|
14
14
|
|
|
15
15
|
Capability id: governance.asset.batch_export_sql.
|
|
16
16
|
|
|
17
|
-
Input sends `project_id` and `node_ids`. Optional `request_id`, `format` (only `xlsx`), and `timeout_seconds`
|
|
17
|
+
Input sends `project_id` and `node_ids`. Optional `request_id`, `format` (only `xlsx`), and `timeout_seconds` may be supplied through `--payload`; inspect the capability for the server default/range. The explicit `--timeout-seconds` flag retains its `1..7200` range. The CLI merges the snake_case object from `--payload` into these top-level Gateway fields; explicit flags override matching payload fields. `--project-id` owns the project identity and cannot be supplied or overridden by payload. Required business fields must exist in the final merged input.
|
|
18
18
|
|
|
19
19
|
Output `data` is an async XLSX descriptor with `run_id`, `artifact_id`, status, and expiry fields. Alternatively, wait and download with `ae-cli analysis run wait --run-id <run_id> --output <file>` using the returned run ID; see [`run_wait.md`](run_wait.md).
|
|
20
20
|
|
|
@@ -31,6 +31,6 @@ This capability starts an asynchronous artifact export. Use `--wait --output <pa
|
|
|
31
31
|
|
|
32
32
|
- `--artifact-format xlsx` selects the logical data format. Follow the returned descriptor for compression and content type.
|
|
33
33
|
- `--request-id cli_<32 lowercase hex>` assigns a stable request identifier.
|
|
34
|
-
- `--timeout-seconds` accepts 1
|
|
34
|
+
- Omit `--timeout-seconds` to use the server-provided default. This typed CLI accepts explicit values in `1..7200`; inspect this capability for the deployment default/max. Use `capability run` with a larger explicit `timeout_seconds` only when its schema permits it.
|
|
35
35
|
- `--wait-timeout-seconds` controls how long this CLI invocation waits; it does not change the server runtime limit.
|
|
36
36
|
- Explicit flags override corresponding `--payload` fields; omitted options preserve payload values.
|
|
@@ -35,6 +35,6 @@ This capability starts an asynchronous artifact export. Use `--wait --output <pa
|
|
|
35
35
|
|
|
36
36
|
- `--artifact-format jsonl` selects the logical data format. Follow the returned descriptor for compression and content type.
|
|
37
37
|
- `--request-id cli_<32 lowercase hex>` assigns a stable request identifier.
|
|
38
|
-
- `--timeout-seconds` accepts 1
|
|
38
|
+
- Omit `--timeout-seconds` to use the server-provided default. This typed CLI accepts explicit values in `1..7200`; inspect this capability for the deployment default/max. Use `capability run` with a larger explicit `timeout_seconds` only when its schema permits it.
|
|
39
39
|
- `--wait-timeout-seconds` controls how long this CLI invocation waits; it does not change the server runtime limit.
|
|
40
40
|
- Explicit flags override corresponding `--payload` fields; omitted options preserve payload values.
|
|
@@ -12,7 +12,7 @@ Command:
|
|
|
12
12
|
ae-cli analysis bi-panel-page-data export --project-id <project_id> --panel-id <panel_id> --page-key <page_key> --result-type charts [--chart-ids '["chart1"]'] [--artifact-format jsonl] --output <file>
|
|
13
13
|
```
|
|
14
14
|
|
|
15
|
-
Input sends `project_id`, `panel_id`, `page_key`, `result_type=charts`, and optional chart, control, column, cache, request, timeout, and format fields. Use CLI flag `--artifact-format` for the gateway `format` input; `--format` is the CLI output formatter. The export does not accept row/block paging fields: Common streams chart rows directly and applies only `model_full_download_limit`.
|
|
15
|
+
Input sends `project_id`, `panel_id`, `page_key`, `result_type=charts`, and optional chart, control, column, cache, request, timeout, and format fields. Use CLI flag `--artifact-format` for the gateway `format` input; `--format` is the CLI output formatter. The export does not accept row/block paging fields: Common streams chart rows directly and applies only `model_full_download_limit`. Omit `--timeout-seconds` to use the deployment's server default (normally 21600 seconds / 6 hours). The typed CLI accepts explicit `1..21600`; inspect this capability for the server default/max and use `capability run` for larger explicit values only when allowed. Read the run descriptor for the effective deadline; cancel earlier with `analysis query cancel --run-id <run_id>`. BI summary is rendered presentation data; query it with `bi-panel-page-data run`.
|
|
16
16
|
|
|
17
17
|
Output is the gateway envelope. `data` contains an async export descriptor with `run_id`, `artifact_id`, status fields, and expiration fields. It does not create `query_context_id`. The CLI handles waiting and download with `--output`.
|
|
18
18
|
|
|
@@ -23,5 +23,5 @@ Parameters:
|
|
|
23
23
|
| `--project-id` | Numeric project ID. | Yes |
|
|
24
24
|
| `--uuid` | Tracking check task UUID. | Yes |
|
|
25
25
|
| `--request-id` | Optional caller-supplied cli_<32 lowercase hex> lifecycle ID. ae-cli generates and prints one before dispatch when omitted. | No |
|
|
26
|
-
| `--timeout-seconds` | Async runtime in seconds.
|
|
26
|
+
| `--timeout-seconds` | Async runtime in seconds. Omit to use the server default (normally 21600 / 6 hours). Explicit CLI values remain in 1..21600. Inspect the capability for its server default/max; use capability run for larger values only when allowed. Cancel with analysis query cancel --run-id <run_id>. | No |
|
|
27
27
|
| `--output` | Wait and download to this local file. | No |
|