@salesforce/lds-adapters-industries-einstein-aiaccelerator 1.308.0-dev1 → 1.309.0

package/src/raml/api.raml

@@ -2,7 +2,7 @@
 securedBy:
   - OAuth2
 title: Salesforce Connect API
-version: '56.0'
+version: '62.0'
 mediaType: application/json
 protocols:
   - https
@@ -82,6 +82,18 @@ types:
         description: Map of the Field Map.
         type: NullableFeatureExtractionParametersMapValue | nil # TODO Hand-rolled W-7093257
         required: false
+  FieldCount:
+    description: .
+    type: object
+    properties:
+      count:
+        description: .
+        type: integer
+        required: false # TODO Hand-rolled W-16235747
+      fieldValue:
+        description: .
+        type: string
+        required: false # TODO Hand-rolled W-16235747
   Insight:
     description: .
     type: object
@@ -300,6 +312,53 @@ types:
         items:
           type: Suggestion | nil
         required: false
+  PredictionOutput:
+    description: Predicted object representation for prediction.
+    type: object
+    properties:
+      customPredictionLabel:
+        description: .
+        type: string
+        required: false # TODO Hand-rolled W-9314597
+      predictionScore:
+        description: .
+        format: float
+        type: number
+        required: false # TODO Hand-rolled W-16235747
+      topPredictors:
+        description: .
+        type: array
+        items:
+          type: Predictor
+        required: false # TODO Hand-rolled W-16235747
+  PredictionOutputObject:
+    description: Prediction for a given record
+    type: object
+    properties:
+      errors:
+        description: .
+        type: array
+        items:
+          type: Error
+        required: false # TODO Hand-rolled W-16235747
+      isSuccess:
+        description: .
+        type: boolean | nil
+        required: true # TODO Hand-rolled W-16235747
+      predictionOutput:
+        description: .
+        type: array
+        items:
+          type: PredictionOutput
+        required: false # TODO Hand-rolled W-16235747
+      predictionWarning:
+        description: .
+        type: PredictionWarning
+        required: false # TODO Hand-rolled W-16235747
+      recordId:
+        description: .
+        type: string
+        required: true # TODO Hand-rolled W-16235747
   PredictionOutputRepresentation:
     description: Predictions for a given request
     type: object
@@ -397,7 +456,146 @@ types:
         description: Indicates whether the call succeeded or failed, and in case of
           failure also provides the reason.
         type: Status
+        required: true # TODO Hand-rolled W-16235747
+  PredictionRequestRepresentation:
+    description: Request for which predictions are fetched.
+    type: object
+    properties:
+      maxInsights:
+        description: .
+        type: integer
+        required: false # TODO Hand-rolled W-9314597
+      predictionModel:
+        description: .
+        type: string
+        required: false # TODO Hand-rolled W-16235747
+      predictionPlatform:
+        description: .
+        type: string
+        required: false # TODO Hand-rolled W-16235747
+      records:
+        type: WrappedList | nil
+        required: true # TODO Hand-rolled W-9314597
+      scoreFilterCriteria:
+        description: .
+        type: string
+        enum:
+          - GreaterThan
+          - GreaterThanEquals
+          - LessThan
+        required: false # TODO Hand-rolled W-9314597
+      scoringThreshold:
+        description: .
+        format: float
+        type: number
+        required: false # TODO Hand-rolled W-9314597
+      sortingOrder:
+        description: .
+        type: string
+        enum:
+          - Asc
+          - Desc
+        required: false # TODO Hand-rolled W-9314597
+      usecaseName:
+        description: .
+        type: string
+        required: true # TODO Hand-rolled W-16235747
+  PredictionResponseRepresentation:
+    description: Predictions for a given request
+    type: object
+    properties:
+      predictionModel:
+        description: .
+        type: string
+        required: false # TODO Hand-rolled W-9314597
+      predictionOutputObjects:
+        description: .
+        type: array
+        items:
+          type: PredictionOutputObject
+        required: false # TODO Hand-rolled W-9314597
+      predictionPlatform:
+        description: .
+        type: string
+        required: false # TODO Hand-rolled W-9314597
+      predictionType:
+        description: .
+        type: string
+        required: false # TODO Hand-rolled W-9314597
+      status:
+        description: .
+        type: Status
         required: true
+      usecaseName:
+        description: .
+        type: string
+        required: true # TODO Hand-rolled W-9314597
+  # TODO Hand-rolled W-16235747
+  PredictionRequestWrapperRepresentation:
+    description: Wrapper for PredictionRequestRepresentation.
+    type: object
+    properties:
+      predictionRequest:
+        description: oas body name.
+        type: PredictionRequestRepresentation
+
+  PredictionWarning:
+    description: Warning for a prediction of a particular record
+    type: object
+    properties:
+      missingFieldNames:
+        description: .
+        type: array
+        items:
+          type: string
+        required: false # TODO Hand-rolled W-16235747
+
+      outOfBoundFields:
+        description: .
+        type: array
+        items:
+          type: FieldCount
+        required: false # TODO Hand-rolled W-16235747
+
+  Predictor:
+    description: Predicted object representation for prediction
+    type: object
+    properties:
+      predictorFields:
+        description: .
+        type: array
+        items:
+          type: PredictorField
+        required: false # TODO Hand-rolled W-16235747
+      contributionValue:
+        description: .
+        format: float
+        type: number
+        required: false # TODO Hand-rolled W-16235747
+  PredictorField:
+    description: Field representation for predictor.
+    type: object
+    properties:
+      customText:
+        description: .
+        type: string
+        required: false # TODO Hand-rolled W-16235747
+      label:
+        description: .
+        type: string
+        required: false # TODO Hand-rolled W-16235747
+      name:
+        description: .
+        type: string
+        required: false # TODO Hand-rolled W-16235747
+      prescribedValue:
+        description: .
+        type: string
+        required: false # TODO Hand-rolled W-16235747
+      value:
+        description: .
+        type: string
+        required: false # TODO Hand-rolled W-16235747
   Prescription:
     description: .
     type: object
@@ -703,3 +901,19 @@ types:
             # TODO Hand-rolled W-10128739. Original type: RecommendationInputRepresentation
             type: RecommendationInputWrapperRepresentation
             (oas-body-name): recommendationInput
+    /v2/predictions:
+      post:
+        displayName: postAIPrediction
+        description: POST resource to fetch the predictions that need to be performed
+          at the store by the sales rep.
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: PredictionResponseRepresentation
+        body:
+          application/json:
+            # TODO Hand-rolled W-10128739. Original type: PredictionRequestRepresentation
+            type: PredictionRequestWrapperRepresentation
+            (oas-body-name): predictionRequest

package/src/raml/luvio.raml

@@ -18,7 +18,11 @@ types:
     (luvio.opaque): true
     (luvio.key):
       status: status.message
-
+  PredictionResponseRepresentation:
+    (luvio.ttl): 1000
+    (luvio.opaque): true
+    (luvio.key):
+      status: status.message
 /connect:
   /aiaccelerator:
     /predictions:
@@ -29,3 +33,7 @@ types:
       post:
         (luvio.adapter):
           name: fetchRecommendations
+    /v2/predictions:
+      post:
+        (luvio.adapter):
+          name: getPredictions