@salesforce/lds-adapters-service-einstein-copilot-bot 1.316.0 → 1.317.0

package/src/raml/api.raml

@@ -491,6 +491,48 @@ types:
         description: Error message for the failed get operation
         type: string
         required: false
+  RecommendedUtterancesRepresentation:
+    description: Represents the result of a get recommended utterances request.
+    type: object
+    properties:
+      utterances:
+        description: Recommended utterances.
+        type: array
+        items:
+          type: string
+      isSuccess:
+        description: Success indicator of the get operation.
+        type: boolean
+      errorMessage:
+        description: Error message for the failed get operation
+        type: string
+        required: false
+  WelcomeTopicSuggestedUtterancesRepresentation:
+    description: A single topic and utterances suggested for that topic.
+    properties:
+      topicApiName:
+        type: string
+        description: The API Name of the Topic
+      utterances:
+        type: array
+        items:
+          type: string
+  WelcomeUtterancesRepresentation:
+    description: Represents the result of a get welcome-utterances request.
+    type: object
+    properties:
+      topicsAndSuggestedUtterances:
+        description: List of topics and their corresponding suggested utterances.
+        type: array
+        items:
+          type: WelcomeTopicSuggestedUtterancesRepresentation
+      isSuccess:
+        description: Success indicator of the get operation.
+        type: boolean
+      errorMessage:
+        description: Error message for the failed get operation
+        type: string
+        required: false
   EsTypeMessageRepresentation:
     description: Represents a ES type message
     type: object
@@ -571,6 +613,11 @@ types:
           body:
             application/json:
               type: CopilotBotInfoRepresentation
+      queryParameters:
+        agentType:
+          description: agent type of the bot
+          type: string
+          required: false
     post:
       displayName: sendMessage
       description: Send messages to the chatbot runtime.
@@ -661,6 +708,20 @@ types:
         application/json:
           type: FollowUpActionsListInputRepresentation
           (oas-body-name): postBody
+  /recommended-utterances:
+    get:
+      displayName: getRecommendedUtterances
+      description: Provide a list of recommended utterances based on the criteria passed in.
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: RecommendedUtterancesRepresentation
+      queryParameters:
+        sessionId:
+          type: string
+          required: true
   /recommended-actions:
     get:
       displayName: getRecommendedActions
@@ -697,3 +758,17 @@ types:
             - Large
             - Medium
             - Small
+  /welcome-utterances:
+    get:
+      displayName: getWelcomeUtterances
+      description: Provides a list of recommended utterances for users to try out copilot capabilities from the welcome screen.
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: WelcomeUtterancesRepresentation
+      queryParameters:
+        sessionId:
+          type: string
+          required: false

package/src/raml/luvio.raml

@@ -37,10 +37,14 @@ types:
     (luvio.ttl): 900000
   RecommendedActionsRepresentation:
     (luvio.ttl): 900000
+  RecommendedUtterancesRepresentation:
+    (luvio.ttl): 900000
   CopilotFollowUpActionsRepresentation:
     (luvio.ttl): 900000
   CopilotObjectListRepresentation:
     (luvio.ttl): 900000
+  WelcomeUtterancesRepresentation:
+    (luvio.ttl): 30000
 
 /connect:
   /conversation-runtime-proxy:
@@ -63,6 +67,14 @@ types:
     get:
       (luvio.adapter):
         name: getRecommendedActions
+  /recommended-utterances:
+    get:
+      (luvio.adapter):
+        name: getRecommendedUtterances
+  /welcome-utterances:
+    get:
+      (luvio.adapter):
+        name: getWelcomeUtterances
   /copilot:
     /feedback:
       post: