@salesforce/lds-adapters-service-einstein-copilot-bot 1.309.0-dev15 → 1.309.0-dev16

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/src/raml/api.raml CHANGED
@@ -488,6 +488,48 @@ types:
488
488
  description: Error message for the failed get operation
489
489
  type: string
490
490
  required: false
491
+ RecommendedUtterancesRepresentation:
492
+ description: Represents the result of a get recommended utterances request.
493
+ type: object
494
+ properties:
495
+ utterances:
496
+ description: Recommended utterances.
497
+ type: array
498
+ items:
499
+ type: string
500
+ isSuccess:
501
+ description: Success indicator of the get operation.
502
+ type: boolean
503
+ errorMessage:
504
+ description: Error message for the failed get operation
505
+ type: string
506
+ required: false
507
+ WelcomeTopicSuggestedUtterancesRepresentation:
508
+ description: A single topic and utterances suggested for that topic.
509
+ properties:
510
+ topicApiName:
511
+ type: string
512
+ description: The API Name of the Topic
513
+ utterances:
514
+ type: array
515
+ items:
516
+ type: string
517
+ WelcomeUtterancesRepresentation:
518
+ description: Represents the result of a get welcome-utterances request.
519
+ type: object
520
+ properties:
521
+ topicsAndSuggestedUtterances:
522
+ description: List of topics and their corresponding suggested utterances.
523
+ type: array
524
+ items:
525
+ type: WelcomeTopicSuggestedUtterancesRepresentation
526
+ isSuccess:
527
+ description: Success indicator of the get operation.
528
+ type: boolean
529
+ errorMessage:
530
+ description: Error message for the failed get operation
531
+ type: string
532
+ required: false
491
533
  EsTypeMessageRepresentation:
492
534
  description: Represents a ES type message
493
535
  type: object
@@ -658,6 +700,20 @@ types:
658
700
  application/json:
659
701
  type: FollowUpActionsListInputRepresentation
660
702
  (oas-body-name): postBody
703
+ /recommended-utterances:
704
+ get:
705
+ displayName: getRecommendedUtterances
706
+ description: Provide a list of recommended utterances based on the criteria passed in.
707
+ responses:
708
+ '200':
709
+ description: Success
710
+ body:
711
+ application/json:
712
+ type: RecommendedUtterancesRepresentation
713
+ queryParameters:
714
+ sessionId:
715
+ type: string
716
+ required: true
661
717
  /recommended-actions:
662
718
  get:
663
719
  displayName: getRecommendedActions
@@ -694,3 +750,17 @@ types:
694
750
  - Large
695
751
  - Medium
696
752
  - Small
753
+ /welcome-utterances:
754
+ get:
755
+ displayName: getWelcomeUtterances
756
+ description: Provides a list of recommended utterances for users to try out copilot capabilities from the welcome screen.
757
+ responses:
758
+ '200':
759
+ description: Success
760
+ body:
761
+ application/json:
762
+ type: WelcomeUtterancesRepresentation
763
+ queryParameters:
764
+ sessionId:
765
+ type: string
766
+ required: false
@@ -37,10 +37,14 @@ types:
37
37
  (luvio.ttl): 900000
38
38
  RecommendedActionsRepresentation:
39
39
  (luvio.ttl): 900000
40
+ RecommendedUtterancesRepresentation:
41
+ (luvio.ttl): 100
40
42
  CopilotFollowUpActionsRepresentation:
41
43
  (luvio.ttl): 900000
42
44
  CopilotObjectListRepresentation:
43
45
  (luvio.ttl): 900000
46
+ WelcomeUtterancesRepresentation:
47
+ (luvio.ttl): 30000
44
48
 
45
49
  /connect:
46
50
  /conversation-runtime-proxy:
@@ -63,6 +67,14 @@ types:
63
67
  get:
64
68
  (luvio.adapter):
65
69
  name: getRecommendedActions
70
+ /recommended-utterances:
71
+ get:
72
+ (luvio.adapter):
73
+ name: getRecommendedUtterances
74
+ /welcome-utterances:
75
+ get:
76
+ (luvio.adapter):
77
+ name: getWelcomeUtterances
66
78
  /copilot:
67
79
  /feedback:
68
80
  post: