@lightdash/common 3.116.0 → 3.118.0
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/dist/cjs/.tsbuildinfo +1 -1
- package/dist/cjs/ee/AiAgent/composerSemanticArtifact.d.ts +4 -1
- package/dist/cjs/ee/AiAgent/composerSemanticArtifact.d.ts.map +1 -1
- package/dist/cjs/ee/AiAgent/composerSemanticArtifact.js +87 -5
- package/dist/cjs/ee/AiAgent/composerSemanticArtifact.js.map +1 -1
- package/dist/cjs/ee/AiAgent/schemas/tools/toolComposerQueryArgs.d.ts +117 -5
- package/dist/cjs/ee/AiAgent/schemas/tools/toolComposerQueryArgs.d.ts.map +1 -1
- package/dist/cjs/ee/AiAgent/schemas/tools/toolComposerQueryArgs.js +89 -13
- package/dist/cjs/ee/AiAgent/schemas/tools/toolComposerQueryArgs.js.map +1 -1
- package/dist/cjs/schemas/chartAsCodeSchema.d.ts +35 -35
- package/dist/cjs/schemas/json/mcp-tools-1.0.json +146 -6
- package/dist/esm/.tsbuildinfo +1 -1
- package/dist/esm/ee/AiAgent/composerSemanticArtifact.d.ts +4 -1
- package/dist/esm/ee/AiAgent/composerSemanticArtifact.d.ts.map +1 -1
- package/dist/esm/ee/AiAgent/composerSemanticArtifact.js +88 -6
- package/dist/esm/ee/AiAgent/composerSemanticArtifact.js.map +1 -1
- package/dist/esm/ee/AiAgent/schemas/tools/toolComposerQueryArgs.d.ts +117 -5
- package/dist/esm/ee/AiAgent/schemas/tools/toolComposerQueryArgs.d.ts.map +1 -1
- package/dist/esm/ee/AiAgent/schemas/tools/toolComposerQueryArgs.js +90 -14
- package/dist/esm/ee/AiAgent/schemas/tools/toolComposerQueryArgs.js.map +1 -1
- package/dist/esm/schemas/chartAsCodeSchema.d.ts +35 -35
- package/dist/esm/schemas/json/mcp-tools-1.0.json +146 -6
- package/dist/types/.tsbuildinfo +1 -1
- package/dist/types/ee/AiAgent/composerSemanticArtifact.d.ts +4 -1
- package/dist/types/ee/AiAgent/composerSemanticArtifact.d.ts.map +1 -1
- package/dist/types/ee/AiAgent/composerSemanticArtifact.js +88 -6
- package/dist/types/ee/AiAgent/composerSemanticArtifact.js.map +1 -1
- package/dist/types/ee/AiAgent/schemas/tools/toolComposerQueryArgs.d.ts +117 -5
- package/dist/types/ee/AiAgent/schemas/tools/toolComposerQueryArgs.d.ts.map +1 -1
- package/dist/types/ee/AiAgent/schemas/tools/toolComposerQueryArgs.js +90 -14
- package/dist/types/ee/AiAgent/schemas/tools/toolComposerQueryArgs.js.map +1 -1
- package/dist/types/schemas/chartAsCodeSchema.d.ts +35 -35
- package/dist/types/schemas/json/mcp-tools-1.0.json +146 -6
- package/package.json +1 -1
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import { type Explore } from '../../types/explore';
|
|
1
2
|
import { type SemanticLayerSourceQuery } from '../../types/querySources';
|
|
2
3
|
import type { AiCustomChartTypeChartArtifactConfig, AiSemanticChartArtifactConfig } from './index';
|
|
3
4
|
import { type ComposerStoredChartVizConfig } from './schemas';
|
|
@@ -13,12 +14,14 @@ export type AiComposerSemanticArtifactVersion = {
|
|
|
13
14
|
* keeps the classic interactions. Null when the classic payload cannot carry
|
|
14
15
|
* the node or its viz config.
|
|
15
16
|
*/
|
|
16
|
-
export declare const toComposerSemanticArtifactVersion: ({ title, description, node, vizConfig, maxQueryLimit, }: {
|
|
17
|
+
export declare const toComposerSemanticArtifactVersion: ({ title, description, node, vizConfig, maxQueryLimit, explore, }: {
|
|
17
18
|
title: string;
|
|
18
19
|
description: string | null;
|
|
19
20
|
node: SemanticLayerSourceQuery;
|
|
20
21
|
vizConfig: ComposerStoredChartVizConfig;
|
|
21
22
|
/** The classic artifact clamps its limit to this. */
|
|
22
23
|
maxQueryLimit: number;
|
|
24
|
+
/** Types custom metric filters; null when the explore is unavailable. */
|
|
25
|
+
explore: Explore | null;
|
|
23
26
|
}) => AiComposerSemanticArtifactVersion | null;
|
|
24
27
|
//# sourceMappingURL=composerSemanticArtifact.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"composerSemanticArtifact.d.ts","sourceRoot":"","sources":["../../../../src/ee/AiAgent/composerSemanticArtifact.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"composerSemanticArtifact.d.ts","sourceRoot":"","sources":["../../../../src/ee/AiAgent/composerSemanticArtifact.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAcnD,OAAO,EAAE,KAAK,wBAAwB,EAAE,MAAM,0BAA0B,CAAC;AAKzE,OAAO,KAAK,EACR,oCAAoC,EACpC,6BAA6B,EAChC,MAAM,SAAS,CAAC;AACjB,OAAO,EAGH,KAAK,4BAA4B,EAGpC,MAAM,WAAW,CAAC;AAEnB,wEAAwE;AACxE,MAAM,MAAM,iCAAiC,GAAG;IAC5C,YAAY,EAAE,OAAO,CAAC;IACtB,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,SAAS,EACH,6BAA6B,GAC7B,oCAAoC,CAAC;CAC9C,CAAC;AAkNF;;;;GAIG;AACH,eAAO,MAAM,iCAAiC,qEAO3C;IACC,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,IAAI,EAAE,wBAAwB,CAAC;IAC/B,SAAS,EAAE,4BAA4B,CAAC;IACxC,qDAAqD;IACrD,aAAa,EAAE,MAAM,CAAC;IACtB,yEAAyE;IACzE,OAAO,EAAE,OAAO,GAAG,IAAI,CAAC;CAC3B,KAAG,iCAAiC,GAAG,IAiEvC,CAAC"}
|
|
@@ -1,6 +1,10 @@
|
|
|
1
|
-
import { DimensionType } from '../../types/field';
|
|
1
|
+
import { DimensionType, MetricType } from '../../types/field';
|
|
2
2
|
import { FilterOperator, FilterType, isFilterRule, } from '../../types/filter';
|
|
3
|
+
import { isPeriodOverPeriodAdditionalMetric, } from '../../types/metricQuery';
|
|
3
4
|
import assertUnreachable from '../../utils/assertUnreachable';
|
|
5
|
+
import { getDimensions } from '../../utils/fields';
|
|
6
|
+
import { getFilterTypeFromItemType } from '../../utils/filters';
|
|
7
|
+
import { getItemId } from '../../utils/item';
|
|
4
8
|
import { toolRunQueryExpressionResolvedArgsSchema, } from './schemas';
|
|
5
9
|
// Persisted rules require a fieldType, which parsing validates and then drops.
|
|
6
10
|
const fieldTypeOf = (filterType) => {
|
|
@@ -108,9 +112,78 @@ const toRunQueryChartConfig = (vizConfig) => {
|
|
|
108
112
|
secondaryYAxisLabel: labels?.y2 ?? null,
|
|
109
113
|
};
|
|
110
114
|
};
|
|
115
|
+
const runQueryAggregations = [
|
|
116
|
+
MetricType.AVERAGE,
|
|
117
|
+
MetricType.COUNT,
|
|
118
|
+
MetricType.COUNT_DISTINCT,
|
|
119
|
+
MetricType.MAX,
|
|
120
|
+
MetricType.MIN,
|
|
121
|
+
MetricType.SUM,
|
|
122
|
+
MetricType.MEDIAN,
|
|
123
|
+
];
|
|
124
|
+
/** A metric filter as runQuery persists it; undefined when its field is unknown. */
|
|
125
|
+
const toRunQueryMetricFilter = (rule, explore) => {
|
|
126
|
+
const dimension = getDimensions(explore).find((field) => `${field.table}.${field.name}` === rule.target.fieldRef);
|
|
127
|
+
if (!dimension)
|
|
128
|
+
return undefined;
|
|
129
|
+
const fieldFilterType = getFilterTypeFromItemType(dimension.type);
|
|
130
|
+
const settings = rule.settings;
|
|
131
|
+
const hasValues = rule.operator !== FilterOperator.NULL &&
|
|
132
|
+
rule.operator !== FilterOperator.NOT_NULL;
|
|
133
|
+
return {
|
|
134
|
+
table: dimension.table,
|
|
135
|
+
filter: {
|
|
136
|
+
fieldId: getItemId(dimension),
|
|
137
|
+
fieldType: dimension.type,
|
|
138
|
+
fieldFilterType,
|
|
139
|
+
operator: rule.operator,
|
|
140
|
+
...(hasValues ? { values: rule.values ?? [] } : {}),
|
|
141
|
+
...(settings !== undefined ? { settings } : {}),
|
|
142
|
+
},
|
|
143
|
+
};
|
|
144
|
+
};
|
|
145
|
+
/** runQuery's custom metrics for a node's additional metrics; undefined when one cannot be carried. */
|
|
146
|
+
const toRunQueryCustomMetrics = (additionalMetrics, explore) => {
|
|
147
|
+
const customMetrics = additionalMetrics.map((metric) => {
|
|
148
|
+
if (isPeriodOverPeriodAdditionalMetric(metric)) {
|
|
149
|
+
// runQuery's comparison builder drops distinct keys and percentiles.
|
|
150
|
+
if (metric.distinctKeys?.length || metric.percentile !== undefined)
|
|
151
|
+
return undefined;
|
|
152
|
+
return {
|
|
153
|
+
kind: 'periodComparison',
|
|
154
|
+
baseMetricId: metric.baseMetricId,
|
|
155
|
+
timeDimensionId: metric.timeDimensionId,
|
|
156
|
+
granularity: metric.granularity,
|
|
157
|
+
periodOffset: metric.periodOffset,
|
|
158
|
+
};
|
|
159
|
+
}
|
|
160
|
+
if (!metric.baseDimensionName ||
|
|
161
|
+
!runQueryAggregations.includes(metric.type)) {
|
|
162
|
+
return undefined;
|
|
163
|
+
}
|
|
164
|
+
const filters = (metric.filters ?? []).map((rule) => explore ? toRunQueryMetricFilter(rule, explore) : undefined);
|
|
165
|
+
if (filters.some((filter) => filter === undefined))
|
|
166
|
+
return undefined;
|
|
167
|
+
return {
|
|
168
|
+
kind: 'aggregation',
|
|
169
|
+
name: metric.name,
|
|
170
|
+
label: metric.label ?? metric.name,
|
|
171
|
+
description: metric.description ?? '',
|
|
172
|
+
baseDimensionName: getItemId({
|
|
173
|
+
table: metric.table,
|
|
174
|
+
name: metric.baseDimensionName,
|
|
175
|
+
}),
|
|
176
|
+
table: metric.table,
|
|
177
|
+
type: metric.type,
|
|
178
|
+
filters: filters.length > 0 ? filters : null,
|
|
179
|
+
};
|
|
180
|
+
});
|
|
181
|
+
return customMetrics.every((metric) => metric !== undefined)
|
|
182
|
+
? customMetrics
|
|
183
|
+
: undefined;
|
|
184
|
+
};
|
|
111
185
|
// Fields the runQuery payload has no place for.
|
|
112
186
|
const hasClassicQueryShape = (node) => !node.tableCalculations?.length &&
|
|
113
|
-
!node.additionalMetrics?.length &&
|
|
114
187
|
!node.customDimensions?.length &&
|
|
115
188
|
!node.metricOverrides &&
|
|
116
189
|
!node.dimensionOverrides &&
|
|
@@ -121,27 +194,36 @@ const hasClassicQueryShape = (node) => !node.tableCalculations?.length &&
|
|
|
121
194
|
* keeps the classic interactions. Null when the classic payload cannot carry
|
|
122
195
|
* the node or its viz config.
|
|
123
196
|
*/
|
|
124
|
-
export const toComposerSemanticArtifactVersion = ({ title, description, node, vizConfig, maxQueryLimit, }) => {
|
|
197
|
+
export const toComposerSemanticArtifactVersion = ({ title, description, node, vizConfig, maxQueryLimit, explore, }) => {
|
|
125
198
|
if (!hasClassicQueryShape(node))
|
|
126
199
|
return null;
|
|
127
200
|
if (node.limit !== undefined && node.limit > maxQueryLimit)
|
|
128
201
|
return null;
|
|
129
202
|
const filters = toResolvedFilters(node.filters);
|
|
130
203
|
const chartConfig = toRunQueryChartConfig(vizConfig);
|
|
131
|
-
|
|
204
|
+
const additionalMetrics = node.additionalMetrics ?? [];
|
|
205
|
+
const customMetrics = toRunQueryCustomMetrics(additionalMetrics, explore);
|
|
206
|
+
if (filters === undefined ||
|
|
207
|
+
chartConfig === undefined ||
|
|
208
|
+
customMetrics === undefined) {
|
|
132
209
|
return null;
|
|
210
|
+
}
|
|
211
|
+
// runQuery derives period comparison columns from customMetrics itself.
|
|
212
|
+
const generatedMetricIds = new Set(additionalMetrics
|
|
213
|
+
.filter(isPeriodOverPeriodAdditionalMetric)
|
|
214
|
+
.map(getItemId));
|
|
133
215
|
const parsed = toolRunQueryExpressionResolvedArgsSchema.safeParse({
|
|
134
216
|
title,
|
|
135
217
|
description: description ?? '',
|
|
136
218
|
queryConfig: {
|
|
137
219
|
exploreName: node.exploreName,
|
|
138
220
|
dimensions: node.dimensions,
|
|
139
|
-
metrics: node.metrics,
|
|
221
|
+
metrics: node.metrics.filter((metricId) => !generatedMetricIds.has(metricId)),
|
|
140
222
|
filters,
|
|
141
223
|
sorts: node.sorts ?? [],
|
|
142
224
|
limit: node.limit ?? null,
|
|
143
225
|
parameters: node.parameters ?? null,
|
|
144
|
-
customMetrics: null,
|
|
226
|
+
customMetrics: customMetrics.length > 0 ? customMetrics : null,
|
|
145
227
|
tableCalculations: null,
|
|
146
228
|
},
|
|
147
229
|
chartConfig,
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"composerSemanticArtifact.js","sourceRoot":"","sources":["../../../../src/ee/AiAgent/composerSemanticArtifact.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"composerSemanticArtifact.js","sourceRoot":"","sources":["../../../../src/ee/AiAgent/composerSemanticArtifact.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAC9D,OAAO,EACH,cAAc,EACd,UAAU,EACV,YAAY,GAIf,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EACH,kCAAkC,GAErC,MAAM,yBAAyB,CAAC;AAEjC,OAAO,iBAAiB,MAAM,+BAA+B,CAAC;AAC9D,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACnD,OAAO,EAAE,yBAAyB,EAAE,MAAM,qBAAqB,CAAC;AAChE,OAAO,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAK7C,OAAO,EACH,wCAAwC,GAK3C,MAAM,WAAW,CAAC;AAYnB,+EAA+E;AAC/E,MAAM,WAAW,GAAG,CAAC,UAAsB,EAAiB,EAAE;IAC1D,QAAQ,UAAU,EAAE,CAAC;QACjB,KAAK,UAAU,CAAC,MAAM;YAClB,OAAO,aAAa,CAAC,MAAM,CAAC;QAChC,KAAK,UAAU,CAAC,MAAM;YAClB,OAAO,aAAa,CAAC,MAAM,CAAC;QAChC,KAAK,UAAU,CAAC,IAAI;YAChB,OAAO,aAAa,CAAC,IAAI,CAAC;QAC9B,KAAK,UAAU,CAAC,OAAO;YACnB,OAAO,aAAa,CAAC,OAAO,CAAC;QACjC;YACI,OAAO,iBAAiB,CAAC,UAAU,EAAE,qBAAqB,CAAC,CAAC;IACpE,CAAC;AACL,CAAC,CAAC;AAEF,MAAM,YAAY,GAAG,CAAC,KAAc,EAAuB,EAAE,CACzD,MAAM,CAAC,MAAM,CAAU,UAAU,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;AAEvD,0FAA0F;AAC1F,MAAM,qBAAqB,GAAG,CAAC,KAA8B,EAAE,EAAE;IAC7D,IAAI,CAAC,KAAK;QAAE,OAAO,IAAI,CAAC;IACxB,MAAM,CAAC,SAAS,EAAE,KAAK,CAAC,GACpB,KAAK,IAAI,KAAK,CAAC,CAAC,CAAE,CAAC,KAAK,EAAE,KAAK,CAAC,GAAG,CAAW,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,KAAK,CAAC,EAAE,CAAC,CAAC;IACtE,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,IAAI,CAAC;IACpC,MAAM,KAAK,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;QAC7B,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC;YAAE,OAAO,SAAS,CAAC;QAC1C,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;QAC1C,MAAM,QAAQ,GAAY,IAAI,CAAC,QAAQ,CAAC;QACxC,MAAM,UAAU,GACZ,iBAAiB,IAAI,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC,CAAC,SAAS,CAAC;QACrE,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC;YAAE,OAAO,SAAS,CAAC;QAChD,MAAM,SAAS,GACX,QAAQ,KAAK,cAAc,CAAC,IAAI;YAChC,QAAQ,KAAK,cAAc,CAAC,QAAQ,CAAC;QACzC,OAAO;YACH,OAAO,EAAE,MAAM,CAAC,OAAO;YACvB,SAAS,EAAE,WAAW,CAAC,UAAU,CAAC;YAClC,eAAe,EAAE,UAAU;YAC3B,QAAQ;YACR,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,MAAM,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YAC9C,GAAG,CAAC,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;SAClD,CAAC;IACN,CAAC,CAAC,CAAC;IACH,OAAO,KAAK,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,KAAK,SAAS,CAAC;QAC5C,CAAC,CAAC,EAAE,SAAS,EAAE,KAAK,EAAE;QACtB,CAAC,CAAC,SAAS,CAAC;AACpB,CAAC,CAAC;AAEF,MAAM,iBAAiB,GAAG,CAAC,OAA4B,EAAE,EAAE;IACvD,MAAM,UAAU,GAAG,qBAAqB,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;IAC9D,MAAM,OAAO,GAAG,qBAAqB,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IACxD,MAAM,iBAAiB,GAAG,qBAAqB,CAAC,OAAO,EAAE,iBAAiB,CAAC,CAAC;IAC5E,IACI,UAAU,KAAK,SAAS;QACxB,OAAO,KAAK,SAAS;QACrB,iBAAiB,KAAK,SAAS,EACjC,CAAC;QACC,OAAO,SAAS,CAAC;IACrB,CAAC;IACD,OAAO,UAAU,IAAI,OAAO,IAAI,iBAAiB;QAC7C,CAAC,CAAC,EAAE,UAAU,EAAE,OAAO,EAAE,iBAAiB,EAAE;QAC5C,CAAC,CAAC,IAAI,CAAC;AACf,CAAC,CAAC;AAEF,MAAM,iBAAiB,GAAG,CACtB,SAAwC,EACe,EAAE;IACzD,QAAQ,SAAS,CAAC,IAAI,EAAE,CAAC;QACrB,KAAK,KAAK;YACN,OAAO,SAAS,CAAC,UAAU,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,KAAK,CAAC;QACvD,KAAK,MAAM;YACP,OAAO,MAAM,CAAC;QAClB,+DAA+D;QAC/D,KAAK,MAAM;YACP,OAAO,SAAS,CAAC,EAAE,KAAK,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC;QACjD,KAAK,OAAO,CAAC;QACb,KAAK,SAAS,CAAC;QACf,KAAK,KAAK,CAAC;QACX,KAAK,QAAQ;YACT,OAAO,SAAS,CAAC,IAAI,CAAC;QAC1B,KAAK,YAAY;YACb,OAAO,IAAI,CAAC;QAChB;YACI,OAAO,iBAAiB,CAAC,SAAS,CAAC,IAAI,EAAE,kBAAkB,CAAC,CAAC;IACrE,CAAC;AACL,CAAC,CAAC;AAEF,MAAM,qBAAqB,GAAG,CAC1B,SAAuC,EACJ,EAAE;IACrC,IAAI,SAAS,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;QAC9B,OAAO;YACH,mBAAmB,EAAE,SAAS,CAAC,mBAAmB;YAClD,YAAY,EAAE,SAAS,CAAC,YAAY;YACpC,OAAO,EAAE,SAAS,CAAC,OAAO;SAC7B,CAAC;IACN,CAAC;IACD,MAAM,cAAc,GAAG,iBAAiB,CAAC,SAAS,CAAC,CAAC;IACpD,IAAI,cAAc,KAAK,IAAI;QAAE,OAAO,SAAS,CAAC;IAC9C,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC;IACnC,MAAM,WAAW,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;IACtE,OAAO;QACH,cAAc;QACd,cAAc,EAAE,SAAS,CAAC,CAAC;QAC3B,YAAY,EAAE,SAAS,CAAC,CAAC;QACzB,OAAO,EAAE,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI;QAC/C,SAAS,EAAE,IAAI;QACf,SAAS,EAAE,IAAI,KAAK,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI;QAClD,QAAQ,EAAE,IAAI,KAAK,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI;QACzC,UAAU,EAAE,MAAM,EAAE,CAAC,IAAI,EAAE;QAC3B,UAAU,EAAE,MAAM,EAAE,CAAC,IAAI,EAAE;QAC3B,oBAAoB,EAChB,WAAW,IAAI,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI;QAC3D,mBAAmB,EAAE,MAAM,EAAE,EAAE,IAAI,IAAI;KAC1C,CAAC;AACN,CAAC,CAAC;AAEF,MAAM,oBAAoB,GAAiB;IACvC,UAAU,CAAC,OAAO;IAClB,UAAU,CAAC,KAAK;IAChB,UAAU,CAAC,cAAc;IACzB,UAAU,CAAC,GAAG;IACd,UAAU,CAAC,GAAG;IACd,UAAU,CAAC,GAAG;IACd,UAAU,CAAC,MAAM;CACpB,CAAC;AAEF,oFAAoF;AACpF,MAAM,sBAAsB,GAAG,CAAC,IAAsB,EAAE,OAAgB,EAAE,EAAE;IACxE,MAAM,SAAS,GAAG,aAAa,CAAC,OAAO,CAAC,CAAC,IAAI,CACzC,CAAC,KAAK,EAAE,EAAE,CAAC,GAAG,KAAK,CAAC,KAAK,IAAI,KAAK,CAAC,IAAI,EAAE,KAAK,IAAI,CAAC,MAAM,CAAC,QAAQ,CACrE,CAAC;IACF,IAAI,CAAC,SAAS;QAAE,OAAO,SAAS,CAAC;IACjC,MAAM,eAAe,GAAG,yBAAyB,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IAClE,MAAM,QAAQ,GAAY,IAAI,CAAC,QAAQ,CAAC;IACxC,MAAM,SAAS,GACX,IAAI,CAAC,QAAQ,KAAK,cAAc,CAAC,IAAI;QACrC,IAAI,CAAC,QAAQ,KAAK,cAAc,CAAC,QAAQ,CAAC;IAC9C,OAAO;QACH,KAAK,EAAE,SAAS,CAAC,KAAK;QACtB,MAAM,EAAE;YACJ,OAAO,EAAE,SAAS,CAAC,SAAS,CAAC;YAC7B,SAAS,EAAE,SAAS,CAAC,IAAI;YACzB,eAAe;YACf,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YACnD,GAAG,CAAC,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;SAClD;KACJ,CAAC;AACN,CAAC,CAAC;AAEF,uGAAuG;AACvG,MAAM,uBAAuB,GAAG,CAC5B,iBAAqC,EACrC,OAAuB,EACzB,EAAE;IACA,MAAM,aAAa,GAAG,iBAAiB,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE;QACnD,IAAI,kCAAkC,CAAC,MAAM,CAAC,EAAE,CAAC;YAC7C,qEAAqE;YACrE,IAAI,MAAM,CAAC,YAAY,EAAE,MAAM,IAAI,MAAM,CAAC,UAAU,KAAK,SAAS;gBAC9D,OAAO,SAAS,CAAC;YACrB,OAAO;gBACH,IAAI,EAAE,kBAA2B;gBACjC,YAAY,EAAE,MAAM,CAAC,YAAY;gBACjC,eAAe,EAAE,MAAM,CAAC,eAAe;gBACvC,WAAW,EAAE,MAAM,CAAC,WAAW;gBAC/B,YAAY,EAAE,MAAM,CAAC,YAAY;aACpC,CAAC;QACN,CAAC;QACD,IACI,CAAC,MAAM,CAAC,iBAAiB;YACzB,CAAC,oBAAoB,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,EAC7C,CAAC;YACC,OAAO,SAAS,CAAC;QACrB,CAAC;QACD,MAAM,OAAO,GAAG,CAAC,MAAM,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAChD,OAAO,CAAC,CAAC,CAAC,sBAAsB,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS,CAC9D,CAAC;QACF,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,KAAK,SAAS,CAAC;YAAE,OAAO,SAAS,CAAC;QACrE,OAAO;YACH,IAAI,EAAE,aAAsB;YAC5B,IAAI,EAAE,MAAM,CAAC,IAAI;YACjB,KAAK,EAAE,MAAM,CAAC,KAAK,IAAI,MAAM,CAAC,IAAI;YAClC,WAAW,EAAE,MAAM,CAAC,WAAW,IAAI,EAAE;YACrC,iBAAiB,EAAE,SAAS,CAAC;gBACzB,KAAK,EAAE,MAAM,CAAC,KAAK;gBACnB,IAAI,EAAE,MAAM,CAAC,iBAAiB;aACjC,CAAC;YACF,KAAK,EAAE,MAAM,CAAC,KAAK;YACnB,IAAI,EAAE,MAAM,CAAC,IAAI;YACjB,OAAO,EAAE,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI;SAC/C,CAAC;IACN,CAAC,CAAC,CAAC;IACH,OAAO,aAAa,CAAC,KAAK,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,KAAK,SAAS,CAAC;QACxD,CAAC,CAAC,aAAa;QACf,CAAC,CAAC,SAAS,CAAC;AACpB,CAAC,CAAC;AAEF,gDAAgD;AAChD,MAAM,oBAAoB,GAAG,CAAC,IAA8B,EAAW,EAAE,CACrE,CAAC,IAAI,CAAC,iBAAiB,EAAE,MAAM;IAC/B,CAAC,IAAI,CAAC,gBAAgB,EAAE,MAAM;IAC9B,CAAC,IAAI,CAAC,eAAe;IACrB,CAAC,IAAI,CAAC,kBAAkB;IACxB,CAAC,IAAI,CAAC,QAAQ;IACd,CAAC,IAAI,CAAC,kBAAkB,CAAC;AAE7B;;;;GAIG;AACH,MAAM,CAAC,MAAM,iCAAiC,GAAG,CAAC,EAC9C,KAAK,EACL,WAAW,EACX,IAAI,EACJ,SAAS,EACT,aAAa,EACb,OAAO,GAUV,EAA4C,EAAE;IAC3C,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC;QAAE,OAAO,IAAI,CAAC;IAC7C,IAAI,IAAI,CAAC,KAAK,KAAK,SAAS,IAAI,IAAI,CAAC,KAAK,GAAG,aAAa;QAAE,OAAO,IAAI,CAAC;IACxE,MAAM,OAAO,GAAG,iBAAiB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAChD,MAAM,WAAW,GAAG,qBAAqB,CAAC,SAAS,CAAC,CAAC;IACrD,MAAM,iBAAiB,GAAG,IAAI,CAAC,iBAAiB,IAAI,EAAE,CAAC;IACvD,MAAM,aAAa,GAAG,uBAAuB,CAAC,iBAAiB,EAAE,OAAO,CAAC,CAAC;IAC1E,IACI,OAAO,KAAK,SAAS;QACrB,WAAW,KAAK,SAAS;QACzB,aAAa,KAAK,SAAS,EAC7B,CAAC;QACC,OAAO,IAAI,CAAC;IAChB,CAAC;IACD,wEAAwE;IACxE,MAAM,kBAAkB,GAAG,IAAI,GAAG,CAC9B,iBAAiB;SACZ,MAAM,CAAC,kCAAkC,CAAC;SAC1C,GAAG,CAAC,SAAS,CAAC,CACtB,CAAC;IAEF,MAAM,MAAM,GAAG,wCAAwC,CAAC,SAAS,CAAC;QAC9D,KAAK;QACL,WAAW,EAAE,WAAW,IAAI,EAAE;QAC9B,WAAW,EAAE;YACT,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,UAAU,EAAE,IAAI,CAAC,UAAU;YAC3B,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,MAAM,CACxB,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,kBAAkB,CAAC,GAAG,CAAC,QAAQ,CAAC,CAClD;YACD,OAAO;YACP,KAAK,EAAE,IAAI,CAAC,KAAK,IAAI,EAAE;YACvB,KAAK,EAAE,IAAI,CAAC,KAAK,IAAI,IAAI;YACzB,UAAU,EAAE,IAAI,CAAC,UAAU,IAAI,IAAI;YACnC,aAAa,EAAE,aAAa,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI;YAC9D,iBAAiB,EAAE,IAAI;SAC1B;QACD,WAAW;QACX,WAAW,EAAE,IAAI;KACpB,CAAC,CAAC;IACH,IAAI,CAAC,MAAM,CAAC,OAAO;QAAE,OAAO,IAAI,CAAC;IAEjC,MAAM,OAAO,GAAG;QACZ,YAAY,EAAE,OAAgB;QAC9B,KAAK;QACL,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;KAC1C,CAAC;IACF,IAAI,SAAS,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;QAC9B,OAAO;YACH,GAAG,OAAO;YACV,SAAS,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,CAAC,IAAI,EAAE;SACzD,CAAC;IACN,CAAC;IACD,OAAO;QACH,GAAG,OAAO;QACV,SAAS,EAAE;YACP,MAAM,EAAE,iBAAiB;YACzB,aAAa,EAAE,CAAC;YAChB,cAAc,EAAE,SAAS,CAAC,cAAc;YACxC,GAAG,CAAC,SAAS,CAAC,iBAAiB,KAAK,IAAI;gBACpC,CAAC,CAAC,EAAE,iBAAiB,EAAE,SAAS,CAAC,iBAAiB,EAAE;gBACpD,CAAC,CAAC,EAAE,CAAC;YACT,MAAM,EAAE,MAAM,CAAC,IAAI;SACtB;KACJ,CAAC;AACN,CAAC,CAAC"}
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import { z } from 'zod';
|
|
2
|
-
import { DimensionType } from '../../../../types/field';
|
|
2
|
+
import { DimensionType, MetricType } from '../../../../types/field';
|
|
3
3
|
import { type Filters } from '../../../../types/filter';
|
|
4
|
+
import { type AdditionalMetric } from '../../../../types/metricQuery';
|
|
4
5
|
import { QuerySourceType, type ApiConnectorType, type ApiSourceQuery, type DuckdbSourceQuery, type ExternalSourceQuery, type PythonSourceQuery, type QueryNodeId, type SemanticLayerSourceQuery, type SqlSourceQuery } from '../../../../types/querySources';
|
|
5
6
|
/** The composer query tool's name, and the name calls persisted before the rename carry. */
|
|
6
7
|
export declare const COMPOSER_QUERY_TOOL_NAMES: readonly ['query', 'runComposerQueries'];
|
|
@@ -9,6 +10,7 @@ export declare const isComposerQueryToolName: (toolName: string) => toolName is
|
|
|
9
10
|
export declare const DEFAULT_COMPOSER_QUERY_LIMIT = 500;
|
|
10
11
|
export declare const DEFAULT_COMPOSER_QUERY_MAX_LIMIT = 5000;
|
|
11
12
|
export declare const COMPOSER_QUERY_PREVIEW_ROW_LIMIT = 50;
|
|
13
|
+
export declare const COMPOSER_NODE_SAMPLE_ROW_LIMIT = 5;
|
|
12
14
|
/** A project connection an api node can query. */
|
|
13
15
|
export type ComposerApiConnection = {
|
|
14
16
|
connectionUuid: string;
|
|
@@ -26,6 +28,32 @@ export declare const composerSemanticLayerFiltersSchema: z.ZodNullable<z.ZodObje
|
|
|
26
28
|
dimensions: z.ZodNullable<z.ZodString>;
|
|
27
29
|
metrics: z.ZodNullable<z.ZodString>;
|
|
28
30
|
}, z.core.$strict>>;
|
|
31
|
+
declare const composerCustomMetricSchema: z.ZodObject<{
|
|
32
|
+
table: z.ZodString;
|
|
33
|
+
name: z.ZodString;
|
|
34
|
+
label: z.ZodString;
|
|
35
|
+
description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
36
|
+
aggregation: z.ZodEnum<{
|
|
37
|
+
average: MetricType.AVERAGE;
|
|
38
|
+
count: MetricType.COUNT;
|
|
39
|
+
count_distinct: MetricType.COUNT_DISTINCT;
|
|
40
|
+
max: MetricType.MAX;
|
|
41
|
+
median: MetricType.MEDIAN;
|
|
42
|
+
min: MetricType.MIN;
|
|
43
|
+
percentile: MetricType.PERCENTILE;
|
|
44
|
+
sum: MetricType.SUM;
|
|
45
|
+
}>;
|
|
46
|
+
dimensionFieldId: z.ZodString;
|
|
47
|
+
percentile: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
48
|
+
filter: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
49
|
+
}, z.core.$strip>;
|
|
50
|
+
declare const composerPeriodComparisonSchema: z.ZodObject<{
|
|
51
|
+
metricFieldId: z.ZodString;
|
|
52
|
+
timeDimensionFieldId: z.ZodString;
|
|
53
|
+
periodOffset: z.ZodCoercedNumber<unknown>;
|
|
54
|
+
}, z.core.$strip>;
|
|
55
|
+
export type ToolComposerCustomMetric = z.infer<typeof composerCustomMetricSchema>;
|
|
56
|
+
export type ToolComposerPeriodComparison = z.infer<typeof composerPeriodComparisonSchema>;
|
|
29
57
|
type CreateToolComposerQueriesArgsSchemaOptions = {
|
|
30
58
|
maxLimit?: number;
|
|
31
59
|
defaultLimit?: number;
|
|
@@ -55,7 +83,31 @@ export declare const createToolComposerQueriesArgsSchemaV1: ({ maxLimit, default
|
|
|
55
83
|
fieldId: z.ZodString;
|
|
56
84
|
descending: z.ZodBoolean;
|
|
57
85
|
}, z.core.$strip>>>;
|
|
58
|
-
|
|
86
|
+
customMetrics: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodObject<{
|
|
87
|
+
table: z.ZodString;
|
|
88
|
+
name: z.ZodString;
|
|
89
|
+
label: z.ZodString;
|
|
90
|
+
description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
91
|
+
aggregation: z.ZodEnum<{
|
|
92
|
+
average: MetricType.AVERAGE;
|
|
93
|
+
count: MetricType.COUNT;
|
|
94
|
+
count_distinct: MetricType.COUNT_DISTINCT;
|
|
95
|
+
max: MetricType.MAX;
|
|
96
|
+
median: MetricType.MEDIAN;
|
|
97
|
+
min: MetricType.MIN;
|
|
98
|
+
percentile: MetricType.PERCENTILE;
|
|
99
|
+
sum: MetricType.SUM;
|
|
100
|
+
}>;
|
|
101
|
+
dimensionFieldId: z.ZodString;
|
|
102
|
+
percentile: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
103
|
+
filter: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
104
|
+
}, z.core.$strip>>>>;
|
|
105
|
+
periodComparisons: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodObject<{
|
|
106
|
+
metricFieldId: z.ZodString;
|
|
107
|
+
timeDimensionFieldId: z.ZodString;
|
|
108
|
+
periodOffset: z.ZodCoercedNumber<unknown>;
|
|
109
|
+
}, z.core.$strip>>>>;
|
|
110
|
+
parameters: z.ZodOptional<z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodArray<z.ZodString>, z.ZodArray<z.ZodNumber>]>>>>;
|
|
59
111
|
limit: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
|
|
60
112
|
}, z.core.$strip>, z.ZodObject<{
|
|
61
113
|
title: z.ZodString;
|
|
@@ -122,7 +174,31 @@ export declare const toolComposerQueriesArgsSchema: z.ZodObject<{
|
|
|
122
174
|
fieldId: z.ZodString;
|
|
123
175
|
descending: z.ZodBoolean;
|
|
124
176
|
}, z.core.$strip>>>;
|
|
125
|
-
|
|
177
|
+
customMetrics: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodObject<{
|
|
178
|
+
table: z.ZodString;
|
|
179
|
+
name: z.ZodString;
|
|
180
|
+
label: z.ZodString;
|
|
181
|
+
description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
182
|
+
aggregation: z.ZodEnum<{
|
|
183
|
+
average: MetricType.AVERAGE;
|
|
184
|
+
count: MetricType.COUNT;
|
|
185
|
+
count_distinct: MetricType.COUNT_DISTINCT;
|
|
186
|
+
max: MetricType.MAX;
|
|
187
|
+
median: MetricType.MEDIAN;
|
|
188
|
+
min: MetricType.MIN;
|
|
189
|
+
percentile: MetricType.PERCENTILE;
|
|
190
|
+
sum: MetricType.SUM;
|
|
191
|
+
}>;
|
|
192
|
+
dimensionFieldId: z.ZodString;
|
|
193
|
+
percentile: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
194
|
+
filter: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
195
|
+
}, z.core.$strip>>>>;
|
|
196
|
+
periodComparisons: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodObject<{
|
|
197
|
+
metricFieldId: z.ZodString;
|
|
198
|
+
timeDimensionFieldId: z.ZodString;
|
|
199
|
+
periodOffset: z.ZodCoercedNumber<unknown>;
|
|
200
|
+
}, z.core.$strip>>>>;
|
|
201
|
+
parameters: z.ZodOptional<z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodArray<z.ZodString>, z.ZodArray<z.ZodNumber>]>>>>;
|
|
126
202
|
limit: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
|
|
127
203
|
}, z.core.$strip>, z.ZodObject<{
|
|
128
204
|
title: z.ZodString;
|
|
@@ -188,7 +264,31 @@ export declare const toolComposerQueriesArgsSchemaPersisted: z.ZodPreprocess<z.Z
|
|
|
188
264
|
fieldId: z.ZodString;
|
|
189
265
|
descending: z.ZodBoolean;
|
|
190
266
|
}, z.core.$strip>>>;
|
|
191
|
-
|
|
267
|
+
customMetrics: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodObject<{
|
|
268
|
+
table: z.ZodString;
|
|
269
|
+
name: z.ZodString;
|
|
270
|
+
label: z.ZodString;
|
|
271
|
+
description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
272
|
+
aggregation: z.ZodEnum<{
|
|
273
|
+
average: MetricType.AVERAGE;
|
|
274
|
+
count: MetricType.COUNT;
|
|
275
|
+
count_distinct: MetricType.COUNT_DISTINCT;
|
|
276
|
+
max: MetricType.MAX;
|
|
277
|
+
median: MetricType.MEDIAN;
|
|
278
|
+
min: MetricType.MIN;
|
|
279
|
+
percentile: MetricType.PERCENTILE;
|
|
280
|
+
sum: MetricType.SUM;
|
|
281
|
+
}>;
|
|
282
|
+
dimensionFieldId: z.ZodString;
|
|
283
|
+
percentile: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
284
|
+
filter: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
285
|
+
}, z.core.$strip>>>>;
|
|
286
|
+
periodComparisons: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodObject<{
|
|
287
|
+
metricFieldId: z.ZodString;
|
|
288
|
+
timeDimensionFieldId: z.ZodString;
|
|
289
|
+
periodOffset: z.ZodCoercedNumber<unknown>;
|
|
290
|
+
}, z.core.$strip>>>>;
|
|
291
|
+
parameters: z.ZodOptional<z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodArray<z.ZodString>, z.ZodArray<z.ZodNumber>]>>>>;
|
|
192
292
|
limit: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
|
|
193
293
|
}, z.core.$strip>, z.ZodObject<{
|
|
194
294
|
title: z.ZodString;
|
|
@@ -239,8 +339,9 @@ export type ToolComposerQueryNode = z.infer<ReturnType<typeof createToolComposer
|
|
|
239
339
|
export type ToolComposerSemanticLayerNode = Extract<ToolComposerQueryNode, {
|
|
240
340
|
sourceType: QuerySourceType.SEMANTIC_LAYER;
|
|
241
341
|
}>;
|
|
242
|
-
export type ResolvedToolComposerQueryNode = Exclude<ToolComposerQueryNode, ToolComposerSemanticLayerNode> | (Omit<ToolComposerSemanticLayerNode, 'filters'> & {
|
|
342
|
+
export type ResolvedToolComposerQueryNode = Exclude<ToolComposerQueryNode, ToolComposerSemanticLayerNode> | (Omit<ToolComposerSemanticLayerNode, 'filters' | 'customMetrics' | 'periodComparisons'> & {
|
|
243
343
|
filters: Filters | null;
|
|
344
|
+
additionalMetrics: AdditionalMetric[];
|
|
244
345
|
});
|
|
245
346
|
/**
|
|
246
347
|
* Converts a validated tool node into the canonical SourceQuery shape the
|
|
@@ -270,6 +371,11 @@ export declare const toolComposerQueriesStructuredContentSchema: z.ZodObject<{
|
|
|
270
371
|
sourceType: z.ZodEnum<typeof QuerySourceType>;
|
|
271
372
|
rowCount: z.ZodNullable<z.ZodNumber>;
|
|
272
373
|
limit: z.ZodNumber;
|
|
374
|
+
columns: z.ZodNullable<z.ZodArray<z.ZodObject<{
|
|
375
|
+
reference: z.ZodString;
|
|
376
|
+
type: z.ZodEnum<typeof DimensionType>;
|
|
377
|
+
}, z.core.$strip>>>;
|
|
378
|
+
sample: z.ZodNullable<z.ZodArray<z.ZodRecord<z.ZodString, z.ZodUnknown>>>;
|
|
273
379
|
}, z.core.$strip>>;
|
|
274
380
|
columns: z.ZodArray<z.ZodObject<{
|
|
275
381
|
reference: z.ZodString;
|
|
@@ -312,6 +418,7 @@ export declare const mcpQueryStructuredOutputSchema: z.ZodObject<{
|
|
|
312
418
|
reference: z.ZodString;
|
|
313
419
|
type: z.ZodEnum<typeof DimensionType>;
|
|
314
420
|
}, z.core.$strip>>>;
|
|
421
|
+
sample: z.ZodNullable<z.ZodArray<z.ZodRecord<z.ZodString, z.ZodUnknown>>>;
|
|
315
422
|
}, z.core.$strip>>;
|
|
316
423
|
}, z.core.$strip>;
|
|
317
424
|
export type McpQueryStructuredContent = z.infer<typeof mcpQueryStructuredOutputSchema>;
|
|
@@ -352,6 +459,11 @@ export declare const toolComposerQueriesOutputSchema: z.ZodUnion<readonly [z.Zod
|
|
|
352
459
|
sourceType: z.ZodEnum<typeof QuerySourceType>;
|
|
353
460
|
rowCount: z.ZodNullable<z.ZodNumber>;
|
|
354
461
|
limit: z.ZodNumber;
|
|
462
|
+
columns: z.ZodNullable<z.ZodArray<z.ZodObject<{
|
|
463
|
+
reference: z.ZodString;
|
|
464
|
+
type: z.ZodEnum<typeof DimensionType>;
|
|
465
|
+
}, z.core.$strip>>>;
|
|
466
|
+
sample: z.ZodNullable<z.ZodArray<z.ZodRecord<z.ZodString, z.ZodUnknown>>>;
|
|
355
467
|
}, z.core.$strip>>;
|
|
356
468
|
columns: z.ZodArray<z.ZodObject<{
|
|
357
469
|
reference: z.ZodString;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"toolComposerQueryArgs.d.ts","sourceRoot":"","sources":["../../../../../../src/ee/AiAgent/schemas/tools/toolComposerQueryArgs.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;
|
|
1
|
+
{"version":3,"file":"toolComposerQueryArgs.d.ts","sourceRoot":"","sources":["../../../../../../src/ee/AiAgent/schemas/tools/toolComposerQueryArgs.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,aAAa,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AACpE,OAAO,EAAE,KAAK,OAAO,EAAE,MAAM,0BAA0B,CAAC;AACxD,OAAO,EACH,KAAK,gBAAgB,EAGxB,MAAM,+BAA+B,CAAC;AAEvC,OAAO,EACH,eAAe,EACf,KAAK,gBAAgB,EACrB,KAAK,cAAc,EACnB,KAAK,iBAAiB,EACtB,KAAK,mBAAmB,EACxB,KAAK,iBAAiB,EACtB,KAAK,WAAW,EAChB,KAAK,wBAAwB,EAC7B,KAAK,cAAc,EACtB,MAAM,gCAAgC,CAAC;AAaxC,4FAA4F;AAC5F,eAAO,MAAM,yBAAyB,YAClC,OAAO,EACP,oBAAoB,CACd,CAAC;AAEX,MAAM,MAAM,qBAAqB,GAAG,CAAC,OAAO,yBAAyB,CAAC,CAAC,MAAM,CAAC,CAAC;AAE/E,eAAO,MAAM,uBAAuB,aACtB,MAAM,KACjB,QAAQ,IAAI,qBACwD,CAAC;AAExE,eAAO,MAAM,4BAA4B,MAAM,CAAC;AAChD,eAAO,MAAM,gCAAgC,OAAO,CAAC;AACrD,eAAO,MAAM,gCAAgC,KAAK,CAAC;AACnD,eAAO,MAAM,8BAA8B,IAAI,CAAC;AAEhD,kDAAkD;AAClD,MAAM,MAAM,qBAAqB,GAAG;IAChC,cAAc,EAAE,MAAM,CAAC;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,gBAAgB,CAAC;CAC/B,CAAC;AAEF,KAAK,iCAAiC,GAAG;IACrC,iBAAiB,EAAE,OAAO,CAAC;IAC3B,cAAc,EAAE,qBAAqB,EAAE,CAAC;CAC3C,CAAC;AA6BF,eAAO,MAAM,iCAAiC,2CAG3C,iCAAiC,WAUsU,CAAC;AAE3W,eAAO,MAAM,0BAA0B,QAcqS,CAAC;AAE7U,eAAO,MAAM,iCAAiC,QAIxC,CAAC;AA2BP,eAAO,MAAM,kCAAkC;;;mBAM1C,CAAC;AAEN,QAAA,MAAM,0BAA0B;;;;;;;;;;;;;;;;;;iBAkD9B,CAAC;AAEH,QAAA,MAAM,8BAA8B;;;;iBAkBlC,CAAC;AAEH,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,KAAK,CAC1C,OAAO,0BAA0B,CACpC,CAAC;AACF,MAAM,MAAM,4BAA4B,GAAG,CAAC,CAAC,KAAK,CAC9C,OAAO,8BAA8B,CACxC,CAAC;AAqBF,KAAK,0CAA0C,GAAG;IAC9C,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,gFAAgF;IAChF,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,oFAAoF;IACpF,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,iFAAiF;IACjF,cAAc,CAAC,EAAE,OAAO,CAAC;CAC5B,CAAC;AAEF,eAAO,MAAM,qCAAqC,+EAM/C,0CAA0C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAmL5C,CAAC;AAGF,eAAO,MAAM,mCAAmC,8CACP,CAAC;AAE1C,eAAO,MAAM,6BAA6B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBACD,CAAC;AA4B1C,eAAO,MAAM,sCAAsC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;2BAQlD,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CACvC,UAAU,CAAC,OAAO,mCAAmC,CAAC,CACzD,CAAC,SAAS,CAAC,CAAC,MAAM,CAAC,CAAC;AAErB,MAAM,MAAM,6BAA6B,GAAG,OAAO,CAC/C,qBAAqB,EACrB;IAAE,UAAU,EAAE,eAAe,CAAC,cAAc,CAAA;CAAE,CACjD,CAAC;AAIF,MAAM,MAAM,6BAA6B,GACnC,OAAO,CAAC,qBAAqB,EAAE,6BAA6B,CAAC,GAC7D,CAAC,IAAI,CACD,6BAA6B,EAC7B,SAAS,GAAG,eAAe,GAAG,mBAAmB,CACpD,GAAG;IACA,OAAO,EAAE,OAAO,GAAG,IAAI,CAAC;IACxB,iBAAiB,EAAE,gBAAgB,EAAE,CAAC;CACzC,CAAC,CAAC;AAST;;;;GAIG;AACH,0EAA0E;AAC1E,MAAM,MAAM,oBAAoB,GAAG,CAC7B,wBAAwB,GACxB,cAAc,GACd,iBAAiB,GACjB,mBAAmB,GACnB,iBAAiB,GACjB,cAAc,CACnB,GAAG;IAAE,MAAM,EAAE,WAAW,CAAA;CAAE,CAAC;AAE5B,eAAO,MAAM,kCAAkC,SACrC,6BAA6B,KACpC,oBAyEF,CAAC;AAsBF;;;;;;;GAOG;AACH,eAAO,MAAM,mCAAmC,UACrC,OAAO,KACf,uBAAuB,GAAG,IAiH5B,CAAC;AAsCF,eAAO,MAAM,0CAA0C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAsCrD,CAAC;AAEH,eAAO,MAAM,8BAA8B;;;;;;;;;;;;;;;;;;;;;;;;;;;iBA8CzC,CAAC;AAEH,MAAM,MAAM,yBAAyB,GAAG,CAAC,CAAC,KAAK,CAC3C,OAAO,8BAA8B,CACxC,CAAC;AAEF,QAAA,MAAM,wCAAwC;;;;;;iBAM5C,CAAC;AAEH,MAAM,MAAM,kCAAkC,GAAG,CAAC,CAAC,KAAK,CACpD,OAAO,wCAAwC,CAClD,CAAC;AAEF,eAAO,MAAM,uCAAuC,aACtC,OAAO,KAClB,kCAAkC,GAAG,IAGvC,CAAC;AAEF,eAAO,MAAM,+BAA+B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;mBAS1C,CAAC;AAEH,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CACzC,UAAU,CAAC,OAAO,mCAAmC,CAAC,CACzD,CAAC;AACF,MAAM,MAAM,yBAAyB,GAAG,CAAC,CAAC,KAAK,CAC3C,OAAO,+BAA+B,CACzC,CAAC;AACF,MAAM,MAAM,oCAAoC,GAAG,CAAC,CAAC,KAAK,CACtD,OAAO,0CAA0C,CACpD,CAAC"}
|
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
import { z } from 'zod';
|
|
2
|
-
import { DimensionType } from '../../../../types/field';
|
|
2
|
+
import { DimensionType, MetricType } from '../../../../types/field';
|
|
3
3
|
import { QuerySourceType, } from '../../../../types/querySources';
|
|
4
4
|
import assertUnreachable from '../../../../utils/assertUnreachable';
|
|
5
|
-
import { filterExpressionsSchema } from '../filterExpressions/expressionSchemas';
|
|
5
|
+
import { filterExpressionInputSchema, filterExpressionsSchema, } from '../filterExpressions/expressionSchemas';
|
|
6
6
|
import { structuredToolOutputSchema } from '../outputMetadata';
|
|
7
7
|
import { createToolSchema } from '../toolSchemaBuilder';
|
|
8
8
|
import { appliedParametersSchema, parameterValueSchema, } from './toolRunQueryArgs';
|
|
@@ -15,6 +15,7 @@ export const isComposerQueryToolName = (toolName) => COMPOSER_QUERY_TOOL_NAMES.i
|
|
|
15
15
|
export const DEFAULT_COMPOSER_QUERY_LIMIT = 500;
|
|
16
16
|
export const DEFAULT_COMPOSER_QUERY_MAX_LIMIT = 5000;
|
|
17
17
|
export const COMPOSER_QUERY_PREVIEW_ROW_LIMIT = 50;
|
|
18
|
+
export const COMPOSER_NODE_SAMPLE_ROW_LIMIT = 5;
|
|
18
19
|
const getComposerNodeKindsDescription = ({ enablePythonNodes, apiConnections, sqlNote, }) => `Node kinds:
|
|
19
20
|
- "semanticLayer": a metric query against an explore. Result columns are the requested field ids.
|
|
20
21
|
- "sql": raw SQL against the project warehouse; ${sqlNote}.
|
|
@@ -30,7 +31,7 @@ const getComposerNodeKindsDescription = ({ enablePythonNodes, apiConnections, sq
|
|
|
30
31
|
: ''}
|
|
31
32
|
|
|
32
33
|
A node reads only the rows its references returned, so a referenced result that reached its limit is incomplete: before totalling, averaging or ranking over it, give that node a limit that holds its whole population, or aggregate there.`;
|
|
33
|
-
export const getToolComposerQueriesDescription = ({ enablePythonNodes, apiConnections, }) => `Run a pipeline: one or more nodes submitted together, where ${enablePythonNodes ? 'duckdb and python' : 'duckdb'} nodes join or transform other nodes' results.
|
|
34
|
+
export const getToolComposerQueriesDescription = ({ enablePythonNodes, apiConnections, }) => `Run a pipeline: one or more nodes submitted together, where ${enablePythonNodes ? 'duckdb and python' : 'duckdb'} nodes join or transform other nodes' results. One call returns one node's rows, the terminal node's, so exactly one submitted node may go unread by the others: to get several results, combine them in one duckdb node (UNION ALL or JOIN) or submit them in separate calls. Every other submitted node is listed with its columns and first rows.
|
|
34
35
|
|
|
35
36
|
${getComposerNodeKindsDescription({
|
|
36
37
|
enablePythonNodes,
|
|
@@ -39,7 +40,9 @@ ${getComposerNodeKindsDescription({
|
|
|
39
40
|
})}
|
|
40
41
|
|
|
41
42
|
Reuse across calls: a node id names one node for the whole thread. To build on a node from an earlier call, read its node id in "references" without resubmitting it; it is copied into this pipeline with everything it reads and served from cache when possible. Resubmitting a node id with a different definition is an error, so give a changed node a new node id.`;
|
|
42
|
-
export const MCP_TOOL_QUERY_DESCRIPTION = `Run a pipeline: one or more nodes submitted together, where duckdb and python nodes join or transform other nodes' results. A pipeline of one node runs a single semantic-layer or SQL query
|
|
43
|
+
export const MCP_TOOL_QUERY_DESCRIPTION = `Run a pipeline: one or more nodes submitted together, where duckdb and python nodes join or transform other nodes' results. A pipeline of one node runs a single semantic-layer or SQL query.
|
|
44
|
+
|
|
45
|
+
One call returns one node's rows, so exactly one submitted node may go unread by the others: combine several results in one duckdb node (UNION ALL or JOIN), or submit them in separate calls reusing earlier nodes.
|
|
43
46
|
|
|
44
47
|
${getComposerNodeKindsDescription({
|
|
45
48
|
enablePythonNodes: true,
|
|
@@ -49,9 +52,9 @@ ${getComposerNodeKindsDescription({
|
|
|
49
52
|
|
|
50
53
|
A python node's "code" defines \`def run(inputs, params)\`, and semanticLayer "filters" are flat expression strings; each field documents its contract.
|
|
51
54
|
|
|
52
|
-
Reuse earlier nodes: a result returns a sessionId once a node has finished; finished nodes are saved in it. On a follow-up, pass that sessionId and read saved nodes by node id in "references", submitting only the new nodes. Reused nodes
|
|
55
|
+
Reuse earlier nodes: a result returns a sessionId once a node has finished; finished nodes are saved in it. On a follow-up, pass that sessionId and read saved nodes by node id in "references", submitting only the new nodes. Reused nodes bring everything they read and are served from cache when possible. A saved node id names one node for the whole session, so give a changed node a new node id; a failed or unfinished node is not saved, so resubmit it under the same id. Omit sessionId to start a new session.
|
|
53
56
|
|
|
54
|
-
Returns
|
|
57
|
+
Returns the terminal node's first rows, other submitted nodes' columns and first rows, and every node's queryUuid. If the result is running, follow up with get_query_result on the terminal node's queryUuid; it also fetches the first page of any node's result by its queryUuid. query computes data only; it saves and charts nothing.`;
|
|
55
58
|
export const TOOL_COMPOSER_QUERIES_DESCRIPTION = getToolComposerQueriesDescription({
|
|
56
59
|
enablePythonNodes: false,
|
|
57
60
|
apiConnections: [],
|
|
@@ -75,6 +78,57 @@ export const composerSemanticLayerFiltersSchema = filterExpressionsSchema
|
|
|
75
78
|
.strict()
|
|
76
79
|
.nullable()
|
|
77
80
|
.describe("Filters on this node's explore as flat expression strings, never structured rule objects: one for dimension fields and one for metric fields, each choosing AND or OR independently and combined with AND. Null when unfiltered, or null for an unused kind.");
|
|
81
|
+
const composerCustomMetricSchema = z.object({
|
|
82
|
+
table: z
|
|
83
|
+
.string()
|
|
84
|
+
.describe('Table of the base dimension; the metric belongs to it.'),
|
|
85
|
+
name: z
|
|
86
|
+
.string()
|
|
87
|
+
.regex(/^[a-z][a-z0-9_]*$/, 'Custom metric names use lowercase snake_case')
|
|
88
|
+
.describe('snake_case name. The metric\'s field id is "<table>_<name>": list it in "metrics" to select it, and use it in sorts, metric filters and periodComparisons.'),
|
|
89
|
+
label: z.string().describe('Column label shown to users.'),
|
|
90
|
+
description: z
|
|
91
|
+
.string()
|
|
92
|
+
.nullish()
|
|
93
|
+
.describe("Shown to users as the metric's description. Null when the label is enough."),
|
|
94
|
+
aggregation: z
|
|
95
|
+
.enum([
|
|
96
|
+
MetricType.SUM,
|
|
97
|
+
MetricType.AVERAGE,
|
|
98
|
+
MetricType.COUNT,
|
|
99
|
+
MetricType.COUNT_DISTINCT,
|
|
100
|
+
MetricType.MIN,
|
|
101
|
+
MetricType.MAX,
|
|
102
|
+
MetricType.MEDIAN,
|
|
103
|
+
MetricType.PERCENTILE,
|
|
104
|
+
])
|
|
105
|
+
.describe('Aggregation over the base dimension. Number dimensions take any; string, date and timestamp dimensions take count, count_distinct, min or max; boolean dimensions take count or count_distinct.'),
|
|
106
|
+
dimensionFieldId: z
|
|
107
|
+
.string()
|
|
108
|
+
.describe('Field id of the dimension to aggregate, a dimension of "table".'),
|
|
109
|
+
percentile: z
|
|
110
|
+
.number()
|
|
111
|
+
.min(0)
|
|
112
|
+
.max(100)
|
|
113
|
+
.nullish()
|
|
114
|
+
.describe('0–100, set only for the percentile aggregation.'),
|
|
115
|
+
filter: filterExpressionInputSchema
|
|
116
|
+
.nullish()
|
|
117
|
+
.describe('Aggregates only the rows this flat AND expression over dimensions matches, in the node filter grammar, e.g. "orders_status equals=completed". Null aggregates every row.'),
|
|
118
|
+
});
|
|
119
|
+
const composerPeriodComparisonSchema = z.object({
|
|
120
|
+
metricFieldId: z
|
|
121
|
+
.string()
|
|
122
|
+
.describe('Metric to compare: a field id in "metrics", explore or custom.'),
|
|
123
|
+
timeDimensionFieldId: z
|
|
124
|
+
.string()
|
|
125
|
+
.describe('Time dimension in "dimensions" with a day, week, month, quarter or year grain; the offset counts in that grain.'),
|
|
126
|
+
periodOffset: z.coerce
|
|
127
|
+
.number()
|
|
128
|
+
.int()
|
|
129
|
+
.min(1)
|
|
130
|
+
.describe('Periods to look back: 1 for the previous period, 12 on a month grain for the same month last year.'),
|
|
131
|
+
});
|
|
78
132
|
const sortFieldSchema = z.object({
|
|
79
133
|
fieldId: z.string().describe('Field id to sort by.'),
|
|
80
134
|
descending: z
|
|
@@ -120,10 +174,17 @@ export const createToolComposerQueriesArgsSchemaV1 = ({ maxLimit = DEFAULT_COMPO
|
|
|
120
174
|
.array(sortFieldSchema)
|
|
121
175
|
.nullable()
|
|
122
176
|
.describe('Sorts by fields this node also selects in dimensions or metrics, e.g. [{"fieldId": "orders_order_date", "descending": true}].'),
|
|
177
|
+
customMetrics: z
|
|
178
|
+
.array(composerCustomMetricSchema)
|
|
179
|
+
.nullish()
|
|
180
|
+
.describe('Metrics the explore lacks, each an aggregation over one of its dimensions, computed in this query.'),
|
|
181
|
+
periodComparisons: z
|
|
182
|
+
.array(composerPeriodComparisonSchema)
|
|
183
|
+
.nullish()
|
|
184
|
+
.describe('Each adds a column holding a metric shifted back in time, next to that metric, e.g. revenue the same month last year. The warehouse reads the earlier period even when the filters exclude it. The column id is generated; read it from the result columns.'),
|
|
123
185
|
parameters: z
|
|
124
186
|
.record(z.string(), parameterValueSchema)
|
|
125
|
-
.
|
|
126
|
-
.default(null)
|
|
187
|
+
.nullish()
|
|
127
188
|
.describe('Parameter values for this node, keyed by parameter name exactly as shown in the explore metadata (e.g. {"orders.metric": "active_users"}). Set them whenever a selected field is marked "requires parameters" and the default does not match what the user asked for: an unset parameter silently resolves to its default, which can return the wrong data. null when the explore has no parameters or the defaults are correct.'),
|
|
128
189
|
limit: limitSchema,
|
|
129
190
|
});
|
|
@@ -213,7 +274,7 @@ export const createToolComposerQueriesArgsSchemaV1 = ({ maxLimit = DEFAULT_COMPO
|
|
|
213
274
|
terminalNodeId: z
|
|
214
275
|
.string()
|
|
215
276
|
.nullable()
|
|
216
|
-
.describe('The terminal node. Null picks the
|
|
277
|
+
.describe('The terminal node. Null picks the one submitted node no other submitted node reads; a node id returns that node of the pipeline instead, including a node from an earlier call.'),
|
|
217
278
|
})
|
|
218
279
|
.build();
|
|
219
280
|
};
|
|
@@ -272,6 +333,9 @@ export const toolComposerQueryNodeToSourceQuery = (node) => {
|
|
|
272
333
|
filters,
|
|
273
334
|
sorts,
|
|
274
335
|
parameters,
|
|
336
|
+
...(node.additionalMetrics.length > 0
|
|
337
|
+
? { additionalMetrics: node.additionalMetrics }
|
|
338
|
+
: {}),
|
|
275
339
|
limit: node.limit,
|
|
276
340
|
};
|
|
277
341
|
}
|
|
@@ -453,6 +517,10 @@ export const parsePartialToolComposerQueriesArgs = (input) => {
|
|
|
453
517
|
terminalNodeId: typeof raw.terminalNodeId === 'string' ? raw.terminalNodeId : null,
|
|
454
518
|
};
|
|
455
519
|
};
|
|
520
|
+
const composerQueryColumnSchema = z.object({
|
|
521
|
+
reference: z.string().describe('Column name as it appears in the rows.'),
|
|
522
|
+
type: z.nativeEnum(DimensionType),
|
|
523
|
+
});
|
|
456
524
|
const composerQueryNodeSummarySchema = z.object({
|
|
457
525
|
nodeId: nodeIdSchema,
|
|
458
526
|
title: z.string().nullable().describe('What users see for this node.'),
|
|
@@ -468,10 +536,14 @@ const composerQueryNodeSummarySchema = z.object({
|
|
|
468
536
|
.int()
|
|
469
537
|
.positive()
|
|
470
538
|
.describe('Row limit this node ran with. A rowCount equal to it means the node reached its limit, so more rows may exist.'),
|
|
471
|
-
|
|
472
|
-
|
|
473
|
-
|
|
474
|
-
|
|
539
|
+
columns: z
|
|
540
|
+
.array(composerQueryColumnSchema)
|
|
541
|
+
.nullable()
|
|
542
|
+
.describe('Columns of a node submitted in this call; null for reused nodes and for the terminal node, whose columns are in columns.'),
|
|
543
|
+
sample: z
|
|
544
|
+
.array(z.record(z.string(), z.unknown()))
|
|
545
|
+
.nullable()
|
|
546
|
+
.describe(`First ${COMPOSER_NODE_SAMPLE_ROW_LIMIT} rows of a node submitted in this call other than the terminal node; null otherwise or when data access is disabled.`),
|
|
475
547
|
});
|
|
476
548
|
export const toolComposerQueriesStructuredContentSchema = z.object({
|
|
477
549
|
terminalNodeId: nodeIdSchema.describe('Node whose rows are returned.'),
|
|
@@ -529,7 +601,11 @@ export const mcpQueryStructuredOutputSchema = z.object({
|
|
|
529
601
|
columns: z
|
|
530
602
|
.array(composerQueryColumnSchema)
|
|
531
603
|
.nullable()
|
|
532
|
-
.describe('Result columns; null until the node is done.'),
|
|
604
|
+
.describe('Result columns of the terminal node and of nodes submitted in this call; null for reused nodes and until the node is done.'),
|
|
605
|
+
sample: z
|
|
606
|
+
.array(z.record(z.string(), z.unknown()))
|
|
607
|
+
.nullable()
|
|
608
|
+
.describe(`First ${COMPOSER_NODE_SAMPLE_ROW_LIMIT} rows of a done node submitted in this call other than the terminal node; null for the terminal node and for reused, failed or unfinished nodes.`),
|
|
533
609
|
}))
|
|
534
610
|
.describe('Every node of the pipeline, in dependency order.'),
|
|
535
611
|
});
|