@salesforce/lds-adapters-platform-learning-content 1.273.1 → 1.275.0

package/src/raml/api.raml

@@ -25,6 +25,86 @@ annotationTypes:
     type: string
     allowedTargets: TypeDeclaration
 types:
+  AbstractCoachingAIFeedbackSectionRepresentation:
+    description: Abstract coaching AI feedback section representation
+    discriminator: feedbackSectionTitle
+    type: object
+    properties:
+      feedbackSectionTitle:
+        description: Title for the feedback section
+        type: string
+  CoachingAICallSubmissionInputRepresentation:
+    description: Input representation for submitting the call
+    type: object
+    properties:
+      callId:
+        description: Call Id that user has selected for getting the coaching AI feedback.
+        type: string
+      learningItemId:
+        description: LearningItemId that is associated to the coaching AI
+        type: string
+  CoachingAICallSubmissionOutputRepresentation:
+    description: This representation defined the coaching AI feedback for a submitted
+      call with the generation ID
+    type: object
+    properties:
+      coachingAIFeedback:
+        description: Coaching AI feedback for submitted call
+        type: CoachingAIFeedbackRepresentation
+      generationId:
+        description: Generation ID for the coaching AI feedback
+        type: string
+  CoachingAICriteriaBasedFeedbackRepresentation:
+    description: This representation defines the fields for criteria based feedback.
+    type: object
+    properties:
+      criteriaName:
+        description: Name of the criteria
+        type: string
+      criteriaScore:
+        description: Score for the criteria
+        format: double
+        type: number
+  CoachingAIFeedbackRepresentation:
+    description: This representation defines the coaching AI feedback
+    type: object
+    properties:
+      additionalFeedback:
+        description: List of additional feedback sections
+        type: array
+        items:
+          type: any #TODO Hand-rolled W-8334626, Originally AbstractCoachingAIFeedbackSectionRepresentation
+      conversationSummaryId:
+        description: Conversation Summary ID for the coaching AI feedback
+        type: string
+      criteriaBasedScores:
+        description: List of criteria based scores
+        type: array
+        items:
+          type: CoachingAICriteriaBasedFeedbackRepresentation
+      score:
+        description: The overall score
+        format: double
+        type: number
+  CoachingAIFeedbackSectionStringCollectionRepresentation:
+    description: This representation defines the fields for additional feedback section
+      items with the list of strings.
+    discriminatorValue: StringCollectionSection
+    type: AbstractCoachingAIFeedbackSectionRepresentation
+    properties:
+      feedbackSectionItems:
+        description: List of strings for the additional feedback section items
+        type: array
+        items:
+          type: string
+  CoachingAIFeedbackSectionTextRepresentation:
+    description: This representation defines the fields for additional feedback.
+    discriminatorValue: TextSection
+    type: AbstractCoachingAIFeedbackSectionRepresentation
+    properties:
+      feedbackSectionItem:
+        description: Text for the additional feedback section
+        type: string
   EvaluateLearningItemInputWrapperRepresentation: # TODO Hand-rolled W-8334626
     description: Wrapper for evaluate learning item input representation
     type: object
@@ -577,6 +657,37 @@ types:
         description: Represents the trusted frame origin used in iframe messaging.
         type: string
 /learning-content-platform:
+  /coaching:
+    /ai-feedback:
+      post:
+        displayName: postCoachingAICallSubmission
+        description: Return the coaching AI feedback for teh submitted call
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: CoachingAICallSubmissionOutputRepresentation
+        body:
+          application/json:
+            type: CoachingAICallSubmissionInputRepresentation
+            (oas-body-name): coachingAICallSubmissionInputRepresentation
+    /{learningItemSubmissionId}/ai-feedback:
+      get:
+        displayName: getCoachingAIFeedback
+        description:
+          Returns a Coaching AI Feedback to the user based on the LearningItemSubmissionId
+          passed
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: CoachingAIFeedbackRepresentation
+      uriParameters:
+        learningItemSubmissionId:
+          type: string
+          required: true
   /featured-item:
     /list/recommended:
       get:
@@ -612,6 +723,10 @@ types:
           pageRef:
             type: string
             required: true
+          returnMax:
+            type: boolean
+            required: false
+            default: false
   /learning:
     /config:
       get:

package/src/raml/luvio.raml

@@ -51,8 +51,21 @@ types:
     (luvio.ttl): 21600000 # 15 seconds
     (luvio.key):
       relatedId: relatedId
+  CoachingAICallSubmissionOutputRepresentation:
+    (luvio.ttl): 15000 # 15 seconds
+    (luvio.key):
+      generation_id: generationId
 
 /learning-content-platform:
+  /coaching:
+    /ai-feedback:
+      post:
+        (luvio.adapter):
+          name: submitForCoachingAIFeedback
+    /{learningItemSubmissionId}/ai-feedback:
+      get:
+        (luvio.adapter):
+          name: getCoachingAIFeedback
   /featured-item:
     /list/related:
       get: