@salesforce/lds-adapters-platform-cdp-machine-learning 1.256.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 (58) hide show
  1. package/LICENSE.txt +82 -0
  2. package/dist/es/es2018/platform-cdp-machine-learning.js +2722 -0
  3. package/dist/es/es2018/types/src/generated/adapters/adapter-utils.d.ts +62 -0
  4. package/dist/es/es2018/types/src/generated/adapters/createCdpMlConfiguredModelCollection.d.ts +25 -0
  5. package/dist/es/es2018/types/src/generated/adapters/getCdpMlConfiguredModel.d.ts +28 -0
  6. package/dist/es/es2018/types/src/generated/adapters/getCdpMlConfiguredModelCollection.d.ts +27 -0
  7. package/dist/es/es2018/types/src/generated/adapters/getCdpMlModelArtifact.d.ts +27 -0
  8. package/dist/es/es2018/types/src/generated/adapters/getCdpMlModelArtifactCollection.d.ts +30 -0
  9. package/dist/es/es2018/types/src/generated/adapters/getCdpMlWorkspace.d.ts +28 -0
  10. package/dist/es/es2018/types/src/generated/adapters/getCdpMlWorkspaceCollection.d.ts +33 -0
  11. package/dist/es/es2018/types/src/generated/adapters/updateCdpMlConfiguredModel.d.ts +26 -0
  12. package/dist/es/es2018/types/src/generated/artifacts/main.d.ts +8 -0
  13. package/dist/es/es2018/types/src/generated/artifacts/sfdc.d.ts +16 -0
  14. package/dist/es/es2018/types/src/generated/resources/getSsotMachineLearningModelArtifacts.d.ts +18 -0
  15. package/dist/es/es2018/types/src/generated/resources/getSsotMachineLearningModelArtifactsByModelArtifactIdOrName.d.ts +15 -0
  16. package/dist/es/es2018/types/src/generated/resources/getSsotMachineLearningWorkspaces.d.ts +21 -0
  17. package/dist/es/es2018/types/src/generated/resources/getSsotMachineLearningWorkspacesByWorkspaceIdOrName.d.ts +16 -0
  18. package/dist/es/es2018/types/src/generated/resources/getSsotMachineLearningWorkspacesModelsByModelIdAndWorkspaceIdOrName.d.ts +16 -0
  19. package/dist/es/es2018/types/src/generated/resources/getSsotMachineLearningWorkspacesModelsByWorkspaceIdOrName.d.ts +15 -0
  20. package/dist/es/es2018/types/src/generated/resources/patchSsotMachineLearningWorkspacesModelsByModelIdAndWorkspaceIdOrName.d.ts +25 -0
  21. package/dist/es/es2018/types/src/generated/resources/postSsotMachineLearningWorkspacesModelsByWorkspaceIdOrName.d.ts +24 -0
  22. package/dist/es/es2018/types/src/generated/types/CdpAssetBaseRepresentation.d.ts +51 -0
  23. package/dist/es/es2018/types/src/generated/types/CdpAssetReferenceRepresentation.d.ts +51 -0
  24. package/dist/es/es2018/types/src/generated/types/CdpMlConfiguredModelCollectionRepresentation.d.ts +36 -0
  25. package/dist/es/es2018/types/src/generated/types/CdpMlConfiguredModelInputRepresentation.d.ts +56 -0
  26. package/dist/es/es2018/types/src/generated/types/CdpMlConfiguredModelRepresentation.d.ts +102 -0
  27. package/dist/es/es2018/types/src/generated/types/CdpMlCustomizableFieldDefinitionRepresentation.d.ts +31 -0
  28. package/dist/es/es2018/types/src/generated/types/CdpMlCustomizableFieldRepresentation.d.ts +35 -0
  29. package/dist/es/es2018/types/src/generated/types/CdpMlFieldRepresentation.d.ts +31 -0
  30. package/dist/es/es2018/types/src/generated/types/CdpMlFilterCriterionBaseRepresentation.d.ts +35 -0
  31. package/dist/es/es2018/types/src/generated/types/CdpMlFilterRepresentation.d.ts +29 -0
  32. package/dist/es/es2018/types/src/generated/types/CdpMlFilterValueRepresentation.d.ts +31 -0
  33. package/dist/es/es2018/types/src/generated/types/CdpMlModelArtifactBaseRepresentation.d.ts +82 -0
  34. package/dist/es/es2018/types/src/generated/types/CdpMlModelArtifactCollectionRepresentation.d.ts +39 -0
  35. package/dist/es/es2018/types/src/generated/types/CdpMlModelFieldBaseRepresentation.d.ts +37 -0
  36. package/dist/es/es2018/types/src/generated/types/CdpMlModelInputFieldBaseRepresentation.d.ts +40 -0
  37. package/dist/es/es2018/types/src/generated/types/CdpMlModelOutcomeDefinitionRepresentation.d.ts +32 -0
  38. package/dist/es/es2018/types/src/generated/types/CdpMlModelOutputFieldRepresentation.d.ts +31 -0
  39. package/dist/es/es2018/types/src/generated/types/CdpMlModelParameterDefinitionBaseRepresentation.d.ts +34 -0
  40. package/dist/es/es2018/types/src/generated/types/CdpMlModelParameterOverrideBaseRepresentation.d.ts +31 -0
  41. package/dist/es/es2018/types/src/generated/types/CdpMlModelRefreshConfigRepresentation.d.ts +35 -0
  42. package/dist/es/es2018/types/src/generated/types/CdpMlModelRefreshRecipientRepresentation.d.ts +34 -0
  43. package/dist/es/es2018/types/src/generated/types/CdpMlModelTypeRepresentation.d.ts +34 -0
  44. package/dist/es/es2018/types/src/generated/types/CdpMlWorkspaceBaseRepresentation.d.ts +102 -0
  45. package/dist/es/es2018/types/src/generated/types/CdpMlWorkspaceCollectionRepresentation.d.ts +39 -0
  46. package/dist/es/es2018/types/src/generated/types/CdpMlWorkspaceDetailRepresentation.d.ts +115 -0
  47. package/dist/es/es2018/types/src/generated/types/CdpMlWorkspaceRepresentation.d.ts +102 -0
  48. package/dist/es/es2018/types/src/generated/types/CdpPaginatedResponseBaseRepresentation.d.ts +34 -0
  49. package/dist/es/es2018/types/src/generated/types/CdpScheduleRepresentation.d.ts +35 -0
  50. package/dist/es/es2018/types/src/generated/types/CdpTimeRepresentation.d.ts +34 -0
  51. package/dist/es/es2018/types/src/generated/types/CdpTimeZoneRepresentation.d.ts +34 -0
  52. package/dist/es/es2018/types/src/generated/types/CdpUserRepresentation.d.ts +34 -0
  53. package/dist/es/es2018/types/src/generated/types/type-utils.d.ts +32 -0
  54. package/package.json +66 -0
  55. package/sfdc/index.d.ts +1 -0
  56. package/sfdc/index.js +2847 -0
  57. package/src/raml/api.raml +1089 -0
  58. package/src/raml/luvio.raml +79 -0
@@ -0,0 +1,1089 @@
1
+ #%RAML 1.0
2
+ securedBy:
3
+ - OAuth2
4
+ title: Salesforce Connect API
5
+ version: '60.0'
6
+ mediaType: application/json
7
+ protocols:
8
+ - https
9
+ baseUri: /services/data/v60.0
10
+ securitySchemes:
11
+ OAuth2:
12
+ type: OAuth 2.0
13
+ settings:
14
+ authorizationUri: https://example.com/oauth/authorize
15
+ accessTokenUri: ''
16
+ authorizationGrants:
17
+ - implicit
18
+ annotationTypes:
19
+ oas-readOnly:
20
+ type: boolean
21
+ allowedTargets: TypeDeclaration
22
+ oas-collectionFormat:
23
+ type: string
24
+ oas-body-name:
25
+ type: string
26
+ allowedTargets: TypeDeclaration
27
+ types:
28
+ CdpAssetBaseRepresentation:
29
+ description: Represents a base Asset
30
+ type: object
31
+ properties:
32
+ createdBy:
33
+ description: Created by
34
+ type: CdpUserRepresentation
35
+ createdDate:
36
+ description: Created date
37
+ type: string
38
+ id:
39
+ description: The 18 character ID of the asset
40
+ type: string
41
+ label:
42
+ description: Label of the asset
43
+ type: string
44
+ lastModifiedBy:
45
+ description: Last modified by
46
+ type: CdpUserRepresentation
47
+ lastModifiedDate:
48
+ description: Last modified date
49
+ type: string
50
+ name:
51
+ description: Name of the asset
52
+ type: string
53
+ namespace:
54
+ description: Namespace of the asset
55
+ type: string
56
+ url:
57
+ description: Url
58
+ type: string
59
+ CdpAssetReferenceRepresentation:
60
+ description: Represents Cdp Asset Reference
61
+ type: object
62
+ properties:
63
+ createdBy:
64
+ description: Created by
65
+ type: CdpUserRepresentation
66
+ createdDate:
67
+ description: Created date
68
+ type: string
69
+ id:
70
+ description: The 18 character ID of the asset
71
+ type: string
72
+ label:
73
+ description: Label of the asset
74
+ type: string
75
+ lastModifiedBy:
76
+ description: Last modified by
77
+ type: CdpUserRepresentation
78
+ lastModifiedDate:
79
+ description: Last modified date
80
+ type: string
81
+ name:
82
+ description: Name of the asset
83
+ type: string
84
+ namespace:
85
+ description: Namespace of the asset
86
+ type: string
87
+ url:
88
+ description: Url
89
+ type: string
90
+ CdpMlConfiguredModelCollectionRepresentation:
91
+ description: Represents Cdp Ml Configured Model Collection
92
+ type: object
93
+ properties:
94
+ models:
95
+ description: List of configured models
96
+ type: array
97
+ items:
98
+ type: CdpMlConfiguredModelRepresentation
99
+ totalSize:
100
+ description: Total size of collection
101
+ type: integer
102
+ url:
103
+ description: Url
104
+ type: string
105
+ CdpMlModelParameterOverrideBaseRepresentation:
106
+ description: Cdp Ml Model Parameter Override Base Representation
107
+ discriminator: type
108
+ type: object
109
+ properties:
110
+ parameterName:
111
+ description: Parameter Name
112
+ type: string
113
+ type:
114
+ description: Parameter Type
115
+ type: string
116
+ enum:
117
+ - Continuous
118
+ - Discrete
119
+ CdpUserRepresentation:
120
+ description: Represents a user
121
+ type: object
122
+ properties:
123
+ id:
124
+ description: The 18 character user ID
125
+ type: string
126
+ name:
127
+ description: The name of the user
128
+ type: string
129
+ profilePhotoUrl:
130
+ description: The Chatter profile photo of the user
131
+ type: string
132
+ CdpMlModelArtifactBaseRepresentation:
133
+ description: Cdp Ml Model Artifact Base Representation
134
+ discriminator: modelType
135
+ type: object
136
+ properties:
137
+ description:
138
+ description: Description
139
+ type: string
140
+ inputFields:
141
+ description: Input Fields
142
+ type: array
143
+ items:
144
+ type: CdpMlModelInputFieldBaseRepresentation
145
+ modelType:
146
+ description: Model Type
147
+ type: string
148
+ enum:
149
+ - Generative
150
+ - Predictive
151
+ outputFields:
152
+ description: Output Fields
153
+ type: array
154
+ items:
155
+ type: CdpMlModelOutputFieldRepresentation
156
+ parameters:
157
+ description: List of Model Parameter Definitions
158
+ type: array
159
+ items:
160
+ type: CdpMlModelParameterDefinitionBaseRepresentation
161
+ runtimeType:
162
+ description: Runtime Type
163
+ type: string
164
+ enum:
165
+ - External
166
+ - Internal
167
+ source:
168
+ description: Source
169
+ type: CdpAssetReferenceRepresentation
170
+ sourceType:
171
+ description: SourceType
172
+ type: string
173
+ enum:
174
+ - EdcNoCode
175
+ - ModelConnector
176
+ - OutOfTheBox
177
+ createdBy:
178
+ description: Created by
179
+ type: CdpUserRepresentation
180
+ createdDate:
181
+ description: Created date
182
+ type: string
183
+ id:
184
+ description: The 18 character ID of the asset
185
+ type: string
186
+ label:
187
+ description: Label of the asset
188
+ type: string
189
+ lastModifiedBy:
190
+ description: Last modified by
191
+ type: CdpUserRepresentation
192
+ lastModifiedDate:
193
+ description: Last modified date
194
+ type: string
195
+ name:
196
+ description: Name of the asset
197
+ type: string
198
+ namespace:
199
+ description: Namespace of the asset
200
+ type: string
201
+ url:
202
+ description: Url
203
+ type: string
204
+ CdpMlConfiguredModelInputRepresentation:
205
+ description: Input representation for a Cdp Ml Configured Model (Active Partition)
206
+ type: object
207
+ properties:
208
+ actionableFields:
209
+ description: Actionable Fields
210
+ type: array
211
+ items:
212
+ type: object
213
+ artifact:
214
+ description: Artifact
215
+ type: object
216
+ capability:
217
+ description: Model capability
218
+ type: string
219
+ enum:
220
+ - ChatCompletion
221
+ - Completion
222
+ - Embedding
223
+ customizableFields:
224
+ description: Customizable Fields
225
+ type: array
226
+ items:
227
+ type: object
228
+ description:
229
+ description: Model description
230
+ type: string
231
+ filter:
232
+ description: Filter
233
+ type: object
234
+ label:
235
+ description: Model label
236
+ type: string
237
+ parameterOverrides:
238
+ description: Model Parameter override
239
+ type: array
240
+ items:
241
+ type: object
242
+ position:
243
+ description: Position
244
+ type: integer
245
+ status:
246
+ description: Model status
247
+ type: string
248
+ enum:
249
+ - Disabled
250
+ - Enabled
251
+ CdpMlConfiguredModelRepresentation:
252
+ description: Represents Cdp Ml Configured Model (Active Partition)
253
+ type: object
254
+ properties:
255
+ actionableFields:
256
+ description: List of actionable fields
257
+ type: array
258
+ items:
259
+ type: CdpMlCustomizableFieldRepresentation
260
+ artifact:
261
+ description: AI model
262
+ type: CdpAssetReferenceRepresentation
263
+ capability:
264
+ description: Model capability
265
+ type: string
266
+ enum:
267
+ - ChatCompletion
268
+ - Completion
269
+ - Embedding
270
+ customizableFields:
271
+ description: List of customizable fields
272
+ type: array
273
+ items:
274
+ type: CdpMlCustomizableFieldRepresentation
275
+ description:
276
+ description: Model description
277
+ type: string
278
+ filter:
279
+ description: Model filters
280
+ type: CdpMlFilterRepresentation
281
+ lastActivatedBy:
282
+ description: Last activated by
283
+ type: CdpUserRepresentation
284
+ lastActivatedDate:
285
+ description: Last activated date
286
+ type: string
287
+ metricsUrl:
288
+ description: Live metrics url
289
+ type: string
290
+ parameterOverrides:
291
+ description: List of Model Parameter Overrides
292
+ type: array
293
+ items:
294
+ type: CdpMlModelParameterOverrideBaseRepresentation
295
+ position:
296
+ description: Model position
297
+ type: integer
298
+ status:
299
+ description: Model status
300
+ type: string
301
+ enum:
302
+ - Disabled
303
+ - Enabled
304
+ createdBy:
305
+ description: Created by
306
+ type: CdpUserRepresentation
307
+ createdDate:
308
+ description: Created date
309
+ type: string
310
+ id:
311
+ description: The 18 character ID of the asset
312
+ type: string
313
+ label:
314
+ description: Label of the asset
315
+ type: string
316
+ lastModifiedBy:
317
+ description: Last modified by
318
+ type: CdpUserRepresentation
319
+ lastModifiedDate:
320
+ description: Last modified date
321
+ type: string
322
+ name:
323
+ description: Name of the asset
324
+ type: string
325
+ namespace:
326
+ description: Namespace of the asset
327
+ type: string
328
+ url:
329
+ description: Url
330
+ type: string
331
+ CdpMlCustomizableFieldDefinitionRepresentation:
332
+ description: Represents Cdp Ml Customizable Field Definition
333
+ type: object
334
+ properties:
335
+ filter:
336
+ description: Filter rules for enabling custom text, catch all is assumed when
337
+ null is set
338
+ type: CdpMlFilterRepresentation
339
+ templateText:
340
+ description: Template text to be replaced with
341
+ type: string
342
+ CdpMlCustomizableFieldRepresentation:
343
+ description: Represents Cdp Ml Customizable Field
344
+ type: object
345
+ properties:
346
+ customDefinitions:
347
+ description: List of customizable field definitions
348
+ type: array
349
+ items:
350
+ type: CdpMlCustomizableFieldDefinitionRepresentation
351
+ field:
352
+ description: Customizable field
353
+ type: CdpMlModelInputFieldBaseRepresentation
354
+ type:
355
+ description: Customizable field type
356
+ type: string
357
+ enum:
358
+ - ActionableVariable
359
+ - TopFactor
360
+ CdpMlFieldRepresentation:
361
+ description: Cdp Ml Field
362
+ type: object
363
+ properties:
364
+ label:
365
+ description: label
366
+ type: string
367
+ name:
368
+ description: name
369
+ type: string
370
+ CdpMlFilterCriterionBaseRepresentation:
371
+ description: Represents Base Cdp Ml Filter Criterion
372
+ type: object
373
+ properties:
374
+ operator:
375
+ description: Operator type
376
+ type: string
377
+ enum:
378
+ - Between
379
+ - Contains
380
+ - EndsWith
381
+ - Equal
382
+ - GreaterThan
383
+ - GreaterThanOrEqual
384
+ - InSet
385
+ - LessThan
386
+ - LessThanOrEqual
387
+ - NotBetween
388
+ - NotEqual
389
+ - NotIn
390
+ - StartsWith
391
+ type:
392
+ description: Filter type
393
+ type: string
394
+ enum:
395
+ - CalculatedInsightObjectField
396
+ - DataModelObjectField
397
+ - ModelInputField
398
+ values:
399
+ description: Ordered list of values to be applied in the filter
400
+ type: array
401
+ items:
402
+ type: CdpMlFilterValueRepresentation
403
+ CdpMlFilterRepresentation:
404
+ description: Represents Cdp Ml filter
405
+ type: object
406
+ properties:
407
+ criteria:
408
+ description: filter criteria
409
+ type: array
410
+ items:
411
+ type: CdpMlFilterCriterionBaseRepresentation
412
+ CdpMlFilterValueRepresentation:
413
+ description: Represents Cdp Ml Filter Value
414
+ type: object
415
+ properties:
416
+ type:
417
+ description: Filter value type
418
+ type: string
419
+ enum:
420
+ - Constant
421
+ - Placeholder
422
+ value:
423
+ description: Filter value can be a constant or a valid placeholder
424
+ type: string
425
+ CdpMlModelParameterDefinitionBaseRepresentation:
426
+ description: Cdp Ml Model Parameter Base Representation
427
+ discriminator: type
428
+ type: object
429
+ properties:
430
+ description:
431
+ description: Parameter description
432
+ type: string
433
+ parameterName:
434
+ description: Parameter Name
435
+ type: string
436
+ type:
437
+ description: Parameter Type
438
+ type: string
439
+ enum:
440
+ - Continuous
441
+ - Discrete
442
+ CdpMlModelOutputFieldRepresentation:
443
+ description: Cdp Ml Model Output Field Representation
444
+ type: object
445
+ properties:
446
+ dataType:
447
+ description: Field data type
448
+ type: string
449
+ enum:
450
+ - Date
451
+ - Number
452
+ - Text
453
+ position:
454
+ description: Field position
455
+ type: integer
456
+ CdpPaginatedResponseBaseRepresentation:
457
+ description: Base paginated response representation
458
+ type: object
459
+ properties:
460
+ currentPageUrl:
461
+ description: Current page url
462
+ type: string
463
+ nextPageUrl:
464
+ description: Next page url if it exists
465
+ type: string
466
+ totalSize:
467
+ description: Total size of collection
468
+ type: integer
469
+ CdpMlModelArtifactCollectionRepresentation:
470
+ description: Cdp Ml Model Artifact Collection Representation
471
+ type: object
472
+ properties:
473
+ modelArtifacts:
474
+ description: List of model artifacts
475
+ type: array
476
+ items:
477
+ type: CdpMlModelArtifactBaseRepresentation
478
+ currentPageUrl:
479
+ description: Current page url
480
+ type: string
481
+ nextPageUrl:
482
+ description: Next page url if it exists
483
+ type: string
484
+ totalSize:
485
+ description: Total size of collection
486
+ type: integer
487
+ CdpMlModelFieldBaseRepresentation:
488
+ description: Cdp Ml Model Field Base Representation
489
+ type: object
490
+ properties:
491
+ dataType:
492
+ description: Field data type
493
+ type: string
494
+ enum:
495
+ - Date
496
+ - Number
497
+ - Text
498
+ position:
499
+ description: Field position
500
+ type: integer
501
+ label:
502
+ description: label
503
+ type: string
504
+ name:
505
+ description: name
506
+ type: string
507
+ CdpMlModelInputFieldBaseRepresentation:
508
+ description: Represents Base Cdp Ml Model Input Field
509
+ type: object
510
+ properties:
511
+ isDisparateImpact:
512
+ description: Whether this field is a disparate impact field
513
+ type: boolean
514
+ isPartitionField:
515
+ description: Is this field used for partition
516
+ type: boolean
517
+ isSensitive:
518
+ description: Whether this field is a sensitive field
519
+ type: boolean
520
+ dataType:
521
+ description: Field data type
522
+ type: string
523
+ enum:
524
+ - Date
525
+ - Number
526
+ - Text
527
+ position:
528
+ description: Field position
529
+ type: integer
530
+ CdpMlModelOutcomeDefinitionRepresentation:
531
+ description: Cdp Ml Model Outcome Definition Representation
532
+ type: object
533
+ properties:
534
+ fields:
535
+ description: Model output fields
536
+ type: array
537
+ items:
538
+ type: CdpMlModelOutputFieldRepresentation
539
+ goal:
540
+ description: Model outcome goal
541
+ type: string
542
+ enum:
543
+ - Maximize
544
+ - Minimize
545
+ - None
546
+ CdpMlModelTypeRepresentation:
547
+ description: Cdp Ml Model Type
548
+ type: object
549
+ properties:
550
+ connectorType:
551
+ description: Connector Type
552
+ type: string
553
+ enum:
554
+ - OpenAI
555
+ - SageMaker
556
+ modelType:
557
+ description: Model type
558
+ type: string
559
+ enum:
560
+ - Generative
561
+ - Predictive
562
+ sourceType:
563
+ description: Source type
564
+ type: string
565
+ enum:
566
+ - EdcNoCode
567
+ - ModelConnector
568
+ - OutOfTheBox
569
+ CdpMlModelRefreshRecipientRepresentation:
570
+ description: Cdp Ml Model Refresh Recipient Representation
571
+ type: object
572
+ properties:
573
+ displayName:
574
+ description: Refresh recipient name
575
+ type: string
576
+ id:
577
+ description: Model refresh recipient Id
578
+ type: string
579
+ type:
580
+ description: Refresh recipient type
581
+ type: string
582
+ enum:
583
+ - Group
584
+ - User
585
+ CdpMlModelRefreshConfigRepresentation:
586
+ description: Cdp Ml Model Refresh Configuration Representation
587
+ type: object
588
+ properties:
589
+ isEnabled:
590
+ description: Returns the value of the enabled flag (true or false)
591
+ type: boolean
592
+ recipients:
593
+ description: List of model recipients
594
+ type: array
595
+ items:
596
+ type: CdpMlModelRefreshRecipientRepresentation
597
+ schedule:
598
+ description: Model refresh schedule
599
+ type: CdpScheduleRepresentation
600
+ CdpMlWorkspaceBaseRepresentation:
601
+ description: Cdp Ml Workspace Base Representation
602
+ type: object
603
+ properties:
604
+ activeSetup:
605
+ description: The active setup, if it exists
606
+ type: CdpAssetReferenceRepresentation
607
+ activeSetupVersionNumber:
608
+ description: The version number of the active setup
609
+ type: integer
610
+ description:
611
+ description: Model description
612
+ type: string
613
+ historiesUrl:
614
+ description: Histories URL
615
+ type: string
616
+ latestSetup:
617
+ description: The latest setup, if it exists
618
+ type: CdpAssetReferenceRepresentation
619
+ modelCount:
620
+ description: Model count
621
+ type: integer
622
+ modelType:
623
+ description: Model type
624
+ type: CdpMlModelTypeRepresentation
625
+ modelsUrl:
626
+ description: Models URL
627
+ type: string
628
+ outcomeDefinition:
629
+ description: Model outcome definition
630
+ type: CdpMlModelOutcomeDefinitionRepresentation
631
+ predictionType:
632
+ description: Model prediction type
633
+ type: string
634
+ enum:
635
+ - BinaryClassification
636
+ - MulticlassClassification
637
+ - Regression
638
+ refreshConfig:
639
+ description: Model refresh config
640
+ type: CdpMlModelRefreshConfigRepresentation
641
+ setupVersionsUrl:
642
+ description: Setup versions URL
643
+ type: string
644
+ status:
645
+ description: Model status
646
+ type: string
647
+ enum:
648
+ - Disabled
649
+ - Draft
650
+ - Enabled
651
+ totalInferenceCount:
652
+ description: Model total inference count
653
+ type: integer
654
+ totalWarningsCount:
655
+ description: Model total warnings count
656
+ type: integer
657
+ createdBy:
658
+ description: Created by
659
+ type: CdpUserRepresentation
660
+ createdDate:
661
+ description: Created date
662
+ type: string
663
+ id:
664
+ description: The 18 character ID of the asset
665
+ type: string
666
+ label:
667
+ description: Label of the asset
668
+ type: string
669
+ lastModifiedBy:
670
+ description: Last modified by
671
+ type: CdpUserRepresentation
672
+ lastModifiedDate:
673
+ description: Last modified date
674
+ type: string
675
+ name:
676
+ description: Name of the asset
677
+ type: string
678
+ namespace:
679
+ description: Namespace of the asset
680
+ type: string
681
+ url:
682
+ description: Url
683
+ type: string
684
+ CdpMlWorkspaceDetailRepresentation:
685
+ description: Cdp Ml Workspace Details Representation
686
+ type: object
687
+ properties:
688
+ activations:
689
+ description: List of activations
690
+ type: array
691
+ items:
692
+ type: string
693
+ enum:
694
+ - Flow
695
+ - PredictionJob
696
+ activeSetup:
697
+ description: The active setup, if it exists
698
+ type: CdpAssetReferenceRepresentation
699
+ activeSetupVersionNumber:
700
+ description: The version number of the active setup
701
+ type: integer
702
+ description:
703
+ description: Model description
704
+ type: string
705
+ historiesUrl:
706
+ description: Histories URL
707
+ type: string
708
+ latestSetup:
709
+ description: The latest setup, if it exists
710
+ type: CdpAssetReferenceRepresentation
711
+ modelCount:
712
+ description: Model count
713
+ type: integer
714
+ modelType:
715
+ description: Model type
716
+ type: CdpMlModelTypeRepresentation
717
+ modelsUrl:
718
+ description: Models URL
719
+ type: string
720
+ outcomeDefinition:
721
+ description: Model outcome definition
722
+ type: CdpMlModelOutcomeDefinitionRepresentation
723
+ predictionType:
724
+ description: Model prediction type
725
+ type: string
726
+ enum:
727
+ - BinaryClassification
728
+ - MulticlassClassification
729
+ - Regression
730
+ refreshConfig:
731
+ description: Model refresh config
732
+ type: CdpMlModelRefreshConfigRepresentation
733
+ setupVersionsUrl:
734
+ description: Setup versions URL
735
+ type: string
736
+ status:
737
+ description: Model status
738
+ type: string
739
+ enum:
740
+ - Disabled
741
+ - Draft
742
+ - Enabled
743
+ totalInferenceCount:
744
+ description: Model total inference count
745
+ type: integer
746
+ totalWarningsCount:
747
+ description: Model total warnings count
748
+ type: integer
749
+ createdBy:
750
+ description: Created by
751
+ type: CdpUserRepresentation
752
+ createdDate:
753
+ description: Created date
754
+ type: string
755
+ id:
756
+ description: The 18 character ID of the asset
757
+ type: string
758
+ label:
759
+ description: Label of the asset
760
+ type: string
761
+ lastModifiedBy:
762
+ description: Last modified by
763
+ type: CdpUserRepresentation
764
+ lastModifiedDate:
765
+ description: Last modified date
766
+ type: string
767
+ name:
768
+ description: Name of the asset
769
+ type: string
770
+ namespace:
771
+ description: Namespace of the asset
772
+ type: string
773
+ url:
774
+ description: Url
775
+ type: string
776
+ CdpMlWorkspaceRepresentation:
777
+ description: Cdp Ml Workspace Representation
778
+ type: object
779
+ properties:
780
+ activeSetup:
781
+ description: The active setup, if it exists
782
+ type: CdpAssetReferenceRepresentation
783
+ activeSetupVersionNumber:
784
+ description: The version number of the active setup
785
+ type: integer
786
+ description:
787
+ description: Model description
788
+ type: string
789
+ historiesUrl:
790
+ description: Histories URL
791
+ type: string
792
+ latestSetup:
793
+ description: The latest setup, if it exists
794
+ type: CdpAssetReferenceRepresentation
795
+ modelCount:
796
+ description: Model count
797
+ type: integer
798
+ modelType:
799
+ description: Model type
800
+ type: CdpMlModelTypeRepresentation
801
+ modelsUrl:
802
+ description: Models URL
803
+ type: string
804
+ outcomeDefinition:
805
+ description: Model outcome definition
806
+ type: CdpMlModelOutcomeDefinitionRepresentation
807
+ predictionType:
808
+ description: Model prediction type
809
+ type: string
810
+ enum:
811
+ - BinaryClassification
812
+ - MulticlassClassification
813
+ - Regression
814
+ refreshConfig:
815
+ description: Model refresh config
816
+ type: CdpMlModelRefreshConfigRepresentation
817
+ setupVersionsUrl:
818
+ description: Setup versions URL
819
+ type: string
820
+ status:
821
+ description: Model status
822
+ type: string
823
+ enum:
824
+ - Disabled
825
+ - Draft
826
+ - Enabled
827
+ totalInferenceCount:
828
+ description: Model total inference count
829
+ type: integer
830
+ totalWarningsCount:
831
+ description: Model total warnings count
832
+ type: integer
833
+ createdBy:
834
+ description: Created by
835
+ type: CdpUserRepresentation
836
+ createdDate:
837
+ description: Created date
838
+ type: string
839
+ id:
840
+ description: The 18 character ID of the asset
841
+ type: string
842
+ label:
843
+ description: Label of the asset
844
+ type: string
845
+ lastModifiedBy:
846
+ description: Last modified by
847
+ type: CdpUserRepresentation
848
+ lastModifiedDate:
849
+ description: Last modified date
850
+ type: string
851
+ name:
852
+ description: Name of the asset
853
+ type: string
854
+ namespace:
855
+ description: Namespace of the asset
856
+ type: string
857
+ url:
858
+ description: Url
859
+ type: string
860
+ CdpMlWorkspaceCollectionRepresentation:
861
+ description: Cdp Ml Workspace Collection Representation
862
+ type: object
863
+ properties:
864
+ workspaces:
865
+ description: List of workspaces
866
+ type: array
867
+ items:
868
+ type: CdpMlWorkspaceRepresentation
869
+ currentPageUrl:
870
+ description: Current page url
871
+ type: string
872
+ nextPageUrl:
873
+ description: Next page url if it exists
874
+ type: string
875
+ totalSize:
876
+ description: Total size of collection
877
+ type: integer
878
+ CdpTimeRepresentation:
879
+ description: Cdp Time Representation
880
+ type: object
881
+ properties:
882
+ hour:
883
+ description: Hour
884
+ type: integer
885
+ minute:
886
+ description: Minute
887
+ type: integer
888
+ timezone:
889
+ description: Time Zone
890
+ type: CdpTimeZoneRepresentation
891
+ CdpTimeZoneRepresentation:
892
+ description: Cdp Time Zone Representation
893
+ type: object
894
+ properties:
895
+ gmtOffset:
896
+ description: Time zone offset to GMT
897
+ format: double
898
+ type: number
899
+ name:
900
+ description: Time zone name
901
+ type: string
902
+ zoneId:
903
+ description: Time zone identifier
904
+ type: string
905
+ CdpScheduleRepresentation:
906
+ description: Cdp Schedule Representation
907
+ type: object
908
+ properties:
909
+ frequency:
910
+ description: Schedule frequency
911
+ type: string
912
+ enum:
913
+ - Daily
914
+ - Hourly
915
+ - Minutely
916
+ - Monthly
917
+ - MonthlyRelative
918
+ - None
919
+ - Weekly
920
+ nextScheduledDate:
921
+ description: Next Scheduled Date
922
+ type: string
923
+ time:
924
+ description: Schedule Time
925
+ type: CdpTimeRepresentation
926
+ /ssot:
927
+ /machine-learning:
928
+ /model-artifacts:
929
+ get:
930
+ displayName: getCdpMlModelArtifactCollection
931
+ description: Get Model Artifacts
932
+ responses:
933
+ '200':
934
+ description: Success
935
+ body:
936
+ application/json:
937
+ type: CdpMlModelArtifactCollectionRepresentation
938
+ queryParameters:
939
+ limit:
940
+ type: integer
941
+ required: false
942
+ modelType:
943
+ type: string
944
+ required: false
945
+ enum:
946
+ - Generative
947
+ - Predictive
948
+ offset:
949
+ type: integer
950
+ required: false
951
+ sourceType:
952
+ type: string
953
+ required: false
954
+ enum:
955
+ - EdcNoCode
956
+ - ModelConnector
957
+ - OutOfTheBox
958
+ /model-artifacts/{modelArtifactIdOrName}:
959
+ get:
960
+ displayName: getCdpMlModelArtifact
961
+ description: Get Model Artifact
962
+ responses:
963
+ '200':
964
+ description: Success
965
+ body:
966
+ application/json:
967
+ type: CdpMlModelArtifactBaseRepresentation
968
+ uriParameters:
969
+ modelArtifactIdOrName:
970
+ type: string
971
+ required: true
972
+ /workspaces:
973
+ get:
974
+ displayName: getCdpMlWorkspaceCollection
975
+ description: Get workspaces
976
+ responses:
977
+ '200':
978
+ description: Success
979
+ body:
980
+ application/json:
981
+ type: CdpMlWorkspaceCollectionRepresentation
982
+ queryParameters:
983
+ limit:
984
+ type: integer
985
+ required: false
986
+ modelType:
987
+ type: string
988
+ required: false
989
+ enum:
990
+ - Generative
991
+ - Predictive
992
+ offset:
993
+ type: integer
994
+ required: false
995
+ predictionType:
996
+ type: string
997
+ required: false
998
+ enum:
999
+ - BinaryClassification
1000
+ - MulticlassClassification
1001
+ - Regression
1002
+ search:
1003
+ type: string
1004
+ required: false
1005
+ sourceType:
1006
+ type: string
1007
+ required: false
1008
+ enum:
1009
+ - EdcNoCode
1010
+ - ModelConnector
1011
+ - OutOfTheBox
1012
+ status:
1013
+ type: string
1014
+ required: false
1015
+ enum:
1016
+ - Disabled
1017
+ - Draft
1018
+ - Enabled
1019
+ /workspaces/{workspaceIdOrName}:
1020
+ get:
1021
+ displayName: getCdpMlWorkspace
1022
+ description: Get workspace
1023
+ responses:
1024
+ '200':
1025
+ description: Success
1026
+ body:
1027
+ application/json:
1028
+ type: CdpMlWorkspaceDetailRepresentation
1029
+ uriParameters:
1030
+ workspaceIdOrName:
1031
+ type: string
1032
+ required: true
1033
+ /models:
1034
+ get:
1035
+ displayName: getCdpMlConfiguredModelCollection
1036
+ description: Get configured models
1037
+ responses:
1038
+ '200':
1039
+ description: Success
1040
+ body:
1041
+ application/json:
1042
+ type: CdpMlConfiguredModelCollectionRepresentation
1043
+ post:
1044
+ displayName: createCdpMlConfiguredModelCollection
1045
+ description: Create a new configured model
1046
+ responses:
1047
+ '200':
1048
+ description: Success
1049
+ body:
1050
+ application/json:
1051
+ type: CdpMlConfiguredModelRepresentation
1052
+ body:
1053
+ application/json:
1054
+ type: CdpMlConfiguredModelInputRepresentation
1055
+ (oas-body-name): model
1056
+ uriParameters:
1057
+ workspaceIdOrName:
1058
+ type: string
1059
+ required: true
1060
+ /models/{modelId}:
1061
+ get:
1062
+ displayName: getCdpMlConfiguredModel
1063
+ description: Get a configured model
1064
+ responses:
1065
+ '200':
1066
+ description: Success
1067
+ body:
1068
+ application/json:
1069
+ type: CdpMlConfiguredModelRepresentation
1070
+ patch:
1071
+ displayName: updateCdpMlConfiguredModel
1072
+ description: Update a configured model
1073
+ responses:
1074
+ '200':
1075
+ description: Success
1076
+ body:
1077
+ application/json:
1078
+ type: CdpMlConfiguredModelRepresentation
1079
+ body:
1080
+ application/json:
1081
+ type: CdpMlConfiguredModelInputRepresentation
1082
+ (oas-body-name): model
1083
+ uriParameters:
1084
+ modelId:
1085
+ type: string
1086
+ required: true
1087
+ workspaceIdOrName:
1088
+ type: string
1089
+ required: true