@gooddata/api-client-tiger 11.19.0-alpha.8 → 11.19.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/esm/__version.d.ts +1 -1
- package/esm/__version.d.ts.map +1 -1
- package/esm/__version.js +1 -1
- package/esm/__version.js.map +1 -1
- package/esm/api-client-tiger.d.ts +1313 -1309
- package/esm/endpoints/aac/index.d.ts.map +1 -1
- package/esm/endpoints/aac/index.js +2 -0
- package/esm/endpoints/aac/index.js.map +1 -1
- package/esm/endpoints/actions/index.js +1 -1
- package/esm/endpoints/authActions/index.js +1 -1
- package/esm/endpoints/automation/index.js +1 -1
- package/esm/endpoints/entitiesObjects/index.js +1 -1
- package/esm/endpoints/execution/index.js +1 -1
- package/esm/endpoints/explain/index.js +1 -1
- package/esm/endpoints/export/index.js +1 -1
- package/esm/endpoints/genAI/index.js +1 -1
- package/esm/endpoints/labelElements/index.js +1 -1
- package/esm/endpoints/layout/index.js +1 -1
- package/esm/endpoints/locationStyle/index.js +1 -1
- package/esm/endpoints/profile/index.js +1 -1
- package/esm/endpoints/scanModel/index.js +1 -1
- package/esm/endpoints/smartFunctions/index.js +1 -1
- package/esm/endpoints/userManagement/index.js +1 -1
- package/esm/endpoints/validDescendants/index.js +1 -1
- package/esm/endpoints/validObjects/index.js +1 -1
- package/esm/gd-tiger-model/index.js +4 -4
- package/esm/generated/afm-rest-api/api.d.ts +560 -556
- package/esm/generated/afm-rest-api/api.d.ts.map +1 -1
- package/esm/generated/afm-rest-api/api.js +540 -410
- package/esm/generated/afm-rest-api/api.js.map +1 -1
- package/esm/generated/afm-rest-api/base.d.ts +2 -2
- package/esm/generated/afm-rest-api/base.d.ts.map +1 -1
- package/esm/generated/afm-rest-api/base.js +3 -1
- package/esm/generated/afm-rest-api/base.js.map +1 -1
- package/esm/generated/afm-rest-api/common.d.ts +1 -1
- package/esm/generated/afm-rest-api/common.d.ts.map +1 -1
- package/esm/generated/afm-rest-api/common.js +24 -14
- package/esm/generated/afm-rest-api/common.js.map +1 -1
- package/esm/generated/afm-rest-api/configuration.d.ts.map +1 -1
- package/esm/generated/afm-rest-api/configuration.js +3 -2
- package/esm/generated/afm-rest-api/configuration.js.map +1 -1
- package/esm/generated/afm-rest-api/index.d.ts.map +1 -1
- package/esm/generated/afm-rest-api/index.js +1 -0
- package/esm/generated/afm-rest-api/index.js.map +1 -1
- package/esm/generated/auth-json-api/api.d.ts +54 -54
- package/esm/generated/auth-json-api/api.d.ts.map +1 -1
- package/esm/generated/auth-json-api/api.js +89 -56
- package/esm/generated/auth-json-api/api.js.map +1 -1
- package/esm/generated/auth-json-api/base.d.ts +2 -2
- package/esm/generated/auth-json-api/base.d.ts.map +1 -1
- package/esm/generated/auth-json-api/base.js +3 -1
- package/esm/generated/auth-json-api/base.js.map +1 -1
- package/esm/generated/auth-json-api/common.d.ts +1 -1
- package/esm/generated/auth-json-api/common.d.ts.map +1 -1
- package/esm/generated/auth-json-api/common.js +24 -14
- package/esm/generated/auth-json-api/common.js.map +1 -1
- package/esm/generated/auth-json-api/configuration.d.ts.map +1 -1
- package/esm/generated/auth-json-api/configuration.js +3 -2
- package/esm/generated/auth-json-api/configuration.js.map +1 -1
- package/esm/generated/auth-json-api/index.d.ts.map +1 -1
- package/esm/generated/auth-json-api/index.js +1 -0
- package/esm/generated/auth-json-api/index.js.map +1 -1
- package/esm/generated/automation-json-api/api.d.ts +430 -430
- package/esm/generated/automation-json-api/api.d.ts.map +1 -1
- package/esm/generated/automation-json-api/api.js +95 -66
- package/esm/generated/automation-json-api/api.js.map +1 -1
- package/esm/generated/automation-json-api/base.d.ts +2 -2
- package/esm/generated/automation-json-api/base.d.ts.map +1 -1
- package/esm/generated/automation-json-api/base.js +3 -1
- package/esm/generated/automation-json-api/base.js.map +1 -1
- package/esm/generated/automation-json-api/common.d.ts +1 -1
- package/esm/generated/automation-json-api/common.d.ts.map +1 -1
- package/esm/generated/automation-json-api/common.js +24 -14
- package/esm/generated/automation-json-api/common.js.map +1 -1
- package/esm/generated/automation-json-api/configuration.d.ts.map +1 -1
- package/esm/generated/automation-json-api/configuration.js +3 -2
- package/esm/generated/automation-json-api/configuration.js.map +1 -1
- package/esm/generated/automation-json-api/index.d.ts.map +1 -1
- package/esm/generated/automation-json-api/index.js +1 -0
- package/esm/generated/automation-json-api/index.js.map +1 -1
- package/esm/generated/export-json-api/api.d.ts +257 -257
- package/esm/generated/export-json-api/api.d.ts.map +1 -1
- package/esm/generated/export-json-api/api.js +183 -138
- package/esm/generated/export-json-api/api.js.map +1 -1
- package/esm/generated/export-json-api/base.d.ts +2 -2
- package/esm/generated/export-json-api/base.d.ts.map +1 -1
- package/esm/generated/export-json-api/base.js +3 -1
- package/esm/generated/export-json-api/base.js.map +1 -1
- package/esm/generated/export-json-api/common.d.ts +1 -1
- package/esm/generated/export-json-api/common.d.ts.map +1 -1
- package/esm/generated/export-json-api/common.js +24 -14
- package/esm/generated/export-json-api/common.js.map +1 -1
- package/esm/generated/export-json-api/configuration.d.ts.map +1 -1
- package/esm/generated/export-json-api/configuration.js +3 -2
- package/esm/generated/export-json-api/configuration.js.map +1 -1
- package/esm/generated/export-json-api/index.d.ts.map +1 -1
- package/esm/generated/export-json-api/index.js +1 -0
- package/esm/generated/export-json-api/index.js.map +1 -1
- package/esm/generated/scan-json-api/api.d.ts +92 -92
- package/esm/generated/scan-json-api/api.d.ts.map +1 -1
- package/esm/generated/scan-json-api/api.js +115 -74
- package/esm/generated/scan-json-api/api.js.map +1 -1
- package/esm/generated/scan-json-api/base.d.ts +2 -2
- package/esm/generated/scan-json-api/base.d.ts.map +1 -1
- package/esm/generated/scan-json-api/base.js +3 -1
- package/esm/generated/scan-json-api/base.js.map +1 -1
- package/esm/generated/scan-json-api/common.d.ts +1 -1
- package/esm/generated/scan-json-api/common.d.ts.map +1 -1
- package/esm/generated/scan-json-api/common.js +24 -14
- package/esm/generated/scan-json-api/common.js.map +1 -1
- package/esm/generated/scan-json-api/configuration.d.ts.map +1 -1
- package/esm/generated/scan-json-api/configuration.js +3 -2
- package/esm/generated/scan-json-api/configuration.js.map +1 -1
- package/esm/generated/scan-json-api/index.d.ts.map +1 -1
- package/esm/generated/scan-json-api/index.js +1 -0
- package/esm/generated/scan-json-api/index.js.map +1 -1
- package/esm/index.d.ts +1 -1
- package/esm/index.d.ts.map +1 -1
- package/esm/index.js +1 -1
- package/esm/index.js.map +1 -1
- package/package.json +14 -8
|
@@ -9,8 +9,8 @@
|
|
|
9
9
|
* https://openapi-generator.tech
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
|
-
import { Configuration } from
|
|
13
|
-
import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from
|
|
12
|
+
import { Configuration } from './configuration.js';
|
|
13
|
+
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.
|
|
@@ -19,36 +19,36 @@ export interface AFM {
|
|
|
19
19
|
/**
|
|
20
20
|
* Attributes to be used in the computation.
|
|
21
21
|
*/
|
|
22
|
-
attributes: Array<AttributeItem>;
|
|
22
|
+
'attributes': Array<AttributeItem>;
|
|
23
23
|
/**
|
|
24
24
|
* Various filter types to filter the execution result.
|
|
25
25
|
*/
|
|
26
|
-
filters: Array<FilterDefinition>;
|
|
26
|
+
'filters': Array<FilterDefinition>;
|
|
27
27
|
/**
|
|
28
28
|
* Metrics to be computed.
|
|
29
29
|
*/
|
|
30
|
-
measures: Array<MeasureItem>;
|
|
30
|
+
'measures': Array<MeasureItem>;
|
|
31
31
|
/**
|
|
32
32
|
* Metrics to be referenced from other AFM objects (e.g. filters) but not included in the result.
|
|
33
33
|
*/
|
|
34
|
-
auxMeasures?: Array<MeasureItem>;
|
|
34
|
+
'auxMeasures'?: Array<MeasureItem>;
|
|
35
35
|
}
|
|
36
36
|
/**
|
|
37
37
|
* A datetime filter specifying exact from and to values.
|
|
38
38
|
*/
|
|
39
39
|
export interface AbsoluteDateFilter {
|
|
40
|
-
absoluteDateFilter: AbsoluteDateFilterAbsoluteDateFilter;
|
|
40
|
+
'absoluteDateFilter': AbsoluteDateFilterAbsoluteDateFilter;
|
|
41
41
|
}
|
|
42
42
|
export interface AbsoluteDateFilterAbsoluteDateFilter {
|
|
43
|
-
from: string;
|
|
44
|
-
to: string;
|
|
45
|
-
localIdentifier?: string;
|
|
46
|
-
applyOnResult?: boolean;
|
|
43
|
+
'from': string;
|
|
44
|
+
'to': string;
|
|
45
|
+
'localIdentifier'?: string;
|
|
46
|
+
'applyOnResult'?: boolean;
|
|
47
47
|
/**
|
|
48
48
|
* If true, rows with undefined (NULL) date values will be included in the result. The filter becomes: (date_condition) OR (date IS NULL). If false or not set, standard behavior applies (NULLs excluded by the date condition).
|
|
49
49
|
*/
|
|
50
|
-
includeEmptyValues?: boolean;
|
|
51
|
-
dataset: AfmObjectIdentifierDataset;
|
|
50
|
+
'includeEmptyValues'?: boolean;
|
|
51
|
+
'dataset': AfmObjectIdentifierDataset;
|
|
52
52
|
}
|
|
53
53
|
/**
|
|
54
54
|
* @type AbstractMeasureValueFilter
|
|
@@ -61,15 +61,15 @@ export interface ActiveObjectIdentification {
|
|
|
61
61
|
/**
|
|
62
62
|
* Object ID.
|
|
63
63
|
*/
|
|
64
|
-
id: string;
|
|
64
|
+
'id': string;
|
|
65
65
|
/**
|
|
66
66
|
* Object type, e.g. dashboard.
|
|
67
67
|
*/
|
|
68
|
-
type: string;
|
|
68
|
+
'type': string;
|
|
69
69
|
/**
|
|
70
70
|
* Workspace ID.
|
|
71
71
|
*/
|
|
72
|
-
workspaceId: string;
|
|
72
|
+
'workspaceId': string;
|
|
73
73
|
}
|
|
74
74
|
/**
|
|
75
75
|
* Any information related to cancellation.
|
|
@@ -78,20 +78,20 @@ export interface AfmCancelTokens {
|
|
|
78
78
|
/**
|
|
79
79
|
* resultId to cancel token pairs
|
|
80
80
|
*/
|
|
81
|
-
resultIdToCancelTokenPairs: {
|
|
81
|
+
'resultIdToCancelTokenPairs': {
|
|
82
82
|
[key: string]: string;
|
|
83
83
|
};
|
|
84
84
|
}
|
|
85
85
|
export interface AfmExecution {
|
|
86
|
-
execution: AFM;
|
|
87
|
-
resultSpec: ResultSpec;
|
|
88
|
-
settings?: ExecutionSettings;
|
|
86
|
+
'execution': AFM;
|
|
87
|
+
'resultSpec': ResultSpec;
|
|
88
|
+
'settings'?: ExecutionSettings;
|
|
89
89
|
}
|
|
90
90
|
/**
|
|
91
91
|
* Response to AFM execution request
|
|
92
92
|
*/
|
|
93
93
|
export interface AfmExecutionResponse {
|
|
94
|
-
executionResponse: ExecutionResponse;
|
|
94
|
+
'executionResponse': ExecutionResponse;
|
|
95
95
|
}
|
|
96
96
|
/**
|
|
97
97
|
* @type AfmIdentifier
|
|
@@ -99,60 +99,60 @@ export interface AfmExecutionResponse {
|
|
|
99
99
|
*/
|
|
100
100
|
export type AfmIdentifier = AfmLocalIdentifier | AfmObjectIdentifier;
|
|
101
101
|
export interface AfmLocalIdentifier {
|
|
102
|
-
localIdentifier: string;
|
|
102
|
+
'localIdentifier': string;
|
|
103
103
|
}
|
|
104
104
|
/**
|
|
105
105
|
* ObjectIdentifier with `identifier` wrapper. This serves to distinguish MD object identifiers in AFM request from local identifiers.
|
|
106
106
|
*/
|
|
107
107
|
export interface AfmObjectIdentifier {
|
|
108
|
-
identifier: AfmObjectIdentifierIdentifier;
|
|
108
|
+
'identifier': AfmObjectIdentifierIdentifier;
|
|
109
109
|
}
|
|
110
110
|
/**
|
|
111
111
|
* Reference to the date attribute to use.
|
|
112
112
|
*/
|
|
113
113
|
export interface AfmObjectIdentifierAttribute {
|
|
114
|
-
identifier: AfmObjectIdentifierAttributeIdentifier;
|
|
114
|
+
'identifier': AfmObjectIdentifierAttributeIdentifier;
|
|
115
115
|
}
|
|
116
116
|
export interface AfmObjectIdentifierAttributeIdentifier {
|
|
117
|
-
id: string;
|
|
118
|
-
type: AfmObjectIdentifierAttributeIdentifierTypeEnum;
|
|
117
|
+
'id': string;
|
|
118
|
+
'type': AfmObjectIdentifierAttributeIdentifierTypeEnum;
|
|
119
119
|
}
|
|
120
|
-
export type AfmObjectIdentifierAttributeIdentifierTypeEnum =
|
|
120
|
+
export type AfmObjectIdentifierAttributeIdentifierTypeEnum = 'attribute';
|
|
121
121
|
/**
|
|
122
122
|
* Reference to the metric, fact or attribute object to use for the metric.
|
|
123
123
|
*/
|
|
124
124
|
export interface AfmObjectIdentifierCore {
|
|
125
|
-
identifier: AfmObjectIdentifierCoreIdentifier;
|
|
125
|
+
'identifier': AfmObjectIdentifierCoreIdentifier;
|
|
126
126
|
}
|
|
127
127
|
export interface AfmObjectIdentifierCoreIdentifier {
|
|
128
|
-
id: string;
|
|
129
|
-
type: AfmObjectIdentifierCoreIdentifierTypeEnum;
|
|
128
|
+
'id': string;
|
|
129
|
+
'type': AfmObjectIdentifierCoreIdentifierTypeEnum;
|
|
130
130
|
}
|
|
131
|
-
export type AfmObjectIdentifierCoreIdentifierTypeEnum =
|
|
131
|
+
export type AfmObjectIdentifierCoreIdentifierTypeEnum = 'attribute' | 'label' | 'fact' | 'metric';
|
|
132
132
|
/**
|
|
133
133
|
* Reference to the date dataset to which the filter should be applied.
|
|
134
134
|
*/
|
|
135
135
|
export interface AfmObjectIdentifierDataset {
|
|
136
|
-
identifier: AfmObjectIdentifierDatasetIdentifier;
|
|
136
|
+
'identifier': AfmObjectIdentifierDatasetIdentifier;
|
|
137
137
|
}
|
|
138
138
|
export interface AfmObjectIdentifierDatasetIdentifier {
|
|
139
|
-
id: string;
|
|
140
|
-
type: AfmObjectIdentifierDatasetIdentifierTypeEnum;
|
|
139
|
+
'id': string;
|
|
140
|
+
'type': AfmObjectIdentifierDatasetIdentifierTypeEnum;
|
|
141
141
|
}
|
|
142
|
-
export type AfmObjectIdentifierDatasetIdentifierTypeEnum =
|
|
142
|
+
export type AfmObjectIdentifierDatasetIdentifierTypeEnum = 'dataset';
|
|
143
143
|
export interface AfmObjectIdentifierIdentifier {
|
|
144
|
-
type: AfmObjectIdentifierIdentifierTypeEnum;
|
|
145
|
-
id: string;
|
|
144
|
+
'type': AfmObjectIdentifierIdentifierTypeEnum;
|
|
145
|
+
'id': string;
|
|
146
146
|
}
|
|
147
|
-
export type AfmObjectIdentifierIdentifierTypeEnum =
|
|
147
|
+
export type AfmObjectIdentifierIdentifierTypeEnum = 'analyticalDashboard' | 'attribute' | 'dashboardPlugin' | 'dataset' | 'fact' | 'label' | 'metric' | 'prompt' | 'visualizationObject' | 'filterContext';
|
|
148
148
|
export interface AfmObjectIdentifierLabel {
|
|
149
|
-
identifier: AfmObjectIdentifierLabelIdentifier;
|
|
149
|
+
'identifier': AfmObjectIdentifierLabelIdentifier;
|
|
150
150
|
}
|
|
151
151
|
export interface AfmObjectIdentifierLabelIdentifier {
|
|
152
|
-
type: AfmObjectIdentifierLabelIdentifierTypeEnum;
|
|
153
|
-
id: string;
|
|
152
|
+
'type': AfmObjectIdentifierLabelIdentifierTypeEnum;
|
|
153
|
+
'id': string;
|
|
154
154
|
}
|
|
155
|
-
export type AfmObjectIdentifierLabelIdentifierTypeEnum =
|
|
155
|
+
export type AfmObjectIdentifierLabelIdentifierTypeEnum = 'label';
|
|
156
156
|
/**
|
|
157
157
|
* Entity describing the valid descendants request.
|
|
158
158
|
*/
|
|
@@ -160,7 +160,7 @@ export interface AfmValidDescendantsQuery {
|
|
|
160
160
|
/**
|
|
161
161
|
* List of identifiers of the attributes to get the valid descendants for.
|
|
162
162
|
*/
|
|
163
|
-
attributes: Array<AfmObjectIdentifierAttribute>;
|
|
163
|
+
'attributes': Array<AfmObjectIdentifierAttribute>;
|
|
164
164
|
}
|
|
165
165
|
/**
|
|
166
166
|
* Entity describing the valid descendants response.
|
|
@@ -169,7 +169,7 @@ export interface AfmValidDescendantsResponse {
|
|
|
169
169
|
/**
|
|
170
170
|
* Map of attribute identifiers to list of valid descendants identifiers.
|
|
171
171
|
*/
|
|
172
|
-
validDescendants: {
|
|
172
|
+
'validDescendants': {
|
|
173
173
|
[key: string]: Array<AfmObjectIdentifierAttribute>;
|
|
174
174
|
};
|
|
175
175
|
}
|
|
@@ -177,15 +177,15 @@ export interface AfmValidDescendantsResponse {
|
|
|
177
177
|
* Entity holding AFM and list of object types whose validity should be computed.
|
|
178
178
|
*/
|
|
179
179
|
export interface AfmValidObjectsQuery {
|
|
180
|
-
types: Array<AfmValidObjectsQueryTypesEnum>;
|
|
181
|
-
afm: AFM;
|
|
180
|
+
'types': Array<AfmValidObjectsQueryTypesEnum>;
|
|
181
|
+
'afm': AFM;
|
|
182
182
|
}
|
|
183
|
-
export type AfmValidObjectsQueryTypesEnum =
|
|
183
|
+
export type AfmValidObjectsQueryTypesEnum = 'facts' | 'attributes' | 'measures';
|
|
184
184
|
/**
|
|
185
185
|
* All objects of specified types valid with respect to given AFM.
|
|
186
186
|
*/
|
|
187
187
|
export interface AfmValidObjectsResponse {
|
|
188
|
-
items: Array<RestApiIdentifier>;
|
|
188
|
+
'items': Array<RestApiIdentifier>;
|
|
189
189
|
}
|
|
190
190
|
/**
|
|
191
191
|
* Allowed relationship type combination.
|
|
@@ -194,30 +194,30 @@ export interface AllowedRelationshipType {
|
|
|
194
194
|
/**
|
|
195
195
|
* Source object type (e.g., \'dashboard\', \'visualization\', \'metric\').
|
|
196
196
|
*/
|
|
197
|
-
sourceType: AllowedRelationshipTypeSourceTypeEnum;
|
|
197
|
+
'sourceType': AllowedRelationshipTypeSourceTypeEnum;
|
|
198
198
|
/**
|
|
199
199
|
* Target object type (e.g., \'visualization\', \'metric\', \'attribute\').
|
|
200
200
|
*/
|
|
201
|
-
targetType: AllowedRelationshipTypeTargetTypeEnum;
|
|
201
|
+
'targetType': AllowedRelationshipTypeTargetTypeEnum;
|
|
202
202
|
/**
|
|
203
203
|
* If true, allows target objects that are not part of any relationship (orphans) to be included in results. If false, orphan target objects will be excluded even if they directly match the search query. Default is true (orphans are allowed).
|
|
204
204
|
*/
|
|
205
|
-
allowOrphans?: boolean;
|
|
205
|
+
'allowOrphans'?: boolean;
|
|
206
206
|
}
|
|
207
|
-
export type AllowedRelationshipTypeSourceTypeEnum =
|
|
208
|
-
export type AllowedRelationshipTypeTargetTypeEnum =
|
|
207
|
+
export type AllowedRelationshipTypeSourceTypeEnum = 'attribute' | 'metric' | 'fact' | 'label' | 'date' | 'dataset' | 'visualization' | 'dashboard';
|
|
208
|
+
export type AllowedRelationshipTypeTargetTypeEnum = 'attribute' | 'metric' | 'fact' | 'label' | 'date' | 'dataset' | 'visualization' | 'dashboard';
|
|
209
209
|
export interface AnalyticsCatalogCreatedBy {
|
|
210
210
|
/**
|
|
211
211
|
* Users who created any object in the catalog
|
|
212
212
|
*/
|
|
213
|
-
users: Array<AnalyticsCatalogUser>;
|
|
213
|
+
'users': Array<AnalyticsCatalogUser>;
|
|
214
214
|
/**
|
|
215
215
|
* Reasoning for error states
|
|
216
216
|
*/
|
|
217
|
-
reasoning: string;
|
|
217
|
+
'reasoning': string;
|
|
218
218
|
}
|
|
219
219
|
export interface AnalyticsCatalogTags {
|
|
220
|
-
tags: Array<string>;
|
|
220
|
+
'tags': Array<string>;
|
|
221
221
|
}
|
|
222
222
|
/**
|
|
223
223
|
* Users who created any object in the catalog
|
|
@@ -226,46 +226,46 @@ export interface AnalyticsCatalogUser {
|
|
|
226
226
|
/**
|
|
227
227
|
* User ID of the user who created any objects
|
|
228
228
|
*/
|
|
229
|
-
userId: string;
|
|
229
|
+
'userId': string;
|
|
230
230
|
/**
|
|
231
231
|
* First name of the user who created any objects
|
|
232
232
|
*/
|
|
233
|
-
firstname: string;
|
|
233
|
+
'firstname': string;
|
|
234
234
|
/**
|
|
235
235
|
* Last name of the user who created any objects
|
|
236
236
|
*/
|
|
237
|
-
lastname: string;
|
|
237
|
+
'lastname': string;
|
|
238
238
|
}
|
|
239
239
|
export interface AnomalyDetectionRequest {
|
|
240
240
|
/**
|
|
241
241
|
* Anomaly detection sensitivity.
|
|
242
242
|
*/
|
|
243
|
-
sensitivity: number;
|
|
243
|
+
'sensitivity': number;
|
|
244
244
|
}
|
|
245
245
|
export interface AnomalyDetectionResult {
|
|
246
|
-
attribute: Array<string>;
|
|
247
|
-
values: Array<number | null>;
|
|
248
|
-
anomalyFlag: Array<boolean | null>;
|
|
246
|
+
'attribute': Array<string>;
|
|
247
|
+
'values': Array<number | null>;
|
|
248
|
+
'anomalyFlag': Array<boolean | null>;
|
|
249
249
|
}
|
|
250
250
|
/**
|
|
251
251
|
* Metric representing arithmetics between other metrics.
|
|
252
252
|
*/
|
|
253
253
|
export interface ArithmeticMeasureDefinition {
|
|
254
|
-
arithmeticMeasure: ArithmeticMeasureDefinitionArithmeticMeasure;
|
|
254
|
+
'arithmeticMeasure': ArithmeticMeasureDefinitionArithmeticMeasure;
|
|
255
255
|
}
|
|
256
256
|
export interface ArithmeticMeasureDefinitionArithmeticMeasure {
|
|
257
257
|
/**
|
|
258
258
|
* List of metrics to apply arithmetic operation by chosen operator.
|
|
259
259
|
*/
|
|
260
|
-
measureIdentifiers: Array<AfmLocalIdentifier>;
|
|
260
|
+
'measureIdentifiers': Array<AfmLocalIdentifier>;
|
|
261
261
|
/**
|
|
262
262
|
* Arithmetic operator describing operation between metrics.
|
|
263
263
|
*/
|
|
264
|
-
operator: ArithmeticMeasureDefinitionArithmeticMeasureOperatorEnum;
|
|
264
|
+
'operator': ArithmeticMeasureDefinitionArithmeticMeasureOperatorEnum;
|
|
265
265
|
}
|
|
266
|
-
export type ArithmeticMeasureDefinitionArithmeticMeasureOperatorEnum =
|
|
266
|
+
export type ArithmeticMeasureDefinitionArithmeticMeasureOperatorEnum = 'SUM' | 'DIFFERENCE' | 'MULTIPLICATION' | 'RATIO' | 'CHANGE';
|
|
267
267
|
export interface AttributeExecutionResultHeader {
|
|
268
|
-
attributeHeader: AttributeResultHeader;
|
|
268
|
+
'attributeHeader': AttributeResultHeader;
|
|
269
269
|
}
|
|
270
270
|
/**
|
|
271
271
|
* @type AttributeFilter
|
|
@@ -279,7 +279,7 @@ export interface AttributeFilterElements {
|
|
|
279
279
|
/**
|
|
280
280
|
* Set of label values.
|
|
281
281
|
*/
|
|
282
|
-
values: Array<string | null>;
|
|
282
|
+
'values': Array<string | null>;
|
|
283
283
|
}
|
|
284
284
|
/**
|
|
285
285
|
* Attribute format describes formatting information to effectively format attribute values when needed.
|
|
@@ -288,66 +288,66 @@ export interface AttributeFormat {
|
|
|
288
288
|
/**
|
|
289
289
|
* Format locale code like \'en-US\', \'cs-CZ\', etc.
|
|
290
290
|
*/
|
|
291
|
-
locale: string;
|
|
291
|
+
'locale': string;
|
|
292
292
|
/**
|
|
293
293
|
* ICU formatting pattern like \'y\', \'dd.MM.y\', etc.
|
|
294
294
|
*/
|
|
295
|
-
pattern: string;
|
|
295
|
+
'pattern': string;
|
|
296
296
|
/**
|
|
297
297
|
* Timezone for date formatting like \'America/New_York\', \'Europe/Prague\', etc.
|
|
298
298
|
*/
|
|
299
|
-
timezone?: string;
|
|
299
|
+
'timezone'?: string;
|
|
300
300
|
}
|
|
301
301
|
export interface AttributeHeader {
|
|
302
|
-
attributeHeader: AttributeHeaderAttributeHeader;
|
|
302
|
+
'attributeHeader': AttributeHeaderAttributeHeader;
|
|
303
303
|
}
|
|
304
304
|
export interface AttributeHeaderAttributeHeader {
|
|
305
305
|
/**
|
|
306
306
|
* Local identifier of the attribute this header relates to.
|
|
307
307
|
*/
|
|
308
|
-
localIdentifier: string;
|
|
309
|
-
label: RestApiIdentifier;
|
|
308
|
+
'localIdentifier': string;
|
|
309
|
+
'label': RestApiIdentifier;
|
|
310
310
|
/**
|
|
311
311
|
* Label name.
|
|
312
312
|
*/
|
|
313
|
-
labelName: string;
|
|
314
|
-
attribute: RestApiIdentifier;
|
|
313
|
+
'labelName': string;
|
|
314
|
+
'attribute': RestApiIdentifier;
|
|
315
315
|
/**
|
|
316
316
|
* Attribute name.
|
|
317
317
|
*/
|
|
318
|
-
attributeName: string;
|
|
318
|
+
'attributeName': string;
|
|
319
319
|
/**
|
|
320
320
|
* Date granularity of the attribute, only filled for date attributes.
|
|
321
321
|
*/
|
|
322
|
-
granularity?: AttributeHeaderAttributeHeaderGranularityEnum;
|
|
323
|
-
primaryLabel: RestApiIdentifier;
|
|
324
|
-
format?: AttributeFormat;
|
|
322
|
+
'granularity'?: AttributeHeaderAttributeHeaderGranularityEnum;
|
|
323
|
+
'primaryLabel': RestApiIdentifier;
|
|
324
|
+
'format'?: AttributeFormat;
|
|
325
325
|
/**
|
|
326
326
|
* Attribute value type.
|
|
327
327
|
*/
|
|
328
|
-
valueType?: AttributeHeaderAttributeHeaderValueTypeEnum;
|
|
329
|
-
geoAreaConfig?: GeoAreaConfig;
|
|
328
|
+
'valueType'?: AttributeHeaderAttributeHeaderValueTypeEnum;
|
|
329
|
+
'geoAreaConfig'?: GeoAreaConfig;
|
|
330
330
|
}
|
|
331
|
-
export type AttributeHeaderAttributeHeaderGranularityEnum =
|
|
332
|
-
export type AttributeHeaderAttributeHeaderValueTypeEnum =
|
|
331
|
+
export type AttributeHeaderAttributeHeaderGranularityEnum = 'MINUTE' | 'HOUR' | 'DAY' | 'WEEK' | 'MONTH' | 'QUARTER' | 'YEAR' | 'MINUTE_OF_HOUR' | 'HOUR_OF_DAY' | 'DAY_OF_WEEK' | 'DAY_OF_MONTH' | 'DAY_OF_QUARTER' | 'DAY_OF_YEAR' | 'WEEK_OF_YEAR' | 'MONTH_OF_YEAR' | 'QUARTER_OF_YEAR' | 'FISCAL_MONTH' | 'FISCAL_QUARTER' | 'FISCAL_YEAR';
|
|
332
|
+
export type AttributeHeaderAttributeHeaderValueTypeEnum = 'TEXT' | 'HYPERLINK' | 'GEO' | 'GEO_LONGITUDE' | 'GEO_LATITUDE' | 'GEO_AREA' | 'IMAGE';
|
|
333
333
|
export interface AttributeItem {
|
|
334
334
|
/**
|
|
335
335
|
* Local identifier of the attribute. This can be used to reference the attribute in other parts of the execution definition.
|
|
336
336
|
*/
|
|
337
|
-
localIdentifier: string;
|
|
338
|
-
label: AfmObjectIdentifierLabel;
|
|
337
|
+
'localIdentifier': string;
|
|
338
|
+
'label': AfmObjectIdentifierLabel;
|
|
339
339
|
/**
|
|
340
340
|
* Indicates whether to show all values of given attribute even if the data bound to those values is not available.
|
|
341
341
|
*/
|
|
342
|
-
showAllValues?: boolean;
|
|
342
|
+
'showAllValues'?: boolean;
|
|
343
343
|
}
|
|
344
344
|
export interface AttributeNegativeFilter {
|
|
345
|
-
using: string;
|
|
346
|
-
exclude: Array<string>;
|
|
345
|
+
'using': string;
|
|
346
|
+
'exclude': Array<string>;
|
|
347
347
|
}
|
|
348
348
|
export interface AttributePositiveFilter {
|
|
349
|
-
using: string;
|
|
350
|
-
include: Array<string>;
|
|
349
|
+
'using': string;
|
|
350
|
+
'include': Array<string>;
|
|
351
351
|
}
|
|
352
352
|
/**
|
|
353
353
|
* Header containing the information related to attributes.
|
|
@@ -356,11 +356,11 @@ export interface AttributeResultHeader {
|
|
|
356
356
|
/**
|
|
357
357
|
* A value of the current attribute label.
|
|
358
358
|
*/
|
|
359
|
-
labelValue: string;
|
|
359
|
+
'labelValue': string;
|
|
360
360
|
/**
|
|
361
361
|
* A value of the primary attribute label.
|
|
362
362
|
*/
|
|
363
|
-
primaryLabelValue: string;
|
|
363
|
+
'primaryLabelValue': string;
|
|
364
364
|
}
|
|
365
365
|
/**
|
|
366
366
|
* 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.
|
|
@@ -369,92 +369,92 @@ export interface BoundedFilter {
|
|
|
369
369
|
/**
|
|
370
370
|
* Date granularity specifying particular date attribute in given dimension.
|
|
371
371
|
*/
|
|
372
|
-
granularity: BoundedFilterGranularityEnum;
|
|
372
|
+
'granularity': BoundedFilterGranularityEnum;
|
|
373
373
|
/**
|
|
374
374
|
* 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.
|
|
375
375
|
*/
|
|
376
|
-
from?: number | null;
|
|
376
|
+
'from'?: number | null;
|
|
377
377
|
/**
|
|
378
378
|
* 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.
|
|
379
379
|
*/
|
|
380
|
-
to?: number | null;
|
|
380
|
+
'to'?: number | null;
|
|
381
381
|
}
|
|
382
|
-
export type BoundedFilterGranularityEnum =
|
|
382
|
+
export type BoundedFilterGranularityEnum = 'MINUTE' | 'HOUR' | 'DAY' | 'WEEK' | 'MONTH' | 'QUARTER' | 'YEAR' | 'MINUTE_OF_HOUR' | 'HOUR_OF_DAY' | 'DAY_OF_WEEK' | 'DAY_OF_MONTH' | 'DAY_OF_QUARTER' | 'DAY_OF_YEAR' | 'WEEK_OF_YEAR' | 'MONTH_OF_YEAR' | 'QUARTER_OF_YEAR' | 'FISCAL_MONTH' | 'FISCAL_QUARTER' | 'FISCAL_YEAR';
|
|
383
383
|
/**
|
|
384
384
|
* Change analysis specification.
|
|
385
385
|
*/
|
|
386
386
|
export interface ChangeAnalysisParams {
|
|
387
|
-
measure: MeasureItem;
|
|
387
|
+
'measure': MeasureItem;
|
|
388
388
|
/**
|
|
389
389
|
* The title of the measure being analyzed
|
|
390
390
|
*/
|
|
391
|
-
measureTitle: string;
|
|
392
|
-
dateAttribute: AttributeItem;
|
|
391
|
+
'measureTitle': string;
|
|
392
|
+
'dateAttribute': AttributeItem;
|
|
393
393
|
/**
|
|
394
394
|
* The reference time period
|
|
395
395
|
*/
|
|
396
|
-
referencePeriod: string;
|
|
396
|
+
'referencePeriod': string;
|
|
397
397
|
/**
|
|
398
398
|
* The analyzed time period
|
|
399
399
|
*/
|
|
400
|
-
analyzedPeriod: string;
|
|
400
|
+
'analyzedPeriod': string;
|
|
401
401
|
/**
|
|
402
402
|
* Attributes to analyze for significant changes
|
|
403
403
|
*/
|
|
404
|
-
attributes: Array<AttributeItem>;
|
|
404
|
+
'attributes': Array<AttributeItem>;
|
|
405
405
|
/**
|
|
406
406
|
* Optional filters to apply
|
|
407
407
|
*/
|
|
408
|
-
filters: Array<OutlierDetectionRequestFiltersInner>;
|
|
408
|
+
'filters': Array<OutlierDetectionRequestFiltersInner>;
|
|
409
409
|
/**
|
|
410
410
|
* Whether to use smart attribute selection
|
|
411
411
|
*/
|
|
412
|
-
useSmartAttributeSelection: boolean;
|
|
412
|
+
'useSmartAttributeSelection': boolean;
|
|
413
413
|
}
|
|
414
414
|
/**
|
|
415
415
|
* Request for change analysis computation
|
|
416
416
|
*/
|
|
417
417
|
export interface ChangeAnalysisRequest {
|
|
418
|
-
measure: MeasureItem;
|
|
419
|
-
dateAttribute: AttributeItem;
|
|
418
|
+
'measure': MeasureItem;
|
|
419
|
+
'dateAttribute': AttributeItem;
|
|
420
420
|
/**
|
|
421
421
|
* The reference time period (e.g., \'2025-01\')
|
|
422
422
|
*/
|
|
423
|
-
referencePeriod: string;
|
|
423
|
+
'referencePeriod': string;
|
|
424
424
|
/**
|
|
425
425
|
* The analyzed time period (e.g., \'2025-02\')
|
|
426
426
|
*/
|
|
427
|
-
analyzedPeriod: string;
|
|
427
|
+
'analyzedPeriod': string;
|
|
428
428
|
/**
|
|
429
429
|
* Attributes to analyze for significant changes. If empty, valid attributes will be automatically discovered.
|
|
430
430
|
*/
|
|
431
|
-
attributes?: Array<AttributeItem>;
|
|
431
|
+
'attributes'?: Array<AttributeItem>;
|
|
432
432
|
/**
|
|
433
433
|
* Optional filters to apply.
|
|
434
434
|
*/
|
|
435
|
-
filters?: Array<OutlierDetectionRequestFiltersInner>;
|
|
435
|
+
'filters'?: Array<OutlierDetectionRequestFiltersInner>;
|
|
436
436
|
/**
|
|
437
437
|
* Auxiliary measures
|
|
438
438
|
*/
|
|
439
|
-
auxMeasures?: Array<MeasureItem>;
|
|
439
|
+
'auxMeasures'?: Array<MeasureItem>;
|
|
440
440
|
/**
|
|
441
441
|
* Whether to use smart attribute selection (LLM-based) instead of discovering all valid attributes. If true, GenAI will intelligently select the most relevant attributes for change analysis. If false or not set, all valid attributes will be discovered using Calcique. Smart attribute selection applies only when no attributes are provided.
|
|
442
442
|
*/
|
|
443
|
-
useSmartAttributeSelection?: boolean;
|
|
443
|
+
'useSmartAttributeSelection'?: boolean;
|
|
444
444
|
/**
|
|
445
445
|
* Only include attributes with at least one of these tags. If empty, no inclusion filter is applied. This filter applies to both auto-discovered and explicitly provided attributes.
|
|
446
446
|
*/
|
|
447
|
-
includeTags?: Array<string>;
|
|
447
|
+
'includeTags'?: Array<string>;
|
|
448
448
|
/**
|
|
449
449
|
* Exclude attributes with any of these tags. This filter applies to both auto-discovered and explicitly provided attributes.
|
|
450
450
|
*/
|
|
451
|
-
excludeTags?: Array<string>;
|
|
451
|
+
'excludeTags'?: Array<string>;
|
|
452
452
|
}
|
|
453
453
|
/**
|
|
454
454
|
* Response for change analysis computation
|
|
455
455
|
*/
|
|
456
456
|
export interface ChangeAnalysisResponse {
|
|
457
|
-
links: ExecutionLinks;
|
|
457
|
+
'links': ExecutionLinks;
|
|
458
458
|
}
|
|
459
459
|
/**
|
|
460
460
|
* Result of a change analysis execution.
|
|
@@ -463,7 +463,7 @@ export interface ChangeAnalysisResult {
|
|
|
463
463
|
/**
|
|
464
464
|
* The change analysis result data containing significant changes.
|
|
465
465
|
*/
|
|
466
|
-
data: Array<MetricValueChange>;
|
|
466
|
+
'data': Array<MetricValueChange>;
|
|
467
467
|
}
|
|
468
468
|
/**
|
|
469
469
|
* List of chat history interactions.
|
|
@@ -472,233 +472,237 @@ export interface ChatHistoryInteraction {
|
|
|
472
472
|
/**
|
|
473
473
|
* User question
|
|
474
474
|
*/
|
|
475
|
-
question: string;
|
|
475
|
+
'question': string;
|
|
476
476
|
/**
|
|
477
477
|
* Chat History thread suffix appended to ID generated by backend. Enables more chat windows.
|
|
478
478
|
*/
|
|
479
|
-
threadIdSuffix?: string;
|
|
479
|
+
'threadIdSuffix'?: string;
|
|
480
480
|
/**
|
|
481
481
|
* Chat History interaction ID. Unique ID for each interaction.
|
|
482
482
|
*/
|
|
483
|
-
chatHistoryInteractionId: string;
|
|
483
|
+
'chatHistoryInteractionId': string;
|
|
484
484
|
/**
|
|
485
485
|
* Has the interaction already finished? Can be used for polling when interaction is in progress.
|
|
486
486
|
*/
|
|
487
|
-
interactionFinished: boolean;
|
|
488
|
-
routing: RouteResult;
|
|
487
|
+
'interactionFinished': boolean;
|
|
488
|
+
'routing': RouteResult;
|
|
489
489
|
/**
|
|
490
490
|
* Text response for general questions.
|
|
491
491
|
*/
|
|
492
|
-
textResponse?: string;
|
|
492
|
+
'textResponse'?: string;
|
|
493
493
|
/**
|
|
494
494
|
* Error response in anything fails.
|
|
495
495
|
*/
|
|
496
|
-
errorResponse?: string;
|
|
497
|
-
foundObjects?: FoundObjects;
|
|
498
|
-
semanticSearch?: SearchResult;
|
|
499
|
-
createdVisualizations?: CreatedVisualizations;
|
|
500
|
-
changeAnalysisParams?: ChangeAnalysisParams;
|
|
496
|
+
'errorResponse'?: string;
|
|
497
|
+
'foundObjects'?: FoundObjects;
|
|
498
|
+
'semanticSearch'?: SearchResult;
|
|
499
|
+
'createdVisualizations'?: CreatedVisualizations;
|
|
500
|
+
'changeAnalysisParams'?: ChangeAnalysisParams;
|
|
501
501
|
/**
|
|
502
502
|
* User feedback.
|
|
503
503
|
*/
|
|
504
|
-
userFeedback?: ChatHistoryInteractionUserFeedbackEnum;
|
|
505
|
-
reasoning?: Reasoning;
|
|
504
|
+
'userFeedback'?: ChatHistoryInteractionUserFeedbackEnum;
|
|
505
|
+
'reasoning'?: Reasoning;
|
|
506
506
|
}
|
|
507
|
-
export type ChatHistoryInteractionUserFeedbackEnum =
|
|
507
|
+
export type ChatHistoryInteractionUserFeedbackEnum = 'POSITIVE' | 'NEGATIVE' | 'NONE';
|
|
508
508
|
export interface ChatHistoryRequest {
|
|
509
509
|
/**
|
|
510
510
|
* Chat History thread suffix appended to ID generated by backend. Enables more chat windows.
|
|
511
511
|
*/
|
|
512
|
-
threadIdSuffix?: string;
|
|
512
|
+
'threadIdSuffix'?: string;
|
|
513
513
|
/**
|
|
514
514
|
* Return chat history records only after this interaction ID. If empty, complete chat history is returned.
|
|
515
515
|
*/
|
|
516
|
-
chatHistoryInteractionId?: string;
|
|
516
|
+
'chatHistoryInteractionId'?: string;
|
|
517
517
|
/**
|
|
518
518
|
* User feedback.
|
|
519
519
|
*/
|
|
520
|
-
userFeedback?: ChatHistoryRequestUserFeedbackEnum;
|
|
520
|
+
'userFeedback'?: ChatHistoryRequestUserFeedbackEnum;
|
|
521
521
|
/**
|
|
522
522
|
* User feedback.
|
|
523
523
|
*/
|
|
524
|
-
reset?: boolean;
|
|
525
|
-
savedVisualization?: SavedVisualization;
|
|
524
|
+
'reset'?: boolean;
|
|
525
|
+
'savedVisualization'?: SavedVisualization;
|
|
526
526
|
/**
|
|
527
527
|
* Response state indicating the outcome of the AI interaction.
|
|
528
528
|
*/
|
|
529
|
-
responseState?: ChatHistoryRequestResponseStateEnum;
|
|
529
|
+
'responseState'?: ChatHistoryRequestResponseStateEnum;
|
|
530
530
|
/**
|
|
531
531
|
* User text feedback for the interaction.
|
|
532
532
|
*/
|
|
533
|
-
userTextFeedback?: string;
|
|
533
|
+
'userTextFeedback'?: string;
|
|
534
534
|
}
|
|
535
|
-
export type ChatHistoryRequestUserFeedbackEnum =
|
|
536
|
-
export type ChatHistoryRequestResponseStateEnum =
|
|
535
|
+
export type ChatHistoryRequestUserFeedbackEnum = 'POSITIVE' | 'NEGATIVE' | 'NONE';
|
|
536
|
+
export type ChatHistoryRequestResponseStateEnum = 'SUCCESSFUL' | 'UNEXPECTED_ERROR' | 'NOT_FOUND_ATTRIBUTES' | 'TOO_MANY_DATA_POINTS' | 'NO_DATA' | 'NO_RESULTS' | 'OUT_OF_TOPIC';
|
|
537
537
|
export interface ChatHistoryResult {
|
|
538
538
|
/**
|
|
539
539
|
* List of chat history interactions.
|
|
540
540
|
*/
|
|
541
|
-
interactions: Array<ChatHistoryInteraction>;
|
|
541
|
+
'interactions': Array<ChatHistoryInteraction>;
|
|
542
542
|
/**
|
|
543
543
|
* The conversation thread ID.
|
|
544
544
|
*/
|
|
545
|
-
threadId: string;
|
|
545
|
+
'threadId': string;
|
|
546
546
|
}
|
|
547
547
|
export interface ChatRequest {
|
|
548
548
|
/**
|
|
549
549
|
* User question
|
|
550
550
|
*/
|
|
551
|
-
question: string;
|
|
551
|
+
'question': string;
|
|
552
552
|
/**
|
|
553
553
|
* Maximum number of search results.
|
|
554
554
|
*/
|
|
555
|
-
limitSearch?: number;
|
|
555
|
+
'limitSearch'?: number;
|
|
556
556
|
/**
|
|
557
557
|
* Maximum number of relevant objects included into context for LLM (for each object type).
|
|
558
558
|
*/
|
|
559
|
-
limitCreateContext?: number;
|
|
559
|
+
'limitCreateContext'?: number;
|
|
560
560
|
/**
|
|
561
561
|
* Maximum number of created results.
|
|
562
562
|
*/
|
|
563
|
-
limitCreate?: number;
|
|
563
|
+
'limitCreate'?: number;
|
|
564
564
|
/**
|
|
565
565
|
* Chat History thread suffix appended to ID generated by backend. Enables more chat windows.
|
|
566
566
|
*/
|
|
567
|
-
threadIdSuffix?: string;
|
|
568
|
-
userContext?: UserContext;
|
|
567
|
+
'threadIdSuffix'?: string;
|
|
568
|
+
'userContext'?: UserContext;
|
|
569
569
|
/**
|
|
570
570
|
* Temporary for experiments. Ratio of title score to descriptor score.
|
|
571
571
|
*/
|
|
572
|
-
titleToDescriptorRatio?: number;
|
|
572
|
+
'titleToDescriptorRatio'?: number;
|
|
573
573
|
/**
|
|
574
574
|
* Score, above which we return found object(s) and don\'t call LLM to create new objects.
|
|
575
575
|
*/
|
|
576
|
-
searchScoreThreshold?: number;
|
|
576
|
+
'searchScoreThreshold'?: number;
|
|
577
577
|
/**
|
|
578
578
|
* Score, above which we return found objects. Below this score objects are not relevant.
|
|
579
579
|
*/
|
|
580
|
-
relevantScoreThreshold?: number;
|
|
580
|
+
'relevantScoreThreshold'?: number;
|
|
581
581
|
/**
|
|
582
582
|
* If true, includes hidden objects in search and visualization building. If false (default), excludes objects where isHidden=true.
|
|
583
583
|
*/
|
|
584
|
-
includeHidden?: boolean;
|
|
584
|
+
'includeHidden'?: boolean;
|
|
585
585
|
/**
|
|
586
586
|
* List of object types to filter the search and visualization building. If empty or null, all object types are considered.
|
|
587
587
|
*/
|
|
588
|
-
objectTypes?: Array<ChatRequestObjectTypesEnum>;
|
|
588
|
+
'objectTypes'?: Array<ChatRequestObjectTypesEnum>;
|
|
589
|
+
/**
|
|
590
|
+
* Filter relationships and search results based on allowed relationship type combinations. When specified, only relationships matching the allowed types are returned (e.g. for view-only users).
|
|
591
|
+
*/
|
|
592
|
+
'allowedRelationshipTypes'?: Array<AllowedRelationshipType>;
|
|
589
593
|
}
|
|
590
|
-
export type ChatRequestObjectTypesEnum =
|
|
594
|
+
export type ChatRequestObjectTypesEnum = 'attribute' | 'metric' | 'fact' | 'label' | 'date' | 'dataset' | 'visualization' | 'dashboard';
|
|
591
595
|
export interface ChatResult {
|
|
592
|
-
routing?: RouteResult;
|
|
596
|
+
'routing'?: RouteResult;
|
|
593
597
|
/**
|
|
594
598
|
* Text response for general questions.
|
|
595
599
|
*/
|
|
596
|
-
textResponse?: string;
|
|
600
|
+
'textResponse'?: string;
|
|
597
601
|
/**
|
|
598
602
|
* Error response in anything fails.
|
|
599
603
|
*/
|
|
600
|
-
errorResponse?: string;
|
|
601
|
-
foundObjects?: FoundObjects;
|
|
602
|
-
createdVisualizations?: CreatedVisualizations;
|
|
603
|
-
changeAnalysisParams?: ChangeAnalysisParams;
|
|
604
|
-
semanticSearch?: SearchResult;
|
|
604
|
+
'errorResponse'?: string;
|
|
605
|
+
'foundObjects'?: FoundObjects;
|
|
606
|
+
'createdVisualizations'?: CreatedVisualizations;
|
|
607
|
+
'changeAnalysisParams'?: ChangeAnalysisParams;
|
|
608
|
+
'semanticSearch'?: SearchResult;
|
|
605
609
|
/**
|
|
606
610
|
* Chat History thread suffix appended to ID generated by backend. Enables more chat windows.
|
|
607
611
|
*/
|
|
608
|
-
threadIdSuffix?: string;
|
|
612
|
+
'threadIdSuffix'?: string;
|
|
609
613
|
/**
|
|
610
614
|
* Chat History interaction ID. Unique ID for each interaction.
|
|
611
615
|
*/
|
|
612
|
-
chatHistoryInteractionId?: string;
|
|
613
|
-
reasoning?: Reasoning;
|
|
616
|
+
'chatHistoryInteractionId'?: string;
|
|
617
|
+
'reasoning'?: Reasoning;
|
|
614
618
|
}
|
|
615
619
|
export interface ChatUsageResponse {
|
|
616
620
|
/**
|
|
617
621
|
* Number of interactions in the time window
|
|
618
622
|
*/
|
|
619
|
-
interactionCount: number;
|
|
623
|
+
'interactionCount': number;
|
|
620
624
|
/**
|
|
621
625
|
* Maximum number of interactions in the time window any user can do in the workspace
|
|
622
626
|
*/
|
|
623
|
-
interactionLimit: number;
|
|
627
|
+
'interactionLimit': number;
|
|
624
628
|
/**
|
|
625
629
|
* Time window in hours
|
|
626
630
|
*/
|
|
627
|
-
timeWindowHours: number;
|
|
631
|
+
'timeWindowHours': number;
|
|
628
632
|
}
|
|
629
633
|
export interface ClusteringRequest {
|
|
630
634
|
/**
|
|
631
635
|
* Number of clusters to create
|
|
632
636
|
*/
|
|
633
|
-
numberOfClusters: number;
|
|
637
|
+
'numberOfClusters': number;
|
|
634
638
|
/**
|
|
635
639
|
* Threshold used for algorithm
|
|
636
640
|
*/
|
|
637
|
-
threshold?: number;
|
|
641
|
+
'threshold'?: number;
|
|
638
642
|
}
|
|
639
643
|
export interface ClusteringResult {
|
|
640
|
-
attribute: Array<object>;
|
|
641
|
-
xCoord?: Array<number | null>;
|
|
642
|
-
yCoord?: Array<number | null>;
|
|
643
|
-
clusters: Array<number | null>;
|
|
644
|
-
xcoord: Array<number>;
|
|
645
|
-
ycoord: Array<number>;
|
|
644
|
+
'attribute': Array<object>;
|
|
645
|
+
'xCoord'?: Array<number | null>;
|
|
646
|
+
'yCoord'?: Array<number | null>;
|
|
647
|
+
'clusters': Array<number | null>;
|
|
648
|
+
'xcoord': Array<number>;
|
|
649
|
+
'ycoord': Array<number>;
|
|
646
650
|
}
|
|
647
651
|
/**
|
|
648
652
|
* Condition that compares the metric value to a given constant value using a comparison operator.
|
|
649
653
|
*/
|
|
650
654
|
export interface ComparisonCondition {
|
|
651
|
-
comparison: ComparisonConditionComparison;
|
|
655
|
+
'comparison': ComparisonConditionComparison;
|
|
652
656
|
}
|
|
653
657
|
export interface ComparisonConditionComparison {
|
|
654
|
-
operator: ComparisonConditionComparisonOperatorEnum;
|
|
655
|
-
value: number;
|
|
658
|
+
'operator': ComparisonConditionComparisonOperatorEnum;
|
|
659
|
+
'value': number;
|
|
656
660
|
}
|
|
657
|
-
export type ComparisonConditionComparisonOperatorEnum =
|
|
661
|
+
export type ComparisonConditionComparisonOperatorEnum = 'GREATER_THAN' | 'GREATER_THAN_OR_EQUAL_TO' | 'LESS_THAN' | 'LESS_THAN_OR_EQUAL_TO' | 'EQUAL_TO' | 'NOT_EQUAL_TO';
|
|
658
662
|
/**
|
|
659
663
|
* Filter the result by comparing specified metric to given constant value, using given comparison operator.
|
|
660
664
|
*/
|
|
661
665
|
export interface ComparisonMeasureValueFilter {
|
|
662
|
-
comparisonMeasureValueFilter: ComparisonMeasureValueFilterComparisonMeasureValueFilter;
|
|
666
|
+
'comparisonMeasureValueFilter': ComparisonMeasureValueFilterComparisonMeasureValueFilter;
|
|
663
667
|
}
|
|
664
668
|
export interface ComparisonMeasureValueFilterComparisonMeasureValueFilter {
|
|
665
669
|
/**
|
|
666
670
|
* References to the attributes to be used when filtering.
|
|
667
671
|
*/
|
|
668
|
-
dimensionality?: Array<AfmIdentifier>;
|
|
672
|
+
'dimensionality'?: Array<AfmIdentifier>;
|
|
669
673
|
/**
|
|
670
674
|
* A value that will be substituted for null values in the metric for the comparisons.
|
|
671
675
|
*/
|
|
672
|
-
treatNullValuesAs?: number;
|
|
673
|
-
operator: ComparisonMeasureValueFilterComparisonMeasureValueFilterOperatorEnum;
|
|
674
|
-
value: number;
|
|
675
|
-
localIdentifier?: string;
|
|
676
|
-
applyOnResult?: boolean;
|
|
677
|
-
measure: AfmIdentifier;
|
|
676
|
+
'treatNullValuesAs'?: number;
|
|
677
|
+
'operator': ComparisonMeasureValueFilterComparisonMeasureValueFilterOperatorEnum;
|
|
678
|
+
'value': number;
|
|
679
|
+
'localIdentifier'?: string;
|
|
680
|
+
'applyOnResult'?: boolean;
|
|
681
|
+
'measure': AfmIdentifier;
|
|
678
682
|
}
|
|
679
|
-
export type ComparisonMeasureValueFilterComparisonMeasureValueFilterOperatorEnum =
|
|
683
|
+
export type ComparisonMeasureValueFilterComparisonMeasureValueFilterOperatorEnum = 'GREATER_THAN' | 'GREATER_THAN_OR_EQUAL_TO' | 'LESS_THAN' | 'LESS_THAN_OR_EQUAL_TO' | 'EQUAL_TO' | 'NOT_EQUAL_TO';
|
|
680
684
|
/**
|
|
681
685
|
* Filter the result by applying multiple comparison and/or range conditions combined with OR logic. If conditions list is empty, no filtering is applied (all rows are returned).
|
|
682
686
|
*/
|
|
683
687
|
export interface CompoundMeasureValueFilter {
|
|
684
|
-
compoundMeasureValueFilter: CompoundMeasureValueFilterCompoundMeasureValueFilter;
|
|
688
|
+
'compoundMeasureValueFilter': CompoundMeasureValueFilterCompoundMeasureValueFilter;
|
|
685
689
|
}
|
|
686
690
|
export interface CompoundMeasureValueFilterCompoundMeasureValueFilter {
|
|
687
691
|
/**
|
|
688
692
|
* References to the attributes to be used when filtering.
|
|
689
693
|
*/
|
|
690
|
-
dimensionality?: Array<AfmIdentifier>;
|
|
694
|
+
'dimensionality'?: Array<AfmIdentifier>;
|
|
691
695
|
/**
|
|
692
696
|
* A value that will be substituted for null values in the metric for the comparisons.
|
|
693
697
|
*/
|
|
694
|
-
treatNullValuesAs?: number;
|
|
698
|
+
'treatNullValuesAs'?: number;
|
|
695
699
|
/**
|
|
696
700
|
* List of conditions to apply. Conditions are combined with OR logic. Each condition can be either a comparison (e.g., > 100) or a range (e.g., BETWEEN 10 AND 50). If empty, no filtering is applied and all rows are returned.
|
|
697
701
|
*/
|
|
698
|
-
conditions: Array<MeasureValueCondition>;
|
|
699
|
-
localIdentifier?: string;
|
|
700
|
-
applyOnResult?: boolean;
|
|
701
|
-
measure: AfmIdentifier;
|
|
702
|
+
'conditions': Array<MeasureValueCondition>;
|
|
703
|
+
'localIdentifier'?: string;
|
|
704
|
+
'applyOnResult'?: boolean;
|
|
705
|
+
'measure': AfmIdentifier;
|
|
702
706
|
}
|
|
703
707
|
/**
|
|
704
708
|
* List of created visualization objects
|
|
@@ -707,37 +711,37 @@ export interface CreatedVisualization {
|
|
|
707
711
|
/**
|
|
708
712
|
* Proposed ID of the new visualization
|
|
709
713
|
*/
|
|
710
|
-
id: string;
|
|
714
|
+
'id': string;
|
|
711
715
|
/**
|
|
712
716
|
* Proposed title of the new visualization
|
|
713
717
|
*/
|
|
714
|
-
title: string;
|
|
718
|
+
'title': string;
|
|
715
719
|
/**
|
|
716
720
|
* Visualization type requested in question
|
|
717
721
|
*/
|
|
718
|
-
visualizationType: CreatedVisualizationVisualizationTypeEnum;
|
|
722
|
+
'visualizationType': CreatedVisualizationVisualizationTypeEnum;
|
|
719
723
|
/**
|
|
720
724
|
* List of metrics to be used in the new visualization
|
|
721
725
|
*/
|
|
722
|
-
metrics: Array<Metric>;
|
|
726
|
+
'metrics': Array<Metric>;
|
|
723
727
|
/**
|
|
724
728
|
* List of attributes representing the dimensionality of the new visualization
|
|
725
729
|
*/
|
|
726
|
-
dimensionality: Array<DimAttribute>;
|
|
730
|
+
'dimensionality': Array<DimAttribute>;
|
|
727
731
|
/**
|
|
728
732
|
* List of filters to be applied to the new visualization
|
|
729
733
|
*/
|
|
730
|
-
filters: Array<CreatedVisualizationFiltersInner>;
|
|
734
|
+
'filters': Array<CreatedVisualizationFiltersInner>;
|
|
731
735
|
/**
|
|
732
736
|
* Suggestions for next steps
|
|
733
737
|
*/
|
|
734
|
-
suggestions: Array<Suggestion>;
|
|
738
|
+
'suggestions': Array<Suggestion>;
|
|
735
739
|
/**
|
|
736
740
|
* Saved visualization ID.
|
|
737
741
|
*/
|
|
738
|
-
savedVisualizationId?: string;
|
|
742
|
+
'savedVisualizationId'?: string;
|
|
739
743
|
}
|
|
740
|
-
export type CreatedVisualizationVisualizationTypeEnum =
|
|
744
|
+
export type CreatedVisualizationVisualizationTypeEnum = 'TABLE' | 'HEADLINE' | 'BAR' | 'LINE' | 'PIE' | 'COLUMN';
|
|
741
745
|
/**
|
|
742
746
|
* @type CreatedVisualizationFiltersInner
|
|
743
747
|
*/
|
|
@@ -749,15 +753,15 @@ export interface CreatedVisualizations {
|
|
|
749
753
|
/**
|
|
750
754
|
* List of created visualization objects
|
|
751
755
|
*/
|
|
752
|
-
objects: Array<CreatedVisualization>;
|
|
756
|
+
'objects': Array<CreatedVisualization>;
|
|
753
757
|
/**
|
|
754
758
|
* DEPRECATED: Use top-level reasoning.steps instead. Reasoning from LLM. Description of how and why the answer was generated.
|
|
755
759
|
*/
|
|
756
|
-
reasoning: string;
|
|
760
|
+
'reasoning': string;
|
|
757
761
|
/**
|
|
758
762
|
* List of suggestions for next steps. Filled when no visualization was created, suggests alternatives.
|
|
759
763
|
*/
|
|
760
|
-
suggestions: Array<Suggestion>;
|
|
764
|
+
'suggestions': Array<Suggestion>;
|
|
761
765
|
}
|
|
762
766
|
/**
|
|
763
767
|
* 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.
|
|
@@ -766,7 +770,7 @@ export interface DataColumnLocator {
|
|
|
766
770
|
/**
|
|
767
771
|
* 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.
|
|
768
772
|
*/
|
|
769
|
-
properties: {
|
|
773
|
+
'properties': {
|
|
770
774
|
[key: string]: string;
|
|
771
775
|
};
|
|
772
776
|
}
|
|
@@ -777,7 +781,7 @@ export interface DataColumnLocators {
|
|
|
777
781
|
/**
|
|
778
782
|
* Mapping from dimensions to data column locators.
|
|
779
783
|
*/
|
|
780
|
-
properties?: {
|
|
784
|
+
'properties'?: {
|
|
781
785
|
[key: string]: DataColumnLocator;
|
|
782
786
|
};
|
|
783
787
|
}
|
|
@@ -788,20 +792,20 @@ export interface DatabaseInstance {
|
|
|
788
792
|
/**
|
|
789
793
|
* Id of the AI Lake Database instance
|
|
790
794
|
*/
|
|
791
|
-
id: string;
|
|
795
|
+
'id': string;
|
|
792
796
|
/**
|
|
793
797
|
* Name of the AI Lake Database instance
|
|
794
798
|
*/
|
|
795
|
-
name: string;
|
|
799
|
+
'name': string;
|
|
796
800
|
/**
|
|
797
801
|
* Set of ids of the storage instances this database instance should access.
|
|
798
802
|
*/
|
|
799
|
-
storageIds: Array<string>;
|
|
803
|
+
'storageIds': Array<string>;
|
|
800
804
|
}
|
|
801
805
|
export interface DateAbsoluteFilter {
|
|
802
|
-
using: string;
|
|
803
|
-
from: string;
|
|
804
|
-
to: string;
|
|
806
|
+
'using': string;
|
|
807
|
+
'from': string;
|
|
808
|
+
'to': string;
|
|
805
809
|
}
|
|
806
810
|
/**
|
|
807
811
|
* @type DateFilter
|
|
@@ -809,12 +813,12 @@ export interface DateAbsoluteFilter {
|
|
|
809
813
|
*/
|
|
810
814
|
export type DateFilter = AbsoluteDateFilter | RelativeDateFilter;
|
|
811
815
|
export interface DateRelativeFilter {
|
|
812
|
-
using: string;
|
|
813
|
-
granularity: DateRelativeFilterGranularityEnum;
|
|
814
|
-
from: number;
|
|
815
|
-
to: number;
|
|
816
|
+
'using': string;
|
|
817
|
+
'granularity': DateRelativeFilterGranularityEnum;
|
|
818
|
+
'from': number;
|
|
819
|
+
'to': number;
|
|
816
820
|
}
|
|
817
|
-
export type DateRelativeFilterGranularityEnum =
|
|
821
|
+
export type DateRelativeFilterGranularityEnum = 'MINUTE' | 'HOUR' | 'DAY' | 'WEEK' | 'MONTH' | 'QUARTER' | 'YEAR' | 'MINUTE_OF_HOUR' | 'HOUR_OF_DAY' | 'DAY_OF_WEEK' | 'DAY_OF_MONTH' | 'DAY_OF_QUARTER' | 'DAY_OF_YEAR' | 'WEEK_OF_YEAR' | 'MONTH_OF_YEAR' | 'QUARTER_OF_YEAR' | 'FISCAL_MONTH' | 'FISCAL_QUARTER' | 'FISCAL_YEAR';
|
|
818
822
|
/**
|
|
819
823
|
* Filter definition type specified by label and values.
|
|
820
824
|
*/
|
|
@@ -822,21 +826,21 @@ export interface DependsOn {
|
|
|
822
826
|
/**
|
|
823
827
|
* Specifies on which label the filter depends on.
|
|
824
828
|
*/
|
|
825
|
-
label: string;
|
|
829
|
+
'label': string;
|
|
826
830
|
/**
|
|
827
831
|
* Specifies values of the label for element filtering.
|
|
828
832
|
*/
|
|
829
|
-
values: Array<string | null>;
|
|
833
|
+
'values': Array<string | null>;
|
|
830
834
|
/**
|
|
831
835
|
* Inverse filtering mode.
|
|
832
836
|
*/
|
|
833
|
-
complementFilter?: boolean;
|
|
837
|
+
'complementFilter'?: boolean;
|
|
834
838
|
}
|
|
835
839
|
/**
|
|
836
840
|
* Filter definition type for dates.
|
|
837
841
|
*/
|
|
838
842
|
export interface DependsOnDateFilter {
|
|
839
|
-
dateFilter: DateFilter;
|
|
843
|
+
'dateFilter': DateFilter;
|
|
840
844
|
}
|
|
841
845
|
/**
|
|
842
846
|
* List of attributes representing the dimensionality of the new visualization
|
|
@@ -845,17 +849,17 @@ export interface DimAttribute {
|
|
|
845
849
|
/**
|
|
846
850
|
* ID of the object
|
|
847
851
|
*/
|
|
848
|
-
id: string;
|
|
852
|
+
'id': string;
|
|
849
853
|
/**
|
|
850
854
|
* Object type
|
|
851
855
|
*/
|
|
852
|
-
type: DimAttributeTypeEnum;
|
|
856
|
+
'type': DimAttributeTypeEnum;
|
|
853
857
|
/**
|
|
854
858
|
* Title of attribute.
|
|
855
859
|
*/
|
|
856
|
-
title: string;
|
|
860
|
+
'title': string;
|
|
857
861
|
}
|
|
858
|
-
export type DimAttributeTypeEnum =
|
|
862
|
+
export type DimAttributeTypeEnum = 'attribute';
|
|
859
863
|
/**
|
|
860
864
|
* Single dimension description.
|
|
861
865
|
*/
|
|
@@ -863,15 +867,15 @@ export interface Dimension {
|
|
|
863
867
|
/**
|
|
864
868
|
* Dimension identification within requests. Other entities can reference this dimension by this value.
|
|
865
869
|
*/
|
|
866
|
-
localIdentifier?: string;
|
|
870
|
+
'localIdentifier'?: string;
|
|
867
871
|
/**
|
|
868
872
|
* List of items in current dimension. Can reference \'localIdentifier\' from \'AttributeItem\', or special pseudo attribute \"measureGroup\" representing list of metrics.
|
|
869
873
|
*/
|
|
870
|
-
itemIdentifiers: Array<string>;
|
|
874
|
+
'itemIdentifiers': Array<string>;
|
|
871
875
|
/**
|
|
872
876
|
* List of sorting rules. From most relevant to least relevant (less relevant rule is applied, when more relevant rule compares items as equal).
|
|
873
877
|
*/
|
|
874
|
-
sorting?: Array<SortKey>;
|
|
878
|
+
'sorting'?: Array<SortKey>;
|
|
875
879
|
}
|
|
876
880
|
/**
|
|
877
881
|
* Contains the dimension-specific header information.
|
|
@@ -880,7 +884,7 @@ export interface DimensionHeader {
|
|
|
880
884
|
/**
|
|
881
885
|
* An array containing header groups.
|
|
882
886
|
*/
|
|
883
|
-
headerGroups: Array<HeaderGroup>;
|
|
887
|
+
'headerGroups': Array<HeaderGroup>;
|
|
884
888
|
}
|
|
885
889
|
/**
|
|
886
890
|
* List of returned elements.
|
|
@@ -889,57 +893,57 @@ export interface Element {
|
|
|
889
893
|
/**
|
|
890
894
|
* Title of requested label.
|
|
891
895
|
*/
|
|
892
|
-
title: string | null;
|
|
896
|
+
'title': string | null;
|
|
893
897
|
/**
|
|
894
898
|
* Title of primary label of attribute owning requested label, null if the title is null or the primary label is excluded
|
|
895
899
|
*/
|
|
896
|
-
primaryTitle: string | null;
|
|
900
|
+
'primaryTitle': string | null;
|
|
897
901
|
}
|
|
898
902
|
export interface ElementsRequest {
|
|
899
903
|
/**
|
|
900
904
|
* Requested label.
|
|
901
905
|
*/
|
|
902
|
-
label: string;
|
|
906
|
+
'label': string;
|
|
903
907
|
/**
|
|
904
908
|
* 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
|
|
905
909
|
*/
|
|
906
|
-
excludePrimaryLabel?: boolean;
|
|
907
|
-
filterBy?: FilterBy;
|
|
910
|
+
'excludePrimaryLabel'?: boolean;
|
|
911
|
+
'filterBy'?: FilterBy;
|
|
908
912
|
/**
|
|
909
913
|
* 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
|
|
910
914
|
*/
|
|
911
|
-
sortOrder?: ElementsRequestSortOrderEnum;
|
|
915
|
+
'sortOrder'?: ElementsRequestSortOrderEnum;
|
|
912
916
|
/**
|
|
913
917
|
* Inverse filters: * ```false``` - return items matching ```patternFilter``` and ```exactFilter``` * ```true``` - return items not matching ```patternFilter``` and ```exactFilter```
|
|
914
918
|
*/
|
|
915
|
-
complementFilter?: boolean;
|
|
919
|
+
'complementFilter'?: boolean;
|
|
916
920
|
/**
|
|
917
921
|
* Return only items, whose ```label``` title case insensitively contains ```filter``` as substring.
|
|
918
922
|
*/
|
|
919
|
-
patternFilter?: string;
|
|
923
|
+
'patternFilter'?: string;
|
|
920
924
|
/**
|
|
921
925
|
* Return only items, whose ```label``` title exactly matches one of ```filter```.
|
|
922
926
|
*/
|
|
923
|
-
exactFilter?: Array<string | null>;
|
|
927
|
+
'exactFilter'?: Array<string | null>;
|
|
924
928
|
/**
|
|
925
929
|
* Return only items that are not filtered-out by the parent filters.
|
|
926
930
|
*/
|
|
927
|
-
dependsOn?: Array<ElementsRequestDependsOnInner>;
|
|
931
|
+
'dependsOn'?: Array<ElementsRequestDependsOnInner>;
|
|
928
932
|
/**
|
|
929
933
|
* Return only items that are computable on metric.
|
|
930
934
|
*/
|
|
931
|
-
validateBy?: Array<ValidateByItem>;
|
|
935
|
+
'validateBy'?: Array<ValidateByItem>;
|
|
932
936
|
/**
|
|
933
937
|
* Specifies percentage of source table data scanned during the computation. This field is deprecated and is no longer used during the elements computation.
|
|
934
938
|
* @deprecated
|
|
935
939
|
*/
|
|
936
|
-
dataSamplingPercentage?: number;
|
|
940
|
+
'dataSamplingPercentage'?: number;
|
|
937
941
|
/**
|
|
938
942
|
* If specified, the element data will be taken from the result with the same cacheId if it is available.
|
|
939
943
|
*/
|
|
940
|
-
cacheId?: string;
|
|
944
|
+
'cacheId'?: string;
|
|
941
945
|
}
|
|
942
|
-
export type ElementsRequestSortOrderEnum =
|
|
946
|
+
export type ElementsRequestSortOrderEnum = 'ASC' | 'DESC';
|
|
943
947
|
/**
|
|
944
948
|
* @type ElementsRequestDependsOnInner
|
|
945
949
|
*/
|
|
@@ -948,23 +952,23 @@ export type ElementsRequestDependsOnInner = DependsOn | DependsOnDateFilter;
|
|
|
948
952
|
* Entity holding list of sorted & filtered label elements, related primary label of attribute owning requested label and paging.
|
|
949
953
|
*/
|
|
950
954
|
export interface ElementsResponse {
|
|
951
|
-
primaryLabel: RestApiIdentifier;
|
|
955
|
+
'primaryLabel': RestApiIdentifier;
|
|
952
956
|
/**
|
|
953
957
|
* List of returned elements.
|
|
954
958
|
*/
|
|
955
|
-
elements: Array<Element>;
|
|
956
|
-
paging: Paging;
|
|
959
|
+
'elements': Array<Element>;
|
|
960
|
+
'paging': Paging;
|
|
957
961
|
/**
|
|
958
962
|
* Granularity of requested label in case of date attribute
|
|
959
963
|
*/
|
|
960
|
-
granularity?: ElementsResponseGranularityEnum;
|
|
961
|
-
format?: AttributeFormat;
|
|
964
|
+
'granularity'?: ElementsResponseGranularityEnum;
|
|
965
|
+
'format'?: AttributeFormat;
|
|
962
966
|
/**
|
|
963
967
|
* 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.
|
|
964
968
|
*/
|
|
965
|
-
cacheId?: string;
|
|
969
|
+
'cacheId'?: string;
|
|
966
970
|
}
|
|
967
|
-
export type ElementsResponseGranularityEnum =
|
|
971
|
+
export type ElementsResponseGranularityEnum = 'MINUTE' | 'HOUR' | 'DAY' | 'WEEK' | 'MONTH' | 'QUARTER' | 'YEAR' | 'MINUTE_OF_HOUR' | 'HOUR_OF_DAY' | 'DAY_OF_WEEK' | 'DAY_OF_MONTH' | 'DAY_OF_QUARTER' | 'DAY_OF_YEAR' | 'WEEK_OF_YEAR' | 'MONTH_OF_YEAR' | 'QUARTER_OF_YEAR' | 'FISCAL_MONTH' | 'FISCAL_QUARTER' | 'FISCAL_YEAR';
|
|
968
972
|
/**
|
|
969
973
|
* Links to the execution result.
|
|
970
974
|
*/
|
|
@@ -972,7 +976,7 @@ export interface ExecutionLinks {
|
|
|
972
976
|
/**
|
|
973
977
|
* Link to the result data.
|
|
974
978
|
*/
|
|
975
|
-
executionResult: string;
|
|
979
|
+
'executionResult': string;
|
|
976
980
|
}
|
|
977
981
|
/**
|
|
978
982
|
* Response to AFM execution request body
|
|
@@ -981,8 +985,8 @@ export interface ExecutionResponse {
|
|
|
981
985
|
/**
|
|
982
986
|
* Dimensions of the result
|
|
983
987
|
*/
|
|
984
|
-
dimensions: Array<ResultDimension>;
|
|
985
|
-
links: ExecutionLinks;
|
|
988
|
+
'dimensions': Array<ResultDimension>;
|
|
989
|
+
'links': ExecutionLinks;
|
|
986
990
|
}
|
|
987
991
|
/**
|
|
988
992
|
* Contains the result of an AFM execution.
|
|
@@ -991,14 +995,14 @@ export interface ExecutionResult {
|
|
|
991
995
|
/**
|
|
992
996
|
* 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.
|
|
993
997
|
*/
|
|
994
|
-
data: Array<object>;
|
|
998
|
+
'data': Array<object>;
|
|
995
999
|
/**
|
|
996
1000
|
* 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.
|
|
997
1001
|
*/
|
|
998
|
-
dimensionHeaders: Array<DimensionHeader>;
|
|
999
|
-
grandTotals: Array<ExecutionResultGrandTotal>;
|
|
1000
|
-
paging: ExecutionResultPaging;
|
|
1001
|
-
metadata: ExecutionResultMetadata;
|
|
1002
|
+
'dimensionHeaders': Array<DimensionHeader>;
|
|
1003
|
+
'grandTotals': Array<ExecutionResultGrandTotal>;
|
|
1004
|
+
'paging': ExecutionResultPaging;
|
|
1005
|
+
'metadata': ExecutionResultMetadata;
|
|
1002
1006
|
}
|
|
1003
1007
|
/**
|
|
1004
1008
|
* A piece of extra information related to the results (e.g. debug information, warnings, etc.).
|
|
@@ -1007,19 +1011,19 @@ export interface ExecutionResultDataSourceMessage {
|
|
|
1007
1011
|
/**
|
|
1008
1012
|
* Id correlating different pieces of supplementary info together.
|
|
1009
1013
|
*/
|
|
1010
|
-
correlationId: string;
|
|
1014
|
+
'correlationId': string;
|
|
1011
1015
|
/**
|
|
1012
1016
|
* Information about what part of the system created this piece of supplementary info.
|
|
1013
1017
|
*/
|
|
1014
|
-
source: string;
|
|
1018
|
+
'source': string;
|
|
1015
1019
|
/**
|
|
1016
1020
|
* Type of the supplementary info instance. There are currently no well-known values for this, but there might be some in the future.
|
|
1017
1021
|
*/
|
|
1018
|
-
type: string;
|
|
1022
|
+
'type': string;
|
|
1019
1023
|
/**
|
|
1020
1024
|
* Data of this particular supplementary info item: a free-form JSON specific to the particular supplementary info item type.
|
|
1021
1025
|
*/
|
|
1022
|
-
data?: object;
|
|
1026
|
+
'data'?: object;
|
|
1023
1027
|
}
|
|
1024
1028
|
/**
|
|
1025
1029
|
* Contains the data of grand totals with the same dimensions.
|
|
@@ -1028,15 +1032,15 @@ export interface ExecutionResultGrandTotal {
|
|
|
1028
1032
|
/**
|
|
1029
1033
|
* 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.
|
|
1030
1034
|
*/
|
|
1031
|
-
data: Array<object>;
|
|
1035
|
+
'data': Array<object>;
|
|
1032
1036
|
/**
|
|
1033
1037
|
* Contains headers for a subset of `totalDimensions` in which the totals are grand totals.
|
|
1034
1038
|
*/
|
|
1035
|
-
dimensionHeaders: Array<DimensionHeader>;
|
|
1039
|
+
'dimensionHeaders': Array<DimensionHeader>;
|
|
1036
1040
|
/**
|
|
1037
1041
|
* Dimensions of the grand totals.
|
|
1038
1042
|
*/
|
|
1039
|
-
totalDimensions: Array<string>;
|
|
1043
|
+
'totalDimensions': Array<string>;
|
|
1040
1044
|
}
|
|
1041
1045
|
/**
|
|
1042
1046
|
* @type ExecutionResultHeader
|
|
@@ -1050,7 +1054,7 @@ export interface ExecutionResultMetadata {
|
|
|
1050
1054
|
/**
|
|
1051
1055
|
* Additional information sent by the underlying data source.
|
|
1052
1056
|
*/
|
|
1053
|
-
dataSourceMessages: Array<ExecutionResultDataSourceMessage>;
|
|
1057
|
+
'dataSourceMessages': Array<ExecutionResultDataSourceMessage>;
|
|
1054
1058
|
}
|
|
1055
1059
|
/**
|
|
1056
1060
|
* A paging information related to the data presented in the execution result. These paging information are multi-dimensional.
|
|
@@ -1059,15 +1063,15 @@ export interface ExecutionResultPaging {
|
|
|
1059
1063
|
/**
|
|
1060
1064
|
* A count of the returned results in every dimension.
|
|
1061
1065
|
*/
|
|
1062
|
-
count: Array<number>;
|
|
1066
|
+
'count': Array<number>;
|
|
1063
1067
|
/**
|
|
1064
1068
|
* The offset of the results returned in every dimension.
|
|
1065
1069
|
*/
|
|
1066
|
-
offset: Array<number>;
|
|
1070
|
+
'offset': Array<number>;
|
|
1067
1071
|
/**
|
|
1068
1072
|
* A total count of the results in every dimension.
|
|
1069
1073
|
*/
|
|
1070
|
-
total: Array<number>;
|
|
1074
|
+
'total': Array<number>;
|
|
1071
1075
|
}
|
|
1072
1076
|
/**
|
|
1073
1077
|
* Various settings affecting the process of AFM execution or its result
|
|
@@ -1076,17 +1080,17 @@ export interface ExecutionSettings {
|
|
|
1076
1080
|
/**
|
|
1077
1081
|
* 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.
|
|
1078
1082
|
*/
|
|
1079
|
-
dataSamplingPercentage?: number;
|
|
1083
|
+
'dataSamplingPercentage'?: number;
|
|
1080
1084
|
/**
|
|
1081
1085
|
* Specifies the timestamp of the execution from which relative filters are resolved. If not set, the current time is used.
|
|
1082
1086
|
*/
|
|
1083
|
-
timestamp?: string;
|
|
1087
|
+
'timestamp'?: string;
|
|
1084
1088
|
}
|
|
1085
1089
|
/**
|
|
1086
1090
|
* Operation that has failed
|
|
1087
1091
|
*/
|
|
1088
1092
|
export interface FailedOperation extends Operation {
|
|
1089
|
-
error: OperationError;
|
|
1093
|
+
'error': OperationError;
|
|
1090
1094
|
}
|
|
1091
1095
|
/**
|
|
1092
1096
|
* Specifies what is used for filtering.
|
|
@@ -1095,9 +1099,9 @@ export interface FilterBy {
|
|
|
1095
1099
|
/**
|
|
1096
1100
|
* Specifies which label is used for filtering - primary or requested.
|
|
1097
1101
|
*/
|
|
1098
|
-
labelType?: FilterByLabelTypeEnum;
|
|
1102
|
+
'labelType'?: FilterByLabelTypeEnum;
|
|
1099
1103
|
}
|
|
1100
|
-
export type FilterByLabelTypeEnum =
|
|
1104
|
+
export type FilterByLabelTypeEnum = 'PRIMARY' | 'REQUESTED';
|
|
1101
1105
|
/**
|
|
1102
1106
|
* @type FilterDefinition
|
|
1103
1107
|
* Abstract filter definition type
|
|
@@ -1112,22 +1116,22 @@ export interface ForecastRequest {
|
|
|
1112
1116
|
/**
|
|
1113
1117
|
* Number of future periods that should be forecasted
|
|
1114
1118
|
*/
|
|
1115
|
-
forecastPeriod: number;
|
|
1119
|
+
'forecastPeriod': number;
|
|
1116
1120
|
/**
|
|
1117
1121
|
* Confidence interval boundary value.
|
|
1118
1122
|
*/
|
|
1119
|
-
confidenceLevel?: number;
|
|
1123
|
+
'confidenceLevel'?: number;
|
|
1120
1124
|
/**
|
|
1121
1125
|
* Whether the input data is seasonal
|
|
1122
1126
|
*/
|
|
1123
|
-
seasonal?: boolean;
|
|
1127
|
+
'seasonal'?: boolean;
|
|
1124
1128
|
}
|
|
1125
1129
|
export interface ForecastResult {
|
|
1126
|
-
attribute: Array<string>;
|
|
1127
|
-
origin: Array<number | null>;
|
|
1128
|
-
prediction: Array<number | null>;
|
|
1129
|
-
lowerBound: Array<number | null>;
|
|
1130
|
-
upperBound: Array<number | null>;
|
|
1130
|
+
'attribute': Array<string>;
|
|
1131
|
+
'origin': Array<number | null>;
|
|
1132
|
+
'prediction': Array<number | null>;
|
|
1133
|
+
'lowerBound': Array<number | null>;
|
|
1134
|
+
'upperBound': Array<number | null>;
|
|
1131
1135
|
}
|
|
1132
1136
|
/**
|
|
1133
1137
|
* List of objects found by similarity search and post-processed by LLM.
|
|
@@ -1136,29 +1140,29 @@ export interface FoundObjects {
|
|
|
1136
1140
|
/**
|
|
1137
1141
|
* List of objects found with a similarity search.
|
|
1138
1142
|
*/
|
|
1139
|
-
objects: Array<SearchResultObject>;
|
|
1143
|
+
'objects': Array<SearchResultObject>;
|
|
1140
1144
|
/**
|
|
1141
1145
|
* DEPRECATED: Use top-level reasoning.steps instead. Reasoning from LLM. Description of how and why the answer was generated.
|
|
1142
1146
|
*/
|
|
1143
|
-
reasoning: string;
|
|
1147
|
+
'reasoning': string;
|
|
1144
1148
|
}
|
|
1145
1149
|
/**
|
|
1146
1150
|
* Configuration specific to geo area labels.
|
|
1147
1151
|
*/
|
|
1148
1152
|
export interface GeoAreaConfig {
|
|
1149
|
-
collection: GeoCollectionIdentifier;
|
|
1153
|
+
'collection': GeoCollectionIdentifier;
|
|
1150
1154
|
}
|
|
1151
1155
|
export interface GeoCollectionIdentifier {
|
|
1152
1156
|
/**
|
|
1153
1157
|
* Geo collection identifier.
|
|
1154
1158
|
*/
|
|
1155
|
-
id: string;
|
|
1159
|
+
'id': string;
|
|
1156
1160
|
/**
|
|
1157
1161
|
* Type of geo collection.
|
|
1158
1162
|
*/
|
|
1159
|
-
kind?: GeoCollectionIdentifierKindEnum;
|
|
1163
|
+
'kind'?: GeoCollectionIdentifierKindEnum;
|
|
1160
1164
|
}
|
|
1161
|
-
export type GeoCollectionIdentifierKindEnum =
|
|
1165
|
+
export type GeoCollectionIdentifierKindEnum = 'STATIC' | 'CUSTOM';
|
|
1162
1166
|
/**
|
|
1163
1167
|
* @type GetAiLakeOperation200Response
|
|
1164
1168
|
*/
|
|
@@ -1167,17 +1171,17 @@ export interface GetQualityIssuesResponse {
|
|
|
1167
1171
|
/**
|
|
1168
1172
|
* List of quality issues found in the workspace
|
|
1169
1173
|
*/
|
|
1170
|
-
issues: Array<QualityIssue>;
|
|
1174
|
+
'issues': Array<QualityIssue>;
|
|
1171
1175
|
/**
|
|
1172
1176
|
* Timestamp when the quality issues were last updated (ISO format)
|
|
1173
1177
|
*/
|
|
1174
|
-
updatedAt?: string;
|
|
1178
|
+
'updatedAt'?: string;
|
|
1175
1179
|
/**
|
|
1176
1180
|
* Status of the latest triggered quality check process
|
|
1177
1181
|
*/
|
|
1178
|
-
status: GetQualityIssuesResponseStatusEnum;
|
|
1182
|
+
'status': GetQualityIssuesResponseStatusEnum;
|
|
1179
1183
|
}
|
|
1180
|
-
export type GetQualityIssuesResponseStatusEnum =
|
|
1184
|
+
export type GetQualityIssuesResponseStatusEnum = 'RUNNING' | 'SYNCING' | 'COMPLETED' | 'FAILED' | 'NOT_FOUND' | 'DISABLED';
|
|
1181
1185
|
/**
|
|
1182
1186
|
* Contains the information specific for a group of headers. These groups correlate to attributes and metric groups.
|
|
1183
1187
|
*/
|
|
@@ -1185,63 +1189,63 @@ export interface HeaderGroup {
|
|
|
1185
1189
|
/**
|
|
1186
1190
|
* An array containing headers.
|
|
1187
1191
|
*/
|
|
1188
|
-
headers: Array<ExecutionResultHeader>;
|
|
1192
|
+
'headers': Array<ExecutionResultHeader>;
|
|
1189
1193
|
}
|
|
1190
1194
|
/**
|
|
1191
1195
|
* Filter in form of direct MAQL query.
|
|
1192
1196
|
*/
|
|
1193
1197
|
export interface InlineFilterDefinition {
|
|
1194
|
-
inline: InlineFilterDefinitionInline;
|
|
1198
|
+
'inline': InlineFilterDefinitionInline;
|
|
1195
1199
|
}
|
|
1196
1200
|
export interface InlineFilterDefinitionInline {
|
|
1197
1201
|
/**
|
|
1198
1202
|
* MAQL query representing the filter.
|
|
1199
1203
|
*/
|
|
1200
|
-
filter: string;
|
|
1201
|
-
localIdentifier?: string;
|
|
1202
|
-
applyOnResult?: boolean;
|
|
1204
|
+
'filter': string;
|
|
1205
|
+
'localIdentifier'?: string;
|
|
1206
|
+
'applyOnResult'?: boolean;
|
|
1203
1207
|
}
|
|
1204
1208
|
/**
|
|
1205
1209
|
* Metric defined by the raw MAQL query.
|
|
1206
1210
|
*/
|
|
1207
1211
|
export interface InlineMeasureDefinition {
|
|
1208
|
-
inline: InlineMeasureDefinitionInline;
|
|
1212
|
+
'inline': InlineMeasureDefinitionInline;
|
|
1209
1213
|
}
|
|
1210
1214
|
export interface InlineMeasureDefinitionInline {
|
|
1211
1215
|
/**
|
|
1212
1216
|
* MAQL query defining the metric.
|
|
1213
1217
|
*/
|
|
1214
|
-
maql: string;
|
|
1218
|
+
'maql': string;
|
|
1215
1219
|
}
|
|
1216
1220
|
export interface KeyDriversDimension {
|
|
1217
|
-
label: RestApiIdentifier;
|
|
1218
|
-
labelName: string;
|
|
1219
|
-
attribute: RestApiIdentifier;
|
|
1220
|
-
attributeName: string;
|
|
1221
|
-
granularity?: KeyDriversDimensionGranularityEnum;
|
|
1222
|
-
format?: AttributeFormat;
|
|
1223
|
-
valueType?: KeyDriversDimensionValueTypeEnum;
|
|
1224
|
-
}
|
|
1225
|
-
export type KeyDriversDimensionGranularityEnum =
|
|
1226
|
-
export type KeyDriversDimensionValueTypeEnum =
|
|
1221
|
+
'label': RestApiIdentifier;
|
|
1222
|
+
'labelName': string;
|
|
1223
|
+
'attribute': RestApiIdentifier;
|
|
1224
|
+
'attributeName': string;
|
|
1225
|
+
'granularity'?: KeyDriversDimensionGranularityEnum;
|
|
1226
|
+
'format'?: AttributeFormat;
|
|
1227
|
+
'valueType'?: KeyDriversDimensionValueTypeEnum;
|
|
1228
|
+
}
|
|
1229
|
+
export type KeyDriversDimensionGranularityEnum = 'MINUTE' | 'HOUR' | 'DAY' | 'WEEK' | 'MONTH' | 'QUARTER' | 'YEAR' | 'MINUTE_OF_HOUR' | 'HOUR_OF_DAY' | 'DAY_OF_WEEK' | 'DAY_OF_MONTH' | 'DAY_OF_QUARTER' | 'DAY_OF_YEAR' | 'WEEK_OF_YEAR' | 'MONTH_OF_YEAR' | 'QUARTER_OF_YEAR' | 'FISCAL_MONTH' | 'FISCAL_QUARTER' | 'FISCAL_YEAR';
|
|
1230
|
+
export type KeyDriversDimensionValueTypeEnum = 'TEXT' | 'HYPERLINK' | 'GEO' | 'GEO_LONGITUDE' | 'GEO_LATITUDE' | 'GEO_AREA' | 'IMAGE';
|
|
1227
1231
|
export interface KeyDriversRequest {
|
|
1228
|
-
metric: MeasureItem;
|
|
1232
|
+
'metric': MeasureItem;
|
|
1229
1233
|
/**
|
|
1230
1234
|
* Additional metrics to be included in the computation, but excluded from the analysis.
|
|
1231
1235
|
*/
|
|
1232
|
-
auxMetrics?: Array<MeasureItem>;
|
|
1236
|
+
'auxMetrics'?: Array<MeasureItem>;
|
|
1233
1237
|
/**
|
|
1234
1238
|
* Sorting elements - ascending/descending order.
|
|
1235
1239
|
*/
|
|
1236
|
-
sortDirection?: KeyDriversRequestSortDirectionEnum;
|
|
1240
|
+
'sortDirection'?: KeyDriversRequestSortDirectionEnum;
|
|
1237
1241
|
}
|
|
1238
|
-
export type KeyDriversRequestSortDirectionEnum =
|
|
1242
|
+
export type KeyDriversRequestSortDirectionEnum = 'ASC' | 'DESC';
|
|
1239
1243
|
export interface KeyDriversResponse {
|
|
1240
|
-
dimensions: Array<KeyDriversDimension>;
|
|
1241
|
-
links: ExecutionLinks;
|
|
1244
|
+
'dimensions': Array<KeyDriversDimension>;
|
|
1245
|
+
'links': ExecutionLinks;
|
|
1242
1246
|
}
|
|
1243
1247
|
export interface KeyDriversResult {
|
|
1244
|
-
data: object;
|
|
1248
|
+
'data': object;
|
|
1245
1249
|
}
|
|
1246
1250
|
/**
|
|
1247
1251
|
* @type MeasureDefinition
|
|
@@ -1249,27 +1253,27 @@ export interface KeyDriversResult {
|
|
|
1249
1253
|
*/
|
|
1250
1254
|
export type MeasureDefinition = ArithmeticMeasureDefinition | InlineMeasureDefinition | PopMeasureDefinition | SimpleMeasureDefinition;
|
|
1251
1255
|
export interface MeasureExecutionResultHeader {
|
|
1252
|
-
measureHeader: MeasureResultHeader;
|
|
1256
|
+
'measureHeader': MeasureResultHeader;
|
|
1253
1257
|
}
|
|
1254
1258
|
/**
|
|
1255
1259
|
* Measure group headers
|
|
1256
1260
|
*/
|
|
1257
1261
|
export interface MeasureGroupHeaders {
|
|
1258
|
-
measureGroupHeaders?: Array<MeasureHeader>;
|
|
1262
|
+
'measureGroupHeaders'?: Array<MeasureHeader>;
|
|
1259
1263
|
}
|
|
1260
1264
|
export interface MeasureHeader {
|
|
1261
1265
|
/**
|
|
1262
1266
|
* Local identifier of the measure this header relates to.
|
|
1263
1267
|
*/
|
|
1264
|
-
localIdentifier: string;
|
|
1268
|
+
'localIdentifier': string;
|
|
1265
1269
|
/**
|
|
1266
1270
|
* Format to be used to format the measure data.
|
|
1267
1271
|
*/
|
|
1268
|
-
format?: string;
|
|
1272
|
+
'format'?: string;
|
|
1269
1273
|
/**
|
|
1270
1274
|
* Name of the measure.
|
|
1271
1275
|
*/
|
|
1272
|
-
name?: string;
|
|
1276
|
+
'name'?: string;
|
|
1273
1277
|
}
|
|
1274
1278
|
/**
|
|
1275
1279
|
* Metric is a quantity that is calculated from the data.
|
|
@@ -1278,8 +1282,8 @@ export interface MeasureItem {
|
|
|
1278
1282
|
/**
|
|
1279
1283
|
* Local identifier of the metric. This can be used to reference the metric in other parts of the execution definition.
|
|
1280
1284
|
*/
|
|
1281
|
-
localIdentifier: string;
|
|
1282
|
-
definition: MeasureDefinition;
|
|
1285
|
+
'localIdentifier': string;
|
|
1286
|
+
'definition': MeasureDefinition;
|
|
1283
1287
|
}
|
|
1284
1288
|
/**
|
|
1285
1289
|
* Header containing the information related to metrics.
|
|
@@ -1288,7 +1292,7 @@ export interface MeasureResultHeader {
|
|
|
1288
1292
|
/**
|
|
1289
1293
|
* Metric index. Starts at 0.
|
|
1290
1294
|
*/
|
|
1291
|
-
measureIndex: number;
|
|
1295
|
+
'measureIndex': number;
|
|
1292
1296
|
}
|
|
1293
1297
|
/**
|
|
1294
1298
|
* @type MeasureValueCondition
|
|
@@ -1304,11 +1308,11 @@ export interface MemoryItemCreatedByUsers {
|
|
|
1304
1308
|
/**
|
|
1305
1309
|
* Users who created memory item
|
|
1306
1310
|
*/
|
|
1307
|
-
users: Array<MemoryItemUser>;
|
|
1311
|
+
'users': Array<MemoryItemUser>;
|
|
1308
1312
|
/**
|
|
1309
1313
|
* Reasoning for error states
|
|
1310
1314
|
*/
|
|
1311
|
-
reasoning: string;
|
|
1315
|
+
'reasoning': string;
|
|
1312
1316
|
}
|
|
1313
1317
|
/**
|
|
1314
1318
|
* Users who created memory item
|
|
@@ -1317,15 +1321,15 @@ export interface MemoryItemUser {
|
|
|
1317
1321
|
/**
|
|
1318
1322
|
* User ID of the user who created memory item
|
|
1319
1323
|
*/
|
|
1320
|
-
userId: string;
|
|
1324
|
+
'userId': string;
|
|
1321
1325
|
/**
|
|
1322
1326
|
* First name of the user who created memory item
|
|
1323
1327
|
*/
|
|
1324
|
-
firstname: string;
|
|
1328
|
+
'firstname': string;
|
|
1325
1329
|
/**
|
|
1326
1330
|
* Last name of the user who created memory item
|
|
1327
1331
|
*/
|
|
1328
|
-
lastname: string;
|
|
1332
|
+
'lastname': string;
|
|
1329
1333
|
}
|
|
1330
1334
|
/**
|
|
1331
1335
|
* List of metrics to be used in the new visualization
|
|
@@ -1334,22 +1338,22 @@ export interface Metric {
|
|
|
1334
1338
|
/**
|
|
1335
1339
|
* ID of the object
|
|
1336
1340
|
*/
|
|
1337
|
-
id: string;
|
|
1341
|
+
'id': string;
|
|
1338
1342
|
/**
|
|
1339
1343
|
* Object type
|
|
1340
1344
|
*/
|
|
1341
|
-
type: MetricTypeEnum;
|
|
1345
|
+
'type': MetricTypeEnum;
|
|
1342
1346
|
/**
|
|
1343
1347
|
* Title of metric.
|
|
1344
1348
|
*/
|
|
1345
|
-
title: string;
|
|
1349
|
+
'title': string;
|
|
1346
1350
|
/**
|
|
1347
1351
|
* Agg function. Empty if a stored metric is used.
|
|
1348
1352
|
*/
|
|
1349
|
-
aggFunction?: MetricAggFunctionEnum;
|
|
1353
|
+
'aggFunction'?: MetricAggFunctionEnum;
|
|
1350
1354
|
}
|
|
1351
|
-
export type MetricTypeEnum =
|
|
1352
|
-
export type MetricAggFunctionEnum =
|
|
1355
|
+
export type MetricTypeEnum = 'metric' | 'fact' | 'attribute';
|
|
1356
|
+
export type MetricAggFunctionEnum = 'COUNT' | 'SUM' | 'MIN' | 'MAX' | 'AVG' | 'MEDIAN';
|
|
1353
1357
|
/**
|
|
1354
1358
|
* Individual change analysis data item
|
|
1355
1359
|
*/
|
|
@@ -1357,59 +1361,59 @@ export interface MetricValueChange {
|
|
|
1357
1361
|
/**
|
|
1358
1362
|
* The name of the attribute being analyzed
|
|
1359
1363
|
*/
|
|
1360
|
-
attributeName: string;
|
|
1364
|
+
'attributeName': string;
|
|
1361
1365
|
/**
|
|
1362
1366
|
* The value of the attribute being analyzed
|
|
1363
1367
|
*/
|
|
1364
|
-
attributeValue: string;
|
|
1368
|
+
'attributeValue': string;
|
|
1365
1369
|
/**
|
|
1366
1370
|
* The metric value in the analyzed period
|
|
1367
1371
|
*/
|
|
1368
|
-
metricValueInAnalyzedPeriod: number;
|
|
1372
|
+
'metricValueInAnalyzedPeriod': number;
|
|
1369
1373
|
/**
|
|
1370
1374
|
* The metric value in the reference period
|
|
1371
1375
|
*/
|
|
1372
|
-
metricValueInReferencePeriod: number;
|
|
1376
|
+
'metricValueInReferencePeriod': number;
|
|
1373
1377
|
/**
|
|
1374
1378
|
* The delta between analyzed and reference periods
|
|
1375
1379
|
*/
|
|
1376
|
-
metricValueDelta: number;
|
|
1380
|
+
'metricValueDelta': number;
|
|
1377
1381
|
/**
|
|
1378
1382
|
* The absolute delta between analyzed and reference periods
|
|
1379
1383
|
*/
|
|
1380
|
-
metricValueDeltaAbs: number;
|
|
1384
|
+
'metricValueDeltaAbs': number;
|
|
1381
1385
|
/**
|
|
1382
1386
|
* The mean of attribute value changes for the attribute being analyzed
|
|
1383
1387
|
*/
|
|
1384
|
-
attributeValuesChangeMean: number;
|
|
1388
|
+
'attributeValuesChangeMean': number;
|
|
1385
1389
|
/**
|
|
1386
1390
|
* The standard deviation of attribute value changes for the attribute being analyzed
|
|
1387
1391
|
*/
|
|
1388
|
-
attributeValuesChangeStd: number;
|
|
1392
|
+
'attributeValuesChangeStd': number;
|
|
1389
1393
|
/**
|
|
1390
1394
|
* Whether the change is statistically significant
|
|
1391
1395
|
*/
|
|
1392
|
-
isSignificantChange: boolean;
|
|
1396
|
+
'isSignificantChange': boolean;
|
|
1393
1397
|
/**
|
|
1394
1398
|
* The overall metric value in the analyzed period
|
|
1395
1399
|
*/
|
|
1396
|
-
overallMetricValueInAnalyzedPeriod: number;
|
|
1400
|
+
'overallMetricValueInAnalyzedPeriod': number;
|
|
1397
1401
|
/**
|
|
1398
1402
|
* The overall metric value in the reference period
|
|
1399
1403
|
*/
|
|
1400
|
-
overallMetricValueInReferencePeriod: number;
|
|
1404
|
+
'overallMetricValueInReferencePeriod': number;
|
|
1401
1405
|
}
|
|
1402
1406
|
/**
|
|
1403
1407
|
* Filter able to limit element values by label and related selected negated elements.
|
|
1404
1408
|
*/
|
|
1405
1409
|
export interface NegativeAttributeFilter {
|
|
1406
|
-
negativeAttributeFilter: NegativeAttributeFilterNegativeAttributeFilter;
|
|
1410
|
+
'negativeAttributeFilter': NegativeAttributeFilterNegativeAttributeFilter;
|
|
1407
1411
|
}
|
|
1408
1412
|
export interface NegativeAttributeFilterNegativeAttributeFilter {
|
|
1409
|
-
notIn: AttributeFilterElements;
|
|
1410
|
-
localIdentifier?: string;
|
|
1411
|
-
applyOnResult?: boolean;
|
|
1412
|
-
label: AfmIdentifier;
|
|
1413
|
+
'notIn': AttributeFilterElements;
|
|
1414
|
+
'localIdentifier'?: string;
|
|
1415
|
+
'applyOnResult'?: boolean;
|
|
1416
|
+
'label': AfmIdentifier;
|
|
1413
1417
|
}
|
|
1414
1418
|
/**
|
|
1415
1419
|
* Represents a Long-Running Operation: a process that takes some time to complete.
|
|
@@ -1418,14 +1422,14 @@ export interface Operation {
|
|
|
1418
1422
|
/**
|
|
1419
1423
|
* Id of the operation
|
|
1420
1424
|
*/
|
|
1421
|
-
id: string;
|
|
1425
|
+
'id': string;
|
|
1422
1426
|
/**
|
|
1423
1427
|
* Type of the long-running operation. * `provision-database` — Provisioning of an AI Lake database. * `deprovision-database` — Deprovisioning (deletion) of an AI Lake database.
|
|
1424
1428
|
*/
|
|
1425
|
-
kind: OperationKindEnum;
|
|
1426
|
-
status: string;
|
|
1429
|
+
'kind': OperationKindEnum;
|
|
1430
|
+
'status': string;
|
|
1427
1431
|
}
|
|
1428
|
-
export type OperationKindEnum =
|
|
1432
|
+
export type OperationKindEnum = 'provision-database' | 'deprovision-database';
|
|
1429
1433
|
/**
|
|
1430
1434
|
* Error information for a failed operation
|
|
1431
1435
|
*/
|
|
@@ -1433,57 +1437,57 @@ export interface OperationError {
|
|
|
1433
1437
|
/**
|
|
1434
1438
|
* Human-readable error details
|
|
1435
1439
|
*/
|
|
1436
|
-
detail: string;
|
|
1440
|
+
'detail': string;
|
|
1437
1441
|
/**
|
|
1438
1442
|
* HTTP status code
|
|
1439
1443
|
*/
|
|
1440
|
-
status: number;
|
|
1444
|
+
'status': number;
|
|
1441
1445
|
/**
|
|
1442
1446
|
* Human-readable error name
|
|
1443
1447
|
*/
|
|
1444
|
-
title: string;
|
|
1448
|
+
'title': string;
|
|
1445
1449
|
}
|
|
1446
1450
|
export interface OutlierDetectionRequest {
|
|
1447
1451
|
/**
|
|
1448
1452
|
* Attributes to be used in the computation.
|
|
1449
1453
|
*/
|
|
1450
|
-
attributes: Array<AttributeItem>;
|
|
1454
|
+
'attributes': Array<AttributeItem>;
|
|
1451
1455
|
/**
|
|
1452
1456
|
* Various filter types to filter the execution result.
|
|
1453
1457
|
*/
|
|
1454
|
-
filters: Array<OutlierDetectionRequestFiltersInner>;
|
|
1455
|
-
measures: Array<MeasureItem>;
|
|
1458
|
+
'filters': Array<OutlierDetectionRequestFiltersInner>;
|
|
1459
|
+
'measures': Array<MeasureItem>;
|
|
1456
1460
|
/**
|
|
1457
1461
|
* Metrics to be referenced from other AFM objects (e.g. filters) but not included in the result.
|
|
1458
1462
|
*/
|
|
1459
|
-
auxMeasures?: Array<MeasureItem>;
|
|
1463
|
+
'auxMeasures'?: Array<MeasureItem>;
|
|
1460
1464
|
/**
|
|
1461
1465
|
* Sensitivity level for outlier detection
|
|
1462
1466
|
*/
|
|
1463
|
-
sensitivity: OutlierDetectionRequestSensitivityEnum;
|
|
1467
|
+
'sensitivity': OutlierDetectionRequestSensitivityEnum;
|
|
1464
1468
|
/**
|
|
1465
1469
|
* Date granularity for anomaly detection. Only time-based granularities are supported (HOUR, DAY, WEEK, MONTH, QUARTER, YEAR).
|
|
1466
1470
|
*/
|
|
1467
|
-
granularity: OutlierDetectionRequestGranularityEnum;
|
|
1471
|
+
'granularity': OutlierDetectionRequestGranularityEnum;
|
|
1468
1472
|
}
|
|
1469
|
-
export type OutlierDetectionRequestSensitivityEnum =
|
|
1470
|
-
export type OutlierDetectionRequestGranularityEnum =
|
|
1473
|
+
export type OutlierDetectionRequestSensitivityEnum = 'LOW' | 'MEDIUM' | 'HIGH';
|
|
1474
|
+
export type OutlierDetectionRequestGranularityEnum = 'HOUR' | 'DAY' | 'WEEK' | 'MONTH' | 'QUARTER' | 'YEAR';
|
|
1471
1475
|
/**
|
|
1472
1476
|
* @type OutlierDetectionRequestFiltersInner
|
|
1473
1477
|
*/
|
|
1474
1478
|
export type OutlierDetectionRequestFiltersInner = AbstractMeasureValueFilter | FilterDefinitionForSimpleMeasure | InlineFilterDefinition;
|
|
1475
1479
|
export interface OutlierDetectionResponse {
|
|
1476
|
-
links: ExecutionLinks;
|
|
1480
|
+
'links': ExecutionLinks;
|
|
1477
1481
|
}
|
|
1478
1482
|
export interface OutlierDetectionResult {
|
|
1479
1483
|
/**
|
|
1480
1484
|
* Attribute values for outlier detection results.
|
|
1481
1485
|
*/
|
|
1482
|
-
attribute: Array<string> | null;
|
|
1486
|
+
'attribute': Array<string> | null;
|
|
1483
1487
|
/**
|
|
1484
1488
|
* Map of measure identifiers to their outlier detection values. Each value is a list of nullable numbers.
|
|
1485
1489
|
*/
|
|
1486
|
-
values: {
|
|
1490
|
+
'values': {
|
|
1487
1491
|
[key: string]: Array<number | null> | null;
|
|
1488
1492
|
} | null;
|
|
1489
1493
|
}
|
|
@@ -1494,19 +1498,19 @@ export interface Paging {
|
|
|
1494
1498
|
/**
|
|
1495
1499
|
* Count of returnable items ignoring paging.
|
|
1496
1500
|
*/
|
|
1497
|
-
total: number;
|
|
1501
|
+
'total': number;
|
|
1498
1502
|
/**
|
|
1499
1503
|
* Count of items in this page.
|
|
1500
1504
|
*/
|
|
1501
|
-
count: number;
|
|
1505
|
+
'count': number;
|
|
1502
1506
|
/**
|
|
1503
1507
|
* Offset of this page.
|
|
1504
1508
|
*/
|
|
1505
|
-
offset: number;
|
|
1509
|
+
'offset': number;
|
|
1506
1510
|
/**
|
|
1507
1511
|
* Link to next page, or null if this is last page.
|
|
1508
1512
|
*/
|
|
1509
|
-
next?: string;
|
|
1513
|
+
'next'?: string;
|
|
1510
1514
|
}
|
|
1511
1515
|
/**
|
|
1512
1516
|
* Operation that is still pending
|
|
@@ -1517,47 +1521,47 @@ export interface PendingOperation extends Operation {
|
|
|
1517
1521
|
* Combination of the date data set to use and how many periods ago to calculate the previous period for.
|
|
1518
1522
|
*/
|
|
1519
1523
|
export interface PopDataset {
|
|
1520
|
-
dataset: AfmObjectIdentifierDataset;
|
|
1524
|
+
'dataset': AfmObjectIdentifierDataset;
|
|
1521
1525
|
/**
|
|
1522
1526
|
* Number of periods ago to calculate the previous period for.
|
|
1523
1527
|
*/
|
|
1524
|
-
periodsAgo: number;
|
|
1528
|
+
'periodsAgo': number;
|
|
1525
1529
|
}
|
|
1526
1530
|
/**
|
|
1527
1531
|
* Previous period type of metric.
|
|
1528
1532
|
*/
|
|
1529
1533
|
export interface PopDatasetMeasureDefinition {
|
|
1530
|
-
previousPeriodMeasure: PopDatasetMeasureDefinitionPreviousPeriodMeasure;
|
|
1534
|
+
'previousPeriodMeasure': PopDatasetMeasureDefinitionPreviousPeriodMeasure;
|
|
1531
1535
|
}
|
|
1532
1536
|
export interface PopDatasetMeasureDefinitionPreviousPeriodMeasure {
|
|
1533
|
-
measureIdentifier: AfmLocalIdentifier;
|
|
1537
|
+
'measureIdentifier': AfmLocalIdentifier;
|
|
1534
1538
|
/**
|
|
1535
1539
|
* Specification of which date data sets to use for determining the period to calculate the previous period for.
|
|
1536
1540
|
*/
|
|
1537
|
-
dateDatasets: Array<PopDataset>;
|
|
1541
|
+
'dateDatasets': Array<PopDataset>;
|
|
1538
1542
|
}
|
|
1539
1543
|
/**
|
|
1540
1544
|
* Combination of the date attribute to use and how many periods ago to calculate the PoP for.
|
|
1541
1545
|
*/
|
|
1542
1546
|
export interface PopDate {
|
|
1543
|
-
attribute: AfmObjectIdentifierAttribute;
|
|
1547
|
+
'attribute': AfmObjectIdentifierAttribute;
|
|
1544
1548
|
/**
|
|
1545
1549
|
* Number of periods ago to calculate the previous period for.
|
|
1546
1550
|
*/
|
|
1547
|
-
periodsAgo: number;
|
|
1551
|
+
'periodsAgo': number;
|
|
1548
1552
|
}
|
|
1549
1553
|
/**
|
|
1550
1554
|
* Period over period type of metric.
|
|
1551
1555
|
*/
|
|
1552
1556
|
export interface PopDateMeasureDefinition {
|
|
1553
|
-
overPeriodMeasure: PopDateMeasureDefinitionOverPeriodMeasure;
|
|
1557
|
+
'overPeriodMeasure': PopDateMeasureDefinitionOverPeriodMeasure;
|
|
1554
1558
|
}
|
|
1555
1559
|
export interface PopDateMeasureDefinitionOverPeriodMeasure {
|
|
1556
|
-
measureIdentifier: AfmLocalIdentifier;
|
|
1560
|
+
'measureIdentifier': AfmLocalIdentifier;
|
|
1557
1561
|
/**
|
|
1558
1562
|
* Attributes to use for determining the period to calculate the PoP for.
|
|
1559
1563
|
*/
|
|
1560
|
-
dateAttributes: Array<PopDate>;
|
|
1564
|
+
'dateAttributes': Array<PopDate>;
|
|
1561
1565
|
}
|
|
1562
1566
|
/**
|
|
1563
1567
|
* @type PopMeasureDefinition
|
|
@@ -1567,13 +1571,13 @@ export type PopMeasureDefinition = PopDatasetMeasureDefinition | PopDateMeasureD
|
|
|
1567
1571
|
* Filter able to limit element values by label and related selected elements.
|
|
1568
1572
|
*/
|
|
1569
1573
|
export interface PositiveAttributeFilter {
|
|
1570
|
-
positiveAttributeFilter: PositiveAttributeFilterPositiveAttributeFilter;
|
|
1574
|
+
'positiveAttributeFilter': PositiveAttributeFilterPositiveAttributeFilter;
|
|
1571
1575
|
}
|
|
1572
1576
|
export interface PositiveAttributeFilterPositiveAttributeFilter {
|
|
1573
|
-
in: AttributeFilterElements;
|
|
1574
|
-
localIdentifier?: string;
|
|
1575
|
-
applyOnResult?: boolean;
|
|
1576
|
-
label: AfmIdentifier;
|
|
1577
|
+
'in': AttributeFilterElements;
|
|
1578
|
+
'localIdentifier'?: string;
|
|
1579
|
+
'applyOnResult'?: boolean;
|
|
1580
|
+
'label': AfmIdentifier;
|
|
1577
1581
|
}
|
|
1578
1582
|
/**
|
|
1579
1583
|
* Request to provision a new AILake Database instance
|
|
@@ -1582,11 +1586,11 @@ export interface ProvisionDatabaseInstanceRequest {
|
|
|
1582
1586
|
/**
|
|
1583
1587
|
* Name of the database instance
|
|
1584
1588
|
*/
|
|
1585
|
-
name: string;
|
|
1589
|
+
'name': string;
|
|
1586
1590
|
/**
|
|
1587
1591
|
* Set of ids of the storage instances this database instance should access.
|
|
1588
1592
|
*/
|
|
1589
|
-
storageIds: Array<string>;
|
|
1593
|
+
'storageIds': Array<string>;
|
|
1590
1594
|
}
|
|
1591
1595
|
/**
|
|
1592
1596
|
* List of quality issues (available when status is COMPLETED)
|
|
@@ -1595,27 +1599,27 @@ export interface QualityIssue {
|
|
|
1595
1599
|
/**
|
|
1596
1600
|
* Unique identifier for the quality issue
|
|
1597
1601
|
*/
|
|
1598
|
-
id: string;
|
|
1602
|
+
'id': string;
|
|
1599
1603
|
/**
|
|
1600
1604
|
* List of objects affected by this quality issue
|
|
1601
1605
|
*/
|
|
1602
|
-
objects: Array<QualityIssueObject>;
|
|
1606
|
+
'objects': Array<QualityIssueObject>;
|
|
1603
1607
|
/**
|
|
1604
1608
|
* Severity level
|
|
1605
1609
|
*/
|
|
1606
|
-
severity: QualityIssueSeverityEnum;
|
|
1610
|
+
'severity': QualityIssueSeverityEnum;
|
|
1607
1611
|
/**
|
|
1608
1612
|
* Quality issue code
|
|
1609
1613
|
*/
|
|
1610
|
-
code: string;
|
|
1614
|
+
'code': string;
|
|
1611
1615
|
/**
|
|
1612
1616
|
* Detailed information about the quality issue
|
|
1613
1617
|
*/
|
|
1614
|
-
detail: {
|
|
1618
|
+
'detail': {
|
|
1615
1619
|
[key: string]: object;
|
|
1616
1620
|
};
|
|
1617
1621
|
}
|
|
1618
|
-
export type QualityIssueSeverityEnum =
|
|
1622
|
+
export type QualityIssueSeverityEnum = 'WARNING' | 'INFO';
|
|
1619
1623
|
/**
|
|
1620
1624
|
* List of objects affected by this quality issue
|
|
1621
1625
|
*/
|
|
@@ -1623,97 +1627,97 @@ export interface QualityIssueObject {
|
|
|
1623
1627
|
/**
|
|
1624
1628
|
* Object type
|
|
1625
1629
|
*/
|
|
1626
|
-
type: string;
|
|
1630
|
+
'type': string;
|
|
1627
1631
|
/**
|
|
1628
1632
|
* Object ID
|
|
1629
1633
|
*/
|
|
1630
|
-
id: string;
|
|
1634
|
+
'id': string;
|
|
1631
1635
|
/**
|
|
1632
1636
|
* Workspace ID where the object belongs
|
|
1633
1637
|
*/
|
|
1634
|
-
workspaceId: string;
|
|
1638
|
+
'workspaceId': string;
|
|
1635
1639
|
/**
|
|
1636
1640
|
* Object title
|
|
1637
1641
|
*/
|
|
1638
|
-
title: string;
|
|
1642
|
+
'title': string;
|
|
1639
1643
|
}
|
|
1640
1644
|
export interface QualityIssuesCalculationStatusResponse {
|
|
1641
1645
|
/**
|
|
1642
1646
|
* Current status of the calculation
|
|
1643
1647
|
*/
|
|
1644
|
-
status: QualityIssuesCalculationStatusResponseStatusEnum;
|
|
1648
|
+
'status': QualityIssuesCalculationStatusResponseStatusEnum;
|
|
1645
1649
|
/**
|
|
1646
1650
|
* List of quality issues (available when status is COMPLETED)
|
|
1647
1651
|
*/
|
|
1648
|
-
issues?: Array<QualityIssue>;
|
|
1652
|
+
'issues'?: Array<QualityIssue>;
|
|
1649
1653
|
/**
|
|
1650
1654
|
* Error message (available when status is FAILED or NOT_FOUND)
|
|
1651
1655
|
*/
|
|
1652
|
-
error?: string;
|
|
1656
|
+
'error'?: string;
|
|
1653
1657
|
}
|
|
1654
|
-
export type QualityIssuesCalculationStatusResponseStatusEnum =
|
|
1658
|
+
export type QualityIssuesCalculationStatusResponseStatusEnum = 'RUNNING' | 'SYNCING' | 'COMPLETED' | 'FAILED' | 'NOT_FOUND' | 'DISABLED';
|
|
1655
1659
|
/**
|
|
1656
1660
|
* Condition that checks if the metric value is within a given range.
|
|
1657
1661
|
*/
|
|
1658
1662
|
export interface RangeCondition {
|
|
1659
|
-
range: RangeConditionRange;
|
|
1663
|
+
'range': RangeConditionRange;
|
|
1660
1664
|
}
|
|
1661
1665
|
export interface RangeConditionRange {
|
|
1662
|
-
operator: RangeConditionRangeOperatorEnum;
|
|
1663
|
-
from: number;
|
|
1664
|
-
to: number;
|
|
1666
|
+
'operator': RangeConditionRangeOperatorEnum;
|
|
1667
|
+
'from': number;
|
|
1668
|
+
'to': number;
|
|
1665
1669
|
}
|
|
1666
|
-
export type RangeConditionRangeOperatorEnum =
|
|
1670
|
+
export type RangeConditionRangeOperatorEnum = 'BETWEEN' | 'NOT_BETWEEN';
|
|
1667
1671
|
/**
|
|
1668
1672
|
* Filter the result by comparing specified metric to given range of values.
|
|
1669
1673
|
*/
|
|
1670
1674
|
export interface RangeMeasureValueFilter {
|
|
1671
|
-
rangeMeasureValueFilter: RangeMeasureValueFilterRangeMeasureValueFilter;
|
|
1675
|
+
'rangeMeasureValueFilter': RangeMeasureValueFilterRangeMeasureValueFilter;
|
|
1672
1676
|
}
|
|
1673
1677
|
export interface RangeMeasureValueFilterRangeMeasureValueFilter {
|
|
1674
1678
|
/**
|
|
1675
1679
|
* References to the attributes to be used when filtering.
|
|
1676
1680
|
*/
|
|
1677
|
-
dimensionality?: Array<AfmIdentifier>;
|
|
1681
|
+
'dimensionality'?: Array<AfmIdentifier>;
|
|
1678
1682
|
/**
|
|
1679
1683
|
* A value that will be substituted for null values in the metric for the comparisons.
|
|
1680
1684
|
*/
|
|
1681
|
-
treatNullValuesAs?: number;
|
|
1682
|
-
operator: RangeMeasureValueFilterRangeMeasureValueFilterOperatorEnum;
|
|
1683
|
-
from: number;
|
|
1684
|
-
to: number;
|
|
1685
|
-
localIdentifier?: string;
|
|
1686
|
-
applyOnResult?: boolean;
|
|
1687
|
-
measure: AfmIdentifier;
|
|
1685
|
+
'treatNullValuesAs'?: number;
|
|
1686
|
+
'operator': RangeMeasureValueFilterRangeMeasureValueFilterOperatorEnum;
|
|
1687
|
+
'from': number;
|
|
1688
|
+
'to': number;
|
|
1689
|
+
'localIdentifier'?: string;
|
|
1690
|
+
'applyOnResult'?: boolean;
|
|
1691
|
+
'measure': AfmIdentifier;
|
|
1688
1692
|
}
|
|
1689
|
-
export type RangeMeasureValueFilterRangeMeasureValueFilterOperatorEnum =
|
|
1693
|
+
export type RangeMeasureValueFilterRangeMeasureValueFilterOperatorEnum = 'BETWEEN' | 'NOT_BETWEEN';
|
|
1690
1694
|
/**
|
|
1691
1695
|
* Filter the result on top/bottom N values according to given metric(s).
|
|
1692
1696
|
*/
|
|
1693
1697
|
export interface RankingFilter {
|
|
1694
|
-
rankingFilter: RankingFilterRankingFilter;
|
|
1698
|
+
'rankingFilter': RankingFilterRankingFilter;
|
|
1695
1699
|
}
|
|
1696
1700
|
export interface RankingFilterRankingFilter {
|
|
1697
1701
|
/**
|
|
1698
1702
|
* References to the attributes to be used when filtering.
|
|
1699
1703
|
*/
|
|
1700
|
-
dimensionality?: Array<AfmIdentifier>;
|
|
1704
|
+
'dimensionality'?: Array<AfmIdentifier>;
|
|
1701
1705
|
/**
|
|
1702
1706
|
* References to the metrics to be used when filtering.
|
|
1703
1707
|
*/
|
|
1704
|
-
measures: Array<AfmIdentifier>;
|
|
1708
|
+
'measures': Array<AfmIdentifier>;
|
|
1705
1709
|
/**
|
|
1706
1710
|
* The type of ranking to use, TOP or BOTTOM.
|
|
1707
1711
|
*/
|
|
1708
|
-
operator: RankingFilterRankingFilterOperatorEnum;
|
|
1712
|
+
'operator': RankingFilterRankingFilterOperatorEnum;
|
|
1709
1713
|
/**
|
|
1710
1714
|
* Number of top/bottom values to filter.
|
|
1711
1715
|
*/
|
|
1712
|
-
value: number;
|
|
1713
|
-
localIdentifier?: string;
|
|
1714
|
-
applyOnResult?: boolean;
|
|
1716
|
+
'value': number;
|
|
1717
|
+
'localIdentifier'?: string;
|
|
1718
|
+
'applyOnResult'?: boolean;
|
|
1715
1719
|
}
|
|
1716
|
-
export type RankingFilterRankingFilterOperatorEnum =
|
|
1720
|
+
export type RankingFilterRankingFilterOperatorEnum = 'TOP' | 'BOTTOM';
|
|
1717
1721
|
/**
|
|
1718
1722
|
* Reasoning wrapper containing steps taken during request handling.
|
|
1719
1723
|
*/
|
|
@@ -1721,11 +1725,11 @@ export interface Reasoning {
|
|
|
1721
1725
|
/**
|
|
1722
1726
|
* Steps taken during processing, showing the AI\'s reasoning process.
|
|
1723
1727
|
*/
|
|
1724
|
-
steps: Array<ReasoningStep>;
|
|
1728
|
+
'steps': Array<ReasoningStep>;
|
|
1725
1729
|
/**
|
|
1726
1730
|
* Final answer/reasoning from the use case result.
|
|
1727
1731
|
*/
|
|
1728
|
-
answer?: string;
|
|
1732
|
+
'answer'?: string;
|
|
1729
1733
|
}
|
|
1730
1734
|
/**
|
|
1731
1735
|
* Steps taken during processing, showing the AI\'s reasoning process.
|
|
@@ -1734,79 +1738,79 @@ export interface ReasoningStep {
|
|
|
1734
1738
|
/**
|
|
1735
1739
|
* Title describing this reasoning step.
|
|
1736
1740
|
*/
|
|
1737
|
-
title: string;
|
|
1741
|
+
'title': string;
|
|
1738
1742
|
/**
|
|
1739
1743
|
* Detailed thoughts/messages within this step.
|
|
1740
1744
|
*/
|
|
1741
|
-
thoughts: Array<Thought>;
|
|
1745
|
+
'thoughts': Array<Thought>;
|
|
1742
1746
|
}
|
|
1743
1747
|
/**
|
|
1744
1748
|
* 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.
|
|
1745
1749
|
*/
|
|
1746
1750
|
export interface RelativeDateFilter {
|
|
1747
|
-
relativeDateFilter: RelativeDateFilterRelativeDateFilter;
|
|
1751
|
+
'relativeDateFilter': RelativeDateFilterRelativeDateFilter;
|
|
1748
1752
|
}
|
|
1749
1753
|
export interface RelativeDateFilterRelativeDateFilter {
|
|
1750
1754
|
/**
|
|
1751
1755
|
* Date granularity specifying particular date attribute in given dimension.
|
|
1752
1756
|
*/
|
|
1753
|
-
granularity: RelativeDateFilterRelativeDateFilterGranularityEnum;
|
|
1757
|
+
'granularity': RelativeDateFilterRelativeDateFilterGranularityEnum;
|
|
1754
1758
|
/**
|
|
1755
1759
|
* 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\').
|
|
1756
1760
|
*/
|
|
1757
|
-
from: number;
|
|
1761
|
+
'from': number;
|
|
1758
1762
|
/**
|
|
1759
1763
|
* 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, ...).
|
|
1760
1764
|
*/
|
|
1761
|
-
to: number;
|
|
1762
|
-
localIdentifier?: string;
|
|
1763
|
-
applyOnResult?: boolean;
|
|
1764
|
-
boundedFilter?: BoundedFilter;
|
|
1765
|
+
'to': number;
|
|
1766
|
+
'localIdentifier'?: string;
|
|
1767
|
+
'applyOnResult'?: boolean;
|
|
1768
|
+
'boundedFilter'?: BoundedFilter;
|
|
1765
1769
|
/**
|
|
1766
1770
|
* If true, rows with undefined (NULL) date values will be included in the result. The filter becomes: (date_condition) OR (date IS NULL). If false or not set, standard behavior applies (NULLs excluded by the date condition).
|
|
1767
1771
|
*/
|
|
1768
|
-
includeEmptyValues?: boolean;
|
|
1769
|
-
dataset: AfmObjectIdentifierDataset;
|
|
1772
|
+
'includeEmptyValues'?: boolean;
|
|
1773
|
+
'dataset': AfmObjectIdentifierDataset;
|
|
1770
1774
|
}
|
|
1771
|
-
export type RelativeDateFilterRelativeDateFilterGranularityEnum =
|
|
1775
|
+
export type RelativeDateFilterRelativeDateFilterGranularityEnum = 'MINUTE' | 'HOUR' | 'DAY' | 'WEEK' | 'MONTH' | 'QUARTER' | 'YEAR' | 'MINUTE_OF_HOUR' | 'HOUR_OF_DAY' | 'DAY_OF_WEEK' | 'DAY_OF_MONTH' | 'DAY_OF_QUARTER' | 'DAY_OF_YEAR' | 'WEEK_OF_YEAR' | 'MONTH_OF_YEAR' | 'QUARTER_OF_YEAR' | 'FISCAL_MONTH' | 'FISCAL_QUARTER' | 'FISCAL_YEAR';
|
|
1772
1776
|
export interface ResolvedLlmEndpoint {
|
|
1773
1777
|
/**
|
|
1774
1778
|
* Endpoint Id
|
|
1775
1779
|
*/
|
|
1776
|
-
id: string;
|
|
1780
|
+
'id': string;
|
|
1777
1781
|
/**
|
|
1778
1782
|
* Endpoint Title
|
|
1779
1783
|
*/
|
|
1780
|
-
title: string;
|
|
1784
|
+
'title': string;
|
|
1781
1785
|
}
|
|
1782
1786
|
export interface ResolvedLlmEndpoints {
|
|
1783
|
-
data: Array<ResolvedLlmEndpoint>;
|
|
1787
|
+
'data': Array<ResolvedLlmEndpoint>;
|
|
1784
1788
|
}
|
|
1785
1789
|
/**
|
|
1786
1790
|
* Object identifier.
|
|
1787
1791
|
*/
|
|
1788
1792
|
export interface RestApiIdentifier {
|
|
1789
|
-
id: string;
|
|
1790
|
-
type: string;
|
|
1793
|
+
'id': string;
|
|
1794
|
+
'type': string;
|
|
1791
1795
|
}
|
|
1792
1796
|
/**
|
|
1793
1797
|
* All execution result\'s metadata used for calculation including ExecutionResponse
|
|
1794
1798
|
*/
|
|
1795
1799
|
export interface ResultCacheMetadata {
|
|
1796
|
-
afm: AFM;
|
|
1797
|
-
executionResponse: ExecutionResponse;
|
|
1798
|
-
resultSpec: ResultSpec;
|
|
1799
|
-
resultSize: number;
|
|
1800
|
+
'afm': AFM;
|
|
1801
|
+
'executionResponse': ExecutionResponse;
|
|
1802
|
+
'resultSpec': ResultSpec;
|
|
1803
|
+
'resultSize': number;
|
|
1800
1804
|
}
|
|
1801
1805
|
/**
|
|
1802
1806
|
* Single result dimension
|
|
1803
1807
|
*/
|
|
1804
1808
|
export interface ResultDimension {
|
|
1805
|
-
headers: Array<ResultDimensionHeader>;
|
|
1809
|
+
'headers': Array<ResultDimensionHeader>;
|
|
1806
1810
|
/**
|
|
1807
1811
|
* Local identifier of the dimension.
|
|
1808
1812
|
*/
|
|
1809
|
-
localIdentifier: string;
|
|
1813
|
+
'localIdentifier': string;
|
|
1810
1814
|
}
|
|
1811
1815
|
/**
|
|
1812
1816
|
* @type ResultDimensionHeader
|
|
@@ -1817,8 +1821,8 @@ export type ResultDimensionHeader = AttributeHeader | MeasureGroupHeaders;
|
|
|
1817
1821
|
* Specifies how the result data will be formatted (```dimensions```) and which additional data shall be computed (```totals```).
|
|
1818
1822
|
*/
|
|
1819
1823
|
export interface ResultSpec {
|
|
1820
|
-
dimensions: Array<Dimension>;
|
|
1821
|
-
totals?: Array<Total>;
|
|
1824
|
+
'dimensions': Array<Dimension>;
|
|
1825
|
+
'totals'?: Array<Total>;
|
|
1822
1826
|
}
|
|
1823
1827
|
/**
|
|
1824
1828
|
* Question -> Use Case routing. May contain final answer is a special use case is not required.
|
|
@@ -1827,13 +1831,13 @@ export interface RouteResult {
|
|
|
1827
1831
|
/**
|
|
1828
1832
|
* Use case where LLM routed based on question.
|
|
1829
1833
|
*/
|
|
1830
|
-
useCase: RouteResultUseCaseEnum;
|
|
1834
|
+
'useCase': RouteResultUseCaseEnum;
|
|
1831
1835
|
/**
|
|
1832
1836
|
* Explanation why LLM picked this use case.
|
|
1833
1837
|
*/
|
|
1834
|
-
reasoning: string;
|
|
1838
|
+
'reasoning': string;
|
|
1835
1839
|
}
|
|
1836
|
-
export type RouteResultUseCaseEnum =
|
|
1840
|
+
export type RouteResultUseCaseEnum = 'INVALID' | 'GENERAL' | 'SEARCH' | 'CREATE_VISUALIZATION' | 'EXTEND_VISUALIZATION' | 'HOWTO' | 'CHANGE_ANALYSIS' | 'ALERT';
|
|
1837
1841
|
/**
|
|
1838
1842
|
* Created and saved visualization IDs.
|
|
1839
1843
|
*/
|
|
@@ -1841,176 +1845,176 @@ export interface SavedVisualization {
|
|
|
1841
1845
|
/**
|
|
1842
1846
|
* Created visualization ID.
|
|
1843
1847
|
*/
|
|
1844
|
-
createdVisualizationId: string;
|
|
1848
|
+
'createdVisualizationId': string;
|
|
1845
1849
|
/**
|
|
1846
1850
|
* Saved visualization ID.
|
|
1847
1851
|
*/
|
|
1848
|
-
savedVisualizationId: string;
|
|
1852
|
+
'savedVisualizationId': string;
|
|
1849
1853
|
}
|
|
1850
1854
|
export interface SearchRelationshipObject {
|
|
1851
1855
|
/**
|
|
1852
1856
|
* Source workspace ID. If relationship is dashboard->visualization, this is the workspace where the dashboard is located.
|
|
1853
1857
|
*/
|
|
1854
|
-
sourceWorkspaceId: string;
|
|
1858
|
+
'sourceWorkspaceId': string;
|
|
1855
1859
|
/**
|
|
1856
1860
|
* Source object ID.
|
|
1857
1861
|
*/
|
|
1858
|
-
sourceObjectId: string;
|
|
1862
|
+
'sourceObjectId': string;
|
|
1859
1863
|
/**
|
|
1860
1864
|
* Source object type, e.g. dashboard.
|
|
1861
1865
|
*/
|
|
1862
|
-
sourceObjectType: string;
|
|
1866
|
+
'sourceObjectType': string;
|
|
1863
1867
|
/**
|
|
1864
1868
|
* Source object title.
|
|
1865
1869
|
*/
|
|
1866
|
-
sourceObjectTitle: string;
|
|
1870
|
+
'sourceObjectTitle': string;
|
|
1867
1871
|
/**
|
|
1868
1872
|
* Target workspace ID. If relationship is dashboard->visualization, this is the workspace where the visualization is located.
|
|
1869
1873
|
*/
|
|
1870
|
-
targetWorkspaceId: string;
|
|
1874
|
+
'targetWorkspaceId': string;
|
|
1871
1875
|
/**
|
|
1872
1876
|
* Target object ID.
|
|
1873
1877
|
*/
|
|
1874
|
-
targetObjectId: string;
|
|
1878
|
+
'targetObjectId': string;
|
|
1875
1879
|
/**
|
|
1876
1880
|
* Target object type, e.g. visualization.
|
|
1877
1881
|
*/
|
|
1878
|
-
targetObjectType: string;
|
|
1882
|
+
'targetObjectType': string;
|
|
1879
1883
|
/**
|
|
1880
1884
|
* Target object title.
|
|
1881
1885
|
*/
|
|
1882
|
-
targetObjectTitle: string;
|
|
1886
|
+
'targetObjectTitle': string;
|
|
1883
1887
|
}
|
|
1884
1888
|
export interface SearchRequest {
|
|
1885
1889
|
/**
|
|
1886
1890
|
* Keyword/sentence is input for search.
|
|
1887
1891
|
*/
|
|
1888
|
-
question: string;
|
|
1892
|
+
'question': string;
|
|
1889
1893
|
/**
|
|
1890
1894
|
* List of object types to search for.
|
|
1891
1895
|
*/
|
|
1892
|
-
objectTypes?: Array<SearchRequestObjectTypesEnum>;
|
|
1896
|
+
'objectTypes'?: Array<SearchRequestObjectTypesEnum>;
|
|
1893
1897
|
/**
|
|
1894
1898
|
* Turn on deep search. If true, content of complex objects will be searched as well, e.g. metrics in visualizations.
|
|
1895
1899
|
*/
|
|
1896
|
-
deepSearch?: boolean;
|
|
1900
|
+
'deepSearch'?: boolean;
|
|
1897
1901
|
/**
|
|
1898
1902
|
* Maximum number of results to return. There is a hard limit and the actual number of returned results may be lower than what is requested. This can happen when post-search filters are applied (e.g., reranker threshold filtering or allowedRelationshipTypes filtering), which may exclude some results after the initial search.
|
|
1899
1903
|
*/
|
|
1900
|
-
limit?: number;
|
|
1904
|
+
'limit'?: number;
|
|
1901
1905
|
/**
|
|
1902
1906
|
* Temporary for experiments. Ratio of title score to descriptor score.
|
|
1903
1907
|
*/
|
|
1904
|
-
titleToDescriptorRatio?: number;
|
|
1908
|
+
'titleToDescriptorRatio'?: number;
|
|
1905
1909
|
/**
|
|
1906
1910
|
* Score, above which we return found objects. Below this score objects are not relevant.
|
|
1907
1911
|
*/
|
|
1908
|
-
relevantScoreThreshold?: number;
|
|
1912
|
+
'relevantScoreThreshold'?: number;
|
|
1909
1913
|
/**
|
|
1910
1914
|
* If true, includes hidden objects in search results. If false (default), excludes objects where isHidden=true.
|
|
1911
1915
|
*/
|
|
1912
|
-
includeHidden?: boolean;
|
|
1916
|
+
'includeHidden'?: boolean;
|
|
1913
1917
|
/**
|
|
1914
1918
|
* Include only objects that contain at least one of the specified tags (OR logic). This parameter only affects the search results. If an object has multiple tags, it will be included as long as it matches at least one tag from this parameter.
|
|
1915
1919
|
*/
|
|
1916
|
-
includeTags?: Array<string>;
|
|
1920
|
+
'includeTags'?: Array<string>;
|
|
1917
1921
|
/**
|
|
1918
1922
|
* Exclude objects that contain any of the specified tags. This parameter only affects the search results. Objects with excluded tags are completely hidden from the results.
|
|
1919
1923
|
*/
|
|
1920
|
-
excludeTags?: Array<string>;
|
|
1924
|
+
'excludeTags'?: Array<string>;
|
|
1921
1925
|
/**
|
|
1922
1926
|
* Filter relationships and results based on allowed relationship type combinations. When specified, only relationships matching the allowed types are returned, and results are filtered to include only direct matches or objects reachable via allowed relationships. When null or omitted, all relationships and results are returned (default behavior). Note: This filtering happens after the initial search, so the number of returned results may be lower than the requested limit if some results are filtered out.
|
|
1923
1927
|
*/
|
|
1924
|
-
allowedRelationshipTypes?: Array<AllowedRelationshipType>;
|
|
1928
|
+
'allowedRelationshipTypes'?: Array<AllowedRelationshipType>;
|
|
1925
1929
|
}
|
|
1926
|
-
export type SearchRequestObjectTypesEnum =
|
|
1930
|
+
export type SearchRequestObjectTypesEnum = 'attribute' | 'metric' | 'fact' | 'label' | 'date' | 'dataset' | 'visualization' | 'dashboard';
|
|
1927
1931
|
export interface SearchResult {
|
|
1928
|
-
results: Array<SearchResultObject>;
|
|
1929
|
-
relationships: Array<SearchRelationshipObject>;
|
|
1932
|
+
'results': Array<SearchResultObject>;
|
|
1933
|
+
'relationships': Array<SearchRelationshipObject>;
|
|
1930
1934
|
/**
|
|
1931
1935
|
* DEPRECATED: Use top-level reasoning.steps instead. If something is not working properly this field will contain explanation.
|
|
1932
1936
|
*/
|
|
1933
|
-
reasoning: string;
|
|
1937
|
+
'reasoning': string;
|
|
1934
1938
|
}
|
|
1935
1939
|
export interface SearchResultObject {
|
|
1936
1940
|
/**
|
|
1937
1941
|
* Object ID.
|
|
1938
1942
|
*/
|
|
1939
|
-
id: string;
|
|
1943
|
+
'id': string;
|
|
1940
1944
|
/**
|
|
1941
1945
|
* Object type, e.g. dashboard.
|
|
1942
1946
|
*/
|
|
1943
|
-
type: string;
|
|
1947
|
+
'type': string;
|
|
1944
1948
|
/**
|
|
1945
1949
|
* Workspace ID.
|
|
1946
1950
|
*/
|
|
1947
|
-
workspaceId: string;
|
|
1951
|
+
'workspaceId': string;
|
|
1948
1952
|
/**
|
|
1949
1953
|
* Object title.
|
|
1950
1954
|
*/
|
|
1951
|
-
title: string;
|
|
1955
|
+
'title': string;
|
|
1952
1956
|
/**
|
|
1953
1957
|
* Object description.
|
|
1954
1958
|
*/
|
|
1955
|
-
description?: string;
|
|
1956
|
-
tags?: Array<string>;
|
|
1959
|
+
'description'?: string;
|
|
1960
|
+
'tags'?: Array<string>;
|
|
1957
1961
|
/**
|
|
1958
1962
|
* Timestamp when object was created.
|
|
1959
1963
|
*/
|
|
1960
|
-
createdAt?: string;
|
|
1964
|
+
'createdAt'?: string;
|
|
1961
1965
|
/**
|
|
1962
1966
|
* Timestamp when object was last modified.
|
|
1963
1967
|
*/
|
|
1964
|
-
modifiedAt?: string;
|
|
1968
|
+
'modifiedAt'?: string;
|
|
1965
1969
|
/**
|
|
1966
1970
|
* If the object is visualization, this field defines the type of visualization.
|
|
1967
1971
|
*/
|
|
1968
|
-
visualizationUrl?: string;
|
|
1972
|
+
'visualizationUrl'?: string;
|
|
1969
1973
|
/**
|
|
1970
1974
|
* Result score calculated by a similarity search algorithm (cosine_distance).
|
|
1971
1975
|
*/
|
|
1972
|
-
score?: number;
|
|
1976
|
+
'score'?: number;
|
|
1973
1977
|
/**
|
|
1974
1978
|
* Result score for object title.
|
|
1975
1979
|
*/
|
|
1976
|
-
scoreTitle?: number;
|
|
1980
|
+
'scoreTitle'?: number;
|
|
1977
1981
|
/**
|
|
1978
1982
|
* Result score for descriptor containing(now) description and tags.
|
|
1979
1983
|
*/
|
|
1980
|
-
scoreDescriptor?: number;
|
|
1984
|
+
'scoreDescriptor'?: number;
|
|
1981
1985
|
/**
|
|
1982
1986
|
* Result score for exact match(id/title). 1/1000. Other scores are multiplied by this.
|
|
1983
1987
|
*/
|
|
1984
|
-
scoreExactMatch?: number;
|
|
1988
|
+
'scoreExactMatch'?: number;
|
|
1985
1989
|
/**
|
|
1986
1990
|
* If true, this object is hidden from AI search results by default.
|
|
1987
1991
|
*/
|
|
1988
|
-
isHidden?: boolean;
|
|
1992
|
+
'isHidden'?: boolean;
|
|
1989
1993
|
}
|
|
1990
1994
|
/**
|
|
1991
1995
|
* Metric defined by referencing a MAQL metric or an LDM fact object with aggregation.
|
|
1992
1996
|
*/
|
|
1993
1997
|
export interface SimpleMeasureDefinition {
|
|
1994
|
-
measure: SimpleMeasureDefinitionMeasure;
|
|
1998
|
+
'measure': SimpleMeasureDefinitionMeasure;
|
|
1995
1999
|
}
|
|
1996
2000
|
export interface SimpleMeasureDefinitionMeasure {
|
|
1997
|
-
item: AfmObjectIdentifierCore;
|
|
2001
|
+
'item': AfmObjectIdentifierCore;
|
|
1998
2002
|
/**
|
|
1999
2003
|
* Definition of aggregation type of the metric.
|
|
2000
2004
|
*/
|
|
2001
|
-
aggregation?: SimpleMeasureDefinitionMeasureAggregationEnum;
|
|
2005
|
+
'aggregation'?: SimpleMeasureDefinitionMeasureAggregationEnum;
|
|
2002
2006
|
/**
|
|
2003
2007
|
* If true, compute the percentage of given metric values (broken down by AFM attributes) to the total (not broken down).
|
|
2004
2008
|
*/
|
|
2005
|
-
computeRatio?: boolean;
|
|
2009
|
+
'computeRatio'?: boolean;
|
|
2006
2010
|
/**
|
|
2007
2011
|
* Metrics can be filtered by attribute filters with the same interface as ones for global AFM. Note that only one DateFilter is allowed.
|
|
2008
2012
|
*/
|
|
2009
|
-
filters?: Array<FilterDefinitionForSimpleMeasure>;
|
|
2013
|
+
'filters'?: Array<FilterDefinitionForSimpleMeasure>;
|
|
2010
2014
|
}
|
|
2011
|
-
export type SimpleMeasureDefinitionMeasureAggregationEnum =
|
|
2015
|
+
export type SimpleMeasureDefinitionMeasureAggregationEnum = 'SUM' | 'COUNT' | 'AVG' | 'MIN' | 'MAX' | 'MEDIAN' | 'RUNSUM' | 'APPROXIMATE_COUNT';
|
|
2012
2016
|
export interface SmartFunctionResponse {
|
|
2013
|
-
links: ExecutionLinks;
|
|
2017
|
+
'links': ExecutionLinks;
|
|
2014
2018
|
}
|
|
2015
2019
|
/**
|
|
2016
2020
|
* @type SortKey
|
|
@@ -2020,56 +2024,56 @@ export type SortKey = SortKeyAttribute | SortKeyTotal | SortKeyValue;
|
|
|
2020
2024
|
* Sorting rule for sorting by attribute value in current dimension.
|
|
2021
2025
|
*/
|
|
2022
2026
|
export interface SortKeyAttribute {
|
|
2023
|
-
attribute: SortKeyAttributeAttribute;
|
|
2027
|
+
'attribute': SortKeyAttributeAttribute;
|
|
2024
2028
|
}
|
|
2025
2029
|
export interface SortKeyAttributeAttribute {
|
|
2026
2030
|
/**
|
|
2027
2031
|
* Item reference (to \'itemIdentifiers\') referencing, which item should be used for sorting. Only references to attributes are allowed.
|
|
2028
2032
|
*/
|
|
2029
|
-
attributeIdentifier: string;
|
|
2033
|
+
'attributeIdentifier': string;
|
|
2030
2034
|
/**
|
|
2031
2035
|
* 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.
|
|
2032
2036
|
*/
|
|
2033
|
-
sortType?: SortKeyAttributeAttributeSortTypeEnum;
|
|
2037
|
+
'sortType'?: SortKeyAttributeAttributeSortTypeEnum;
|
|
2034
2038
|
/**
|
|
2035
2039
|
* Sorting elements - ascending/descending order.
|
|
2036
2040
|
*/
|
|
2037
|
-
direction?: SortKeyAttributeAttributeDirectionEnum;
|
|
2041
|
+
'direction'?: SortKeyAttributeAttributeDirectionEnum;
|
|
2038
2042
|
}
|
|
2039
|
-
export type SortKeyAttributeAttributeSortTypeEnum =
|
|
2040
|
-
export type SortKeyAttributeAttributeDirectionEnum =
|
|
2043
|
+
export type SortKeyAttributeAttributeSortTypeEnum = 'DEFAULT' | 'LABEL' | 'ATTRIBUTE' | 'AREA';
|
|
2044
|
+
export type SortKeyAttributeAttributeDirectionEnum = 'ASC' | 'DESC';
|
|
2041
2045
|
/**
|
|
2042
2046
|
* 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.
|
|
2043
2047
|
*/
|
|
2044
2048
|
export interface SortKeyTotal {
|
|
2045
|
-
total: SortKeyTotalTotal;
|
|
2049
|
+
'total': SortKeyTotalTotal;
|
|
2046
2050
|
}
|
|
2047
2051
|
export interface SortKeyTotalTotal {
|
|
2048
2052
|
/**
|
|
2049
2053
|
* Local identifier of the total to sort by.
|
|
2050
2054
|
*/
|
|
2051
|
-
totalIdentifier: string;
|
|
2052
|
-
dataColumnLocators?: DataColumnLocators;
|
|
2055
|
+
'totalIdentifier': string;
|
|
2056
|
+
'dataColumnLocators'?: DataColumnLocators;
|
|
2053
2057
|
/**
|
|
2054
2058
|
* Sorting elements - ascending/descending order.
|
|
2055
2059
|
*/
|
|
2056
|
-
direction?: SortKeyTotalTotalDirectionEnum;
|
|
2060
|
+
'direction'?: SortKeyTotalTotalDirectionEnum;
|
|
2057
2061
|
}
|
|
2058
|
-
export type SortKeyTotalTotalDirectionEnum =
|
|
2062
|
+
export type SortKeyTotalTotalDirectionEnum = 'ASC' | 'DESC';
|
|
2059
2063
|
/**
|
|
2060
2064
|
* Sorting rule for sorting by measure value. DataColumnLocators for each dimension opposite to the sorted one must be specified.
|
|
2061
2065
|
*/
|
|
2062
2066
|
export interface SortKeyValue {
|
|
2063
|
-
value: SortKeyValueValue;
|
|
2067
|
+
'value': SortKeyValueValue;
|
|
2064
2068
|
}
|
|
2065
2069
|
export interface SortKeyValueValue {
|
|
2066
|
-
dataColumnLocators: DataColumnLocators;
|
|
2070
|
+
'dataColumnLocators': DataColumnLocators;
|
|
2067
2071
|
/**
|
|
2068
2072
|
* Sorting elements - ascending/descending order.
|
|
2069
2073
|
*/
|
|
2070
|
-
direction?: SortKeyValueValueDirectionEnum;
|
|
2074
|
+
'direction'?: SortKeyValueValueDirectionEnum;
|
|
2071
2075
|
}
|
|
2072
|
-
export type SortKeyValueValueDirectionEnum =
|
|
2076
|
+
export type SortKeyValueValueDirectionEnum = 'ASC' | 'DESC';
|
|
2073
2077
|
/**
|
|
2074
2078
|
* Operation that has succeeded
|
|
2075
2079
|
*/
|
|
@@ -2077,7 +2081,7 @@ export interface SucceededOperation extends Operation {
|
|
|
2077
2081
|
/**
|
|
2078
2082
|
* Operation-specific result payload, can be missing for operations like delete
|
|
2079
2083
|
*/
|
|
2080
|
-
result?: object;
|
|
2084
|
+
'result'?: object;
|
|
2081
2085
|
}
|
|
2082
2086
|
/**
|
|
2083
2087
|
* List of suggestions for next steps. Filled when no visualization was created, suggests alternatives.
|
|
@@ -2086,11 +2090,11 @@ export interface Suggestion {
|
|
|
2086
2090
|
/**
|
|
2087
2091
|
* Suggestion query
|
|
2088
2092
|
*/
|
|
2089
|
-
query: string;
|
|
2093
|
+
'query': string;
|
|
2090
2094
|
/**
|
|
2091
2095
|
* Suggestion button label
|
|
2092
2096
|
*/
|
|
2093
|
-
label: string;
|
|
2097
|
+
'label': string;
|
|
2094
2098
|
}
|
|
2095
2099
|
/**
|
|
2096
2100
|
* Detailed thoughts/messages within this step.
|
|
@@ -2099,7 +2103,7 @@ export interface Thought {
|
|
|
2099
2103
|
/**
|
|
2100
2104
|
* The text content of this thought.
|
|
2101
2105
|
*/
|
|
2102
|
-
text: string;
|
|
2106
|
+
'text': string;
|
|
2103
2107
|
}
|
|
2104
2108
|
/**
|
|
2105
2109
|
* 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`
|
|
@@ -2108,18 +2112,18 @@ export interface Total {
|
|
|
2108
2112
|
/**
|
|
2109
2113
|
* Total identification within this request. Used e.g. in sorting by a total.
|
|
2110
2114
|
*/
|
|
2111
|
-
localIdentifier: string;
|
|
2115
|
+
'localIdentifier': string;
|
|
2112
2116
|
/**
|
|
2113
2117
|
* Aggregation function to compute the total.
|
|
2114
2118
|
*/
|
|
2115
|
-
function: TotalFunctionEnum;
|
|
2119
|
+
'function': TotalFunctionEnum;
|
|
2116
2120
|
/**
|
|
2117
2121
|
* The metric for which the total will be computed
|
|
2118
2122
|
*/
|
|
2119
|
-
metric: string;
|
|
2120
|
-
totalDimensions: Array<TotalDimension>;
|
|
2123
|
+
'metric': string;
|
|
2124
|
+
'totalDimensions': Array<TotalDimension>;
|
|
2121
2125
|
}
|
|
2122
|
-
export type TotalFunctionEnum =
|
|
2126
|
+
export type TotalFunctionEnum = 'SUM' | 'MIN' | 'MAX' | 'AVG' | 'MED' | 'NAT';
|
|
2123
2127
|
/**
|
|
2124
2128
|
* A list of dimensions across which the total will be computed. Total headers for only these dimensions will be returned in the result.
|
|
2125
2129
|
*/
|
|
@@ -2127,101 +2131,101 @@ export interface TotalDimension {
|
|
|
2127
2131
|
/**
|
|
2128
2132
|
* An identifier of a dimension for which the total will be computed.
|
|
2129
2133
|
*/
|
|
2130
|
-
dimensionIdentifier: string;
|
|
2134
|
+
'dimensionIdentifier': string;
|
|
2131
2135
|
/**
|
|
2132
2136
|
* 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.
|
|
2133
2137
|
*/
|
|
2134
|
-
totalDimensionItems: Array<string>;
|
|
2138
|
+
'totalDimensionItems': Array<string>;
|
|
2135
2139
|
}
|
|
2136
2140
|
export interface TotalExecutionResultHeader {
|
|
2137
|
-
totalHeader: TotalResultHeader;
|
|
2141
|
+
'totalHeader': TotalResultHeader;
|
|
2138
2142
|
}
|
|
2139
2143
|
/**
|
|
2140
2144
|
* Header containing the information related to a subtotal.
|
|
2141
2145
|
*/
|
|
2142
2146
|
export interface TotalResultHeader {
|
|
2143
|
-
function: string;
|
|
2147
|
+
'function': string;
|
|
2144
2148
|
}
|
|
2145
2149
|
export interface TriggerQualityIssuesCalculationResponse {
|
|
2146
2150
|
/**
|
|
2147
2151
|
* Process ID for tracking the calculation status
|
|
2148
2152
|
*/
|
|
2149
|
-
processId: string;
|
|
2153
|
+
'processId': string;
|
|
2150
2154
|
/**
|
|
2151
2155
|
* Current status of the calculation
|
|
2152
2156
|
*/
|
|
2153
|
-
status: TriggerQualityIssuesCalculationResponseStatusEnum;
|
|
2157
|
+
'status': TriggerQualityIssuesCalculationResponseStatusEnum;
|
|
2154
2158
|
}
|
|
2155
|
-
export type TriggerQualityIssuesCalculationResponseStatusEnum =
|
|
2159
|
+
export type TriggerQualityIssuesCalculationResponseStatusEnum = 'RUNNING' | 'COMPLETED' | 'FAILED' | 'DISABLED';
|
|
2156
2160
|
/**
|
|
2157
2161
|
* User context, which can affect the behavior of the underlying AI features.
|
|
2158
2162
|
*/
|
|
2159
2163
|
export interface UserContext {
|
|
2160
|
-
activeObject: ActiveObjectIdentification;
|
|
2164
|
+
'activeObject': ActiveObjectIdentification;
|
|
2161
2165
|
}
|
|
2162
2166
|
export interface ValidateByItem {
|
|
2163
2167
|
/**
|
|
2164
2168
|
* Specifies entity used for valid elements computation.
|
|
2165
2169
|
*/
|
|
2166
|
-
id: string;
|
|
2170
|
+
'id': string;
|
|
2167
2171
|
/**
|
|
2168
2172
|
* Specifies entity type which could be label, attribute, fact, or metric.
|
|
2169
2173
|
*/
|
|
2170
|
-
type: string;
|
|
2174
|
+
'type': string;
|
|
2171
2175
|
}
|
|
2172
2176
|
export interface ValidateLLMEndpointByIdRequest {
|
|
2173
2177
|
/**
|
|
2174
2178
|
* Provider for the LLM endpoint validation
|
|
2175
2179
|
*/
|
|
2176
|
-
provider?: string;
|
|
2180
|
+
'provider'?: string;
|
|
2177
2181
|
/**
|
|
2178
2182
|
* Base URL for the LLM endpoint validation
|
|
2179
2183
|
*/
|
|
2180
|
-
baseUrl?: string;
|
|
2184
|
+
'baseUrl'?: string;
|
|
2181
2185
|
/**
|
|
2182
2186
|
* Token for the LLM endpoint validation
|
|
2183
2187
|
*/
|
|
2184
|
-
token?: string;
|
|
2188
|
+
'token'?: string;
|
|
2185
2189
|
/**
|
|
2186
2190
|
* Organization name for the LLM endpoint validation
|
|
2187
2191
|
*/
|
|
2188
|
-
llmOrganization?: string;
|
|
2192
|
+
'llmOrganization'?: string;
|
|
2189
2193
|
/**
|
|
2190
2194
|
* LLM model for the LLM endpoint validation
|
|
2191
2195
|
*/
|
|
2192
|
-
llmModel?: string;
|
|
2196
|
+
'llmModel'?: string;
|
|
2193
2197
|
}
|
|
2194
2198
|
export interface ValidateLLMEndpointRequest {
|
|
2195
2199
|
/**
|
|
2196
2200
|
* Provider for the LLM endpoint validation
|
|
2197
2201
|
*/
|
|
2198
|
-
provider: string;
|
|
2202
|
+
'provider': string;
|
|
2199
2203
|
/**
|
|
2200
2204
|
* Base URL for the LLM endpoint validation
|
|
2201
2205
|
*/
|
|
2202
|
-
baseUrl?: string;
|
|
2206
|
+
'baseUrl'?: string;
|
|
2203
2207
|
/**
|
|
2204
2208
|
* Token for the LLM endpoint validation
|
|
2205
2209
|
*/
|
|
2206
|
-
token: string;
|
|
2210
|
+
'token': string;
|
|
2207
2211
|
/**
|
|
2208
2212
|
* Organization name for the LLM endpoint validation
|
|
2209
2213
|
*/
|
|
2210
|
-
llmOrganization?: string;
|
|
2214
|
+
'llmOrganization'?: string;
|
|
2211
2215
|
/**
|
|
2212
2216
|
* LLM model for the LLM endpoint validation
|
|
2213
2217
|
*/
|
|
2214
|
-
llmModel?: string;
|
|
2218
|
+
'llmModel'?: string;
|
|
2215
2219
|
}
|
|
2216
2220
|
export interface ValidateLLMEndpointResponse {
|
|
2217
2221
|
/**
|
|
2218
2222
|
* Whether the LLM endpoint validation was successful
|
|
2219
2223
|
*/
|
|
2220
|
-
successful: boolean;
|
|
2224
|
+
'successful': boolean;
|
|
2221
2225
|
/**
|
|
2222
2226
|
* Additional message about the LLM endpoint validation
|
|
2223
2227
|
*/
|
|
2224
|
-
message: string;
|
|
2228
|
+
'message': string;
|
|
2225
2229
|
}
|
|
2226
2230
|
/**
|
|
2227
2231
|
* (BETA) Deletes an existing database in the organization\'s AI Lake. Returns an operation-id in the operation-id header the client can use to poll for the progress.
|
|
@@ -2647,7 +2651,7 @@ export declare function ActionsApiAxiosParamCreator_CreatedBy(workspaceId: strin
|
|
|
2647
2651
|
* @param {Configuration} [configuration] Optional configuration.
|
|
2648
2652
|
* @throws {RequiredError}
|
|
2649
2653
|
*/
|
|
2650
|
-
export declare function ActionsApiAxiosParamCreator_ExplainAFM(workspaceId: string, afmExecution: AfmExecution, explainType?:
|
|
2654
|
+
export declare function ActionsApiAxiosParamCreator_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, configuration?: Configuration): Promise<RequestArgs>;
|
|
2651
2655
|
/**
|
|
2652
2656
|
* (BETA) Computes forecasted data points from the provided execution result and parameters.
|
|
2653
2657
|
* @summary (BETA) Smart functions - Forecast
|
|
@@ -3915,7 +3919,7 @@ export interface ActionsApiExplainAFMRequest {
|
|
|
3915
3919
|
* @type {'MAQL' | 'GRPC_MODEL' | 'GRPC_MODEL_SVG' | 'WDF' | 'QT' | 'QT_SVG' | 'OPT_QT' | 'OPT_QT_SVG' | 'SQL' | 'SETTINGS' | 'COMPRESSED_SQL'}
|
|
3916
3920
|
* @memberof ActionsApiExplainAFM
|
|
3917
3921
|
*/
|
|
3918
|
-
readonly explainType?:
|
|
3922
|
+
readonly explainType?: 'MAQL' | 'GRPC_MODEL' | 'GRPC_MODEL_SVG' | 'WDF' | 'QT' | 'QT_SVG' | 'OPT_QT' | 'OPT_QT_SVG' | 'SQL' | 'SETTINGS' | 'COMPRESSED_SQL';
|
|
3919
3923
|
}
|
|
3920
3924
|
/**
|
|
3921
3925
|
* Request parameters for forecast operation in ActionsApi.
|
|
@@ -4668,7 +4672,7 @@ export declare function ComputationApiAxiosParamCreator_ComputeValidObjects(work
|
|
|
4668
4672
|
* @param {Configuration} [configuration] Optional configuration.
|
|
4669
4673
|
* @throws {RequiredError}
|
|
4670
4674
|
*/
|
|
4671
|
-
export declare function ComputationApiAxiosParamCreator_ExplainAFM(workspaceId: string, afmExecution: AfmExecution, explainType?:
|
|
4675
|
+
export declare function ComputationApiAxiosParamCreator_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, configuration?: Configuration): Promise<RequestArgs>;
|
|
4672
4676
|
/**
|
|
4673
4677
|
* (EXPERIMENTAL) Computes key driver analysis for the provided execution definition.
|
|
4674
4678
|
* @summary (EXPERIMENTAL) Compute key driver analysis
|
|
@@ -5212,7 +5216,7 @@ export interface ComputationApiExplainAFMRequest {
|
|
|
5212
5216
|
* @type {'MAQL' | 'GRPC_MODEL' | 'GRPC_MODEL_SVG' | 'WDF' | 'QT' | 'QT_SVG' | 'OPT_QT' | 'OPT_QT_SVG' | 'SQL' | 'SETTINGS' | 'COMPRESSED_SQL'}
|
|
5213
5217
|
* @memberof ComputationApiExplainAFM
|
|
5214
5218
|
*/
|
|
5215
|
-
readonly explainType?:
|
|
5219
|
+
readonly explainType?: 'MAQL' | 'GRPC_MODEL' | 'GRPC_MODEL_SVG' | 'WDF' | 'QT' | 'QT_SVG' | 'OPT_QT' | 'OPT_QT_SVG' | 'SQL' | 'SETTINGS' | 'COMPRESSED_SQL';
|
|
5216
5220
|
}
|
|
5217
5221
|
/**
|
|
5218
5222
|
* Request parameters for keyDriverAnalysis operation in ComputationApi.
|