@osdk/foundry.models 2.48.0 → 2.50.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +24 -0
- package/build/browser/_components.d.ts +588 -0
- package/build/browser/_components.d.ts.map +1 -1
- package/build/browser/_errors.d.ts +230 -0
- package/build/browser/_errors.d.ts.map +1 -1
- package/build/browser/index.d.ts +6 -2
- package/build/browser/index.d.ts.map +1 -1
- package/build/browser/index.js +4 -0
- package/build/browser/index.js.map +1 -1
- package/build/browser/public/Experiment.d.ts +37 -0
- package/build/browser/public/Experiment.d.ts.map +1 -0
- package/build/browser/public/Experiment.js +44 -0
- package/build/browser/public/Experiment.js.map +1 -0
- package/build/browser/public/ExperimentArtifactTable.d.ts +41 -0
- package/build/browser/public/ExperimentArtifactTable.d.ts.map +1 -0
- package/build/browser/public/ExperimentArtifactTable.js +44 -0
- package/build/browser/public/ExperimentArtifactTable.js.map +1 -0
- package/build/browser/public/ExperimentSeries.d.ts +40 -0
- package/build/browser/public/ExperimentSeries.d.ts.map +1 -0
- package/build/browser/public/ExperimentSeries.js +43 -0
- package/build/browser/public/ExperimentSeries.js.map +1 -0
- package/build/browser/public/LiveDeployment.d.ts +20 -0
- package/build/browser/public/LiveDeployment.d.ts.map +1 -0
- package/build/browser/public/LiveDeployment.js +30 -0
- package/build/browser/public/LiveDeployment.js.map +1 -0
- package/build/browser/public/Model.d.ts +2 -2
- package/build/browser/public/Model.js +2 -2
- package/build/browser/public/Model.js.map +1 -1
- package/build/browser/public/ModelStudioTrainer.d.ts +3 -7
- package/build/browser/public/ModelStudioTrainer.d.ts.map +1 -1
- package/build/browser/public/ModelVersion.d.ts +2 -2
- package/build/browser/public/ModelVersion.js +2 -2
- package/build/browser/public/ModelVersion.js.map +1 -1
- package/build/esm/_components.d.ts +588 -0
- package/build/esm/_components.d.ts.map +1 -1
- package/build/esm/_errors.d.ts +230 -0
- package/build/esm/_errors.d.ts.map +1 -1
- package/build/esm/index.d.ts +6 -2
- package/build/esm/index.d.ts.map +1 -1
- package/build/esm/index.js +4 -0
- package/build/esm/index.js.map +1 -1
- package/build/esm/public/Experiment.d.ts +37 -0
- package/build/esm/public/Experiment.d.ts.map +1 -0
- package/build/esm/public/Experiment.js +44 -0
- package/build/esm/public/Experiment.js.map +1 -0
- package/build/esm/public/ExperimentArtifactTable.d.ts +41 -0
- package/build/esm/public/ExperimentArtifactTable.d.ts.map +1 -0
- package/build/esm/public/ExperimentArtifactTable.js +44 -0
- package/build/esm/public/ExperimentArtifactTable.js.map +1 -0
- package/build/esm/public/ExperimentSeries.d.ts +40 -0
- package/build/esm/public/ExperimentSeries.d.ts.map +1 -0
- package/build/esm/public/ExperimentSeries.js +43 -0
- package/build/esm/public/ExperimentSeries.js.map +1 -0
- package/build/esm/public/LiveDeployment.d.ts +20 -0
- package/build/esm/public/LiveDeployment.d.ts.map +1 -0
- package/build/esm/public/LiveDeployment.js +30 -0
- package/build/esm/public/LiveDeployment.js.map +1 -0
- package/build/esm/public/Model.d.ts +2 -2
- package/build/esm/public/Model.js +2 -2
- package/build/esm/public/Model.js.map +1 -1
- package/build/esm/public/ModelStudioTrainer.d.ts +3 -7
- package/build/esm/public/ModelStudioTrainer.d.ts.map +1 -1
- package/build/esm/public/ModelVersion.d.ts +2 -2
- package/build/esm/public/ModelVersion.js +2 -2
- package/build/esm/public/ModelVersion.js.map +1 -1
- package/package.json +5 -5
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,29 @@
|
|
|
1
1
|
# @osdk/foundry.models
|
|
2
2
|
|
|
3
|
+
## 2.50.0
|
|
4
|
+
|
|
5
|
+
### Minor Changes
|
|
6
|
+
|
|
7
|
+
- e7d3aec: Regenerate platform sdks, notably, for branching params in queries.
|
|
8
|
+
|
|
9
|
+
### Patch Changes
|
|
10
|
+
|
|
11
|
+
- Updated dependencies [e7d3aec]
|
|
12
|
+
- @osdk/foundry.filesystem@2.50.0
|
|
13
|
+
- @osdk/foundry.core@2.50.0
|
|
14
|
+
|
|
15
|
+
## 2.49.0
|
|
16
|
+
|
|
17
|
+
### Minor Changes
|
|
18
|
+
|
|
19
|
+
- ed3ac19: Regenerate Platform SDKs
|
|
20
|
+
|
|
21
|
+
### Patch Changes
|
|
22
|
+
|
|
23
|
+
- Updated dependencies [ed3ac19]
|
|
24
|
+
- @osdk/foundry.filesystem@2.49.0
|
|
25
|
+
- @osdk/foundry.core@2.49.0
|
|
26
|
+
|
|
3
27
|
## 2.48.0
|
|
4
28
|
|
|
5
29
|
### Minor Changes
|
|
@@ -3,6 +3,14 @@ import type * as _Filesystem from "@osdk/foundry.filesystem";
|
|
|
3
3
|
export type LooselyBrandedString<T extends string> = string & {
|
|
4
4
|
__LOOSE_BRAND?: T;
|
|
5
5
|
};
|
|
6
|
+
/**
|
|
7
|
+
* A boolean parameter value.
|
|
8
|
+
*
|
|
9
|
+
* Log Safety: UNSAFE
|
|
10
|
+
*/
|
|
11
|
+
export interface BooleanParameter {
|
|
12
|
+
value: boolean;
|
|
13
|
+
}
|
|
6
14
|
/**
|
|
7
15
|
* Log Safety: SAFE
|
|
8
16
|
*/
|
|
@@ -64,6 +72,14 @@ export interface DatasetInput {
|
|
|
64
72
|
ignoreColumns: Array<_Core.ColumnName>;
|
|
65
73
|
selectColumns: Array<_Core.ColumnName>;
|
|
66
74
|
}
|
|
75
|
+
/**
|
|
76
|
+
* A datetime parameter value.
|
|
77
|
+
*
|
|
78
|
+
* Log Safety: UNSAFE
|
|
79
|
+
*/
|
|
80
|
+
export interface DatetimeParameter {
|
|
81
|
+
value: string;
|
|
82
|
+
}
|
|
67
83
|
/**
|
|
68
84
|
* Log Safety: SAFE
|
|
69
85
|
*/
|
|
@@ -75,27 +91,250 @@ export interface DateType {
|
|
|
75
91
|
export interface DillModelFiles {
|
|
76
92
|
serializedModelFunction: string;
|
|
77
93
|
}
|
|
94
|
+
/**
|
|
95
|
+
* A double parameter value.
|
|
96
|
+
*
|
|
97
|
+
* Log Safety: UNSAFE
|
|
98
|
+
*/
|
|
99
|
+
export interface DoubleParameter {
|
|
100
|
+
value: number;
|
|
101
|
+
}
|
|
102
|
+
/**
|
|
103
|
+
* Aggregated statistics for numeric series.
|
|
104
|
+
*
|
|
105
|
+
* Log Safety: UNSAFE
|
|
106
|
+
*/
|
|
107
|
+
export interface DoubleSeriesAggregations {
|
|
108
|
+
min?: number;
|
|
109
|
+
max?: number;
|
|
110
|
+
last?: number;
|
|
111
|
+
}
|
|
112
|
+
/**
|
|
113
|
+
* A series of double values.
|
|
114
|
+
*
|
|
115
|
+
* Log Safety: UNSAFE
|
|
116
|
+
*/
|
|
117
|
+
export interface DoubleSeriesV1 {
|
|
118
|
+
series: Array<DoubleSeriesValueV1>;
|
|
119
|
+
}
|
|
120
|
+
/**
|
|
121
|
+
* A single double value in a series.
|
|
122
|
+
*
|
|
123
|
+
* Log Safety: UNSAFE
|
|
124
|
+
*/
|
|
125
|
+
export interface DoubleSeriesValueV1 {
|
|
126
|
+
value: number;
|
|
127
|
+
timestamp: EpochMillis;
|
|
128
|
+
step: string;
|
|
129
|
+
}
|
|
78
130
|
/**
|
|
79
131
|
* Log Safety: SAFE
|
|
80
132
|
*/
|
|
81
133
|
export interface DoubleType {
|
|
82
134
|
}
|
|
135
|
+
/**
|
|
136
|
+
* Milliseconds since unix time zero. This representation is used to maintain consistency with the Parquet
|
|
137
|
+
format.
|
|
138
|
+
*
|
|
139
|
+
* Log Safety: SAFE
|
|
140
|
+
*/
|
|
141
|
+
export type EpochMillis = string;
|
|
142
|
+
/**
|
|
143
|
+
* Log Safety: UNSAFE
|
|
144
|
+
*/
|
|
145
|
+
export interface Experiment {
|
|
146
|
+
rid: ExperimentRid;
|
|
147
|
+
modelRid: ModelRid;
|
|
148
|
+
name?: string;
|
|
149
|
+
createdAt: _Core.CreatedTime;
|
|
150
|
+
createdBy: _Core.CreatedBy;
|
|
151
|
+
source: ExperimentSource;
|
|
152
|
+
status: ExperimentStatus;
|
|
153
|
+
statusMessage?: string;
|
|
154
|
+
branch: ExperimentBranch;
|
|
155
|
+
parameters: Array<Parameter>;
|
|
156
|
+
series: Array<SeriesAggregations>;
|
|
157
|
+
summaryMetrics: Array<SummaryMetric>;
|
|
158
|
+
artifacts: Record<ExperimentArtifactName, ExperimentArtifactMetadata>;
|
|
159
|
+
tags: Array<ExperimentTagText>;
|
|
160
|
+
linkedModelVersion?: ModelVersionRid;
|
|
161
|
+
jobRid?: _Core.JobRid;
|
|
162
|
+
}
|
|
163
|
+
/**
|
|
164
|
+
* Details about an experiment artifact.
|
|
165
|
+
*
|
|
166
|
+
* Log Safety: SAFE
|
|
167
|
+
*/
|
|
168
|
+
export type ExperimentArtifactDetails = {
|
|
169
|
+
type: "table";
|
|
170
|
+
} & TableArtifactDetails;
|
|
171
|
+
/**
|
|
172
|
+
* Metadata about an experiment artifact.
|
|
173
|
+
*
|
|
174
|
+
* Log Safety: UNSAFE
|
|
175
|
+
*/
|
|
176
|
+
export interface ExperimentArtifactMetadata {
|
|
177
|
+
name: ExperimentArtifactName;
|
|
178
|
+
description?: string;
|
|
179
|
+
sizeBytes: _Core.SizeBytes;
|
|
180
|
+
details: ExperimentArtifactDetails;
|
|
181
|
+
}
|
|
182
|
+
/**
|
|
183
|
+
* The name of an experiment artifact.
|
|
184
|
+
*
|
|
185
|
+
* Log Safety: UNSAFE
|
|
186
|
+
*/
|
|
187
|
+
export type ExperimentArtifactName = LooselyBrandedString<"ExperimentArtifactName">;
|
|
188
|
+
/**
|
|
189
|
+
* Log Safety: UNSAFE
|
|
190
|
+
*/
|
|
191
|
+
export interface ExperimentArtifactTable {
|
|
192
|
+
name: ExperimentArtifactName;
|
|
193
|
+
}
|
|
194
|
+
/**
|
|
195
|
+
* Experiment created from an authoring repository.
|
|
196
|
+
*
|
|
197
|
+
* Log Safety: SAFE
|
|
198
|
+
*/
|
|
199
|
+
export interface ExperimentAuthoringSource {
|
|
200
|
+
stemmaRid: string;
|
|
201
|
+
}
|
|
202
|
+
/**
|
|
203
|
+
* Log Safety: UNSAFE
|
|
204
|
+
*/
|
|
205
|
+
export type ExperimentBranch = LooselyBrandedString<"ExperimentBranch">;
|
|
206
|
+
/**
|
|
207
|
+
* Experiment created from a code workspace.
|
|
208
|
+
*
|
|
209
|
+
* Log Safety: SAFE
|
|
210
|
+
*/
|
|
211
|
+
export interface ExperimentCodeWorkspaceSource {
|
|
212
|
+
containerRid: string;
|
|
213
|
+
deploymentRid?: string;
|
|
214
|
+
}
|
|
215
|
+
/**
|
|
216
|
+
* The Resource Identifier (RID) of an Experiment.
|
|
217
|
+
*
|
|
218
|
+
* Log Safety: SAFE
|
|
219
|
+
*/
|
|
220
|
+
export type ExperimentRid = LooselyBrandedString<"ExperimentRid">;
|
|
221
|
+
/**
|
|
222
|
+
* Experiment created from the SDK.
|
|
223
|
+
*
|
|
224
|
+
* Log Safety: SAFE
|
|
225
|
+
*/
|
|
226
|
+
export interface ExperimentSdkSource {
|
|
227
|
+
}
|
|
228
|
+
/**
|
|
229
|
+
* Log Safety: UNSAFE
|
|
230
|
+
*/
|
|
231
|
+
export interface ExperimentSeries {
|
|
232
|
+
name: SeriesName;
|
|
233
|
+
}
|
|
234
|
+
/**
|
|
235
|
+
* The source from which the experiment was created.
|
|
236
|
+
*
|
|
237
|
+
* Log Safety: SAFE
|
|
238
|
+
*/
|
|
239
|
+
export type ExperimentSource = ({
|
|
240
|
+
type: "codeWorkspace";
|
|
241
|
+
} & ExperimentCodeWorkspaceSource) | ({
|
|
242
|
+
type: "authoring";
|
|
243
|
+
} & ExperimentAuthoringSource) | ({
|
|
244
|
+
type: "sdk";
|
|
245
|
+
} & ExperimentSdkSource);
|
|
246
|
+
/**
|
|
247
|
+
* The current status of an experiment.
|
|
248
|
+
*
|
|
249
|
+
* Log Safety: SAFE
|
|
250
|
+
*/
|
|
251
|
+
export type ExperimentStatus = "RUNNING" | "SUCCEEDED" | "FAILED";
|
|
252
|
+
/**
|
|
253
|
+
* A tag associated with an experiment.
|
|
254
|
+
*
|
|
255
|
+
* Log Safety: UNSAFE
|
|
256
|
+
*/
|
|
257
|
+
export type ExperimentTagText = LooselyBrandedString<"ExperimentTagText">;
|
|
83
258
|
/**
|
|
84
259
|
* Log Safety: SAFE
|
|
85
260
|
*/
|
|
86
261
|
export interface FloatType {
|
|
87
262
|
}
|
|
263
|
+
/**
|
|
264
|
+
* Array elements have inconsistent dimensions.
|
|
265
|
+
*
|
|
266
|
+
* Log Safety: UNSAFE
|
|
267
|
+
*/
|
|
268
|
+
export interface InconsistentArrayDimensionsError {
|
|
269
|
+
firstElementShape: Array<number>;
|
|
270
|
+
conflictingElementShape: Array<number>;
|
|
271
|
+
}
|
|
272
|
+
/**
|
|
273
|
+
* The specific type and details of an input validation error for inference requests.
|
|
274
|
+
Each variant carries parameters relevant to that specific error category.
|
|
275
|
+
*
|
|
276
|
+
* Log Safety: UNSAFE
|
|
277
|
+
*/
|
|
278
|
+
export type InferenceInputErrorType = ({
|
|
279
|
+
type: "invalidArrayShape";
|
|
280
|
+
} & InvalidArrayShapeError) | ({
|
|
281
|
+
type: "typeMismatch";
|
|
282
|
+
} & TypeMismatchError) | ({
|
|
283
|
+
type: "unsupportedType";
|
|
284
|
+
} & UnsupportedTypeError) | ({
|
|
285
|
+
type: "unknownInputName";
|
|
286
|
+
} & UnknownInputNameError) | ({
|
|
287
|
+
type: "invalidTabularFormat";
|
|
288
|
+
} & InvalidTabularFormatError) | ({
|
|
289
|
+
type: "inconsistentArrayDimensions";
|
|
290
|
+
} & InconsistentArrayDimensionsError) | ({
|
|
291
|
+
type: "requiredValueMissing";
|
|
292
|
+
} & RequiredValueMissingError) | ({
|
|
293
|
+
type: "invalidMapFormat";
|
|
294
|
+
} & InvalidMapFormatError);
|
|
88
295
|
/**
|
|
89
296
|
* A string alias used to identify inputs in a Model Studio configuration.
|
|
90
297
|
*
|
|
91
298
|
* Log Safety: UNSAFE
|
|
92
299
|
*/
|
|
93
300
|
export type InputAlias = LooselyBrandedString<"InputAlias">;
|
|
301
|
+
/**
|
|
302
|
+
* An integer parameter value.
|
|
303
|
+
*
|
|
304
|
+
* Log Safety: UNSAFE
|
|
305
|
+
*/
|
|
306
|
+
export interface IntegerParameter {
|
|
307
|
+
value: string;
|
|
308
|
+
}
|
|
94
309
|
/**
|
|
95
310
|
* Log Safety: SAFE
|
|
96
311
|
*/
|
|
97
312
|
export interface IntegerType {
|
|
98
313
|
}
|
|
314
|
+
/**
|
|
315
|
+
* Array dimensions do not match expected ndarray shape.
|
|
316
|
+
*
|
|
317
|
+
* Log Safety: UNSAFE
|
|
318
|
+
*/
|
|
319
|
+
export interface InvalidArrayShapeError {
|
|
320
|
+
expectedShape: Array<number>;
|
|
321
|
+
actualShape?: Array<number>;
|
|
322
|
+
}
|
|
323
|
+
/**
|
|
324
|
+
* Map input has incorrect structure or null keys.
|
|
325
|
+
*
|
|
326
|
+
* Log Safety: SAFE
|
|
327
|
+
*/
|
|
328
|
+
export interface InvalidMapFormatError {
|
|
329
|
+
}
|
|
330
|
+
/**
|
|
331
|
+
* Tabular input has incorrect JSON structure.
|
|
332
|
+
*
|
|
333
|
+
* Log Safety: UNSAFE
|
|
334
|
+
*/
|
|
335
|
+
export interface InvalidTabularFormatError {
|
|
336
|
+
inputFieldName: string;
|
|
337
|
+
}
|
|
99
338
|
/**
|
|
100
339
|
* Log Safety: UNSAFE
|
|
101
340
|
*/
|
|
@@ -124,6 +363,18 @@ export interface ListModelVersionsResponse {
|
|
|
124
363
|
data: Array<ModelVersion>;
|
|
125
364
|
nextPageToken?: _Core.PageToken;
|
|
126
365
|
}
|
|
366
|
+
/**
|
|
367
|
+
* Log Safety: SAFE
|
|
368
|
+
*/
|
|
369
|
+
export interface LiveDeployment {
|
|
370
|
+
rid: LiveDeploymentRid;
|
|
371
|
+
}
|
|
372
|
+
/**
|
|
373
|
+
* The Resource Identifier (RID) of a Live Deployment.
|
|
374
|
+
*
|
|
375
|
+
* Log Safety: SAFE
|
|
376
|
+
*/
|
|
377
|
+
export type LiveDeploymentRid = LooselyBrandedString<"LiveDeploymentRid">;
|
|
127
378
|
/**
|
|
128
379
|
* Log Safety: SAFE
|
|
129
380
|
*/
|
|
@@ -421,6 +672,45 @@ export type ModelVersionRid = LooselyBrandedString<"ModelVersionRid">;
|
|
|
421
672
|
* Log Safety: UNSAFE
|
|
422
673
|
*/
|
|
423
674
|
export type OutputAlias = LooselyBrandedString<"OutputAlias">;
|
|
675
|
+
/**
|
|
676
|
+
* A parameter with its name and value.
|
|
677
|
+
*
|
|
678
|
+
* Log Safety: UNSAFE
|
|
679
|
+
*/
|
|
680
|
+
export interface Parameter {
|
|
681
|
+
name: ParameterName;
|
|
682
|
+
value: ParameterValue;
|
|
683
|
+
}
|
|
684
|
+
/**
|
|
685
|
+
* The name of an experiment parameter.
|
|
686
|
+
*
|
|
687
|
+
* Log Safety: UNSAFE
|
|
688
|
+
*/
|
|
689
|
+
export type ParameterName = LooselyBrandedString<"ParameterName">;
|
|
690
|
+
/**
|
|
691
|
+
* A parameter value logged for an experiment.
|
|
692
|
+
*
|
|
693
|
+
* Log Safety: UNSAFE
|
|
694
|
+
*/
|
|
695
|
+
export type ParameterValue = ({
|
|
696
|
+
type: "datetime";
|
|
697
|
+
} & DatetimeParameter) | ({
|
|
698
|
+
type: "boolean";
|
|
699
|
+
} & BooleanParameter) | ({
|
|
700
|
+
type: "string";
|
|
701
|
+
} & StringParameter) | ({
|
|
702
|
+
type: "double";
|
|
703
|
+
} & DoubleParameter) | ({
|
|
704
|
+
type: "integer";
|
|
705
|
+
} & IntegerParameter);
|
|
706
|
+
/**
|
|
707
|
+
* Required input field is null or missing.
|
|
708
|
+
*
|
|
709
|
+
* Log Safety: UNSAFE
|
|
710
|
+
*/
|
|
711
|
+
export interface RequiredValueMissingError {
|
|
712
|
+
fieldName: string;
|
|
713
|
+
}
|
|
424
714
|
/**
|
|
425
715
|
* Compute resource configuration for training runs.
|
|
426
716
|
*
|
|
@@ -436,11 +726,270 @@ export interface ResourceConfiguration {
|
|
|
436
726
|
* Log Safety: SAFE
|
|
437
727
|
*/
|
|
438
728
|
export type RunId = LooselyBrandedString<"RunId">;
|
|
729
|
+
/**
|
|
730
|
+
* Returns experiments where every filter is satisfied.
|
|
731
|
+
*
|
|
732
|
+
* Log Safety: UNSAFE
|
|
733
|
+
*/
|
|
734
|
+
export interface SearchExperimentsAndFilter {
|
|
735
|
+
filters: Array<SearchExperimentsFilter>;
|
|
736
|
+
}
|
|
737
|
+
/**
|
|
738
|
+
* Filter for substring containment matches.
|
|
739
|
+
*
|
|
740
|
+
* Log Safety: UNSAFE
|
|
741
|
+
*/
|
|
742
|
+
export interface SearchExperimentsContainsFilter {
|
|
743
|
+
field: SearchExperimentsContainsFilterField;
|
|
744
|
+
value: any;
|
|
745
|
+
}
|
|
746
|
+
/**
|
|
747
|
+
* Fields that support substring containment filtering.
|
|
748
|
+
*
|
|
749
|
+
* Log Safety: SAFE
|
|
750
|
+
*/
|
|
751
|
+
export type SearchExperimentsContainsFilterField = "EXPERIMENT_NAME" | "PARAMETER_NAME" | "SERIES_NAME";
|
|
752
|
+
/**
|
|
753
|
+
* Filter for exact field value matches.
|
|
754
|
+
*
|
|
755
|
+
* Log Safety: UNSAFE
|
|
756
|
+
*/
|
|
757
|
+
export interface SearchExperimentsEqualsFilter {
|
|
758
|
+
field: SearchExperimentsEqualsFilterField;
|
|
759
|
+
value: any;
|
|
760
|
+
}
|
|
761
|
+
/**
|
|
762
|
+
* Fields that support equality filtering.
|
|
763
|
+
*
|
|
764
|
+
* Log Safety: SAFE
|
|
765
|
+
*/
|
|
766
|
+
export type SearchExperimentsEqualsFilterField = "STATUS" | "BRANCH" | "EXPERIMENT_NAME" | "EXPERIMENT_RID" | "JOB_RID" | "TAG" | "PARAMETER_NAME" | "SERIES_NAME";
|
|
767
|
+
/**
|
|
768
|
+
* Filter for searching experiments using operator-based composition.
|
|
769
|
+
Supports equality, text matching, boolean combination operators, and compound filters
|
|
770
|
+
that atomically bind a name to a value comparison.
|
|
771
|
+
Example filters:
|
|
772
|
+
|
|
773
|
+
Simple status: {"eq": {"field": "STATUS", "value": "RUNNING"}}
|
|
774
|
+
Branch match: {"eq": {"field": "BRANCH", "value": "master"}}
|
|
775
|
+
Parameter filter: {"parameterFilter": {"parameterName": "learning_rate", "operator": "GT", "value": 0.01}}
|
|
776
|
+
Combined: {"and": {"filters": [
|
|
777
|
+
{"eq": {"field": "STATUS", "value": "SUCCEEDED"}},
|
|
778
|
+
{"parameterFilter": {"parameterName": "learning_rate", "operator": "GT", "value": 0.5}}
|
|
779
|
+
]}}
|
|
780
|
+
*
|
|
781
|
+
* Log Safety: UNSAFE
|
|
782
|
+
*/
|
|
783
|
+
export type SearchExperimentsFilter = ({
|
|
784
|
+
type: "seriesFilter";
|
|
785
|
+
} & SearchExperimentsSeriesFilter) | ({
|
|
786
|
+
type: "contains";
|
|
787
|
+
} & SearchExperimentsContainsFilter) | ({
|
|
788
|
+
type: "not";
|
|
789
|
+
} & SearchExperimentsNotFilter) | ({
|
|
790
|
+
type: "or";
|
|
791
|
+
} & SearchExperimentsOrFilter) | ({
|
|
792
|
+
type: "and";
|
|
793
|
+
} & SearchExperimentsAndFilter) | ({
|
|
794
|
+
type: "parameterFilter";
|
|
795
|
+
} & SearchExperimentsParameterFilter) | ({
|
|
796
|
+
type: "summaryMetricFilter";
|
|
797
|
+
} & SearchExperimentsSummaryMetricFilter) | ({
|
|
798
|
+
type: "eq";
|
|
799
|
+
} & SearchExperimentsEqualsFilter) | ({
|
|
800
|
+
type: "startsWith";
|
|
801
|
+
} & SearchExperimentsStartsWithFilter);
|
|
802
|
+
/**
|
|
803
|
+
* Returns experiments where the filter is not satisfied.
|
|
804
|
+
*
|
|
805
|
+
* Log Safety: UNSAFE
|
|
806
|
+
*/
|
|
807
|
+
export interface SearchExperimentsNotFilter {
|
|
808
|
+
value: SearchExperimentsFilter;
|
|
809
|
+
}
|
|
810
|
+
/**
|
|
811
|
+
* Comparison operator for numeric filter predicates (series and summary metrics).
|
|
812
|
+
*
|
|
813
|
+
* Log Safety: SAFE
|
|
814
|
+
*/
|
|
815
|
+
export type SearchExperimentsNumericFilterOperator = "EQ" | "GT" | "LT";
|
|
816
|
+
/**
|
|
817
|
+
* Ordering configuration for experiment search results.
|
|
818
|
+
*
|
|
819
|
+
* Log Safety: SAFE
|
|
820
|
+
*/
|
|
821
|
+
export interface SearchExperimentsOrderBy {
|
|
822
|
+
field: SearchExperimentsOrderByField;
|
|
823
|
+
direction: _Core.OrderByDirection;
|
|
824
|
+
}
|
|
825
|
+
/**
|
|
826
|
+
* Fields to order experiment search results by.
|
|
827
|
+
*
|
|
828
|
+
* Log Safety: SAFE
|
|
829
|
+
*/
|
|
830
|
+
export type SearchExperimentsOrderByField = "EXPERIMENT_NAME" | "CREATED_AT";
|
|
831
|
+
/**
|
|
832
|
+
* Returns experiments where at least one filter is satisfied.
|
|
833
|
+
*
|
|
834
|
+
* Log Safety: UNSAFE
|
|
835
|
+
*/
|
|
836
|
+
export interface SearchExperimentsOrFilter {
|
|
837
|
+
filters: Array<SearchExperimentsFilter>;
|
|
838
|
+
}
|
|
839
|
+
/**
|
|
840
|
+
* Filter that atomically binds a parameter name to a value comparison,
|
|
841
|
+
ensuring both conditions are evaluated on the same parameter.
|
|
842
|
+
Supported combinations:
|
|
843
|
+
|
|
844
|
+
EQ: boolean, double, integer, or datetime value
|
|
845
|
+
GT/LT: double, integer, or datetime value
|
|
846
|
+
CONTAINS: string value (substring match on the parameter's string value)
|
|
847
|
+
*
|
|
848
|
+
* Log Safety: UNSAFE
|
|
849
|
+
*/
|
|
850
|
+
export interface SearchExperimentsParameterFilter {
|
|
851
|
+
parameterName: ParameterName;
|
|
852
|
+
operator: SearchExperimentsParameterFilterOperator;
|
|
853
|
+
value: any;
|
|
854
|
+
}
|
|
855
|
+
/**
|
|
856
|
+
* Comparison operator for parameter filter predicates.
|
|
857
|
+
*
|
|
858
|
+
* Log Safety: SAFE
|
|
859
|
+
*/
|
|
860
|
+
export type SearchExperimentsParameterFilterOperator = "EQ" | "GT" | "LT" | "CONTAINS";
|
|
861
|
+
/**
|
|
862
|
+
* Log Safety: UNSAFE
|
|
863
|
+
*/
|
|
864
|
+
export interface SearchExperimentsRequest {
|
|
865
|
+
where?: SearchExperimentsFilter;
|
|
866
|
+
orderBy?: SearchExperimentsOrderBy;
|
|
867
|
+
pageSize?: _Core.PageSize;
|
|
868
|
+
pageToken?: _Core.PageToken;
|
|
869
|
+
}
|
|
870
|
+
/**
|
|
871
|
+
* Response from searching experiments.
|
|
872
|
+
*
|
|
873
|
+
* Log Safety: UNSAFE
|
|
874
|
+
*/
|
|
875
|
+
export interface SearchExperimentsResponse {
|
|
876
|
+
data: Array<Experiment>;
|
|
877
|
+
nextPageToken?: _Core.PageToken;
|
|
878
|
+
}
|
|
879
|
+
/**
|
|
880
|
+
* Filter that atomically binds a series name to a metric comparison,
|
|
881
|
+
ensuring all conditions are evaluated on the same series.
|
|
882
|
+
*
|
|
883
|
+
* Log Safety: UNSAFE
|
|
884
|
+
*/
|
|
885
|
+
export interface SearchExperimentsSeriesFilter {
|
|
886
|
+
seriesName: SeriesName;
|
|
887
|
+
field: SearchExperimentsSeriesFilterField;
|
|
888
|
+
operator: SearchExperimentsNumericFilterOperator;
|
|
889
|
+
value: any;
|
|
890
|
+
}
|
|
891
|
+
/**
|
|
892
|
+
* The series metric to filter on.
|
|
893
|
+
*
|
|
894
|
+
* Log Safety: SAFE
|
|
895
|
+
*/
|
|
896
|
+
export type SearchExperimentsSeriesFilterField = "LENGTH" | "AGGREGATION_MIN" | "AGGREGATION_MAX" | "AGGREGATION_LAST";
|
|
897
|
+
/**
|
|
898
|
+
* Filter for prefix matches.
|
|
899
|
+
*
|
|
900
|
+
* Log Safety: UNSAFE
|
|
901
|
+
*/
|
|
902
|
+
export interface SearchExperimentsStartsWithFilter {
|
|
903
|
+
field: SearchExperimentsStartsWithFilterField;
|
|
904
|
+
value: any;
|
|
905
|
+
}
|
|
906
|
+
/**
|
|
907
|
+
* Fields that support prefix filtering.
|
|
908
|
+
*
|
|
909
|
+
* Log Safety: SAFE
|
|
910
|
+
*/
|
|
911
|
+
export type SearchExperimentsStartsWithFilterField = "EXPERIMENT_NAME" | "PARAMETER_NAME" | "SERIES_NAME";
|
|
912
|
+
/**
|
|
913
|
+
* Filter that atomically binds a series name and aggregation type to a value comparison,
|
|
914
|
+
ensuring all conditions are evaluated on the same summary metric.
|
|
915
|
+
*
|
|
916
|
+
* Log Safety: UNSAFE
|
|
917
|
+
*/
|
|
918
|
+
export interface SearchExperimentsSummaryMetricFilter {
|
|
919
|
+
seriesName: SeriesName;
|
|
920
|
+
aggregation: SummaryMetricAggregation;
|
|
921
|
+
operator: SearchExperimentsNumericFilterOperator;
|
|
922
|
+
value: any;
|
|
923
|
+
}
|
|
924
|
+
/**
|
|
925
|
+
* A series of values logged over time.
|
|
926
|
+
*
|
|
927
|
+
* Log Safety: UNSAFE
|
|
928
|
+
*/
|
|
929
|
+
export type Series = {
|
|
930
|
+
type: "doubleV1";
|
|
931
|
+
} & DoubleSeriesV1;
|
|
932
|
+
/**
|
|
933
|
+
* Series with precomputed aggregation values.
|
|
934
|
+
*
|
|
935
|
+
* Log Safety: UNSAFE
|
|
936
|
+
*/
|
|
937
|
+
export interface SeriesAggregations {
|
|
938
|
+
name: SeriesName;
|
|
939
|
+
length?: string;
|
|
940
|
+
value: SeriesAggregationsValue;
|
|
941
|
+
}
|
|
942
|
+
/**
|
|
943
|
+
* Union of aggregation values by series type.
|
|
944
|
+
*
|
|
945
|
+
* Log Safety: UNSAFE
|
|
946
|
+
*/
|
|
947
|
+
export type SeriesAggregationsValue = {
|
|
948
|
+
type: "double";
|
|
949
|
+
} & DoubleSeriesAggregations;
|
|
950
|
+
/**
|
|
951
|
+
* The name of a series (metrics tracked over time).
|
|
952
|
+
*
|
|
953
|
+
* Log Safety: UNSAFE
|
|
954
|
+
*/
|
|
955
|
+
export type SeriesName = LooselyBrandedString<"SeriesName">;
|
|
956
|
+
/**
|
|
957
|
+
* A string parameter value.
|
|
958
|
+
*
|
|
959
|
+
* Log Safety: UNSAFE
|
|
960
|
+
*/
|
|
961
|
+
export interface StringParameter {
|
|
962
|
+
value: string;
|
|
963
|
+
}
|
|
439
964
|
/**
|
|
440
965
|
* Log Safety: SAFE
|
|
441
966
|
*/
|
|
442
967
|
export interface StringType {
|
|
443
968
|
}
|
|
969
|
+
/**
|
|
970
|
+
* A summary metric with series name, aggregation type, and computed value.
|
|
971
|
+
*
|
|
972
|
+
* Log Safety: UNSAFE
|
|
973
|
+
*/
|
|
974
|
+
export interface SummaryMetric {
|
|
975
|
+
seriesName: SeriesName;
|
|
976
|
+
aggregation: SummaryMetricAggregation;
|
|
977
|
+
value: number;
|
|
978
|
+
}
|
|
979
|
+
/**
|
|
980
|
+
* The type of aggregation computed for a summary metric.
|
|
981
|
+
*
|
|
982
|
+
* Log Safety: SAFE
|
|
983
|
+
*/
|
|
984
|
+
export type SummaryMetricAggregation = "MIN" | "MAX" | "LAST";
|
|
985
|
+
/**
|
|
986
|
+
* Details about a table artifact.
|
|
987
|
+
*
|
|
988
|
+
* Log Safety: SAFE
|
|
989
|
+
*/
|
|
990
|
+
export interface TableArtifactDetails {
|
|
991
|
+
rowCount: string;
|
|
992
|
+
}
|
|
444
993
|
/**
|
|
445
994
|
* Log Safety: SAFE
|
|
446
995
|
*/
|
|
@@ -503,6 +1052,37 @@ export interface TrainerVersionLocator {
|
|
|
503
1052
|
trainerId: TrainerId;
|
|
504
1053
|
version: string;
|
|
505
1054
|
}
|
|
1055
|
+
/**
|
|
1056
|
+
* Log Safety: UNSAFE
|
|
1057
|
+
*/
|
|
1058
|
+
export interface TransformJsonLiveDeploymentRequest {
|
|
1059
|
+
input: Record<string, any>;
|
|
1060
|
+
}
|
|
1061
|
+
/**
|
|
1062
|
+
* The response from transforming input data using a live deployment.
|
|
1063
|
+
*
|
|
1064
|
+
* Log Safety: UNSAFE
|
|
1065
|
+
*/
|
|
1066
|
+
export interface TransformLiveDeploymentResponse {
|
|
1067
|
+
output: Record<string, any>;
|
|
1068
|
+
}
|
|
1069
|
+
/**
|
|
1070
|
+
* Input type does not match expected type in model API.
|
|
1071
|
+
*
|
|
1072
|
+
* Log Safety: SAFE
|
|
1073
|
+
*/
|
|
1074
|
+
export interface TypeMismatchError {
|
|
1075
|
+
expectedType: string;
|
|
1076
|
+
actualType: string;
|
|
1077
|
+
}
|
|
1078
|
+
/**
|
|
1079
|
+
* Provided input name not found in model API specification.
|
|
1080
|
+
*
|
|
1081
|
+
* Log Safety: UNSAFE
|
|
1082
|
+
*/
|
|
1083
|
+
export interface UnknownInputNameError {
|
|
1084
|
+
inputName: string;
|
|
1085
|
+
}
|
|
506
1086
|
/**
|
|
507
1087
|
* Log Safety: UNSAFE
|
|
508
1088
|
*/
|
|
@@ -510,6 +1090,14 @@ export interface UnsupportedType {
|
|
|
510
1090
|
unsupportedType: string;
|
|
511
1091
|
params: Record<_Core.UnsupportedTypeParamKey, _Core.UnsupportedTypeParamValue>;
|
|
512
1092
|
}
|
|
1093
|
+
/**
|
|
1094
|
+
* Input contains an unsupported data type.
|
|
1095
|
+
*
|
|
1096
|
+
* Log Safety: SAFE
|
|
1097
|
+
*/
|
|
1098
|
+
export interface UnsupportedTypeError {
|
|
1099
|
+
unsupportedType: string;
|
|
1100
|
+
}
|
|
513
1101
|
/**
|
|
514
1102
|
* Log Safety: UNSAFE
|
|
515
1103
|
*/
|