@salesforce/lds-adapters-sales-saleseinsteincoach 0.1.0-dev1

package/src/raml/api.raml

@@ -0,0 +1,247 @@
+#%RAML 1.0
+securedBy:
+  - OAuth2
+title: Salesforce Connect API
+version: '62.0'
+mediaType: application/json
+protocols:
+  - https
+baseUri: /services/data/v66.0
+securitySchemes:
+  OAuth2:
+    type: OAuth 2.0
+    settings:
+      authorizationUri: https://example.com/oauth/authorize
+      accessTokenUri: ''
+      authorizationGrants:
+        - implicit
+annotationTypes:
+  oas-readOnly:
+    type: boolean
+    allowedTargets: TypeDeclaration
+  oas-collectionFormat:
+    type: string
+  oas-body-name:
+    type: string
+    allowedTargets: TypeDeclaration
+types:
+  EtsConfigRepresentation:
+    description: The ETS configuration required to connect to the transcription service
+    type: object
+    properties:
+      appContext:
+        description: The app context for the ETS Configuration
+        type: string
+      tenantId:
+        description: The tenant Id for the ETS Configuration
+        type: string
+      uri:
+        description: The URI of the ETS Configuration
+        type: string
+  SalesEinsteinCoachConfigurationOutputRepresentation:
+    description: Directs UI to show a particular type of coaching moment and gives
+      configuration to connect to ETS along with instructions for LLM
+    type: object
+    properties:
+      coachingMomentType:
+        description: Type of coaching moment to show to user (SimulatedConversation
+          or StandAndDeliver)
+        type: string
+        enum:
+          - SimulatedConversation
+          - StandAndDeliver
+      etsConfig:
+        description: The ets configuration required to connect to the transcription
+          service
+        type: EtsConfigRepresentation
+      instructions:
+        description: The instructions for the co-pilot
+        type: string
+  SalesEinsteinCoachFeedbackInputRepresentation:
+    description: Input representation for the UI to submit a transcript to get AI
+      feedback.
+    type: object
+    properties:
+      recordId:
+        description: Id of the record that the feedback is for
+        type: string
+      scenario:
+        description: Coaching moment scenario
+        type: string
+        enum:
+          - Discovery
+          - Negotiation
+          - Proposal
+          - Qualification
+      transcript:
+        description: Transcript of the call
+        type: array
+        items:
+          type: object
+          properties:
+            //:
+              type: any
+  SalesEinsteinCoachFeedbackOutputRepresentation:
+    description: Feedback given by AI on the transcript of a call
+    type: object
+    properties:
+      feedback:
+        description: The feedback from the LLM for the transcript of the call
+        type: string
+      generationId:
+        description: The generation ID for the feedback received from LLM
+        type: string
+  SalesEinsteinCoachRolePlayInputRepresentation:
+    description: Input representation to talk back and forth with an AI modal
+    type: object
+    properties:
+      replyId:
+        description: Reply Id of the previous response from LLM
+        type: string
+      sequenceId:
+        description: Sequence id required by co-pilot
+        type: string
+      transcript:
+        description: The transcript of the conversation up to this point in time
+        type: string
+      scenario:
+        description: The coaching moment scenario for the session
+        type: string
+        enum:
+          - Discovery
+          - Negotiation
+          - Proposal
+          - Qualification
+  SalesEinsteinCoachRolePlayOutputRepresentation:
+    description: Reply given by AI on a back and forth conversation with user
+    type: object
+    properties:
+      reply:
+        description: The reply from the co-pilot
+        type: string
+      replyAudio:
+        description: The audio string returned by speech synthesizer
+        type: string | nil
+      replyId:
+        description: The reply ID for the co-pilot interaction
+        type: string
+      sequenceId:
+        description: The sequence ID for the co-pilot interaction
+        type: string
+  SalesEinsteinCoachRolePlaySessionInputRepresentation:
+    description: Input representation to start a session with einstein copilot for
+      role play
+    type: object
+    properties:
+      recordId:
+        description: The id of the record the session is based on
+        type: string
+      scenario:
+        description: The coaching moment scenario for the session
+        type: string
+        enum:
+          - Discovery
+          - Negotiation
+          - Proposal
+          - Qualification
+  SalesEinsteinCoachRolePlaySessionOutputRepresentation:
+    description: This resource is used to create a new session with co-pilot for role
+      play
+    type: object
+    properties:
+      sessionId:
+        description: The id of the session created with co-pilot for role play
+        type: string
+/sales-einstein-coach/practice:
+  /configuration:
+    get:
+      displayName: getSalesEinsteinCoachConfiguration
+      description: Returns the configuration for ETS and the instructions for LLM
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: SalesEinsteinCoachConfigurationOutputRepresentation
+      queryParameters:
+        scenario:
+          type: string
+          required: true
+          enum:
+            - Discovery
+            - Negotiation
+            - Proposal
+            - Qualification
+  /feedback:
+    post:
+      displayName: postSalesEinsteinCoachFeedback
+      description: Return the AI feedback on the given transcript
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: SalesEinsteinCoachFeedbackOutputRepresentation
+      body:
+        application/json:
+          type: SalesEinsteinCoachFeedbackInputRepresentation
+          #required: false
+          (oas-body-name): SalesEinsteinCoachFeedbackInputRepresentation
+  /roleplay:
+    delete:
+      displayName: deleteSalesEinsteinCoachRolePlay
+      description: Deletes the session created with co-pilot for conversation
+      responses:
+        '200':
+          description: Success
+      queryParameters:
+        sessionId:
+          type: string
+          required: false
+    get:
+      displayName: getSalesEinsteinCoachRolePlay
+      description: Return the sessionId of the session created with co-pilot for this
+        conversation
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: SalesEinsteinCoachRolePlaySessionOutputRepresentation
+      queryParameters:
+        sessionId:
+          type: string
+          required: false
+    post:
+      displayName: postSalesEinsteinCoachRolePlay
+      description: Returns the response from co-pilot for the conversation
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: SalesEinsteinCoachRolePlayOutputRepresentation
+      queryParameters:
+        sessionId:
+          type: string
+          required: false
+      body:
+        application/json:
+          type: SalesEinsteinCoachRolePlayInputRepresentation
+          #required: false
+          (oas-body-name): SalesEinsteinCoachRolePlayInputRepresentation
+  /roleplay/start:
+    post:
+      displayName: postSalesEinsteinCoachRolePlaySession
+      description: Return the id of the new session created with co-pilot
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: SalesEinsteinCoachRolePlaySessionOutputRepresentation
+      body:
+        application/json:
+          type: SalesEinsteinCoachRolePlaySessionInputRepresentation
+          #required: false
+          (oas-body-name): SalesEinsteinCoachRolePlaySessionInputRepresentation

package/src/raml/luvio.raml

@@ -0,0 +1,50 @@
+#%RAML 1.0 Overlay
+extends: ./api.raml
+
+uses:
+  luvio: luvio://annotations.raml
+
+(luvio.keyPrefix): 'SalesEinsteinCoach'
+(luvio.ttl): 15000
+
+types:
+  SalesEinsteinCoachConfigurationOutputRepresentation:
+    (luvio.ttl): 600000 # 10 minutes
+  SalesEinsteinCoachFeedbackOutputRepresentation:
+    (luvio.ttl): 15000
+    (luvio.key):
+      generation_id: generationId
+  SalesEinsteinCoachRolePlayOutputRepresentation:
+    (luvio.ttl): 15000
+    (luvio.key):
+      reply_id: replyId
+  SalesEinsteinCoachRolePlaySessionOutputRepresentation:
+    (luvio.ttl): 15000
+    (luvio.key):
+      session_id: sessionId
+
+/sales-einstein-coach/practice:
+  /configuration:
+    get:
+      (luvio.adapter):
+        name: getSalesEinsteinCoachConfiguration
+  /feedback:
+    post:
+      (luvio.adapter):
+        name: submitForFeedback
+  /roleplay:
+    delete:
+      (luvio.adapter):
+        name: deleteRolePlaySession
+      (luvio.key):
+        session_id: queryParams.sessionId || ''
+    get:
+      (luvio.key):
+        session_id: queryParams.sessionId || ''
+    post:
+      (luvio.adapter):
+        name: submitForRolePlay
+  /roleplay/start:
+    post:
+      (luvio.adapter):
+        name: startRolePlaySession