@osdk/foundry.models 2.47.0 → 2.49.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (94) hide show
  1. package/CHANGELOG.md +24 -0
  2. package/build/browser/_components.d.ts +873 -0
  3. package/build/browser/_components.d.ts.map +1 -1
  4. package/build/browser/_errors.d.ts +353 -0
  5. package/build/browser/_errors.d.ts.map +1 -1
  6. package/build/browser/index.d.ts +10 -2
  7. package/build/browser/index.d.ts.map +1 -1
  8. package/build/browser/index.js +8 -0
  9. package/build/browser/index.js.map +1 -1
  10. package/build/browser/public/Experiment.d.ts +37 -0
  11. package/build/browser/public/Experiment.d.ts.map +1 -0
  12. package/build/browser/public/Experiment.js +44 -0
  13. package/build/browser/public/Experiment.js.map +1 -0
  14. package/build/browser/public/ExperimentArtifactTable.d.ts +41 -0
  15. package/build/browser/public/ExperimentArtifactTable.d.ts.map +1 -0
  16. package/build/browser/public/ExperimentArtifactTable.js +44 -0
  17. package/build/browser/public/ExperimentArtifactTable.js.map +1 -0
  18. package/build/browser/public/ExperimentSeries.d.ts +40 -0
  19. package/build/browser/public/ExperimentSeries.d.ts.map +1 -0
  20. package/build/browser/public/ExperimentSeries.js +43 -0
  21. package/build/browser/public/ExperimentSeries.js.map +1 -0
  22. package/build/browser/public/LiveDeployment.d.ts +20 -0
  23. package/build/browser/public/LiveDeployment.d.ts.map +1 -0
  24. package/build/browser/public/LiveDeployment.js +30 -0
  25. package/build/browser/public/LiveDeployment.js.map +1 -0
  26. package/build/browser/public/Model.d.ts +2 -2
  27. package/build/browser/public/Model.js +2 -2
  28. package/build/browser/public/Model.js.map +1 -1
  29. package/build/browser/public/ModelStudio.d.ts +47 -0
  30. package/build/browser/public/ModelStudio.d.ts.map +1 -0
  31. package/build/browser/public/ModelStudio.js +54 -0
  32. package/build/browser/public/ModelStudio.js.map +1 -0
  33. package/build/browser/public/ModelStudioConfigVersion.d.ts +65 -0
  34. package/build/browser/public/ModelStudioConfigVersion.d.ts.map +1 -0
  35. package/build/browser/public/ModelStudioConfigVersion.js +66 -0
  36. package/build/browser/public/ModelStudioConfigVersion.js.map +1 -0
  37. package/build/browser/public/ModelStudioRun.d.ts +22 -0
  38. package/build/browser/public/ModelStudioRun.d.ts.map +1 -0
  39. package/build/browser/public/ModelStudioRun.js +30 -0
  40. package/build/browser/public/ModelStudioRun.js.map +1 -0
  41. package/build/browser/public/ModelStudioTrainer.d.ts +31 -0
  42. package/build/browser/public/ModelStudioTrainer.d.ts.map +1 -0
  43. package/build/browser/public/ModelStudioTrainer.js +42 -0
  44. package/build/browser/public/ModelStudioTrainer.js.map +1 -0
  45. package/build/browser/public/ModelVersion.d.ts +2 -2
  46. package/build/browser/public/ModelVersion.js +2 -2
  47. package/build/browser/public/ModelVersion.js.map +1 -1
  48. package/build/esm/_components.d.ts +873 -0
  49. package/build/esm/_components.d.ts.map +1 -1
  50. package/build/esm/_errors.d.ts +353 -0
  51. package/build/esm/_errors.d.ts.map +1 -1
  52. package/build/esm/index.d.ts +10 -2
  53. package/build/esm/index.d.ts.map +1 -1
  54. package/build/esm/index.js +8 -0
  55. package/build/esm/index.js.map +1 -1
  56. package/build/esm/public/Experiment.d.ts +37 -0
  57. package/build/esm/public/Experiment.d.ts.map +1 -0
  58. package/build/esm/public/Experiment.js +44 -0
  59. package/build/esm/public/Experiment.js.map +1 -0
  60. package/build/esm/public/ExperimentArtifactTable.d.ts +41 -0
  61. package/build/esm/public/ExperimentArtifactTable.d.ts.map +1 -0
  62. package/build/esm/public/ExperimentArtifactTable.js +44 -0
  63. package/build/esm/public/ExperimentArtifactTable.js.map +1 -0
  64. package/build/esm/public/ExperimentSeries.d.ts +40 -0
  65. package/build/esm/public/ExperimentSeries.d.ts.map +1 -0
  66. package/build/esm/public/ExperimentSeries.js +43 -0
  67. package/build/esm/public/ExperimentSeries.js.map +1 -0
  68. package/build/esm/public/LiveDeployment.d.ts +20 -0
  69. package/build/esm/public/LiveDeployment.d.ts.map +1 -0
  70. package/build/esm/public/LiveDeployment.js +30 -0
  71. package/build/esm/public/LiveDeployment.js.map +1 -0
  72. package/build/esm/public/Model.d.ts +2 -2
  73. package/build/esm/public/Model.js +2 -2
  74. package/build/esm/public/Model.js.map +1 -1
  75. package/build/esm/public/ModelStudio.d.ts +47 -0
  76. package/build/esm/public/ModelStudio.d.ts.map +1 -0
  77. package/build/esm/public/ModelStudio.js +54 -0
  78. package/build/esm/public/ModelStudio.js.map +1 -0
  79. package/build/esm/public/ModelStudioConfigVersion.d.ts +65 -0
  80. package/build/esm/public/ModelStudioConfigVersion.d.ts.map +1 -0
  81. package/build/esm/public/ModelStudioConfigVersion.js +66 -0
  82. package/build/esm/public/ModelStudioConfigVersion.js.map +1 -0
  83. package/build/esm/public/ModelStudioRun.d.ts +22 -0
  84. package/build/esm/public/ModelStudioRun.d.ts.map +1 -0
  85. package/build/esm/public/ModelStudioRun.js +30 -0
  86. package/build/esm/public/ModelStudioRun.js.map +1 -0
  87. package/build/esm/public/ModelStudioTrainer.d.ts +31 -0
  88. package/build/esm/public/ModelStudioTrainer.d.ts.map +1 -0
  89. package/build/esm/public/ModelStudioTrainer.js +42 -0
  90. package/build/esm/public/ModelStudioTrainer.js.map +1 -0
  91. package/build/esm/public/ModelVersion.d.ts +2 -2
  92. package/build/esm/public/ModelVersion.js +2 -2
  93. package/build/esm/public/ModelVersion.js.map +1 -1
  94. package/package.json +4 -4
@@ -3,11 +3,31 @@ 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
  */
9
17
  export interface BooleanType {
10
18
  }
19
+ /**
20
+ * The name of a column in a dataset.
21
+ *
22
+ * Log Safety: UNSAFE
23
+ */
24
+ export type ColumnName = LooselyBrandedString<"ColumnName">;
25
+ /**
26
+ * An identifier for a column type specification.
27
+ *
28
+ * Log Safety: UNSAFE
29
+ */
30
+ export type ColumnTypeSpecId = LooselyBrandedString<"ColumnTypeSpecId">;
11
31
  /**
12
32
  * Log Safety: UNSAFE
13
33
  */
@@ -15,6 +35,23 @@ export interface CreateModelRequest {
15
35
  name: ModelName;
16
36
  parentFolderRid: _Filesystem.FolderRid;
17
37
  }
38
+ /**
39
+ * Log Safety: UNSAFE
40
+ */
41
+ export interface CreateModelStudioConfigVersionRequest {
42
+ name: ModelStudioConfigVersionName;
43
+ resources: ResourceConfiguration;
44
+ changelog?: string;
45
+ workerConfig: ModelStudioWorkerConfig;
46
+ trainerId: TrainerId;
47
+ }
48
+ /**
49
+ * Log Safety: UNSAFE
50
+ */
51
+ export interface CreateModelStudioRequest {
52
+ name: string;
53
+ parentFolderRid: _Filesystem.FolderRid;
54
+ }
18
55
  /**
19
56
  * Log Safety: UNSAFE
20
57
  */
@@ -24,6 +61,25 @@ export interface CreateModelVersionRequest {
24
61
  condaRequirements: Array<string>;
25
62
  modelApi: ModelApi;
26
63
  }
64
+ /**
65
+ * Dataset input configuration.
66
+ *
67
+ * Log Safety: UNSAFE
68
+ */
69
+ export interface DatasetInput {
70
+ rid: string;
71
+ columnMapping: Record<ColumnTypeSpecId, Array<_Core.ColumnName>>;
72
+ ignoreColumns: Array<_Core.ColumnName>;
73
+ selectColumns: Array<_Core.ColumnName>;
74
+ }
75
+ /**
76
+ * A datetime parameter value.
77
+ *
78
+ * Log Safety: UNSAFE
79
+ */
80
+ export interface DatetimeParameter {
81
+ value: string;
82
+ }
27
83
  /**
28
84
  * Log Safety: SAFE
29
85
  */
@@ -35,21 +91,275 @@ export interface DateType {
35
91
  export interface DillModelFiles {
36
92
  serializedModelFunction: string;
37
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
+ }
38
130
  /**
39
131
  * Log Safety: SAFE
40
132
  */
41
133
  export interface DoubleType {
42
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: ExperimentName;
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
+ * Log Safety: UNSAFE
217
+ */
218
+ export type ExperimentName = LooselyBrandedString<"ExperimentName">;
219
+ /**
220
+ * The Resource Identifier (RID) of an Experiment.
221
+ *
222
+ * Log Safety: SAFE
223
+ */
224
+ export type ExperimentRid = LooselyBrandedString<"ExperimentRid">;
225
+ /**
226
+ * Experiment created from the SDK.
227
+ *
228
+ * Log Safety: SAFE
229
+ */
230
+ export interface ExperimentSdkSource {
231
+ }
232
+ /**
233
+ * Log Safety: UNSAFE
234
+ */
235
+ export interface ExperimentSeries {
236
+ name: SeriesName;
237
+ }
238
+ /**
239
+ * The source from which the experiment was created.
240
+ *
241
+ * Log Safety: SAFE
242
+ */
243
+ export type ExperimentSource = ({
244
+ type: "codeWorkspace";
245
+ } & ExperimentCodeWorkspaceSource) | ({
246
+ type: "authoring";
247
+ } & ExperimentAuthoringSource) | ({
248
+ type: "sdk";
249
+ } & ExperimentSdkSource);
250
+ /**
251
+ * The current status of an experiment.
252
+ *
253
+ * Log Safety: SAFE
254
+ */
255
+ export type ExperimentStatus = "RUNNING" | "SUCCEEDED" | "FAILED";
256
+ /**
257
+ * A tag associated with an experiment.
258
+ *
259
+ * Log Safety: UNSAFE
260
+ */
261
+ export type ExperimentTagText = LooselyBrandedString<"ExperimentTagText">;
43
262
  /**
44
263
  * Log Safety: SAFE
45
264
  */
46
265
  export interface FloatType {
47
266
  }
267
+ /**
268
+ * Array elements have inconsistent dimensions.
269
+ *
270
+ * Log Safety: UNSAFE
271
+ */
272
+ export interface InconsistentArrayDimensionsError {
273
+ firstElementShape: Array<number>;
274
+ conflictingElementShape: Array<number>;
275
+ }
276
+ /**
277
+ * The specific type and details of an input validation error for inference requests.
278
+ Each variant carries parameters relevant to that specific error category.
279
+ *
280
+ * Log Safety: UNSAFE
281
+ */
282
+ export type InferenceInputErrorType = ({
283
+ type: "invalidArrayShape";
284
+ } & InvalidArrayShapeError) | ({
285
+ type: "typeMismatch";
286
+ } & TypeMismatchError) | ({
287
+ type: "unsupportedType";
288
+ } & UnsupportedTypeError) | ({
289
+ type: "unknownInputName";
290
+ } & UnknownInputNameError) | ({
291
+ type: "invalidTabularFormat";
292
+ } & InvalidTabularFormatError) | ({
293
+ type: "inconsistentArrayDimensions";
294
+ } & InconsistentArrayDimensionsError) | ({
295
+ type: "requiredValueMissing";
296
+ } & RequiredValueMissingError) | ({
297
+ type: "invalidMapFormat";
298
+ } & InvalidMapFormatError);
299
+ /**
300
+ * A string alias used to identify inputs in a Model Studio configuration.
301
+ *
302
+ * Log Safety: UNSAFE
303
+ */
304
+ export type InputAlias = LooselyBrandedString<"InputAlias">;
305
+ /**
306
+ * An integer parameter value.
307
+ *
308
+ * Log Safety: UNSAFE
309
+ */
310
+ export interface IntegerParameter {
311
+ value: string;
312
+ }
48
313
  /**
49
314
  * Log Safety: SAFE
50
315
  */
51
316
  export interface IntegerType {
52
317
  }
318
+ /**
319
+ * Array dimensions do not match expected ndarray shape.
320
+ *
321
+ * Log Safety: UNSAFE
322
+ */
323
+ export interface InvalidArrayShapeError {
324
+ expectedShape: Array<number>;
325
+ actualShape?: Array<number>;
326
+ }
327
+ /**
328
+ * Map input has incorrect structure or null keys.
329
+ *
330
+ * Log Safety: SAFE
331
+ */
332
+ export interface InvalidMapFormatError {
333
+ }
334
+ /**
335
+ * Tabular input has incorrect JSON structure.
336
+ *
337
+ * Log Safety: UNSAFE
338
+ */
339
+ export interface InvalidTabularFormatError {
340
+ inputFieldName: string;
341
+ }
342
+ /**
343
+ * Log Safety: UNSAFE
344
+ */
345
+ export interface ListModelStudioConfigVersionsResponse {
346
+ data: Array<ModelStudioConfigVersion>;
347
+ nextPageToken?: _Core.PageToken;
348
+ }
349
+ /**
350
+ * Log Safety: UNSAFE
351
+ */
352
+ export interface ListModelStudioRunsResponse {
353
+ data: Array<ModelStudioRun>;
354
+ nextPageToken?: _Core.PageToken;
355
+ }
356
+ /**
357
+ * Log Safety: UNSAFE
358
+ */
359
+ export interface ListModelStudioTrainersResponse {
360
+ data: Array<ModelStudioTrainer>;
361
+ nextPageToken?: _Core.PageToken;
362
+ }
53
363
  /**
54
364
  * Log Safety: UNSAFE
55
365
  */
@@ -57,6 +367,18 @@ export interface ListModelVersionsResponse {
57
367
  data: Array<ModelVersion>;
58
368
  nextPageToken?: _Core.PageToken;
59
369
  }
370
+ /**
371
+ * Log Safety: SAFE
372
+ */
373
+ export interface LiveDeployment {
374
+ rid: LiveDeploymentRid;
375
+ }
376
+ /**
377
+ * The Resource Identifier (RID) of a Live Deployment.
378
+ *
379
+ * Log Safety: SAFE
380
+ */
381
+ export type LiveDeploymentRid = LooselyBrandedString<"LiveDeploymentRid">;
60
382
  /**
61
383
  * Log Safety: SAFE
62
384
  */
@@ -185,12 +507,154 @@ export type ModelFiles = {
185
507
  * Log Safety: UNSAFE
186
508
  */
187
509
  export type ModelName = LooselyBrandedString<"ModelName">;
510
+ /**
511
+ * Model output configuration.
512
+ *
513
+ * Log Safety: SAFE
514
+ */
515
+ export interface ModelOutput {
516
+ modelRid: string;
517
+ }
188
518
  /**
189
519
  * The Resource Identifier (RID) of a Model.
190
520
  *
191
521
  * Log Safety: SAFE
192
522
  */
193
523
  export type ModelRid = LooselyBrandedString<"ModelRid">;
524
+ /**
525
+ * Log Safety: SAFE
526
+ */
527
+ export interface ModelStudio {
528
+ rid: ModelStudioRid;
529
+ folderRid: _Filesystem.FolderRid;
530
+ createdTime: _Core.CreatedTime;
531
+ }
532
+ /**
533
+ * The Resource Identifier (RID) of a Model Studio Configuration.
534
+ *
535
+ * Log Safety: SAFE
536
+ */
537
+ export type ModelStudioConfigRid = LooselyBrandedString<"ModelStudioConfigRid">;
538
+ /**
539
+ * Log Safety: UNSAFE
540
+ */
541
+ export interface ModelStudioConfigVersion {
542
+ name: ModelStudioConfigVersionName;
543
+ version: ModelStudioConfigVersionNumber;
544
+ trainerId: TrainerId;
545
+ trainer: TrainerVersionLocator;
546
+ workerConfig: ModelStudioWorkerConfig;
547
+ resources: ResourceConfiguration;
548
+ changelog?: string;
549
+ createdBy: _Core.CreatedBy;
550
+ createdTime: _Core.CreatedTime;
551
+ }
552
+ /**
553
+ * Human readable name of the configuration version and experiment.
554
+ *
555
+ * Log Safety: UNSAFE
556
+ */
557
+ export type ModelStudioConfigVersionName = LooselyBrandedString<"ModelStudioConfigVersionName">;
558
+ /**
559
+ * The version number of a Model Studio Configuration.
560
+ *
561
+ * Log Safety: SAFE
562
+ */
563
+ export type ModelStudioConfigVersionNumber = number;
564
+ /**
565
+ * Input specification for a Model Studio configuration.
566
+ *
567
+ * Log Safety: UNSAFE
568
+ */
569
+ export type ModelStudioInput = {
570
+ type: "dataset";
571
+ } & DatasetInput;
572
+ /**
573
+ * Output specification for a Model Studio configuration.
574
+ *
575
+ * Log Safety: SAFE
576
+ */
577
+ export type ModelStudioOutput = {
578
+ type: "model";
579
+ } & ModelOutput;
580
+ /**
581
+ * The Resource Identifier (RID) of a Model Studio.
582
+ *
583
+ * Log Safety: SAFE
584
+ */
585
+ export type ModelStudioRid = LooselyBrandedString<"ModelStudioRid">;
586
+ /**
587
+ * Log Safety: UNSAFE
588
+ */
589
+ export interface ModelStudioRun {
590
+ runId: RunId;
591
+ buildRid: ModelStudioRunBuildRid;
592
+ jobRid: ModelStudioRunJobRid;
593
+ configVersion: ModelStudioConfigVersionNumber;
594
+ startedBy: _Core.CreatedBy;
595
+ startedTime: _Core.CreatedTime;
596
+ resolvedOutputs: Record<OutputAlias, ModelStudioRunOutput>;
597
+ }
598
+ /**
599
+ * The RID of the build associated with this run.
600
+ *
601
+ * Log Safety: SAFE
602
+ */
603
+ export type ModelStudioRunBuildRid = LooselyBrandedString<"ModelStudioRunBuildRid">;
604
+ /**
605
+ * The RID of the job associated with this run.
606
+ *
607
+ * Log Safety: SAFE
608
+ */
609
+ export type ModelStudioRunJobRid = LooselyBrandedString<"ModelStudioRunJobRid">;
610
+ /**
611
+ * Resolved model output details for a Model Studio run.
612
+ *
613
+ * Log Safety: SAFE
614
+ */
615
+ export interface ModelStudioRunModelOutput {
616
+ modelRid: string;
617
+ modelVersionRid: string;
618
+ experimentRid?: string;
619
+ }
620
+ /**
621
+ * Resolved output details for a Model Studio run.
622
+ *
623
+ * Log Safety: SAFE
624
+ */
625
+ export type ModelStudioRunOutput = {
626
+ type: "model";
627
+ } & ModelStudioRunModelOutput;
628
+ /**
629
+ * Log Safety: UNSAFE
630
+ */
631
+ export interface ModelStudioTrainer {
632
+ trainerId: TrainerId;
633
+ version: TrainerVersion;
634
+ name: TrainerName;
635
+ type: TrainerType;
636
+ description: TrainerDescription;
637
+ customConfigSchema: TrainerSchemaDefinition;
638
+ inputs: TrainerInputsSpecification;
639
+ outputs: TrainerOutputsSpecification;
640
+ experimental: ModelStudioTrainerExperimental;
641
+ }
642
+ /**
643
+ * Whether this trainer is experimental and may have breaking changes.
644
+ *
645
+ * Log Safety: SAFE
646
+ */
647
+ export type ModelStudioTrainerExperimental = boolean;
648
+ /**
649
+ * Configuration for the Model Studio worker.
650
+ *
651
+ * Log Safety: UNSAFE
652
+ */
653
+ export interface ModelStudioWorkerConfig {
654
+ customConfig?: Record<string, any>;
655
+ inputs: Record<InputAlias, ModelStudioInput>;
656
+ outputs: Record<OutputAlias, ModelStudioOutput>;
657
+ }
194
658
  /**
195
659
  * Log Safety: UNSAFE
196
660
  */
@@ -206,16 +670,417 @@ export interface ModelVersion {
206
670
  * Log Safety: SAFE
207
671
  */
208
672
  export type ModelVersionRid = LooselyBrandedString<"ModelVersionRid">;
673
+ /**
674
+ * A string alias used to identify outputs in a Model Studio configuration.
675
+ *
676
+ * Log Safety: UNSAFE
677
+ */
678
+ export type OutputAlias = LooselyBrandedString<"OutputAlias">;
679
+ /**
680
+ * A parameter with its name and value.
681
+ *
682
+ * Log Safety: UNSAFE
683
+ */
684
+ export interface Parameter {
685
+ name: ParameterName;
686
+ value: ParameterValue;
687
+ }
688
+ /**
689
+ * The name of an experiment parameter.
690
+ *
691
+ * Log Safety: UNSAFE
692
+ */
693
+ export type ParameterName = LooselyBrandedString<"ParameterName">;
694
+ /**
695
+ * A parameter value logged for an experiment.
696
+ *
697
+ * Log Safety: UNSAFE
698
+ */
699
+ export type ParameterValue = ({
700
+ type: "datetime";
701
+ } & DatetimeParameter) | ({
702
+ type: "boolean";
703
+ } & BooleanParameter) | ({
704
+ type: "string";
705
+ } & StringParameter) | ({
706
+ type: "double";
707
+ } & DoubleParameter) | ({
708
+ type: "integer";
709
+ } & IntegerParameter);
710
+ /**
711
+ * Required input field is null or missing.
712
+ *
713
+ * Log Safety: UNSAFE
714
+ */
715
+ export interface RequiredValueMissingError {
716
+ fieldName: string;
717
+ }
718
+ /**
719
+ * Compute resource configuration for training runs.
720
+ *
721
+ * Log Safety: SAFE
722
+ */
723
+ export interface ResourceConfiguration {
724
+ memory: string;
725
+ cpu: string;
726
+ }
727
+ /**
728
+ * A unique identifier for a Model Studio run, derived from the studio, config, and build.
729
+ *
730
+ * Log Safety: SAFE
731
+ */
732
+ export type RunId = LooselyBrandedString<"RunId">;
733
+ /**
734
+ * Returns experiments where every filter is satisfied.
735
+ *
736
+ * Log Safety: UNSAFE
737
+ */
738
+ export interface SearchExperimentsAndFilter {
739
+ filters: Array<SearchExperimentsFilter>;
740
+ }
741
+ /**
742
+ * Filter for substring containment matches.
743
+ *
744
+ * Log Safety: UNSAFE
745
+ */
746
+ export interface SearchExperimentsContainsFilter {
747
+ field: SearchExperimentsContainsFilterField;
748
+ value: any;
749
+ }
750
+ /**
751
+ * Fields that support substring containment filtering.
752
+ *
753
+ * Log Safety: SAFE
754
+ */
755
+ export type SearchExperimentsContainsFilterField = "EXPERIMENT_NAME" | "PARAMETER_NAME" | "SERIES_NAME";
756
+ /**
757
+ * Filter for exact field value matches.
758
+ *
759
+ * Log Safety: UNSAFE
760
+ */
761
+ export interface SearchExperimentsEqualsFilter {
762
+ field: SearchExperimentsEqualsFilterField;
763
+ value: any;
764
+ }
765
+ /**
766
+ * Fields that support equality filtering.
767
+ *
768
+ * Log Safety: SAFE
769
+ */
770
+ export type SearchExperimentsEqualsFilterField = "STATUS" | "BRANCH" | "EXPERIMENT_NAME" | "EXPERIMENT_RID" | "JOB_RID" | "TAG" | "PARAMETER_NAME" | "SERIES_NAME";
771
+ /**
772
+ * Filter for searching experiments using operator-based composition.
773
+ Supports equality, text matching, boolean combination operators, and compound filters
774
+ that atomically bind a name to a value comparison.
775
+ Example filters:
776
+
777
+ Simple status: {"eq": {"field": "STATUS", "value": "RUNNING"}}
778
+ Branch match: {"eq": {"field": "BRANCH", "value": "master"}}
779
+ Parameter filter: {"parameterFilter": {"parameterName": "learning_rate", "operator": "GT", "value": 0.01}}
780
+ Combined: {"and": {"filters": [
781
+ {"eq": {"field": "STATUS", "value": "SUCCEEDED"}},
782
+ {"parameterFilter": {"parameterName": "learning_rate", "operator": "GT", "value": 0.5}}
783
+ ]}}
784
+ *
785
+ * Log Safety: UNSAFE
786
+ */
787
+ export type SearchExperimentsFilter = ({
788
+ type: "seriesFilter";
789
+ } & SearchExperimentsSeriesFilter) | ({
790
+ type: "contains";
791
+ } & SearchExperimentsContainsFilter) | ({
792
+ type: "not";
793
+ } & SearchExperimentsNotFilter) | ({
794
+ type: "or";
795
+ } & SearchExperimentsOrFilter) | ({
796
+ type: "and";
797
+ } & SearchExperimentsAndFilter) | ({
798
+ type: "parameterFilter";
799
+ } & SearchExperimentsParameterFilter) | ({
800
+ type: "summaryMetricFilter";
801
+ } & SearchExperimentsSummaryMetricFilter) | ({
802
+ type: "eq";
803
+ } & SearchExperimentsEqualsFilter) | ({
804
+ type: "startsWith";
805
+ } & SearchExperimentsStartsWithFilter);
806
+ /**
807
+ * Comparison operator for compound filter predicates.
808
+ *
809
+ * Log Safety: SAFE
810
+ */
811
+ export type SearchExperimentsFilterOperator = "EQ" | "GT" | "LT" | "CONTAINS";
812
+ /**
813
+ * Returns experiments where the filter is not satisfied.
814
+ *
815
+ * Log Safety: UNSAFE
816
+ */
817
+ export interface SearchExperimentsNotFilter {
818
+ value: SearchExperimentsFilter;
819
+ }
820
+ /**
821
+ * Ordering configuration for experiment search results.
822
+ *
823
+ * Log Safety: SAFE
824
+ */
825
+ export interface SearchExperimentsOrderBy {
826
+ field: SearchExperimentsOrderByField;
827
+ direction: _Core.OrderByDirection;
828
+ }
829
+ /**
830
+ * Fields to order experiment search results by.
831
+ *
832
+ * Log Safety: SAFE
833
+ */
834
+ export type SearchExperimentsOrderByField = "EXPERIMENT_NAME" | "CREATED_AT";
835
+ /**
836
+ * Returns experiments where at least one filter is satisfied.
837
+ *
838
+ * Log Safety: UNSAFE
839
+ */
840
+ export interface SearchExperimentsOrFilter {
841
+ filters: Array<SearchExperimentsFilter>;
842
+ }
843
+ /**
844
+ * Filter that atomically binds a parameter name to a value comparison,
845
+ ensuring both conditions are evaluated on the same parameter.
846
+ Supported combinations:
847
+
848
+ EQ: boolean, double, integer, datetime, or string value
849
+ GT/LT: double, integer, or datetime value
850
+ CONTAINS: string value (matches the parameter's string value)
851
+ *
852
+ * Log Safety: UNSAFE
853
+ */
854
+ export interface SearchExperimentsParameterFilter {
855
+ parameterName: ParameterName;
856
+ operator: SearchExperimentsFilterOperator;
857
+ value: any;
858
+ }
859
+ /**
860
+ * Log Safety: UNSAFE
861
+ */
862
+ export interface SearchExperimentsRequest {
863
+ where?: SearchExperimentsFilter;
864
+ orderBy?: SearchExperimentsOrderBy;
865
+ pageSize?: _Core.PageSize;
866
+ pageToken?: _Core.PageToken;
867
+ }
868
+ /**
869
+ * Response from searching experiments.
870
+ *
871
+ * Log Safety: UNSAFE
872
+ */
873
+ export interface SearchExperimentsResponse {
874
+ data: Array<Experiment>;
875
+ nextPageToken?: _Core.PageToken;
876
+ }
877
+ /**
878
+ * Filter that atomically binds a series name to a metric comparison,
879
+ ensuring all conditions are evaluated on the same series.
880
+ *
881
+ * Log Safety: UNSAFE
882
+ */
883
+ export interface SearchExperimentsSeriesFilter {
884
+ seriesName: SeriesName;
885
+ field: SearchExperimentsSeriesFilterField;
886
+ operator: SearchExperimentsFilterOperator;
887
+ value: any;
888
+ }
889
+ /**
890
+ * The series metric to filter on.
891
+ *
892
+ * Log Safety: SAFE
893
+ */
894
+ export type SearchExperimentsSeriesFilterField = "LENGTH" | "AGGREGATION_MIN" | "AGGREGATION_MAX" | "AGGREGATION_LAST";
895
+ /**
896
+ * Filter for prefix matches.
897
+ *
898
+ * Log Safety: UNSAFE
899
+ */
900
+ export interface SearchExperimentsStartsWithFilter {
901
+ field: SearchExperimentsStartsWithFilterField;
902
+ value: any;
903
+ }
904
+ /**
905
+ * Fields that support prefix filtering.
906
+ *
907
+ * Log Safety: SAFE
908
+ */
909
+ export type SearchExperimentsStartsWithFilterField = "EXPERIMENT_NAME" | "PARAMETER_NAME" | "SERIES_NAME";
910
+ /**
911
+ * Filter that atomically binds a series name and aggregation type to a value comparison,
912
+ ensuring all conditions are evaluated on the same summary metric.
913
+ *
914
+ * Log Safety: UNSAFE
915
+ */
916
+ export interface SearchExperimentsSummaryMetricFilter {
917
+ seriesName: SeriesName;
918
+ aggregation: SummaryMetricAggregation;
919
+ operator: SearchExperimentsFilterOperator;
920
+ value: any;
921
+ }
922
+ /**
923
+ * A series of values logged over time.
924
+ *
925
+ * Log Safety: UNSAFE
926
+ */
927
+ export type Series = {
928
+ type: "doubleV1";
929
+ } & DoubleSeriesV1;
930
+ /**
931
+ * Series with precomputed aggregation values.
932
+ *
933
+ * Log Safety: UNSAFE
934
+ */
935
+ export interface SeriesAggregations {
936
+ name: SeriesName;
937
+ length: string;
938
+ value: SeriesAggregationsValue;
939
+ }
940
+ /**
941
+ * Union of aggregation values by series type.
942
+ *
943
+ * Log Safety: UNSAFE
944
+ */
945
+ export type SeriesAggregationsValue = {
946
+ type: "double";
947
+ } & DoubleSeriesAggregations;
948
+ /**
949
+ * The name of a series (metrics tracked over time).
950
+ *
951
+ * Log Safety: UNSAFE
952
+ */
953
+ export type SeriesName = LooselyBrandedString<"SeriesName">;
954
+ /**
955
+ * A string parameter value.
956
+ *
957
+ * Log Safety: UNSAFE
958
+ */
959
+ export interface StringParameter {
960
+ value: string;
961
+ }
209
962
  /**
210
963
  * Log Safety: SAFE
211
964
  */
212
965
  export interface StringType {
213
966
  }
967
+ /**
968
+ * A summary metric with series name, aggregation type, and computed value.
969
+ *
970
+ * Log Safety: UNSAFE
971
+ */
972
+ export interface SummaryMetric {
973
+ seriesName: SeriesName;
974
+ aggregation: SummaryMetricAggregation;
975
+ value: number;
976
+ }
977
+ /**
978
+ * The type of aggregation computed for a summary metric.
979
+ *
980
+ * Log Safety: SAFE
981
+ */
982
+ export type SummaryMetricAggregation = "MIN" | "MAX" | "LAST";
983
+ /**
984
+ * Details about a table artifact.
985
+ *
986
+ * Log Safety: SAFE
987
+ */
988
+ export interface TableArtifactDetails {
989
+ rowCount: string;
990
+ }
214
991
  /**
215
992
  * Log Safety: SAFE
216
993
  */
217
994
  export interface TimestampType {
218
995
  }
996
+ /**
997
+ * Description of what a trainer does and its capabilities.
998
+ *
999
+ * Log Safety: UNSAFE
1000
+ */
1001
+ export type TrainerDescription = LooselyBrandedString<"TrainerDescription">;
1002
+ /**
1003
+ * The identifier for a trainer.
1004
+ *
1005
+ * Log Safety: UNSAFE
1006
+ */
1007
+ export type TrainerId = LooselyBrandedString<"TrainerId">;
1008
+ /**
1009
+ * Specification of the inputs required by a trainer. When creating a ModelStudioConfigVersion, the workerConfig.inputs must conform to this specification, providing entries for each required input defined here.
1010
+ *
1011
+ * Log Safety: UNSAFE
1012
+ */
1013
+ export type TrainerInputsSpecification = any;
1014
+ /**
1015
+ * Human-readable name of a trainer.
1016
+ *
1017
+ * Log Safety: UNSAFE
1018
+ */
1019
+ export type TrainerName = LooselyBrandedString<"TrainerName">;
1020
+ /**
1021
+ * Specification of the outputs produced by a trainer. When creating a ModelStudioConfigVersion, the workerConfig.outputs must conform to this specification, providing entries for each required output defined here.
1022
+ *
1023
+ * Log Safety: UNSAFE
1024
+ */
1025
+ export type TrainerOutputsSpecification = any;
1026
+ /**
1027
+ * JSON schema defining the custom configuration parameters for a trainer.
1028
+ *
1029
+ * Log Safety: UNSAFE
1030
+ */
1031
+ export type TrainerSchemaDefinition = any;
1032
+ /**
1033
+ * The type/category of a trainer.
1034
+ *
1035
+ * Log Safety: UNSAFE
1036
+ */
1037
+ export type TrainerType = LooselyBrandedString<"TrainerType">;
1038
+ /**
1039
+ * A specific version identifier for a trainer.
1040
+ *
1041
+ * Log Safety: SAFE
1042
+ */
1043
+ export type TrainerVersion = LooselyBrandedString<"TrainerVersion">;
1044
+ /**
1045
+ * Identifies a specific version of a trainer.
1046
+ *
1047
+ * Log Safety: UNSAFE
1048
+ */
1049
+ export interface TrainerVersionLocator {
1050
+ trainerId: TrainerId;
1051
+ version: string;
1052
+ }
1053
+ /**
1054
+ * Log Safety: UNSAFE
1055
+ */
1056
+ export interface TransformJsonLiveDeploymentRequest {
1057
+ input: Record<string, any>;
1058
+ }
1059
+ /**
1060
+ * The response from transforming input data using a live deployment.
1061
+ *
1062
+ * Log Safety: UNSAFE
1063
+ */
1064
+ export interface TransformLiveDeploymentResponse {
1065
+ output: Record<string, any>;
1066
+ }
1067
+ /**
1068
+ * Input type does not match expected type in model API.
1069
+ *
1070
+ * Log Safety: SAFE
1071
+ */
1072
+ export interface TypeMismatchError {
1073
+ expectedType: string;
1074
+ actualType: string;
1075
+ }
1076
+ /**
1077
+ * Provided input name not found in model API specification.
1078
+ *
1079
+ * Log Safety: UNSAFE
1080
+ */
1081
+ export interface UnknownInputNameError {
1082
+ inputName: string;
1083
+ }
219
1084
  /**
220
1085
  * Log Safety: UNSAFE
221
1086
  */
@@ -223,6 +1088,14 @@ export interface UnsupportedType {
223
1088
  unsupportedType: string;
224
1089
  params: Record<_Core.UnsupportedTypeParamKey, _Core.UnsupportedTypeParamValue>;
225
1090
  }
1091
+ /**
1092
+ * Input contains an unsupported data type.
1093
+ *
1094
+ * Log Safety: SAFE
1095
+ */
1096
+ export interface UnsupportedTypeError {
1097
+ unsupportedType: string;
1098
+ }
226
1099
  /**
227
1100
  * Log Safety: UNSAFE
228
1101
  */