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