@gooddata/api-client-tiger 11.50.0-alpha.3 → 11.50.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/esm/__version.d.ts +1 -1
- package/esm/__version.d.ts.map +1 -1
- package/esm/__version.js +1 -1
- package/esm/api-client-tiger.d.ts +8005 -4512
- package/esm/generated/afm-rest-api/api.d.ts +731 -673
- package/esm/generated/afm-rest-api/api.d.ts.map +1 -1
- package/esm/generated/ai-json-api/api.d.ts +432 -380
- package/esm/generated/ai-json-api/api.d.ts.map +1 -1
- package/esm/generated/ai-json-api/api.js +29 -24
- package/esm/generated/auth-json-api/api.d.ts +22 -22
- package/esm/generated/auth-json-api/api.d.ts.map +1 -1
- package/esm/generated/automation-json-api/api.d.ts +339 -300
- package/esm/generated/automation-json-api/api.d.ts.map +1 -1
- package/esm/generated/export-json-api/api.d.ts +266 -207
- package/esm/generated/export-json-api/api.d.ts.map +1 -1
- package/esm/generated/metadata-json-api/api.d.ts +6107 -2913
- package/esm/generated/metadata-json-api/api.d.ts.map +1 -1
- package/esm/generated/metadata-json-api/api.js +570 -68
- package/esm/generated/result-json-api/api.d.ts +87 -87
- package/esm/generated/result-json-api/api.d.ts.map +1 -1
- package/esm/generated/scan-json-api/api.d.ts +109 -109
- package/esm/generated/scan-json-api/api.d.ts.map +1 -1
- package/esm/index.d.ts +4 -4
- package/esm/index.d.ts.map +1 -1
- package/package.json +4 -4
|
@@ -20,26 +20,26 @@ export interface AFM {
|
|
|
20
20
|
* Attributes to be used in the computation.
|
|
21
21
|
*/
|
|
22
22
|
'attributes': Array<AttributeItem>;
|
|
23
|
+
/**
|
|
24
|
+
* Metrics to be referenced from other AFM objects (e.g. filters) but not included in the result.
|
|
25
|
+
*/
|
|
26
|
+
'auxMeasures'?: Array<MeasureItem>;
|
|
23
27
|
/**
|
|
24
28
|
* Various filter types to filter the execution result.
|
|
25
29
|
*/
|
|
26
30
|
'filters': Array<FilterDefinition>;
|
|
27
31
|
/**
|
|
28
|
-
*
|
|
32
|
+
* (EXPERIMENTAL) Override definitions of catalog metrics for this request. Allows substituting a catalog metric\'s MAQL definition without modifying the stored definition.
|
|
29
33
|
*/
|
|
30
|
-
'
|
|
34
|
+
'measureDefinitionOverrides'?: Array<MetricDefinitionOverride>;
|
|
31
35
|
/**
|
|
32
|
-
* Metrics to be
|
|
36
|
+
* Metrics to be computed.
|
|
33
37
|
*/
|
|
34
|
-
'
|
|
38
|
+
'measures': Array<MeasureItem>;
|
|
35
39
|
/**
|
|
36
40
|
* (EXPERIMENTAL) Parameter values to use for this execution.
|
|
37
41
|
*/
|
|
38
42
|
'parameters'?: Array<ParameterItem>;
|
|
39
|
-
/**
|
|
40
|
-
* (EXPERIMENTAL) Override definitions of catalog metrics for this request. Allows substituting a catalog metric\'s MAQL definition without modifying the stored definition.
|
|
41
|
-
*/
|
|
42
|
-
'measureDefinitionOverrides'?: Array<MetricDefinitionOverride>;
|
|
43
43
|
}
|
|
44
44
|
/**
|
|
45
45
|
* A datetime filter specifying exact from and to values.
|
|
@@ -48,17 +48,46 @@ export interface AbsoluteDateFilter {
|
|
|
48
48
|
'absoluteDateFilter': AbsoluteDateFilterAbsoluteDateFilter;
|
|
49
49
|
}
|
|
50
50
|
export interface AbsoluteDateFilterAbsoluteDateFilter {
|
|
51
|
-
'from': string;
|
|
52
|
-
'to': string;
|
|
53
|
-
'localIdentifier'?: string;
|
|
54
51
|
'applyOnResult'?: boolean;
|
|
52
|
+
'dataset': AfmObjectIdentifierDataset;
|
|
55
53
|
/**
|
|
56
54
|
* Specifies how rows with empty (null/missing) date values should be handled. INCLUDE includes empty dates in addition to the date range restriction, EXCLUDE removes rows with empty dates (default), ONLY keeps only rows with empty dates.
|
|
57
55
|
*/
|
|
58
56
|
'emptyValueHandling'?: AbsoluteDateFilterAbsoluteDateFilterEmptyValueHandlingEnum;
|
|
59
|
-
'
|
|
57
|
+
'from': string;
|
|
58
|
+
'localIdentifier'?: string;
|
|
59
|
+
'to': string;
|
|
60
60
|
}
|
|
61
61
|
export type AbsoluteDateFilterAbsoluteDateFilterEmptyValueHandlingEnum = 'INCLUDE' | 'EXCLUDE' | 'ONLY';
|
|
62
|
+
/**
|
|
63
|
+
* An absolute date range filter defined at a specific granularity. The \'from\'/\'to\' literals must match the format of the chosen granularity (e.g. \'2020\' for YEAR, \'2012-05\' for MONTH, \'2012-3\' for QUARTER, \'1996-01\' for WEEK, \'2010-10-30\' for DAY, or a plain ordinal like \'6\' for periodical granularities such as MONTH_OF_YEAR). At least one of \'from\'/\'to\' must be provided; specifying only one yields an open-ended range.
|
|
64
|
+
*/
|
|
65
|
+
export interface AbsoluteGranularityDateFilter {
|
|
66
|
+
'absoluteGranularityDateFilter': AbsoluteGranularityDateFilterAbsoluteGranularityDateFilter;
|
|
67
|
+
}
|
|
68
|
+
export interface AbsoluteGranularityDateFilterAbsoluteGranularityDateFilter {
|
|
69
|
+
'applyOnResult'?: boolean;
|
|
70
|
+
'dataset': AfmObjectIdentifierDataset;
|
|
71
|
+
/**
|
|
72
|
+
* Specifies how rows with empty (null/missing) date values should be handled. INCLUDE includes empty dates in addition to the date range restriction, EXCLUDE removes rows with empty dates (default), ONLY keeps only rows with empty dates.
|
|
73
|
+
*/
|
|
74
|
+
'emptyValueHandling'?: AbsoluteGranularityDateFilterAbsoluteGranularityDateFilterEmptyValueHandlingEnum;
|
|
75
|
+
/**
|
|
76
|
+
* Start of the range (including), in the format matching \'granularity\'. If omitted, the range is unbounded at the start.
|
|
77
|
+
*/
|
|
78
|
+
'from'?: string | null;
|
|
79
|
+
/**
|
|
80
|
+
* Granularity determining the filtered date attribute and the expected \'from\'/\'to\' format.
|
|
81
|
+
*/
|
|
82
|
+
'granularity': AbsoluteGranularityDateFilterAbsoluteGranularityDateFilterGranularityEnum;
|
|
83
|
+
'localIdentifier'?: string;
|
|
84
|
+
/**
|
|
85
|
+
* End of the range (including), in the format matching \'granularity\'. If omitted, the range is unbounded at the end.
|
|
86
|
+
*/
|
|
87
|
+
'to'?: string | null;
|
|
88
|
+
}
|
|
89
|
+
export type AbsoluteGranularityDateFilterAbsoluteGranularityDateFilterEmptyValueHandlingEnum = 'INCLUDE' | 'EXCLUDE' | 'ONLY';
|
|
90
|
+
export type AbsoluteGranularityDateFilterAbsoluteGranularityDateFilterGranularityEnum = 'SECOND' | 'SECOND_OF_MINUTE' | 'SECOND_OF_DAY' | 'MINUTE' | 'MINUTE_OF_HOUR' | 'MINUTE_OF_DAY' | 'HOUR' | 'HOUR_OF_DAY' | 'DAY' | 'DAY_OF_WEEK' | 'DAY_OF_MONTH' | 'DAY_OF_QUARTER' | 'DAY_OF_YEAR' | 'WEEK' | 'WEEK_OF_YEAR' | 'MONTH' | 'MONTH_OF_YEAR' | 'QUARTER' | 'QUARTER_OF_YEAR' | 'YEAR' | 'FISCAL_DAY_OF_FISCAL_WEEK' | 'FISCAL_DAY_OF_FISCAL_MONTH' | 'FISCAL_DAY_OF_FISCAL_QUARTER' | 'FISCAL_DAY_OF_FISCAL_SEMESTER' | 'FISCAL_DAY_OF_FISCAL_YEAR' | 'FISCAL_WEEK' | 'FISCAL_WEEK_OF_FISCAL_MONTH' | 'FISCAL_WEEK_OF_FISCAL_QUARTER' | 'FISCAL_WEEK_OF_FISCAL_SEMESTER' | 'FISCAL_WEEK_OF_FISCAL_YEAR' | 'FISCAL_MONTH' | 'FISCAL_MONTH_OF_FISCAL_QUARTER' | 'FISCAL_MONTH_OF_FISCAL_SEMESTER' | 'FISCAL_MONTH_OF_FISCAL_YEAR' | 'FISCAL_QUARTER' | 'FISCAL_QUARTER_OF_FISCAL_SEMESTER' | 'FISCAL_QUARTER_OF_FISCAL_YEAR' | 'FISCAL_SEMESTER' | 'FISCAL_SEMESTER_OF_FISCAL_YEAR' | 'FISCAL_YEAR';
|
|
62
91
|
/**
|
|
63
92
|
* @type AbstractMeasureValueFilter
|
|
64
93
|
*/
|
|
@@ -169,16 +198,16 @@ export interface AfmObjectIdentifierDatasetIdentifier {
|
|
|
169
198
|
}
|
|
170
199
|
export type AfmObjectIdentifierDatasetIdentifierTypeEnum = 'dataset';
|
|
171
200
|
export interface AfmObjectIdentifierIdentifier {
|
|
172
|
-
'type': AfmObjectIdentifierIdentifierTypeEnum;
|
|
173
201
|
'id': string;
|
|
202
|
+
'type': AfmObjectIdentifierIdentifierTypeEnum;
|
|
174
203
|
}
|
|
175
204
|
export type AfmObjectIdentifierIdentifierTypeEnum = 'analyticalDashboard' | 'attribute' | 'dashboardPlugin' | 'dataset' | 'fact' | 'label' | 'metric' | 'prompt' | 'visualizationObject' | 'filterContext';
|
|
176
205
|
export interface AfmObjectIdentifierLabel {
|
|
177
206
|
'identifier': AfmObjectIdentifierLabelIdentifier;
|
|
178
207
|
}
|
|
179
208
|
export interface AfmObjectIdentifierLabelIdentifier {
|
|
180
|
-
'type': AfmObjectIdentifierLabelIdentifierTypeEnum;
|
|
181
209
|
'id': string;
|
|
210
|
+
'type': AfmObjectIdentifierLabelIdentifierTypeEnum;
|
|
182
211
|
}
|
|
183
212
|
export type AfmObjectIdentifierLabelIdentifierTypeEnum = 'label';
|
|
184
213
|
/**
|
|
@@ -216,8 +245,8 @@ export interface AfmValidDescendantsResponse {
|
|
|
216
245
|
* Entity holding AFM and list of object types whose validity should be computed.
|
|
217
246
|
*/
|
|
218
247
|
export interface AfmValidObjectsQuery {
|
|
219
|
-
'types': Array<AfmValidObjectsQueryTypesEnum>;
|
|
220
248
|
'afm': AFM;
|
|
249
|
+
'types': Array<AfmValidObjectsQueryTypesEnum>;
|
|
221
250
|
}
|
|
222
251
|
export type AfmValidObjectsQueryTypesEnum = 'facts' | 'attributes' | 'measures';
|
|
223
252
|
/**
|
|
@@ -259,6 +288,8 @@ export interface AllTimeDateFilter {
|
|
|
259
288
|
'allTimeDateFilter': AllTimeDateFilterAllTimeDateFilter;
|
|
260
289
|
}
|
|
261
290
|
export interface AllTimeDateFilterAllTimeDateFilter {
|
|
291
|
+
'applyOnResult'?: boolean;
|
|
292
|
+
'dataset': AfmObjectIdentifierDataset;
|
|
262
293
|
/**
|
|
263
294
|
* Specifies how rows with empty (null/missing) date values should be handled. INCLUDE means no filtering effect (default), EXCLUDE removes rows with null dates, ONLY keeps only rows with null dates.
|
|
264
295
|
*/
|
|
@@ -268,15 +299,17 @@ export interface AllTimeDateFilterAllTimeDateFilter {
|
|
|
268
299
|
*/
|
|
269
300
|
'granularity'?: AllTimeDateFilterAllTimeDateFilterGranularityEnum;
|
|
270
301
|
'localIdentifier'?: string;
|
|
271
|
-
'applyOnResult'?: boolean;
|
|
272
|
-
'dataset': AfmObjectIdentifierDataset;
|
|
273
302
|
}
|
|
274
303
|
export type AllTimeDateFilterAllTimeDateFilterEmptyValueHandlingEnum = 'INCLUDE' | 'EXCLUDE' | 'ONLY';
|
|
275
|
-
export type AllTimeDateFilterAllTimeDateFilterGranularityEnum = '
|
|
304
|
+
export type AllTimeDateFilterAllTimeDateFilterGranularityEnum = 'SECOND' | 'SECOND_OF_MINUTE' | 'SECOND_OF_DAY' | 'MINUTE' | 'MINUTE_OF_HOUR' | 'MINUTE_OF_DAY' | 'HOUR' | 'HOUR_OF_DAY' | 'DAY' | 'DAY_OF_WEEK' | 'DAY_OF_MONTH' | 'DAY_OF_QUARTER' | 'DAY_OF_YEAR' | 'WEEK' | 'WEEK_OF_YEAR' | 'MONTH' | 'MONTH_OF_YEAR' | 'QUARTER' | 'QUARTER_OF_YEAR' | 'YEAR' | 'FISCAL_DAY_OF_FISCAL_WEEK' | 'FISCAL_DAY_OF_FISCAL_MONTH' | 'FISCAL_DAY_OF_FISCAL_QUARTER' | 'FISCAL_DAY_OF_FISCAL_SEMESTER' | 'FISCAL_DAY_OF_FISCAL_YEAR' | 'FISCAL_WEEK' | 'FISCAL_WEEK_OF_FISCAL_MONTH' | 'FISCAL_WEEK_OF_FISCAL_QUARTER' | 'FISCAL_WEEK_OF_FISCAL_SEMESTER' | 'FISCAL_WEEK_OF_FISCAL_YEAR' | 'FISCAL_MONTH' | 'FISCAL_MONTH_OF_FISCAL_QUARTER' | 'FISCAL_MONTH_OF_FISCAL_SEMESTER' | 'FISCAL_MONTH_OF_FISCAL_YEAR' | 'FISCAL_QUARTER' | 'FISCAL_QUARTER_OF_FISCAL_SEMESTER' | 'FISCAL_QUARTER_OF_FISCAL_YEAR' | 'FISCAL_SEMESTER' | 'FISCAL_SEMESTER_OF_FISCAL_YEAR' | 'FISCAL_YEAR';
|
|
276
305
|
/**
|
|
277
306
|
* Allowed relationship type combination.
|
|
278
307
|
*/
|
|
279
308
|
export interface AllowedRelationshipType {
|
|
309
|
+
/**
|
|
310
|
+
* If true, allows target objects that are not part of any relationship (orphans) to be included in results. If false, orphan target objects will be excluded even if they directly match the search query. Default is true (orphans are allowed).
|
|
311
|
+
*/
|
|
312
|
+
'allowOrphans'?: boolean;
|
|
280
313
|
/**
|
|
281
314
|
* Source object type (e.g., \'dashboard\', \'visualization\', \'metric\').
|
|
282
315
|
*/
|
|
@@ -285,10 +318,6 @@ export interface AllowedRelationshipType {
|
|
|
285
318
|
* Target object type (e.g., \'visualization\', \'metric\', \'attribute\').
|
|
286
319
|
*/
|
|
287
320
|
'targetType': AllowedRelationshipTypeTargetTypeEnum;
|
|
288
|
-
/**
|
|
289
|
-
* If true, allows target objects that are not part of any relationship (orphans) to be included in results. If false, orphan target objects will be excluded even if they directly match the search query. Default is true (orphans are allowed).
|
|
290
|
-
*/
|
|
291
|
-
'allowOrphans'?: boolean;
|
|
292
321
|
}
|
|
293
322
|
export type AllowedRelationshipTypeSourceTypeEnum = 'attribute' | 'metric' | 'fact' | 'label' | 'date' | 'dataset' | 'visualization' | 'dashboard';
|
|
294
323
|
export type AllowedRelationshipTypeTargetTypeEnum = 'attribute' | 'metric' | 'fact' | 'label' | 'date' | 'dataset' | 'visualization' | 'dashboard';
|
|
@@ -318,9 +347,9 @@ export interface AnomalyDetectionRequest {
|
|
|
318
347
|
'sensitivity': number;
|
|
319
348
|
}
|
|
320
349
|
export interface AnomalyDetectionResult {
|
|
350
|
+
'anomalyFlag': Array<boolean | null>;
|
|
321
351
|
'attribute': Array<string>;
|
|
322
352
|
'values': Array<number | null>;
|
|
323
|
-
'anomalyFlag': Array<boolean | null>;
|
|
324
353
|
}
|
|
325
354
|
export interface AnthropicApiKeyAuth {
|
|
326
355
|
/**
|
|
@@ -337,11 +366,11 @@ export type AnthropicApiKeyAuthTypeEnum = 'API_KEY';
|
|
|
337
366
|
* Configuration for Anthropic provider.
|
|
338
367
|
*/
|
|
339
368
|
export interface AnthropicProviderConfig {
|
|
369
|
+
'auth': AnthropicApiKeyAuth;
|
|
340
370
|
/**
|
|
341
371
|
* Custom base URL for the Anthropic API. Defaults to the official endpoint; override only for enterprise proxies or compatible gateways.
|
|
342
372
|
*/
|
|
343
373
|
'baseUrl'?: string;
|
|
344
|
-
'auth': AnthropicApiKeyAuth;
|
|
345
374
|
/**
|
|
346
375
|
* Provider type.
|
|
347
376
|
*/
|
|
@@ -403,52 +432,52 @@ export interface AttributeHeader {
|
|
|
403
432
|
'attributeHeader': AttributeHeaderAttributeHeader;
|
|
404
433
|
}
|
|
405
434
|
export interface AttributeHeaderAttributeHeader {
|
|
406
|
-
/**
|
|
407
|
-
* Local identifier of the attribute this header relates to.
|
|
408
|
-
*/
|
|
409
|
-
'localIdentifier': string;
|
|
410
|
-
'label': RestApiIdentifier;
|
|
411
|
-
/**
|
|
412
|
-
* Label name.
|
|
413
|
-
*/
|
|
414
|
-
'labelName': string;
|
|
415
435
|
'attribute': RestApiIdentifier;
|
|
416
436
|
/**
|
|
417
437
|
* Attribute name.
|
|
418
438
|
*/
|
|
419
439
|
'attributeName': string;
|
|
440
|
+
'format'?: AttributeFormat;
|
|
441
|
+
'geoAreaConfig'?: GeoAreaConfig;
|
|
420
442
|
/**
|
|
421
443
|
* Date granularity of the attribute, only filled for date attributes.
|
|
422
444
|
*/
|
|
423
445
|
'granularity'?: AttributeHeaderAttributeHeaderGranularityEnum;
|
|
446
|
+
'label': RestApiIdentifier;
|
|
447
|
+
/**
|
|
448
|
+
* Label name.
|
|
449
|
+
*/
|
|
450
|
+
'labelName': string;
|
|
451
|
+
/**
|
|
452
|
+
* Local identifier of the attribute this header relates to.
|
|
453
|
+
*/
|
|
454
|
+
'localIdentifier': string;
|
|
424
455
|
'primaryLabel': RestApiIdentifier;
|
|
425
|
-
'format'?: AttributeFormat;
|
|
426
456
|
/**
|
|
427
457
|
* Attribute value type.
|
|
428
458
|
*/
|
|
429
459
|
'valueType'?: AttributeHeaderAttributeHeaderValueTypeEnum;
|
|
430
|
-
'geoAreaConfig'?: GeoAreaConfig;
|
|
431
460
|
}
|
|
432
|
-
export type AttributeHeaderAttributeHeaderGranularityEnum = '
|
|
461
|
+
export type AttributeHeaderAttributeHeaderGranularityEnum = 'SECOND' | 'SECOND_OF_MINUTE' | 'SECOND_OF_DAY' | 'MINUTE' | 'MINUTE_OF_HOUR' | 'MINUTE_OF_DAY' | 'HOUR' | 'HOUR_OF_DAY' | 'DAY' | 'DAY_OF_WEEK' | 'DAY_OF_MONTH' | 'DAY_OF_QUARTER' | 'DAY_OF_YEAR' | 'WEEK' | 'WEEK_OF_YEAR' | 'MONTH' | 'MONTH_OF_YEAR' | 'QUARTER' | 'QUARTER_OF_YEAR' | 'YEAR' | 'FISCAL_DAY_OF_FISCAL_WEEK' | 'FISCAL_DAY_OF_FISCAL_MONTH' | 'FISCAL_DAY_OF_FISCAL_QUARTER' | 'FISCAL_DAY_OF_FISCAL_SEMESTER' | 'FISCAL_DAY_OF_FISCAL_YEAR' | 'FISCAL_WEEK' | 'FISCAL_WEEK_OF_FISCAL_MONTH' | 'FISCAL_WEEK_OF_FISCAL_QUARTER' | 'FISCAL_WEEK_OF_FISCAL_SEMESTER' | 'FISCAL_WEEK_OF_FISCAL_YEAR' | 'FISCAL_MONTH' | 'FISCAL_MONTH_OF_FISCAL_QUARTER' | 'FISCAL_MONTH_OF_FISCAL_SEMESTER' | 'FISCAL_MONTH_OF_FISCAL_YEAR' | 'FISCAL_QUARTER' | 'FISCAL_QUARTER_OF_FISCAL_SEMESTER' | 'FISCAL_QUARTER_OF_FISCAL_YEAR' | 'FISCAL_SEMESTER' | 'FISCAL_SEMESTER_OF_FISCAL_YEAR' | 'FISCAL_YEAR';
|
|
433
462
|
export type AttributeHeaderAttributeHeaderValueTypeEnum = 'TEXT' | 'HYPERLINK' | 'GEO' | 'GEO_LONGITUDE' | 'GEO_LATITUDE' | 'GEO_AREA' | 'GEO_ICON' | 'IMAGE' | 'HYPERLOGLOG';
|
|
434
463
|
export interface AttributeItem {
|
|
464
|
+
'label': AfmObjectIdentifierLabel;
|
|
435
465
|
/**
|
|
436
466
|
* Local identifier of the attribute. This can be used to reference the attribute in other parts of the execution definition.
|
|
437
467
|
*/
|
|
438
468
|
'localIdentifier': string;
|
|
439
|
-
'label': AfmObjectIdentifierLabel;
|
|
440
469
|
/**
|
|
441
470
|
* Indicates whether to show all values of given attribute even if the data bound to those values is not available.
|
|
442
471
|
*/
|
|
443
472
|
'showAllValues'?: boolean;
|
|
444
473
|
}
|
|
445
474
|
export interface AttributeNegativeFilter {
|
|
446
|
-
'using': string;
|
|
447
475
|
'exclude': Array<string>;
|
|
476
|
+
'using': string;
|
|
448
477
|
}
|
|
449
478
|
export interface AttributePositiveFilter {
|
|
450
|
-
'using': string;
|
|
451
479
|
'include': Array<string>;
|
|
480
|
+
'using': string;
|
|
452
481
|
}
|
|
453
482
|
/**
|
|
454
483
|
* Header containing the information related to attributes.
|
|
@@ -486,11 +515,11 @@ export type AwsBedrockAccessKeyAuthTypeEnum = 'ACCESS_KEY';
|
|
|
486
515
|
* Configuration for AWS Bedrock provider.
|
|
487
516
|
*/
|
|
488
517
|
export interface AwsBedrockProviderConfig {
|
|
518
|
+
'auth': AwsBedrockAccessKeyAuth;
|
|
489
519
|
/**
|
|
490
520
|
* AWS region for Bedrock.
|
|
491
521
|
*/
|
|
492
522
|
'region': string;
|
|
493
|
-
'auth': AwsBedrockAccessKeyAuth;
|
|
494
523
|
/**
|
|
495
524
|
* Provider type.
|
|
496
525
|
*/
|
|
@@ -512,11 +541,11 @@ export type AzureFoundryApiKeyAuthTypeEnum = 'API_KEY';
|
|
|
512
541
|
* Configuration for Azure Foundry provider.
|
|
513
542
|
*/
|
|
514
543
|
export interface AzureFoundryProviderConfig {
|
|
544
|
+
'auth': AzureFoundryApiKeyAuth;
|
|
515
545
|
/**
|
|
516
546
|
* Azure OpenAI endpoint URL.
|
|
517
547
|
*/
|
|
518
548
|
'endpoint': string;
|
|
519
|
-
'auth': AzureFoundryApiKeyAuth;
|
|
520
549
|
/**
|
|
521
550
|
* Provider type.
|
|
522
551
|
*/
|
|
@@ -527,47 +556,37 @@ export type AzureFoundryProviderConfigTypeEnum = 'AZURE_FOUNDRY';
|
|
|
527
556
|
* Bounding filter for this relative date filter. This can be used to limit the range of the relative date filter to a specific date range.
|
|
528
557
|
*/
|
|
529
558
|
export interface BoundedFilter {
|
|
530
|
-
/**
|
|
531
|
-
* Date granularity specifying particular date attribute in given dimension.
|
|
532
|
-
*/
|
|
533
|
-
'granularity': BoundedFilterGranularityEnum;
|
|
534
559
|
/**
|
|
535
560
|
* Start of the filtering interval. Specified by number of periods (with respect to given granularity). Typically negative (historical time interval like -2 for \'2 days/weeks, ... ago\'). If null, then start of the range is unbounded.
|
|
536
561
|
*/
|
|
537
562
|
'from'?: number | null;
|
|
563
|
+
/**
|
|
564
|
+
* Date granularity specifying particular date attribute in given dimension.
|
|
565
|
+
*/
|
|
566
|
+
'granularity': BoundedFilterGranularityEnum;
|
|
538
567
|
/**
|
|
539
568
|
* End of the filtering interval. Specified by number of periods (with respect to given granularity). Value \'O\' is representing current time-interval (current day, week, ...). If null, then end of the range is unbounded.
|
|
540
569
|
*/
|
|
541
570
|
'to'?: number | null;
|
|
542
571
|
}
|
|
543
|
-
export type BoundedFilterGranularityEnum = '
|
|
572
|
+
export type BoundedFilterGranularityEnum = 'SECOND' | 'SECOND_OF_MINUTE' | 'SECOND_OF_DAY' | 'MINUTE' | 'MINUTE_OF_HOUR' | 'MINUTE_OF_DAY' | 'HOUR' | 'HOUR_OF_DAY' | 'DAY' | 'DAY_OF_WEEK' | 'DAY_OF_MONTH' | 'DAY_OF_QUARTER' | 'DAY_OF_YEAR' | 'WEEK' | 'WEEK_OF_YEAR' | 'MONTH' | 'MONTH_OF_YEAR' | 'QUARTER' | 'QUARTER_OF_YEAR' | 'YEAR' | 'FISCAL_DAY_OF_FISCAL_WEEK' | 'FISCAL_DAY_OF_FISCAL_MONTH' | 'FISCAL_DAY_OF_FISCAL_QUARTER' | 'FISCAL_DAY_OF_FISCAL_SEMESTER' | 'FISCAL_DAY_OF_FISCAL_YEAR' | 'FISCAL_WEEK' | 'FISCAL_WEEK_OF_FISCAL_MONTH' | 'FISCAL_WEEK_OF_FISCAL_QUARTER' | 'FISCAL_WEEK_OF_FISCAL_SEMESTER' | 'FISCAL_WEEK_OF_FISCAL_YEAR' | 'FISCAL_MONTH' | 'FISCAL_MONTH_OF_FISCAL_QUARTER' | 'FISCAL_MONTH_OF_FISCAL_SEMESTER' | 'FISCAL_MONTH_OF_FISCAL_YEAR' | 'FISCAL_QUARTER' | 'FISCAL_QUARTER_OF_FISCAL_SEMESTER' | 'FISCAL_QUARTER_OF_FISCAL_YEAR' | 'FISCAL_SEMESTER' | 'FISCAL_SEMESTER_OF_FISCAL_YEAR' | 'FISCAL_YEAR';
|
|
544
573
|
/**
|
|
545
574
|
* Certification state of the object. Who certified and when are never exposed here.
|
|
546
575
|
*/
|
|
547
576
|
export interface CertificationInfo {
|
|
548
|
-
/**
|
|
549
|
-
* Certification status, e.g. CERTIFIED.
|
|
550
|
-
*/
|
|
551
|
-
'status': string;
|
|
552
577
|
/**
|
|
553
578
|
* Optional message describing the certification.
|
|
554
579
|
*/
|
|
555
580
|
'certificationMessage'?: string;
|
|
581
|
+
/**
|
|
582
|
+
* Certification status, e.g. CERTIFIED.
|
|
583
|
+
*/
|
|
584
|
+
'status': string;
|
|
556
585
|
}
|
|
557
586
|
/**
|
|
558
587
|
* Change analysis specification.
|
|
559
588
|
*/
|
|
560
589
|
export interface ChangeAnalysisParams {
|
|
561
|
-
'measure': MeasureItem;
|
|
562
|
-
/**
|
|
563
|
-
* The title of the measure being analyzed
|
|
564
|
-
*/
|
|
565
|
-
'measureTitle': string;
|
|
566
|
-
'dateAttribute': AttributeItem;
|
|
567
|
-
/**
|
|
568
|
-
* The reference time period
|
|
569
|
-
*/
|
|
570
|
-
'referencePeriod': string;
|
|
571
590
|
/**
|
|
572
591
|
* The analyzed time period
|
|
573
592
|
*/
|
|
@@ -576,25 +595,33 @@ export interface ChangeAnalysisParams {
|
|
|
576
595
|
* Attributes to analyze for significant changes
|
|
577
596
|
*/
|
|
578
597
|
'attributes': Array<AttributeItem>;
|
|
598
|
+
'dateAttribute': AttributeItem;
|
|
579
599
|
/**
|
|
580
600
|
* Optional filters to apply
|
|
581
601
|
*/
|
|
582
|
-
'filters': Array<
|
|
602
|
+
'filters': Array<ChangeAnalysisParamsFiltersInner>;
|
|
603
|
+
'measure': MeasureItem;
|
|
604
|
+
/**
|
|
605
|
+
* The title of the measure being analyzed
|
|
606
|
+
*/
|
|
607
|
+
'measureTitle': string;
|
|
608
|
+
/**
|
|
609
|
+
* The reference time period
|
|
610
|
+
*/
|
|
611
|
+
'referencePeriod': string;
|
|
583
612
|
/**
|
|
584
613
|
* Whether to use smart attribute selection
|
|
585
614
|
*/
|
|
586
615
|
'useSmartAttributeSelection': boolean;
|
|
587
616
|
}
|
|
617
|
+
/**
|
|
618
|
+
* @type ChangeAnalysisParamsFiltersInner
|
|
619
|
+
*/
|
|
620
|
+
export type ChangeAnalysisParamsFiltersInner = AbstractMeasureValueFilter | FilterDefinitionForSimpleMeasure | InlineFilterDefinition;
|
|
588
621
|
/**
|
|
589
622
|
* Request for change analysis computation
|
|
590
623
|
*/
|
|
591
624
|
export interface ChangeAnalysisRequest {
|
|
592
|
-
'measure': MeasureItem;
|
|
593
|
-
'dateAttribute': AttributeItem;
|
|
594
|
-
/**
|
|
595
|
-
* The reference time period (e.g., \'2025-01\')
|
|
596
|
-
*/
|
|
597
|
-
'referencePeriod': string;
|
|
598
625
|
/**
|
|
599
626
|
* The analyzed time period (e.g., \'2025-02\')
|
|
600
627
|
*/
|
|
@@ -603,27 +630,37 @@ export interface ChangeAnalysisRequest {
|
|
|
603
630
|
* Attributes to analyze for significant changes. If empty, valid attributes will be automatically discovered.
|
|
604
631
|
*/
|
|
605
632
|
'attributes'?: Array<AttributeItem>;
|
|
606
|
-
/**
|
|
607
|
-
* Optional filters to apply.
|
|
608
|
-
*/
|
|
609
|
-
'filters'?: Array<OutlierDetectionRequestFiltersInner>;
|
|
610
633
|
/**
|
|
611
634
|
* Auxiliary measures
|
|
612
635
|
*/
|
|
613
636
|
'auxMeasures'?: Array<MeasureItem>;
|
|
637
|
+
'dateAttribute': AttributeItem;
|
|
614
638
|
/**
|
|
615
|
-
*
|
|
639
|
+
* Exclude attributes with any of these tags. This filter applies to both auto-discovered and explicitly provided attributes.
|
|
616
640
|
*/
|
|
617
|
-
'
|
|
641
|
+
'excludeTags'?: Array<string>;
|
|
642
|
+
/**
|
|
643
|
+
* Optional filters to apply.
|
|
644
|
+
*/
|
|
645
|
+
'filters'?: Array<ChangeAnalysisRequestFiltersInner>;
|
|
618
646
|
/**
|
|
619
647
|
* Only include attributes with at least one of these tags. If empty, no inclusion filter is applied. This filter applies to both auto-discovered and explicitly provided attributes.
|
|
620
648
|
*/
|
|
621
649
|
'includeTags'?: Array<string>;
|
|
650
|
+
'measure': MeasureItem;
|
|
622
651
|
/**
|
|
623
|
-
*
|
|
652
|
+
* The reference time period (e.g., \'2025-01\')
|
|
624
653
|
*/
|
|
625
|
-
'
|
|
654
|
+
'referencePeriod': string;
|
|
655
|
+
/**
|
|
656
|
+
* Whether to use smart attribute selection (LLM-based) instead of discovering all valid attributes. If true, GenAI will intelligently select the most relevant attributes for change analysis. If false or not set, all valid attributes will be discovered using Calcique. Smart attribute selection applies only when no attributes are provided.
|
|
657
|
+
*/
|
|
658
|
+
'useSmartAttributeSelection'?: boolean;
|
|
626
659
|
}
|
|
660
|
+
/**
|
|
661
|
+
* @type ChangeAnalysisRequestFiltersInner
|
|
662
|
+
*/
|
|
663
|
+
export type ChangeAnalysisRequestFiltersInner = AbstractMeasureValueFilter | FilterDefinitionForSimpleMeasure | InlineFilterDefinition;
|
|
627
664
|
/**
|
|
628
665
|
* Response for change analysis computation
|
|
629
666
|
*/
|
|
@@ -643,71 +680,71 @@ export interface ChangeAnalysisResult {
|
|
|
643
680
|
* List of chat history interactions.
|
|
644
681
|
*/
|
|
645
682
|
export interface ChatHistoryInteraction {
|
|
646
|
-
|
|
647
|
-
* User question
|
|
648
|
-
*/
|
|
649
|
-
'question': string;
|
|
650
|
-
/**
|
|
651
|
-
* Chat History thread suffix appended to ID generated by backend. Enables more chat windows.
|
|
652
|
-
*/
|
|
653
|
-
'threadIdSuffix'?: string;
|
|
683
|
+
'changeAnalysisParams'?: ChangeAnalysisParams;
|
|
654
684
|
/**
|
|
655
685
|
* Chat History interaction ID. Unique ID for each interaction.
|
|
656
686
|
*/
|
|
657
687
|
'chatHistoryInteractionId': string;
|
|
688
|
+
'createdVisualizations'?: CreatedVisualizations;
|
|
689
|
+
/**
|
|
690
|
+
* Error response in anything fails.
|
|
691
|
+
*/
|
|
692
|
+
'errorResponse'?: string;
|
|
693
|
+
'foundObjects'?: FoundObjects;
|
|
658
694
|
/**
|
|
659
695
|
* Has the interaction already finished? Can be used for polling when interaction is in progress.
|
|
660
696
|
*/
|
|
661
697
|
'interactionFinished': boolean;
|
|
698
|
+
/**
|
|
699
|
+
* User question
|
|
700
|
+
*/
|
|
701
|
+
'question': string;
|
|
702
|
+
'reasoning'?: Reasoning;
|
|
662
703
|
'routing': RouteResult;
|
|
704
|
+
'semanticSearch'?: SearchResult;
|
|
663
705
|
/**
|
|
664
706
|
* Text response for general questions.
|
|
665
707
|
*/
|
|
666
708
|
'textResponse'?: string;
|
|
667
709
|
/**
|
|
668
|
-
*
|
|
710
|
+
* Chat History thread suffix appended to ID generated by backend. Enables more chat windows.
|
|
669
711
|
*/
|
|
670
|
-
'
|
|
671
|
-
'foundObjects'?: FoundObjects;
|
|
672
|
-
'semanticSearch'?: SearchResult;
|
|
673
|
-
'createdVisualizations'?: CreatedVisualizations;
|
|
674
|
-
'changeAnalysisParams'?: ChangeAnalysisParams;
|
|
712
|
+
'threadIdSuffix'?: string;
|
|
675
713
|
/**
|
|
676
714
|
* User feedback.
|
|
677
715
|
*/
|
|
678
716
|
'userFeedback'?: ChatHistoryInteractionUserFeedbackEnum;
|
|
679
|
-
'reasoning'?: Reasoning;
|
|
680
717
|
}
|
|
681
718
|
export type ChatHistoryInteractionUserFeedbackEnum = 'POSITIVE' | 'NEGATIVE' | 'NONE';
|
|
682
719
|
export interface ChatHistoryRequest {
|
|
683
|
-
/**
|
|
684
|
-
* Chat History thread suffix appended to ID generated by backend. Enables more chat windows.
|
|
685
|
-
*/
|
|
686
|
-
'threadIdSuffix'?: string;
|
|
687
720
|
/**
|
|
688
721
|
* Return chat history records only after this interaction ID. If empty, complete chat history is returned.
|
|
689
722
|
*/
|
|
690
723
|
'chatHistoryInteractionId'?: string;
|
|
691
|
-
/**
|
|
692
|
-
* User feedback.
|
|
693
|
-
*/
|
|
694
|
-
'userFeedback'?: ChatHistoryRequestUserFeedbackEnum;
|
|
695
724
|
/**
|
|
696
725
|
* User feedback.
|
|
697
726
|
*/
|
|
698
727
|
'reset'?: boolean;
|
|
699
|
-
'savedVisualization'?: SavedVisualization;
|
|
700
728
|
/**
|
|
701
729
|
* Response state indicating the outcome of the AI interaction.
|
|
702
730
|
*/
|
|
703
731
|
'responseState'?: ChatHistoryRequestResponseStateEnum;
|
|
732
|
+
'savedVisualization'?: SavedVisualization;
|
|
733
|
+
/**
|
|
734
|
+
* Chat History thread suffix appended to ID generated by backend. Enables more chat windows.
|
|
735
|
+
*/
|
|
736
|
+
'threadIdSuffix'?: string;
|
|
737
|
+
/**
|
|
738
|
+
* User feedback.
|
|
739
|
+
*/
|
|
740
|
+
'userFeedback'?: ChatHistoryRequestUserFeedbackEnum;
|
|
704
741
|
/**
|
|
705
742
|
* User text feedback for the interaction.
|
|
706
743
|
*/
|
|
707
744
|
'userTextFeedback'?: string;
|
|
708
745
|
}
|
|
709
|
-
export type ChatHistoryRequestUserFeedbackEnum = 'POSITIVE' | 'NEGATIVE' | 'NONE';
|
|
710
746
|
export type ChatHistoryRequestResponseStateEnum = 'SUCCESSFUL' | 'UNEXPECTED_ERROR' | 'NOT_FOUND_ATTRIBUTES' | 'TOO_MANY_DATA_POINTS' | 'NO_DATA' | 'NO_RESULTS' | 'OUT_OF_TOPIC';
|
|
747
|
+
export type ChatHistoryRequestUserFeedbackEnum = 'POSITIVE' | 'NEGATIVE' | 'NONE';
|
|
711
748
|
export interface ChatHistoryResult {
|
|
712
749
|
/**
|
|
713
750
|
* List of chat history interactions.
|
|
@@ -720,75 +757,75 @@ export interface ChatHistoryResult {
|
|
|
720
757
|
}
|
|
721
758
|
export interface ChatRequest {
|
|
722
759
|
/**
|
|
723
|
-
*
|
|
724
|
-
*/
|
|
725
|
-
'question': string;
|
|
726
|
-
/**
|
|
727
|
-
* Maximum number of search results.
|
|
760
|
+
* Filter relationships and search results based on allowed relationship type combinations. When specified, only relationships matching the allowed types are returned (e.g. for view-only users).
|
|
728
761
|
*/
|
|
729
|
-
'
|
|
762
|
+
'allowedRelationshipTypes'?: Array<AllowedRelationshipType>;
|
|
730
763
|
/**
|
|
731
|
-
*
|
|
764
|
+
* If true, includes hidden objects in search and visualization building. If false (default), excludes objects where isHidden=true.
|
|
732
765
|
*/
|
|
733
|
-
'
|
|
766
|
+
'includeHidden'?: boolean;
|
|
734
767
|
/**
|
|
735
768
|
* Maximum number of created results.
|
|
736
769
|
*/
|
|
737
770
|
'limitCreate'?: number;
|
|
738
771
|
/**
|
|
739
|
-
*
|
|
772
|
+
* Maximum number of relevant objects included into context for LLM (for each object type).
|
|
740
773
|
*/
|
|
741
|
-
'
|
|
742
|
-
'userContext'?: UserContext;
|
|
774
|
+
'limitCreateContext'?: number;
|
|
743
775
|
/**
|
|
744
|
-
*
|
|
776
|
+
* Maximum number of search results.
|
|
745
777
|
*/
|
|
746
|
-
'
|
|
778
|
+
'limitSearch'?: number;
|
|
747
779
|
/**
|
|
748
|
-
*
|
|
780
|
+
* List of object types to filter the search and visualization building. If empty or null, all object types are considered.
|
|
749
781
|
*/
|
|
750
|
-
'
|
|
782
|
+
'objectTypes'?: Array<ChatRequestObjectTypesEnum>;
|
|
783
|
+
/**
|
|
784
|
+
* User question
|
|
785
|
+
*/
|
|
786
|
+
'question': string;
|
|
751
787
|
/**
|
|
752
788
|
* Score, above which we return found objects. Below this score objects are not relevant.
|
|
753
789
|
*/
|
|
754
790
|
'relevantScoreThreshold'?: number;
|
|
755
791
|
/**
|
|
756
|
-
*
|
|
792
|
+
* Score, above which we return found object(s) and don\'t call LLM to create new objects.
|
|
757
793
|
*/
|
|
758
|
-
'
|
|
794
|
+
'searchScoreThreshold'?: number;
|
|
759
795
|
/**
|
|
760
|
-
*
|
|
796
|
+
* Chat History thread suffix appended to ID generated by backend. Enables more chat windows.
|
|
761
797
|
*/
|
|
762
|
-
'
|
|
798
|
+
'threadIdSuffix'?: string;
|
|
763
799
|
/**
|
|
764
|
-
*
|
|
800
|
+
* Temporary for experiments. Ratio of title score to descriptor score.
|
|
765
801
|
*/
|
|
766
|
-
'
|
|
802
|
+
'titleToDescriptorRatio'?: number;
|
|
803
|
+
'userContext'?: UserContext;
|
|
767
804
|
}
|
|
768
805
|
export type ChatRequestObjectTypesEnum = 'attribute' | 'metric' | 'fact' | 'label' | 'date' | 'dataset' | 'visualization' | 'dashboard';
|
|
769
806
|
export interface ChatResult {
|
|
770
|
-
'
|
|
807
|
+
'changeAnalysisParams'?: ChangeAnalysisParams;
|
|
771
808
|
/**
|
|
772
|
-
*
|
|
809
|
+
* Chat History interaction ID. Unique ID for each interaction.
|
|
773
810
|
*/
|
|
774
|
-
'
|
|
811
|
+
'chatHistoryInteractionId'?: string;
|
|
812
|
+
'createdVisualizations'?: CreatedVisualizations;
|
|
775
813
|
/**
|
|
776
814
|
* Error response in anything fails.
|
|
777
815
|
*/
|
|
778
816
|
'errorResponse'?: string;
|
|
779
817
|
'foundObjects'?: FoundObjects;
|
|
780
|
-
'
|
|
781
|
-
'
|
|
818
|
+
'reasoning'?: Reasoning;
|
|
819
|
+
'routing'?: RouteResult;
|
|
782
820
|
'semanticSearch'?: SearchResult;
|
|
783
821
|
/**
|
|
784
|
-
*
|
|
822
|
+
* Text response for general questions.
|
|
785
823
|
*/
|
|
786
|
-
'
|
|
824
|
+
'textResponse'?: string;
|
|
787
825
|
/**
|
|
788
|
-
* Chat History
|
|
826
|
+
* Chat History thread suffix appended to ID generated by backend. Enables more chat windows.
|
|
789
827
|
*/
|
|
790
|
-
'
|
|
791
|
-
'reasoning'?: Reasoning;
|
|
828
|
+
'threadIdSuffix'?: string;
|
|
792
829
|
/**
|
|
793
830
|
* AI usage metadata returned after the interaction (e.g. current query count vs. entitlement limit).
|
|
794
831
|
*/
|
|
@@ -833,24 +870,24 @@ export interface ClusteringRequest {
|
|
|
833
870
|
}
|
|
834
871
|
export interface ClusteringResult {
|
|
835
872
|
'attribute': Array<object>;
|
|
836
|
-
'xCoord'?: Array<number | null>;
|
|
837
|
-
'yCoord'?: Array<number | null>;
|
|
838
873
|
'clusters': Array<number | null>;
|
|
874
|
+
'xCoord'?: Array<number | null>;
|
|
839
875
|
'xcoord': Array<number>;
|
|
876
|
+
'yCoord'?: Array<number | null>;
|
|
840
877
|
'ycoord': Array<number>;
|
|
841
878
|
}
|
|
842
879
|
/**
|
|
843
880
|
* Single column projection override: applies `function(column)` to a source column.
|
|
844
881
|
*/
|
|
845
882
|
export interface ColumnExpression {
|
|
846
|
-
/**
|
|
847
|
-
* StarRocks transform applied to a source column when projecting it through the generated CREATE PIPE ... AS INSERT statement.
|
|
848
|
-
*/
|
|
849
|
-
'function': ColumnExpressionFunctionEnum;
|
|
850
883
|
/**
|
|
851
884
|
* Source column produced by parquet schema inference (after columnOverrides).
|
|
852
885
|
*/
|
|
853
886
|
'column': string;
|
|
887
|
+
/**
|
|
888
|
+
* StarRocks transform applied to a source column when projecting it through the generated CREATE PIPE ... AS INSERT statement.
|
|
889
|
+
*/
|
|
890
|
+
'function': ColumnExpressionFunctionEnum;
|
|
854
891
|
}
|
|
855
892
|
export type ColumnExpressionFunctionEnum = 'HLL_HASH' | 'BITMAP_HASH' | 'BITMAP_HASH64' | 'TO_BITMAP';
|
|
856
893
|
/**
|
|
@@ -893,19 +930,19 @@ export interface ComparisonMeasureValueFilter {
|
|
|
893
930
|
'comparisonMeasureValueFilter': ComparisonMeasureValueFilterComparisonMeasureValueFilter;
|
|
894
931
|
}
|
|
895
932
|
export interface ComparisonMeasureValueFilterComparisonMeasureValueFilter {
|
|
933
|
+
'applyOnResult'?: boolean;
|
|
896
934
|
/**
|
|
897
935
|
* References to the attributes to be used when filtering.
|
|
898
936
|
*/
|
|
899
937
|
'dimensionality'?: Array<AfmIdentifier>;
|
|
938
|
+
'localIdentifier'?: string;
|
|
939
|
+
'measure': AfmIdentifier;
|
|
940
|
+
'operator': ComparisonMeasureValueFilterComparisonMeasureValueFilterOperatorEnum;
|
|
900
941
|
/**
|
|
901
942
|
* A value that will be substituted for null values in the metric for the comparisons.
|
|
902
943
|
*/
|
|
903
944
|
'treatNullValuesAs'?: number;
|
|
904
|
-
'operator': ComparisonMeasureValueFilterComparisonMeasureValueFilterOperatorEnum;
|
|
905
945
|
'value': number;
|
|
906
|
-
'localIdentifier'?: string;
|
|
907
|
-
'applyOnResult'?: boolean;
|
|
908
|
-
'measure': AfmIdentifier;
|
|
909
946
|
}
|
|
910
947
|
export type ComparisonMeasureValueFilterComparisonMeasureValueFilterOperatorEnum = 'GREATER_THAN' | 'GREATER_THAN_OR_EQUAL_TO' | 'LESS_THAN' | 'LESS_THAN_OR_EQUAL_TO' | 'EQUAL_TO' | 'NOT_EQUAL_TO';
|
|
911
948
|
/**
|
|
@@ -915,111 +952,111 @@ export interface CompoundMeasureValueFilter {
|
|
|
915
952
|
'compoundMeasureValueFilter': CompoundMeasureValueFilterCompoundMeasureValueFilter;
|
|
916
953
|
}
|
|
917
954
|
export interface CompoundMeasureValueFilterCompoundMeasureValueFilter {
|
|
955
|
+
'applyOnResult'?: boolean;
|
|
956
|
+
/**
|
|
957
|
+
* List of conditions to apply. Conditions are combined with OR logic. Each condition can be either a comparison (e.g., > 100) or a range (e.g., BETWEEN 10 AND 50). If empty, no filtering is applied and all rows are returned.
|
|
958
|
+
*/
|
|
959
|
+
'conditions': Array<MeasureValueCondition>;
|
|
918
960
|
/**
|
|
919
961
|
* References to the attributes to be used when filtering.
|
|
920
962
|
*/
|
|
921
963
|
'dimensionality'?: Array<AfmIdentifier>;
|
|
964
|
+
'localIdentifier'?: string;
|
|
965
|
+
'measure': AfmIdentifier;
|
|
922
966
|
/**
|
|
923
967
|
* A value that will be substituted for null values in the metric for the comparisons.
|
|
924
968
|
*/
|
|
925
969
|
'treatNullValuesAs'?: number;
|
|
926
|
-
/**
|
|
927
|
-
* List of conditions to apply. Conditions are combined with OR logic. Each condition can be either a comparison (e.g., > 100) or a range (e.g., BETWEEN 10 AND 50). If empty, no filtering is applied and all rows are returned.
|
|
928
|
-
*/
|
|
929
|
-
'conditions': Array<MeasureValueCondition>;
|
|
930
|
-
'localIdentifier'?: string;
|
|
931
|
-
'applyOnResult'?: boolean;
|
|
932
|
-
'measure': AfmIdentifier;
|
|
933
970
|
}
|
|
934
971
|
/**
|
|
935
972
|
* Request to create a new pipe-backed OLAP table in the AI Lake
|
|
936
973
|
*/
|
|
937
974
|
export interface CreatePipeTableRequest {
|
|
938
975
|
/**
|
|
939
|
-
*
|
|
940
|
-
*/
|
|
941
|
-
'tableName': string;
|
|
942
|
-
/**
|
|
943
|
-
* Name of the pre-configured S3/MinIO ObjectStorage source
|
|
944
|
-
*/
|
|
945
|
-
'sourceStorageName': string;
|
|
946
|
-
/**
|
|
947
|
-
* Path prefix to the parquet files (e.g. \'my-dataset/year=2024/\'). All parquet files must be at a uniform depth under the prefix — either all directly under the prefix, or all under a consistent Hive partition hierarchy (e.g. year=2024/month=01/). Mixed layouts (files at multiple depths) are not supported.
|
|
948
|
-
*/
|
|
949
|
-
'pathPrefix': string;
|
|
950
|
-
'keyConfig'?: KeyConfig;
|
|
951
|
-
'distributionConfig'?: DistributionConfig;
|
|
952
|
-
'partitionConfig'?: PartitionConfig;
|
|
953
|
-
/**
|
|
954
|
-
* CREATE TABLE PROPERTIES key-value pairs. Defaults to {\"replication_num\": \"1\"}.
|
|
976
|
+
* Maps non-key column names to their StarRocks aggregation function (SUM, MIN, MAX, REPLACE, REPLACE_IF_NOT_NULL, HLL_UNION, BITMAP_UNION, PERCENTILE_UNION). Required for every non-key column when keyConfig type is \'aggregate\'. Ignored for other key types.
|
|
955
977
|
*/
|
|
956
|
-
'
|
|
978
|
+
'aggregationOverrides'?: {
|
|
957
979
|
[key: string]: string;
|
|
958
980
|
};
|
|
959
981
|
/**
|
|
960
|
-
*
|
|
982
|
+
* Per-target-column projection overrides. Each entry emits `<function>(<column>) AS <key>` in the SELECT list of the generated CREATE PIPE ... AS INSERT; keys absent from the map are projected as-is. Required for AGGREGATE-KEY tables that include native HLL columns (StarRocks rejects raw VARBINARY into HLL columns).
|
|
961
983
|
*/
|
|
962
|
-
'
|
|
984
|
+
'columnExpressions'?: {
|
|
985
|
+
[key: string]: ColumnExpression;
|
|
986
|
+
};
|
|
963
987
|
/**
|
|
964
988
|
* Override inferred column types. Maps column names to SQL type strings (e.g. {\"year\": \"INT\", \"event_date\": \"DATE\"}). Applied after parquet schema inference.
|
|
965
989
|
*/
|
|
966
990
|
'columnOverrides'?: {
|
|
967
991
|
[key: string]: string;
|
|
968
992
|
};
|
|
993
|
+
'distributionConfig'?: DistributionConfig;
|
|
994
|
+
'keyConfig'?: KeyConfig;
|
|
969
995
|
/**
|
|
970
|
-
*
|
|
996
|
+
* Cap VARCHAR(N) to this length when N exceeds it. 0 = no cap.
|
|
971
997
|
*/
|
|
972
|
-
'
|
|
973
|
-
|
|
974
|
-
};
|
|
998
|
+
'maxVarcharLength'?: number;
|
|
999
|
+
'partitionConfig'?: PartitionConfig;
|
|
975
1000
|
/**
|
|
976
|
-
*
|
|
1001
|
+
* Path prefix to the parquet files (e.g. \'my-dataset/year=2024/\'). All parquet files must be at a uniform depth under the prefix — either all directly under the prefix, or all under a consistent Hive partition hierarchy (e.g. year=2024/month=01/). Mixed layouts (files at multiple depths) are not supported.
|
|
977
1002
|
*/
|
|
978
|
-
'
|
|
979
|
-
[key: string]: ColumnExpression;
|
|
980
|
-
};
|
|
1003
|
+
'pathPrefix': string;
|
|
981
1004
|
/**
|
|
982
1005
|
* How often (in seconds) the pipe polls for new files. 0 or null = use server default.
|
|
983
1006
|
*/
|
|
984
1007
|
'pollingIntervalSeconds'?: number;
|
|
1008
|
+
/**
|
|
1009
|
+
* Name of the pre-configured S3/MinIO ObjectStorage source
|
|
1010
|
+
*/
|
|
1011
|
+
'sourceStorageName': string;
|
|
1012
|
+
/**
|
|
1013
|
+
* Name of the OLAP table to create. Must match ^[a-z][a-z0-9_-]{0,62}$
|
|
1014
|
+
*/
|
|
1015
|
+
'tableName': string;
|
|
1016
|
+
/**
|
|
1017
|
+
* CREATE TABLE PROPERTIES key-value pairs. Defaults to {\"replication_num\": \"1\"}.
|
|
1018
|
+
*/
|
|
1019
|
+
'tableProperties'?: {
|
|
1020
|
+
[key: string]: string;
|
|
1021
|
+
};
|
|
985
1022
|
}
|
|
986
1023
|
/**
|
|
987
1024
|
* List of created visualization objects
|
|
988
1025
|
*/
|
|
989
1026
|
export interface CreatedVisualization {
|
|
1027
|
+
'config'?: VisualizationConfig;
|
|
990
1028
|
/**
|
|
991
|
-
*
|
|
1029
|
+
* List of attributes representing the dimensionality of the new visualization
|
|
992
1030
|
*/
|
|
993
|
-
'
|
|
1031
|
+
'dimensionality': Array<DimAttribute>;
|
|
994
1032
|
/**
|
|
995
|
-
*
|
|
1033
|
+
* List of filters to be applied to the new visualization
|
|
996
1034
|
*/
|
|
997
|
-
'
|
|
1035
|
+
'filters': Array<CreatedVisualizationFiltersInner>;
|
|
998
1036
|
/**
|
|
999
|
-
*
|
|
1037
|
+
* Proposed ID of the new visualization
|
|
1000
1038
|
*/
|
|
1001
|
-
'
|
|
1039
|
+
'id': string;
|
|
1002
1040
|
/**
|
|
1003
1041
|
* List of metrics to be used in the new visualization
|
|
1004
1042
|
*/
|
|
1005
1043
|
'metrics': Array<Metric>;
|
|
1006
1044
|
/**
|
|
1007
|
-
*
|
|
1008
|
-
*/
|
|
1009
|
-
'dimensionality': Array<DimAttribute>;
|
|
1010
|
-
/**
|
|
1011
|
-
* List of filters to be applied to the new visualization
|
|
1045
|
+
* Saved visualization ID.
|
|
1012
1046
|
*/
|
|
1013
|
-
'
|
|
1047
|
+
'savedVisualizationId'?: string;
|
|
1014
1048
|
/**
|
|
1015
1049
|
* Suggestions for next steps
|
|
1016
1050
|
*/
|
|
1017
1051
|
'suggestions': Array<Suggestion>;
|
|
1018
1052
|
/**
|
|
1019
|
-
*
|
|
1053
|
+
* Proposed title of the new visualization
|
|
1020
1054
|
*/
|
|
1021
|
-
'
|
|
1022
|
-
|
|
1055
|
+
'title': string;
|
|
1056
|
+
/**
|
|
1057
|
+
* Visualization type requested in question
|
|
1058
|
+
*/
|
|
1059
|
+
'visualizationType': CreatedVisualizationVisualizationTypeEnum;
|
|
1023
1060
|
}
|
|
1024
1061
|
export type CreatedVisualizationVisualizationTypeEnum = 'TABLE' | 'HEADLINE' | 'BAR' | 'LINE' | 'PIE' | 'COLUMN' | 'SCATTER';
|
|
1025
1062
|
/**
|
|
@@ -1057,20 +1094,20 @@ export interface DashboardContext {
|
|
|
1057
1094
|
'widgets': Array<WidgetDescriptor>;
|
|
1058
1095
|
}
|
|
1059
1096
|
export interface DashboardSummaryRequestDto {
|
|
1060
|
-
'
|
|
1097
|
+
'aiModel'?: string;
|
|
1061
1098
|
'customUserPrompt'?: string;
|
|
1099
|
+
'dashboardId': string;
|
|
1100
|
+
'dryRun'?: boolean;
|
|
1062
1101
|
'gooddataHost'?: string;
|
|
1063
1102
|
'gooddataToken'?: string;
|
|
1064
1103
|
'keyMetricIds'?: Array<string>;
|
|
1065
1104
|
'referenceQuarter'?: string;
|
|
1066
|
-
'dryRun'?: boolean;
|
|
1067
1105
|
'temperature'?: number;
|
|
1068
|
-
'aiModel'?: string;
|
|
1069
1106
|
}
|
|
1070
1107
|
export interface DashboardSummaryResponseDto {
|
|
1108
|
+
'message': string;
|
|
1071
1109
|
'runId': string;
|
|
1072
1110
|
'status': string;
|
|
1073
|
-
'message': string;
|
|
1074
1111
|
}
|
|
1075
1112
|
/**
|
|
1076
1113
|
* Mapping from dimension items (either \'localIdentifier\' from \'AttributeItem\', or \"measureGroup\") to their respective values. This effectively specifies the path (location) of the data column used for sorting. Therefore values for all dimension items must be specified.
|
|
@@ -1098,10 +1135,6 @@ export interface DataColumnLocators {
|
|
|
1098
1135
|
* A single data source association for an AI Lake Database instance
|
|
1099
1136
|
*/
|
|
1100
1137
|
export interface DataSourceInfo {
|
|
1101
|
-
/**
|
|
1102
|
-
* Id of the data source association record.
|
|
1103
|
-
*/
|
|
1104
|
-
'id': string;
|
|
1105
1138
|
/**
|
|
1106
1139
|
* Identifier of the data source in metadata-api.
|
|
1107
1140
|
*/
|
|
@@ -1110,11 +1143,19 @@ export interface DataSourceInfo {
|
|
|
1110
1143
|
* Display name of the data source in metadata-api.
|
|
1111
1144
|
*/
|
|
1112
1145
|
'dataSourceName': string;
|
|
1146
|
+
/**
|
|
1147
|
+
* Id of the data source association record.
|
|
1148
|
+
*/
|
|
1149
|
+
'id': string;
|
|
1113
1150
|
}
|
|
1114
1151
|
/**
|
|
1115
1152
|
* A single AI Lake Database instance
|
|
1116
1153
|
*/
|
|
1117
1154
|
export interface DatabaseInstance {
|
|
1155
|
+
/**
|
|
1156
|
+
* All data source associations for this database instance.
|
|
1157
|
+
*/
|
|
1158
|
+
'dataSources': Array<DataSourceInfo>;
|
|
1118
1159
|
/**
|
|
1119
1160
|
* Id of the AI Lake Database instance
|
|
1120
1161
|
*/
|
|
@@ -1127,28 +1168,24 @@ export interface DatabaseInstance {
|
|
|
1127
1168
|
* Set of ids of the storage instances this database instance should access.
|
|
1128
1169
|
*/
|
|
1129
1170
|
'storageIds': Array<string>;
|
|
1130
|
-
/**
|
|
1131
|
-
* All data source associations for this database instance.
|
|
1132
|
-
*/
|
|
1133
|
-
'dataSources': Array<DataSourceInfo>;
|
|
1134
1171
|
}
|
|
1135
1172
|
export interface DateAbsoluteFilter {
|
|
1136
|
-
'using': string;
|
|
1137
1173
|
'from': string;
|
|
1138
1174
|
'to': string;
|
|
1175
|
+
'using': string;
|
|
1139
1176
|
}
|
|
1140
1177
|
/**
|
|
1141
1178
|
* @type DateFilter
|
|
1142
1179
|
* Abstract filter definition type for dates.
|
|
1143
1180
|
*/
|
|
1144
|
-
export type DateFilter = AbsoluteDateFilter | AllTimeDateFilter | RelativeDateFilter;
|
|
1181
|
+
export type DateFilter = AbsoluteDateFilter | AbsoluteGranularityDateFilter | AllTimeDateFilter | RelativeDateFilter;
|
|
1145
1182
|
export interface DateRelativeFilter {
|
|
1146
|
-
'using': string;
|
|
1147
|
-
'granularity': DateRelativeFilterGranularityEnum;
|
|
1148
1183
|
'from': number;
|
|
1184
|
+
'granularity': DateRelativeFilterGranularityEnum;
|
|
1149
1185
|
'to': number;
|
|
1186
|
+
'using': string;
|
|
1150
1187
|
}
|
|
1151
|
-
export type DateRelativeFilterGranularityEnum = '
|
|
1188
|
+
export type DateRelativeFilterGranularityEnum = 'SECOND' | 'SECOND_OF_MINUTE' | 'SECOND_OF_DAY' | 'MINUTE' | 'MINUTE_OF_HOUR' | 'MINUTE_OF_DAY' | 'HOUR' | 'HOUR_OF_DAY' | 'DAY' | 'DAY_OF_WEEK' | 'DAY_OF_MONTH' | 'DAY_OF_QUARTER' | 'DAY_OF_YEAR' | 'WEEK' | 'WEEK_OF_YEAR' | 'MONTH' | 'MONTH_OF_YEAR' | 'QUARTER' | 'QUARTER_OF_YEAR' | 'YEAR' | 'FISCAL_DAY_OF_FISCAL_WEEK' | 'FISCAL_DAY_OF_FISCAL_MONTH' | 'FISCAL_DAY_OF_FISCAL_QUARTER' | 'FISCAL_DAY_OF_FISCAL_SEMESTER' | 'FISCAL_DAY_OF_FISCAL_YEAR' | 'FISCAL_WEEK' | 'FISCAL_WEEK_OF_FISCAL_MONTH' | 'FISCAL_WEEK_OF_FISCAL_QUARTER' | 'FISCAL_WEEK_OF_FISCAL_SEMESTER' | 'FISCAL_WEEK_OF_FISCAL_YEAR' | 'FISCAL_MONTH' | 'FISCAL_MONTH_OF_FISCAL_QUARTER' | 'FISCAL_MONTH_OF_FISCAL_SEMESTER' | 'FISCAL_MONTH_OF_FISCAL_YEAR' | 'FISCAL_QUARTER' | 'FISCAL_QUARTER_OF_FISCAL_SEMESTER' | 'FISCAL_QUARTER_OF_FISCAL_YEAR' | 'FISCAL_SEMESTER' | 'FISCAL_SEMESTER_OF_FISCAL_YEAR' | 'FISCAL_YEAR';
|
|
1152
1189
|
/**
|
|
1153
1190
|
* Partition by date_trunc() expression.
|
|
1154
1191
|
*/
|
|
@@ -1167,6 +1204,10 @@ export type DateTruncPartitionConfigUnitEnum = 'year' | 'quarter' | 'month' | 'w
|
|
|
1167
1204
|
* Filter definition type specified by label and values.
|
|
1168
1205
|
*/
|
|
1169
1206
|
export interface DependsOn {
|
|
1207
|
+
/**
|
|
1208
|
+
* Inverse filtering mode.
|
|
1209
|
+
*/
|
|
1210
|
+
'complementFilter'?: boolean;
|
|
1170
1211
|
/**
|
|
1171
1212
|
* Specifies on which label the filter depends on.
|
|
1172
1213
|
*/
|
|
@@ -1175,10 +1216,6 @@ export interface DependsOn {
|
|
|
1175
1216
|
* Specifies values of the label for element filtering.
|
|
1176
1217
|
*/
|
|
1177
1218
|
'values': Array<string | null>;
|
|
1178
|
-
/**
|
|
1179
|
-
* Inverse filtering mode.
|
|
1180
|
-
*/
|
|
1181
|
-
'complementFilter'?: boolean;
|
|
1182
1219
|
}
|
|
1183
1220
|
/**
|
|
1184
1221
|
* Filter definition type for dates.
|
|
@@ -1200,28 +1237,28 @@ export interface DimAttribute {
|
|
|
1200
1237
|
* ID of the object
|
|
1201
1238
|
*/
|
|
1202
1239
|
'id': string;
|
|
1203
|
-
/**
|
|
1204
|
-
* Object type
|
|
1205
|
-
*/
|
|
1206
|
-
'type': DimAttributeTypeEnum;
|
|
1207
1240
|
/**
|
|
1208
1241
|
* Title of attribute.
|
|
1209
1242
|
*/
|
|
1210
1243
|
'title': string;
|
|
1244
|
+
/**
|
|
1245
|
+
* Object type
|
|
1246
|
+
*/
|
|
1247
|
+
'type': DimAttributeTypeEnum;
|
|
1211
1248
|
}
|
|
1212
1249
|
export type DimAttributeTypeEnum = 'attribute';
|
|
1213
1250
|
/**
|
|
1214
1251
|
* Single dimension description.
|
|
1215
1252
|
*/
|
|
1216
1253
|
export interface Dimension {
|
|
1217
|
-
/**
|
|
1218
|
-
* Dimension identification within requests. Other entities can reference this dimension by this value.
|
|
1219
|
-
*/
|
|
1220
|
-
'localIdentifier'?: string;
|
|
1221
1254
|
/**
|
|
1222
1255
|
* List of items in current dimension. Can reference \'localIdentifier\' from \'AttributeItem\', or special pseudo attribute \"measureGroup\" representing list of metrics.
|
|
1223
1256
|
*/
|
|
1224
1257
|
'itemIdentifiers': Array<string>;
|
|
1258
|
+
/**
|
|
1259
|
+
* Dimension identification within requests. Other entities can reference this dimension by this value.
|
|
1260
|
+
*/
|
|
1261
|
+
'localIdentifier'?: string;
|
|
1225
1262
|
/**
|
|
1226
1263
|
* List of sorting rules. From most relevant to least relevant (less relevant rule is applied, when more relevant rule compares items as equal).
|
|
1227
1264
|
*/
|
|
@@ -1255,58 +1292,62 @@ export interface DuplicateKeyConfig {
|
|
|
1255
1292
|
* List of returned elements.
|
|
1256
1293
|
*/
|
|
1257
1294
|
export interface Element {
|
|
1258
|
-
/**
|
|
1259
|
-
* Title of requested label.
|
|
1260
|
-
*/
|
|
1261
|
-
'title': string | null;
|
|
1262
1295
|
/**
|
|
1263
1296
|
* Title of primary label of attribute owning requested label, null if the title is null or the primary label is excluded
|
|
1264
1297
|
*/
|
|
1265
1298
|
'primaryTitle': string | null;
|
|
1299
|
+
/**
|
|
1300
|
+
* Title of requested label.
|
|
1301
|
+
*/
|
|
1302
|
+
'title': string | null;
|
|
1266
1303
|
}
|
|
1267
1304
|
export interface ElementsRequest {
|
|
1268
1305
|
/**
|
|
1269
|
-
*
|
|
1306
|
+
* If specified, the element data will be taken from the result with the same cacheId if it is available.
|
|
1270
1307
|
*/
|
|
1271
|
-
'
|
|
1308
|
+
'cacheId'?: string;
|
|
1309
|
+
/**
|
|
1310
|
+
* Inverse filters: * ```false``` - return items matching ```patternFilter``` and ```exactFilter``` * ```true``` - return items not matching ```patternFilter``` and ```exactFilter```
|
|
1311
|
+
*/
|
|
1312
|
+
'complementFilter'?: boolean;
|
|
1313
|
+
/**
|
|
1314
|
+
* Specifies percentage of source table data scanned during the computation. This field is deprecated and is no longer used during the elements computation.
|
|
1315
|
+
* @deprecated
|
|
1316
|
+
*/
|
|
1317
|
+
'dataSamplingPercentage'?: number;
|
|
1318
|
+
/**
|
|
1319
|
+
* Return only items that are not filtered-out by the parent filters.
|
|
1320
|
+
*/
|
|
1321
|
+
'dependsOn'?: Array<ElementsRequestDependsOnInner>;
|
|
1322
|
+
/**
|
|
1323
|
+
* Return only items, whose ```label``` title exactly matches one of ```filter```.
|
|
1324
|
+
*/
|
|
1325
|
+
'exactFilter'?: Array<string | null>;
|
|
1272
1326
|
/**
|
|
1273
1327
|
* Excludes items from the result that differ only by primary label * ```false``` - return items with distinct primary label * ```true``` - return items with distinct requested label
|
|
1274
1328
|
*/
|
|
1275
1329
|
'excludePrimaryLabel'?: boolean;
|
|
1276
1330
|
'filterBy'?: FilterBy;
|
|
1277
1331
|
/**
|
|
1278
|
-
*
|
|
1279
|
-
*/
|
|
1280
|
-
'sortOrder'?: ElementsRequestSortOrderEnum;
|
|
1281
|
-
/**
|
|
1282
|
-
* Inverse filters: * ```false``` - return items matching ```patternFilter``` and ```exactFilter``` * ```true``` - return items not matching ```patternFilter``` and ```exactFilter```
|
|
1332
|
+
* Requested label.
|
|
1283
1333
|
*/
|
|
1284
|
-
'
|
|
1334
|
+
'label': string;
|
|
1285
1335
|
/**
|
|
1286
1336
|
* Return only items, whose ```label``` title case insensitively contains ```filter``` as substring.
|
|
1287
1337
|
*/
|
|
1288
1338
|
'patternFilter'?: string;
|
|
1289
1339
|
/**
|
|
1290
|
-
*
|
|
1340
|
+
* Sort order of returned items. Items are sorted by ```label``` title. If no sort order is specified then attribute\'s ```sortDirection``` is used, which is ASC by default
|
|
1291
1341
|
*/
|
|
1292
|
-
'
|
|
1342
|
+
'sortOrder'?: ElementsRequestSortOrderEnum;
|
|
1293
1343
|
/**
|
|
1294
|
-
*
|
|
1344
|
+
* Time zone (IANA id, e.g. \"Europe/Prague\") used to resolve relative date filters in ```dependsOn```. If set it takes precedence over the workspace/user time zone setting; if not set the setting is used.
|
|
1295
1345
|
*/
|
|
1296
|
-
'
|
|
1346
|
+
'timezone'?: string;
|
|
1297
1347
|
/**
|
|
1298
1348
|
* Return only items that are computable on metric.
|
|
1299
1349
|
*/
|
|
1300
1350
|
'validateBy'?: Array<ValidateByItem>;
|
|
1301
|
-
/**
|
|
1302
|
-
* Specifies percentage of source table data scanned during the computation. This field is deprecated and is no longer used during the elements computation.
|
|
1303
|
-
* @deprecated
|
|
1304
|
-
*/
|
|
1305
|
-
'dataSamplingPercentage'?: number;
|
|
1306
|
-
/**
|
|
1307
|
-
* If specified, the element data will be taken from the result with the same cacheId if it is available.
|
|
1308
|
-
*/
|
|
1309
|
-
'cacheId'?: string;
|
|
1310
1351
|
}
|
|
1311
1352
|
export type ElementsRequestSortOrderEnum = 'ASC' | 'DESC';
|
|
1312
1353
|
/**
|
|
@@ -1317,35 +1358,35 @@ export type ElementsRequestDependsOnInner = DependsOn | DependsOnDateFilter | De
|
|
|
1317
1358
|
* Entity holding list of sorted & filtered label elements, related primary label of attribute owning requested label and paging.
|
|
1318
1359
|
*/
|
|
1319
1360
|
export interface ElementsResponse {
|
|
1320
|
-
|
|
1361
|
+
/**
|
|
1362
|
+
* The client can use this in subsequent requests (like paging or search) to get results from the same point in time as the previous request. This is useful when the underlying data source has caches disabled and the client wants to avoid seeing inconsistent results and to also avoid excessive queries to the database itself.
|
|
1363
|
+
*/
|
|
1364
|
+
'cacheId'?: string;
|
|
1321
1365
|
/**
|
|
1322
1366
|
* List of returned elements.
|
|
1323
1367
|
*/
|
|
1324
1368
|
'elements': Array<Element>;
|
|
1325
|
-
'
|
|
1369
|
+
'format'?: AttributeFormat;
|
|
1326
1370
|
/**
|
|
1327
1371
|
* Granularity of requested label in case of date attribute
|
|
1328
1372
|
*/
|
|
1329
1373
|
'granularity'?: ElementsResponseGranularityEnum;
|
|
1330
|
-
'
|
|
1331
|
-
|
|
1332
|
-
* The client can use this in subsequent requests (like paging or search) to get results from the same point in time as the previous request. This is useful when the underlying data source has caches disabled and the client wants to avoid seeing inconsistent results and to also avoid excessive queries to the database itself.
|
|
1333
|
-
*/
|
|
1334
|
-
'cacheId'?: string;
|
|
1374
|
+
'paging': Paging;
|
|
1375
|
+
'primaryLabel': RestApiIdentifier;
|
|
1335
1376
|
}
|
|
1336
|
-
export type ElementsResponseGranularityEnum = '
|
|
1377
|
+
export type ElementsResponseGranularityEnum = 'SECOND' | 'SECOND_OF_MINUTE' | 'SECOND_OF_DAY' | 'MINUTE' | 'MINUTE_OF_HOUR' | 'MINUTE_OF_DAY' | 'HOUR' | 'HOUR_OF_DAY' | 'DAY' | 'DAY_OF_WEEK' | 'DAY_OF_MONTH' | 'DAY_OF_QUARTER' | 'DAY_OF_YEAR' | 'WEEK' | 'WEEK_OF_YEAR' | 'MONTH' | 'MONTH_OF_YEAR' | 'QUARTER' | 'QUARTER_OF_YEAR' | 'YEAR' | 'FISCAL_DAY_OF_FISCAL_WEEK' | 'FISCAL_DAY_OF_FISCAL_MONTH' | 'FISCAL_DAY_OF_FISCAL_QUARTER' | 'FISCAL_DAY_OF_FISCAL_SEMESTER' | 'FISCAL_DAY_OF_FISCAL_YEAR' | 'FISCAL_WEEK' | 'FISCAL_WEEK_OF_FISCAL_MONTH' | 'FISCAL_WEEK_OF_FISCAL_QUARTER' | 'FISCAL_WEEK_OF_FISCAL_SEMESTER' | 'FISCAL_WEEK_OF_FISCAL_YEAR' | 'FISCAL_MONTH' | 'FISCAL_MONTH_OF_FISCAL_QUARTER' | 'FISCAL_MONTH_OF_FISCAL_SEMESTER' | 'FISCAL_MONTH_OF_FISCAL_YEAR' | 'FISCAL_QUARTER' | 'FISCAL_QUARTER_OF_FISCAL_SEMESTER' | 'FISCAL_QUARTER_OF_FISCAL_YEAR' | 'FISCAL_SEMESTER' | 'FISCAL_SEMESTER_OF_FISCAL_YEAR' | 'FISCAL_YEAR';
|
|
1337
1378
|
/**
|
|
1338
1379
|
* Structured error, present when the search could not run (e.g. metadata sync in progress). Absent on success.
|
|
1339
1380
|
*/
|
|
1340
1381
|
export interface ErrorInfo {
|
|
1341
|
-
/**
|
|
1342
|
-
* HTTP-like semantic status (e.g. 503 when the workspace is still syncing).
|
|
1343
|
-
*/
|
|
1344
|
-
'statusCode': number;
|
|
1345
1382
|
/**
|
|
1346
1383
|
* Stable machine-readable error code. Switch on this for localized client messages.
|
|
1347
1384
|
*/
|
|
1348
1385
|
'reason': string;
|
|
1386
|
+
/**
|
|
1387
|
+
* HTTP-like semantic status (e.g. 503 when the workspace is still syncing).
|
|
1388
|
+
*/
|
|
1389
|
+
'statusCode': number;
|
|
1349
1390
|
}
|
|
1350
1391
|
/**
|
|
1351
1392
|
* Links to the execution result.
|
|
@@ -1379,8 +1420,8 @@ export interface ExecutionResult {
|
|
|
1379
1420
|
*/
|
|
1380
1421
|
'dimensionHeaders': Array<DimensionHeader>;
|
|
1381
1422
|
'grandTotals': Array<ExecutionResultGrandTotal>;
|
|
1382
|
-
'paging': ExecutionResultPaging;
|
|
1383
1423
|
'metadata': ExecutionResultMetadata;
|
|
1424
|
+
'paging': ExecutionResultPaging;
|
|
1384
1425
|
}
|
|
1385
1426
|
/**
|
|
1386
1427
|
* A piece of extra information related to the results (e.g. debug information, warnings, etc.).
|
|
@@ -1390,6 +1431,10 @@ export interface ExecutionResultDataSourceMessage {
|
|
|
1390
1431
|
* Id correlating different pieces of supplementary info together.
|
|
1391
1432
|
*/
|
|
1392
1433
|
'correlationId': string;
|
|
1434
|
+
/**
|
|
1435
|
+
* Data of this particular supplementary info item: a free-form JSON specific to the particular supplementary info item type.
|
|
1436
|
+
*/
|
|
1437
|
+
'data'?: object;
|
|
1393
1438
|
/**
|
|
1394
1439
|
* Information about what part of the system created this piece of supplementary info.
|
|
1395
1440
|
*/
|
|
@@ -1398,10 +1443,6 @@ export interface ExecutionResultDataSourceMessage {
|
|
|
1398
1443
|
* Type of the supplementary info instance. There are currently no well-known values for this, but there might be some in the future.
|
|
1399
1444
|
*/
|
|
1400
1445
|
'type': string;
|
|
1401
|
-
/**
|
|
1402
|
-
* Data of this particular supplementary info item: a free-form JSON specific to the particular supplementary info item type.
|
|
1403
|
-
*/
|
|
1404
|
-
'data'?: object;
|
|
1405
1446
|
}
|
|
1406
1447
|
/**
|
|
1407
1448
|
* Contains the data of grand totals with the same dimensions.
|
|
@@ -1429,14 +1470,14 @@ export type ExecutionResultHeader = AttributeExecutionResultHeader | MeasureExec
|
|
|
1429
1470
|
* Describes a limit that was broken, resulting in partial data being returned.
|
|
1430
1471
|
*/
|
|
1431
1472
|
export interface ExecutionResultLimitBreak {
|
|
1432
|
-
/**
|
|
1433
|
-
* Type of the limit that was broken, e.g. \"rowCount\".
|
|
1434
|
-
*/
|
|
1435
|
-
'limitType': string;
|
|
1436
1473
|
/**
|
|
1437
1474
|
* The configured threshold value.
|
|
1438
1475
|
*/
|
|
1439
1476
|
'limit': number;
|
|
1477
|
+
/**
|
|
1478
|
+
* Type of the limit that was broken, e.g. \"rowCount\".
|
|
1479
|
+
*/
|
|
1480
|
+
'limitType': string;
|
|
1440
1481
|
/**
|
|
1441
1482
|
* The actual value that triggered the limit; null when it cannot be determined exactly.
|
|
1442
1483
|
*/
|
|
@@ -1484,6 +1525,10 @@ export interface ExecutionSettings {
|
|
|
1484
1525
|
* Specifies the timestamp of the execution from which relative filters are resolved. If not set, the current time is used.
|
|
1485
1526
|
*/
|
|
1486
1527
|
'timestamp'?: string;
|
|
1528
|
+
/**
|
|
1529
|
+
* Specifies the time zone used to resolve relative date filters and to convert time-zone-aware date/time values in the result. Expects an IANA time zone id (e.g. \"Europe/Prague\") or a fixed GMT offset (e.g. \"GMT+02:00\"). If not set, the time zone from the workspace/user settings is used.
|
|
1530
|
+
*/
|
|
1531
|
+
'timezone'?: string;
|
|
1487
1532
|
}
|
|
1488
1533
|
/**
|
|
1489
1534
|
* Operation that has failed
|
|
@@ -1509,7 +1554,7 @@ export type FilterByLabelTypeEnum = 'PRIMARY' | 'REQUESTED';
|
|
|
1509
1554
|
* @type FilterDefinition
|
|
1510
1555
|
* Abstract filter definition type
|
|
1511
1556
|
*/
|
|
1512
|
-
export type FilterDefinition = AbsoluteDateFilter | AllTimeDateFilter | ComparisonMeasureValueFilter | CompoundMeasureValueFilter | InlineFilterDefinition | MatchAttributeFilter | NegativeAttributeFilter | PositiveAttributeFilter | RangeMeasureValueFilter | RankingFilter | RelativeDateFilter;
|
|
1557
|
+
export type FilterDefinition = AbsoluteDateFilter | AbsoluteGranularityDateFilter | AllTimeDateFilter | ComparisonMeasureValueFilter | CompoundMeasureValueFilter | InlineFilterDefinition | MatchAttributeFilter | NegativeAttributeFilter | PositiveAttributeFilter | RangeMeasureValueFilter | RankingFilter | RelativeDateFilter;
|
|
1513
1558
|
/**
|
|
1514
1559
|
* @type FilterDefinitionForSimpleMeasure
|
|
1515
1560
|
* Abstract filter definition type for simple metric.
|
|
@@ -1519,28 +1564,28 @@ export type FilterDefinitionForSimpleMeasure = AttributeFilter | DateFilter;
|
|
|
1519
1564
|
* Forecast configuration.
|
|
1520
1565
|
*/
|
|
1521
1566
|
export interface ForecastConfig {
|
|
1522
|
-
/**
|
|
1523
|
-
* Number of future periods that should be forecasted
|
|
1524
|
-
*/
|
|
1525
|
-
'forecastPeriod': number;
|
|
1526
1567
|
/**
|
|
1527
1568
|
* Confidence interval boundary value.
|
|
1528
1569
|
*/
|
|
1529
1570
|
'confidenceLevel': number;
|
|
1571
|
+
/**
|
|
1572
|
+
* Number of future periods that should be forecasted
|
|
1573
|
+
*/
|
|
1574
|
+
'forecastPeriod': number;
|
|
1530
1575
|
/**
|
|
1531
1576
|
* Whether the input data is seasonal
|
|
1532
1577
|
*/
|
|
1533
1578
|
'seasonal': boolean;
|
|
1534
1579
|
}
|
|
1535
1580
|
export interface ForecastRequest {
|
|
1536
|
-
/**
|
|
1537
|
-
* Number of future periods that should be forecasted
|
|
1538
|
-
*/
|
|
1539
|
-
'forecastPeriod': number;
|
|
1540
1581
|
/**
|
|
1541
1582
|
* Confidence interval boundary value.
|
|
1542
1583
|
*/
|
|
1543
1584
|
'confidenceLevel'?: number;
|
|
1585
|
+
/**
|
|
1586
|
+
* Number of future periods that should be forecasted
|
|
1587
|
+
*/
|
|
1588
|
+
'forecastPeriod': number;
|
|
1544
1589
|
/**
|
|
1545
1590
|
* Whether the input data is seasonal
|
|
1546
1591
|
*/
|
|
@@ -1548,9 +1593,9 @@ export interface ForecastRequest {
|
|
|
1548
1593
|
}
|
|
1549
1594
|
export interface ForecastResult {
|
|
1550
1595
|
'attribute': Array<string>;
|
|
1596
|
+
'lowerBound': Array<number | null>;
|
|
1551
1597
|
'origin': Array<number | null>;
|
|
1552
1598
|
'prediction': Array<number | null>;
|
|
1553
|
-
'lowerBound': Array<number | null>;
|
|
1554
1599
|
'upperBound': Array<number | null>;
|
|
1555
1600
|
}
|
|
1556
1601
|
/**
|
|
@@ -1567,14 +1612,14 @@ export interface FoundObjects {
|
|
|
1567
1612
|
'reasoning': string;
|
|
1568
1613
|
}
|
|
1569
1614
|
export interface GenerateDescriptionRequest {
|
|
1570
|
-
/**
|
|
1571
|
-
* Type of the object to describe. One of: visualization, dashboard, metric, fact, attribute
|
|
1572
|
-
*/
|
|
1573
|
-
'objectType': GenerateDescriptionRequestObjectTypeEnum;
|
|
1574
1615
|
/**
|
|
1575
1616
|
* Identifier of the object to describe
|
|
1576
1617
|
*/
|
|
1577
1618
|
'objectId': string;
|
|
1619
|
+
/**
|
|
1620
|
+
* Type of the object to describe. One of: visualization, dashboard, metric, fact, attribute
|
|
1621
|
+
*/
|
|
1622
|
+
'objectType': GenerateDescriptionRequestObjectTypeEnum;
|
|
1578
1623
|
}
|
|
1579
1624
|
export type GenerateDescriptionRequestObjectTypeEnum = 'Visualization' | 'Dashboard' | 'Metric' | 'Fact' | 'Attribute';
|
|
1580
1625
|
export interface GenerateDescriptionResponse {
|
|
@@ -1588,25 +1633,25 @@ export interface GenerateDescriptionResponse {
|
|
|
1588
1633
|
'note'?: string;
|
|
1589
1634
|
}
|
|
1590
1635
|
export interface GenerateTitleRequest {
|
|
1591
|
-
/**
|
|
1592
|
-
* Type of the object to title. Matches chat-search object types.
|
|
1593
|
-
*/
|
|
1594
|
-
'objectType': GenerateTitleRequestObjectTypeEnum;
|
|
1595
1636
|
/**
|
|
1596
1637
|
* Identifier of the object to title
|
|
1597
1638
|
*/
|
|
1598
1639
|
'objectId': string;
|
|
1640
|
+
/**
|
|
1641
|
+
* Type of the object to title. Matches chat-search object types.
|
|
1642
|
+
*/
|
|
1643
|
+
'objectType': GenerateTitleRequestObjectTypeEnum;
|
|
1599
1644
|
}
|
|
1600
1645
|
export type GenerateTitleRequestObjectTypeEnum = 'Visualization' | 'Dashboard' | 'Metric' | 'Fact' | 'Attribute';
|
|
1601
1646
|
export interface GenerateTitleResponse {
|
|
1602
|
-
/**
|
|
1603
|
-
* Generated title of the requested object
|
|
1604
|
-
*/
|
|
1605
|
-
'title'?: string;
|
|
1606
1647
|
/**
|
|
1607
1648
|
* Additional note with details in case generation was not performed
|
|
1608
1649
|
*/
|
|
1609
1650
|
'note'?: string;
|
|
1651
|
+
/**
|
|
1652
|
+
* Generated title of the requested object
|
|
1653
|
+
*/
|
|
1654
|
+
'title'?: string;
|
|
1610
1655
|
}
|
|
1611
1656
|
/**
|
|
1612
1657
|
* Configuration specific to geo area labels.
|
|
@@ -1634,14 +1679,14 @@ export interface GetQualityIssuesResponse {
|
|
|
1634
1679
|
* List of quality issues found in the workspace
|
|
1635
1680
|
*/
|
|
1636
1681
|
'issues': Array<QualityIssue>;
|
|
1637
|
-
/**
|
|
1638
|
-
* Timestamp when the quality issues were last updated (ISO format)
|
|
1639
|
-
*/
|
|
1640
|
-
'updatedAt'?: string;
|
|
1641
1682
|
/**
|
|
1642
1683
|
* Status of the latest triggered quality check process
|
|
1643
1684
|
*/
|
|
1644
1685
|
'status': GetQualityIssuesResponseStatusEnum;
|
|
1686
|
+
/**
|
|
1687
|
+
* Timestamp when the quality issues were last updated (ISO format)
|
|
1688
|
+
*/
|
|
1689
|
+
'updatedAt'?: string;
|
|
1645
1690
|
}
|
|
1646
1691
|
export type GetQualityIssuesResponseStatusEnum = 'RUNNING' | 'SYNCING' | 'COMPLETED' | 'FAILED' | 'CANCELLED' | 'NOT_FOUND' | 'DISABLED';
|
|
1647
1692
|
/**
|
|
@@ -1657,14 +1702,14 @@ export interface GetServiceStatusResponse {
|
|
|
1657
1702
|
* Hash-based distribution across buckets.
|
|
1658
1703
|
*/
|
|
1659
1704
|
export interface HashDistributionConfig {
|
|
1660
|
-
/**
|
|
1661
|
-
* Columns to distribute by. Defaults to first column.
|
|
1662
|
-
*/
|
|
1663
|
-
'columns'?: Array<string>;
|
|
1664
1705
|
/**
|
|
1665
1706
|
* Number of hash buckets. Defaults to 1.
|
|
1666
1707
|
*/
|
|
1667
1708
|
'buckets'?: number;
|
|
1709
|
+
/**
|
|
1710
|
+
* Columns to distribute by. Defaults to first column.
|
|
1711
|
+
*/
|
|
1712
|
+
'columns'?: Array<string>;
|
|
1668
1713
|
}
|
|
1669
1714
|
/**
|
|
1670
1715
|
* Contains the information specific for a group of headers. These groups correlate to attributes and metric groups.
|
|
@@ -1682,12 +1727,12 @@ export interface InlineFilterDefinition {
|
|
|
1682
1727
|
'inline': InlineFilterDefinitionInline;
|
|
1683
1728
|
}
|
|
1684
1729
|
export interface InlineFilterDefinitionInline {
|
|
1730
|
+
'applyOnResult'?: boolean;
|
|
1685
1731
|
/**
|
|
1686
1732
|
* MAQL query representing the filter.
|
|
1687
1733
|
*/
|
|
1688
1734
|
'filter': string;
|
|
1689
1735
|
'localIdentifier'?: string;
|
|
1690
|
-
'applyOnResult'?: boolean;
|
|
1691
1736
|
}
|
|
1692
1737
|
/**
|
|
1693
1738
|
* Metric defined by the raw MAQL query.
|
|
@@ -1705,14 +1750,6 @@ export interface InlineMeasureDefinitionInline {
|
|
|
1705
1750
|
* Insight widget displaying a visualization.
|
|
1706
1751
|
*/
|
|
1707
1752
|
export interface InsightWidgetDescriptor {
|
|
1708
|
-
/**
|
|
1709
|
-
* Widget object ID.
|
|
1710
|
-
*/
|
|
1711
|
-
'widgetId': string;
|
|
1712
|
-
/**
|
|
1713
|
-
* Widget title as displayed on the dashboard.
|
|
1714
|
-
*/
|
|
1715
|
-
'title': string;
|
|
1716
1753
|
/**
|
|
1717
1754
|
* Filters currently applied to the dashboard.
|
|
1718
1755
|
*/
|
|
@@ -1721,10 +1758,18 @@ export interface InsightWidgetDescriptor {
|
|
|
1721
1758
|
* Signed result ID for this widget\'s cached execution result.
|
|
1722
1759
|
*/
|
|
1723
1760
|
'resultId'?: string;
|
|
1761
|
+
/**
|
|
1762
|
+
* Widget title as displayed on the dashboard.
|
|
1763
|
+
*/
|
|
1764
|
+
'title': string;
|
|
1724
1765
|
/**
|
|
1725
1766
|
* Visualization object ID referenced by this insight widget.
|
|
1726
1767
|
*/
|
|
1727
1768
|
'visualizationId': string;
|
|
1769
|
+
/**
|
|
1770
|
+
* Widget object ID.
|
|
1771
|
+
*/
|
|
1772
|
+
'widgetId': string;
|
|
1728
1773
|
}
|
|
1729
1774
|
/**
|
|
1730
1775
|
* JSON:API-compatible single-resource response envelope
|
|
@@ -1744,6 +1789,7 @@ export interface JsonApiDocumentPipeTable {
|
|
|
1744
1789
|
* A single JSON:API resource item
|
|
1745
1790
|
*/
|
|
1746
1791
|
export interface JsonApiItemDataSourceInfo {
|
|
1792
|
+
'attributes': DataSourceInfo;
|
|
1747
1793
|
/**
|
|
1748
1794
|
* Resource identifier
|
|
1749
1795
|
*/
|
|
@@ -1752,12 +1798,12 @@ export interface JsonApiItemDataSourceInfo {
|
|
|
1752
1798
|
* Resource type
|
|
1753
1799
|
*/
|
|
1754
1800
|
'type': string;
|
|
1755
|
-
'attributes': DataSourceInfo;
|
|
1756
1801
|
}
|
|
1757
1802
|
/**
|
|
1758
1803
|
* A single JSON:API resource item
|
|
1759
1804
|
*/
|
|
1760
1805
|
export interface JsonApiItemDatabaseInstance {
|
|
1806
|
+
'attributes': DatabaseInstance;
|
|
1761
1807
|
/**
|
|
1762
1808
|
* Resource identifier
|
|
1763
1809
|
*/
|
|
@@ -1766,12 +1812,12 @@ export interface JsonApiItemDatabaseInstance {
|
|
|
1766
1812
|
* Resource type
|
|
1767
1813
|
*/
|
|
1768
1814
|
'type': string;
|
|
1769
|
-
'attributes': DatabaseInstance;
|
|
1770
1815
|
}
|
|
1771
1816
|
/**
|
|
1772
1817
|
* A single JSON:API resource item
|
|
1773
1818
|
*/
|
|
1774
1819
|
export interface JsonApiItemObjectStorageInfo {
|
|
1820
|
+
'attributes': ObjectStorageInfo;
|
|
1775
1821
|
/**
|
|
1776
1822
|
* Resource identifier
|
|
1777
1823
|
*/
|
|
@@ -1780,12 +1826,12 @@ export interface JsonApiItemObjectStorageInfo {
|
|
|
1780
1826
|
* Resource type
|
|
1781
1827
|
*/
|
|
1782
1828
|
'type': string;
|
|
1783
|
-
'attributes': ObjectStorageInfo;
|
|
1784
1829
|
}
|
|
1785
1830
|
/**
|
|
1786
1831
|
* A single JSON:API resource item
|
|
1787
1832
|
*/
|
|
1788
1833
|
export interface JsonApiItemPipeTable {
|
|
1834
|
+
'attributes': PipeTable;
|
|
1789
1835
|
/**
|
|
1790
1836
|
* Resource identifier
|
|
1791
1837
|
*/
|
|
@@ -1794,12 +1840,12 @@ export interface JsonApiItemPipeTable {
|
|
|
1794
1840
|
* Resource type
|
|
1795
1841
|
*/
|
|
1796
1842
|
'type': string;
|
|
1797
|
-
'attributes': PipeTable;
|
|
1798
1843
|
}
|
|
1799
1844
|
/**
|
|
1800
1845
|
* A single JSON:API resource item
|
|
1801
1846
|
*/
|
|
1802
1847
|
export interface JsonApiItemPipeTableSummary {
|
|
1848
|
+
'attributes': PipeTableSummary;
|
|
1803
1849
|
/**
|
|
1804
1850
|
* Resource identifier
|
|
1805
1851
|
*/
|
|
@@ -1808,12 +1854,12 @@ export interface JsonApiItemPipeTableSummary {
|
|
|
1808
1854
|
* Resource type
|
|
1809
1855
|
*/
|
|
1810
1856
|
'type': string;
|
|
1811
|
-
'attributes': PipeTableSummary;
|
|
1812
1857
|
}
|
|
1813
1858
|
/**
|
|
1814
1859
|
* A single JSON:API resource item
|
|
1815
1860
|
*/
|
|
1816
1861
|
export interface JsonApiItemServiceInfo {
|
|
1862
|
+
'attributes': ServiceInfo;
|
|
1817
1863
|
/**
|
|
1818
1864
|
* Resource identifier
|
|
1819
1865
|
*/
|
|
@@ -1822,7 +1868,6 @@ export interface JsonApiItemServiceInfo {
|
|
|
1822
1868
|
* Resource type
|
|
1823
1869
|
*/
|
|
1824
1870
|
'type': string;
|
|
1825
|
-
'attributes': ServiceInfo;
|
|
1826
1871
|
}
|
|
1827
1872
|
/**
|
|
1828
1873
|
* JSON:API-compatible list response envelope
|
|
@@ -1922,22 +1967,22 @@ export interface KeyConfig {
|
|
|
1922
1967
|
'type': string;
|
|
1923
1968
|
}
|
|
1924
1969
|
export interface KeyDriversDimension {
|
|
1925
|
-
'label': RestApiIdentifier;
|
|
1926
|
-
'labelName': string;
|
|
1927
1970
|
'attribute': RestApiIdentifier;
|
|
1928
1971
|
'attributeName': string;
|
|
1929
|
-
'granularity'?: KeyDriversDimensionGranularityEnum;
|
|
1930
1972
|
'format'?: AttributeFormat;
|
|
1973
|
+
'granularity'?: KeyDriversDimensionGranularityEnum;
|
|
1974
|
+
'label': RestApiIdentifier;
|
|
1975
|
+
'labelName': string;
|
|
1931
1976
|
'valueType'?: KeyDriversDimensionValueTypeEnum;
|
|
1932
1977
|
}
|
|
1933
|
-
export type KeyDriversDimensionGranularityEnum = '
|
|
1978
|
+
export type KeyDriversDimensionGranularityEnum = 'SECOND' | 'SECOND_OF_MINUTE' | 'SECOND_OF_DAY' | 'MINUTE' | 'MINUTE_OF_HOUR' | 'MINUTE_OF_DAY' | 'HOUR' | 'HOUR_OF_DAY' | 'DAY' | 'DAY_OF_WEEK' | 'DAY_OF_MONTH' | 'DAY_OF_QUARTER' | 'DAY_OF_YEAR' | 'WEEK' | 'WEEK_OF_YEAR' | 'MONTH' | 'MONTH_OF_YEAR' | 'QUARTER' | 'QUARTER_OF_YEAR' | 'YEAR' | 'FISCAL_DAY_OF_FISCAL_WEEK' | 'FISCAL_DAY_OF_FISCAL_MONTH' | 'FISCAL_DAY_OF_FISCAL_QUARTER' | 'FISCAL_DAY_OF_FISCAL_SEMESTER' | 'FISCAL_DAY_OF_FISCAL_YEAR' | 'FISCAL_WEEK' | 'FISCAL_WEEK_OF_FISCAL_MONTH' | 'FISCAL_WEEK_OF_FISCAL_QUARTER' | 'FISCAL_WEEK_OF_FISCAL_SEMESTER' | 'FISCAL_WEEK_OF_FISCAL_YEAR' | 'FISCAL_MONTH' | 'FISCAL_MONTH_OF_FISCAL_QUARTER' | 'FISCAL_MONTH_OF_FISCAL_SEMESTER' | 'FISCAL_MONTH_OF_FISCAL_YEAR' | 'FISCAL_QUARTER' | 'FISCAL_QUARTER_OF_FISCAL_SEMESTER' | 'FISCAL_QUARTER_OF_FISCAL_YEAR' | 'FISCAL_SEMESTER' | 'FISCAL_SEMESTER_OF_FISCAL_YEAR' | 'FISCAL_YEAR';
|
|
1934
1979
|
export type KeyDriversDimensionValueTypeEnum = 'TEXT' | 'HYPERLINK' | 'GEO' | 'GEO_LONGITUDE' | 'GEO_LATITUDE' | 'GEO_AREA' | 'GEO_ICON' | 'IMAGE' | 'HYPERLOGLOG';
|
|
1935
1980
|
export interface KeyDriversRequest {
|
|
1936
|
-
'metric': MeasureItem;
|
|
1937
1981
|
/**
|
|
1938
1982
|
* Additional metrics to be included in the computation, but excluded from the analysis.
|
|
1939
1983
|
*/
|
|
1940
1984
|
'auxMetrics'?: Array<MeasureItem>;
|
|
1985
|
+
'metric': MeasureItem;
|
|
1941
1986
|
/**
|
|
1942
1987
|
* Sorting elements - ascending/descending order.
|
|
1943
1988
|
*/
|
|
@@ -1952,38 +1997,38 @@ export interface KeyDriversResult {
|
|
|
1952
1997
|
'data': object;
|
|
1953
1998
|
}
|
|
1954
1999
|
export interface KnowledgeRecommendationsRequestDto {
|
|
1955
|
-
'
|
|
1956
|
-
'
|
|
2000
|
+
'aiModel'?: string;
|
|
2001
|
+
'analyticalDashboardId'?: string;
|
|
2002
|
+
'analyzedValue'?: number;
|
|
1957
2003
|
'comparisonType': KnowledgeRecommendationsRequestDtoComparisonTypeEnum;
|
|
2004
|
+
'direction'?: KnowledgeRecommendationsRequestDtoDirectionEnum;
|
|
2005
|
+
'dryRun'?: boolean;
|
|
2006
|
+
'gooddataHost'?: string;
|
|
2007
|
+
'gooddataToken'?: string;
|
|
1958
2008
|
'limit'?: number;
|
|
2009
|
+
'maxTokens'?: number;
|
|
2010
|
+
'metricId': string;
|
|
1959
2011
|
'minScore'?: number;
|
|
1960
|
-
'
|
|
2012
|
+
'referenceValue'?: number;
|
|
1961
2013
|
'temperature'?: number;
|
|
1962
|
-
'maxTokens'?: number;
|
|
1963
|
-
'gooddataHost'?: string;
|
|
1964
|
-
'gooddataToken'?: string;
|
|
1965
|
-
'analyticalDashboardId'?: string;
|
|
1966
2014
|
'widgetId'?: string;
|
|
1967
2015
|
'widgetName'?: string;
|
|
1968
|
-
'dryRun'?: boolean;
|
|
1969
|
-
'referenceValue'?: number;
|
|
1970
|
-
'analyzedValue'?: number;
|
|
1971
2016
|
}
|
|
1972
|
-
export type KnowledgeRecommendationsRequestDtoDirectionEnum = 'INCREASED' | 'DECREASED';
|
|
1973
2017
|
export type KnowledgeRecommendationsRequestDtoComparisonTypeEnum = 'MONTH' | 'QUARTER' | 'YEAR';
|
|
2018
|
+
export type KnowledgeRecommendationsRequestDtoDirectionEnum = 'INCREASED' | 'DECREASED';
|
|
1974
2019
|
export interface KnowledgeRecommendationsResponseDto {
|
|
2020
|
+
'message': string;
|
|
1975
2021
|
'runId': string;
|
|
1976
2022
|
'status': string;
|
|
1977
|
-
'message': string;
|
|
1978
2023
|
}
|
|
1979
2024
|
export interface ListLlmProviderModelsRequest {
|
|
1980
|
-
'providerConfig':
|
|
2025
|
+
'providerConfig': ListLlmProviderModelsRequestProviderConfig;
|
|
1981
2026
|
}
|
|
2027
|
+
/**
|
|
2028
|
+
* @type ListLlmProviderModelsRequestProviderConfig
|
|
2029
|
+
*/
|
|
2030
|
+
export type ListLlmProviderModelsRequestProviderConfig = AnthropicProviderConfig | AwsBedrockProviderConfig | AzureFoundryProviderConfig | OpenAIProviderConfig;
|
|
1982
2031
|
export interface ListLlmProviderModelsResponse {
|
|
1983
|
-
/**
|
|
1984
|
-
* Whether the model listing succeeded.
|
|
1985
|
-
*/
|
|
1986
|
-
'success': boolean;
|
|
1987
2032
|
/**
|
|
1988
2033
|
* Message about the listing result.
|
|
1989
2034
|
*/
|
|
@@ -1992,19 +2037,23 @@ export interface ListLlmProviderModelsResponse {
|
|
|
1992
2037
|
* Available models on the provider.
|
|
1993
2038
|
*/
|
|
1994
2039
|
'models': Array<LlmModel>;
|
|
2040
|
+
/**
|
|
2041
|
+
* Whether the model listing succeeded.
|
|
2042
|
+
*/
|
|
2043
|
+
'success': boolean;
|
|
1995
2044
|
}
|
|
1996
2045
|
/**
|
|
1997
2046
|
* LLM Model configuration (id, family) within a provider.
|
|
1998
2047
|
*/
|
|
1999
2048
|
export interface LlmModel {
|
|
2000
|
-
/**
|
|
2001
|
-
* Unique identifier of the model (e.g., gpt-5.3, claude-4.6).
|
|
2002
|
-
*/
|
|
2003
|
-
'id': string;
|
|
2004
2049
|
/**
|
|
2005
2050
|
* Family of LLM models.
|
|
2006
2051
|
*/
|
|
2007
2052
|
'family': LlmModelFamilyEnum;
|
|
2053
|
+
/**
|
|
2054
|
+
* Unique identifier of the model (e.g., gpt-5.3, claude-4.6).
|
|
2055
|
+
*/
|
|
2056
|
+
'id': string;
|
|
2008
2057
|
}
|
|
2009
2058
|
export type LlmModelFamilyEnum = 'OPENAI' | 'ANTHROPIC' | 'META' | 'MISTRAL' | 'AMAZON' | 'GOOGLE' | 'COHERE' | 'UNKNOWN';
|
|
2010
2059
|
/**
|
|
@@ -2019,10 +2068,17 @@ export interface MatchAttributeFilter {
|
|
|
2019
2068
|
'matchAttributeFilter': MatchAttributeFilterMatchAttributeFilter;
|
|
2020
2069
|
}
|
|
2021
2070
|
export interface MatchAttributeFilterMatchAttributeFilter {
|
|
2071
|
+
'applyOnResult'?: boolean;
|
|
2072
|
+
/**
|
|
2073
|
+
* Indicates whether the filter match is evaluated in case-sensitive mode or not.
|
|
2074
|
+
*/
|
|
2075
|
+
'caseSensitive'?: boolean;
|
|
2076
|
+
'label': AfmIdentifier;
|
|
2022
2077
|
/**
|
|
2023
2078
|
* Literal used to limit label values.
|
|
2024
2079
|
*/
|
|
2025
2080
|
'literal': string;
|
|
2081
|
+
'localIdentifier'?: string;
|
|
2026
2082
|
/**
|
|
2027
2083
|
* Requested match type.
|
|
2028
2084
|
*/
|
|
@@ -2031,13 +2087,6 @@ export interface MatchAttributeFilterMatchAttributeFilter {
|
|
|
2031
2087
|
* Indicates whether the filter should negate the match.
|
|
2032
2088
|
*/
|
|
2033
2089
|
'negate'?: boolean;
|
|
2034
|
-
/**
|
|
2035
|
-
* Indicates whether the filter match is evaluated in case-sensitive mode or not.
|
|
2036
|
-
*/
|
|
2037
|
-
'caseSensitive'?: boolean;
|
|
2038
|
-
'localIdentifier'?: string;
|
|
2039
|
-
'applyOnResult'?: boolean;
|
|
2040
|
-
'label': AfmIdentifier;
|
|
2041
2090
|
}
|
|
2042
2091
|
export type MatchAttributeFilterMatchAttributeFilterMatchTypeEnum = 'STARTS_WITH' | 'ENDS_WITH' | 'CONTAINS';
|
|
2043
2092
|
/**
|
|
@@ -2055,14 +2104,14 @@ export interface MeasureGroupHeaders {
|
|
|
2055
2104
|
'measureGroupHeaders'?: Array<MeasureHeader>;
|
|
2056
2105
|
}
|
|
2057
2106
|
export interface MeasureHeader {
|
|
2058
|
-
/**
|
|
2059
|
-
* Local identifier of the measure this header relates to.
|
|
2060
|
-
*/
|
|
2061
|
-
'localIdentifier': string;
|
|
2062
2107
|
/**
|
|
2063
2108
|
* Format to be used to format the measure data.
|
|
2064
2109
|
*/
|
|
2065
2110
|
'format'?: string;
|
|
2111
|
+
/**
|
|
2112
|
+
* Local identifier of the measure this header relates to.
|
|
2113
|
+
*/
|
|
2114
|
+
'localIdentifier': string;
|
|
2066
2115
|
/**
|
|
2067
2116
|
* Name of the measure.
|
|
2068
2117
|
*/
|
|
@@ -2072,11 +2121,11 @@ export interface MeasureHeader {
|
|
|
2072
2121
|
* Metric is a quantity that is calculated from the data.
|
|
2073
2122
|
*/
|
|
2074
2123
|
export interface MeasureItem {
|
|
2124
|
+
'definition': MeasureDefinition;
|
|
2075
2125
|
/**
|
|
2076
2126
|
* Local identifier of the metric. This can be used to reference the metric in other parts of the execution definition.
|
|
2077
2127
|
*/
|
|
2078
2128
|
'localIdentifier': string;
|
|
2079
|
-
'definition': MeasureDefinition;
|
|
2080
2129
|
}
|
|
2081
2130
|
/**
|
|
2082
2131
|
* Header containing the information related to metrics.
|
|
@@ -2098,23 +2147,19 @@ export type MeasureValueCondition = ComparisonCondition | RangeCondition;
|
|
|
2098
2147
|
*/
|
|
2099
2148
|
export type MeasureValueFilter = ComparisonMeasureValueFilter | CompoundMeasureValueFilter | RangeMeasureValueFilter;
|
|
2100
2149
|
export interface MemoryItemCreatedByUsers {
|
|
2101
|
-
/**
|
|
2102
|
-
* Users who created memory item
|
|
2103
|
-
*/
|
|
2104
|
-
'users': Array<MemoryItemUser>;
|
|
2105
2150
|
/**
|
|
2106
2151
|
* Reasoning for error states
|
|
2107
2152
|
*/
|
|
2108
2153
|
'reasoning': string;
|
|
2154
|
+
/**
|
|
2155
|
+
* Users who created memory item
|
|
2156
|
+
*/
|
|
2157
|
+
'users': Array<MemoryItemUser>;
|
|
2109
2158
|
}
|
|
2110
2159
|
/**
|
|
2111
2160
|
* Users who created memory item
|
|
2112
2161
|
*/
|
|
2113
2162
|
export interface MemoryItemUser {
|
|
2114
|
-
/**
|
|
2115
|
-
* User ID of the user who created memory item
|
|
2116
|
-
*/
|
|
2117
|
-
'userId': string;
|
|
2118
2163
|
/**
|
|
2119
2164
|
* First name of the user who created memory item
|
|
2120
2165
|
*/
|
|
@@ -2123,36 +2168,40 @@ export interface MemoryItemUser {
|
|
|
2123
2168
|
* Last name of the user who created memory item
|
|
2124
2169
|
*/
|
|
2125
2170
|
'lastname': string;
|
|
2171
|
+
/**
|
|
2172
|
+
* User ID of the user who created memory item
|
|
2173
|
+
*/
|
|
2174
|
+
'userId': string;
|
|
2126
2175
|
}
|
|
2127
2176
|
/**
|
|
2128
2177
|
* List of metrics to be used in the new visualization
|
|
2129
2178
|
*/
|
|
2130
2179
|
export interface Metric {
|
|
2131
2180
|
/**
|
|
2132
|
-
*
|
|
2181
|
+
* Agg function. Empty if a stored metric is used.
|
|
2133
2182
|
*/
|
|
2134
|
-
'
|
|
2183
|
+
'aggFunction'?: MetricAggFunctionEnum;
|
|
2135
2184
|
/**
|
|
2136
|
-
*
|
|
2185
|
+
* ID of the object
|
|
2137
2186
|
*/
|
|
2138
|
-
'
|
|
2187
|
+
'id': string;
|
|
2139
2188
|
/**
|
|
2140
2189
|
* Title of metric.
|
|
2141
2190
|
*/
|
|
2142
2191
|
'title': string;
|
|
2143
2192
|
/**
|
|
2144
|
-
*
|
|
2193
|
+
* Object type
|
|
2145
2194
|
*/
|
|
2146
|
-
'
|
|
2195
|
+
'type': MetricTypeEnum;
|
|
2147
2196
|
}
|
|
2148
|
-
export type MetricTypeEnum = 'metric' | 'fact' | 'attribute';
|
|
2149
2197
|
export type MetricAggFunctionEnum = 'COUNT' | 'SUM' | 'MIN' | 'MAX' | 'AVG' | 'MEDIAN';
|
|
2198
|
+
export type MetricTypeEnum = 'metric' | 'fact' | 'attribute';
|
|
2150
2199
|
/**
|
|
2151
2200
|
* (EXPERIMENTAL) Override for a catalog metric definition.
|
|
2152
2201
|
*/
|
|
2153
2202
|
export interface MetricDefinitionOverride {
|
|
2154
|
-
'item': AfmObjectIdentifierCore;
|
|
2155
2203
|
'definition': InlineMeasureDefinition;
|
|
2204
|
+
'item': AfmObjectIdentifierCore;
|
|
2156
2205
|
}
|
|
2157
2206
|
/**
|
|
2158
2207
|
* Individual change analysis data item
|
|
@@ -2167,13 +2216,17 @@ export interface MetricValueChange {
|
|
|
2167
2216
|
*/
|
|
2168
2217
|
'attributeValue': string;
|
|
2169
2218
|
/**
|
|
2170
|
-
* The
|
|
2219
|
+
* The mean of attribute value changes for the attribute being analyzed
|
|
2171
2220
|
*/
|
|
2172
|
-
'
|
|
2221
|
+
'attributeValuesChangeMean': number;
|
|
2173
2222
|
/**
|
|
2174
|
-
* The
|
|
2223
|
+
* The standard deviation of attribute value changes for the attribute being analyzed
|
|
2175
2224
|
*/
|
|
2176
|
-
'
|
|
2225
|
+
'attributeValuesChangeStd': number;
|
|
2226
|
+
/**
|
|
2227
|
+
* Whether the change is statistically significant
|
|
2228
|
+
*/
|
|
2229
|
+
'isSignificantChange': boolean;
|
|
2177
2230
|
/**
|
|
2178
2231
|
* The delta between analyzed and reference periods
|
|
2179
2232
|
*/
|
|
@@ -2183,17 +2236,13 @@ export interface MetricValueChange {
|
|
|
2183
2236
|
*/
|
|
2184
2237
|
'metricValueDeltaAbs': number;
|
|
2185
2238
|
/**
|
|
2186
|
-
* The
|
|
2187
|
-
*/
|
|
2188
|
-
'attributeValuesChangeMean': number;
|
|
2189
|
-
/**
|
|
2190
|
-
* The standard deviation of attribute value changes for the attribute being analyzed
|
|
2239
|
+
* The metric value in the analyzed period
|
|
2191
2240
|
*/
|
|
2192
|
-
'
|
|
2241
|
+
'metricValueInAnalyzedPeriod': number;
|
|
2193
2242
|
/**
|
|
2194
|
-
*
|
|
2243
|
+
* The metric value in the reference period
|
|
2195
2244
|
*/
|
|
2196
|
-
'
|
|
2245
|
+
'metricValueInReferencePeriod': number;
|
|
2197
2246
|
/**
|
|
2198
2247
|
* The overall metric value in the analyzed period
|
|
2199
2248
|
*/
|
|
@@ -2207,6 +2256,10 @@ export interface MetricValueChange {
|
|
|
2207
2256
|
* Per-model test results.
|
|
2208
2257
|
*/
|
|
2209
2258
|
export interface ModelTestResult {
|
|
2259
|
+
/**
|
|
2260
|
+
* Message about the model test result.
|
|
2261
|
+
*/
|
|
2262
|
+
'message': string;
|
|
2210
2263
|
/**
|
|
2211
2264
|
* The model ID that was tested.
|
|
2212
2265
|
*/
|
|
@@ -2215,10 +2268,6 @@ export interface ModelTestResult {
|
|
|
2215
2268
|
* Whether the model test was successful.
|
|
2216
2269
|
*/
|
|
2217
2270
|
'successful': boolean;
|
|
2218
|
-
/**
|
|
2219
|
-
* Message about the model test result.
|
|
2220
|
-
*/
|
|
2221
|
-
'message': string;
|
|
2222
2271
|
}
|
|
2223
2272
|
/**
|
|
2224
2273
|
* Filter able to limit element values by label and related selected negated elements.
|
|
@@ -2227,24 +2276,24 @@ export interface NegativeAttributeFilter {
|
|
|
2227
2276
|
'negativeAttributeFilter': NegativeAttributeFilterNegativeAttributeFilter;
|
|
2228
2277
|
}
|
|
2229
2278
|
export interface NegativeAttributeFilterNegativeAttributeFilter {
|
|
2230
|
-
'notIn': AttributeFilterElements;
|
|
2231
|
-
'localIdentifier'?: string;
|
|
2232
2279
|
'applyOnResult'?: boolean;
|
|
2280
|
+
'label': AfmIdentifier;
|
|
2281
|
+
'localIdentifier'?: string;
|
|
2282
|
+
'notIn': AttributeFilterElements;
|
|
2233
2283
|
/**
|
|
2234
2284
|
* If true, indicates that the values in notInElements were filled free-form, otherwise they have been picked from existing elements.
|
|
2235
2285
|
*/
|
|
2236
2286
|
'usesArbitraryValues'?: boolean;
|
|
2237
|
-
'label': AfmIdentifier;
|
|
2238
2287
|
}
|
|
2239
2288
|
export interface ObjectReference {
|
|
2240
|
-
/**
|
|
2241
|
-
* Type of the referenced object.
|
|
2242
|
-
*/
|
|
2243
|
-
'type': ObjectReferenceTypeEnum;
|
|
2244
2289
|
/**
|
|
2245
2290
|
* Object identifier (e.g. widget ID, metric ID).
|
|
2246
2291
|
*/
|
|
2247
2292
|
'id': string;
|
|
2293
|
+
/**
|
|
2294
|
+
* Type of the referenced object.
|
|
2295
|
+
*/
|
|
2296
|
+
'type': ObjectReferenceTypeEnum;
|
|
2248
2297
|
}
|
|
2249
2298
|
export type ObjectReferenceTypeEnum = 'WIDGET' | 'METRIC' | 'ATTRIBUTE' | 'DASHBOARD';
|
|
2250
2299
|
export interface ObjectReferenceGroup {
|
|
@@ -2258,38 +2307,38 @@ export interface ObjectReferenceGroup {
|
|
|
2258
2307
|
* Descriptor of a registered ObjectStorage. Provider credentials are stripped — only fields useful for identifying the storage are returned.
|
|
2259
2308
|
*/
|
|
2260
2309
|
export interface ObjectStorageInfo {
|
|
2261
|
-
/**
|
|
2262
|
-
* Stable identifier of the storage configuration (UUID).
|
|
2263
|
-
*/
|
|
2264
|
-
'storageId': string;
|
|
2265
2310
|
/**
|
|
2266
2311
|
* Human-readable name. Use this as `sourceStorageName` in CreatePipeTable, or pass `storageId` to ProvisionDatabase.storageIds.
|
|
2267
2312
|
*/
|
|
2268
2313
|
'name': string;
|
|
2269
|
-
/**
|
|
2270
|
-
* Provider type.
|
|
2271
|
-
*/
|
|
2272
|
-
'storageType': string;
|
|
2273
2314
|
/**
|
|
2274
2315
|
* Provider-specific descriptors (e.g. bucket, region, endpoint, container). Credential references (any keys ending in `_env`) are stripped server-side.
|
|
2275
2316
|
*/
|
|
2276
2317
|
'storageConfig': {
|
|
2277
2318
|
[key: string]: string;
|
|
2278
2319
|
};
|
|
2320
|
+
/**
|
|
2321
|
+
* Stable identifier of the storage configuration (UUID).
|
|
2322
|
+
*/
|
|
2323
|
+
'storageId': string;
|
|
2324
|
+
/**
|
|
2325
|
+
* Provider type.
|
|
2326
|
+
*/
|
|
2327
|
+
'storageType': string;
|
|
2279
2328
|
}
|
|
2280
2329
|
/**
|
|
2281
2330
|
* Configuration for OpenAI provider.
|
|
2282
2331
|
*/
|
|
2283
2332
|
export interface OpenAIProviderConfig {
|
|
2284
|
-
|
|
2285
|
-
* OpenAI organization ID.
|
|
2286
|
-
*/
|
|
2287
|
-
'organization'?: string | null;
|
|
2333
|
+
'auth': OpenAiApiKeyAuth;
|
|
2288
2334
|
/**
|
|
2289
2335
|
* Custom base URL for OpenAI API.
|
|
2290
2336
|
*/
|
|
2291
2337
|
'baseUrl'?: string;
|
|
2292
|
-
|
|
2338
|
+
/**
|
|
2339
|
+
* OpenAI organization ID.
|
|
2340
|
+
*/
|
|
2341
|
+
'organization'?: string | null;
|
|
2293
2342
|
/**
|
|
2294
2343
|
* Provider type.
|
|
2295
2344
|
*/
|
|
@@ -2344,26 +2393,26 @@ export interface OutlierDetectionRequest {
|
|
|
2344
2393
|
* Attributes to be used in the computation.
|
|
2345
2394
|
*/
|
|
2346
2395
|
'attributes': Array<AttributeItem>;
|
|
2347
|
-
/**
|
|
2348
|
-
* Various filter types to filter the execution result.
|
|
2349
|
-
*/
|
|
2350
|
-
'filters': Array<OutlierDetectionRequestFiltersInner>;
|
|
2351
|
-
'measures': Array<MeasureItem>;
|
|
2352
2396
|
/**
|
|
2353
2397
|
* Metrics to be referenced from other AFM objects (e.g. filters) but not included in the result.
|
|
2354
2398
|
*/
|
|
2355
2399
|
'auxMeasures'?: Array<MeasureItem>;
|
|
2356
2400
|
/**
|
|
2357
|
-
*
|
|
2401
|
+
* Various filter types to filter the execution result.
|
|
2358
2402
|
*/
|
|
2359
|
-
'
|
|
2403
|
+
'filters': Array<OutlierDetectionRequestFiltersInner>;
|
|
2360
2404
|
/**
|
|
2361
2405
|
* Date granularity for anomaly detection. Only time-based granularities are supported (HOUR, DAY, WEEK, MONTH, QUARTER, YEAR).
|
|
2362
2406
|
*/
|
|
2363
2407
|
'granularity': OutlierDetectionRequestGranularityEnum;
|
|
2408
|
+
'measures': Array<MeasureItem>;
|
|
2409
|
+
/**
|
|
2410
|
+
* Sensitivity level for outlier detection
|
|
2411
|
+
*/
|
|
2412
|
+
'sensitivity': OutlierDetectionRequestSensitivityEnum;
|
|
2364
2413
|
}
|
|
2365
|
-
export type OutlierDetectionRequestSensitivityEnum = 'LOW' | 'MEDIUM' | 'HIGH';
|
|
2366
2414
|
export type OutlierDetectionRequestGranularityEnum = 'HOUR' | 'DAY' | 'WEEK' | 'MONTH' | 'QUARTER' | 'YEAR';
|
|
2415
|
+
export type OutlierDetectionRequestSensitivityEnum = 'LOW' | 'MEDIUM' | 'HIGH';
|
|
2367
2416
|
/**
|
|
2368
2417
|
* @type OutlierDetectionRequestFiltersInner
|
|
2369
2418
|
*/
|
|
@@ -2387,27 +2436,28 @@ export interface OutlierDetectionResult {
|
|
|
2387
2436
|
* Current page description.
|
|
2388
2437
|
*/
|
|
2389
2438
|
export interface Paging {
|
|
2390
|
-
/**
|
|
2391
|
-
* Count of returnable items ignoring paging.
|
|
2392
|
-
*/
|
|
2393
|
-
'total': number;
|
|
2394
2439
|
/**
|
|
2395
2440
|
* Count of items in this page.
|
|
2396
2441
|
*/
|
|
2397
2442
|
'count': number;
|
|
2443
|
+
/**
|
|
2444
|
+
* Link to next page, or null if this is last page.
|
|
2445
|
+
*/
|
|
2446
|
+
'next'?: string;
|
|
2398
2447
|
/**
|
|
2399
2448
|
* Offset of this page.
|
|
2400
2449
|
*/
|
|
2401
2450
|
'offset': number;
|
|
2402
2451
|
/**
|
|
2403
|
-
*
|
|
2452
|
+
* Count of returnable items ignoring paging.
|
|
2404
2453
|
*/
|
|
2405
|
-
'
|
|
2454
|
+
'total': number;
|
|
2406
2455
|
}
|
|
2407
2456
|
/**
|
|
2408
2457
|
* (EXPERIMENTAL) Parameter value for this execution.
|
|
2409
2458
|
*/
|
|
2410
2459
|
export interface ParameterItem {
|
|
2460
|
+
[key: string]: any;
|
|
2411
2461
|
'parameter': AfmObjectIdentifierParameter;
|
|
2412
2462
|
/**
|
|
2413
2463
|
* Value to use for this parameter instead of its default.
|
|
@@ -2430,46 +2480,46 @@ export interface PendingOperation extends Operation {
|
|
|
2430
2480
|
*/
|
|
2431
2481
|
export interface PipeTable {
|
|
2432
2482
|
/**
|
|
2433
|
-
*
|
|
2434
|
-
*/
|
|
2435
|
-
'pipeTableId': string;
|
|
2436
|
-
/**
|
|
2437
|
-
* OLAP table name
|
|
2483
|
+
* Inferred column schema
|
|
2438
2484
|
*/
|
|
2439
|
-
'
|
|
2485
|
+
'columns': Array<ColumnInfo>;
|
|
2440
2486
|
/**
|
|
2441
2487
|
* Database name
|
|
2442
2488
|
*/
|
|
2443
2489
|
'databaseName': string;
|
|
2490
|
+
'distributionConfig': PipeTableDistributionConfig;
|
|
2491
|
+
'keyConfig': PipeTableKeyConfig;
|
|
2444
2492
|
/**
|
|
2445
|
-
*
|
|
2493
|
+
* Hive partition columns detected from the path structure
|
|
2446
2494
|
*/
|
|
2447
|
-
'
|
|
2495
|
+
'partitionColumns': Array<string>;
|
|
2496
|
+
'partitionConfig'?: PipeTablePartitionConfig;
|
|
2448
2497
|
/**
|
|
2449
2498
|
* Path prefix to the parquet files
|
|
2450
2499
|
*/
|
|
2451
2500
|
'pathPrefix': string;
|
|
2452
2501
|
/**
|
|
2453
|
-
*
|
|
2502
|
+
* Internal UUID of the pipe table record
|
|
2454
2503
|
*/
|
|
2455
|
-
'
|
|
2504
|
+
'pipeTableId': string;
|
|
2456
2505
|
/**
|
|
2457
|
-
*
|
|
2506
|
+
* How often (in seconds) the pipe polls for new files. 0 = server default.
|
|
2458
2507
|
*/
|
|
2459
|
-
'
|
|
2460
|
-
|
|
2461
|
-
|
|
2462
|
-
|
|
2508
|
+
'pollingIntervalSeconds': number;
|
|
2509
|
+
/**
|
|
2510
|
+
* Source ObjectStorage name
|
|
2511
|
+
*/
|
|
2512
|
+
'sourceStorageName': string;
|
|
2513
|
+
/**
|
|
2514
|
+
* OLAP table name
|
|
2515
|
+
*/
|
|
2516
|
+
'tableName': string;
|
|
2463
2517
|
/**
|
|
2464
2518
|
* CREATE TABLE PROPERTIES key-value pairs
|
|
2465
2519
|
*/
|
|
2466
2520
|
'tableProperties': {
|
|
2467
2521
|
[key: string]: string;
|
|
2468
2522
|
};
|
|
2469
|
-
/**
|
|
2470
|
-
* How often (in seconds) the pipe polls for new files. 0 = server default.
|
|
2471
|
-
*/
|
|
2472
|
-
'pollingIntervalSeconds': number;
|
|
2473
2523
|
}
|
|
2474
2524
|
/**
|
|
2475
2525
|
* @type PipeTableDistributionConfig
|
|
@@ -2488,21 +2538,21 @@ export type PipeTablePartitionConfig = ColumnPartitionConfig | DateTruncPartitio
|
|
|
2488
2538
|
*/
|
|
2489
2539
|
export interface PipeTableSummary {
|
|
2490
2540
|
/**
|
|
2491
|
-
*
|
|
2492
|
-
*/
|
|
2493
|
-
'pipeTableId': string;
|
|
2494
|
-
/**
|
|
2495
|
-
* OLAP table name
|
|
2541
|
+
* Inferred column schema
|
|
2496
2542
|
*/
|
|
2497
|
-
'
|
|
2543
|
+
'columns': Array<ColumnInfo>;
|
|
2498
2544
|
/**
|
|
2499
2545
|
* Path prefix to the parquet files
|
|
2500
2546
|
*/
|
|
2501
2547
|
'pathPrefix': string;
|
|
2502
2548
|
/**
|
|
2503
|
-
*
|
|
2549
|
+
* Internal UUID of the pipe table record
|
|
2504
2550
|
*/
|
|
2505
|
-
'
|
|
2551
|
+
'pipeTableId': string;
|
|
2552
|
+
/**
|
|
2553
|
+
* OLAP table name
|
|
2554
|
+
*/
|
|
2555
|
+
'tableName': string;
|
|
2506
2556
|
}
|
|
2507
2557
|
/**
|
|
2508
2558
|
* Combination of the date data set to use and how many periods ago to calculate the previous period for.
|
|
@@ -2521,11 +2571,11 @@ export interface PopDatasetMeasureDefinition {
|
|
|
2521
2571
|
'previousPeriodMeasure': PopDatasetMeasureDefinitionPreviousPeriodMeasure;
|
|
2522
2572
|
}
|
|
2523
2573
|
export interface PopDatasetMeasureDefinitionPreviousPeriodMeasure {
|
|
2524
|
-
'measureIdentifier': AfmLocalIdentifier;
|
|
2525
2574
|
/**
|
|
2526
2575
|
* Specification of which date data sets to use for determining the period to calculate the previous period for.
|
|
2527
2576
|
*/
|
|
2528
2577
|
'dateDatasets': Array<PopDataset>;
|
|
2578
|
+
'measureIdentifier': AfmLocalIdentifier;
|
|
2529
2579
|
}
|
|
2530
2580
|
/**
|
|
2531
2581
|
* Combination of the date attribute to use and how many periods ago to calculate the PoP for.
|
|
@@ -2544,11 +2594,11 @@ export interface PopDateMeasureDefinition {
|
|
|
2544
2594
|
'overPeriodMeasure': PopDateMeasureDefinitionOverPeriodMeasure;
|
|
2545
2595
|
}
|
|
2546
2596
|
export interface PopDateMeasureDefinitionOverPeriodMeasure {
|
|
2547
|
-
'measureIdentifier': AfmLocalIdentifier;
|
|
2548
2597
|
/**
|
|
2549
2598
|
* Attributes to use for determining the period to calculate the PoP for.
|
|
2550
2599
|
*/
|
|
2551
2600
|
'dateAttributes': Array<PopDate>;
|
|
2601
|
+
'measureIdentifier': AfmLocalIdentifier;
|
|
2552
2602
|
}
|
|
2553
2603
|
/**
|
|
2554
2604
|
* @type PopMeasureDefinition
|
|
@@ -2561,14 +2611,14 @@ export interface PositiveAttributeFilter {
|
|
|
2561
2611
|
'positiveAttributeFilter': PositiveAttributeFilterPositiveAttributeFilter;
|
|
2562
2612
|
}
|
|
2563
2613
|
export interface PositiveAttributeFilterPositiveAttributeFilter {
|
|
2614
|
+
'applyOnResult'?: boolean;
|
|
2564
2615
|
'in': AttributeFilterElements;
|
|
2616
|
+
'label': AfmIdentifier;
|
|
2565
2617
|
'localIdentifier'?: string;
|
|
2566
|
-
'applyOnResult'?: boolean;
|
|
2567
2618
|
/**
|
|
2568
2619
|
* If true, indicates that the values in inElements were filled free-form, otherwise they have been picked from existing elements.
|
|
2569
2620
|
*/
|
|
2570
2621
|
'usesArbitraryValues'?: boolean;
|
|
2571
|
-
'label': AfmIdentifier;
|
|
2572
2622
|
}
|
|
2573
2623
|
/**
|
|
2574
2624
|
* Primary key model — enforces uniqueness, replaces on conflict.
|
|
@@ -2583,14 +2633,6 @@ export interface PrimaryKeyConfig {
|
|
|
2583
2633
|
* Request to provision a new AILake Database instance
|
|
2584
2634
|
*/
|
|
2585
2635
|
export interface ProvisionDatabaseInstanceRequest {
|
|
2586
|
-
/**
|
|
2587
|
-
* Name of the database instance
|
|
2588
|
-
*/
|
|
2589
|
-
'name': string;
|
|
2590
|
-
/**
|
|
2591
|
-
* Set of ids of the storage instances this database instance should access.
|
|
2592
|
-
*/
|
|
2593
|
-
'storageIds': Array<string>;
|
|
2594
2636
|
/**
|
|
2595
2637
|
* Identifier for the data source created in metadata-api. Defaults to the database name.
|
|
2596
2638
|
*/
|
|
@@ -2599,11 +2641,29 @@ export interface ProvisionDatabaseInstanceRequest {
|
|
|
2599
2641
|
* Display name for the data source created in metadata-api. Defaults to the database name.
|
|
2600
2642
|
*/
|
|
2601
2643
|
'dataSourceName'?: string;
|
|
2644
|
+
/**
|
|
2645
|
+
* Name of the database instance
|
|
2646
|
+
*/
|
|
2647
|
+
'name': string;
|
|
2648
|
+
/**
|
|
2649
|
+
* Set of ids of the storage instances this database instance should access.
|
|
2650
|
+
*/
|
|
2651
|
+
'storageIds': Array<string>;
|
|
2602
2652
|
}
|
|
2603
2653
|
/**
|
|
2604
2654
|
* List of quality issues (available when status is COMPLETED)
|
|
2605
2655
|
*/
|
|
2606
2656
|
export interface QualityIssue {
|
|
2657
|
+
/**
|
|
2658
|
+
* Quality issue code
|
|
2659
|
+
*/
|
|
2660
|
+
'code': string;
|
|
2661
|
+
/**
|
|
2662
|
+
* Detailed information about the quality issue
|
|
2663
|
+
*/
|
|
2664
|
+
'detail': {
|
|
2665
|
+
[key: string]: object;
|
|
2666
|
+
};
|
|
2607
2667
|
/**
|
|
2608
2668
|
* Unique identifier for the quality issue
|
|
2609
2669
|
*/
|
|
@@ -2616,52 +2676,42 @@ export interface QualityIssue {
|
|
|
2616
2676
|
* Severity level
|
|
2617
2677
|
*/
|
|
2618
2678
|
'severity': QualityIssueSeverityEnum;
|
|
2619
|
-
/**
|
|
2620
|
-
* Quality issue code
|
|
2621
|
-
*/
|
|
2622
|
-
'code': string;
|
|
2623
|
-
/**
|
|
2624
|
-
* Detailed information about the quality issue
|
|
2625
|
-
*/
|
|
2626
|
-
'detail': {
|
|
2627
|
-
[key: string]: object;
|
|
2628
|
-
};
|
|
2629
2679
|
}
|
|
2630
2680
|
export type QualityIssueSeverityEnum = 'WARNING' | 'INFO';
|
|
2631
2681
|
/**
|
|
2632
2682
|
* List of objects affected by this quality issue
|
|
2633
2683
|
*/
|
|
2634
2684
|
export interface QualityIssueObject {
|
|
2635
|
-
/**
|
|
2636
|
-
* Object type
|
|
2637
|
-
*/
|
|
2638
|
-
'type': string;
|
|
2639
2685
|
/**
|
|
2640
2686
|
* Object ID
|
|
2641
2687
|
*/
|
|
2642
2688
|
'id': string;
|
|
2643
|
-
/**
|
|
2644
|
-
* Workspace ID where the object belongs
|
|
2645
|
-
*/
|
|
2646
|
-
'workspaceId': string;
|
|
2647
2689
|
/**
|
|
2648
2690
|
* Object title
|
|
2649
2691
|
*/
|
|
2650
2692
|
'title': string;
|
|
2693
|
+
/**
|
|
2694
|
+
* Object type
|
|
2695
|
+
*/
|
|
2696
|
+
'type': string;
|
|
2697
|
+
/**
|
|
2698
|
+
* Workspace ID where the object belongs
|
|
2699
|
+
*/
|
|
2700
|
+
'workspaceId': string;
|
|
2651
2701
|
}
|
|
2652
2702
|
export interface QualityIssuesCalculationStatusResponse {
|
|
2653
2703
|
/**
|
|
2654
|
-
*
|
|
2704
|
+
* Error message (available when status is FAILED or NOT_FOUND)
|
|
2655
2705
|
*/
|
|
2656
|
-
'
|
|
2706
|
+
'error'?: string;
|
|
2657
2707
|
/**
|
|
2658
2708
|
* List of quality issues (available when status is COMPLETED)
|
|
2659
2709
|
*/
|
|
2660
2710
|
'issues'?: Array<QualityIssue>;
|
|
2661
2711
|
/**
|
|
2662
|
-
*
|
|
2712
|
+
* Current status of the calculation
|
|
2663
2713
|
*/
|
|
2664
|
-
'
|
|
2714
|
+
'status': QualityIssuesCalculationStatusResponseStatusEnum;
|
|
2665
2715
|
}
|
|
2666
2716
|
export type QualityIssuesCalculationStatusResponseStatusEnum = 'RUNNING' | 'SYNCING' | 'COMPLETED' | 'FAILED' | 'CANCELLED' | 'NOT_FOUND' | 'DISABLED';
|
|
2667
2717
|
/**
|
|
@@ -2680,8 +2730,8 @@ export interface RangeCondition {
|
|
|
2680
2730
|
'range': RangeConditionRange;
|
|
2681
2731
|
}
|
|
2682
2732
|
export interface RangeConditionRange {
|
|
2683
|
-
'operator': RangeConditionRangeOperatorEnum;
|
|
2684
2733
|
'from': number;
|
|
2734
|
+
'operator': RangeConditionRangeOperatorEnum;
|
|
2685
2735
|
'to': number;
|
|
2686
2736
|
}
|
|
2687
2737
|
export type RangeConditionRangeOperatorEnum = 'BETWEEN' | 'NOT_BETWEEN';
|
|
@@ -2692,20 +2742,20 @@ export interface RangeMeasureValueFilter {
|
|
|
2692
2742
|
'rangeMeasureValueFilter': RangeMeasureValueFilterRangeMeasureValueFilter;
|
|
2693
2743
|
}
|
|
2694
2744
|
export interface RangeMeasureValueFilterRangeMeasureValueFilter {
|
|
2745
|
+
'applyOnResult'?: boolean;
|
|
2695
2746
|
/**
|
|
2696
2747
|
* References to the attributes to be used when filtering.
|
|
2697
2748
|
*/
|
|
2698
2749
|
'dimensionality'?: Array<AfmIdentifier>;
|
|
2750
|
+
'from': number;
|
|
2751
|
+
'localIdentifier'?: string;
|
|
2752
|
+
'measure': AfmIdentifier;
|
|
2753
|
+
'operator': RangeMeasureValueFilterRangeMeasureValueFilterOperatorEnum;
|
|
2754
|
+
'to': number;
|
|
2699
2755
|
/**
|
|
2700
2756
|
* A value that will be substituted for null values in the metric for the comparisons.
|
|
2701
2757
|
*/
|
|
2702
2758
|
'treatNullValuesAs'?: number;
|
|
2703
|
-
'operator': RangeMeasureValueFilterRangeMeasureValueFilterOperatorEnum;
|
|
2704
|
-
'from': number;
|
|
2705
|
-
'to': number;
|
|
2706
|
-
'localIdentifier'?: string;
|
|
2707
|
-
'applyOnResult'?: boolean;
|
|
2708
|
-
'measure': AfmIdentifier;
|
|
2709
2759
|
}
|
|
2710
2760
|
export type RangeMeasureValueFilterRangeMeasureValueFilterOperatorEnum = 'BETWEEN' | 'NOT_BETWEEN';
|
|
2711
2761
|
/**
|
|
@@ -2715,10 +2765,12 @@ export interface RankingFilter {
|
|
|
2715
2765
|
'rankingFilter': RankingFilterRankingFilter;
|
|
2716
2766
|
}
|
|
2717
2767
|
export interface RankingFilterRankingFilter {
|
|
2768
|
+
'applyOnResult'?: boolean;
|
|
2718
2769
|
/**
|
|
2719
2770
|
* References to the attributes to be used when filtering.
|
|
2720
2771
|
*/
|
|
2721
2772
|
'dimensionality'?: Array<AfmIdentifier>;
|
|
2773
|
+
'localIdentifier'?: string;
|
|
2722
2774
|
/**
|
|
2723
2775
|
* References to the metrics to be used when filtering.
|
|
2724
2776
|
*/
|
|
@@ -2727,43 +2779,41 @@ export interface RankingFilterRankingFilter {
|
|
|
2727
2779
|
* The type of ranking to use, TOP or BOTTOM.
|
|
2728
2780
|
*/
|
|
2729
2781
|
'operator': RankingFilterRankingFilterOperatorEnum;
|
|
2730
|
-
/**
|
|
2731
|
-
* Number of top/bottom values to filter.
|
|
2732
|
-
*/
|
|
2733
|
-
'value': number;
|
|
2734
2782
|
/**
|
|
2735
2783
|
* When true, filter returns requested number of rows at most. Default is false.
|
|
2736
2784
|
*/
|
|
2737
2785
|
'strictLimitOfRows'?: boolean;
|
|
2738
|
-
|
|
2739
|
-
|
|
2786
|
+
/**
|
|
2787
|
+
* Number of top/bottom values to filter.
|
|
2788
|
+
*/
|
|
2789
|
+
'value': number;
|
|
2740
2790
|
}
|
|
2741
2791
|
export type RankingFilterRankingFilterOperatorEnum = 'TOP' | 'BOTTOM';
|
|
2742
2792
|
/**
|
|
2743
2793
|
* Reasoning wrapper containing steps taken during request handling.
|
|
2744
2794
|
*/
|
|
2745
2795
|
export interface Reasoning {
|
|
2746
|
-
/**
|
|
2747
|
-
* Steps taken during processing, showing the AI\'s reasoning process.
|
|
2748
|
-
*/
|
|
2749
|
-
'steps': Array<ReasoningStep>;
|
|
2750
2796
|
/**
|
|
2751
2797
|
* Final answer/reasoning from the use case result.
|
|
2752
2798
|
*/
|
|
2753
2799
|
'answer'?: string;
|
|
2800
|
+
/**
|
|
2801
|
+
* Steps taken during processing, showing the AI\'s reasoning process.
|
|
2802
|
+
*/
|
|
2803
|
+
'steps': Array<ReasoningStep>;
|
|
2754
2804
|
}
|
|
2755
2805
|
/**
|
|
2756
2806
|
* Steps taken during processing, showing the AI\'s reasoning process.
|
|
2757
2807
|
*/
|
|
2758
2808
|
export interface ReasoningStep {
|
|
2759
|
-
/**
|
|
2760
|
-
* Title describing this reasoning step.
|
|
2761
|
-
*/
|
|
2762
|
-
'title': string;
|
|
2763
2809
|
/**
|
|
2764
2810
|
* Detailed thoughts/messages within this step.
|
|
2765
2811
|
*/
|
|
2766
2812
|
'thoughts': Array<Thought>;
|
|
2813
|
+
/**
|
|
2814
|
+
* Title describing this reasoning step.
|
|
2815
|
+
*/
|
|
2816
|
+
'title': string;
|
|
2767
2817
|
}
|
|
2768
2818
|
/**
|
|
2769
2819
|
* Request to refresh a specific Hive partition in a pipe-backed OLAP table
|
|
@@ -2783,29 +2833,29 @@ export interface RelativeDateFilter {
|
|
|
2783
2833
|
'relativeDateFilter': RelativeDateFilterRelativeDateFilter;
|
|
2784
2834
|
}
|
|
2785
2835
|
export interface RelativeDateFilterRelativeDateFilter {
|
|
2836
|
+
'applyOnResult'?: boolean;
|
|
2837
|
+
'boundedFilter'?: BoundedFilter;
|
|
2838
|
+
'dataset': AfmObjectIdentifierDataset;
|
|
2786
2839
|
/**
|
|
2787
|
-
*
|
|
2840
|
+
* Specifies how rows with empty (null/missing) date values should be handled. INCLUDE includes empty dates in addition to the date range restriction, EXCLUDE removes rows with empty dates (default), ONLY keeps only rows with empty dates.
|
|
2788
2841
|
*/
|
|
2789
|
-
'
|
|
2842
|
+
'emptyValueHandling'?: RelativeDateFilterRelativeDateFilterEmptyValueHandlingEnum;
|
|
2790
2843
|
/**
|
|
2791
2844
|
* Start of the filtering interval. Specified by number of periods (with respect to given granularity). Typically negative (historical time interval like -2 for \'2 days/weeks, ... ago\').
|
|
2792
2845
|
*/
|
|
2793
2846
|
'from': number;
|
|
2794
2847
|
/**
|
|
2795
|
-
*
|
|
2848
|
+
* Date granularity specifying particular date attribute in given dimension.
|
|
2796
2849
|
*/
|
|
2797
|
-
'
|
|
2850
|
+
'granularity': RelativeDateFilterRelativeDateFilterGranularityEnum;
|
|
2798
2851
|
'localIdentifier'?: string;
|
|
2799
|
-
'applyOnResult'?: boolean;
|
|
2800
|
-
'boundedFilter'?: BoundedFilter;
|
|
2801
2852
|
/**
|
|
2802
|
-
*
|
|
2853
|
+
* End of the filtering interval. Specified by number of periods (with respect to given granularity). Value \'O\' is representing current time-interval (current day, week, ...).
|
|
2803
2854
|
*/
|
|
2804
|
-
'
|
|
2805
|
-
'dataset': AfmObjectIdentifierDataset;
|
|
2855
|
+
'to': number;
|
|
2806
2856
|
}
|
|
2807
|
-
export type RelativeDateFilterRelativeDateFilterGranularityEnum = 'MINUTE' | 'HOUR' | 'DAY' | 'WEEK' | 'MONTH' | 'QUARTER' | 'YEAR' | 'MINUTE_OF_HOUR' | 'HOUR_OF_DAY' | 'DAY_OF_WEEK' | 'DAY_OF_MONTH' | 'DAY_OF_QUARTER' | 'DAY_OF_YEAR' | 'WEEK_OF_YEAR' | 'MONTH_OF_YEAR' | 'QUARTER_OF_YEAR' | 'FISCAL_MONTH' | 'FISCAL_QUARTER' | 'FISCAL_YEAR';
|
|
2808
2857
|
export type RelativeDateFilterRelativeDateFilterEmptyValueHandlingEnum = 'INCLUDE' | 'EXCLUDE' | 'ONLY';
|
|
2858
|
+
export type RelativeDateFilterRelativeDateFilterGranularityEnum = 'SECOND' | 'SECOND_OF_MINUTE' | 'SECOND_OF_DAY' | 'MINUTE' | 'MINUTE_OF_HOUR' | 'MINUTE_OF_DAY' | 'HOUR' | 'HOUR_OF_DAY' | 'DAY' | 'DAY_OF_WEEK' | 'DAY_OF_MONTH' | 'DAY_OF_QUARTER' | 'DAY_OF_YEAR' | 'WEEK' | 'WEEK_OF_YEAR' | 'MONTH' | 'MONTH_OF_YEAR' | 'QUARTER' | 'QUARTER_OF_YEAR' | 'YEAR' | 'FISCAL_DAY_OF_FISCAL_WEEK' | 'FISCAL_DAY_OF_FISCAL_MONTH' | 'FISCAL_DAY_OF_FISCAL_QUARTER' | 'FISCAL_DAY_OF_FISCAL_SEMESTER' | 'FISCAL_DAY_OF_FISCAL_YEAR' | 'FISCAL_WEEK' | 'FISCAL_WEEK_OF_FISCAL_MONTH' | 'FISCAL_WEEK_OF_FISCAL_QUARTER' | 'FISCAL_WEEK_OF_FISCAL_SEMESTER' | 'FISCAL_WEEK_OF_FISCAL_YEAR' | 'FISCAL_MONTH' | 'FISCAL_MONTH_OF_FISCAL_QUARTER' | 'FISCAL_MONTH_OF_FISCAL_SEMESTER' | 'FISCAL_MONTH_OF_FISCAL_YEAR' | 'FISCAL_QUARTER' | 'FISCAL_QUARTER_OF_FISCAL_SEMESTER' | 'FISCAL_QUARTER_OF_FISCAL_YEAR' | 'FISCAL_SEMESTER' | 'FISCAL_SEMESTER_OF_FISCAL_YEAR' | 'FISCAL_YEAR';
|
|
2809
2859
|
/**
|
|
2810
2860
|
* Confirmation of data source removal from an AI Lake Database instance
|
|
2811
2861
|
*/
|
|
@@ -2849,8 +2899,8 @@ export interface RestApiIdentifier {
|
|
|
2849
2899
|
export interface ResultCacheMetadata {
|
|
2850
2900
|
'afm': AFM;
|
|
2851
2901
|
'executionResponse': ExecutionResponse;
|
|
2852
|
-
'resultSpec': ResultSpec;
|
|
2853
2902
|
'resultSize': number;
|
|
2903
|
+
'resultSpec': ResultSpec;
|
|
2854
2904
|
}
|
|
2855
2905
|
/**
|
|
2856
2906
|
* Single result dimension
|
|
@@ -2879,34 +2929,34 @@ export interface ResultSpec {
|
|
|
2879
2929
|
*/
|
|
2880
2930
|
export interface RichTextWidgetDescriptor {
|
|
2881
2931
|
/**
|
|
2882
|
-
*
|
|
2883
|
-
*/
|
|
2884
|
-
'widgetId': string;
|
|
2885
|
-
/**
|
|
2886
|
-
* Widget title as displayed on the dashboard.
|
|
2932
|
+
* Markdown/text content of the rich text widget.
|
|
2887
2933
|
*/
|
|
2888
|
-
'
|
|
2934
|
+
'content'?: string;
|
|
2889
2935
|
/**
|
|
2890
2936
|
* Filters currently applied to the dashboard.
|
|
2891
2937
|
*/
|
|
2892
2938
|
'filters'?: Array<FilterDefinition>;
|
|
2893
2939
|
/**
|
|
2894
|
-
*
|
|
2940
|
+
* Widget title as displayed on the dashboard.
|
|
2895
2941
|
*/
|
|
2896
|
-
'
|
|
2942
|
+
'title': string;
|
|
2943
|
+
/**
|
|
2944
|
+
* Widget object ID.
|
|
2945
|
+
*/
|
|
2946
|
+
'widgetId': string;
|
|
2897
2947
|
}
|
|
2898
2948
|
/**
|
|
2899
2949
|
* Question -> Use Case routing. May contain final answer is a special use case is not required.
|
|
2900
2950
|
*/
|
|
2901
2951
|
export interface RouteResult {
|
|
2902
|
-
/**
|
|
2903
|
-
* Use case where LLM routed based on question.
|
|
2904
|
-
*/
|
|
2905
|
-
'useCase': RouteResultUseCaseEnum;
|
|
2906
2952
|
/**
|
|
2907
2953
|
* Explanation why LLM picked this use case.
|
|
2908
2954
|
*/
|
|
2909
2955
|
'reasoning': string;
|
|
2956
|
+
/**
|
|
2957
|
+
* Use case where LLM routed based on question.
|
|
2958
|
+
*/
|
|
2959
|
+
'useCase': RouteResultUseCaseEnum;
|
|
2910
2960
|
}
|
|
2911
2961
|
export type RouteResultUseCaseEnum = 'INVALID' | 'GENERAL' | 'SEARCH' | 'CREATE_VISUALIZATION' | 'EXTEND_VISUALIZATION' | 'HOWTO' | 'CHANGE_ANALYSIS' | 'ALERT';
|
|
2912
2962
|
/**
|
|
@@ -2938,64 +2988,56 @@ export interface SavedVisualization {
|
|
|
2938
2988
|
'savedVisualizationId': string;
|
|
2939
2989
|
}
|
|
2940
2990
|
export interface SearchRelationshipObject {
|
|
2941
|
-
/**
|
|
2942
|
-
* Source workspace ID. If relationship is dashboard->visualization, this is the workspace where the dashboard is located.
|
|
2943
|
-
*/
|
|
2944
|
-
'sourceWorkspaceId': string;
|
|
2945
2991
|
/**
|
|
2946
2992
|
* Source object ID.
|
|
2947
2993
|
*/
|
|
2948
2994
|
'sourceObjectId': string;
|
|
2949
|
-
/**
|
|
2950
|
-
* Source object type, e.g. dashboard.
|
|
2951
|
-
*/
|
|
2952
|
-
'sourceObjectType': string;
|
|
2953
2995
|
/**
|
|
2954
2996
|
* Source object title.
|
|
2955
2997
|
*/
|
|
2956
2998
|
'sourceObjectTitle': string;
|
|
2957
2999
|
/**
|
|
2958
|
-
*
|
|
3000
|
+
* Source object type, e.g. dashboard.
|
|
2959
3001
|
*/
|
|
2960
|
-
'
|
|
3002
|
+
'sourceObjectType': string;
|
|
3003
|
+
/**
|
|
3004
|
+
* Source workspace ID. If relationship is dashboard->visualization, this is the workspace where the dashboard is located.
|
|
3005
|
+
*/
|
|
3006
|
+
'sourceWorkspaceId': string;
|
|
2961
3007
|
/**
|
|
2962
3008
|
* Target object ID.
|
|
2963
3009
|
*/
|
|
2964
3010
|
'targetObjectId': string;
|
|
3011
|
+
/**
|
|
3012
|
+
* Target object title.
|
|
3013
|
+
*/
|
|
3014
|
+
'targetObjectTitle': string;
|
|
2965
3015
|
/**
|
|
2966
3016
|
* Target object type, e.g. visualization.
|
|
2967
3017
|
*/
|
|
2968
3018
|
'targetObjectType': string;
|
|
2969
3019
|
/**
|
|
2970
|
-
* Target
|
|
3020
|
+
* Target workspace ID. If relationship is dashboard->visualization, this is the workspace where the visualization is located.
|
|
2971
3021
|
*/
|
|
2972
|
-
'
|
|
3022
|
+
'targetWorkspaceId': string;
|
|
2973
3023
|
}
|
|
2974
3024
|
export interface SearchRequest {
|
|
2975
3025
|
/**
|
|
2976
|
-
*
|
|
2977
|
-
*/
|
|
2978
|
-
'question': string;
|
|
2979
|
-
/**
|
|
2980
|
-
* List of object types to search for.
|
|
3026
|
+
* Filter relationships and results based on allowed relationship type combinations. When specified, only relationships matching the allowed types are returned, and results are filtered to include only direct matches or objects reachable via allowed relationships. When null or omitted, all relationships and results are returned (default behavior). Note: This filtering happens after the initial search, so the number of returned results may be lower than the requested limit if some results are filtered out.
|
|
2981
3027
|
*/
|
|
2982
|
-
'
|
|
3028
|
+
'allowedRelationshipTypes'?: Array<AllowedRelationshipType>;
|
|
2983
3029
|
/**
|
|
2984
3030
|
* Turn on deep search. If true, content of complex objects will be searched as well, e.g. metrics in visualizations.
|
|
2985
3031
|
*/
|
|
2986
3032
|
'deepSearch'?: boolean;
|
|
2987
3033
|
/**
|
|
2988
|
-
*
|
|
2989
|
-
*/
|
|
2990
|
-
'limit'?: number;
|
|
2991
|
-
/**
|
|
2992
|
-
* Temporary for experiments. Ratio of title score to descriptor score.
|
|
3034
|
+
* If true, enables hybrid search combining vector similarity and keyword matching. This can improve search results by considering both semantic similarity and exact keyword matches.
|
|
2993
3035
|
*/
|
|
2994
|
-
'
|
|
3036
|
+
'enableHybridSearch'?: boolean;
|
|
2995
3037
|
/**
|
|
2996
|
-
*
|
|
3038
|
+
* Exclude objects that contain any of the specified tags. This parameter only affects the search results. Objects with excluded tags are completely hidden from the results.
|
|
2997
3039
|
*/
|
|
2998
|
-
'
|
|
3040
|
+
'excludeTags'?: Array<string>;
|
|
2999
3041
|
/**
|
|
3000
3042
|
* If true, includes hidden objects in search results. If false (default), excludes objects where isHidden=true.
|
|
3001
3043
|
*/
|
|
@@ -3005,70 +3047,62 @@ export interface SearchRequest {
|
|
|
3005
3047
|
*/
|
|
3006
3048
|
'includeTags'?: Array<string>;
|
|
3007
3049
|
/**
|
|
3008
|
-
*
|
|
3050
|
+
* Maximum number of results to return. There is a hard limit and the actual number of returned results may be lower than what is requested. This can happen when post-search filters are applied (e.g., reranker threshold filtering or allowedRelationshipTypes filtering), which may exclude some results after the initial search.
|
|
3051
|
+
*/
|
|
3052
|
+
'limit'?: number;
|
|
3053
|
+
/**
|
|
3054
|
+
* List of object types to search for.
|
|
3055
|
+
*/
|
|
3056
|
+
'objectTypes'?: Array<SearchRequestObjectTypesEnum>;
|
|
3057
|
+
/**
|
|
3058
|
+
* Keyword/sentence is input for search.
|
|
3009
3059
|
*/
|
|
3010
|
-
'
|
|
3060
|
+
'question': string;
|
|
3011
3061
|
/**
|
|
3012
|
-
*
|
|
3062
|
+
* Score, above which we return found objects. Below this score objects are not relevant.
|
|
3013
3063
|
*/
|
|
3014
|
-
'
|
|
3064
|
+
'relevantScoreThreshold'?: number;
|
|
3015
3065
|
/**
|
|
3016
|
-
*
|
|
3066
|
+
* Temporary for experiments. Ratio of title score to descriptor score.
|
|
3017
3067
|
*/
|
|
3018
|
-
'
|
|
3068
|
+
'titleToDescriptorRatio'?: number;
|
|
3019
3069
|
}
|
|
3020
3070
|
export type SearchRequestObjectTypesEnum = 'attribute' | 'metric' | 'fact' | 'label' | 'date' | 'dataset' | 'visualization' | 'dashboard';
|
|
3021
3071
|
export interface SearchResult {
|
|
3022
|
-
'
|
|
3023
|
-
'relationships': Array<SearchRelationshipObject>;
|
|
3072
|
+
'error'?: ErrorInfo;
|
|
3024
3073
|
/**
|
|
3025
3074
|
* DEPRECATED: Use top-level reasoning.steps instead. If something is not working properly this field will contain explanation.
|
|
3026
3075
|
*/
|
|
3027
3076
|
'reasoning': string;
|
|
3028
|
-
'
|
|
3077
|
+
'relationships': Array<SearchRelationshipObject>;
|
|
3078
|
+
'results': Array<SearchResultObject>;
|
|
3029
3079
|
}
|
|
3030
3080
|
export interface SearchResultObject {
|
|
3081
|
+
'certification'?: CertificationInfo;
|
|
3031
3082
|
/**
|
|
3032
|
-
*
|
|
3033
|
-
*/
|
|
3034
|
-
'id': string;
|
|
3035
|
-
/**
|
|
3036
|
-
* Object type, e.g. dashboard.
|
|
3037
|
-
*/
|
|
3038
|
-
'type': string;
|
|
3039
|
-
/**
|
|
3040
|
-
* Workspace ID.
|
|
3041
|
-
*/
|
|
3042
|
-
'workspaceId': string;
|
|
3043
|
-
/**
|
|
3044
|
-
* Object title.
|
|
3083
|
+
* Timestamp when object was created.
|
|
3045
3084
|
*/
|
|
3046
|
-
'
|
|
3085
|
+
'createdAt'?: string;
|
|
3047
3086
|
/**
|
|
3048
3087
|
* Object description.
|
|
3049
3088
|
*/
|
|
3050
3089
|
'description'?: string;
|
|
3051
|
-
'tags'?: Array<string>;
|
|
3052
3090
|
/**
|
|
3053
|
-
*
|
|
3091
|
+
* Object ID.
|
|
3054
3092
|
*/
|
|
3055
|
-
'
|
|
3093
|
+
'id': string;
|
|
3056
3094
|
/**
|
|
3057
|
-
*
|
|
3095
|
+
* If true, this object is hidden from AI search results by default.
|
|
3058
3096
|
*/
|
|
3059
|
-
'
|
|
3097
|
+
'isHidden'?: boolean;
|
|
3060
3098
|
/**
|
|
3061
|
-
*
|
|
3099
|
+
* Timestamp when object was last modified.
|
|
3062
3100
|
*/
|
|
3063
|
-
'
|
|
3101
|
+
'modifiedAt'?: string;
|
|
3064
3102
|
/**
|
|
3065
3103
|
* Result score calculated by a similarity search algorithm (cosine_distance).
|
|
3066
3104
|
*/
|
|
3067
3105
|
'score'?: number;
|
|
3068
|
-
/**
|
|
3069
|
-
* Result score for object title.
|
|
3070
|
-
*/
|
|
3071
|
-
'scoreTitle'?: number;
|
|
3072
3106
|
/**
|
|
3073
3107
|
* Result score for descriptor containing(now) description and tags.
|
|
3074
3108
|
*/
|
|
@@ -3078,23 +3112,39 @@ export interface SearchResultObject {
|
|
|
3078
3112
|
*/
|
|
3079
3113
|
'scoreExactMatch'?: number;
|
|
3080
3114
|
/**
|
|
3081
|
-
*
|
|
3115
|
+
* Result score for object title.
|
|
3082
3116
|
*/
|
|
3083
|
-
'
|
|
3084
|
-
'
|
|
3117
|
+
'scoreTitle'?: number;
|
|
3118
|
+
'tags'?: Array<string>;
|
|
3119
|
+
/**
|
|
3120
|
+
* Object title.
|
|
3121
|
+
*/
|
|
3122
|
+
'title': string;
|
|
3123
|
+
/**
|
|
3124
|
+
* Object type, e.g. dashboard.
|
|
3125
|
+
*/
|
|
3126
|
+
'type': string;
|
|
3127
|
+
/**
|
|
3128
|
+
* If the object is visualization, this field defines the type of visualization.
|
|
3129
|
+
*/
|
|
3130
|
+
'visualizationUrl'?: string;
|
|
3131
|
+
/**
|
|
3132
|
+
* Workspace ID.
|
|
3133
|
+
*/
|
|
3134
|
+
'workspaceId': string;
|
|
3085
3135
|
}
|
|
3086
3136
|
/**
|
|
3087
3137
|
* Non-sensitive metadata for an AI Lake pipeline
|
|
3088
3138
|
*/
|
|
3089
3139
|
export interface ServiceInfo {
|
|
3090
|
-
/**
|
|
3091
|
-
* Internal identifier for the service configuration (UUID)
|
|
3092
|
-
*/
|
|
3093
|
-
'serviceId': string;
|
|
3094
3140
|
/**
|
|
3095
3141
|
* Human-readable name of the service
|
|
3096
3142
|
*/
|
|
3097
3143
|
'name': string;
|
|
3144
|
+
/**
|
|
3145
|
+
* Internal identifier for the service configuration (UUID)
|
|
3146
|
+
*/
|
|
3147
|
+
'serviceId': string;
|
|
3098
3148
|
}
|
|
3099
3149
|
/**
|
|
3100
3150
|
* Metric defined by referencing a MAQL metric or an LDM fact object with aggregation.
|
|
@@ -3103,7 +3153,6 @@ export interface SimpleMeasureDefinition {
|
|
|
3103
3153
|
'measure': SimpleMeasureDefinitionMeasure;
|
|
3104
3154
|
}
|
|
3105
3155
|
export interface SimpleMeasureDefinitionMeasure {
|
|
3106
|
-
'item': AfmObjectIdentifierCore;
|
|
3107
3156
|
/**
|
|
3108
3157
|
* Definition of aggregation type of the metric.
|
|
3109
3158
|
*/
|
|
@@ -3116,6 +3165,7 @@ export interface SimpleMeasureDefinitionMeasure {
|
|
|
3116
3165
|
* Metrics can be filtered by attribute filters with the same interface as ones for global AFM. Note that only one DateFilter is allowed.
|
|
3117
3166
|
*/
|
|
3118
3167
|
'filters'?: Array<FilterDefinitionForSimpleMeasure>;
|
|
3168
|
+
'item': AfmObjectIdentifierCore;
|
|
3119
3169
|
}
|
|
3120
3170
|
export type SimpleMeasureDefinitionMeasureAggregationEnum = 'SUM' | 'COUNT' | 'AVG' | 'MIN' | 'MAX' | 'MEDIAN' | 'RUNSUM' | 'APPROXIMATE_COUNT';
|
|
3121
3171
|
export interface SmartFunctionResponse {
|
|
@@ -3136,17 +3186,17 @@ export interface SortKeyAttributeAttribute {
|
|
|
3136
3186
|
* Item reference (to \'itemIdentifiers\') referencing, which item should be used for sorting. Only references to attributes are allowed.
|
|
3137
3187
|
*/
|
|
3138
3188
|
'attributeIdentifier': string;
|
|
3139
|
-
/**
|
|
3140
|
-
* Mechanism by which this attribute should be sorted. Available options are: - DEFAULT: sorting based on default rules (using sort column if defined, otherwise this label) - LABEL: sorting by this label values - ATTRIBUTE: sorting by values of this label\'s attribute (or rather the primary label) - ATTRIBUTE: sorting by values of this label\'s attribute (or rather the primary label)- AREA: sorting by area (total or subtotal) corresponding to each attribute value. The area is computed by summing up all metric values in all other dimensions.
|
|
3141
|
-
*/
|
|
3142
|
-
'sortType'?: SortKeyAttributeAttributeSortTypeEnum;
|
|
3143
3189
|
/**
|
|
3144
3190
|
* Sorting elements - ascending/descending order.
|
|
3145
3191
|
*/
|
|
3146
3192
|
'direction'?: SortKeyAttributeAttributeDirectionEnum;
|
|
3193
|
+
/**
|
|
3194
|
+
* Mechanism by which this attribute should be sorted. Available options are: - DEFAULT: sorting based on default rules (using sort column if defined, otherwise this label) - LABEL: sorting by this label values - ATTRIBUTE: sorting by values of this label\'s attribute (or rather the primary label) - ATTRIBUTE: sorting by values of this label\'s attribute (or rather the primary label)- AREA: sorting by area (total or subtotal) corresponding to each attribute value. The area is computed by summing up all metric values in all other dimensions.
|
|
3195
|
+
*/
|
|
3196
|
+
'sortType'?: SortKeyAttributeAttributeSortTypeEnum;
|
|
3147
3197
|
}
|
|
3148
|
-
export type SortKeyAttributeAttributeSortTypeEnum = 'DEFAULT' | 'LABEL' | 'ATTRIBUTE' | 'AREA';
|
|
3149
3198
|
export type SortKeyAttributeAttributeDirectionEnum = 'ASC' | 'DESC';
|
|
3199
|
+
export type SortKeyAttributeAttributeSortTypeEnum = 'DEFAULT' | 'LABEL' | 'ATTRIBUTE' | 'AREA';
|
|
3150
3200
|
/**
|
|
3151
3201
|
* Sorting rule for sorting by total value. DataColumnLocators are only required if there is ambiguity. Locator for measureGroup is taken from the metric of the total.
|
|
3152
3202
|
*/
|
|
@@ -3154,15 +3204,15 @@ export interface SortKeyTotal {
|
|
|
3154
3204
|
'total': SortKeyTotalTotal;
|
|
3155
3205
|
}
|
|
3156
3206
|
export interface SortKeyTotalTotal {
|
|
3157
|
-
/**
|
|
3158
|
-
* Local identifier of the total to sort by.
|
|
3159
|
-
*/
|
|
3160
|
-
'totalIdentifier': string;
|
|
3161
3207
|
'dataColumnLocators'?: DataColumnLocators;
|
|
3162
3208
|
/**
|
|
3163
3209
|
* Sorting elements - ascending/descending order.
|
|
3164
3210
|
*/
|
|
3165
3211
|
'direction'?: SortKeyTotalTotalDirectionEnum;
|
|
3212
|
+
/**
|
|
3213
|
+
* Local identifier of the total to sort by.
|
|
3214
|
+
*/
|
|
3215
|
+
'totalIdentifier': string;
|
|
3166
3216
|
}
|
|
3167
3217
|
export type SortKeyTotalTotalDirectionEnum = 'ASC' | 'DESC';
|
|
3168
3218
|
/**
|
|
@@ -3192,46 +3242,50 @@ export interface SucceededOperation extends Operation {
|
|
|
3192
3242
|
* List of suggestions for next steps. Filled when no visualization was created, suggests alternatives.
|
|
3193
3243
|
*/
|
|
3194
3244
|
export interface Suggestion {
|
|
3195
|
-
/**
|
|
3196
|
-
* Suggestion query
|
|
3197
|
-
*/
|
|
3198
|
-
'query': string;
|
|
3199
3245
|
/**
|
|
3200
3246
|
* Suggestion button label
|
|
3201
3247
|
*/
|
|
3202
3248
|
'label': string;
|
|
3249
|
+
/**
|
|
3250
|
+
* Suggestion query
|
|
3251
|
+
*/
|
|
3252
|
+
'query': string;
|
|
3203
3253
|
}
|
|
3204
3254
|
export interface TestLlmProviderByIdRequest {
|
|
3205
|
-
'providerConfig'?: TestLlmProviderByIdRequestProviderConfig;
|
|
3206
3255
|
/**
|
|
3207
3256
|
* Models overrides.
|
|
3208
3257
|
*/
|
|
3209
3258
|
'models'?: Array<LlmModel>;
|
|
3259
|
+
'providerConfig'?: TestLlmProviderByIdRequestProviderConfig;
|
|
3210
3260
|
}
|
|
3211
3261
|
/**
|
|
3212
3262
|
* @type TestLlmProviderByIdRequestProviderConfig
|
|
3213
3263
|
*/
|
|
3214
3264
|
export type TestLlmProviderByIdRequestProviderConfig = AnthropicProviderConfig | AwsBedrockProviderConfig | AzureFoundryProviderConfig | OpenAIProviderConfig;
|
|
3215
3265
|
export interface TestLlmProviderDefinitionRequest {
|
|
3216
|
-
'providerConfig': TestLlmProviderByIdRequestProviderConfig;
|
|
3217
3266
|
/**
|
|
3218
3267
|
* Models to test.
|
|
3219
3268
|
*/
|
|
3220
3269
|
'models'?: Array<LlmModel>;
|
|
3270
|
+
'providerConfig': TestLlmProviderDefinitionRequestProviderConfig;
|
|
3221
3271
|
}
|
|
3272
|
+
/**
|
|
3273
|
+
* @type TestLlmProviderDefinitionRequestProviderConfig
|
|
3274
|
+
*/
|
|
3275
|
+
export type TestLlmProviderDefinitionRequestProviderConfig = AnthropicProviderConfig | AwsBedrockProviderConfig | AzureFoundryProviderConfig | OpenAIProviderConfig;
|
|
3222
3276
|
export interface TestLlmProviderResponse {
|
|
3223
3277
|
/**
|
|
3224
|
-
*
|
|
3278
|
+
* Per-model test results.
|
|
3225
3279
|
*/
|
|
3226
|
-
'
|
|
3280
|
+
'modelResults': Array<ModelTestResult>;
|
|
3227
3281
|
/**
|
|
3228
3282
|
* Message about the provider connectivity test.
|
|
3229
3283
|
*/
|
|
3230
3284
|
'providerMessage': string;
|
|
3231
3285
|
/**
|
|
3232
|
-
*
|
|
3286
|
+
* Whether the LLM provider is reachable.
|
|
3233
3287
|
*/
|
|
3234
|
-
'
|
|
3288
|
+
'providerReachable': boolean;
|
|
3235
3289
|
}
|
|
3236
3290
|
/**
|
|
3237
3291
|
* Detailed thoughts/messages within this step.
|
|
@@ -3250,28 +3304,28 @@ export interface TimeSlicePartitionConfig {
|
|
|
3250
3304
|
* Column to partition on.
|
|
3251
3305
|
*/
|
|
3252
3306
|
'column': string;
|
|
3253
|
-
/**
|
|
3254
|
-
* Date/time unit for partition granularity
|
|
3255
|
-
*/
|
|
3256
|
-
'unit': TimeSlicePartitionConfigUnitEnum;
|
|
3257
3307
|
/**
|
|
3258
3308
|
* How many units per slice.
|
|
3259
3309
|
*/
|
|
3260
3310
|
'slices': number;
|
|
3311
|
+
/**
|
|
3312
|
+
* Date/time unit for partition granularity
|
|
3313
|
+
*/
|
|
3314
|
+
'unit': TimeSlicePartitionConfigUnitEnum;
|
|
3261
3315
|
}
|
|
3262
3316
|
export type TimeSlicePartitionConfigUnitEnum = 'year' | 'quarter' | 'month' | 'week' | 'day' | 'hour' | 'minute' | 'second' | 'millisecond' | 'microsecond';
|
|
3263
3317
|
/**
|
|
3264
3318
|
* Definition of a total. There are two types of totals: grand totals and subtotals. Grand total data will be returned in a separate section of the result structure while subtotals are fully integrated into the main result data. The mechanism for this distinction is automatic and it\'s described in `TotalDimension`
|
|
3265
3319
|
*/
|
|
3266
3320
|
export interface Total {
|
|
3267
|
-
/**
|
|
3268
|
-
* Total identification within this request. Used e.g. in sorting by a total.
|
|
3269
|
-
*/
|
|
3270
|
-
'localIdentifier': string;
|
|
3271
3321
|
/**
|
|
3272
3322
|
* Aggregation function to compute the total.
|
|
3273
3323
|
*/
|
|
3274
3324
|
'function': TotalFunctionEnum;
|
|
3325
|
+
/**
|
|
3326
|
+
* Total identification within this request. Used e.g. in sorting by a total.
|
|
3327
|
+
*/
|
|
3328
|
+
'localIdentifier': string;
|
|
3275
3329
|
/**
|
|
3276
3330
|
* The metric for which the total will be computed
|
|
3277
3331
|
*/
|
|
@@ -3306,42 +3360,33 @@ export interface TotalResultHeader {
|
|
|
3306
3360
|
*/
|
|
3307
3361
|
export interface TrendingObjectItem {
|
|
3308
3362
|
/**
|
|
3309
|
-
*
|
|
3310
|
-
*/
|
|
3311
|
-
'id': string;
|
|
3312
|
-
/**
|
|
3313
|
-
* Object type, e.g. dashboard, visualization, metric.
|
|
3314
|
-
*/
|
|
3315
|
-
'type': string;
|
|
3316
|
-
/**
|
|
3317
|
-
* Workspace ID the object belongs to.
|
|
3363
|
+
* Timestamp when object was created.
|
|
3318
3364
|
*/
|
|
3319
|
-
'
|
|
3365
|
+
'createdAt'?: string;
|
|
3320
3366
|
/**
|
|
3321
|
-
*
|
|
3367
|
+
* ID of the user who created the object.
|
|
3322
3368
|
*/
|
|
3323
|
-
'
|
|
3369
|
+
'createdBy'?: string;
|
|
3324
3370
|
/**
|
|
3325
|
-
*
|
|
3371
|
+
* ID of the associated dataset, if applicable.
|
|
3326
3372
|
*/
|
|
3327
|
-
'
|
|
3328
|
-
'tags': Array<string>;
|
|
3373
|
+
'datasetId'?: string;
|
|
3329
3374
|
/**
|
|
3330
|
-
*
|
|
3375
|
+
* Title of the associated dataset, if applicable.
|
|
3331
3376
|
*/
|
|
3332
|
-
'
|
|
3377
|
+
'datasetTitle'?: string;
|
|
3333
3378
|
/**
|
|
3334
|
-
*
|
|
3379
|
+
* Type of the associated dataset, if applicable.
|
|
3335
3380
|
*/
|
|
3336
|
-
'
|
|
3381
|
+
'datasetType'?: string;
|
|
3337
3382
|
/**
|
|
3338
|
-
*
|
|
3383
|
+
* Object description.
|
|
3339
3384
|
*/
|
|
3340
|
-
'
|
|
3385
|
+
'description'?: string;
|
|
3341
3386
|
/**
|
|
3342
|
-
* ID
|
|
3387
|
+
* Object ID.
|
|
3343
3388
|
*/
|
|
3344
|
-
'
|
|
3389
|
+
'id': string;
|
|
3345
3390
|
/**
|
|
3346
3391
|
* If true, this object is hidden from AI search results by default.
|
|
3347
3392
|
*/
|
|
@@ -3350,30 +3395,39 @@ export interface TrendingObjectItem {
|
|
|
3350
3395
|
* If true, this object is hidden from KDA.
|
|
3351
3396
|
*/
|
|
3352
3397
|
'isHiddenFromKda'?: boolean;
|
|
3353
|
-
/**
|
|
3354
|
-
* URL of the visualization, if applicable.
|
|
3355
|
-
*/
|
|
3356
|
-
'visualizationUrl'?: string;
|
|
3357
3398
|
/**
|
|
3358
3399
|
* Type of the metric (e.g. MAQL), if applicable.
|
|
3359
3400
|
*/
|
|
3360
3401
|
'metricType'?: string;
|
|
3361
3402
|
/**
|
|
3362
|
-
*
|
|
3403
|
+
* Timestamp when object was last modified.
|
|
3363
3404
|
*/
|
|
3364
|
-
'
|
|
3405
|
+
'modifiedAt'?: string;
|
|
3365
3406
|
/**
|
|
3366
|
-
*
|
|
3407
|
+
* ID of the user who last modified the object.
|
|
3367
3408
|
*/
|
|
3368
|
-
'
|
|
3409
|
+
'modifiedBy'?: string;
|
|
3410
|
+
'tags': Array<string>;
|
|
3369
3411
|
/**
|
|
3370
|
-
*
|
|
3412
|
+
* Object title.
|
|
3371
3413
|
*/
|
|
3372
|
-
'
|
|
3414
|
+
'title': string;
|
|
3415
|
+
/**
|
|
3416
|
+
* Object type, e.g. dashboard, visualization, metric.
|
|
3417
|
+
*/
|
|
3418
|
+
'type': string;
|
|
3373
3419
|
/**
|
|
3374
3420
|
* Number of times this object has been used/referenced.
|
|
3375
3421
|
*/
|
|
3376
3422
|
'usageCount': number;
|
|
3423
|
+
/**
|
|
3424
|
+
* URL of the visualization, if applicable.
|
|
3425
|
+
*/
|
|
3426
|
+
'visualizationUrl'?: string;
|
|
3427
|
+
/**
|
|
3428
|
+
* Workspace ID the object belongs to.
|
|
3429
|
+
*/
|
|
3430
|
+
'workspaceId': string;
|
|
3377
3431
|
}
|
|
3378
3432
|
export interface TrendingObjectsResult {
|
|
3379
3433
|
'objects': Array<TrendingObjectItem>;
|
|
@@ -3438,12 +3492,12 @@ export interface UpdateDatabaseDataSourceResponse {
|
|
|
3438
3492
|
* User context with ambient UI state (view) and explicitly referenced objects.
|
|
3439
3493
|
*/
|
|
3440
3494
|
export interface UserContext {
|
|
3441
|
-
'
|
|
3495
|
+
'activeObject'?: ActiveObjectIdentification;
|
|
3442
3496
|
/**
|
|
3443
3497
|
* Groups of explicitly referenced objects, each optionally scoped by a context (e.g. a dashboard context with widget references).
|
|
3444
3498
|
*/
|
|
3445
3499
|
'referencedObjects'?: Array<ObjectReferenceGroup>;
|
|
3446
|
-
'
|
|
3500
|
+
'view'?: UIContext;
|
|
3447
3501
|
}
|
|
3448
3502
|
export interface ValidateByItem {
|
|
3449
3503
|
/**
|
|
@@ -3459,9 +3513,9 @@ export interface ValidateByItem {
|
|
|
3459
3513
|
* Visualization config for smart-function rendering.
|
|
3460
3514
|
*/
|
|
3461
3515
|
export interface VisualizationConfig {
|
|
3462
|
-
'forecast'?: ForecastConfig;
|
|
3463
3516
|
'anomalyDetection'?: AnomalyDetectionConfig;
|
|
3464
3517
|
'clustering'?: ClusteringConfig;
|
|
3518
|
+
'forecast'?: ForecastConfig;
|
|
3465
3519
|
'whatIf'?: WhatIfScenarioConfig;
|
|
3466
3520
|
}
|
|
3467
3521
|
export interface VisualizationObjectExecution {
|
|
@@ -3476,13 +3530,9 @@ export interface VisualizationObjectExecution {
|
|
|
3476
3530
|
*/
|
|
3477
3531
|
export interface VisualizationSwitcherWidgetDescriptor {
|
|
3478
3532
|
/**
|
|
3479
|
-
*
|
|
3480
|
-
*/
|
|
3481
|
-
'widgetId': string;
|
|
3482
|
-
/**
|
|
3483
|
-
* Widget title as displayed on the dashboard.
|
|
3533
|
+
* ID of the currently active visualization in the switcher.
|
|
3484
3534
|
*/
|
|
3485
|
-
'
|
|
3535
|
+
'activeVisualizationId': string;
|
|
3486
3536
|
/**
|
|
3487
3537
|
* Filters currently applied to the dashboard.
|
|
3488
3538
|
*/
|
|
@@ -3492,13 +3542,17 @@ export interface VisualizationSwitcherWidgetDescriptor {
|
|
|
3492
3542
|
*/
|
|
3493
3543
|
'resultId'?: string;
|
|
3494
3544
|
/**
|
|
3495
|
-
*
|
|
3545
|
+
* Widget title as displayed on the dashboard.
|
|
3496
3546
|
*/
|
|
3497
|
-
'
|
|
3547
|
+
'title': string;
|
|
3498
3548
|
/**
|
|
3499
3549
|
* IDs of all visualizations available in the switcher.
|
|
3500
3550
|
*/
|
|
3501
3551
|
'visualizationIds': Array<string>;
|
|
3552
|
+
/**
|
|
3553
|
+
* Widget object ID.
|
|
3554
|
+
*/
|
|
3555
|
+
'widgetId': string;
|
|
3502
3556
|
}
|
|
3503
3557
|
/**
|
|
3504
3558
|
* Measure adjustments for this scenario
|
|
@@ -3521,57 +3575,61 @@ export interface WhatIfMeasureAdjustmentConfig {
|
|
|
3521
3575
|
* What-if scenario configuration.
|
|
3522
3576
|
*/
|
|
3523
3577
|
export interface WhatIfScenarioConfig {
|
|
3524
|
-
/**
|
|
3525
|
-
* Scenarios with alternative measure calculations
|
|
3526
|
-
*/
|
|
3527
|
-
'scenarios': Array<WhatIfScenarioItem>;
|
|
3528
3578
|
/**
|
|
3529
3579
|
* Whether baseline (unmodified) values are included
|
|
3530
3580
|
*/
|
|
3531
3581
|
'includeBaseline': boolean;
|
|
3582
|
+
/**
|
|
3583
|
+
* Scenarios with alternative measure calculations
|
|
3584
|
+
*/
|
|
3585
|
+
'scenarios': Array<WhatIfScenarioItem>;
|
|
3532
3586
|
}
|
|
3533
3587
|
/**
|
|
3534
3588
|
* Scenarios with alternative measure calculations
|
|
3535
3589
|
*/
|
|
3536
3590
|
export interface WhatIfScenarioItem {
|
|
3537
|
-
/**
|
|
3538
|
-
* Human-readable scenario label
|
|
3539
|
-
*/
|
|
3540
|
-
'label': string;
|
|
3541
3591
|
/**
|
|
3542
3592
|
* Measure adjustments for this scenario
|
|
3543
3593
|
*/
|
|
3544
3594
|
'adjustments': Array<WhatIfMeasureAdjustmentConfig>;
|
|
3595
|
+
/**
|
|
3596
|
+
* Human-readable scenario label
|
|
3597
|
+
*/
|
|
3598
|
+
'label': string;
|
|
3545
3599
|
}
|
|
3546
3600
|
/**
|
|
3547
3601
|
* Descriptor for a widget on the dashboard.
|
|
3548
3602
|
*/
|
|
3549
3603
|
export interface WidgetDescriptor {
|
|
3550
|
-
'filters'?: Array<
|
|
3604
|
+
'filters'?: Array<WidgetDescriptorFiltersInner>;
|
|
3551
3605
|
'title': string;
|
|
3552
3606
|
'widgetId': string;
|
|
3553
3607
|
'widgetType': string;
|
|
3554
3608
|
}
|
|
3609
|
+
/**
|
|
3610
|
+
* @type WidgetDescriptorFiltersInner
|
|
3611
|
+
*/
|
|
3612
|
+
export type WidgetDescriptorFiltersInner = AbstractMeasureValueFilter | FilterDefinitionForSimpleMeasure | InlineFilterDefinition;
|
|
3555
3613
|
export interface WorkflowDashboardSummaryRequestDto {
|
|
3614
|
+
'customUserPrompt'?: string;
|
|
3556
3615
|
'dashboardId': string;
|
|
3557
3616
|
'keyMetricIds'?: Array<string>;
|
|
3558
3617
|
'referenceQuarter'?: string;
|
|
3559
|
-
'customUserPrompt'?: string;
|
|
3560
3618
|
}
|
|
3561
3619
|
export interface WorkflowDashboardSummaryResponseDto {
|
|
3620
|
+
'message': string;
|
|
3562
3621
|
'runId': string;
|
|
3563
3622
|
'status': string;
|
|
3564
|
-
'message': string;
|
|
3565
3623
|
}
|
|
3566
3624
|
export interface WorkflowStatusResponseDto {
|
|
3567
|
-
'
|
|
3568
|
-
'
|
|
3625
|
+
'currentPhase'?: string;
|
|
3626
|
+
'error'?: string;
|
|
3569
3627
|
'message': string;
|
|
3570
3628
|
'result'?: {
|
|
3571
3629
|
[key: string]: object;
|
|
3572
3630
|
};
|
|
3573
|
-
'
|
|
3574
|
-
'
|
|
3631
|
+
'runId': string;
|
|
3632
|
+
'status': string;
|
|
3575
3633
|
}
|
|
3576
3634
|
/**
|
|
3577
3635
|
* (BETA) Associates an additional metadata-api data source with an existing AI Lake database instance. The new data source uses the same StarRocks connection details as the primary data source.
|