@gooddata/api-client-tiger 10.42.0-alpha.3 → 10.42.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.
Files changed (92) hide show
  1. package/esm/__version.d.ts +2 -1
  2. package/esm/__version.d.ts.map +1 -1
  3. package/esm/__version.js +2 -1
  4. package/esm/__version.js.map +1 -1
  5. package/esm/api-client-tiger.d.ts +658 -17668
  6. package/esm/generated/afm-rest-api/api.d.ts +41 -1883
  7. package/esm/generated/afm-rest-api/api.d.ts.map +1 -1
  8. package/esm/generated/afm-rest-api/api.js +0 -18
  9. package/esm/generated/afm-rest-api/api.js.map +1 -1
  10. package/esm/generated/afm-rest-api/base.d.ts +11 -24
  11. package/esm/generated/afm-rest-api/base.d.ts.map +1 -1
  12. package/esm/generated/afm-rest-api/base.js +3 -19
  13. package/esm/generated/afm-rest-api/base.js.map +1 -1
  14. package/esm/generated/afm-rest-api/configuration.d.ts +5 -14
  15. package/esm/generated/afm-rest-api/configuration.d.ts.map +1 -1
  16. package/esm/generated/afm-rest-api/configuration.js +11 -15
  17. package/esm/generated/afm-rest-api/configuration.js.map +1 -1
  18. package/esm/generated/auth-json-api/api.d.ts +15 -230
  19. package/esm/generated/auth-json-api/api.d.ts.map +1 -1
  20. package/esm/generated/auth-json-api/api.js.map +1 -1
  21. package/esm/generated/auth-json-api/base.d.ts +11 -24
  22. package/esm/generated/auth-json-api/base.d.ts.map +1 -1
  23. package/esm/generated/auth-json-api/base.js +3 -19
  24. package/esm/generated/auth-json-api/base.js.map +1 -1
  25. package/esm/generated/auth-json-api/configuration.d.ts +5 -14
  26. package/esm/generated/auth-json-api/configuration.d.ts.map +1 -1
  27. package/esm/generated/auth-json-api/configuration.js +11 -15
  28. package/esm/generated/auth-json-api/configuration.js.map +1 -1
  29. package/esm/generated/automation-json-api/api.d.ts +33 -1837
  30. package/esm/generated/automation-json-api/api.d.ts.map +1 -1
  31. package/esm/generated/automation-json-api/api.js +2 -2
  32. package/esm/generated/automation-json-api/api.js.map +1 -1
  33. package/esm/generated/automation-json-api/base.d.ts +11 -24
  34. package/esm/generated/automation-json-api/base.d.ts.map +1 -1
  35. package/esm/generated/automation-json-api/base.js +3 -19
  36. package/esm/generated/automation-json-api/base.js.map +1 -1
  37. package/esm/generated/automation-json-api/configuration.d.ts +5 -14
  38. package/esm/generated/automation-json-api/configuration.d.ts.map +1 -1
  39. package/esm/generated/automation-json-api/configuration.js +11 -15
  40. package/esm/generated/automation-json-api/configuration.js.map +1 -1
  41. package/esm/generated/export-json-api/api.d.ts +35 -1046
  42. package/esm/generated/export-json-api/api.d.ts.map +1 -1
  43. package/esm/generated/export-json-api/api.js.map +1 -1
  44. package/esm/generated/export-json-api/base.d.ts +11 -24
  45. package/esm/generated/export-json-api/base.d.ts.map +1 -1
  46. package/esm/generated/export-json-api/base.js +3 -19
  47. package/esm/generated/export-json-api/base.js.map +1 -1
  48. package/esm/generated/export-json-api/configuration.d.ts +5 -14
  49. package/esm/generated/export-json-api/configuration.d.ts.map +1 -1
  50. package/esm/generated/export-json-api/configuration.js +11 -15
  51. package/esm/generated/export-json-api/configuration.js.map +1 -1
  52. package/esm/generated/metadata-json-api/api.d.ts +496 -12213
  53. package/esm/generated/metadata-json-api/api.d.ts.map +1 -1
  54. package/esm/generated/metadata-json-api/api.js +92 -110
  55. package/esm/generated/metadata-json-api/api.js.map +1 -1
  56. package/esm/generated/metadata-json-api/base.d.ts +11 -24
  57. package/esm/generated/metadata-json-api/base.d.ts.map +1 -1
  58. package/esm/generated/metadata-json-api/base.js +3 -19
  59. package/esm/generated/metadata-json-api/base.js.map +1 -1
  60. package/esm/generated/metadata-json-api/configuration.d.ts +5 -14
  61. package/esm/generated/metadata-json-api/configuration.d.ts.map +1 -1
  62. package/esm/generated/metadata-json-api/configuration.js +11 -15
  63. package/esm/generated/metadata-json-api/configuration.js.map +1 -1
  64. package/esm/generated/metadata-json-api/openapi-spec.json +9762 -9762
  65. package/esm/generated/result-json-api/api.d.ts +12 -317
  66. package/esm/generated/result-json-api/api.d.ts.map +1 -1
  67. package/esm/generated/result-json-api/api.js +4 -4
  68. package/esm/generated/result-json-api/api.js.map +1 -1
  69. package/esm/generated/result-json-api/base.d.ts +11 -24
  70. package/esm/generated/result-json-api/base.d.ts.map +1 -1
  71. package/esm/generated/result-json-api/base.js +3 -19
  72. package/esm/generated/result-json-api/base.js.map +1 -1
  73. package/esm/generated/result-json-api/configuration.d.ts +5 -14
  74. package/esm/generated/result-json-api/configuration.d.ts.map +1 -1
  75. package/esm/generated/result-json-api/configuration.js +11 -15
  76. package/esm/generated/result-json-api/configuration.js.map +1 -1
  77. package/esm/generated/scan-json-api/api.d.ts +4 -369
  78. package/esm/generated/scan-json-api/api.d.ts.map +1 -1
  79. package/esm/generated/scan-json-api/api.js.map +1 -1
  80. package/esm/generated/scan-json-api/base.d.ts +11 -24
  81. package/esm/generated/scan-json-api/base.d.ts.map +1 -1
  82. package/esm/generated/scan-json-api/base.js +3 -19
  83. package/esm/generated/scan-json-api/base.js.map +1 -1
  84. package/esm/generated/scan-json-api/configuration.d.ts +5 -14
  85. package/esm/generated/scan-json-api/configuration.d.ts.map +1 -1
  86. package/esm/generated/scan-json-api/configuration.js +11 -15
  87. package/esm/generated/scan-json-api/configuration.js.map +1 -1
  88. package/esm/index.d.ts +4 -3
  89. package/esm/index.d.ts.map +1 -1
  90. package/esm/index.js +1 -1
  91. package/esm/index.js.map +1 -1
  92. package/package.json +5 -5
@@ -14,230 +14,103 @@ import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from "axios";
14
14
  import { RequestArgs, BaseAPI } from './base.js';
15
15
  /**
16
16
  * Top level executable entity. Combination of [A]ttributes, [F]ilters & [M]etrics.
17
- * @export
18
- * @interface AFM
19
17
  */
20
18
  export interface AFM {
21
19
  /**
22
20
  * Attributes to be used in the computation.
23
- * @type {Array<AttributeItem>}
24
- * @memberof AFM
25
21
  */
26
22
  attributes: Array<AttributeItem>;
27
23
  /**
28
24
  * Various filter types to filter the execution result.
29
- * @type {Array<FilterDefinition>}
30
- * @memberof AFM
31
25
  */
32
26
  filters: Array<FilterDefinition>;
33
27
  /**
34
28
  * Metrics to be computed.
35
- * @type {Array<MeasureItem>}
36
- * @memberof AFM
37
29
  */
38
30
  measures: Array<MeasureItem>;
39
31
  /**
40
32
  * Metrics to be referenced from other AFM objects (e.g. filters) but not included in the result.
41
- * @type {Array<MeasureItem>}
42
- * @memberof AFM
43
33
  */
44
34
  auxMeasures?: Array<MeasureItem>;
45
35
  }
46
36
  /**
47
37
  * A datetime filter specifying exact from and to values.
48
- * @export
49
- * @interface AbsoluteDateFilter
50
38
  */
51
39
  export interface AbsoluteDateFilter {
52
- /**
53
- *
54
- * @type {AbsoluteDateFilterAbsoluteDateFilter}
55
- * @memberof AbsoluteDateFilter
56
- */
57
40
  absoluteDateFilter: AbsoluteDateFilterAbsoluteDateFilter;
58
41
  }
59
- /**
60
- *
61
- * @export
62
- * @interface AbsoluteDateFilterAbsoluteDateFilter
63
- */
64
42
  export interface AbsoluteDateFilterAbsoluteDateFilter {
65
- /**
66
- *
67
- * @type {string}
68
- * @memberof AbsoluteDateFilterAbsoluteDateFilter
69
- */
70
43
  from: string;
71
- /**
72
- *
73
- * @type {string}
74
- * @memberof AbsoluteDateFilterAbsoluteDateFilter
75
- */
76
44
  to: string;
77
- /**
78
- *
79
- * @type {string}
80
- * @memberof AbsoluteDateFilterAbsoluteDateFilter
81
- */
82
45
  localIdentifier?: string;
83
- /**
84
- *
85
- * @type {boolean}
86
- * @memberof AbsoluteDateFilterAbsoluteDateFilter
87
- */
88
46
  applyOnResult?: boolean;
89
- /**
90
- *
91
- * @type {AfmObjectIdentifierDataset}
92
- * @memberof AbsoluteDateFilterAbsoluteDateFilter
93
- */
94
47
  dataset: AfmObjectIdentifierDataset;
95
48
  }
96
49
  /**
97
50
  * @type AbstractMeasureValueFilter
98
- * @export
99
51
  */
100
52
  export type AbstractMeasureValueFilter = ComparisonMeasureValueFilter | RangeMeasureValueFilter | RankingFilter;
101
53
  /**
102
54
  * Object, with which the user is actively working.
103
- * @export
104
- * @interface ActiveObjectIdentification
105
55
  */
106
56
  export interface ActiveObjectIdentification {
107
57
  /**
108
58
  * Object ID.
109
- * @type {string}
110
- * @memberof ActiveObjectIdentification
111
59
  */
112
60
  id: string;
113
61
  /**
114
62
  * Object type, e.g. dashboard.
115
- * @type {string}
116
- * @memberof ActiveObjectIdentification
117
63
  */
118
64
  type: string;
119
65
  /**
120
66
  * Workspace ID.
121
- * @type {string}
122
- * @memberof ActiveObjectIdentification
123
67
  */
124
68
  workspaceId: string;
125
69
  }
126
70
  /**
127
71
  * Any information related to cancellation.
128
- * @export
129
- * @interface AfmCancelTokens
130
72
  */
131
73
  export interface AfmCancelTokens {
132
74
  /**
133
75
  * resultId to cancel token pairs
134
- * @type {{ [key: string]: string; }}
135
- * @memberof AfmCancelTokens
136
76
  */
137
77
  resultIdToCancelTokenPairs: {
138
78
  [key: string]: string;
139
79
  };
140
80
  }
141
- /**
142
- *
143
- * @export
144
- * @interface AfmExecution
145
- */
146
81
  export interface AfmExecution {
147
- /**
148
- *
149
- * @type {AFM}
150
- * @memberof AfmExecution
151
- */
152
82
  execution: AFM;
153
- /**
154
- *
155
- * @type {ResultSpec}
156
- * @memberof AfmExecution
157
- */
158
83
  resultSpec: ResultSpec;
159
- /**
160
- *
161
- * @type {ExecutionSettings}
162
- * @memberof AfmExecution
163
- */
164
84
  settings?: ExecutionSettings;
165
85
  }
166
86
  /**
167
87
  * Response to AFM execution request
168
- * @export
169
- * @interface AfmExecutionResponse
170
88
  */
171
89
  export interface AfmExecutionResponse {
172
- /**
173
- *
174
- * @type {ExecutionResponse}
175
- * @memberof AfmExecutionResponse
176
- */
177
90
  executionResponse: ExecutionResponse;
178
91
  }
179
92
  /**
180
93
  * @type AfmIdentifier
181
94
  * Reference to the attribute label to which the filter should be applied.
182
- * @export
183
95
  */
184
96
  export type AfmIdentifier = AfmLocalIdentifier | AfmObjectIdentifier;
185
- /**
186
- *
187
- * @export
188
- * @interface AfmLocalIdentifier
189
- */
190
97
  export interface AfmLocalIdentifier {
191
- /**
192
- *
193
- * @type {string}
194
- * @memberof AfmLocalIdentifier
195
- */
196
98
  localIdentifier: string;
197
99
  }
198
100
  /**
199
101
  * ObjectIdentifier with `identifier` wrapper. This serves to distinguish MD object identifiers in AFM request from local identifiers.
200
- * @export
201
- * @interface AfmObjectIdentifier
202
102
  */
203
103
  export interface AfmObjectIdentifier {
204
- /**
205
- *
206
- * @type {AfmObjectIdentifierIdentifier}
207
- * @memberof AfmObjectIdentifier
208
- */
209
104
  identifier: AfmObjectIdentifierIdentifier;
210
105
  }
211
106
  /**
212
107
  * Reference to the date attribute to use.
213
- * @export
214
- * @interface AfmObjectIdentifierAttribute
215
108
  */
216
109
  export interface AfmObjectIdentifierAttribute {
217
- /**
218
- *
219
- * @type {AfmObjectIdentifierAttributeIdentifier}
220
- * @memberof AfmObjectIdentifierAttribute
221
- */
222
110
  identifier: AfmObjectIdentifierAttributeIdentifier;
223
111
  }
224
- /**
225
- *
226
- * @export
227
- * @interface AfmObjectIdentifierAttributeIdentifier
228
- */
229
112
  export interface AfmObjectIdentifierAttributeIdentifier {
230
- /**
231
- *
232
- * @type {string}
233
- * @memberof AfmObjectIdentifierAttributeIdentifier
234
- */
235
113
  id: string;
236
- /**
237
- *
238
- * @type {string}
239
- * @memberof AfmObjectIdentifierAttributeIdentifier
240
- */
241
114
  type: AfmObjectIdentifierAttributeIdentifierTypeEnum;
242
115
  }
243
116
  export declare const AfmObjectIdentifierAttributeIdentifierTypeEnum: {
@@ -246,34 +119,12 @@ export declare const AfmObjectIdentifierAttributeIdentifierTypeEnum: {
246
119
  export type AfmObjectIdentifierAttributeIdentifierTypeEnum = (typeof AfmObjectIdentifierAttributeIdentifierTypeEnum)[keyof typeof AfmObjectIdentifierAttributeIdentifierTypeEnum];
247
120
  /**
248
121
  * Reference to the metric, fact or attribute object to use for the metric.
249
- * @export
250
- * @interface AfmObjectIdentifierCore
251
122
  */
252
123
  export interface AfmObjectIdentifierCore {
253
- /**
254
- *
255
- * @type {AfmObjectIdentifierCoreIdentifier}
256
- * @memberof AfmObjectIdentifierCore
257
- */
258
124
  identifier: AfmObjectIdentifierCoreIdentifier;
259
125
  }
260
- /**
261
- *
262
- * @export
263
- * @interface AfmObjectIdentifierCoreIdentifier
264
- */
265
126
  export interface AfmObjectIdentifierCoreIdentifier {
266
- /**
267
- *
268
- * @type {string}
269
- * @memberof AfmObjectIdentifierCoreIdentifier
270
- */
271
127
  id: string;
272
- /**
273
- *
274
- * @type {string}
275
- * @memberof AfmObjectIdentifierCoreIdentifier
276
- */
277
128
  type: AfmObjectIdentifierCoreIdentifierTypeEnum;
278
129
  }
279
130
  export declare const AfmObjectIdentifierCoreIdentifierTypeEnum: {
@@ -285,57 +136,20 @@ export declare const AfmObjectIdentifierCoreIdentifierTypeEnum: {
285
136
  export type AfmObjectIdentifierCoreIdentifierTypeEnum = (typeof AfmObjectIdentifierCoreIdentifierTypeEnum)[keyof typeof AfmObjectIdentifierCoreIdentifierTypeEnum];
286
137
  /**
287
138
  * Reference to the date dataset to which the filter should be applied.
288
- * @export
289
- * @interface AfmObjectIdentifierDataset
290
139
  */
291
140
  export interface AfmObjectIdentifierDataset {
292
- /**
293
- *
294
- * @type {AfmObjectIdentifierDatasetIdentifier}
295
- * @memberof AfmObjectIdentifierDataset
296
- */
297
141
  identifier: AfmObjectIdentifierDatasetIdentifier;
298
142
  }
299
- /**
300
- *
301
- * @export
302
- * @interface AfmObjectIdentifierDatasetIdentifier
303
- */
304
143
  export interface AfmObjectIdentifierDatasetIdentifier {
305
- /**
306
- *
307
- * @type {string}
308
- * @memberof AfmObjectIdentifierDatasetIdentifier
309
- */
310
144
  id: string;
311
- /**
312
- *
313
- * @type {string}
314
- * @memberof AfmObjectIdentifierDatasetIdentifier
315
- */
316
145
  type: AfmObjectIdentifierDatasetIdentifierTypeEnum;
317
146
  }
318
147
  export declare const AfmObjectIdentifierDatasetIdentifierTypeEnum: {
319
148
  readonly DATASET: "dataset";
320
149
  };
321
150
  export type AfmObjectIdentifierDatasetIdentifierTypeEnum = (typeof AfmObjectIdentifierDatasetIdentifierTypeEnum)[keyof typeof AfmObjectIdentifierDatasetIdentifierTypeEnum];
322
- /**
323
- *
324
- * @export
325
- * @interface AfmObjectIdentifierIdentifier
326
- */
327
151
  export interface AfmObjectIdentifierIdentifier {
328
- /**
329
- *
330
- * @type {string}
331
- * @memberof AfmObjectIdentifierIdentifier
332
- */
333
152
  type: AfmObjectIdentifierIdentifierTypeEnum;
334
- /**
335
- *
336
- * @type {string}
337
- * @memberof AfmObjectIdentifierIdentifier
338
- */
339
153
  id: string;
340
154
  }
341
155
  export declare const AfmObjectIdentifierIdentifierTypeEnum: {
@@ -351,36 +165,11 @@ export declare const AfmObjectIdentifierIdentifierTypeEnum: {
351
165
  readonly FILTER_CONTEXT: "filterContext";
352
166
  };
353
167
  export type AfmObjectIdentifierIdentifierTypeEnum = (typeof AfmObjectIdentifierIdentifierTypeEnum)[keyof typeof AfmObjectIdentifierIdentifierTypeEnum];
354
- /**
355
- *
356
- * @export
357
- * @interface AfmObjectIdentifierLabel
358
- */
359
168
  export interface AfmObjectIdentifierLabel {
360
- /**
361
- *
362
- * @type {AfmObjectIdentifierLabelIdentifier}
363
- * @memberof AfmObjectIdentifierLabel
364
- */
365
169
  identifier: AfmObjectIdentifierLabelIdentifier;
366
170
  }
367
- /**
368
- *
369
- * @export
370
- * @interface AfmObjectIdentifierLabelIdentifier
371
- */
372
171
  export interface AfmObjectIdentifierLabelIdentifier {
373
- /**
374
- *
375
- * @type {string}
376
- * @memberof AfmObjectIdentifierLabelIdentifier
377
- */
378
172
  type: AfmObjectIdentifierLabelIdentifierTypeEnum;
379
- /**
380
- *
381
- * @type {string}
382
- * @memberof AfmObjectIdentifierLabelIdentifier
383
- */
384
173
  id: string;
385
174
  }
386
175
  export declare const AfmObjectIdentifierLabelIdentifierTypeEnum: {
@@ -389,27 +178,19 @@ export declare const AfmObjectIdentifierLabelIdentifierTypeEnum: {
389
178
  export type AfmObjectIdentifierLabelIdentifierTypeEnum = (typeof AfmObjectIdentifierLabelIdentifierTypeEnum)[keyof typeof AfmObjectIdentifierLabelIdentifierTypeEnum];
390
179
  /**
391
180
  * Entity describing the valid descendants request.
392
- * @export
393
- * @interface AfmValidDescendantsQuery
394
181
  */
395
182
  export interface AfmValidDescendantsQuery {
396
183
  /**
397
184
  * List of identifiers of the attributes to get the valid descendants for.
398
- * @type {Array<AfmObjectIdentifierAttribute>}
399
- * @memberof AfmValidDescendantsQuery
400
185
  */
401
186
  attributes: Array<AfmObjectIdentifierAttribute>;
402
187
  }
403
188
  /**
404
189
  * Entity describing the valid descendants response.
405
- * @export
406
- * @interface AfmValidDescendantsResponse
407
190
  */
408
191
  export interface AfmValidDescendantsResponse {
409
192
  /**
410
193
  * Map of attribute identifiers to list of valid descendants identifiers.
411
- * @type {{ [key: string]: Array<AfmObjectIdentifierAttribute>; }}
412
- * @memberof AfmValidDescendantsResponse
413
194
  */
414
195
  validDescendants: {
415
196
  [key: string]: Array<AfmObjectIdentifierAttribute>;
@@ -417,21 +198,9 @@ export interface AfmValidDescendantsResponse {
417
198
  }
418
199
  /**
419
200
  * Entity holding AFM and list of object types whose validity should be computed.
420
- * @export
421
- * @interface AfmValidObjectsQuery
422
201
  */
423
202
  export interface AfmValidObjectsQuery {
424
- /**
425
- *
426
- * @type {Array<string>}
427
- * @memberof AfmValidObjectsQuery
428
- */
429
203
  types: Array<AfmValidObjectsQueryTypesEnum>;
430
- /**
431
- *
432
- * @type {AFM}
433
- * @memberof AfmValidObjectsQuery
434
- */
435
204
  afm: AFM;
436
205
  }
437
206
  export declare const AfmValidObjectsQueryTypesEnum: {
@@ -442,84 +211,34 @@ export declare const AfmValidObjectsQueryTypesEnum: {
442
211
  export type AfmValidObjectsQueryTypesEnum = (typeof AfmValidObjectsQueryTypesEnum)[keyof typeof AfmValidObjectsQueryTypesEnum];
443
212
  /**
444
213
  * All objects of specified types valid with respect to given AFM.
445
- * @export
446
- * @interface AfmValidObjectsResponse
447
214
  */
448
215
  export interface AfmValidObjectsResponse {
449
- /**
450
- *
451
- * @type {Array<RestApiIdentifier>}
452
- * @memberof AfmValidObjectsResponse
453
- */
454
216
  items: Array<RestApiIdentifier>;
455
217
  }
456
- /**
457
- *
458
- * @export
459
- * @interface AnomalyDetectionRequest
460
- */
461
218
  export interface AnomalyDetectionRequest {
462
219
  /**
463
220
  * Anomaly detection sensitivity.
464
- * @type {number}
465
- * @memberof AnomalyDetectionRequest
466
221
  */
467
222
  sensitivity: number;
468
223
  }
469
- /**
470
- *
471
- * @export
472
- * @interface AnomalyDetectionResult
473
- */
474
224
  export interface AnomalyDetectionResult {
475
- /**
476
- *
477
- * @type {Array<string>}
478
- * @memberof AnomalyDetectionResult
479
- */
480
225
  attribute: Array<string>;
481
- /**
482
- *
483
- * @type {Array<number>}
484
- * @memberof AnomalyDetectionResult
485
- */
486
- values: Array<number>;
487
- /**
488
- *
489
- * @type {Array<boolean>}
490
- * @memberof AnomalyDetectionResult
491
- */
492
- anomalyFlag: Array<boolean>;
226
+ values: Array<number | null>;
227
+ anomalyFlag: Array<boolean | null>;
493
228
  }
494
229
  /**
495
230
  * Metric representing arithmetics between other metrics.
496
- * @export
497
- * @interface ArithmeticMeasureDefinition
498
231
  */
499
232
  export interface ArithmeticMeasureDefinition {
500
- /**
501
- *
502
- * @type {ArithmeticMeasureDefinitionArithmeticMeasure}
503
- * @memberof ArithmeticMeasureDefinition
504
- */
505
233
  arithmeticMeasure: ArithmeticMeasureDefinitionArithmeticMeasure;
506
234
  }
507
- /**
508
- *
509
- * @export
510
- * @interface ArithmeticMeasureDefinitionArithmeticMeasure
511
- */
512
235
  export interface ArithmeticMeasureDefinitionArithmeticMeasure {
513
236
  /**
514
237
  * List of metrics to apply arithmetic operation by chosen operator.
515
- * @type {Array<AfmLocalIdentifier>}
516
- * @memberof ArithmeticMeasureDefinitionArithmeticMeasure
517
238
  */
518
239
  measureIdentifiers: Array<AfmLocalIdentifier>;
519
240
  /**
520
241
  * Arithmetic operator describing operation between metrics.
521
- * @type {string}
522
- * @memberof ArithmeticMeasureDefinitionArithmeticMeasure
523
242
  */
524
243
  operator: ArithmeticMeasureDefinitionArithmeticMeasureOperatorEnum;
525
244
  }
@@ -531,134 +250,66 @@ export declare const ArithmeticMeasureDefinitionArithmeticMeasureOperatorEnum: {
531
250
  readonly CHANGE: "CHANGE";
532
251
  };
533
252
  export type ArithmeticMeasureDefinitionArithmeticMeasureOperatorEnum = (typeof ArithmeticMeasureDefinitionArithmeticMeasureOperatorEnum)[keyof typeof ArithmeticMeasureDefinitionArithmeticMeasureOperatorEnum];
534
- /**
535
- *
536
- * @export
537
- * @interface AttributeExecutionResultHeader
538
- */
539
253
  export interface AttributeExecutionResultHeader {
540
- /**
541
- *
542
- * @type {AttributeResultHeader}
543
- * @memberof AttributeExecutionResultHeader
544
- */
545
254
  attributeHeader: AttributeResultHeader;
546
255
  }
547
256
  /**
548
257
  * @type AttributeFilter
549
258
  * Abstract filter definition type attributes
550
- * @export
551
259
  */
552
260
  export type AttributeFilter = NegativeAttributeFilter | PositiveAttributeFilter;
553
261
  /**
554
262
  * Filter on specific set of label values.
555
- * @export
556
- * @interface AttributeFilterElements
557
263
  */
558
264
  export interface AttributeFilterElements {
559
265
  /**
560
266
  * Set of label values.
561
- * @type {Array<string>}
562
- * @memberof AttributeFilterElements
563
267
  */
564
268
  values: Array<string | null>;
565
269
  }
566
270
  /**
567
271
  * Attribute format describes formatting information to effectively format attribute values when needed.
568
- * @export
569
- * @interface AttributeFormat
570
272
  */
571
273
  export interface AttributeFormat {
572
274
  /**
573
275
  * Format locale code like \'en-US\', \'cs-CZ\', etc.
574
- * @type {string}
575
- * @memberof AttributeFormat
576
276
  */
577
277
  locale: string;
578
278
  /**
579
279
  * ICU formatting pattern like \'y\', \'dd.MM.y\', etc.
580
- * @type {string}
581
- * @memberof AttributeFormat
582
280
  */
583
281
  pattern: string;
584
282
  /**
585
283
  * Timezone for date formatting like \'America/New_York\', \'Europe/Prague\', etc.
586
- * @type {string}
587
- * @memberof AttributeFormat
588
284
  */
589
285
  timezone?: string;
590
286
  }
591
- /**
592
- *
593
- * @export
594
- * @interface AttributeHeader
595
- */
596
287
  export interface AttributeHeader {
597
- /**
598
- *
599
- * @type {AttributeHeaderAttributeHeader}
600
- * @memberof AttributeHeader
601
- */
602
288
  attributeHeader: AttributeHeaderAttributeHeader;
603
289
  }
604
- /**
605
- *
606
- * @export
607
- * @interface AttributeHeaderAttributeHeader
608
- */
609
290
  export interface AttributeHeaderAttributeHeader {
610
291
  /**
611
292
  * Local identifier of the attribute this header relates to.
612
- * @type {string}
613
- * @memberof AttributeHeaderAttributeHeader
614
293
  */
615
294
  localIdentifier: string;
616
- /**
617
- *
618
- * @type {RestApiIdentifier}
619
- * @memberof AttributeHeaderAttributeHeader
620
- */
621
295
  label: RestApiIdentifier;
622
296
  /**
623
297
  * Label name.
624
- * @type {string}
625
- * @memberof AttributeHeaderAttributeHeader
626
298
  */
627
299
  labelName: string;
628
- /**
629
- *
630
- * @type {RestApiIdentifier}
631
- * @memberof AttributeHeaderAttributeHeader
632
- */
633
300
  attribute: RestApiIdentifier;
634
301
  /**
635
302
  * Attribute name.
636
- * @type {string}
637
- * @memberof AttributeHeaderAttributeHeader
638
303
  */
639
304
  attributeName: string;
640
305
  /**
641
306
  * Date granularity of the attribute, only filled for date attributes.
642
- * @type {string}
643
- * @memberof AttributeHeaderAttributeHeader
644
307
  */
645
308
  granularity?: AttributeHeaderAttributeHeaderGranularityEnum;
646
- /**
647
- *
648
- * @type {RestApiIdentifier}
649
- * @memberof AttributeHeaderAttributeHeader
650
- */
651
309
  primaryLabel: RestApiIdentifier;
652
- /**
653
- *
654
- * @type {AttributeFormat}
655
- * @memberof AttributeHeaderAttributeHeader
656
- */
657
310
  format?: AttributeFormat;
658
311
  /**
659
312
  * Attribute value type.
660
- * @type {string}
661
- * @memberof AttributeHeaderAttributeHeader
662
313
  */
663
314
  valueType?: AttributeHeaderAttributeHeaderValueTypeEnum;
664
315
  }
@@ -690,148 +341,52 @@ export declare const AttributeHeaderAttributeHeaderValueTypeEnum: {
690
341
  readonly IMAGE: "IMAGE";
691
342
  };
692
343
  export type AttributeHeaderAttributeHeaderValueTypeEnum = (typeof AttributeHeaderAttributeHeaderValueTypeEnum)[keyof typeof AttributeHeaderAttributeHeaderValueTypeEnum];
693
- /**
694
- *
695
- * @export
696
- * @interface AttributeItem
697
- */
698
344
  export interface AttributeItem {
699
345
  /**
700
346
  * Local identifier of the attribute. This can be used to reference the attribute in other parts of the execution definition.
701
- * @type {string}
702
- * @memberof AttributeItem
703
347
  */
704
348
  localIdentifier: string;
705
- /**
706
- *
707
- * @type {AfmObjectIdentifierLabel}
708
- * @memberof AttributeItem
709
- */
710
349
  label: AfmObjectIdentifierLabel;
711
350
  /**
712
351
  * Indicates whether to show all values of given attribute even if the data bound to those values is not available.
713
- * @type {boolean}
714
- * @memberof AttributeItem
715
352
  */
716
353
  showAllValues?: boolean;
717
354
  }
718
- /**
719
- *
720
- * @export
721
- * @interface AttributeNegativeFilter
722
- */
723
355
  export interface AttributeNegativeFilter {
724
- /**
725
- *
726
- * @type {string}
727
- * @memberof AttributeNegativeFilter
728
- */
729
356
  using: string;
730
- /**
731
- *
732
- * @type {Array<string>}
733
- * @memberof AttributeNegativeFilter
734
- */
735
357
  exclude: Array<string>;
736
358
  }
359
+ export interface AttributePositiveFilter {
360
+ using: string;
361
+ include: Array<string>;
362
+ }
737
363
  /**
738
- *
739
- * @export
740
- * @interface AttributeNegativeFilterAllOf
741
- */
742
- export interface AttributeNegativeFilterAllOf {
743
- /**
744
- *
745
- * @type {string}
746
- * @memberof AttributeNegativeFilterAllOf
747
- */
748
- using?: string;
749
- /**
750
- *
751
- * @type {Array<string>}
752
- * @memberof AttributeNegativeFilterAllOf
753
- */
754
- exclude?: Array<string>;
755
- }
756
- /**
757
- *
758
- * @export
759
- * @interface AttributePositiveFilter
760
- */
761
- export interface AttributePositiveFilter {
762
- /**
763
- *
764
- * @type {string}
765
- * @memberof AttributePositiveFilter
766
- */
767
- using: string;
768
- /**
769
- *
770
- * @type {Array<string>}
771
- * @memberof AttributePositiveFilter
772
- */
773
- include: Array<string>;
774
- }
775
- /**
776
- *
777
- * @export
778
- * @interface AttributePositiveFilterAllOf
779
- */
780
- export interface AttributePositiveFilterAllOf {
781
- /**
782
- *
783
- * @type {string}
784
- * @memberof AttributePositiveFilterAllOf
785
- */
786
- using?: string;
787
- /**
788
- *
789
- * @type {Array<string>}
790
- * @memberof AttributePositiveFilterAllOf
791
- */
792
- include?: Array<string>;
793
- }
794
- /**
795
- * Header containing the information related to attributes.
796
- * @export
797
- * @interface AttributeResultHeader
364
+ * Header containing the information related to attributes.
798
365
  */
799
366
  export interface AttributeResultHeader {
800
367
  /**
801
368
  * A value of the current attribute label.
802
- * @type {string}
803
- * @memberof AttributeResultHeader
804
369
  */
805
370
  labelValue: string;
806
371
  /**
807
372
  * A value of the primary attribute label.
808
- * @type {string}
809
- * @memberof AttributeResultHeader
810
373
  */
811
374
  primaryLabelValue: string;
812
375
  }
813
376
  /**
814
377
  * 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.
815
- * @export
816
- * @interface BoundedFilter
817
378
  */
818
379
  export interface BoundedFilter {
819
380
  /**
820
381
  * Date granularity specifying particular date attribute in given dimension.
821
- * @type {string}
822
- * @memberof BoundedFilter
823
382
  */
824
383
  granularity: BoundedFilterGranularityEnum;
825
384
  /**
826
385
  * 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.
827
- * @type {number}
828
- * @memberof BoundedFilter
829
386
  */
830
387
  from?: number | null;
831
388
  /**
832
389
  * 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.
833
- * @type {number}
834
- * @memberof BoundedFilter
835
390
  */
836
391
  to?: number | null;
837
392
  }
@@ -856,68 +411,37 @@ export declare const BoundedFilterGranularityEnum: {
856
411
  export type BoundedFilterGranularityEnum = (typeof BoundedFilterGranularityEnum)[keyof typeof BoundedFilterGranularityEnum];
857
412
  /**
858
413
  * List of chat history interactions.
859
- * @export
860
- * @interface ChatHistoryInteraction
861
414
  */
862
415
  export interface ChatHistoryInteraction {
863
416
  /**
864
417
  * User question
865
- * @type {string}
866
- * @memberof ChatHistoryInteraction
867
418
  */
868
419
  question: string;
869
420
  /**
870
421
  * Chat History thread suffix appended to ID generated by backend. Enables more chat windows.
871
- * @type {string}
872
- * @memberof ChatHistoryInteraction
873
422
  */
874
423
  threadIdSuffix?: string;
875
424
  /**
876
425
  * Chat History interaction ID. Unique ID for each interaction.
877
- * @type {string}
878
- * @memberof ChatHistoryInteraction
879
426
  */
880
427
  chatHistoryInteractionId: string;
881
428
  /**
882
429
  * Has the interaction already finished? Can be used for polling when interaction is in progress.
883
- * @type {boolean}
884
- * @memberof ChatHistoryInteraction
885
430
  */
886
431
  interactionFinished: boolean;
887
- /**
888
- *
889
- * @type {RouteResult}
890
- * @memberof ChatHistoryInteraction
891
- */
892
432
  routing: RouteResult;
893
433
  /**
894
434
  * Text response for general questions.
895
- * @type {string}
896
- * @memberof ChatHistoryInteraction
897
435
  */
898
436
  textResponse?: string;
899
437
  /**
900
438
  * Error response in anything fails.
901
- * @type {string}
902
- * @memberof ChatHistoryInteraction
903
439
  */
904
440
  errorResponse?: string;
905
- /**
906
- *
907
- * @type {FoundObjects}
908
- * @memberof ChatHistoryInteraction
909
- */
910
441
  foundObjects?: FoundObjects;
911
- /**
912
- *
913
- * @type {CreatedVisualizations}
914
- * @memberof ChatHistoryInteraction
915
- */
916
442
  createdVisualizations?: CreatedVisualizations;
917
443
  /**
918
444
  * User feedback.
919
- * @type {string}
920
- * @memberof ChatHistoryInteraction
921
445
  */
922
446
  userFeedback?: ChatHistoryInteractionUserFeedbackEnum;
923
447
  }
@@ -927,46 +451,26 @@ export declare const ChatHistoryInteractionUserFeedbackEnum: {
927
451
  readonly NONE: "NONE";
928
452
  };
929
453
  export type ChatHistoryInteractionUserFeedbackEnum = (typeof ChatHistoryInteractionUserFeedbackEnum)[keyof typeof ChatHistoryInteractionUserFeedbackEnum];
930
- /**
931
- *
932
- * @export
933
- * @interface ChatHistoryRequest
934
- */
935
454
  export interface ChatHistoryRequest {
936
455
  /**
937
456
  * Chat History thread suffix appended to ID generated by backend. Enables more chat windows.
938
- * @type {string}
939
- * @memberof ChatHistoryRequest
940
457
  */
941
458
  threadIdSuffix?: string;
942
459
  /**
943
460
  * Return chat history records only after this interaction ID. If empty, complete chat history is returned.
944
- * @type {string}
945
- * @memberof ChatHistoryRequest
946
461
  */
947
462
  chatHistoryInteractionId?: string;
948
463
  /**
949
464
  * User feedback.
950
- * @type {string}
951
- * @memberof ChatHistoryRequest
952
465
  */
953
466
  userFeedback?: ChatHistoryRequestUserFeedbackEnum;
954
467
  /**
955
468
  * User feedback.
956
- * @type {boolean}
957
- * @memberof ChatHistoryRequest
958
469
  */
959
470
  reset?: boolean;
960
- /**
961
- *
962
- * @type {SavedVisualization}
963
- * @memberof ChatHistoryRequest
964
- */
965
471
  savedVisualization?: SavedVisualization;
966
472
  /**
967
473
  * Response state indicating the outcome of the AI interaction.
968
- * @type {string}
969
- * @memberof ChatHistoryRequest
970
474
  */
971
475
  responseState?: ChatHistoryRequestResponseStateEnum;
972
476
  }
@@ -986,282 +490,123 @@ export declare const ChatHistoryRequestResponseStateEnum: {
986
490
  readonly OUT_OF_TOPIC: "OUT_OF_TOPIC";
987
491
  };
988
492
  export type ChatHistoryRequestResponseStateEnum = (typeof ChatHistoryRequestResponseStateEnum)[keyof typeof ChatHistoryRequestResponseStateEnum];
989
- /**
990
- *
991
- * @export
992
- * @interface ChatHistoryResult
993
- */
994
493
  export interface ChatHistoryResult {
995
494
  /**
996
495
  * List of chat history interactions.
997
- * @type {Array<ChatHistoryInteraction>}
998
- * @memberof ChatHistoryResult
999
496
  */
1000
497
  interactions: Array<ChatHistoryInteraction>;
1001
498
  /**
1002
499
  * The conversation thread ID.
1003
- * @type {string}
1004
- * @memberof ChatHistoryResult
1005
500
  */
1006
501
  threadId: string;
1007
502
  }
1008
- /**
1009
- *
1010
- * @export
1011
- * @interface ChatRequest
1012
- */
1013
503
  export interface ChatRequest {
1014
504
  /**
1015
505
  * User question
1016
- * @type {string}
1017
- * @memberof ChatRequest
1018
506
  */
1019
507
  question: string;
1020
508
  /**
1021
509
  * Maximum number of search results.
1022
- * @type {number}
1023
- * @memberof ChatRequest
1024
510
  */
1025
511
  limitSearch?: number;
1026
512
  /**
1027
513
  * Maximum number of relevant objects included into context for LLM (for each object type).
1028
- * @type {number}
1029
- * @memberof ChatRequest
1030
514
  */
1031
515
  limitCreateContext?: number;
1032
516
  /**
1033
517
  * Maximum number of created results.
1034
- * @type {number}
1035
- * @memberof ChatRequest
1036
518
  */
1037
519
  limitCreate?: number;
1038
520
  /**
1039
521
  * Chat History thread suffix appended to ID generated by backend. Enables more chat windows.
1040
- * @type {string}
1041
- * @memberof ChatRequest
1042
522
  */
1043
523
  threadIdSuffix?: string;
1044
- /**
1045
- *
1046
- * @type {UserContext}
1047
- * @memberof ChatRequest
1048
- */
1049
524
  userContext?: UserContext;
1050
525
  /**
1051
526
  * Temporary for experiments. Ratio of title score to descriptor score.
1052
- * @type {number}
1053
- * @memberof ChatRequest
1054
527
  */
1055
528
  titleToDescriptorRatio?: number;
1056
529
  /**
1057
530
  * Score, above which we return found object(s) and don\'t call LLM to create new objects.
1058
- * @type {number}
1059
- * @memberof ChatRequest
1060
531
  */
1061
532
  searchScoreThreshold?: number;
1062
533
  /**
1063
534
  * Score, above which we return found objects. Below this score objects are not relevant.
1064
- * @type {number}
1065
- * @memberof ChatRequest
1066
535
  */
1067
536
  relevantScoreThreshold?: number;
1068
537
  }
1069
- /**
1070
- *
1071
- * @export
1072
- * @interface ChatResult
1073
- */
1074
538
  export interface ChatResult {
1075
- /**
1076
- *
1077
- * @type {RouteResult}
1078
- * @memberof ChatResult
1079
- */
1080
539
  routing?: RouteResult;
1081
540
  /**
1082
541
  * Text response for general questions.
1083
- * @type {string}
1084
- * @memberof ChatResult
1085
542
  */
1086
543
  textResponse?: string;
1087
544
  /**
1088
545
  * Error response in anything fails.
1089
- * @type {string}
1090
- * @memberof ChatResult
1091
546
  */
1092
547
  errorResponse?: string;
1093
- /**
1094
- *
1095
- * @type {FoundObjects}
1096
- * @memberof ChatResult
1097
- */
1098
548
  foundObjects?: FoundObjects;
1099
- /**
1100
- *
1101
- * @type {CreatedVisualizations}
1102
- * @memberof ChatResult
1103
- */
1104
549
  createdVisualizations?: CreatedVisualizations;
1105
550
  /**
1106
551
  * Chat History thread suffix appended to ID generated by backend. Enables more chat windows.
1107
- * @type {string}
1108
- * @memberof ChatResult
1109
552
  */
1110
553
  threadIdSuffix?: string;
1111
554
  /**
1112
555
  * Chat History interaction ID. Unique ID for each interaction.
1113
- * @type {string}
1114
- * @memberof ChatResult
1115
556
  */
1116
557
  chatHistoryInteractionId?: string;
1117
558
  }
1118
- /**
1119
- *
1120
- * @export
1121
- * @interface ChatUsageResponse
1122
- */
1123
559
  export interface ChatUsageResponse {
1124
560
  /**
1125
561
  * Number of interactions in the time window
1126
- * @type {number}
1127
- * @memberof ChatUsageResponse
1128
562
  */
1129
563
  interactionCount: number;
1130
564
  /**
1131
565
  * Maximum number of interactions in the time window any user can do in the workspace
1132
- * @type {number}
1133
- * @memberof ChatUsageResponse
1134
566
  */
1135
567
  interactionLimit: number;
1136
568
  /**
1137
569
  * Time window in hours
1138
- * @type {number}
1139
- * @memberof ChatUsageResponse
1140
570
  */
1141
571
  timeWindowHours: number;
1142
572
  }
1143
- /**
1144
- *
1145
- * @export
1146
- * @interface ClusteringRequest
1147
- */
1148
573
  export interface ClusteringRequest {
1149
574
  /**
1150
575
  * Number of clusters to create
1151
- * @type {number}
1152
- * @memberof ClusteringRequest
1153
576
  */
1154
577
  numberOfClusters: number;
1155
578
  /**
1156
579
  * Threshold used for algorithm
1157
- * @type {number}
1158
- * @memberof ClusteringRequest
1159
580
  */
1160
581
  threshold?: number;
1161
582
  }
1162
- /**
1163
- *
1164
- * @export
1165
- * @interface ClusteringResult
1166
- */
1167
583
  export interface ClusteringResult {
1168
- /**
1169
- *
1170
- * @type {Array<object>}
1171
- * @memberof ClusteringResult
1172
- */
1173
584
  attribute: Array<object>;
1174
- /**
1175
- *
1176
- * @type {Array<number>}
1177
- * @memberof ClusteringResult
1178
- */
1179
- xCoord?: Array<number>;
1180
- /**
1181
- *
1182
- * @type {Array<number>}
1183
- * @memberof ClusteringResult
1184
- */
1185
- yCoord?: Array<number>;
1186
- /**
1187
- *
1188
- * @type {Array<number>}
1189
- * @memberof ClusteringResult
1190
- */
1191
- clusters: Array<number>;
1192
- /**
1193
- *
1194
- * @type {Array<number>}
1195
- * @memberof ClusteringResult
1196
- */
585
+ xCoord?: Array<number | null>;
586
+ yCoord?: Array<number | null>;
587
+ clusters: Array<number | null>;
1197
588
  xcoord: Array<number>;
1198
- /**
1199
- *
1200
- * @type {Array<number>}
1201
- * @memberof ClusteringResult
1202
- */
1203
589
  ycoord: Array<number>;
1204
590
  }
1205
591
  /**
1206
592
  * Filter the result by comparing specified metric to given constant value, using given comparison operator.
1207
- * @export
1208
- * @interface ComparisonMeasureValueFilter
1209
593
  */
1210
594
  export interface ComparisonMeasureValueFilter {
1211
- /**
1212
- *
1213
- * @type {ComparisonMeasureValueFilterComparisonMeasureValueFilter}
1214
- * @memberof ComparisonMeasureValueFilter
1215
- */
1216
595
  comparisonMeasureValueFilter: ComparisonMeasureValueFilterComparisonMeasureValueFilter;
1217
596
  }
1218
- /**
1219
- *
1220
- * @export
1221
- * @interface ComparisonMeasureValueFilterComparisonMeasureValueFilter
1222
- */
1223
597
  export interface ComparisonMeasureValueFilterComparisonMeasureValueFilter {
1224
598
  /**
1225
599
  * References to the attributes to be used when filtering.
1226
- * @type {Array<AfmIdentifier>}
1227
- * @memberof ComparisonMeasureValueFilterComparisonMeasureValueFilter
1228
600
  */
1229
601
  dimensionality?: Array<AfmIdentifier>;
1230
602
  /**
1231
603
  * A value that will be substituted for null values in the metric for the comparisons.
1232
- * @type {number}
1233
- * @memberof ComparisonMeasureValueFilterComparisonMeasureValueFilter
1234
604
  */
1235
605
  treatNullValuesAs?: number;
1236
- /**
1237
- *
1238
- * @type {string}
1239
- * @memberof ComparisonMeasureValueFilterComparisonMeasureValueFilter
1240
- */
1241
606
  operator: ComparisonMeasureValueFilterComparisonMeasureValueFilterOperatorEnum;
1242
- /**
1243
- *
1244
- * @type {number}
1245
- * @memberof ComparisonMeasureValueFilterComparisonMeasureValueFilter
1246
- */
1247
607
  value: number;
1248
- /**
1249
- *
1250
- * @type {string}
1251
- * @memberof ComparisonMeasureValueFilterComparisonMeasureValueFilter
1252
- */
1253
608
  localIdentifier?: string;
1254
- /**
1255
- *
1256
- * @type {boolean}
1257
- * @memberof ComparisonMeasureValueFilterComparisonMeasureValueFilter
1258
- */
1259
609
  applyOnResult?: boolean;
1260
- /**
1261
- *
1262
- * @type {AfmIdentifier}
1263
- * @memberof ComparisonMeasureValueFilterComparisonMeasureValueFilter
1264
- */
1265
610
  measure: AfmIdentifier;
1266
611
  }
1267
612
  export declare const ComparisonMeasureValueFilterComparisonMeasureValueFilterOperatorEnum: {
@@ -1275,56 +620,38 @@ export declare const ComparisonMeasureValueFilterComparisonMeasureValueFilterOpe
1275
620
  export type ComparisonMeasureValueFilterComparisonMeasureValueFilterOperatorEnum = (typeof ComparisonMeasureValueFilterComparisonMeasureValueFilterOperatorEnum)[keyof typeof ComparisonMeasureValueFilterComparisonMeasureValueFilterOperatorEnum];
1276
621
  /**
1277
622
  * List of created visualization objects
1278
- * @export
1279
- * @interface CreatedVisualization
1280
623
  */
1281
624
  export interface CreatedVisualization {
1282
625
  /**
1283
626
  * Proposed ID of the new visualization
1284
- * @type {string}
1285
- * @memberof CreatedVisualization
1286
627
  */
1287
628
  id: string;
1288
629
  /**
1289
630
  * Proposed title of the new visualization
1290
- * @type {string}
1291
- * @memberof CreatedVisualization
1292
631
  */
1293
632
  title: string;
1294
633
  /**
1295
634
  * Visualization type requested in question
1296
- * @type {string}
1297
- * @memberof CreatedVisualization
1298
635
  */
1299
636
  visualizationType: CreatedVisualizationVisualizationTypeEnum;
1300
637
  /**
1301
638
  * List of metrics to be used in the new visualization
1302
- * @type {Array<Metric>}
1303
- * @memberof CreatedVisualization
1304
639
  */
1305
640
  metrics: Array<Metric>;
1306
641
  /**
1307
642
  * List of attributes representing the dimensionality of the new visualization
1308
- * @type {Array<DimAttribute>}
1309
- * @memberof CreatedVisualization
1310
643
  */
1311
644
  dimensionality: Array<DimAttribute>;
1312
645
  /**
1313
646
  * List of filters to be applied to the new visualization
1314
- * @type {Array<AttributeNegativeFilter | AttributePositiveFilter | DateAbsoluteFilter | DateRelativeFilter>}
1315
- * @memberof CreatedVisualization
1316
647
  */
1317
- filters: Array<AttributeNegativeFilter | AttributePositiveFilter | DateAbsoluteFilter | DateRelativeFilter>;
648
+ filters: Array<CreatedVisualizationFiltersInner>;
1318
649
  /**
1319
650
  * Suggestions for next steps
1320
- * @type {Array<Suggestion>}
1321
- * @memberof CreatedVisualization
1322
651
  */
1323
652
  suggestions: Array<Suggestion>;
1324
653
  /**
1325
654
  * Saved visualization ID.
1326
- * @type {string}
1327
- * @memberof CreatedVisualization
1328
655
  */
1329
656
  savedVisualizationId?: string;
1330
657
  }
@@ -1337,41 +664,33 @@ export declare const CreatedVisualizationVisualizationTypeEnum: {
1337
664
  readonly COLUMN: "COLUMN";
1338
665
  };
1339
666
  export type CreatedVisualizationVisualizationTypeEnum = (typeof CreatedVisualizationVisualizationTypeEnum)[keyof typeof CreatedVisualizationVisualizationTypeEnum];
667
+ /**
668
+ * @type CreatedVisualizationFiltersInner
669
+ */
670
+ export type CreatedVisualizationFiltersInner = AttributeNegativeFilter | AttributePositiveFilter | DateAbsoluteFilter | DateRelativeFilter;
1340
671
  /**
1341
672
  * Visualization definitions created by AI.
1342
- * @export
1343
- * @interface CreatedVisualizations
1344
673
  */
1345
674
  export interface CreatedVisualizations {
1346
675
  /**
1347
676
  * List of created visualization objects
1348
- * @type {Array<CreatedVisualization>}
1349
- * @memberof CreatedVisualizations
1350
677
  */
1351
678
  objects: Array<CreatedVisualization>;
1352
679
  /**
1353
680
  * Reasoning from LLM. Description of how and why the answer was generated.
1354
- * @type {string}
1355
- * @memberof CreatedVisualizations
1356
681
  */
1357
682
  reasoning: string;
1358
683
  /**
1359
684
  * List of suggestions for next steps. Filled when no visualization was created, suggests alternatives.
1360
- * @type {Array<Suggestion>}
1361
- * @memberof CreatedVisualizations
1362
685
  */
1363
686
  suggestions: Array<Suggestion>;
1364
687
  }
1365
688
  /**
1366
689
  * 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.
1367
- * @export
1368
- * @interface DataColumnLocator
1369
690
  */
1370
691
  export interface DataColumnLocator {
1371
692
  /**
1372
693
  * 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.
1373
- * @type {{ [key: string]: string; }}
1374
- * @memberof DataColumnLocator
1375
694
  */
1376
695
  properties: {
1377
696
  [key: string]: string;
@@ -1379,104 +698,29 @@ export interface DataColumnLocator {
1379
698
  }
1380
699
  /**
1381
700
  * Data column locators for the values.
1382
- * @export
1383
- * @interface DataColumnLocators
1384
701
  */
1385
702
  export interface DataColumnLocators {
1386
703
  /**
1387
704
  * Mapping from dimensions to data column locators.
1388
- * @type {{ [key: string]: DataColumnLocator; }}
1389
- * @memberof DataColumnLocators
1390
705
  */
1391
706
  properties?: {
1392
707
  [key: string]: DataColumnLocator;
1393
708
  };
1394
709
  }
1395
- /**
1396
- *
1397
- * @export
1398
- * @interface DateAbsoluteFilter
1399
- */
1400
710
  export interface DateAbsoluteFilter {
1401
- /**
1402
- *
1403
- * @type {string}
1404
- * @memberof DateAbsoluteFilter
1405
- */
1406
711
  using: string;
1407
- /**
1408
- *
1409
- * @type {string}
1410
- * @memberof DateAbsoluteFilter
1411
- */
1412
712
  from: string;
1413
- /**
1414
- *
1415
- * @type {string}
1416
- * @memberof DateAbsoluteFilter
1417
- */
1418
713
  to: string;
1419
714
  }
1420
- /**
1421
- *
1422
- * @export
1423
- * @interface DateAbsoluteFilterAllOf
1424
- */
1425
- export interface DateAbsoluteFilterAllOf {
1426
- /**
1427
- *
1428
- * @type {string}
1429
- * @memberof DateAbsoluteFilterAllOf
1430
- */
1431
- using?: string;
1432
- /**
1433
- *
1434
- * @type {string}
1435
- * @memberof DateAbsoluteFilterAllOf
1436
- */
1437
- from?: string;
1438
- /**
1439
- *
1440
- * @type {string}
1441
- * @memberof DateAbsoluteFilterAllOf
1442
- */
1443
- to?: string;
1444
- }
1445
715
  /**
1446
716
  * @type DateFilter
1447
717
  * Abstract filter definition type for dates.
1448
- * @export
1449
718
  */
1450
719
  export type DateFilter = AbsoluteDateFilter | RelativeDateFilter;
1451
- /**
1452
- *
1453
- * @export
1454
- * @interface DateRelativeFilter
1455
- */
1456
720
  export interface DateRelativeFilter {
1457
- /**
1458
- *
1459
- * @type {string}
1460
- * @memberof DateRelativeFilter
1461
- */
1462
721
  using: string;
1463
- /**
1464
- *
1465
- * @type {string}
1466
- * @memberof DateRelativeFilter
1467
- */
1468
722
  granularity: DateRelativeFilterGranularityEnum;
1469
- /**
1470
- *
1471
- * @type {number}
1472
- * @memberof DateRelativeFilter
1473
- */
1474
723
  from: number;
1475
- /**
1476
- *
1477
- * @type {number}
1478
- * @memberof DateRelativeFilter
1479
- */
1480
724
  to: number;
1481
725
  }
1482
726
  export declare const DateRelativeFilterGranularityEnum: {
@@ -1499,153 +743,42 @@ export declare const DateRelativeFilterGranularityEnum: {
1499
743
  };
1500
744
  export type DateRelativeFilterGranularityEnum = (typeof DateRelativeFilterGranularityEnum)[keyof typeof DateRelativeFilterGranularityEnum];
1501
745
  /**
1502
- *
1503
- * @export
1504
- * @interface DateRelativeFilterAllOf
746
+ * Filter definition type specified by label and values.
1505
747
  */
1506
- export interface DateRelativeFilterAllOf {
748
+ export interface DependsOn {
1507
749
  /**
1508
- *
1509
- * @type {string}
1510
- * @memberof DateRelativeFilterAllOf
750
+ * Specifies on which label the filter depends on.
1511
751
  */
1512
- using?: string;
1513
- /**
1514
- *
1515
- * @type {string}
1516
- * @memberof DateRelativeFilterAllOf
1517
- */
1518
- granularity?: DateRelativeFilterAllOfGranularityEnum;
1519
- /**
1520
- *
1521
- * @type {number}
1522
- * @memberof DateRelativeFilterAllOf
1523
- */
1524
- from?: number;
1525
- /**
1526
- *
1527
- * @type {number}
1528
- * @memberof DateRelativeFilterAllOf
1529
- */
1530
- to?: number;
1531
- }
1532
- export declare const DateRelativeFilterAllOfGranularityEnum: {
1533
- readonly MINUTE: "MINUTE";
1534
- readonly HOUR: "HOUR";
1535
- readonly DAY: "DAY";
1536
- readonly WEEK: "WEEK";
1537
- readonly MONTH: "MONTH";
1538
- readonly QUARTER: "QUARTER";
1539
- readonly YEAR: "YEAR";
1540
- readonly MINUTE_OF_HOUR: "MINUTE_OF_HOUR";
1541
- readonly HOUR_OF_DAY: "HOUR_OF_DAY";
1542
- readonly DAY_OF_WEEK: "DAY_OF_WEEK";
1543
- readonly DAY_OF_MONTH: "DAY_OF_MONTH";
1544
- readonly DAY_OF_QUARTER: "DAY_OF_QUARTER";
1545
- readonly DAY_OF_YEAR: "DAY_OF_YEAR";
1546
- readonly WEEK_OF_YEAR: "WEEK_OF_YEAR";
1547
- readonly MONTH_OF_YEAR: "MONTH_OF_YEAR";
1548
- readonly QUARTER_OF_YEAR: "QUARTER_OF_YEAR";
1549
- };
1550
- export type DateRelativeFilterAllOfGranularityEnum = (typeof DateRelativeFilterAllOfGranularityEnum)[keyof typeof DateRelativeFilterAllOfGranularityEnum];
1551
- /**
1552
- * Filter definition type specified by label and values.
1553
- * @export
1554
- * @interface DependsOn
1555
- */
1556
- export interface DependsOn {
1557
- /**
1558
- * Specifies on which label the filter depends on.
1559
- * @type {string}
1560
- * @memberof DependsOn
1561
- */
1562
- label: string;
752
+ label: string;
1563
753
  /**
1564
754
  * Specifies values of the label for element filtering.
1565
- * @type {Array<string>}
1566
- * @memberof DependsOn
1567
755
  */
1568
756
  values: Array<string | null>;
1569
757
  /**
1570
758
  * Inverse filtering mode.
1571
- * @type {boolean}
1572
- * @memberof DependsOn
1573
- */
1574
- complementFilter?: boolean;
1575
- }
1576
- /**
1577
- *
1578
- * @export
1579
- * @interface DependsOnAllOf
1580
- */
1581
- export interface DependsOnAllOf {
1582
- /**
1583
- * Specifies on which label the filter depends on.
1584
- * @type {string}
1585
- * @memberof DependsOnAllOf
1586
- */
1587
- label?: string;
1588
- /**
1589
- * Specifies values of the label for element filtering.
1590
- * @type {Array<string>}
1591
- * @memberof DependsOnAllOf
1592
- */
1593
- values?: Array<string>;
1594
- /**
1595
- * Inverse filtering mode.
1596
- * @type {boolean}
1597
- * @memberof DependsOnAllOf
1598
759
  */
1599
760
  complementFilter?: boolean;
1600
761
  }
1601
762
  /**
1602
763
  * Filter definition type for dates.
1603
- * @export
1604
- * @interface DependsOnDateFilter
1605
764
  */
1606
765
  export interface DependsOnDateFilter {
1607
- /**
1608
- *
1609
- * @type {DateFilter}
1610
- * @memberof DependsOnDateFilter
1611
- */
1612
766
  dateFilter: DateFilter;
1613
767
  }
1614
- /**
1615
- *
1616
- * @export
1617
- * @interface DependsOnDateFilterAllOf
1618
- */
1619
- export interface DependsOnDateFilterAllOf {
1620
- /**
1621
- *
1622
- * @type {DateFilter}
1623
- * @memberof DependsOnDateFilterAllOf
1624
- */
1625
- dateFilter?: DateFilter;
1626
- }
1627
768
  /**
1628
769
  * List of attributes representing the dimensionality of the new visualization
1629
- * @export
1630
- * @interface DimAttribute
1631
770
  */
1632
771
  export interface DimAttribute {
1633
772
  /**
1634
773
  * ID of the object
1635
- * @type {string}
1636
- * @memberof DimAttribute
1637
774
  */
1638
775
  id: string;
1639
776
  /**
1640
777
  * Object type
1641
- * @type {string}
1642
- * @memberof DimAttribute
1643
778
  */
1644
779
  type: DimAttributeTypeEnum;
1645
780
  /**
1646
781
  * Title of attribute.
1647
- * @type {string}
1648
- * @memberof DimAttribute
1649
782
  */
1650
783
  title: string;
1651
784
  }
@@ -1655,132 +788,84 @@ export declare const DimAttributeTypeEnum: {
1655
788
  export type DimAttributeTypeEnum = (typeof DimAttributeTypeEnum)[keyof typeof DimAttributeTypeEnum];
1656
789
  /**
1657
790
  * Single dimension description.
1658
- * @export
1659
- * @interface Dimension
1660
791
  */
1661
792
  export interface Dimension {
1662
793
  /**
1663
794
  * Dimension identification within requests. Other entities can reference this dimension by this value.
1664
- * @type {string}
1665
- * @memberof Dimension
1666
795
  */
1667
796
  localIdentifier?: string;
1668
797
  /**
1669
798
  * List of items in current dimension. Can reference \'localIdentifier\' from \'AttributeItem\', or special pseudo attribute \"measureGroup\" representing list of metrics.
1670
- * @type {Array<string>}
1671
- * @memberof Dimension
1672
799
  */
1673
800
  itemIdentifiers: Array<string>;
1674
801
  /**
1675
802
  * List of sorting rules. From most relevant to least relevant (less relevant rule is applied, when more relevant rule compares items as equal).
1676
- * @type {Array<SortKey>}
1677
- * @memberof Dimension
1678
803
  */
1679
804
  sorting?: Array<SortKey>;
1680
805
  }
1681
806
  /**
1682
807
  * Contains the dimension-specific header information.
1683
- * @export
1684
- * @interface DimensionHeader
1685
808
  */
1686
809
  export interface DimensionHeader {
1687
810
  /**
1688
811
  * An array containing header groups.
1689
- * @type {Array<HeaderGroup>}
1690
- * @memberof DimensionHeader
1691
812
  */
1692
813
  headerGroups: Array<HeaderGroup>;
1693
814
  }
1694
815
  /**
1695
816
  * List of returned elements.
1696
- * @export
1697
- * @interface Element
1698
817
  */
1699
818
  export interface Element {
1700
819
  /**
1701
820
  * Title of requested label.
1702
- * @type {string}
1703
- * @memberof Element
1704
821
  */
1705
822
  title: string | null;
1706
823
  /**
1707
824
  * Title of primary label of attribute owning requested label, null if the title is null or the primary label is excluded
1708
- * @type {string}
1709
- * @memberof Element
1710
825
  */
1711
826
  primaryTitle: string | null;
1712
827
  }
1713
- /**
1714
- *
1715
- * @export
1716
- * @interface ElementsRequest
1717
- */
1718
828
  export interface ElementsRequest {
1719
829
  /**
1720
830
  * Requested label.
1721
- * @type {string}
1722
- * @memberof ElementsRequest
1723
831
  */
1724
832
  label: string;
1725
833
  /**
1726
834
  * 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
1727
- * @type {boolean}
1728
- * @memberof ElementsRequest
1729
835
  */
1730
836
  excludePrimaryLabel?: boolean;
1731
- /**
1732
- *
1733
- * @type {FilterBy}
1734
- * @memberof ElementsRequest
1735
- */
1736
837
  filterBy?: FilterBy;
1737
838
  /**
1738
839
  * 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
1739
- * @type {string}
1740
- * @memberof ElementsRequest
1741
840
  */
1742
841
  sortOrder?: ElementsRequestSortOrderEnum;
1743
842
  /**
1744
843
  * Inverse filters: * ```false``` - return items matching ```patternFilter``` and ```exactFilter``` * ```true``` - return items not matching ```patternFilter``` and ```exactFilter```
1745
- * @type {boolean}
1746
- * @memberof ElementsRequest
1747
844
  */
1748
845
  complementFilter?: boolean;
1749
846
  /**
1750
847
  * Return only items, whose ```label``` title case insensitively contains ```filter``` as substring.
1751
- * @type {string}
1752
- * @memberof ElementsRequest
1753
848
  */
1754
849
  patternFilter?: string;
1755
850
  /**
1756
851
  * Return only items, whose ```label``` title exactly matches one of ```filter```.
1757
- * @type {Array<string>}
1758
- * @memberof ElementsRequest
1759
852
  */
1760
- exactFilter?: Array<string>;
853
+ exactFilter?: Array<string | null>;
1761
854
  /**
1762
855
  * Return only items that are not filtered-out by the parent filters.
1763
- * @type {Array<DependsOn | DependsOnDateFilter>}
1764
- * @memberof ElementsRequest
1765
856
  */
1766
- dependsOn?: Array<DependsOn | DependsOnDateFilter>;
857
+ dependsOn?: Array<ElementsRequestDependsOnInner>;
1767
858
  /**
1768
859
  * Return only items that are computable on metric.
1769
- * @type {Array<ValidateByItem>}
1770
- * @memberof ElementsRequest
1771
860
  */
1772
861
  validateBy?: Array<ValidateByItem>;
1773
862
  /**
1774
863
  * Specifies percentage of source table data scanned during the computation. This field is deprecated and is no longer used during the elements computation.
1775
- * @type {number}
1776
- * @memberof ElementsRequest
1777
864
  * @deprecated
1778
865
  */
1779
866
  dataSamplingPercentage?: number;
1780
867
  /**
1781
868
  * If specified, the element data will be taken from the result with the same cacheId if it is available.
1782
- * @type {string}
1783
- * @memberof ElementsRequest
1784
869
  */
1785
870
  cacheId?: string;
1786
871
  }
@@ -1789,46 +874,27 @@ export declare const ElementsRequestSortOrderEnum: {
1789
874
  readonly DESC: "DESC";
1790
875
  };
1791
876
  export type ElementsRequestSortOrderEnum = (typeof ElementsRequestSortOrderEnum)[keyof typeof ElementsRequestSortOrderEnum];
877
+ /**
878
+ * @type ElementsRequestDependsOnInner
879
+ */
880
+ export type ElementsRequestDependsOnInner = DependsOn | DependsOnDateFilter;
1792
881
  /**
1793
882
  * Entity holding list of sorted & filtered label elements, related primary label of attribute owning requested label and paging.
1794
- * @export
1795
- * @interface ElementsResponse
1796
883
  */
1797
884
  export interface ElementsResponse {
1798
- /**
1799
- *
1800
- * @type {RestApiIdentifier}
1801
- * @memberof ElementsResponse
1802
- */
1803
885
  primaryLabel: RestApiIdentifier;
1804
886
  /**
1805
887
  * List of returned elements.
1806
- * @type {Array<Element>}
1807
- * @memberof ElementsResponse
1808
888
  */
1809
889
  elements: Array<Element>;
1810
- /**
1811
- *
1812
- * @type {Paging}
1813
- * @memberof ElementsResponse
1814
- */
1815
890
  paging: Paging;
1816
891
  /**
1817
892
  * Granularity of requested label in case of date attribute
1818
- * @type {string}
1819
- * @memberof ElementsResponse
1820
893
  */
1821
894
  granularity?: ElementsResponseGranularityEnum;
1822
- /**
1823
- *
1824
- * @type {AttributeFormat}
1825
- * @memberof ElementsResponse
1826
- */
1827
895
  format?: AttributeFormat;
1828
896
  /**
1829
897
  * 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.
1830
- * @type {string}
1831
- * @memberof ElementsResponse
1832
898
  */
1833
899
  cacheId?: string;
1834
900
  }
@@ -1853,202 +919,127 @@ export declare const ElementsResponseGranularityEnum: {
1853
919
  export type ElementsResponseGranularityEnum = (typeof ElementsResponseGranularityEnum)[keyof typeof ElementsResponseGranularityEnum];
1854
920
  /**
1855
921
  * Links to the execution result.
1856
- * @export
1857
- * @interface ExecutionLinks
1858
922
  */
1859
923
  export interface ExecutionLinks {
1860
924
  /**
1861
925
  * Link to the result data.
1862
- * @type {string}
1863
- * @memberof ExecutionLinks
1864
926
  */
1865
927
  executionResult: string;
1866
928
  }
1867
929
  /**
1868
930
  * Response to AFM execution request body
1869
- * @export
1870
- * @interface ExecutionResponse
1871
931
  */
1872
932
  export interface ExecutionResponse {
1873
933
  /**
1874
934
  * Dimensions of the result
1875
- * @type {Array<ResultDimension>}
1876
- * @memberof ExecutionResponse
1877
935
  */
1878
936
  dimensions: Array<ResultDimension>;
1879
- /**
1880
- *
1881
- * @type {ExecutionLinks}
1882
- * @memberof ExecutionResponse
1883
- */
1884
937
  links: ExecutionLinks;
1885
938
  }
1886
939
  /**
1887
940
  * Contains the result of an AFM execution.
1888
- * @export
1889
- * @interface ExecutionResult
1890
941
  */
1891
942
  export interface ExecutionResult {
1892
943
  /**
1893
944
  * A multi-dimensional array of computed results. The most common one being a 2-dimensional array. The arrays can be composed of Double or null values.
1894
- * @type {Array<object>}
1895
- * @memberof ExecutionResult
1896
945
  */
1897
946
  data: Array<object>;
1898
947
  /**
1899
948
  * An array containing dimension headers. The size of the array corresponds to the number of dimensions. Their order corresponds to the dimension order in the execution result spec.
1900
- * @type {Array<DimensionHeader>}
1901
- * @memberof ExecutionResult
1902
949
  */
1903
950
  dimensionHeaders: Array<DimensionHeader>;
1904
- /**
1905
- *
1906
- * @type {Array<ExecutionResultGrandTotal>}
1907
- * @memberof ExecutionResult
1908
- */
1909
951
  grandTotals: Array<ExecutionResultGrandTotal>;
1910
- /**
1911
- *
1912
- * @type {ExecutionResultPaging}
1913
- * @memberof ExecutionResult
1914
- */
1915
952
  paging: ExecutionResultPaging;
1916
- /**
1917
- *
1918
- * @type {ExecutionResultMetadata}
1919
- * @memberof ExecutionResult
1920
- */
1921
953
  metadata: ExecutionResultMetadata;
1922
954
  }
1923
955
  /**
1924
956
  * A piece of extra information related to the results (e.g. debug information, warnings, etc.).
1925
- * @export
1926
- * @interface ExecutionResultDataSourceMessage
1927
957
  */
1928
958
  export interface ExecutionResultDataSourceMessage {
1929
959
  /**
1930
960
  * Id correlating different pieces of supplementary info together.
1931
- * @type {string}
1932
- * @memberof ExecutionResultDataSourceMessage
1933
961
  */
1934
962
  correlationId: string;
1935
963
  /**
1936
964
  * Information about what part of the system created this piece of supplementary info.
1937
- * @type {string}
1938
- * @memberof ExecutionResultDataSourceMessage
1939
965
  */
1940
966
  source: string;
1941
967
  /**
1942
968
  * Type of the supplementary info instance. There are currently no well-known values for this, but there might be some in the future.
1943
- * @type {string}
1944
- * @memberof ExecutionResultDataSourceMessage
1945
969
  */
1946
970
  type: string;
1947
971
  /**
1948
972
  * Data of this particular supplementary info item: a free-form JSON specific to the particular supplementary info item type.
1949
- * @type {object}
1950
- * @memberof ExecutionResultDataSourceMessage
1951
973
  */
1952
974
  data?: object;
1953
975
  }
1954
976
  /**
1955
977
  * Contains the data of grand totals with the same dimensions.
1956
- * @export
1957
- * @interface ExecutionResultGrandTotal
1958
978
  */
1959
979
  export interface ExecutionResultGrandTotal {
1960
980
  /**
1961
981
  * A multi-dimensional array of computed results. The most common one being a 2-dimensional array. The arrays can be composed of Double or null values.
1962
- * @type {Array<object>}
1963
- * @memberof ExecutionResultGrandTotal
1964
982
  */
1965
983
  data: Array<object>;
1966
984
  /**
1967
985
  * Contains headers for a subset of `totalDimensions` in which the totals are grand totals.
1968
- * @type {Array<DimensionHeader>}
1969
- * @memberof ExecutionResultGrandTotal
1970
986
  */
1971
987
  dimensionHeaders: Array<DimensionHeader>;
1972
988
  /**
1973
989
  * Dimensions of the grand totals.
1974
- * @type {Array<string>}
1975
- * @memberof ExecutionResultGrandTotal
1976
990
  */
1977
991
  totalDimensions: Array<string>;
1978
992
  }
1979
993
  /**
1980
994
  * @type ExecutionResultHeader
1981
995
  * Abstract execution result header
1982
- * @export
1983
996
  */
1984
997
  export type ExecutionResultHeader = AttributeExecutionResultHeader | MeasureExecutionResultHeader | TotalExecutionResultHeader;
1985
998
  /**
1986
999
  * Additional metadata for the particular execution result.
1987
- * @export
1988
- * @interface ExecutionResultMetadata
1989
1000
  */
1990
1001
  export interface ExecutionResultMetadata {
1991
1002
  /**
1992
1003
  * Additional information sent by the underlying data source.
1993
- * @type {Array<ExecutionResultDataSourceMessage>}
1994
- * @memberof ExecutionResultMetadata
1995
1004
  */
1996
1005
  dataSourceMessages: Array<ExecutionResultDataSourceMessage>;
1997
1006
  }
1998
1007
  /**
1999
1008
  * A paging information related to the data presented in the execution result. These paging information are multi-dimensional.
2000
- * @export
2001
- * @interface ExecutionResultPaging
2002
1009
  */
2003
1010
  export interface ExecutionResultPaging {
2004
1011
  /**
2005
1012
  * A count of the returned results in every dimension.
2006
- * @type {Array<number>}
2007
- * @memberof ExecutionResultPaging
2008
1013
  */
2009
1014
  count: Array<number>;
2010
1015
  /**
2011
1016
  * The offset of the results returned in every dimension.
2012
- * @type {Array<number>}
2013
- * @memberof ExecutionResultPaging
2014
1017
  */
2015
1018
  offset: Array<number>;
2016
1019
  /**
2017
1020
  * A total count of the results in every dimension.
2018
- * @type {Array<number>}
2019
- * @memberof ExecutionResultPaging
2020
1021
  */
2021
1022
  total: Array<number>;
2022
1023
  }
2023
1024
  /**
2024
1025
  * Various settings affecting the process of AFM execution or its result
2025
- * @export
2026
- * @interface ExecutionSettings
2027
1026
  */
2028
1027
  export interface ExecutionSettings {
2029
1028
  /**
2030
1029
  * Specifies the percentage of rows from fact datasets to use during computation. This feature is available only for workspaces that use a Vertica Data Source without table views.
2031
- * @type {number}
2032
- * @memberof ExecutionSettings
2033
1030
  */
2034
1031
  dataSamplingPercentage?: number;
2035
1032
  /**
2036
1033
  * Specifies the timestamp of the execution from which relative filters are resolved. If not set, the current time is used.
2037
- * @type {string}
2038
- * @memberof ExecutionSettings
2039
1034
  */
2040
1035
  timestamp?: string;
2041
1036
  }
2042
1037
  /**
2043
1038
  * Specifies what is used for filtering.
2044
- * @export
2045
- * @interface FilterBy
2046
1039
  */
2047
1040
  export interface FilterBy {
2048
1041
  /**
2049
1042
  * Specifies which label is used for filtering - primary or requested.
2050
- * @type {string}
2051
- * @memberof FilterBy
2052
1043
  */
2053
1044
  labelType?: FilterByLabelTypeEnum;
2054
1045
  }
@@ -2060,220 +1051,89 @@ export type FilterByLabelTypeEnum = (typeof FilterByLabelTypeEnum)[keyof typeof
2060
1051
  /**
2061
1052
  * @type FilterDefinition
2062
1053
  * Abstract filter definition type
2063
- * @export
2064
1054
  */
2065
1055
  export type FilterDefinition = AbsoluteDateFilter | ComparisonMeasureValueFilter | InlineFilterDefinition | NegativeAttributeFilter | PositiveAttributeFilter | RangeMeasureValueFilter | RankingFilter | RelativeDateFilter;
2066
1056
  /**
2067
1057
  * @type FilterDefinitionForSimpleMeasure
2068
1058
  * Abstract filter definition type for simple metric.
2069
- * @export
2070
1059
  */
2071
1060
  export type FilterDefinitionForSimpleMeasure = AttributeFilter | DateFilter;
2072
- /**
2073
- *
2074
- * @export
2075
- * @interface ForecastRequest
2076
- */
2077
1061
  export interface ForecastRequest {
2078
1062
  /**
2079
1063
  * Number of future periods that should be forecasted
2080
- * @type {number}
2081
- * @memberof ForecastRequest
2082
1064
  */
2083
1065
  forecastPeriod: number;
2084
1066
  /**
2085
1067
  * Confidence interval boundary value.
2086
- * @type {number}
2087
- * @memberof ForecastRequest
2088
1068
  */
2089
1069
  confidenceLevel?: number;
2090
1070
  /**
2091
1071
  * Whether the input data is seasonal
2092
- * @type {boolean}
2093
- * @memberof ForecastRequest
2094
1072
  */
2095
1073
  seasonal?: boolean;
2096
1074
  }
2097
- /**
2098
- *
2099
- * @export
2100
- * @interface ForecastResult
2101
- */
2102
1075
  export interface ForecastResult {
2103
- /**
2104
- *
2105
- * @type {Array<string>}
2106
- * @memberof ForecastResult
2107
- */
2108
1076
  attribute: Array<string>;
2109
- /**
2110
- *
2111
- * @type {Array<number>}
2112
- * @memberof ForecastResult
2113
- */
2114
- origin: Array<number>;
2115
- /**
2116
- *
2117
- * @type {Array<number>}
2118
- * @memberof ForecastResult
2119
- */
2120
- prediction: Array<number>;
2121
- /**
2122
- *
2123
- * @type {Array<number>}
2124
- * @memberof ForecastResult
2125
- */
2126
- lowerBound: Array<number>;
2127
- /**
2128
- *
2129
- * @type {Array<number>}
2130
- * @memberof ForecastResult
2131
- */
2132
- upperBound: Array<number>;
1077
+ origin: Array<number | null>;
1078
+ prediction: Array<number | null>;
1079
+ lowerBound: Array<number | null>;
1080
+ upperBound: Array<number | null>;
2133
1081
  }
2134
1082
  /**
2135
1083
  * List of objects found by similarity search and post-processed by LLM.
2136
- * @export
2137
- * @interface FoundObjects
2138
1084
  */
2139
1085
  export interface FoundObjects {
2140
1086
  /**
2141
1087
  * List of objects found with a similarity search.
2142
- * @type {Array<SearchResultObject>}
2143
- * @memberof FoundObjects
2144
1088
  */
2145
1089
  objects: Array<SearchResultObject>;
2146
1090
  /**
2147
1091
  * Reasoning from LLM. Description of how and why the answer was generated.
2148
- * @type {string}
2149
- * @memberof FoundObjects
2150
1092
  */
2151
1093
  reasoning: string;
2152
1094
  }
2153
1095
  /**
2154
1096
  * Contains the information specific for a group of headers. These groups correlate to attributes and metric groups.
2155
- * @export
2156
- * @interface HeaderGroup
2157
1097
  */
2158
1098
  export interface HeaderGroup {
2159
1099
  /**
2160
1100
  * An array containing headers.
2161
- * @type {Array<ExecutionResultHeader>}
2162
- * @memberof HeaderGroup
2163
1101
  */
2164
1102
  headers: Array<ExecutionResultHeader>;
2165
1103
  }
2166
1104
  /**
2167
1105
  * Filter in form of direct MAQL query.
2168
- * @export
2169
- * @interface InlineFilterDefinition
2170
1106
  */
2171
1107
  export interface InlineFilterDefinition {
2172
- /**
2173
- *
2174
- * @type {InlineFilterDefinitionInline}
2175
- * @memberof InlineFilterDefinition
2176
- */
2177
1108
  inline: InlineFilterDefinitionInline;
2178
1109
  }
2179
- /**
2180
- *
2181
- * @export
2182
- * @interface InlineFilterDefinitionInline
2183
- */
2184
1110
  export interface InlineFilterDefinitionInline {
2185
1111
  /**
2186
1112
  * MAQL query representing the filter.
2187
- * @type {string}
2188
- * @memberof InlineFilterDefinitionInline
2189
1113
  */
2190
1114
  filter: string;
2191
- /**
2192
- *
2193
- * @type {string}
2194
- * @memberof InlineFilterDefinitionInline
2195
- */
2196
1115
  localIdentifier?: string;
2197
- /**
2198
- *
2199
- * @type {boolean}
2200
- * @memberof InlineFilterDefinitionInline
2201
- */
2202
1116
  applyOnResult?: boolean;
2203
1117
  }
2204
1118
  /**
2205
1119
  * Metric defined by the raw MAQL query.
2206
- * @export
2207
- * @interface InlineMeasureDefinition
2208
1120
  */
2209
1121
  export interface InlineMeasureDefinition {
2210
- /**
2211
- *
2212
- * @type {InlineMeasureDefinitionInline}
2213
- * @memberof InlineMeasureDefinition
2214
- */
2215
1122
  inline: InlineMeasureDefinitionInline;
2216
1123
  }
2217
- /**
2218
- *
2219
- * @export
2220
- * @interface InlineMeasureDefinitionInline
2221
- */
2222
1124
  export interface InlineMeasureDefinitionInline {
2223
1125
  /**
2224
1126
  * MAQL query defining the metric.
2225
- * @type {string}
2226
- * @memberof InlineMeasureDefinitionInline
2227
1127
  */
2228
1128
  maql: string;
2229
1129
  }
2230
- /**
2231
- *
2232
- * @export
2233
- * @interface KeyDriversDimension
2234
- */
2235
1130
  export interface KeyDriversDimension {
2236
- /**
2237
- *
2238
- * @type {RestApiIdentifier}
2239
- * @memberof KeyDriversDimension
2240
- */
2241
1131
  label: RestApiIdentifier;
2242
- /**
2243
- *
2244
- * @type {string}
2245
- * @memberof KeyDriversDimension
2246
- */
2247
1132
  labelName: string;
2248
- /**
2249
- *
2250
- * @type {RestApiIdentifier}
2251
- * @memberof KeyDriversDimension
2252
- */
2253
1133
  attribute: RestApiIdentifier;
2254
- /**
2255
- *
2256
- * @type {string}
2257
- * @memberof KeyDriversDimension
2258
- */
2259
1134
  attributeName: string;
2260
- /**
2261
- *
2262
- * @type {string}
2263
- * @memberof KeyDriversDimension
2264
- */
2265
1135
  granularity?: KeyDriversDimensionGranularityEnum;
2266
- /**
2267
- *
2268
- * @type {AttributeFormat}
2269
- * @memberof KeyDriversDimension
2270
- */
2271
1136
  format?: AttributeFormat;
2272
- /**
2273
- *
2274
- * @type {string}
2275
- * @memberof KeyDriversDimension
2276
- */
2277
1137
  valueType?: KeyDriversDimensionValueTypeEnum;
2278
1138
  }
2279
1139
  export declare const KeyDriversDimensionGranularityEnum: {
@@ -2304,28 +1164,14 @@ export declare const KeyDriversDimensionValueTypeEnum: {
2304
1164
  readonly IMAGE: "IMAGE";
2305
1165
  };
2306
1166
  export type KeyDriversDimensionValueTypeEnum = (typeof KeyDriversDimensionValueTypeEnum)[keyof typeof KeyDriversDimensionValueTypeEnum];
2307
- /**
2308
- *
2309
- * @export
2310
- * @interface KeyDriversRequest
2311
- */
2312
1167
  export interface KeyDriversRequest {
2313
- /**
2314
- *
2315
- * @type {MeasureItem}
2316
- * @memberof KeyDriversRequest
2317
- */
2318
1168
  metric: MeasureItem;
2319
1169
  /**
2320
1170
  * Additional metrics to be included in the computation, but excluded from the analysis.
2321
- * @type {Array<MeasureItem>}
2322
- * @memberof KeyDriversRequest
2323
1171
  */
2324
1172
  auxMetrics?: Array<MeasureItem>;
2325
1173
  /**
2326
1174
  * Sorting elements - ascending/descending order.
2327
- * @type {string}
2328
- * @memberof KeyDriversRequest
2329
1175
  */
2330
1176
  sortDirection?: KeyDriversRequestSortDirectionEnum;
2331
1177
  }
@@ -2334,161 +1180,83 @@ export declare const KeyDriversRequestSortDirectionEnum: {
2334
1180
  readonly DESC: "DESC";
2335
1181
  };
2336
1182
  export type KeyDriversRequestSortDirectionEnum = (typeof KeyDriversRequestSortDirectionEnum)[keyof typeof KeyDriversRequestSortDirectionEnum];
2337
- /**
2338
- *
2339
- * @export
2340
- * @interface KeyDriversResponse
2341
- */
2342
1183
  export interface KeyDriversResponse {
2343
- /**
2344
- *
2345
- * @type {Array<KeyDriversDimension>}
2346
- * @memberof KeyDriversResponse
2347
- */
2348
1184
  dimensions: Array<KeyDriversDimension>;
2349
- /**
2350
- *
2351
- * @type {ExecutionLinks}
2352
- * @memberof KeyDriversResponse
2353
- */
2354
1185
  links: ExecutionLinks;
2355
1186
  }
2356
- /**
2357
- *
2358
- * @export
2359
- * @interface KeyDriversResult
2360
- */
2361
1187
  export interface KeyDriversResult {
2362
- /**
2363
- *
2364
- * @type {object}
2365
- * @memberof KeyDriversResult
2366
- */
2367
1188
  data: object;
2368
1189
  }
2369
1190
  /**
2370
1191
  * @type MeasureDefinition
2371
1192
  * Abstract metric definition type
2372
- * @export
2373
1193
  */
2374
1194
  export type MeasureDefinition = ArithmeticMeasureDefinition | InlineMeasureDefinition | PopMeasureDefinition | SimpleMeasureDefinition;
2375
- /**
2376
- *
2377
- * @export
2378
- * @interface MeasureExecutionResultHeader
2379
- */
2380
1195
  export interface MeasureExecutionResultHeader {
2381
- /**
2382
- *
2383
- * @type {MeasureResultHeader}
2384
- * @memberof MeasureExecutionResultHeader
2385
- */
2386
1196
  measureHeader: MeasureResultHeader;
2387
1197
  }
2388
1198
  /**
2389
1199
  * Measure group headers
2390
- * @export
2391
- * @interface MeasureGroupHeaders
2392
1200
  */
2393
1201
  export interface MeasureGroupHeaders {
2394
- /**
2395
- *
2396
- * @type {Array<MeasureHeader>}
2397
- * @memberof MeasureGroupHeaders
2398
- */
2399
1202
  measureGroupHeaders?: Array<MeasureHeader>;
2400
1203
  }
2401
- /**
2402
- *
2403
- * @export
2404
- * @interface MeasureHeader
2405
- */
2406
1204
  export interface MeasureHeader {
2407
1205
  /**
2408
1206
  * Local identifier of the measure this header relates to.
2409
- * @type {string}
2410
- * @memberof MeasureHeader
2411
1207
  */
2412
1208
  localIdentifier: string;
2413
1209
  /**
2414
1210
  * Format to be used to format the measure data.
2415
- * @type {string}
2416
- * @memberof MeasureHeader
2417
1211
  */
2418
1212
  format?: string;
2419
1213
  /**
2420
1214
  * Name of the measure.
2421
- * @type {string}
2422
- * @memberof MeasureHeader
2423
1215
  */
2424
1216
  name?: string;
2425
1217
  }
2426
1218
  /**
2427
1219
  * Metric is a quantity that is calculated from the data.
2428
- * @export
2429
- * @interface MeasureItem
2430
1220
  */
2431
1221
  export interface MeasureItem {
2432
1222
  /**
2433
1223
  * Local identifier of the metric. This can be used to reference the metric in other parts of the execution definition.
2434
- * @type {string}
2435
- * @memberof MeasureItem
2436
1224
  */
2437
1225
  localIdentifier: string;
2438
- /**
2439
- *
2440
- * @type {MeasureDefinition}
2441
- * @memberof MeasureItem
2442
- */
2443
1226
  definition: MeasureDefinition;
2444
1227
  }
2445
1228
  /**
2446
1229
  * Header containing the information related to metrics.
2447
- * @export
2448
- * @interface MeasureResultHeader
2449
1230
  */
2450
1231
  export interface MeasureResultHeader {
2451
1232
  /**
2452
1233
  * Metric index. Starts at 0.
2453
- * @type {number}
2454
- * @memberof MeasureResultHeader
2455
1234
  */
2456
1235
  measureIndex: number;
2457
1236
  }
2458
1237
  /**
2459
1238
  * @type MeasureValueFilter
2460
1239
  * Abstract filter definition type filtering by the value of the metric.
2461
- * @export
2462
1240
  */
2463
1241
  export type MeasureValueFilter = ComparisonMeasureValueFilter | RangeMeasureValueFilter;
2464
1242
  /**
2465
1243
  * List of metrics to be used in the new visualization
2466
- * @export
2467
- * @interface Metric
2468
1244
  */
2469
1245
  export interface Metric {
2470
1246
  /**
2471
1247
  * ID of the object
2472
- * @type {string}
2473
- * @memberof Metric
2474
1248
  */
2475
1249
  id: string;
2476
1250
  /**
2477
1251
  * Object type
2478
- * @type {string}
2479
- * @memberof Metric
2480
1252
  */
2481
1253
  type: MetricTypeEnum;
2482
1254
  /**
2483
1255
  * Title of metric.
2484
- * @type {string}
2485
- * @memberof Metric
2486
1256
  */
2487
1257
  title: string;
2488
1258
  /**
2489
1259
  * Agg function. Empty if a stored metric is used.
2490
- * @type {string}
2491
- * @memberof Metric
2492
1260
  */
2493
1261
  aggFunction?: MetricAggFunctionEnum;
2494
1262
  }
@@ -2509,296 +1277,119 @@ export declare const MetricAggFunctionEnum: {
2509
1277
  export type MetricAggFunctionEnum = (typeof MetricAggFunctionEnum)[keyof typeof MetricAggFunctionEnum];
2510
1278
  /**
2511
1279
  * Filter able to limit element values by label and related selected negated elements.
2512
- * @export
2513
- * @interface NegativeAttributeFilter
2514
1280
  */
2515
1281
  export interface NegativeAttributeFilter {
2516
- /**
2517
- *
2518
- * @type {NegativeAttributeFilterNegativeAttributeFilter}
2519
- * @memberof NegativeAttributeFilter
2520
- */
2521
1282
  negativeAttributeFilter: NegativeAttributeFilterNegativeAttributeFilter;
2522
1283
  }
2523
- /**
2524
- *
2525
- * @export
2526
- * @interface NegativeAttributeFilterNegativeAttributeFilter
2527
- */
2528
1284
  export interface NegativeAttributeFilterNegativeAttributeFilter {
2529
- /**
2530
- *
2531
- * @type {AttributeFilterElements}
2532
- * @memberof NegativeAttributeFilterNegativeAttributeFilter
2533
- */
2534
1285
  notIn: AttributeFilterElements;
2535
- /**
2536
- *
2537
- * @type {string}
2538
- * @memberof NegativeAttributeFilterNegativeAttributeFilter
2539
- */
2540
1286
  localIdentifier?: string;
2541
- /**
2542
- *
2543
- * @type {boolean}
2544
- * @memberof NegativeAttributeFilterNegativeAttributeFilter
2545
- */
2546
1287
  applyOnResult?: boolean;
2547
- /**
2548
- *
2549
- * @type {AfmIdentifier}
2550
- * @memberof NegativeAttributeFilterNegativeAttributeFilter
2551
- */
2552
1288
  label: AfmIdentifier;
2553
1289
  }
2554
1290
  /**
2555
1291
  * Current page description.
2556
- * @export
2557
- * @interface Paging
2558
1292
  */
2559
1293
  export interface Paging {
2560
1294
  /**
2561
1295
  * Count of returnable items ignoring paging.
2562
- * @type {number}
2563
- * @memberof Paging
2564
1296
  */
2565
1297
  total: number;
2566
1298
  /**
2567
1299
  * Count of items in this page.
2568
- * @type {number}
2569
- * @memberof Paging
2570
1300
  */
2571
1301
  count: number;
2572
1302
  /**
2573
1303
  * Offset of this page.
2574
- * @type {number}
2575
- * @memberof Paging
2576
1304
  */
2577
1305
  offset: number;
2578
1306
  /**
2579
1307
  * Link to next page, or null if this is last page.
2580
- * @type {string}
2581
- * @memberof Paging
2582
1308
  */
2583
1309
  next?: string;
2584
1310
  }
2585
1311
  /**
2586
1312
  * Combination of the date data set to use and how many periods ago to calculate the previous period for.
2587
- * @export
2588
- * @interface PopDataset
2589
1313
  */
2590
1314
  export interface PopDataset {
2591
- /**
2592
- *
2593
- * @type {AfmObjectIdentifierDataset}
2594
- * @memberof PopDataset
2595
- */
2596
1315
  dataset: AfmObjectIdentifierDataset;
2597
1316
  /**
2598
1317
  * Number of periods ago to calculate the previous period for.
2599
- * @type {number}
2600
- * @memberof PopDataset
2601
1318
  */
2602
1319
  periodsAgo: number;
2603
1320
  }
2604
1321
  /**
2605
1322
  * Previous period type of metric.
2606
- * @export
2607
- * @interface PopDatasetMeasureDefinition
2608
1323
  */
2609
1324
  export interface PopDatasetMeasureDefinition {
2610
- /**
2611
- *
2612
- * @type {PopDatasetMeasureDefinitionPreviousPeriodMeasure}
2613
- * @memberof PopDatasetMeasureDefinition
2614
- */
2615
1325
  previousPeriodMeasure: PopDatasetMeasureDefinitionPreviousPeriodMeasure;
2616
1326
  }
2617
- /**
2618
- *
2619
- * @export
2620
- * @interface PopDatasetMeasureDefinitionPreviousPeriodMeasure
2621
- */
2622
1327
  export interface PopDatasetMeasureDefinitionPreviousPeriodMeasure {
2623
- /**
2624
- *
2625
- * @type {AfmLocalIdentifier}
2626
- * @memberof PopDatasetMeasureDefinitionPreviousPeriodMeasure
2627
- */
2628
1328
  measureIdentifier: AfmLocalIdentifier;
2629
1329
  /**
2630
1330
  * Specification of which date data sets to use for determining the period to calculate the previous period for.
2631
- * @type {Array<PopDataset>}
2632
- * @memberof PopDatasetMeasureDefinitionPreviousPeriodMeasure
2633
1331
  */
2634
1332
  dateDatasets: Array<PopDataset>;
2635
1333
  }
2636
1334
  /**
2637
1335
  * Combination of the date attribute to use and how many periods ago to calculate the PoP for.
2638
- * @export
2639
- * @interface PopDate
2640
1336
  */
2641
1337
  export interface PopDate {
2642
- /**
2643
- *
2644
- * @type {AfmObjectIdentifierAttribute}
2645
- * @memberof PopDate
2646
- */
2647
1338
  attribute: AfmObjectIdentifierAttribute;
2648
1339
  /**
2649
1340
  * Number of periods ago to calculate the previous period for.
2650
- * @type {number}
2651
- * @memberof PopDate
2652
1341
  */
2653
1342
  periodsAgo: number;
2654
1343
  }
2655
1344
  /**
2656
1345
  * Period over period type of metric.
2657
- * @export
2658
- * @interface PopDateMeasureDefinition
2659
1346
  */
2660
1347
  export interface PopDateMeasureDefinition {
2661
- /**
2662
- *
2663
- * @type {PopDateMeasureDefinitionOverPeriodMeasure}
2664
- * @memberof PopDateMeasureDefinition
2665
- */
2666
1348
  overPeriodMeasure: PopDateMeasureDefinitionOverPeriodMeasure;
2667
1349
  }
2668
- /**
2669
- *
2670
- * @export
2671
- * @interface PopDateMeasureDefinitionOverPeriodMeasure
2672
- */
2673
1350
  export interface PopDateMeasureDefinitionOverPeriodMeasure {
2674
- /**
2675
- *
2676
- * @type {AfmLocalIdentifier}
2677
- * @memberof PopDateMeasureDefinitionOverPeriodMeasure
2678
- */
2679
1351
  measureIdentifier: AfmLocalIdentifier;
2680
1352
  /**
2681
1353
  * Attributes to use for determining the period to calculate the PoP for.
2682
- * @type {Array<PopDate>}
2683
- * @memberof PopDateMeasureDefinitionOverPeriodMeasure
2684
1354
  */
2685
1355
  dateAttributes: Array<PopDate>;
2686
1356
  }
2687
1357
  /**
2688
1358
  * @type PopMeasureDefinition
2689
- * @export
2690
1359
  */
2691
1360
  export type PopMeasureDefinition = PopDatasetMeasureDefinition | PopDateMeasureDefinition;
2692
1361
  /**
2693
1362
  * Filter able to limit element values by label and related selected elements.
2694
- * @export
2695
- * @interface PositiveAttributeFilter
2696
1363
  */
2697
1364
  export interface PositiveAttributeFilter {
2698
- /**
2699
- *
2700
- * @type {PositiveAttributeFilterPositiveAttributeFilter}
2701
- * @memberof PositiveAttributeFilter
2702
- */
2703
1365
  positiveAttributeFilter: PositiveAttributeFilterPositiveAttributeFilter;
2704
1366
  }
2705
- /**
2706
- *
2707
- * @export
2708
- * @interface PositiveAttributeFilterPositiveAttributeFilter
2709
- */
2710
1367
  export interface PositiveAttributeFilterPositiveAttributeFilter {
2711
- /**
2712
- *
2713
- * @type {AttributeFilterElements}
2714
- * @memberof PositiveAttributeFilterPositiveAttributeFilter
2715
- */
2716
1368
  in: AttributeFilterElements;
2717
- /**
2718
- *
2719
- * @type {string}
2720
- * @memberof PositiveAttributeFilterPositiveAttributeFilter
2721
- */
2722
1369
  localIdentifier?: string;
2723
- /**
2724
- *
2725
- * @type {boolean}
2726
- * @memberof PositiveAttributeFilterPositiveAttributeFilter
2727
- */
2728
1370
  applyOnResult?: boolean;
2729
- /**
2730
- *
2731
- * @type {AfmIdentifier}
2732
- * @memberof PositiveAttributeFilterPositiveAttributeFilter
2733
- */
2734
1371
  label: AfmIdentifier;
2735
1372
  }
2736
1373
  /**
2737
1374
  * Filter the result by comparing specified metric to given range of values.
2738
- * @export
2739
- * @interface RangeMeasureValueFilter
2740
1375
  */
2741
1376
  export interface RangeMeasureValueFilter {
2742
- /**
2743
- *
2744
- * @type {RangeMeasureValueFilterRangeMeasureValueFilter}
2745
- * @memberof RangeMeasureValueFilter
2746
- */
2747
1377
  rangeMeasureValueFilter: RangeMeasureValueFilterRangeMeasureValueFilter;
2748
1378
  }
2749
- /**
2750
- *
2751
- * @export
2752
- * @interface RangeMeasureValueFilterRangeMeasureValueFilter
2753
- */
2754
1379
  export interface RangeMeasureValueFilterRangeMeasureValueFilter {
2755
1380
  /**
2756
1381
  * References to the attributes to be used when filtering.
2757
- * @type {Array<AfmIdentifier>}
2758
- * @memberof RangeMeasureValueFilterRangeMeasureValueFilter
2759
1382
  */
2760
1383
  dimensionality?: Array<AfmIdentifier>;
2761
1384
  /**
2762
1385
  * A value that will be substituted for null values in the metric for the comparisons.
2763
- * @type {number}
2764
- * @memberof RangeMeasureValueFilterRangeMeasureValueFilter
2765
1386
  */
2766
1387
  treatNullValuesAs?: number;
2767
- /**
2768
- *
2769
- * @type {string}
2770
- * @memberof RangeMeasureValueFilterRangeMeasureValueFilter
2771
- */
2772
1388
  operator: RangeMeasureValueFilterRangeMeasureValueFilterOperatorEnum;
2773
- /**
2774
- *
2775
- * @type {number}
2776
- * @memberof RangeMeasureValueFilterRangeMeasureValueFilter
2777
- */
2778
1389
  from: number;
2779
- /**
2780
- *
2781
- * @type {number}
2782
- * @memberof RangeMeasureValueFilterRangeMeasureValueFilter
2783
- */
2784
1390
  to: number;
2785
- /**
2786
- *
2787
- * @type {string}
2788
- * @memberof RangeMeasureValueFilterRangeMeasureValueFilter
2789
- */
2790
1391
  localIdentifier?: string;
2791
- /**
2792
- *
2793
- * @type {boolean}
2794
- * @memberof RangeMeasureValueFilterRangeMeasureValueFilter
2795
- */
2796
1392
  applyOnResult?: boolean;
2797
- /**
2798
- *
2799
- * @type {AfmIdentifier}
2800
- * @memberof RangeMeasureValueFilterRangeMeasureValueFilter
2801
- */
2802
1393
  measure: AfmIdentifier;
2803
1394
  }
2804
1395
  export declare const RangeMeasureValueFilterRangeMeasureValueFilterOperatorEnum: {
@@ -2808,58 +1399,28 @@ export declare const RangeMeasureValueFilterRangeMeasureValueFilterOperatorEnum:
2808
1399
  export type RangeMeasureValueFilterRangeMeasureValueFilterOperatorEnum = (typeof RangeMeasureValueFilterRangeMeasureValueFilterOperatorEnum)[keyof typeof RangeMeasureValueFilterRangeMeasureValueFilterOperatorEnum];
2809
1400
  /**
2810
1401
  * Filter the result on top/bottom N values according to given metric(s).
2811
- * @export
2812
- * @interface RankingFilter
2813
1402
  */
2814
1403
  export interface RankingFilter {
2815
- /**
2816
- *
2817
- * @type {RankingFilterRankingFilter}
2818
- * @memberof RankingFilter
2819
- */
2820
1404
  rankingFilter: RankingFilterRankingFilter;
2821
1405
  }
2822
- /**
2823
- *
2824
- * @export
2825
- * @interface RankingFilterRankingFilter
2826
- */
2827
1406
  export interface RankingFilterRankingFilter {
2828
1407
  /**
2829
1408
  * References to the attributes to be used when filtering.
2830
- * @type {Array<AfmIdentifier>}
2831
- * @memberof RankingFilterRankingFilter
2832
1409
  */
2833
1410
  dimensionality?: Array<AfmIdentifier>;
2834
1411
  /**
2835
1412
  * References to the metrics to be used when filtering.
2836
- * @type {Array<AfmIdentifier>}
2837
- * @memberof RankingFilterRankingFilter
2838
1413
  */
2839
1414
  measures: Array<AfmIdentifier>;
2840
1415
  /**
2841
1416
  * The type of ranking to use, TOP or BOTTOM.
2842
- * @type {string}
2843
- * @memberof RankingFilterRankingFilter
2844
- */
2845
- operator: RankingFilterRankingFilterOperatorEnum;
2846
- /**
2847
- * Number of top/bottom values to filter.
2848
- * @type {number}
2849
- * @memberof RankingFilterRankingFilter
2850
- */
2851
- value: number;
2852
- /**
2853
- *
2854
- * @type {string}
2855
- * @memberof RankingFilterRankingFilter
2856
1417
  */
2857
- localIdentifier?: string;
1418
+ operator: RankingFilterRankingFilterOperatorEnum;
2858
1419
  /**
2859
- *
2860
- * @type {boolean}
2861
- * @memberof RankingFilterRankingFilter
1420
+ * Number of top/bottom values to filter.
2862
1421
  */
1422
+ value: number;
1423
+ localIdentifier?: string;
2863
1424
  applyOnResult?: boolean;
2864
1425
  }
2865
1426
  export declare const RankingFilterRankingFilterOperatorEnum: {
@@ -2869,64 +1430,26 @@ export declare const RankingFilterRankingFilterOperatorEnum: {
2869
1430
  export type RankingFilterRankingFilterOperatorEnum = (typeof RankingFilterRankingFilterOperatorEnum)[keyof typeof RankingFilterRankingFilterOperatorEnum];
2870
1431
  /**
2871
1432
  * A date filter specifying a time interval that is relative to the current date. For example, last week, next month, and so on. Field dataset is representing qualifier of date dimension. The \'from\' and \'to\' properties mark the boundaries of the interval. If \'from\' is omitted, all values earlier than \'to\' are included. If \'to\' is omitted, all values later than \'from\' are included. It is not allowed to omit both.
2872
- * @export
2873
- * @interface RelativeDateFilter
2874
1433
  */
2875
1434
  export interface RelativeDateFilter {
2876
- /**
2877
- *
2878
- * @type {RelativeDateFilterRelativeDateFilter}
2879
- * @memberof RelativeDateFilter
2880
- */
2881
1435
  relativeDateFilter: RelativeDateFilterRelativeDateFilter;
2882
1436
  }
2883
- /**
2884
- *
2885
- * @export
2886
- * @interface RelativeDateFilterRelativeDateFilter
2887
- */
2888
1437
  export interface RelativeDateFilterRelativeDateFilter {
2889
1438
  /**
2890
1439
  * Date granularity specifying particular date attribute in given dimension.
2891
- * @type {string}
2892
- * @memberof RelativeDateFilterRelativeDateFilter
2893
1440
  */
2894
1441
  granularity: RelativeDateFilterRelativeDateFilterGranularityEnum;
2895
1442
  /**
2896
1443
  * 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\').
2897
- * @type {number}
2898
- * @memberof RelativeDateFilterRelativeDateFilter
2899
1444
  */
2900
1445
  from: number;
2901
1446
  /**
2902
1447
  * 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, ...).
2903
- * @type {number}
2904
- * @memberof RelativeDateFilterRelativeDateFilter
2905
1448
  */
2906
1449
  to: number;
2907
- /**
2908
- *
2909
- * @type {string}
2910
- * @memberof RelativeDateFilterRelativeDateFilter
2911
- */
2912
1450
  localIdentifier?: string;
2913
- /**
2914
- *
2915
- * @type {boolean}
2916
- * @memberof RelativeDateFilterRelativeDateFilter
2917
- */
2918
1451
  applyOnResult?: boolean;
2919
- /**
2920
- *
2921
- * @type {BoundedFilter}
2922
- * @memberof RelativeDateFilterRelativeDateFilter
2923
- */
2924
1452
  boundedFilter?: BoundedFilter;
2925
- /**
2926
- *
2927
- * @type {AfmObjectIdentifierDataset}
2928
- * @memberof RelativeDateFilterRelativeDateFilter
2929
- */
2930
1453
  dataset: AfmObjectIdentifierDataset;
2931
1454
  }
2932
1455
  export declare const RelativeDateFilterRelativeDateFilterGranularityEnum: {
@@ -2948,148 +1471,67 @@ export declare const RelativeDateFilterRelativeDateFilterGranularityEnum: {
2948
1471
  readonly QUARTER_OF_YEAR: "QUARTER_OF_YEAR";
2949
1472
  };
2950
1473
  export type RelativeDateFilterRelativeDateFilterGranularityEnum = (typeof RelativeDateFilterRelativeDateFilterGranularityEnum)[keyof typeof RelativeDateFilterRelativeDateFilterGranularityEnum];
2951
- /**
2952
- *
2953
- * @export
2954
- * @interface ResolvedLlmEndpoint
2955
- */
2956
1474
  export interface ResolvedLlmEndpoint {
2957
1475
  /**
2958
1476
  * Endpoint Id
2959
- * @type {string}
2960
- * @memberof ResolvedLlmEndpoint
2961
1477
  */
2962
1478
  id: string;
2963
1479
  /**
2964
1480
  * Endpoint Title
2965
- * @type {string}
2966
- * @memberof ResolvedLlmEndpoint
2967
1481
  */
2968
1482
  title: string;
2969
1483
  }
2970
- /**
2971
- *
2972
- * @export
2973
- * @interface ResolvedLlmEndpoints
2974
- */
2975
1484
  export interface ResolvedLlmEndpoints {
2976
- /**
2977
- *
2978
- * @type {Array<ResolvedLlmEndpoint>}
2979
- * @memberof ResolvedLlmEndpoints
2980
- */
2981
1485
  data: Array<ResolvedLlmEndpoint>;
2982
1486
  }
2983
1487
  /**
2984
1488
  * Object identifier.
2985
- * @export
2986
- * @interface RestApiIdentifier
2987
1489
  */
2988
1490
  export interface RestApiIdentifier {
2989
- /**
2990
- *
2991
- * @type {string}
2992
- * @memberof RestApiIdentifier
2993
- */
2994
1491
  id: string;
2995
- /**
2996
- *
2997
- * @type {string}
2998
- * @memberof RestApiIdentifier
2999
- */
3000
1492
  type: string;
3001
1493
  }
3002
1494
  /**
3003
1495
  * All execution result\'s metadata used for calculation including ExecutionResponse
3004
- * @export
3005
- * @interface ResultCacheMetadata
3006
1496
  */
3007
1497
  export interface ResultCacheMetadata {
3008
- /**
3009
- *
3010
- * @type {AFM}
3011
- * @memberof ResultCacheMetadata
3012
- */
3013
1498
  afm: AFM;
3014
- /**
3015
- *
3016
- * @type {ExecutionResponse}
3017
- * @memberof ResultCacheMetadata
3018
- */
3019
1499
  executionResponse: ExecutionResponse;
3020
- /**
3021
- *
3022
- * @type {ResultSpec}
3023
- * @memberof ResultCacheMetadata
3024
- */
3025
1500
  resultSpec: ResultSpec;
3026
- /**
3027
- *
3028
- * @type {number}
3029
- * @memberof ResultCacheMetadata
3030
- */
3031
1501
  resultSize: number;
3032
1502
  }
3033
1503
  /**
3034
1504
  * Single result dimension
3035
- * @export
3036
- * @interface ResultDimension
3037
1505
  */
3038
1506
  export interface ResultDimension {
3039
- /**
3040
- *
3041
- * @type {Array<ResultDimensionHeader>}
3042
- * @memberof ResultDimension
3043
- */
3044
1507
  headers: Array<ResultDimensionHeader>;
3045
1508
  /**
3046
1509
  * Local identifier of the dimension.
3047
- * @type {string}
3048
- * @memberof ResultDimension
3049
1510
  */
3050
1511
  localIdentifier: string;
3051
1512
  }
3052
1513
  /**
3053
1514
  * @type ResultDimensionHeader
3054
1515
  * One of the headers in a result dimension.
3055
- * @export
3056
1516
  */
3057
1517
  export type ResultDimensionHeader = AttributeHeader | MeasureGroupHeaders;
3058
1518
  /**
3059
1519
  * Specifies how the result data will be formatted (```dimensions```) and which additional data shall be computed (```totals```).
3060
- * @export
3061
- * @interface ResultSpec
3062
1520
  */
3063
1521
  export interface ResultSpec {
3064
- /**
3065
- *
3066
- * @type {Array<Dimension>}
3067
- * @memberof ResultSpec
3068
- */
3069
1522
  dimensions: Array<Dimension>;
3070
- /**
3071
- *
3072
- * @type {Array<Total>}
3073
- * @memberof ResultSpec
3074
- */
3075
1523
  totals?: Array<Total>;
3076
1524
  }
3077
1525
  /**
3078
1526
  * Question -> Use Case routing. May contain final answer is a special use case is not required.
3079
- * @export
3080
- * @interface RouteResult
3081
1527
  */
3082
1528
  export interface RouteResult {
3083
1529
  /**
3084
1530
  * Use case where LLM routed based on question.
3085
- * @type {string}
3086
- * @memberof RouteResult
3087
1531
  */
3088
1532
  useCase: RouteResultUseCaseEnum;
3089
1533
  /**
3090
1534
  * Explanation why LLM picked this use case.
3091
- * @type {string}
3092
- * @memberof RouteResult
3093
1535
  */
3094
1536
  reasoning: string;
3095
1537
  }
@@ -3104,118 +1546,74 @@ export declare const RouteResultUseCaseEnum: {
3104
1546
  export type RouteResultUseCaseEnum = (typeof RouteResultUseCaseEnum)[keyof typeof RouteResultUseCaseEnum];
3105
1547
  /**
3106
1548
  * Created and saved visualization IDs.
3107
- * @export
3108
- * @interface SavedVisualization
3109
1549
  */
3110
1550
  export interface SavedVisualization {
3111
1551
  /**
3112
1552
  * Created visualization ID.
3113
- * @type {string}
3114
- * @memberof SavedVisualization
3115
1553
  */
3116
1554
  createdVisualizationId: string;
3117
1555
  /**
3118
1556
  * Saved visualization ID.
3119
- * @type {string}
3120
- * @memberof SavedVisualization
3121
1557
  */
3122
1558
  savedVisualizationId: string;
3123
1559
  }
3124
- /**
3125
- *
3126
- * @export
3127
- * @interface SearchRelationshipObject
3128
- */
3129
1560
  export interface SearchRelationshipObject {
3130
1561
  /**
3131
1562
  * Source workspace ID. If relationship is dashboard->visualization, this is the workspace where the dashboard is located.
3132
- * @type {string}
3133
- * @memberof SearchRelationshipObject
3134
1563
  */
3135
1564
  sourceWorkspaceId: string;
3136
1565
  /**
3137
1566
  * Source object ID.
3138
- * @type {string}
3139
- * @memberof SearchRelationshipObject
3140
1567
  */
3141
1568
  sourceObjectId: string;
3142
1569
  /**
3143
1570
  * Source object type, e.g. dashboard.
3144
- * @type {string}
3145
- * @memberof SearchRelationshipObject
3146
1571
  */
3147
1572
  sourceObjectType: string;
3148
1573
  /**
3149
1574
  * Source object title.
3150
- * @type {string}
3151
- * @memberof SearchRelationshipObject
3152
1575
  */
3153
1576
  sourceObjectTitle: string;
3154
1577
  /**
3155
1578
  * Target workspace ID. If relationship is dashboard->visualization, this is the workspace where the visualization is located.
3156
- * @type {string}
3157
- * @memberof SearchRelationshipObject
3158
1579
  */
3159
1580
  targetWorkspaceId: string;
3160
1581
  /**
3161
1582
  * Target object ID.
3162
- * @type {string}
3163
- * @memberof SearchRelationshipObject
3164
1583
  */
3165
1584
  targetObjectId: string;
3166
1585
  /**
3167
1586
  * Target object type, e.g. visualization.
3168
- * @type {string}
3169
- * @memberof SearchRelationshipObject
3170
1587
  */
3171
1588
  targetObjectType: string;
3172
1589
  /**
3173
1590
  * Target object title.
3174
- * @type {string}
3175
- * @memberof SearchRelationshipObject
3176
1591
  */
3177
1592
  targetObjectTitle: string;
3178
1593
  }
3179
- /**
3180
- *
3181
- * @export
3182
- * @interface SearchRequest
3183
- */
3184
1594
  export interface SearchRequest {
3185
1595
  /**
3186
1596
  * Keyword/sentence is input for search.
3187
- * @type {string}
3188
- * @memberof SearchRequest
3189
1597
  */
3190
1598
  question: string;
3191
1599
  /**
3192
1600
  * List of object types to search for.
3193
- * @type {Array<string>}
3194
- * @memberof SearchRequest
3195
1601
  */
3196
1602
  objectTypes?: Array<SearchRequestObjectTypesEnum>;
3197
1603
  /**
3198
1604
  * Turn on deep search. If true, content of complex objects will be searched as well, e.g. metrics in visualizations.
3199
- * @type {boolean}
3200
- * @memberof SearchRequest
3201
1605
  */
3202
1606
  deepSearch?: boolean;
3203
1607
  /**
3204
1608
  * 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.
3205
- * @type {number}
3206
- * @memberof SearchRequest
3207
1609
  */
3208
1610
  limit?: number;
3209
1611
  /**
3210
1612
  * Temporary for experiments. Ratio of title score to descriptor score.
3211
- * @type {number}
3212
- * @memberof SearchRequest
3213
1613
  */
3214
1614
  titleToDescriptorRatio?: number;
3215
1615
  /**
3216
1616
  * Score, above which we return found objects. Below this score objects are not relevant.
3217
- * @type {number}
3218
- * @memberof SearchRequest
3219
1617
  */
3220
1618
  relevantScoreThreshold?: number;
3221
1619
  }
@@ -3230,157 +1628,83 @@ export declare const SearchRequestObjectTypesEnum: {
3230
1628
  readonly DASHBOARD: "dashboard";
3231
1629
  };
3232
1630
  export type SearchRequestObjectTypesEnum = (typeof SearchRequestObjectTypesEnum)[keyof typeof SearchRequestObjectTypesEnum];
3233
- /**
3234
- *
3235
- * @export
3236
- * @interface SearchResult
3237
- */
3238
1631
  export interface SearchResult {
3239
- /**
3240
- *
3241
- * @type {Array<SearchResultObject>}
3242
- * @memberof SearchResult
3243
- */
3244
1632
  results: Array<SearchResultObject>;
3245
- /**
3246
- *
3247
- * @type {Array<SearchRelationshipObject>}
3248
- * @memberof SearchResult
3249
- */
3250
1633
  relationships: Array<SearchRelationshipObject>;
3251
1634
  /**
3252
1635
  * If something is not working properly this field will contain explanation.
3253
- * @type {string}
3254
- * @memberof SearchResult
3255
1636
  */
3256
1637
  reasoning: string;
3257
1638
  }
3258
- /**
3259
- *
3260
- * @export
3261
- * @interface SearchResultObject
3262
- */
3263
1639
  export interface SearchResultObject {
3264
1640
  /**
3265
1641
  * Object ID.
3266
- * @type {string}
3267
- * @memberof SearchResultObject
3268
1642
  */
3269
1643
  id: string;
3270
1644
  /**
3271
1645
  * Object type, e.g. dashboard.
3272
- * @type {string}
3273
- * @memberof SearchResultObject
3274
1646
  */
3275
1647
  type: string;
3276
1648
  /**
3277
1649
  * Workspace ID.
3278
- * @type {string}
3279
- * @memberof SearchResultObject
3280
1650
  */
3281
1651
  workspaceId: string;
3282
1652
  /**
3283
1653
  * Object title.
3284
- * @type {string}
3285
- * @memberof SearchResultObject
3286
1654
  */
3287
1655
  title: string;
3288
1656
  /**
3289
1657
  * Object description.
3290
- * @type {string}
3291
- * @memberof SearchResultObject
3292
1658
  */
3293
1659
  description?: string;
3294
- /**
3295
- *
3296
- * @type {Array<string>}
3297
- * @memberof SearchResultObject
3298
- */
3299
1660
  tags?: Array<string>;
3300
1661
  /**
3301
1662
  * Timestamp when object was created.
3302
- * @type {string}
3303
- * @memberof SearchResultObject
3304
1663
  */
3305
1664
  createdAt?: string;
3306
1665
  /**
3307
1666
  * Timestamp when object was last modified.
3308
- * @type {string}
3309
- * @memberof SearchResultObject
3310
1667
  */
3311
1668
  modifiedAt?: string;
3312
1669
  /**
3313
1670
  * If the object is visualization, this field defines the type of visualization.
3314
- * @type {string}
3315
- * @memberof SearchResultObject
3316
1671
  */
3317
1672
  visualizationUrl?: string;
3318
1673
  /**
3319
1674
  * Result score calculated by a similarity search algorithm (cosine_distance).
3320
- * @type {number}
3321
- * @memberof SearchResultObject
3322
1675
  */
3323
1676
  score?: number;
3324
1677
  /**
3325
1678
  * Result score for object title.
3326
- * @type {number}
3327
- * @memberof SearchResultObject
3328
1679
  */
3329
1680
  scoreTitle?: number;
3330
1681
  /**
3331
1682
  * Result score for descriptor containing(now) description and tags.
3332
- * @type {number}
3333
- * @memberof SearchResultObject
3334
1683
  */
3335
1684
  scoreDescriptor?: number;
3336
1685
  /**
3337
1686
  * Result score for exact match(id/title). 1/1000. Other scores are multiplied by this.
3338
- * @type {number}
3339
- * @memberof SearchResultObject
3340
1687
  */
3341
1688
  scoreExactMatch?: number;
3342
1689
  }
3343
1690
  /**
3344
1691
  * Metric defined by referencing a MAQL metric or an LDM fact object with aggregation.
3345
- * @export
3346
- * @interface SimpleMeasureDefinition
3347
1692
  */
3348
1693
  export interface SimpleMeasureDefinition {
3349
- /**
3350
- *
3351
- * @type {SimpleMeasureDefinitionMeasure}
3352
- * @memberof SimpleMeasureDefinition
3353
- */
3354
1694
  measure: SimpleMeasureDefinitionMeasure;
3355
1695
  }
3356
- /**
3357
- *
3358
- * @export
3359
- * @interface SimpleMeasureDefinitionMeasure
3360
- */
3361
1696
  export interface SimpleMeasureDefinitionMeasure {
3362
- /**
3363
- *
3364
- * @type {AfmObjectIdentifierCore}
3365
- * @memberof SimpleMeasureDefinitionMeasure
3366
- */
3367
1697
  item: AfmObjectIdentifierCore;
3368
1698
  /**
3369
1699
  * Definition of aggregation type of the metric.
3370
- * @type {string}
3371
- * @memberof SimpleMeasureDefinitionMeasure
3372
1700
  */
3373
1701
  aggregation?: SimpleMeasureDefinitionMeasureAggregationEnum;
3374
1702
  /**
3375
1703
  * If true, compute the percentage of given metric values (broken down by AFM attributes) to the total (not broken down).
3376
- * @type {boolean}
3377
- * @memberof SimpleMeasureDefinitionMeasure
3378
1704
  */
3379
1705
  computeRatio?: boolean;
3380
1706
  /**
3381
1707
  * Metrics can be filtered by attribute filters with the same interface as ones for global AFM. Note that only one DateFilter is allowed.
3382
- * @type {Array<FilterDefinitionForSimpleMeasure>}
3383
- * @memberof SimpleMeasureDefinitionMeasure
3384
1708
  */
3385
1709
  filters?: Array<FilterDefinitionForSimpleMeasure>;
3386
1710
  }
@@ -3395,59 +1719,30 @@ export declare const SimpleMeasureDefinitionMeasureAggregationEnum: {
3395
1719
  readonly APPROXIMATE_COUNT: "APPROXIMATE_COUNT";
3396
1720
  };
3397
1721
  export type SimpleMeasureDefinitionMeasureAggregationEnum = (typeof SimpleMeasureDefinitionMeasureAggregationEnum)[keyof typeof SimpleMeasureDefinitionMeasureAggregationEnum];
3398
- /**
3399
- *
3400
- * @export
3401
- * @interface SmartFunctionResponse
3402
- */
3403
1722
  export interface SmartFunctionResponse {
3404
- /**
3405
- *
3406
- * @type {ExecutionLinks}
3407
- * @memberof SmartFunctionResponse
3408
- */
3409
1723
  links: ExecutionLinks;
3410
1724
  }
3411
1725
  /**
3412
1726
  * @type SortKey
3413
- * @export
3414
1727
  */
3415
1728
  export type SortKey = SortKeyAttribute | SortKeyTotal | SortKeyValue;
3416
1729
  /**
3417
1730
  * Sorting rule for sorting by attribute value in current dimension.
3418
- * @export
3419
- * @interface SortKeyAttribute
3420
1731
  */
3421
1732
  export interface SortKeyAttribute {
3422
- /**
3423
- *
3424
- * @type {SortKeyAttributeAttribute}
3425
- * @memberof SortKeyAttribute
3426
- */
3427
1733
  attribute: SortKeyAttributeAttribute;
3428
1734
  }
3429
- /**
3430
- *
3431
- * @export
3432
- * @interface SortKeyAttributeAttribute
3433
- */
3434
1735
  export interface SortKeyAttributeAttribute {
3435
1736
  /**
3436
1737
  * Item reference (to \'itemIdentifiers\') referencing, which item should be used for sorting. Only references to attributes are allowed.
3437
- * @type {string}
3438
- * @memberof SortKeyAttributeAttribute
3439
1738
  */
3440
1739
  attributeIdentifier: string;
3441
1740
  /**
3442
1741
  * 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.
3443
- * @type {string}
3444
- * @memberof SortKeyAttributeAttribute
3445
1742
  */
3446
1743
  sortType?: SortKeyAttributeAttributeSortTypeEnum;
3447
1744
  /**
3448
1745
  * Sorting elements - ascending/descending order.
3449
- * @type {string}
3450
- * @memberof SortKeyAttributeAttribute
3451
1746
  */
3452
1747
  direction?: SortKeyAttributeAttributeDirectionEnum;
3453
1748
  }
@@ -3465,39 +1760,18 @@ export declare const SortKeyAttributeAttributeDirectionEnum: {
3465
1760
  export type SortKeyAttributeAttributeDirectionEnum = (typeof SortKeyAttributeAttributeDirectionEnum)[keyof typeof SortKeyAttributeAttributeDirectionEnum];
3466
1761
  /**
3467
1762
  * 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.
3468
- * @export
3469
- * @interface SortKeyTotal
3470
1763
  */
3471
1764
  export interface SortKeyTotal {
3472
- /**
3473
- *
3474
- * @type {SortKeyTotalTotal}
3475
- * @memberof SortKeyTotal
3476
- */
3477
1765
  total: SortKeyTotalTotal;
3478
1766
  }
3479
- /**
3480
- *
3481
- * @export
3482
- * @interface SortKeyTotalTotal
3483
- */
3484
1767
  export interface SortKeyTotalTotal {
3485
1768
  /**
3486
1769
  * Local identifier of the total to sort by.
3487
- * @type {string}
3488
- * @memberof SortKeyTotalTotal
3489
1770
  */
3490
1771
  totalIdentifier: string;
3491
- /**
3492
- *
3493
- * @type {DataColumnLocators}
3494
- * @memberof SortKeyTotalTotal
3495
- */
3496
1772
  dataColumnLocators?: DataColumnLocators;
3497
1773
  /**
3498
1774
  * Sorting elements - ascending/descending order.
3499
- * @type {string}
3500
- * @memberof SortKeyTotalTotal
3501
1775
  */
3502
1776
  direction?: SortKeyTotalTotalDirectionEnum;
3503
1777
  }
@@ -3508,33 +1782,14 @@ export declare const SortKeyTotalTotalDirectionEnum: {
3508
1782
  export type SortKeyTotalTotalDirectionEnum = (typeof SortKeyTotalTotalDirectionEnum)[keyof typeof SortKeyTotalTotalDirectionEnum];
3509
1783
  /**
3510
1784
  * Sorting rule for sorting by measure value. DataColumnLocators for each dimension opposite to the sorted one must be specified.
3511
- * @export
3512
- * @interface SortKeyValue
3513
1785
  */
3514
1786
  export interface SortKeyValue {
3515
- /**
3516
- *
3517
- * @type {SortKeyValueValue}
3518
- * @memberof SortKeyValue
3519
- */
3520
1787
  value: SortKeyValueValue;
3521
1788
  }
3522
- /**
3523
- *
3524
- * @export
3525
- * @interface SortKeyValueValue
3526
- */
3527
1789
  export interface SortKeyValueValue {
3528
- /**
3529
- *
3530
- * @type {DataColumnLocators}
3531
- * @memberof SortKeyValueValue
3532
- */
3533
1790
  dataColumnLocators: DataColumnLocators;
3534
1791
  /**
3535
1792
  * Sorting elements - ascending/descending order.
3536
- * @type {string}
3537
- * @memberof SortKeyValueValue
3538
1793
  */
3539
1794
  direction?: SortKeyValueValueDirectionEnum;
3540
1795
  }
@@ -3545,52 +1800,33 @@ export declare const SortKeyValueValueDirectionEnum: {
3545
1800
  export type SortKeyValueValueDirectionEnum = (typeof SortKeyValueValueDirectionEnum)[keyof typeof SortKeyValueValueDirectionEnum];
3546
1801
  /**
3547
1802
  * List of suggestions for next steps. Filled when no visualization was created, suggests alternatives.
3548
- * @export
3549
- * @interface Suggestion
3550
1803
  */
3551
1804
  export interface Suggestion {
3552
1805
  /**
3553
1806
  * Suggestion query
3554
- * @type {string}
3555
- * @memberof Suggestion
3556
1807
  */
3557
1808
  query: string;
3558
1809
  /**
3559
1810
  * Suggestion button label
3560
- * @type {string}
3561
- * @memberof Suggestion
3562
1811
  */
3563
1812
  label: string;
3564
1813
  }
3565
1814
  /**
3566
1815
  * 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`
3567
- * @export
3568
- * @interface Total
3569
1816
  */
3570
1817
  export interface Total {
3571
1818
  /**
3572
1819
  * Total identification within this request. Used e.g. in sorting by a total.
3573
- * @type {string}
3574
- * @memberof Total
3575
1820
  */
3576
1821
  localIdentifier: string;
3577
1822
  /**
3578
1823
  * Aggregation function to compute the total.
3579
- * @type {string}
3580
- * @memberof Total
3581
1824
  */
3582
1825
  function: TotalFunctionEnum;
3583
1826
  /**
3584
1827
  * The metric for which the total will be computed
3585
- * @type {string}
3586
- * @memberof Total
3587
1828
  */
3588
1829
  metric: string;
3589
- /**
3590
- *
3591
- * @type {Array<TotalDimension>}
3592
- * @memberof Total
3593
- */
3594
1830
  totalDimensions: Array<TotalDimension>;
3595
1831
  }
3596
1832
  export declare const TotalFunctionEnum: {
@@ -3604,171 +1840,93 @@ export declare const TotalFunctionEnum: {
3604
1840
  export type TotalFunctionEnum = (typeof TotalFunctionEnum)[keyof typeof TotalFunctionEnum];
3605
1841
  /**
3606
1842
  * A list of dimensions across which the total will be computed. Total headers for only these dimensions will be returned in the result.
3607
- * @export
3608
- * @interface TotalDimension
3609
1843
  */
3610
1844
  export interface TotalDimension {
3611
1845
  /**
3612
1846
  * An identifier of a dimension for which the total will be computed.
3613
- * @type {string}
3614
- * @memberof TotalDimension
3615
1847
  */
3616
1848
  dimensionIdentifier: string;
3617
1849
  /**
3618
1850
  * List of dimension items which will be used for total computation. The total is a grand total in this dimension if the list is empty or it includes the first dimension item from the dimension definition, and its data and header will be returned in a separate `ExecutionResultGrandTotal` structure. Otherwise, it is a subtotal and the data will be integrated into the main result.
3619
- * @type {Array<string>}
3620
- * @memberof TotalDimension
3621
1851
  */
3622
1852
  totalDimensionItems: Array<string>;
3623
1853
  }
3624
- /**
3625
- *
3626
- * @export
3627
- * @interface TotalExecutionResultHeader
3628
- */
3629
1854
  export interface TotalExecutionResultHeader {
3630
- /**
3631
- *
3632
- * @type {TotalResultHeader}
3633
- * @memberof TotalExecutionResultHeader
3634
- */
3635
1855
  totalHeader: TotalResultHeader;
3636
1856
  }
3637
1857
  /**
3638
1858
  * Header containing the information related to a subtotal.
3639
- * @export
3640
- * @interface TotalResultHeader
3641
1859
  */
3642
1860
  export interface TotalResultHeader {
3643
- /**
3644
- *
3645
- * @type {string}
3646
- * @memberof TotalResultHeader
3647
- */
3648
1861
  function: string;
3649
1862
  }
3650
1863
  /**
3651
1864
  * User context, which can affect the behavior of the underlying AI features.
3652
- * @export
3653
- * @interface UserContext
3654
1865
  */
3655
1866
  export interface UserContext {
3656
- /**
3657
- *
3658
- * @type {ActiveObjectIdentification}
3659
- * @memberof UserContext
3660
- */
3661
1867
  activeObject: ActiveObjectIdentification;
3662
1868
  }
3663
- /**
3664
- *
3665
- * @export
3666
- * @interface ValidateByItem
3667
- */
3668
1869
  export interface ValidateByItem {
3669
1870
  /**
3670
1871
  * Specifies entity used for valid elements computation.
3671
- * @type {string}
3672
- * @memberof ValidateByItem
3673
1872
  */
3674
1873
  id: string;
3675
1874
  /**
3676
1875
  * Specifies entity type which could be label, attribute, fact, or metric.
3677
- * @type {string}
3678
- * @memberof ValidateByItem
3679
1876
  */
3680
1877
  type: string;
3681
1878
  }
3682
- /**
3683
- *
3684
- * @export
3685
- * @interface ValidateLLMEndpointByIdRequest
3686
- */
3687
1879
  export interface ValidateLLMEndpointByIdRequest {
3688
1880
  /**
3689
1881
  * Provider for the LLM endpoint validation
3690
- * @type {string}
3691
- * @memberof ValidateLLMEndpointByIdRequest
3692
1882
  */
3693
1883
  provider?: string;
3694
1884
  /**
3695
1885
  * Base URL for the LLM endpoint validation
3696
- * @type {string}
3697
- * @memberof ValidateLLMEndpointByIdRequest
3698
1886
  */
3699
1887
  baseUrl?: string;
3700
1888
  /**
3701
1889
  * Token for the LLM endpoint validation
3702
- * @type {string}
3703
- * @memberof ValidateLLMEndpointByIdRequest
3704
1890
  */
3705
1891
  token?: string;
3706
1892
  /**
3707
1893
  * Organization name for the LLM endpoint validation
3708
- * @type {string}
3709
- * @memberof ValidateLLMEndpointByIdRequest
3710
1894
  */
3711
1895
  llmOrganization?: string;
3712
1896
  /**
3713
1897
  * LLM model for the LLM endpoint validation
3714
- * @type {string}
3715
- * @memberof ValidateLLMEndpointByIdRequest
3716
1898
  */
3717
1899
  llmModel?: string;
3718
1900
  }
3719
- /**
3720
- *
3721
- * @export
3722
- * @interface ValidateLLMEndpointRequest
3723
- */
3724
1901
  export interface ValidateLLMEndpointRequest {
3725
1902
  /**
3726
1903
  * Provider for the LLM endpoint validation
3727
- * @type {string}
3728
- * @memberof ValidateLLMEndpointRequest
3729
1904
  */
3730
1905
  provider: string;
3731
1906
  /**
3732
1907
  * Base URL for the LLM endpoint validation
3733
- * @type {string}
3734
- * @memberof ValidateLLMEndpointRequest
3735
1908
  */
3736
1909
  baseUrl?: string;
3737
1910
  /**
3738
1911
  * Token for the LLM endpoint validation
3739
- * @type {string}
3740
- * @memberof ValidateLLMEndpointRequest
3741
1912
  */
3742
1913
  token: string;
3743
1914
  /**
3744
1915
  * Organization name for the LLM endpoint validation
3745
- * @type {string}
3746
- * @memberof ValidateLLMEndpointRequest
3747
1916
  */
3748
1917
  llmOrganization?: string;
3749
1918
  /**
3750
1919
  * LLM model for the LLM endpoint validation
3751
- * @type {string}
3752
- * @memberof ValidateLLMEndpointRequest
3753
1920
  */
3754
1921
  llmModel?: string;
3755
1922
  }
3756
- /**
3757
- *
3758
- * @export
3759
- * @interface ValidateLLMEndpointResponse
3760
- */
3761
1923
  export interface ValidateLLMEndpointResponse {
3762
1924
  /**
3763
1925
  * Whether the LLM endpoint validation was successful
3764
- * @type {boolean}
3765
- * @memberof ValidateLLMEndpointResponse
3766
1926
  */
3767
1927
  successful: boolean;
3768
1928
  /**
3769
1929
  * Additional message about the LLM endpoint validation
3770
- * @type {string}
3771
- * @memberof ValidateLLMEndpointResponse
3772
1930
  */
3773
1931
  message: string;
3774
1932
  }
@@ -4168,7 +2326,7 @@ export declare const ActionsApiFp: (configuration?: Configuration) => {
4168
2326
  * @param {*} [options] Override http request option.
4169
2327
  * @throws {RequiredError}
4170
2328
  */
4171
- explainAFM(workspaceId: string, afmExecution: AfmExecution, explainType?: "MAQL" | "GRPC_MODEL" | "GRPC_MODEL_SVG" | "WDF" | "QT" | "QT_SVG" | "OPT_QT" | "OPT_QT_SVG" | "SQL" | "SETTINGS" | "COMPRESSED_SQL", options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
2329
+ explainAFM(workspaceId: string, afmExecution: AfmExecution, explainType?: "MAQL" | "GRPC_MODEL" | "GRPC_MODEL_SVG" | "WDF" | "QT" | "QT_SVG" | "OPT_QT" | "OPT_QT_SVG" | "SQL" | "SETTINGS" | "COMPRESSED_SQL", options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
4172
2330
  /**
4173
2331
  * (BETA) Computes forecasted data points from the provided execution result and parameters.
4174
2332
  * @summary (BETA) Smart functions - Forecast
@@ -4384,7 +2542,7 @@ export declare const ActionsApiFactory: (configuration?: Configuration, basePath
4384
2542
  * @param {*} [options] Override http request option.
4385
2543
  * @throws {RequiredError}
4386
2544
  */
4387
- explainAFM(requestParameters: ActionsApiExplainAFMRequest, options?: AxiosRequestConfig): AxiosPromise<any>;
2545
+ explainAFM(requestParameters: ActionsApiExplainAFMRequest, options?: AxiosRequestConfig): AxiosPromise<File>;
4388
2546
  /**
4389
2547
  * (BETA) Computes forecasted data points from the provided execution result and parameters.
4390
2548
  * @summary (BETA) Smart functions - Forecast
@@ -4598,7 +2756,7 @@ export interface ActionsApiInterface {
4598
2756
  * @throws {RequiredError}
4599
2757
  * @memberof ActionsApiInterface
4600
2758
  */
4601
- explainAFM(requestParameters: ActionsApiExplainAFMRequest, options?: AxiosRequestConfig): AxiosPromise<any>;
2759
+ explainAFM(requestParameters: ActionsApiExplainAFMRequest, options?: AxiosRequestConfig): AxiosPromise<File>;
4602
2760
  /**
4603
2761
  * (BETA) Computes forecasted data points from the provided execution result and parameters.
4604
2762
  * @summary (BETA) Smart functions - Forecast
@@ -5410,7 +3568,7 @@ export declare class ActionsApi extends BaseAPI implements ActionsApiInterface {
5410
3568
  * @throws {RequiredError}
5411
3569
  * @memberof ActionsApi
5412
3570
  */
5413
- explainAFM(requestParameters: ActionsApiExplainAFMRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<any, any>>;
3571
+ explainAFM(requestParameters: ActionsApiExplainAFMRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any>>;
5414
3572
  /**
5415
3573
  * (BETA) Computes forecasted data points from the provided execution result and parameters.
5416
3574
  * @summary (BETA) Smart functions - Forecast
@@ -5648,7 +3806,7 @@ export declare const ComputationApiFp: (configuration?: Configuration) => {
5648
3806
  * @param {*} [options] Override http request option.
5649
3807
  * @throws {RequiredError}
5650
3808
  */
5651
- explainAFM(workspaceId: string, afmExecution: AfmExecution, explainType?: "MAQL" | "GRPC_MODEL" | "GRPC_MODEL_SVG" | "WDF" | "QT" | "QT_SVG" | "OPT_QT" | "OPT_QT_SVG" | "SQL" | "SETTINGS" | "COMPRESSED_SQL", options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
3809
+ explainAFM(workspaceId: string, afmExecution: AfmExecution, explainType?: "MAQL" | "GRPC_MODEL" | "GRPC_MODEL_SVG" | "WDF" | "QT" | "QT_SVG" | "OPT_QT" | "OPT_QT_SVG" | "SQL" | "SETTINGS" | "COMPRESSED_SQL", options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
5652
3810
  /**
5653
3811
  * (EXPERIMENTAL) Computes key driver analysis for the provided execution definition.
5654
3812
  * @summary (EXPERIMENTAL) Compute key driver analysis
@@ -5737,7 +3895,7 @@ export declare const ComputationApiFactory: (configuration?: Configuration, base
5737
3895
  * @param {*} [options] Override http request option.
5738
3896
  * @throws {RequiredError}
5739
3897
  */
5740
- explainAFM(requestParameters: ComputationApiExplainAFMRequest, options?: AxiosRequestConfig): AxiosPromise<any>;
3898
+ explainAFM(requestParameters: ComputationApiExplainAFMRequest, options?: AxiosRequestConfig): AxiosPromise<File>;
5741
3899
  /**
5742
3900
  * (EXPERIMENTAL) Computes key driver analysis for the provided execution definition.
5743
3901
  * @summary (EXPERIMENTAL) Compute key driver analysis
@@ -5821,7 +3979,7 @@ export interface ComputationApiInterface {
5821
3979
  * @throws {RequiredError}
5822
3980
  * @memberof ComputationApiInterface
5823
3981
  */
5824
- explainAFM(requestParameters: ComputationApiExplainAFMRequest, options?: AxiosRequestConfig): AxiosPromise<any>;
3982
+ explainAFM(requestParameters: ComputationApiExplainAFMRequest, options?: AxiosRequestConfig): AxiosPromise<File>;
5825
3983
  /**
5826
3984
  * (EXPERIMENTAL) Computes key driver analysis for the provided execution definition.
5827
3985
  * @summary (EXPERIMENTAL) Compute key driver analysis
@@ -6159,7 +4317,7 @@ export declare class ComputationApi extends BaseAPI implements ComputationApiInt
6159
4317
  * @throws {RequiredError}
6160
4318
  * @memberof ComputationApi
6161
4319
  */
6162
- explainAFM(requestParameters: ComputationApiExplainAFMRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<any, any>>;
4320
+ explainAFM(requestParameters: ComputationApiExplainAFMRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any>>;
6163
4321
  /**
6164
4322
  * (EXPERIMENTAL) Computes key driver analysis for the provided execution definition.
6165
4323
  * @summary (EXPERIMENTAL) Compute key driver analysis