@qlik/api 2.3.0 → 2.4.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/analytics/change-stores.d.ts +40 -76
- package/analytics/change-stores.js +9 -10
- package/analytics.d.ts +1 -2
- package/analytics.js +5 -6
- package/api-keys.d.ts +46 -100
- package/api-keys.js +3 -4
- package/apps.d.ts +334 -461
- package/apps.js +74 -6
- package/assistants.d.ts +172 -337
- package/assistants.js +3 -4
- package/audits.d.ts +41 -85
- package/audits.js +3 -4
- package/auth-types.d.ts +110 -1
- package/auth-types.js +22 -1
- package/auth.d.ts +1 -2
- package/auth.js +1 -1
- package/automation-connections.d.ts +44 -95
- package/automation-connections.js +3 -4
- package/automation-connectors.d.ts +10 -20
- package/automation-connectors.js +3 -4
- package/automations.d.ts +54 -112
- package/automations.js +3 -4
- package/automl-deployments.d.ts +17 -36
- package/automl-deployments.js +3 -4
- package/automl-predictions.d.ts +12 -24
- package/automl-predictions.js +3 -4
- package/banners.d.ts +8 -14
- package/banners.js +3 -4
- package/brands.d.ts +19 -39
- package/brands.js +3 -4
- package/chunks/auth-B8lJw7rm.js +31 -0
- package/chunks/{interceptors-DipDBQQ5.js → boot-interceptors-DqRxTczb.js} +296 -248
- package/chunks/{chunk-D3vHIbds.js → chunk-BdHzlgOL.js} +3 -3
- package/chunks/{invoke-fetch-B7lGscuQ.js → invoke-fetch-DMAi6Fg3.js} +3 -3
- package/chunks/{invoke-fetch-DhdyFZ0F.js → invoke-fetch-pMN6iqup.js} +2 -3
- package/chunks/platform-types-CECrZkOF.d.ts +29 -0
- package/chunks/{public-runtime-modules-QhLPeQr5.js → public-runtime-modules-2KfyI2qM.js} +5 -5
- package/chunks/{qix-RCUslia8.js → qix-BdNrIA4s.js} +19 -20
- package/chunks/{qix-chunk-entrypoint-WAS4NVTf.js → qix-chunk-entrypoint-L9RpWwLK.js} +52 -58
- package/chunks/{qix-CrqXv44x.d.ts → qix-types-y_di0roE.d.ts} +33 -115
- package/collections.d.ts +67 -144
- package/collections.js +3 -4
- package/conditions.d.ts +87 -190
- package/conditions.js +3 -4
- package/consumption.d.ts +35 -72
- package/consumption.js +3 -4
- package/core/ip-policies.d.ts +43 -93
- package/core/ip-policies.js +5 -6
- package/core.d.ts +1 -2
- package/core.js +5 -6
- package/csp-origins.d.ts +42 -85
- package/csp-origins.js +3 -4
- package/csrf-token.d.ts +6 -11
- package/csrf-token.js +3 -4
- package/data-alerts.d.ts +152 -325
- package/data-alerts.js +3 -4
- package/data-assets.d.ts +16 -31
- package/data-assets.js +3 -4
- package/data-connections.d.ts +123 -257
- package/data-connections.js +3 -4
- package/data-credentials.d.ts +36 -76
- package/data-credentials.js +3 -4
- package/data-files.d.ts +60 -121
- package/data-files.js +3 -4
- package/data-governance/data-products.d.ts +429 -0
- package/data-governance/data-products.js +212 -0
- package/data-governance.d.ts +13 -0
- package/data-governance.js +12 -0
- package/data-qualities.d.ts +11 -25
- package/data-qualities.js +3 -4
- package/data-sets.d.ts +28 -57
- package/data-sets.js +3 -4
- package/data-sources.d.ts +45 -97
- package/data-sources.js +3 -4
- package/data-stores.d.ts +53 -107
- package/data-stores.js +3 -4
- package/dcaas.d.ts +32 -67
- package/dcaas.js +3 -4
- package/di-projects.d.ts +111 -136
- package/di-projects.js +25 -4
- package/direct-access-agents.d.ts +29 -63
- package/direct-access-agents.js +3 -4
- package/encryption.d.ts +28 -59
- package/encryption.js +3 -4
- package/extensions.d.ts +35 -73
- package/extensions.js +3 -4
- package/global-types.d.ts +139 -1
- package/glossaries.d.ts +75 -158
- package/glossaries.js +3 -4
- package/groups.d.ts +58 -125
- package/groups.js +3 -4
- package/identity-providers.d.ts +148 -324
- package/identity-providers.js +3 -4
- package/index.d.ts +18 -4
- package/index.js +64 -19
- package/interceptors.d.ts +2 -3
- package/interceptors.js +104 -2
- package/invoke-fetch-types.d.ts +97 -1
- package/items.d.ts +85 -181
- package/items.js +3 -4
- package/knowledgebases.d.ts +137 -270
- package/knowledgebases.js +3 -4
- package/licenses.d.ts +71 -153
- package/licenses.js +3 -4
- package/lineage-graphs.d.ts +39 -85
- package/lineage-graphs.js +3 -4
- package/ml.d.ts +290 -621
- package/ml.js +3 -4
- package/notes.d.ts +9 -18
- package/notes.js +3 -4
- package/notifications.d.ts +14 -30
- package/notifications.js +3 -4
- package/oauth-clients.d.ts +98 -159
- package/oauth-clients.js +4 -5
- package/oauth-tokens.d.ts +16 -33
- package/oauth-tokens.js +3 -4
- package/package.json +6 -4
- package/qix.d.ts +46 -2
- package/qix.js +2 -3
- package/questions.d.ts +53 -110
- package/questions.js +3 -4
- package/quotas.d.ts +13 -26
- package/quotas.js +3 -4
- package/reload-tasks.d.ts +23 -46
- package/reload-tasks.js +3 -4
- package/reloads.d.ts +26 -52
- package/reloads.js +3 -4
- package/report-templates.d.ts +30 -63
- package/report-templates.js +3 -4
- package/reports.d.ts +111 -238
- package/reports.js +3 -4
- package/roles.d.ts +36 -77
- package/roles.js +3 -4
- package/sharing-tasks.d.ts +201 -427
- package/sharing-tasks.js +3 -4
- package/spaces.d.ts +71 -157
- package/spaces.js +3 -4
- package/tasks.d.ts +76 -164
- package/tasks.js +3 -4
- package/temp-contents.d.ts +17 -35
- package/temp-contents.js +3 -4
- package/tenant-settings.d.ts +298 -0
- package/tenant-settings.js +107 -0
- package/tenants.d.ts +31 -67
- package/tenants.js +3 -4
- package/themes.d.ts +27 -55
- package/themes.js +3 -4
- package/transports.d.ts +46 -106
- package/transports.js +3 -4
- package/ui-config.d.ts +8 -17
- package/ui-config.js +3 -4
- package/users.d.ts +80 -170
- package/users.js +3 -4
- package/web-integrations.d.ts +38 -83
- package/web-integrations.js +3 -4
- package/web-notifications.d.ts +14 -29
- package/web-notifications.js +3 -4
- package/webhooks.d.ts +77 -162
- package/webhooks.js +3 -4
- package/chunks/auth-BowS4SUR.js +0 -28
- package/chunks/auth-types-YrlH_R9f.d.ts +0 -416
- package/chunks/auth-types-h43TVDpB.js +0 -24
- package/chunks/global-types-CEVAJebk.js +0 -1
- /package/chunks/{dist-n3iOVn1W.js → dist-DR758NU5.js} +0 -0
- /package/chunks/{invoke-fetch-C1Z0RJYU.d.ts → invoke-fetch-DFc3yzaj.d.ts} +0 -0
- /package/chunks/{utils-vv-xFm06.js → utils-jkpLuYZR.js} +0 -0
- /package/chunks/{websocket-errors-CRTDTtBL.js → websocket-errors-C5U1tba-.js} +0 -0
package/ml.d.ts
CHANGED
|
@@ -1,71 +1,48 @@
|
|
|
1
|
-
import {
|
|
2
|
-
import "./chunks/invoke-fetch-
|
|
1
|
+
import { ApiCallOptions } from "./invoke-fetch-types.js";
|
|
2
|
+
import "./chunks/invoke-fetch-DFc3yzaj.js";
|
|
3
3
|
|
|
4
4
|
//#region src/public/rest/ml.d.ts
|
|
5
5
|
/**
|
|
6
6
|
* An error object
|
|
7
7
|
*/
|
|
8
8
|
type APIError = {
|
|
9
|
-
/** Qlik error code (not HTTP response status code) */
|
|
10
|
-
|
|
11
|
-
/** Description of the error */
|
|
12
|
-
detail?: string;
|
|
13
|
-
/** Additional details about the error. These may vary by error. */
|
|
9
|
+
/** Qlik error code (not HTTP response status code) */code: string; /** Description of the error */
|
|
10
|
+
detail?: string; /** Additional details about the error. These may vary by error. */
|
|
14
11
|
meta?: {
|
|
15
|
-
/** The argument */
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
/** The
|
|
20
|
-
errorId?: string;
|
|
21
|
-
/** The issue code */
|
|
22
|
-
issue?: string;
|
|
23
|
-
/** The resource type that the error occurred on */
|
|
24
|
-
resource?: string;
|
|
25
|
-
/** The resource id that the error occurred on */
|
|
12
|
+
/** The argument */argument?: string; /** Extra details for what may have caused the error */
|
|
13
|
+
details?: string; /** The unique id of the error instance */
|
|
14
|
+
errorId?: string; /** The issue code */
|
|
15
|
+
issue?: string; /** The resource type that the error occurred on */
|
|
16
|
+
resource?: string; /** The resource id that the error occurred on */
|
|
26
17
|
resourceId?: string;
|
|
27
|
-
};
|
|
28
|
-
/** Short summary of error */
|
|
18
|
+
}; /** Short summary of error */
|
|
29
19
|
title: string;
|
|
30
20
|
};
|
|
31
21
|
/**
|
|
32
22
|
* An AutoML alias
|
|
33
23
|
*/
|
|
34
24
|
type Alias = {
|
|
35
|
-
/** Timestamp when this was created */
|
|
36
|
-
|
|
37
|
-
/** ID of
|
|
38
|
-
|
|
39
|
-
/** ID of a model deployment */
|
|
40
|
-
deploymentId: DeploymentId;
|
|
41
|
-
/** ID of this entity */
|
|
42
|
-
id: EntityId;
|
|
43
|
-
/** The mode of an alias. Default mode means the model assigned to that alias will be used if alias is not specified */
|
|
25
|
+
/** Timestamp when this was created */createdAt: CreatedAt; /** ID of the owner/user that created this entity */
|
|
26
|
+
createdBy: string; /** ID of a model deployment */
|
|
27
|
+
deploymentId: DeploymentId; /** ID of this entity */
|
|
28
|
+
id: EntityId; /** The mode of an alias. Default mode means the model assigned to that alias will be used if alias is not specified */
|
|
44
29
|
mode: AliasMode;
|
|
45
|
-
models: ModelsInfo;
|
|
46
|
-
/**
|
|
47
|
-
name: EntityName;
|
|
48
|
-
/** Timestamp when this was updated */
|
|
30
|
+
models: ModelsInfo; /** Name of this entity */
|
|
31
|
+
name: EntityName; /** Timestamp when this was updated */
|
|
49
32
|
updatedAt: UpdatedAt;
|
|
50
33
|
};
|
|
51
34
|
type AliasFindResponse = {
|
|
52
35
|
data: {
|
|
53
|
-
/** An AutoML alias */
|
|
54
|
-
attributes: Alias;
|
|
55
|
-
/** ID of this entity */
|
|
36
|
+
/** An AutoML alias */attributes: Alias; /** ID of this entity */
|
|
56
37
|
id: EntityId;
|
|
57
38
|
type: "alias";
|
|
58
|
-
}[];
|
|
59
|
-
|
|
60
|
-
links: ResponseLinks;
|
|
61
|
-
/** Meta for FIND operations */
|
|
39
|
+
}[]; /** Resource links included in paginated responses */
|
|
40
|
+
links: ResponseLinks; /** Meta for FIND operations */
|
|
62
41
|
meta?: FindResponseMeta;
|
|
63
42
|
};
|
|
64
43
|
type AliasGetResponse = {
|
|
65
44
|
data: {
|
|
66
|
-
/** An AutoML alias */
|
|
67
|
-
attributes: Alias;
|
|
68
|
-
/** ID of this entity */
|
|
45
|
+
/** An AutoML alias */attributes: Alias; /** ID of this entity */
|
|
69
46
|
id: EntityId;
|
|
70
47
|
type: "alias";
|
|
71
48
|
};
|
|
@@ -80,8 +57,7 @@ type AliasId = string;
|
|
|
80
57
|
type AliasInput = {
|
|
81
58
|
data: {
|
|
82
59
|
attributes: {
|
|
83
|
-
models: ModelsInfo;
|
|
84
|
-
/** Name of this entity */
|
|
60
|
+
models: ModelsInfo; /** Name of this entity */
|
|
85
61
|
name: EntityName;
|
|
86
62
|
};
|
|
87
63
|
type: "alias";
|
|
@@ -109,18 +85,13 @@ type AliasPatch = AliasPatchItem[];
|
|
|
109
85
|
* Alias values that can be patched.
|
|
110
86
|
*/
|
|
111
87
|
type AliasPatchItem = {
|
|
112
|
-
/** All patch requests use the replace operation */
|
|
113
|
-
|
|
114
|
-
/** Path for the property you want to update */
|
|
115
|
-
path: "/name" | "/models";
|
|
116
|
-
/** Use for fields that can be `any` type (string, number, etc.) */
|
|
88
|
+
/** All patch requests use the replace operation */op: "replace"; /** Path for the property you want to update */
|
|
89
|
+
path: "/name" | "/models"; /** Use for fields that can be `any` type (string, number, etc.) */
|
|
117
90
|
value: AnyType;
|
|
118
91
|
};
|
|
119
92
|
type AliasPostResponse = {
|
|
120
93
|
data: {
|
|
121
|
-
/** An AutoML alias */
|
|
122
|
-
attributes: Alias;
|
|
123
|
-
/** ID of this entity */
|
|
94
|
+
/** An AutoML alias */attributes: Alias; /** ID of this entity */
|
|
124
95
|
id: EntityId;
|
|
125
96
|
type: "alias";
|
|
126
97
|
};
|
|
@@ -133,38 +104,23 @@ type AnyType = unknown;
|
|
|
133
104
|
* A batch prediction job configuration
|
|
134
105
|
*/
|
|
135
106
|
type BatchPrediction = {
|
|
136
|
-
/** ID of an alias */
|
|
137
|
-
|
|
138
|
-
/**
|
|
139
|
-
|
|
140
|
-
/** ID of
|
|
141
|
-
|
|
142
|
-
/**
|
|
143
|
-
|
|
144
|
-
/** ID of the dataset with the prediction results */
|
|
145
|
-
datasetId?: string;
|
|
146
|
-
/** ID of a model deployment */
|
|
147
|
-
deploymentId?: DeploymentId;
|
|
148
|
-
/** JSON string of error object */
|
|
149
|
-
errorMessage?: ErrorMessage;
|
|
150
|
-
/** JSON string with list of error objects */
|
|
151
|
-
errors?: Errors;
|
|
152
|
-
/** ID of this entity */
|
|
107
|
+
/** ID of an alias */aliasId?: AliasId; /** Timestamp when this was created */
|
|
108
|
+
createdAt?: CreatedAt; /** ID of the owner/user that ran this prediction batch */
|
|
109
|
+
createdBy?: string; /** The Qlik catalog dataset ID */
|
|
110
|
+
dataSetId?: DataSetId; /** ID of the dataset with the prediction results */
|
|
111
|
+
datasetId?: string; /** ID of a model deployment */
|
|
112
|
+
deploymentId?: DeploymentId; /** JSON string of error object */
|
|
113
|
+
errorMessage?: ErrorMessage; /** JSON string with list of error objects */
|
|
114
|
+
errors?: Errors; /** ID of this entity */
|
|
153
115
|
id?: EntityId;
|
|
154
116
|
/** A optional column name upon which to create an index. Must be unique for
|
|
155
117
|
* every row. If not included, Qlik will create a unique index column. */
|
|
156
|
-
indexColumn?: IndexColumn;
|
|
157
|
-
/**
|
|
158
|
-
|
|
159
|
-
/**
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
ownerId?: OwnerId;
|
|
163
|
-
/** Batch prediction job schedule */
|
|
164
|
-
schedule?: BatchPredictionSchedule;
|
|
165
|
-
/** Status of this batch prediction */
|
|
166
|
-
status?: BatchPredictionStatus;
|
|
167
|
-
/** Timestamp when this was updated */
|
|
118
|
+
indexColumn?: IndexColumn; /** Name of this entity */
|
|
119
|
+
name?: EntityName; /** Where to output dataset */
|
|
120
|
+
outputDataset?: string; /** ID of owner/user for this entity */
|
|
121
|
+
ownerId?: OwnerId; /** Batch prediction job schedule */
|
|
122
|
+
schedule?: BatchPredictionSchedule; /** Status of this batch prediction */
|
|
123
|
+
status?: BatchPredictionStatus; /** Timestamp when this was updated */
|
|
168
124
|
updatedAt?: UpdatedAt;
|
|
169
125
|
/** Sets which files, file names, and spaces are used to write results of
|
|
170
126
|
* batch predictions (output files) to the catalog.
|
|
@@ -178,30 +134,23 @@ type BatchPrediction = {
|
|
|
178
134
|
*/
|
|
179
135
|
type BatchPredictionActionResponse = {
|
|
180
136
|
data: {
|
|
181
|
-
attributes: PredictionJobResponse;
|
|
182
|
-
/** ID of this entity */
|
|
137
|
+
attributes: PredictionJobResponse; /** ID of this entity */
|
|
183
138
|
id: EntityId;
|
|
184
139
|
type: "job";
|
|
185
140
|
};
|
|
186
141
|
};
|
|
187
142
|
type BatchPredictionFindResponse = {
|
|
188
143
|
data: {
|
|
189
|
-
/** A batch prediction job configuration */
|
|
190
|
-
attributes: BatchPrediction;
|
|
191
|
-
/** ID of this entity */
|
|
144
|
+
/** A batch prediction job configuration */attributes: BatchPrediction; /** ID of this entity */
|
|
192
145
|
id: EntityId;
|
|
193
146
|
type: "batch-prediction";
|
|
194
|
-
}[];
|
|
195
|
-
|
|
196
|
-
links: ResponseLinks;
|
|
197
|
-
/** Meta for FIND operations */
|
|
147
|
+
}[]; /** Resource links included in paginated responses */
|
|
148
|
+
links: ResponseLinks; /** Meta for FIND operations */
|
|
198
149
|
meta?: FindResponseMeta;
|
|
199
150
|
};
|
|
200
151
|
type BatchPredictionGetResponse = {
|
|
201
152
|
data: {
|
|
202
|
-
/** A batch prediction job configuration */
|
|
203
|
-
attributes: BatchPrediction;
|
|
204
|
-
/** ID of this entity */
|
|
153
|
+
/** A batch prediction job configuration */attributes: BatchPrediction; /** ID of this entity */
|
|
205
154
|
id: EntityId;
|
|
206
155
|
type: "batch-prediction";
|
|
207
156
|
};
|
|
@@ -212,19 +161,14 @@ type BatchPredictionGetResponse = {
|
|
|
212
161
|
type BatchPredictionInput = {
|
|
213
162
|
data?: {
|
|
214
163
|
attributes?: {
|
|
215
|
-
/** ID of an alias */
|
|
216
|
-
|
|
217
|
-
/** The Qlik catalog dataset ID */
|
|
218
|
-
dataSetId?: DataSetId;
|
|
219
|
-
/** ID of a model deployment */
|
|
164
|
+
/** ID of an alias */aliasId?: AliasId; /** The Qlik catalog dataset ID */
|
|
165
|
+
dataSetId?: DataSetId; /** ID of a model deployment */
|
|
220
166
|
deploymentId?: DeploymentId;
|
|
221
167
|
description?: string;
|
|
222
168
|
/** A optional column name upon which to create an index. Must be unique for
|
|
223
169
|
* every row. If not included, Qlik will create a unique index column. */
|
|
224
|
-
indexColumn?: IndexColumn;
|
|
225
|
-
/**
|
|
226
|
-
name?: EntityName;
|
|
227
|
-
/** Configuration to schedule a batch prediction */
|
|
170
|
+
indexColumn?: IndexColumn; /** Name of this entity */
|
|
171
|
+
name?: EntityName; /** Configuration to schedule a batch prediction */
|
|
228
172
|
schedule?: BatchPredictionScheduleInputAttributes;
|
|
229
173
|
/** Sets which files, file names, and spaces are used to write results of
|
|
230
174
|
* batch predictions (output files) to the catalog.
|
|
@@ -237,18 +181,13 @@ type BatchPredictionInput = {
|
|
|
237
181
|
};
|
|
238
182
|
};
|
|
239
183
|
type BatchPredictionPatch = {
|
|
240
|
-
/** All patch requests use the replace operation */
|
|
241
|
-
|
|
242
|
-
/** Path for the property you want to update */
|
|
243
|
-
path: "/name" | "/description" | "/dataSetId" | "/indexColumn" | "/applyDatasetChangeOnly" | "/ownerId" | "/writeback/spaceId" | "/writeback/format" | "/writeback/dstName" | "/writeback/dstShapName" | "/writeback/dstCoordShapName" | "/writeback/dstNotPredictedName" | "/writeback/dstSourceName";
|
|
244
|
-
/** Use for fields that can be `any` type (string, number, etc.) */
|
|
184
|
+
/** All patch requests use the replace operation */op: "replace"; /** Path for the property you want to update */
|
|
185
|
+
path: "/name" | "/description" | "/dataSetId" | "/indexColumn" | "/applyDatasetChangeOnly" | "/ownerId" | "/writeback/spaceId" | "/writeback/format" | "/writeback/dstName" | "/writeback/dstShapName" | "/writeback/dstCoordShapName" | "/writeback/dstNotPredictedName" | "/writeback/dstSourceName"; /** Use for fields that can be `any` type (string, number, etc.) */
|
|
245
186
|
value: AnyType;
|
|
246
187
|
}[];
|
|
247
188
|
type BatchPredictionPostResponse = {
|
|
248
189
|
data: {
|
|
249
|
-
/** A batch prediction job configuration */
|
|
250
|
-
attributes: BatchPrediction;
|
|
251
|
-
/** ID of this entity */
|
|
190
|
+
/** A batch prediction job configuration */attributes: BatchPrediction; /** ID of this entity */
|
|
252
191
|
id: EntityId;
|
|
253
192
|
type: "batch-prediction";
|
|
254
193
|
};
|
|
@@ -260,31 +199,22 @@ type BatchPredictionSchedule = {
|
|
|
260
199
|
/** If true, only run prediction if dataset has changed to avoid
|
|
261
200
|
* duplicates. If set to false, re-runs predictions on unchanged
|
|
262
201
|
* datasets. */
|
|
263
|
-
applyDatasetChangeOnly?: boolean;
|
|
264
|
-
|
|
265
|
-
|
|
266
|
-
/** When the job
|
|
267
|
-
endDateTime?: string;
|
|
268
|
-
/** Number of times a scheduled prediction job has failed */
|
|
269
|
-
failureAttempts?: number;
|
|
270
|
-
/** When the last successful job happened */
|
|
202
|
+
applyDatasetChangeOnly?: boolean; /** The ID of the chronos job */
|
|
203
|
+
chronosJobId?: string; /** When the job finished */
|
|
204
|
+
endDateTime?: string; /** Number of times a scheduled prediction job has failed */
|
|
205
|
+
failureAttempts?: number; /** When the last successful job happened */
|
|
271
206
|
lastSuccessfulDateTime?: string;
|
|
272
207
|
/** Recurrence rules. Maximum is DAILY but you can specify the
|
|
273
208
|
* hour, minute, and second it runs each day.
|
|
274
209
|
* One string per rule. */
|
|
275
|
-
recurrence?: string[];
|
|
276
|
-
|
|
277
|
-
|
|
278
|
-
/** The status of the schedule */
|
|
279
|
-
status?: "pending" | "active" | "error" | "error_scheduler_unreachable" | "error_scheduler_callback_error" | "licence_advanced_features_required" | "failing_schedule_permission";
|
|
280
|
-
/** Timezone used for the date-time fields */
|
|
210
|
+
recurrence?: string[]; /** When the job is scheduled to start */
|
|
211
|
+
startDateTime?: string; /** The status of the schedule */
|
|
212
|
+
status?: "pending" | "active" | "error" | "error_scheduler_unreachable" | "error_scheduler_callback_error" | "licence_advanced_features_required" | "failing_schedule_permission"; /** Timezone used for the date-time fields */
|
|
281
213
|
timezone?: string;
|
|
282
214
|
};
|
|
283
215
|
type BatchPredictionScheduleGetResponse = {
|
|
284
216
|
data: {
|
|
285
|
-
/** Batch prediction job schedule */
|
|
286
|
-
attributes: BatchPredictionSchedule;
|
|
287
|
-
/** ID of this entity */
|
|
217
|
+
/** Batch prediction job schedule */attributes: BatchPredictionSchedule; /** ID of this entity */
|
|
288
218
|
id: EntityId;
|
|
289
219
|
type: "batch-prediction-schedule";
|
|
290
220
|
};
|
|
@@ -294,8 +224,7 @@ type BatchPredictionScheduleGetResponse = {
|
|
|
294
224
|
*/
|
|
295
225
|
type BatchPredictionScheduleInput = {
|
|
296
226
|
data?: {
|
|
297
|
-
/** Configuration to schedule a batch prediction */
|
|
298
|
-
attributes?: BatchPredictionScheduleInputAttributes;
|
|
227
|
+
/** Configuration to schedule a batch prediction */attributes?: BatchPredictionScheduleInputAttributes;
|
|
299
228
|
type?: "batch-prediction-schedule";
|
|
300
229
|
};
|
|
301
230
|
};
|
|
@@ -306,31 +235,23 @@ type BatchPredictionScheduleInputAttributes = {
|
|
|
306
235
|
/** If true, only run prediction if dataset has changed to avoid
|
|
307
236
|
* duplicates. If set to false, re-runs predictions on unchanged
|
|
308
237
|
* datasets. */
|
|
309
|
-
applyDatasetChangeOnly?: boolean;
|
|
310
|
-
/** When the job is scheduled to finish */
|
|
238
|
+
applyDatasetChangeOnly?: boolean; /** When the job is scheduled to finish */
|
|
311
239
|
endDateTime?: string;
|
|
312
240
|
/** Recurrence rules. Maximum is DAILY but you can specify the
|
|
313
241
|
* hour, minute, and second it runs each day.
|
|
314
242
|
* One string per rule. */
|
|
315
|
-
recurrence?: string[];
|
|
316
|
-
/**
|
|
317
|
-
startDateTime: string;
|
|
318
|
-
/** Timezone used for the date-time fields */
|
|
243
|
+
recurrence?: string[]; /** When the job is scheduled to start */
|
|
244
|
+
startDateTime: string; /** Timezone used for the date-time fields */
|
|
319
245
|
timezone: string;
|
|
320
246
|
};
|
|
321
247
|
type BatchPredictionSchedulePatch = {
|
|
322
|
-
/** All patch requests use the replace operation */
|
|
323
|
-
|
|
324
|
-
/** Path for the property you want to update */
|
|
325
|
-
path: "/startDateTime" | "/endDateTime" | "/timezone" | "/recurrence" | "/applyDatasetChangeOnly";
|
|
326
|
-
/** Use for fields that can be `any` type (string, number, etc.) */
|
|
248
|
+
/** All patch requests use the replace operation */op: "replace"; /** Path for the property you want to update */
|
|
249
|
+
path: "/startDateTime" | "/endDateTime" | "/timezone" | "/recurrence" | "/applyDatasetChangeOnly"; /** Use for fields that can be `any` type (string, number, etc.) */
|
|
327
250
|
value: AnyType;
|
|
328
251
|
}[];
|
|
329
252
|
type BatchPredictionSchedulePutResponse = {
|
|
330
253
|
data: {
|
|
331
|
-
/** Batch prediction job schedule */
|
|
332
|
-
attributes: BatchPredictionSchedule;
|
|
333
|
-
/** ID of this entity */
|
|
254
|
+
/** Batch prediction job schedule */attributes: BatchPredictionSchedule; /** ID of this entity */
|
|
334
255
|
id: EntityId;
|
|
335
256
|
type: "batch-prediction-schedule";
|
|
336
257
|
};
|
|
@@ -351,8 +272,7 @@ type BatchPredictionWriteback = {
|
|
|
351
272
|
dstName: string;
|
|
352
273
|
dstNotPredictedName?: string;
|
|
353
274
|
dstShapName?: string;
|
|
354
|
-
dstSourceName?: string;
|
|
355
|
-
/** File format for write back files (this applies to all) */
|
|
275
|
+
dstSourceName?: string; /** File format for write back files (this applies to all) */
|
|
356
276
|
format: "qvd" | "parquet" | "csv";
|
|
357
277
|
/** Space ID where you want to save batch prediction writebacks or
|
|
358
278
|
* empty string ('') save them to your personal space. */
|
|
@@ -423,8 +343,7 @@ type DeployedModelIds = string[];
|
|
|
423
343
|
type DeployedModelsInput = {
|
|
424
344
|
data: {
|
|
425
345
|
attributes: {
|
|
426
|
-
/** IDs of all models deployed to the deployment */
|
|
427
|
-
deployedModelIds: DeployedModelIds;
|
|
346
|
+
/** IDs of all models deployed to the deployment */deployedModelIds: DeployedModelIds;
|
|
428
347
|
};
|
|
429
348
|
type: "deployed-models";
|
|
430
349
|
};
|
|
@@ -433,53 +352,33 @@ type DeployedModelsInput = {
|
|
|
433
352
|
* A deployed model against which you can run predictions
|
|
434
353
|
*/
|
|
435
354
|
type Deployment = {
|
|
436
|
-
/** Timestamp when this was created */
|
|
437
|
-
|
|
438
|
-
|
|
439
|
-
|
|
440
|
-
|
|
441
|
-
|
|
442
|
-
/**
|
|
443
|
-
|
|
444
|
-
/**
|
|
445
|
-
|
|
446
|
-
/**
|
|
447
|
-
|
|
448
|
-
/**
|
|
449
|
-
errorMessage?: ErrorMessage;
|
|
450
|
-
/** JSON string with list of error objects */
|
|
451
|
-
errors?: Errors;
|
|
452
|
-
/** ID of this entity */
|
|
453
|
-
id: EntityId;
|
|
454
|
-
/** ID of the model */
|
|
455
|
-
modelId: ModelId;
|
|
456
|
-
/** Name of this entity */
|
|
457
|
-
name: EntityName;
|
|
458
|
-
/** ID of owner/user for this entity */
|
|
459
|
-
ownerId: OwnerId;
|
|
460
|
-
/** Space ID for this entity (empty string for personal space) */
|
|
461
|
-
spaceId: SpaceId;
|
|
462
|
-
/** Timestamp when this was updated */
|
|
355
|
+
/** Timestamp when this was created */createdAt: CreatedAt; /** ID of the owner/user that created this entity. */
|
|
356
|
+
createdBy: CreatedBy; /** IDs of all models deployed to the deployment */
|
|
357
|
+
deployedModelIds?: DeployedModelIds; /** Whether this deployment is deprecated */
|
|
358
|
+
deprecated: boolean; /** Description of this entity */
|
|
359
|
+
description: EntityDescription; /** Whether to allow predictions */
|
|
360
|
+
enablePredictions: boolean; /** JSON string of error object */
|
|
361
|
+
errorMessage?: ErrorMessage; /** JSON string with list of error objects */
|
|
362
|
+
errors?: Errors; /** ID of this entity */
|
|
363
|
+
id: EntityId; /** ID of the model */
|
|
364
|
+
modelId: ModelId; /** Name of this entity */
|
|
365
|
+
name: EntityName; /** ID of owner/user for this entity */
|
|
366
|
+
ownerId: OwnerId; /** Space ID for this entity (empty string for personal space) */
|
|
367
|
+
spaceId: SpaceId; /** Timestamp when this was updated */
|
|
463
368
|
updatedAt: UpdatedAt;
|
|
464
369
|
};
|
|
465
370
|
type DeploymentFindResponse = {
|
|
466
371
|
data: {
|
|
467
|
-
/** A deployed model against which you can run predictions */
|
|
468
|
-
attributes: Deployment;
|
|
469
|
-
/** ID of this entity */
|
|
372
|
+
/** A deployed model against which you can run predictions */attributes: Deployment; /** ID of this entity */
|
|
470
373
|
id: EntityId;
|
|
471
374
|
type: "deployment";
|
|
472
|
-
}[];
|
|
473
|
-
|
|
474
|
-
links: ResponseLinks;
|
|
475
|
-
/** Meta for FIND operations */
|
|
375
|
+
}[]; /** Resource links included in paginated responses */
|
|
376
|
+
links: ResponseLinks; /** Meta for FIND operations */
|
|
476
377
|
meta?: FindResponseMeta;
|
|
477
378
|
};
|
|
478
379
|
type DeploymentGetResponse = {
|
|
479
380
|
data: {
|
|
480
|
-
/** A deployed model against which you can run predictions */
|
|
481
|
-
attributes: Deployment;
|
|
482
|
-
/** ID of this entity */
|
|
381
|
+
/** A deployed model against which you can run predictions */attributes: Deployment; /** ID of this entity */
|
|
483
382
|
id: EntityId;
|
|
484
383
|
type: "deployment";
|
|
485
384
|
};
|
|
@@ -494,35 +393,24 @@ type DeploymentId = string;
|
|
|
494
393
|
type DeploymentInput = {
|
|
495
394
|
data?: {
|
|
496
395
|
attributes?: {
|
|
497
|
-
/** Whether this deployment is deprecated */
|
|
498
|
-
|
|
499
|
-
/**
|
|
500
|
-
|
|
501
|
-
/**
|
|
502
|
-
enablePredictions?: boolean;
|
|
503
|
-
/** ID of the model */
|
|
504
|
-
modelId: ModelId;
|
|
505
|
-
/** Name of this entity */
|
|
506
|
-
name: EntityName;
|
|
507
|
-
/** Space ID for this entity (empty string for personal space) */
|
|
396
|
+
/** Whether this deployment is deprecated */deprecated?: boolean; /** Description of this entity */
|
|
397
|
+
description?: EntityDescription; /** Whether to allow real-time predictions */
|
|
398
|
+
enablePredictions?: boolean; /** ID of the model */
|
|
399
|
+
modelId: ModelId; /** Name of this entity */
|
|
400
|
+
name: EntityName; /** Space ID for this entity (empty string for personal space) */
|
|
508
401
|
spaceId: SpaceId;
|
|
509
402
|
};
|
|
510
403
|
type?: "deployment";
|
|
511
404
|
};
|
|
512
405
|
};
|
|
513
406
|
type DeploymentPatch = {
|
|
514
|
-
/** All patch requests use the replace operation */
|
|
515
|
-
|
|
516
|
-
/** Path for the property you want to update */
|
|
517
|
-
path: "/name" | "/description" | "/spaceId";
|
|
518
|
-
/** Use for fields that can be `any` type (string, number, etc.) */
|
|
407
|
+
/** All patch requests use the replace operation */op: "replace"; /** Path for the property you want to update */
|
|
408
|
+
path: "/name" | "/description" | "/spaceId"; /** Use for fields that can be `any` type (string, number, etc.) */
|
|
519
409
|
value: AnyType;
|
|
520
410
|
}[];
|
|
521
411
|
type DeploymentPostResponse = {
|
|
522
412
|
data: {
|
|
523
|
-
/** A deployed model against which you can run predictions */
|
|
524
|
-
attributes: Deployment;
|
|
525
|
-
/** ID of this entity */
|
|
413
|
+
/** A deployed model against which you can run predictions */attributes: Deployment; /** ID of this entity */
|
|
526
414
|
id: EntityId;
|
|
527
415
|
type: "deployment";
|
|
528
416
|
};
|
|
@@ -531,9 +419,7 @@ type DeploymentPostResponse = {
|
|
|
531
419
|
* Feature dropped during preprocessing
|
|
532
420
|
*/
|
|
533
421
|
type DroppedFeature = {
|
|
534
|
-
/** Name of dropped feature in the dataset */
|
|
535
|
-
name?: string;
|
|
536
|
-
/** Reason the feature was dropped */
|
|
422
|
+
/** Name of dropped feature in the dataset */name?: string; /** Reason the feature was dropped */
|
|
537
423
|
reason?: "highly_correlated" | "has_target_leakage" | "is_date_engineered" | "feature_with_low_importance";
|
|
538
424
|
};
|
|
539
425
|
/**
|
|
@@ -566,41 +452,27 @@ type Errors = APIError[];
|
|
|
566
452
|
* An AutoML experiment
|
|
567
453
|
*/
|
|
568
454
|
type Experiment = {
|
|
569
|
-
/** Timestamp when this was created */
|
|
570
|
-
|
|
571
|
-
/**
|
|
572
|
-
|
|
573
|
-
/** ID
|
|
574
|
-
|
|
575
|
-
/**
|
|
576
|
-
name?: EntityName;
|
|
577
|
-
/** ID of owner/user for this entity */
|
|
578
|
-
ownerId: OwnerId;
|
|
579
|
-
/** Space ID for this entity (empty string for personal space) */
|
|
580
|
-
spaceId: SpaceId;
|
|
581
|
-
/** Tenant ID for this entity */
|
|
582
|
-
tenantId: TenantId;
|
|
583
|
-
/** Timestamp when this was updated */
|
|
455
|
+
/** Timestamp when this was created */createdAt: CreatedAt; /** Description of this entity */
|
|
456
|
+
description?: EntityDescription; /** ID of this entity */
|
|
457
|
+
id: EntityId; /** Name of this entity */
|
|
458
|
+
name?: EntityName; /** ID of owner/user for this entity */
|
|
459
|
+
ownerId: OwnerId; /** Space ID for this entity (empty string for personal space) */
|
|
460
|
+
spaceId: SpaceId; /** Tenant ID for this entity */
|
|
461
|
+
tenantId: TenantId; /** Timestamp when this was updated */
|
|
584
462
|
updatedAt: UpdatedAt;
|
|
585
463
|
};
|
|
586
464
|
type ExperimentFindResponse = {
|
|
587
465
|
data: {
|
|
588
|
-
/** An AutoML experiment */
|
|
589
|
-
attributes: Experiment;
|
|
590
|
-
/** ID of this entity */
|
|
466
|
+
/** An AutoML experiment */attributes: Experiment; /** ID of this entity */
|
|
591
467
|
id: EntityId;
|
|
592
468
|
type: "experiment";
|
|
593
|
-
}[];
|
|
594
|
-
|
|
595
|
-
links: ResponseLinks;
|
|
596
|
-
/** Meta for FIND operations */
|
|
469
|
+
}[]; /** Resource links included in paginated responses */
|
|
470
|
+
links: ResponseLinks; /** Meta for FIND operations */
|
|
597
471
|
meta?: FindResponseMeta;
|
|
598
472
|
};
|
|
599
473
|
type ExperimentGetResponse = {
|
|
600
474
|
data: {
|
|
601
|
-
/** An AutoML experiment */
|
|
602
|
-
attributes: Experiment;
|
|
603
|
-
/** ID of this entity */
|
|
475
|
+
/** An AutoML experiment */attributes: Experiment; /** ID of this entity */
|
|
604
476
|
id: EntityId;
|
|
605
477
|
type: "experiment";
|
|
606
478
|
};
|
|
@@ -613,15 +485,10 @@ type ExperimentId = string;
|
|
|
613
485
|
* Input for creating this entity
|
|
614
486
|
*/
|
|
615
487
|
type ExperimentInput = {
|
|
616
|
-
/** Data container for ExperimentInput */
|
|
617
|
-
|
|
618
|
-
|
|
619
|
-
|
|
620
|
-
/** Description of this entity */
|
|
621
|
-
description?: EntityDescription;
|
|
622
|
-
/** Name of this entity */
|
|
623
|
-
name: EntityName;
|
|
624
|
-
/** Space ID for this entity (empty string for personal space) */
|
|
488
|
+
/** Data container for ExperimentInput */data?: {
|
|
489
|
+
/** Experiment input attributes */attributes?: {
|
|
490
|
+
/** Description of this entity */description?: EntityDescription; /** Name of this entity */
|
|
491
|
+
name: EntityName; /** Space ID for this entity (empty string for personal space) */
|
|
625
492
|
spaceId: SpaceId;
|
|
626
493
|
};
|
|
627
494
|
type?: "experiment";
|
|
@@ -635,19 +502,14 @@ type ExperimentMode = "intelligent" | "manual" | "manual_hpo";
|
|
|
635
502
|
* Criteria to determine which pool of models to provide recommendations from
|
|
636
503
|
*/
|
|
637
504
|
type ExperimentModelRecommendationFilter = {
|
|
638
|
-
/** The model algorithms to consider */
|
|
639
|
-
|
|
640
|
-
/**
|
|
641
|
-
deployed?: boolean;
|
|
642
|
-
/** Whether to only consider models with 100% sampling */
|
|
643
|
-
fullSampling?: boolean;
|
|
644
|
-
/** The versionNumbers of the experiment versions to consider models from */
|
|
505
|
+
/** The model algorithms to consider */algorithms?: ModelAlgorithm[]; /** Whether to only consider models that are already deployed */
|
|
506
|
+
deployed?: boolean; /** Whether to only consider models with 100% sampling */
|
|
507
|
+
fullSampling?: boolean; /** The versionNumbers of the experiment versions to consider models from */
|
|
645
508
|
versionNumbers?: number[];
|
|
646
509
|
};
|
|
647
510
|
type ExperimentModelRecommendationPostResponse = {
|
|
648
511
|
data: {
|
|
649
|
-
/** Model recommendations */
|
|
650
|
-
attributes: {
|
|
512
|
+
/** Model recommendations */attributes: {
|
|
651
513
|
bestModel?: ModelForRecommendations;
|
|
652
514
|
fastestModel?: ModelForRecommendations;
|
|
653
515
|
mostAccurateModel?: ModelForRecommendations;
|
|
@@ -677,18 +539,13 @@ type ExperimentPatch = ExperimentPatchItem[];
|
|
|
677
539
|
* Experiment fields that can be patched. The following paths all require `value` to be a string: `/name`, `/spaceId`, and `/description`
|
|
678
540
|
*/
|
|
679
541
|
type ExperimentPatchItem = {
|
|
680
|
-
/** All patch requests use the replace operation */
|
|
681
|
-
|
|
682
|
-
/** Path for the property you want to update */
|
|
683
|
-
path: "/name" | "/description" | "/spaceId";
|
|
684
|
-
/** Use for fields that can be `any` type (string, number, etc.) */
|
|
542
|
+
/** All patch requests use the replace operation */op: "replace"; /** Path for the property you want to update */
|
|
543
|
+
path: "/name" | "/description" | "/spaceId"; /** Use for fields that can be `any` type (string, number, etc.) */
|
|
685
544
|
value: AnyType;
|
|
686
545
|
};
|
|
687
546
|
type ExperimentPostResponse = {
|
|
688
547
|
data: {
|
|
689
|
-
/** An AutoML experiment */
|
|
690
|
-
attributes: Experiment;
|
|
691
|
-
/** ID of this entity */
|
|
548
|
+
/** An AutoML experiment */attributes: Experiment; /** ID of this entity */
|
|
692
549
|
id: EntityId;
|
|
693
550
|
type: "experiment";
|
|
694
551
|
};
|
|
@@ -702,81 +559,57 @@ type ExperimentType = "binary" | "multiclass" | "regression";
|
|
|
702
559
|
* models within an experiment.
|
|
703
560
|
*/
|
|
704
561
|
type ExperimentVersion = {
|
|
705
|
-
/** List of algorithms selected for model training in this version */
|
|
706
|
-
|
|
707
|
-
/**
|
|
708
|
-
|
|
709
|
-
/**
|
|
710
|
-
|
|
711
|
-
/**
|
|
712
|
-
|
|
713
|
-
/**
|
|
714
|
-
|
|
715
|
-
/** A optional date column name to index */
|
|
716
|
-
dateIndexes?: DateIndexes;
|
|
717
|
-
/** JSON string of error object */
|
|
718
|
-
errorMessage?: ErrorMessage;
|
|
719
|
-
/** JSON string with list of error objects */
|
|
720
|
-
errors?: Errors;
|
|
721
|
-
/** ID of the experiment */
|
|
722
|
-
experimentId: ExperimentId;
|
|
723
|
-
/** The model training mode for the experiment version */
|
|
724
|
-
experimentMode?: ExperimentMode;
|
|
725
|
-
/** Experiment type */
|
|
562
|
+
/** List of algorithms selected for model training in this version */algorithms?: ModelAlgorithm[]; /** Timestamp when this was created */
|
|
563
|
+
createdAt: CreatedAt; /** ID of owner/user for this entity */
|
|
564
|
+
createdByUserId: OwnerId; /** The Qlik catalog dataset ID */
|
|
565
|
+
dataSetId: DataSetId; /** Whether this is a new or other dataset */
|
|
566
|
+
datasetOrigin?: DatasetOrigin; /** A optional date column name to index */
|
|
567
|
+
dateIndexes?: DateIndexes; /** JSON string of error object */
|
|
568
|
+
errorMessage?: ErrorMessage; /** JSON string with list of error objects */
|
|
569
|
+
errors?: Errors; /** ID of the experiment */
|
|
570
|
+
experimentId: ExperimentId; /** The model training mode for the experiment version */
|
|
571
|
+
experimentMode?: ExperimentMode; /** Experiment type */
|
|
726
572
|
experimentType: ExperimentType;
|
|
727
573
|
/** List of features from your dataset for creating Experiment
|
|
728
574
|
* Versions. This appears in from ProfileInsights response (in the
|
|
729
575
|
* defaultVersionConfig). You can adjust the default settings before
|
|
730
576
|
* using it as input to create or update Experiment Versions. */
|
|
731
|
-
featuresList?: FeaturesList;
|
|
732
|
-
/**
|
|
733
|
-
|
|
734
|
-
/** Number of the last batch */
|
|
735
|
-
lastBatchNum?: number;
|
|
736
|
-
/** Name of this entity */
|
|
577
|
+
featuresList?: FeaturesList; /** ID of this entity */
|
|
578
|
+
id: EntityId; /** Number of the last batch */
|
|
579
|
+
lastBatchNum?: number; /** Name of this entity */
|
|
737
580
|
name?: EntityName;
|
|
738
581
|
/** Pipeline metadata including transformations to apply to columns and
|
|
739
582
|
* specific schema configuration data */
|
|
740
|
-
pipeline?: Pipeline;
|
|
741
|
-
/**
|
|
742
|
-
|
|
743
|
-
|
|
744
|
-
profileId?: string;
|
|
745
|
-
/** Current status of this entity */
|
|
746
|
-
status: "ready" | "error" | "cancelled" | "pending" | "dataprep_requested" | "datasync_requested" | "datasync_done";
|
|
747
|
-
/** The target field in the dataset */
|
|
583
|
+
pipeline?: Pipeline; /** Preprocessed insights. Like feature insights but with fewer details. */
|
|
584
|
+
preprocessedInsights?: PreprocessedInsightColumn[]; /** ID of the dataset profile with metadata about source data */
|
|
585
|
+
profileId?: string; /** Current status of this entity */
|
|
586
|
+
status: "ready" | "error" | "cancelled" | "pending" | "dataprep_requested" | "datasync_requested" | "datasync_done"; /** The target field in the dataset */
|
|
748
587
|
target: string;
|
|
749
588
|
/** ID of the top model (based on training scores) in this experiment
|
|
750
589
|
* version */
|
|
751
590
|
topModelId?: string;
|
|
752
591
|
/** Optional training duration in seconds. If not provided, max value used.
|
|
753
592
|
* If provided, min 900 (15m) and max 21600 (6h). */
|
|
754
|
-
trainingDuration?: TrainingDuration;
|
|
755
|
-
/**
|
|
756
|
-
updatedAt: UpdatedAt;
|
|
757
|
-
/** 1-based sequential version number within the experiment */
|
|
593
|
+
trainingDuration?: TrainingDuration; /** Timestamp when this was updated */
|
|
594
|
+
updatedAt: UpdatedAt; /** 1-based sequential version number within the experiment */
|
|
758
595
|
versionNumber?: number;
|
|
759
596
|
};
|
|
760
597
|
type ExperimentVersionFindResponse = {
|
|
761
598
|
data: {
|
|
762
599
|
/** An AutoML experiment version. This is a configuration for training
|
|
763
600
|
* models within an experiment. */
|
|
764
|
-
attributes: ExperimentVersion;
|
|
765
|
-
/** ID of this entity */
|
|
601
|
+
attributes: ExperimentVersion; /** ID of this entity */
|
|
766
602
|
id: EntityId;
|
|
767
603
|
type: "experiment-version";
|
|
768
|
-
}[];
|
|
769
|
-
|
|
770
|
-
links: ResponseLinks;
|
|
771
|
-
/** Meta for FIND operations */
|
|
604
|
+
}[]; /** Resource links included in paginated responses */
|
|
605
|
+
links: ResponseLinks; /** Meta for FIND operations */
|
|
772
606
|
meta?: FindResponseMeta;
|
|
773
607
|
};
|
|
774
608
|
type ExperimentVersionGetResponse = {
|
|
775
609
|
data: {
|
|
776
610
|
/** An AutoML experiment version. This is a configuration for training
|
|
777
611
|
* models within an experiment. */
|
|
778
|
-
attributes: ExperimentVersion;
|
|
779
|
-
/** ID of this entity */
|
|
612
|
+
attributes: ExperimentVersion; /** ID of this entity */
|
|
780
613
|
id: EntityId;
|
|
781
614
|
type: "experiment-version";
|
|
782
615
|
};
|
|
@@ -798,16 +631,11 @@ type ExperimentVersionInput = {
|
|
|
798
631
|
*
|
|
799
632
|
* If not provided, defaults to all valid algorithms for your
|
|
800
633
|
* experimentType. */
|
|
801
|
-
algorithms?: ModelAlgorithm[];
|
|
802
|
-
/**
|
|
803
|
-
|
|
804
|
-
/**
|
|
805
|
-
|
|
806
|
-
/** A optional date column name to index */
|
|
807
|
-
dateIndexes?: DateIndexes;
|
|
808
|
-
/** The model training mode for the experiment version */
|
|
809
|
-
experimentMode: ExperimentMode;
|
|
810
|
-
/** Experiment type */
|
|
634
|
+
algorithms?: ModelAlgorithm[]; /** The Qlik catalog dataset ID */
|
|
635
|
+
dataSetId: DataSetId; /** Whether this is a new or other dataset */
|
|
636
|
+
datasetOrigin?: DatasetOrigin; /** A optional date column name to index */
|
|
637
|
+
dateIndexes?: DateIndexes; /** The model training mode for the experiment version */
|
|
638
|
+
experimentMode: ExperimentMode; /** Experiment type */
|
|
811
639
|
experimentType: ExperimentType;
|
|
812
640
|
/** List of features from your dataset for creating Experiment
|
|
813
641
|
* Versions. This appears in from ProfileInsights response (in the
|
|
@@ -829,19 +657,15 @@ type ExperimentVersionInput = {
|
|
|
829
657
|
};
|
|
830
658
|
};
|
|
831
659
|
type ExperimentVersionPatch = {
|
|
832
|
-
/** All patch requests use the replace operation */
|
|
833
|
-
|
|
834
|
-
/** Path for the properties you can update. */
|
|
835
|
-
path: "/name";
|
|
836
|
-
/** Use for fields that can be `any` type (string, number, etc.) */
|
|
660
|
+
/** All patch requests use the replace operation */op: "replace"; /** Path for the properties you can update. */
|
|
661
|
+
path: "/name"; /** Use for fields that can be `any` type (string, number, etc.) */
|
|
837
662
|
value: AnyType;
|
|
838
663
|
}[];
|
|
839
664
|
type ExperimentVersionPostResponse = {
|
|
840
665
|
data: {
|
|
841
666
|
/** An AutoML experiment version. This is a configuration for training
|
|
842
667
|
* models within an experiment. */
|
|
843
|
-
attributes: ExperimentVersion;
|
|
844
|
-
/** ID of this entity */
|
|
668
|
+
attributes: ExperimentVersion; /** ID of this entity */
|
|
845
669
|
id: EntityId;
|
|
846
670
|
type: "experiment-version";
|
|
847
671
|
};
|
|
@@ -856,8 +680,7 @@ type Failure = {
|
|
|
856
680
|
type Feature = {
|
|
857
681
|
/** Indicates if you want to change the featureType for this
|
|
858
682
|
* feature within the experiment version */
|
|
859
|
-
changeType?: ChangeType;
|
|
860
|
-
/** The data type of this feature in your dataset */
|
|
683
|
+
changeType?: ChangeType; /** The data type of this feature in your dataset */
|
|
861
684
|
dataType?: DataType;
|
|
862
685
|
/** The default feature type based on the feature's data type.
|
|
863
686
|
* If you want a value to be interpreted differently (e.g. 0/1
|
|
@@ -866,10 +689,8 @@ type Feature = {
|
|
|
866
689
|
/** Include this feature in your experiment version? Default
|
|
867
690
|
* here is based on insights for this feature
|
|
868
691
|
* (e.g. willBeDropped). */
|
|
869
|
-
include?: boolean;
|
|
870
|
-
/**
|
|
871
|
-
name?: string;
|
|
872
|
-
/** The parent feature name for engineered features. e.g. `OrderDate` may be the parent of its engineered features (features extracted from parent) like `OrderDate.YEAR`, `OrderDate.MONTH`, etc. */
|
|
692
|
+
include?: boolean; /** Name of the feature column */
|
|
693
|
+
name?: string; /** The parent feature name for engineered features. e.g. `OrderDate` may be the parent of its engineered features (features extracted from parent) like `OrderDate.YEAR`, `OrderDate.MONTH`, etc. */
|
|
873
694
|
parentFeature?: string;
|
|
874
695
|
};
|
|
875
696
|
/**
|
|
@@ -877,8 +698,7 @@ type Feature = {
|
|
|
877
698
|
* ProfileInsights.
|
|
878
699
|
*/
|
|
879
700
|
type FeatureInsights = {
|
|
880
|
-
/** Whether a feature cannot be the target field */
|
|
881
|
-
cannotBeTarget: boolean;
|
|
701
|
+
/** Whether a feature cannot be the target field */cannotBeTarget: boolean;
|
|
882
702
|
/** The default feature type based on the feature's data type.
|
|
883
703
|
* If you want a value to be interpreted differently (e.g. 0/1
|
|
884
704
|
* as categorical/boolean instead of numeric), use `changeType`. */
|
|
@@ -893,12 +713,9 @@ type FeatureInsights = {
|
|
|
893
713
|
* applies to possible date index columns. After the experiment version
|
|
894
714
|
* is created, we get a more precise number for subsequent versions.
|
|
895
715
|
* When training data is grouped, this estimate may be less accurate. */
|
|
896
|
-
estimatedMaxForecastHorizon?: number;
|
|
897
|
-
/**
|
|
898
|
-
|
|
899
|
-
/** List of insights about this feature. */
|
|
900
|
-
insights: Insights[];
|
|
901
|
-
/** Name of the feature insight */
|
|
716
|
+
estimatedMaxForecastHorizon?: number; /** Experiment types in this feature insight */
|
|
717
|
+
experimentTypes: ExperimentType[]; /** List of insights about this feature. */
|
|
718
|
+
insights: Insights[]; /** Name of the feature insight */
|
|
902
719
|
name: string;
|
|
903
720
|
/** Whether this feature will be dropped. Traits like high cardinality
|
|
904
721
|
* make some features less predictive or too costly to merit use. */
|
|
@@ -946,50 +763,34 @@ type JobType = "prediction";
|
|
|
946
763
|
* A model based on an algorithm within an experiment version.
|
|
947
764
|
*/
|
|
948
765
|
type Model = {
|
|
949
|
-
/** Model algorithm name abbreviation */
|
|
950
|
-
algoAbbrv?: ModelAlgorithmAbbreviation;
|
|
951
|
-
/** The algorithm used by this model */
|
|
766
|
+
/** Model algorithm name abbreviation */algoAbbrv?: ModelAlgorithmAbbreviation; /** The algorithm used by this model */
|
|
952
767
|
algorithm?: string;
|
|
953
768
|
anomalyRatio?: number;
|
|
954
769
|
/** Batch number indicates the index of the experiment version fold
|
|
955
770
|
* (most relevant when HPO is enabled) */
|
|
956
771
|
batchNum?: number;
|
|
957
772
|
binaryImbalanceSampling?: BinaryImbalanceSampling;
|
|
958
|
-
binningFeatures?: string[];
|
|
959
|
-
/**
|
|
960
|
-
|
|
961
|
-
/**
|
|
962
|
-
|
|
963
|
-
/**
|
|
964
|
-
|
|
965
|
-
/**
|
|
966
|
-
|
|
967
|
-
/**
|
|
968
|
-
errorMessage?: ErrorMessage;
|
|
969
|
-
/** JSON string with list of error objects */
|
|
970
|
-
errors?: Errors;
|
|
971
|
-
/** ID of the experiment version */
|
|
972
|
-
experimentVersionId?: ExperimentVersionId;
|
|
973
|
-
/** Version number of the hyperparameter optimization */
|
|
974
|
-
hpoNum?: number;
|
|
975
|
-
/** ID of this entity */
|
|
976
|
-
id?: EntityId;
|
|
977
|
-
/** Model metrics based on the type of model */
|
|
773
|
+
binningFeatures?: string[]; /** Dataset columns selected as features */
|
|
774
|
+
columns?: string[]; /** Timestamp when this was created */
|
|
775
|
+
createdAt?: CreatedAt; /** Description of this entity */
|
|
776
|
+
description?: EntityDescription; /** Features dropped because they're unsuitable */
|
|
777
|
+
droppedFeatures?: DroppedFeature[]; /** JSON string of error object */
|
|
778
|
+
errorMessage?: ErrorMessage; /** JSON string with list of error objects */
|
|
779
|
+
errors?: Errors; /** ID of the experiment version */
|
|
780
|
+
experimentVersionId?: ExperimentVersionId; /** Version number of the hyperparameter optimization */
|
|
781
|
+
hpoNum?: number; /** ID of this entity */
|
|
782
|
+
id?: EntityId; /** Model metrics based on the type of model */
|
|
978
783
|
metrics?: ModelMetrics;
|
|
979
784
|
/** Model state. These are the state of the model in relation to
|
|
980
785
|
* deployments. */
|
|
981
|
-
modelState?: ModelState;
|
|
982
|
-
/** Name of this entity */
|
|
786
|
+
modelState?: ModelState; /** Name of this entity */
|
|
983
787
|
name?: EntityName;
|
|
984
|
-
powerTransformFeatures?: string[];
|
|
985
|
-
|
|
986
|
-
samplingRatio?: number;
|
|
987
|
-
/** Model sequence number within the experiment version */
|
|
788
|
+
powerTransformFeatures?: string[]; /** Ratio of sample data in relation to the dataset */
|
|
789
|
+
samplingRatio?: number; /** Model sequence number within the experiment version */
|
|
988
790
|
seqNum?: number;
|
|
989
791
|
/** Model status. These are the status of the model in relation to
|
|
990
792
|
* experiments (i.e. training status). */
|
|
991
|
-
status?: ModelStatus;
|
|
992
|
-
/** Timestamp when this was updated */
|
|
793
|
+
status?: ModelStatus; /** Timestamp when this was updated */
|
|
993
794
|
updatedAt?: UpdatedAt;
|
|
994
795
|
};
|
|
995
796
|
/**
|
|
@@ -1008,28 +809,21 @@ type ModelAlgorithm = "catboost_classifier" | "catboost_regression" | "elasticne
|
|
|
1008
809
|
type ModelAlgorithmAbbreviation = "CATBC" | "CATBR" | "ELNC" | "GNBC" | "LGBMC" | "LGBMR" | "LINR" | "LOGC" | "LSOC" | "RAFC" | "RAFR" | "SGDR" | "XGBC" | "XGBR";
|
|
1009
810
|
type ModelFindResponse = {
|
|
1010
811
|
data: {
|
|
1011
|
-
/** A model based on an algorithm within an experiment version. */
|
|
1012
|
-
attributes: Model;
|
|
1013
|
-
/** ID of this entity */
|
|
812
|
+
/** A model based on an algorithm within an experiment version. */attributes: Model; /** ID of this entity */
|
|
1014
813
|
id: EntityId;
|
|
1015
814
|
type: "model";
|
|
1016
|
-
}[];
|
|
1017
|
-
|
|
1018
|
-
links: ResponseLinks;
|
|
1019
|
-
/** Meta for FIND operations */
|
|
815
|
+
}[]; /** Resource links included in paginated responses */
|
|
816
|
+
links: ResponseLinks; /** Meta for FIND operations */
|
|
1020
817
|
meta?: FindResponseMeta;
|
|
1021
818
|
};
|
|
1022
819
|
type ModelForRecommendations = Model & {
|
|
1023
820
|
metrics?: {
|
|
1024
|
-
/** This represents model prediction speed in rows/second */
|
|
1025
|
-
predictionSpeed: number;
|
|
821
|
+
/** This represents model prediction speed in rows/second */predictionSpeed: number;
|
|
1026
822
|
};
|
|
1027
823
|
};
|
|
1028
824
|
type ModelGetResponse = {
|
|
1029
825
|
data: {
|
|
1030
|
-
/** A model based on an algorithm within an experiment version. */
|
|
1031
|
-
attributes: Model;
|
|
1032
|
-
/** ID of this entity */
|
|
826
|
+
/** A model based on an algorithm within an experiment version. */attributes: Model; /** ID of this entity */
|
|
1033
827
|
id: EntityId;
|
|
1034
828
|
type: "model";
|
|
1035
829
|
};
|
|
@@ -1042,8 +836,7 @@ type ModelId = string;
|
|
|
1042
836
|
* Model information stored on an alias
|
|
1043
837
|
*/
|
|
1044
838
|
type ModelInfo = {
|
|
1045
|
-
/** ID of this entity */
|
|
1046
|
-
id?: EntityId;
|
|
839
|
+
/** ID of this entity */id?: EntityId;
|
|
1047
840
|
};
|
|
1048
841
|
/**
|
|
1049
842
|
* Model metrics based on the type of model
|
|
@@ -1057,8 +850,7 @@ type ModelMetrics = {
|
|
|
1057
850
|
multiclass?: ModelMetricsMulticlass;
|
|
1058
851
|
/** Regression metrics for numeric values. Details:
|
|
1059
852
|
* https://help.qlik.com/en-US/cloud-services/Subsystems/Hub/Content/Sense_Hub/AutoML/scoring-regression.htm */
|
|
1060
|
-
regression?: ModelMetricsRegression;
|
|
1061
|
-
/** Timeseries metrics experiments valid for timeseries forecasting. */
|
|
853
|
+
regression?: ModelMetricsRegression; /** Timeseries metrics experiments valid for timeseries forecasting. */
|
|
1062
854
|
timeseries?: ModelMetricsTimeseries;
|
|
1063
855
|
};
|
|
1064
856
|
/**
|
|
@@ -1071,68 +863,40 @@ type ModelMetricsBinary = {
|
|
|
1071
863
|
accuracy?: number;
|
|
1072
864
|
/** Average measure of how often the model made correct predictions
|
|
1073
865
|
* (test data) */
|
|
1074
|
-
accuracyTest?: number;
|
|
1075
|
-
/** Area under curve (
|
|
1076
|
-
|
|
1077
|
-
/**
|
|
1078
|
-
|
|
1079
|
-
/** The
|
|
1080
|
-
|
|
1081
|
-
/**
|
|
1082
|
-
|
|
1083
|
-
/**
|
|
1084
|
-
|
|
1085
|
-
/**
|
|
1086
|
-
|
|
1087
|
-
|
|
1088
|
-
|
|
1089
|
-
|
|
1090
|
-
|
|
1091
|
-
|
|
1092
|
-
falsePositive?: number;
|
|
1093
|
-
/** Actual false values incorrectly predicted as true (test data) */
|
|
1094
|
-
falsePositiveTest?: number;
|
|
1095
|
-
/** Measures accuracy in logistic regression (training data) */
|
|
1096
|
-
logLoss?: number;
|
|
1097
|
-
/** Measures accuracy in logistic regression (test data) */
|
|
1098
|
-
logLossTest?: number;
|
|
1099
|
-
/** Matthews correlation coefficient (training data) */
|
|
1100
|
-
mcc?: number;
|
|
1101
|
-
/** Matthews correlation coefficient (test data) */
|
|
1102
|
-
mccTest?: number;
|
|
1103
|
-
/** The false negative rate (training data) */
|
|
1104
|
-
missRate?: number;
|
|
1105
|
-
/** The false negative rate (test data) */
|
|
1106
|
-
missRateTest?: number;
|
|
1107
|
-
/** Negative predictive value (training data) */
|
|
1108
|
-
npv?: number;
|
|
1109
|
-
/** Negative predictive value (test data) */
|
|
866
|
+
accuracyTest?: number; /** Area under curve (training data) */
|
|
867
|
+
auc?: number; /** Area under curve (test data) */
|
|
868
|
+
aucTest?: number; /** The harmonic mean of precision and recall for training data */
|
|
869
|
+
f1?: number; /** The harmonic mean of precision and recall for test data */
|
|
870
|
+
f1Test?: number; /** The false positive rate (training data) */
|
|
871
|
+
fallout?: number; /** The false positive rate (test data) */
|
|
872
|
+
falloutTest?: number; /** Actual true values incorrectly predicted as false (training data) */
|
|
873
|
+
falseNegative?: number; /** Actual true values incorrectly predicted as false (test data) */
|
|
874
|
+
falseNegativeTest?: number; /** Actual false values incorrectly predicted as true (training data) */
|
|
875
|
+
falsePositive?: number; /** Actual false values incorrectly predicted as true (test data) */
|
|
876
|
+
falsePositiveTest?: number; /** Measures accuracy in logistic regression (training data) */
|
|
877
|
+
logLoss?: number; /** Measures accuracy in logistic regression (test data) */
|
|
878
|
+
logLossTest?: number; /** Matthews correlation coefficient (training data) */
|
|
879
|
+
mcc?: number; /** Matthews correlation coefficient (test data) */
|
|
880
|
+
mccTest?: number; /** The false negative rate (training data) */
|
|
881
|
+
missRate?: number; /** The false negative rate (test data) */
|
|
882
|
+
missRateTest?: number; /** Negative predictive value (training data) */
|
|
883
|
+
npv?: number; /** Negative predictive value (test data) */
|
|
1110
884
|
npvTest?: number;
|
|
1111
885
|
/** Positive predictive value. Probability that the model was correct
|
|
1112
886
|
* when it predicted something was true. (training data) */
|
|
1113
887
|
precision?: number;
|
|
1114
888
|
/** Positive predictive value. Probability that the model was correct
|
|
1115
889
|
* when it predicted something was true. (test data) */
|
|
1116
|
-
precisionTest?: number;
|
|
1117
|
-
/** The true positive rate (
|
|
1118
|
-
|
|
1119
|
-
/** The true
|
|
1120
|
-
|
|
1121
|
-
/**
|
|
1122
|
-
|
|
1123
|
-
/**
|
|
1124
|
-
|
|
1125
|
-
/**
|
|
1126
|
-
threshold?: number;
|
|
1127
|
-
/** Probability that a prediction is true (test data) */
|
|
1128
|
-
thresholdTest?: number;
|
|
1129
|
-
/** Actual false values correctly predicted as false (training data) */
|
|
1130
|
-
trueNegative?: number;
|
|
1131
|
-
/** Actual false values correctly predicted as false (test data) */
|
|
1132
|
-
trueNegativeTest?: number;
|
|
1133
|
-
/** Actual true values correctly predicted as true (training data) */
|
|
1134
|
-
truePositive?: number;
|
|
1135
|
-
/** Actual true values correctly predicted as true (test data) */
|
|
890
|
+
precisionTest?: number; /** The true positive rate (training data) */
|
|
891
|
+
recall?: number; /** The true positive rate (test data) */
|
|
892
|
+
recallTest?: number; /** The true negative rate (training data) */
|
|
893
|
+
specificity?: number; /** The true negative rate (test data) */
|
|
894
|
+
specificityTest?: number; /** Probability that a prediction is true (training data) */
|
|
895
|
+
threshold?: number; /** Probability that a prediction is true (test data) */
|
|
896
|
+
thresholdTest?: number; /** Actual false values correctly predicted as false (training data) */
|
|
897
|
+
trueNegative?: number; /** Actual false values correctly predicted as false (test data) */
|
|
898
|
+
trueNegativeTest?: number; /** Actual true values correctly predicted as true (training data) */
|
|
899
|
+
truePositive?: number; /** Actual true values correctly predicted as true (test data) */
|
|
1136
900
|
truePositiveTest?: number;
|
|
1137
901
|
};
|
|
1138
902
|
/**
|
|
@@ -1142,8 +906,7 @@ type ModelMetricsBinary = {
|
|
|
1142
906
|
type ModelMetricsMulticlass = {
|
|
1143
907
|
/** Average of how often the model made a correct prediction (training
|
|
1144
908
|
* data) */
|
|
1145
|
-
accuracy?: number;
|
|
1146
|
-
/** Average of how often the model made a correct prediction (test data) */
|
|
909
|
+
accuracy?: number; /** Average of how often the model made a correct prediction (test data) */
|
|
1147
910
|
accuracyTest?: number;
|
|
1148
911
|
/** A matrix summary of the accuracy of predictions in a classification
|
|
1149
912
|
* model (training data) */
|
|
@@ -1162,10 +925,8 @@ type ModelMetricsMulticlass = {
|
|
|
1162
925
|
f1Micro?: number;
|
|
1163
926
|
/** Micro F1 is the F1 value calculated across the entire confusion
|
|
1164
927
|
* matrix (test data) */
|
|
1165
|
-
f1MicroTest?: number;
|
|
1166
|
-
/** Weighted F1 (
|
|
1167
|
-
f1Weighted?: number;
|
|
1168
|
-
/** Weighted F1 (test data) */
|
|
928
|
+
f1MicroTest?: number; /** Weighted F1 (training data) */
|
|
929
|
+
f1Weighted?: number; /** Weighted F1 (test data) */
|
|
1169
930
|
f1WeightedTest?: number;
|
|
1170
931
|
};
|
|
1171
932
|
/**
|
|
@@ -1173,62 +934,36 @@ type ModelMetricsMulticlass = {
|
|
|
1173
934
|
* https://help.qlik.com/en-US/cloud-services/Subsystems/Hub/Content/Sense_Hub/AutoML/scoring-regression.htm
|
|
1174
935
|
*/
|
|
1175
936
|
type ModelMetricsRegression = {
|
|
1176
|
-
/** Mean absolute error (training data) */
|
|
1177
|
-
|
|
1178
|
-
/** Mean
|
|
1179
|
-
|
|
1180
|
-
/**
|
|
1181
|
-
|
|
1182
|
-
/**
|
|
1183
|
-
mseTest?: number;
|
|
1184
|
-
/** R squared (training data) */
|
|
1185
|
-
r2?: number;
|
|
1186
|
-
/** R squared (test data) */
|
|
1187
|
-
r2Test?: number;
|
|
1188
|
-
/** Root mean squared error (training data) */
|
|
1189
|
-
rmse?: number;
|
|
1190
|
-
/** Root mean squared error (test data) */
|
|
937
|
+
/** Mean absolute error (training data) */mae?: number; /** Mean absolute error (test data) */
|
|
938
|
+
maeTest?: number; /** Mean squared error (training data) */
|
|
939
|
+
mse?: number; /** Mean squared error (test data) */
|
|
940
|
+
mseTest?: number; /** R squared (training data) */
|
|
941
|
+
r2?: number; /** R squared (test data) */
|
|
942
|
+
r2Test?: number; /** Root mean squared error (training data) */
|
|
943
|
+
rmse?: number; /** Root mean squared error (test data) */
|
|
1191
944
|
rmseTest?: number;
|
|
1192
945
|
};
|
|
1193
946
|
/**
|
|
1194
947
|
* Timeseries metrics experiments valid for timeseries forecasting.
|
|
1195
948
|
*/
|
|
1196
949
|
type ModelMetricsTimeseries = {
|
|
1197
|
-
/** Mean absolute error (training data) */
|
|
1198
|
-
|
|
1199
|
-
/** Mean absolute error (test data) */
|
|
1200
|
-
|
|
1201
|
-
/** Mean absolute
|
|
1202
|
-
|
|
1203
|
-
/**
|
|
1204
|
-
|
|
1205
|
-
/**
|
|
1206
|
-
|
|
1207
|
-
/** Mean
|
|
1208
|
-
|
|
1209
|
-
/**
|
|
1210
|
-
|
|
1211
|
-
/**
|
|
1212
|
-
|
|
1213
|
-
/**
|
|
1214
|
-
mdnrmse?: number;
|
|
1215
|
-
/** Median root mean squared error (test data) */
|
|
1216
|
-
mdnrmseTest?: number;
|
|
1217
|
-
/** Mean root mean squared error (training data) */
|
|
1218
|
-
mnrmse?: number;
|
|
1219
|
-
/** Mean root mean squared error (test data) */
|
|
1220
|
-
mnrmseTest?: number;
|
|
1221
|
-
/** Root mean squared error (training data) */
|
|
1222
|
-
rmse?: number;
|
|
1223
|
-
/** Root mean squared error (test data) */
|
|
1224
|
-
rmseTest?: number;
|
|
1225
|
-
/** Symmetric mean absolute percentage error (training data) */
|
|
1226
|
-
smape?: number;
|
|
1227
|
-
/** Symmetric mean absolute percentage error (test data) */
|
|
1228
|
-
smapeTest?: number;
|
|
1229
|
-
/** Weighted mean absolute percentage error (training data) */
|
|
1230
|
-
wmape?: number;
|
|
1231
|
-
/** Weighted mean absolute percentage error (test data) */
|
|
950
|
+
/** Mean absolute error (training data) */mae?: number; /** Mean absolute error (test data) */
|
|
951
|
+
maeTest?: number; /** Mean absolute percentage error (training data) */
|
|
952
|
+
mape?: number; /** Mean absolute percentage error (test data) */
|
|
953
|
+
mapeTest?: number; /** Mean absolute scaled error (training data) */
|
|
954
|
+
mase?: number; /** Mean absolute scaled error (test data) */
|
|
955
|
+
maseTest?: number; /** Median absolute percentage error (training data) */
|
|
956
|
+
mdape?: number; /** Median absolute percentage error (test data) */
|
|
957
|
+
mdapeTest?: number; /** Median root mean squared error (training data) */
|
|
958
|
+
mdnrmse?: number; /** Median root mean squared error (test data) */
|
|
959
|
+
mdnrmseTest?: number; /** Mean root mean squared error (training data) */
|
|
960
|
+
mnrmse?: number; /** Mean root mean squared error (test data) */
|
|
961
|
+
mnrmseTest?: number; /** Root mean squared error (training data) */
|
|
962
|
+
rmse?: number; /** Root mean squared error (test data) */
|
|
963
|
+
rmseTest?: number; /** Symmetric mean absolute percentage error (training data) */
|
|
964
|
+
smape?: number; /** Symmetric mean absolute percentage error (test data) */
|
|
965
|
+
smapeTest?: number; /** Weighted mean absolute percentage error (training data) */
|
|
966
|
+
wmape?: number; /** Weighted mean absolute percentage error (test data) */
|
|
1232
967
|
wmapeTest?: number;
|
|
1233
968
|
};
|
|
1234
969
|
/**
|
|
@@ -1243,12 +978,10 @@ type ModelState = "pending" | "enabled" | "disabled" | "inactive";
|
|
|
1243
978
|
type ModelStatus = "pending" | "training_requested" | "training_done" | "ready" | "error";
|
|
1244
979
|
type ModelsInfo = ModelInfo[];
|
|
1245
980
|
type OutputFile = {
|
|
1246
|
-
fileName: string;
|
|
1247
|
-
/** Dataset file type */
|
|
981
|
+
fileName: string; /** Dataset file type */
|
|
1248
982
|
fileType: FileType;
|
|
1249
983
|
key: string;
|
|
1250
|
-
path: string;
|
|
1251
|
-
/** Space ID for this entity (empty string for personal space) */
|
|
984
|
+
path: string; /** Space ID for this entity (empty string for personal space) */
|
|
1252
985
|
spaceId: SpaceId;
|
|
1253
986
|
};
|
|
1254
987
|
/**
|
|
@@ -1267,43 +1000,31 @@ type Pipeline = {
|
|
|
1267
1000
|
transforms?: Transform[];
|
|
1268
1001
|
};
|
|
1269
1002
|
type PredictionJobResponse = {
|
|
1270
|
-
/** The ID of a correlated resource of corrType */
|
|
1271
|
-
corrId: CorrId;
|
|
1003
|
+
/** The ID of a correlated resource of corrType */corrId: CorrId;
|
|
1272
1004
|
/** Types names of correlated resources (batch 'prediction' and
|
|
1273
1005
|
* experiment_version) */
|
|
1274
|
-
corrType: CorrType;
|
|
1275
|
-
/**
|
|
1276
|
-
|
|
1277
|
-
/** ID of
|
|
1278
|
-
createdBy: string;
|
|
1279
|
-
/** Timestamp when this is deleted */
|
|
1280
|
-
deletedAt: DeletedAt;
|
|
1281
|
-
/** ID of a model deployment */
|
|
1006
|
+
corrType: CorrType; /** Timestamp when this was created */
|
|
1007
|
+
createdAt: CreatedAt; /** ID of the owner/user that created this entity */
|
|
1008
|
+
createdBy: string; /** Timestamp when this is deleted */
|
|
1009
|
+
deletedAt: DeletedAt; /** ID of a model deployment */
|
|
1282
1010
|
deploymentId: DeploymentId;
|
|
1283
1011
|
details: {
|
|
1284
1012
|
isScheduled: boolean;
|
|
1285
1013
|
lineageSchemaUpdated: boolean;
|
|
1286
1014
|
outputFiles: OutputFile[];
|
|
1287
1015
|
};
|
|
1288
|
-
experimentVersionNumber: string;
|
|
1289
|
-
/**
|
|
1290
|
-
|
|
1291
|
-
/** The type for this job */
|
|
1292
|
-
jobType: JobType;
|
|
1293
|
-
/** ID of the model */
|
|
1016
|
+
experimentVersionNumber: string; /** ID of this entity */
|
|
1017
|
+
id: EntityId; /** The type for this job */
|
|
1018
|
+
jobType: JobType; /** ID of the model */
|
|
1294
1019
|
modelId: ModelId;
|
|
1295
|
-
name: string;
|
|
1296
|
-
/** ID of the current job's parent */
|
|
1020
|
+
name: string; /** ID of the current job's parent */
|
|
1297
1021
|
parentJobId: ParentJobId;
|
|
1298
1022
|
parentName: string;
|
|
1299
|
-
rowsPredicted: number;
|
|
1300
|
-
/** Status of this job */
|
|
1023
|
+
rowsPredicted: number; /** Status of this job */
|
|
1301
1024
|
status: "pending" | "completed" | "cancelled" | "error";
|
|
1302
|
-
success: boolean;
|
|
1303
|
-
/** Tenant ID for this entity */
|
|
1025
|
+
success: boolean; /** Tenant ID for this entity */
|
|
1304
1026
|
tenantId: TenantId;
|
|
1305
|
-
trigger: string;
|
|
1306
|
-
/** Timestamp when this was updated */
|
|
1027
|
+
trigger: string; /** Timestamp when this was updated */
|
|
1307
1028
|
updatedAt: UpdatedAt;
|
|
1308
1029
|
};
|
|
1309
1030
|
/**
|
|
@@ -1312,8 +1033,7 @@ type PredictionJobResponse = {
|
|
|
1312
1033
|
type PreprocessedInsightColumn = {
|
|
1313
1034
|
/** Preliminary list of column/feature insights available after
|
|
1314
1035
|
* preprocessing but before feature insights are available */
|
|
1315
|
-
insights: ("is_free_text" | "cannot_be_processed_as_free_text" | "is_date_engineered" | "has_target_leakage" | "feature_type_change_invalid" | "feature_type_change_failed" | "feature_type_change_successful" | "data_bias_detected" | "representation_bias_detected")[];
|
|
1316
|
-
/** Name of the preprocessed insight column */
|
|
1036
|
+
insights: ("is_free_text" | "cannot_be_processed_as_free_text" | "is_date_engineered" | "has_target_leakage" | "feature_type_change_invalid" | "feature_type_change_failed" | "feature_type_change_successful" | "data_bias_detected" | "representation_bias_detected")[]; /** Name of the preprocessed insight column */
|
|
1317
1037
|
name: string;
|
|
1318
1038
|
/** Whether this feature insight will be dropped due to free text or
|
|
1319
1039
|
* high cardinality that makes it less useful */
|
|
@@ -1323,14 +1043,10 @@ type PreprocessedInsightColumn = {
|
|
|
1323
1043
|
* Insights (metadata) about an experiment dataset
|
|
1324
1044
|
*/
|
|
1325
1045
|
type ProfileInsights = {
|
|
1326
|
-
/** List of algorithms available for the selected experiment type */
|
|
1327
|
-
algorithms?: ModelAlgorithm[];
|
|
1046
|
+
/** List of algorithms available for the selected experiment type */algorithms?: ModelAlgorithm[];
|
|
1328
1047
|
defaultVersionConfig?: {
|
|
1329
|
-
/** The Qlik catalog dataset ID */
|
|
1330
|
-
|
|
1331
|
-
/** Whether this is a new or other dataset */
|
|
1332
|
-
datasetOrigin: DatasetOrigin;
|
|
1333
|
-
/** The model training mode for the experiment version */
|
|
1048
|
+
/** The Qlik catalog dataset ID */dataSetId: DataSetId; /** Whether this is a new or other dataset */
|
|
1049
|
+
datasetOrigin: DatasetOrigin; /** The model training mode for the experiment version */
|
|
1334
1050
|
experimentMode: ExperimentMode;
|
|
1335
1051
|
/** List of features from your dataset for creating Experiment
|
|
1336
1052
|
* Versions. This appears in from ProfileInsights response (in the
|
|
@@ -1341,10 +1057,8 @@ type ProfileInsights = {
|
|
|
1341
1057
|
};
|
|
1342
1058
|
/** Optional experiment version ID. When included, it indicates that
|
|
1343
1059
|
* this dataset profile is a snapshot from a previous version. */
|
|
1344
|
-
experimentVersionId?: string;
|
|
1345
|
-
|
|
1346
|
-
insights?: FeatureInsights[];
|
|
1347
|
-
/** Is this a CSV dataset > 1GB? */
|
|
1060
|
+
experimentVersionId?: string; /** List of feature insights object, one per feature in the dataset */
|
|
1061
|
+
insights?: FeatureInsights[]; /** Is this a CSV dataset > 1GB? */
|
|
1348
1062
|
isLargeCsv?: boolean;
|
|
1349
1063
|
/** Number of rows in the dataset.
|
|
1350
1064
|
*
|
|
@@ -1355,21 +1069,15 @@ type ProfileInsights = {
|
|
|
1355
1069
|
* included in experiment version) to calculate total `cells` to
|
|
1356
1070
|
* ensure it stays under your license limit. Large CSVs have a hard
|
|
1357
1071
|
* 100M cell limit. */
|
|
1358
|
-
numberOfRows?: number;
|
|
1359
|
-
/**
|
|
1360
|
-
|
|
1361
|
-
|
|
1362
|
-
sizeInBytes?: number;
|
|
1363
|
-
/** Status of profile insights. Not available until `ready`. */
|
|
1364
|
-
status: "pending" | "error" | "ready";
|
|
1365
|
-
/** Tenant ID for this entity */
|
|
1072
|
+
numberOfRows?: number; /** ID of owner/user for this entity */
|
|
1073
|
+
ownerId: OwnerId; /** Size of the profiled dataset in bytes. */
|
|
1074
|
+
sizeInBytes?: number; /** Status of profile insights. Not available until `ready`. */
|
|
1075
|
+
status: "pending" | "error" | "ready"; /** Tenant ID for this entity */
|
|
1366
1076
|
tenantId: TenantId;
|
|
1367
1077
|
};
|
|
1368
1078
|
type ProfileInsightsGetResponse = {
|
|
1369
1079
|
data: {
|
|
1370
|
-
/** Insights (metadata) about an experiment dataset */
|
|
1371
|
-
attributes: ProfileInsights;
|
|
1372
|
-
/** ID of this entity */
|
|
1080
|
+
/** Insights (metadata) about an experiment dataset */attributes: ProfileInsights; /** ID of this entity */
|
|
1373
1081
|
id: EntityId;
|
|
1374
1082
|
type: "profile-insights";
|
|
1375
1083
|
};
|
|
@@ -1379,29 +1087,21 @@ type ProfileInsightsGetResponse = {
|
|
|
1379
1087
|
* experiment versions
|
|
1380
1088
|
*/
|
|
1381
1089
|
type ProfileInsightsInput = {
|
|
1382
|
-
/** Data wrapper for request input */
|
|
1383
|
-
|
|
1384
|
-
|
|
1385
|
-
|
|
1386
|
-
/**
|
|
1387
|
-
dataSetId?: DataSetId;
|
|
1388
|
-
/** Experiment type */
|
|
1389
|
-
experimentType?: ExperimentType;
|
|
1390
|
-
/** Whether the server should or client should manage polling/waiting */
|
|
1391
|
-
shouldWait?: boolean;
|
|
1392
|
-
/** Optional selected target provided on subsequent requests */
|
|
1090
|
+
/** Data wrapper for request input */data?: {
|
|
1091
|
+
/** The request body for this resource */attributes?: {
|
|
1092
|
+
/** The Qlik catalog dataset ID */dataSetId?: DataSetId; /** Experiment type */
|
|
1093
|
+
experimentType?: ExperimentType; /** Whether the server should or client should manage polling/waiting */
|
|
1094
|
+
shouldWait?: boolean; /** Optional selected target provided on subsequent requests */
|
|
1393
1095
|
target?: string;
|
|
1394
1096
|
};
|
|
1395
1097
|
type?: "profile-insights";
|
|
1396
1098
|
};
|
|
1397
1099
|
};
|
|
1398
1100
|
type RealTimePredictionInputSchema = {
|
|
1399
|
-
/** The name of a feature in the dataset */
|
|
1400
|
-
name?: string;
|
|
1101
|
+
/** The name of a feature in the dataset */name?: string;
|
|
1401
1102
|
};
|
|
1402
1103
|
type RealTimePredictionSchema = {
|
|
1403
|
-
/** The name of a feature in the dataset */
|
|
1404
|
-
name?: string;
|
|
1104
|
+
/** The name of a feature in the dataset */name?: string;
|
|
1405
1105
|
};
|
|
1406
1106
|
/**
|
|
1407
1107
|
* Input values for creating realtime predictions
|
|
@@ -1409,9 +1109,7 @@ type RealTimePredictionSchema = {
|
|
|
1409
1109
|
type RealtimePrediction = {
|
|
1410
1110
|
data?: {
|
|
1411
1111
|
attributes?: {
|
|
1412
|
-
/** Rows of the dataset from which to produce predictions */
|
|
1413
|
-
rows?: string[][];
|
|
1414
|
-
/** List of features in the dataset */
|
|
1112
|
+
/** Rows of the dataset from which to produce predictions */rows?: string[][]; /** List of features in the dataset */
|
|
1415
1113
|
schema?: RealTimePredictionSchema[];
|
|
1416
1114
|
};
|
|
1417
1115
|
type?: "realtime-prediction";
|
|
@@ -1423,8 +1121,7 @@ type RealtimePrediction = {
|
|
|
1423
1121
|
type RealtimePredictionInput = {
|
|
1424
1122
|
/** Rows of the dataset from which to produce predictions.
|
|
1425
1123
|
* Date features must be in ISO 8601 format. */
|
|
1426
|
-
rows?: string[][];
|
|
1427
|
-
/** List of features in the dataset. */
|
|
1124
|
+
rows?: string[][]; /** List of features in the dataset. */
|
|
1428
1125
|
schema?: RealTimePredictionInputSchema[];
|
|
1429
1126
|
};
|
|
1430
1127
|
/**
|
|
@@ -1432,8 +1129,7 @@ type RealtimePredictionInput = {
|
|
|
1432
1129
|
*/
|
|
1433
1130
|
type ResponseLinks = {
|
|
1434
1131
|
first: {
|
|
1435
|
-
/** Link to the first set of responses from `offset` 0 to count `limit`` */
|
|
1436
|
-
href?: string;
|
|
1132
|
+
/** Link to the first set of responses from `offset` 0 to count `limit`` */href?: string;
|
|
1437
1133
|
};
|
|
1438
1134
|
last: {
|
|
1439
1135
|
/** Link to the last set of responses from `limit` minus `offset` to
|
|
@@ -1441,16 +1137,13 @@ type ResponseLinks = {
|
|
|
1441
1137
|
href?: string;
|
|
1442
1138
|
};
|
|
1443
1139
|
next: {
|
|
1444
|
-
/** Link to the next set of responses */
|
|
1445
|
-
href?: string;
|
|
1140
|
+
/** Link to the next set of responses */href?: string;
|
|
1446
1141
|
};
|
|
1447
1142
|
prev: {
|
|
1448
|
-
/** Link to the previous set of responses */
|
|
1449
|
-
href?: string;
|
|
1143
|
+
/** Link to the previous set of responses */href?: string;
|
|
1450
1144
|
};
|
|
1451
1145
|
self: {
|
|
1452
|
-
/** Link to the current set of responses */
|
|
1453
|
-
href?: string;
|
|
1146
|
+
/** Link to the current set of responses */href?: string;
|
|
1454
1147
|
};
|
|
1455
1148
|
};
|
|
1456
1149
|
/**
|
|
@@ -1500,12 +1193,9 @@ declare function getMlDeployments(query: {
|
|
|
1500
1193
|
* - `exactName` string - Deployments with exact name. Names may not be unique.
|
|
1501
1194
|
* - `nameContains` string - Deployments where name includes this. Names may not be unique
|
|
1502
1195
|
* - `experimentType` string - Deployments that have models of the experiment type */
|
|
1503
|
-
filter?: string;
|
|
1504
|
-
/** Number of
|
|
1505
|
-
|
|
1506
|
-
/** Number of rows to skip before getting page[size] */
|
|
1507
|
-
offset?: number;
|
|
1508
|
-
/** Field(s) by which to sort response */
|
|
1196
|
+
filter?: string; /** Number of results per page. Default is 32. */
|
|
1197
|
+
limit?: number; /** Number of rows to skip before getting page[size] */
|
|
1198
|
+
offset?: number; /** Field(s) by which to sort response */
|
|
1509
1199
|
sort?: EnumSortDeployments;
|
|
1510
1200
|
}, options?: ApiCallOptions): Promise<GetMlDeploymentsHttpResponse>;
|
|
1511
1201
|
type GetMlDeploymentsHttpResponse = {
|
|
@@ -1635,12 +1325,9 @@ declare function getMlDeploymentAliases(deploymentId: string, query: {
|
|
|
1635
1325
|
* - `name` string - Aliases with exact name
|
|
1636
1326
|
* - `modelId` UUID string - By model ID
|
|
1637
1327
|
* - `mode` enum string - Mode by which alias is set to */
|
|
1638
|
-
filter?: string;
|
|
1639
|
-
/** Number of
|
|
1640
|
-
|
|
1641
|
-
/** Number of rows to skip before getting page[size] */
|
|
1642
|
-
offset?: number;
|
|
1643
|
-
/** Field(s) by which to sort response */
|
|
1328
|
+
filter?: string; /** Number of results per page. Default is 32. */
|
|
1329
|
+
limit?: number; /** Number of rows to skip before getting page[size] */
|
|
1330
|
+
offset?: number; /** Field(s) by which to sort response */
|
|
1644
1331
|
sort?: EnumSortAliases;
|
|
1645
1332
|
}, options?: ApiCallOptions): Promise<GetMlDeploymentAliasesHttpResponse>;
|
|
1646
1333
|
type GetMlDeploymentAliasesHttpResponse = {
|
|
@@ -1738,11 +1425,8 @@ type PatchMlDeploymentAliaseHttpError = {
|
|
|
1738
1425
|
* @throws RunMlDeploymentAliaseRealtimePredictionsHttpError
|
|
1739
1426
|
*/
|
|
1740
1427
|
declare function runMlDeploymentAliaseRealtimePredictions(deploymentId: string, aliasName: string, query: {
|
|
1741
|
-
/** If true, reason why a prediction was not produced included response */
|
|
1742
|
-
|
|
1743
|
-
/** If true, shap values included in response */
|
|
1744
|
-
includeShap?: boolean;
|
|
1745
|
-
/** If true, source data included in response */
|
|
1428
|
+
/** If true, reason why a prediction was not produced included response */includeNotPredictedReason?: boolean; /** If true, shap values included in response */
|
|
1429
|
+
includeShap?: boolean; /** If true, source data included in response */
|
|
1746
1430
|
includeSource?: boolean;
|
|
1747
1431
|
/** The name of the feature in the source data to use as an index in the
|
|
1748
1432
|
* response data. The column will be included with its original name
|
|
@@ -1776,12 +1460,9 @@ declare function getMlDeploymentBatchPredictions(deploymentId: string, query: {
|
|
|
1776
1460
|
* - `experimentVersionId` UUID string - ID of experiment version in which model(s) exist
|
|
1777
1461
|
* - `modelId` UUID string - By model ID
|
|
1778
1462
|
* - `ownerId` ID string of batch prediction owner */
|
|
1779
|
-
filter?: string;
|
|
1780
|
-
/** Number of
|
|
1781
|
-
|
|
1782
|
-
/** Number of rows to skip before getting page[size] */
|
|
1783
|
-
offset?: number;
|
|
1784
|
-
/** Field(s) by which to sort response */
|
|
1463
|
+
filter?: string; /** Number of results per page. Default is 32. */
|
|
1464
|
+
limit?: number; /** Number of rows to skip before getting page[size] */
|
|
1465
|
+
offset?: number; /** Field(s) by which to sort response */
|
|
1785
1466
|
sort?: EnumSortBatchPredictions;
|
|
1786
1467
|
}, options?: ApiCallOptions): Promise<GetMlDeploymentBatchPredictionsHttpResponse>;
|
|
1787
1468
|
type GetMlDeploymentBatchPredictionsHttpResponse = {
|
|
@@ -2006,11 +1687,8 @@ type RemoveMlDeploymentModelsHttpError = {
|
|
|
2006
1687
|
* @throws RunMlDeploymentRealtimePredictionsHttpError
|
|
2007
1688
|
*/
|
|
2008
1689
|
declare function runMlDeploymentRealtimePredictions(deploymentId: string, query: {
|
|
2009
|
-
/** If true, reason why a prediction was not produced included response */
|
|
2010
|
-
|
|
2011
|
-
/** If true, shapley values included in response */
|
|
2012
|
-
includeShap?: boolean;
|
|
2013
|
-
/** If true, source data included in response */
|
|
1690
|
+
/** If true, reason why a prediction was not produced included response */includeNotPredictedReason?: boolean; /** If true, shapley values included in response */
|
|
1691
|
+
includeShap?: boolean; /** If true, source data included in response */
|
|
2014
1692
|
includeSource?: boolean;
|
|
2015
1693
|
/** The name of the feature in the source data to use as an index in the
|
|
2016
1694
|
* response data. The column will be included with its original name
|
|
@@ -2050,12 +1728,9 @@ declare function getMlExperiments(query: {
|
|
|
2050
1728
|
* - `experimentVersionId` UUID string - ID of an experiment version in the experiment
|
|
2051
1729
|
* - `modelId` UUID string - ID of a model associated with the experiment
|
|
2052
1730
|
* - `deploymentId` UUID string - ID of a deployment of a model associated with the experiment */
|
|
2053
|
-
filter?: string;
|
|
2054
|
-
/** Number of
|
|
2055
|
-
|
|
2056
|
-
/** Number of rows to skip before getting page[size] */
|
|
2057
|
-
offset?: number;
|
|
2058
|
-
/** Field(s) by which to sort response */
|
|
1731
|
+
filter?: string; /** Number of results per page. Default is 32. */
|
|
1732
|
+
limit?: number; /** Number of rows to skip before getting page[size] */
|
|
1733
|
+
offset?: number; /** Field(s) by which to sort response */
|
|
2059
1734
|
sort?: EnumSortExperiments;
|
|
2060
1735
|
}, options?: ApiCallOptions): Promise<GetMlExperimentsHttpResponse>;
|
|
2061
1736
|
type GetMlExperimentsHttpResponse = {
|
|
@@ -2189,12 +1864,9 @@ declare function getMlExperimentModels(experimentId: string, query: {
|
|
|
2189
1864
|
* - `samplingRatio` number - Find models by sampling ratio
|
|
2190
1865
|
* - `modelState` enum string - State by which to find models<br><br>
|
|
2191
1866
|
* - Valid states: `pending, enabled, disabled, inactive` */
|
|
2192
|
-
filter?: string;
|
|
2193
|
-
/** Number of
|
|
2194
|
-
|
|
2195
|
-
/** Number of rows to skip before getting page[size] */
|
|
2196
|
-
offset?: number;
|
|
2197
|
-
/** Field(s) by which to sort response */
|
|
1867
|
+
filter?: string; /** Number of results per page. Default is 32. */
|
|
1868
|
+
limit?: number; /** Number of rows to skip before getting page[size] */
|
|
1869
|
+
offset?: number; /** Field(s) by which to sort response */
|
|
2198
1870
|
sort?: EnumSortModels;
|
|
2199
1871
|
}, options?: ApiCallOptions): Promise<GetMlExperimentModelsHttpResponse>;
|
|
2200
1872
|
type GetMlExperimentModelsHttpResponse = {
|
|
@@ -2241,12 +1913,9 @@ declare function getMlExperimentVersions(experimentId: string, query: {
|
|
|
2241
1913
|
* - `status` enum string - Status to filter by. Omit to get models of any status.
|
|
2242
1914
|
* - Valid statuses: pending, ready, error, cancelled
|
|
2243
1915
|
* - `modelId` UUID string - ID of a model associated with the experiment */
|
|
2244
|
-
filter?: string;
|
|
2245
|
-
/** Number of
|
|
2246
|
-
|
|
2247
|
-
/** Number of rows to skip before getting page[size] */
|
|
2248
|
-
offset?: number;
|
|
2249
|
-
/** Field(s) by which to sort response */
|
|
1916
|
+
filter?: string; /** Number of results per page. Default is 32. */
|
|
1917
|
+
limit?: number; /** Number of rows to skip before getting page[size] */
|
|
1918
|
+
offset?: number; /** Field(s) by which to sort response */
|
|
2250
1919
|
sort?: EnumSortExperimentVersions;
|
|
2251
1920
|
}, options?: ApiCallOptions): Promise<GetMlExperimentVersionsHttpResponse>;
|
|
2252
1921
|
type GetMlExperimentVersionsHttpResponse = {
|