@salesforce/lds-adapters-service-einstein-copilot-bot 1.266.0-dev17 → 1.266.0-dev18

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
@@ -56,12 +56,24 @@ types:
56
56
  description: Message ID that this message is replying to
57
57
  type: string
58
58
  required: false
59
+ intent:
60
+ description: Intent
61
+ type: string
62
+ required: false
59
63
  messageType:
60
64
  description: Message type
61
65
  type: string
62
66
  required: false
63
67
  enum:
64
68
  - Reply
69
+ planId:
70
+ description: PlanId
71
+ type: string
72
+ required: false
73
+ planTemplateVariables:
74
+ description: Additional Plan Templates Variables
75
+ type: any
76
+ required: false
65
77
  reply:
66
78
  description: Reply
67
79
  type: array
@@ -79,8 +91,13 @@ types:
79
91
  enum:
80
92
  - Cancel
81
93
  - EsMessage
94
+ - PlanTemplate
82
95
  - SetVariables
83
96
  - Text
97
+ userUtterance:
98
+ description: UserUtterance
99
+ type: string
100
+ required: false
84
101
  variables:
85
102
  description: Variables
86
103
  type: array
@@ -230,6 +247,48 @@ types:
230
247
  value:
231
248
  description: Value of the variable
232
249
  type: string
250
+ required: false
251
+ PlanTemplateRepresentation:
252
+ description: Represents a plan template which can be executed by a Copilot client.
253
+ type: object
254
+ properties:
255
+ intent:
256
+ description: Intent used by Planner when executing this plan template.
257
+ type: string
258
+ label:
259
+ description: Label to display when rendering this plan template in a Copilot
260
+ client.
261
+ type: string
262
+ planTemplateId:
263
+ description: ID of a plan template.
264
+ type: string
265
+ userUtterance:
266
+ description: User utterance to be recorded in conversation history by Planner
267
+ when executing this plan template.
268
+ type: string
269
+ variables:
270
+ description: Variables for executing this plan template.
271
+ type: object
272
+ properties:
273
+ //:
274
+ type: string
275
+ RecommendedPlanTemplatesRepresentation:
276
+ description: Represents the result of a get recommended plan templates request.
277
+ type: object
278
+ properties:
279
+ errorMessage:
280
+ description: Error message for the failed get operation.
281
+ type: string
282
+ required: false
283
+ isSuccess:
284
+ description: Success indicator of the get operation.
285
+ type: boolean
286
+ planTemplates:
287
+ description: Recommended plan templates.
288
+ type: array
289
+ items:
290
+ type: PlanTemplateRepresentation
291
+
233
292
  /connect:
234
293
  /conversation-runtime-proxy:
235
294
  get:
@@ -267,3 +326,20 @@ types:
267
326
  application/json:
268
327
  type: ConversationRuntimeProxyInputRepresentation
269
328
  (oas-body-name): postBody
329
+ /recommended-plan-templates/{pageType}/{objectType}:
330
+ get:
331
+ displayName: getRecommendedPlanTemplates
332
+ description: Gets a list of recommended plan templates based on the page/app
333
+ responses:
334
+ '200':
335
+ description: Success
336
+ body:
337
+ application/json:
338
+ type: RecommendedPlanTemplatesRepresentation
339
+ uriParameters:
340
+ pageType:
341
+ type: string
342
+ required: true
343
+ objectType:
344
+ type: string
345
+ required: true
@@ -25,6 +25,10 @@ types:
25
25
  (luvio.ttl): 30000
26
26
  VariableRepresentation:
27
27
  (luvio.ttl): 30000
28
+ PlanTemplateRepresentation:
29
+ (luvio.ttl): 900000
30
+ RecommendedPlanTemplatesRepresentation:
31
+ (luvio.ttl): 900000
28
32
 
29
33
  /connect:
30
34
  /conversation-runtime-proxy:
@@ -34,3 +38,7 @@ types:
34
38
  post:
35
39
  (luvio.adapter):
36
40
  name: sendMessage
41
+ /recommended-plan-templates/{pageType}/{objectType}:
42
+ get:
43
+ (luvio.adapter):
44
+ name: getRecommendedPlanTemplates