@salesforce/lds-adapters-platform-cdp-machine-learning 1.310.0 → 1.311.0

package/src/raml/api.raml

@@ -1205,6 +1205,100 @@ types:
       url:
         description: Url
         type: string
+  CdpMlAggregatePredictConditionRepresentation:
+    description: Cdp Ml Aggregate Prediction Contribution
+    type: object
+    properties:
+      count?:
+        description: Count of rows included in the aggregate condition
+        type: integer
+  CdpMlPredictionBaseRepresentation:
+    description: Base representation for a prediction result
+    type: object
+    properties:
+      status?:
+        description: prediction status
+        type: string | nil
+        enum:
+          - Success
+          - Error
+  CdpMlAggregatePredictionRepresentation:
+    description: Cdp Ml Prediction result representation
+    type: object
+    properties:
+      status?:
+        description: Status of aggregate prediction
+        type: string | nil
+        enum:
+          - Success
+          - Error
+      type?:
+        description: Type of aggregate prediction
+        type: string | nil
+        enum:
+          - Average
+          - Median
+          - Sum
+      factors?:
+        description: Top factors associated to this aggregate prediction
+        type: array
+        items:
+          type: CdpMlAggregatePredictConditionRepresentation
+      prescriptions?:
+        description: Prescriptions associated to this aggregate prediction
+        type: array
+        items:
+          type: CdpMlAggregatePredictConditionRepresentation
+      value?:
+        description: Aggregate prediction value
+        format: double
+        type: number
+  CdpMlPredictSettingsInputRepresentation:
+    description: Predict Settings Representation
+    type: object
+    properties:
+      maxPrescriptions?:
+        description: Maximum recommendation count. Default value is -1 (unlimited) and the allowed range is [-1, 200]
+        type: integer
+      prescriptionImpactPercentage?:
+        description: Impact Percentage of Prescriptions, Default is set at 0
+        type: integer
+      maxTopFactors?:
+        description: Maximum top factor count. Default value is 0 and the allowed range is [0, 3]
+        type: integer
+      aggregateFunctions?:
+        description: List of aggregate functions
+        type: array
+        items:
+          type: string | nil
+  CdpMlPredictResultRepresentation:
+    description: Cdp Ml Prediction result representation
+    type: object
+    properties:
+      model:
+        description: Model asset reference used as part of the prediction request
+        type: CdpAssetReferenceRepresentation
+      predictionType:
+        description: Prediction Type
+        type: string
+        enum:
+          - Regression
+          - BinaryClassification
+          - MulticlassClassification
+          - Generic/Unknown
+      predictions?:
+        description: A list of prediction results
+        type: array
+        items:
+          type: CdpMlPredictionBaseRepresentation
+      aggregatePredictions?:
+        description: Aggregate Result List
+        type: array
+        items:
+          type: CdpMlAggregatePredictionRepresentation
+      settings?:
+        description: Settings used for the prediction
+        type: CdpMlPredictSettingsInputRepresentation
   MlConfiguredModelInputRepresentation:
     description: Input representation for a Ml Configured Model
     type: object
@@ -1240,6 +1334,32 @@ types:
         enum:
           - Disabled
           - Enabled
+  CdpMlPredictRawDataInputRepresentation:
+    description: Raw Data Input Representation
+    type: object
+    properties:
+      type:
+        description: prediction type enum
+        type: string
+        enum:
+          - Records
+          - RawData
+          - RecordOverrides
+      model:
+        description: Model Reference
+        type: CdpAssetReferenceInputRepresentation
+      fieldNames:
+        description: Field names
+        type: array
+        items:
+          type: string
+      rows:
+        description: Rows of values
+        type: array
+        items:
+          type: array
+          items:
+            type: string
 /ssot:
   /machine-learning:
     /model-artifacts:
@@ -1539,3 +1659,17 @@ types:
           workspaceIdOrName:
             type: string
             required: true
+    /predict:
+      post:
+        displayName: CdpMlPredictResult
+        description: Get prediction result
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: CdpMlPredictResultRepresentation
+        body:
+          application/json:
+            type: CdpMlPredictRawDataInputRepresentation
+            (oas-body-name): predictInput

package/src/raml/luvio.raml

@@ -40,7 +40,23 @@ types:
     (luvio.opaque): true
     (luvio.key):
       configuredModelIdOrName: name
-
+  CdpMlAggregatePredictConditionRepresentation:
+    (luvio.ttl): 1000
+    (luvio.opaque): true
+  CdpMlPredictionBaseRepresentation:
+    (luvio.ttl): 1000
+    (luvio.opaque): true
+  CdpMlAggregatePredictionRepresentation:
+    (luvio.ttl): 1000
+    (luvio.opaque): true
+  CdpMlPredictSettingsInputRepresentation:
+    (luvio.ttl): 1000
+    (luvio.opaque): true
+  CdpMlPredictResultRepresentation:
+    (luvio.ttl): 1000
+    (luvio.opaque): true
+    (luvio.key):
+      predictionType: predictionType
 /ssot:
   /machine-learning:
     /model-artifacts:
@@ -103,3 +119,7 @@ types:
         uriParameters:
           modelIdOrName:
           workspaceIdOrName:
+    /predict:
+      post:
+        (luvio.adapter):
+          name: createCdpMlPredictResult