@salesforce/lds-adapters-service-einstein-copilot-bot 1.266.0-dev2 → 1.266.0-dev21

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
@@ -32,6 +32,11 @@ types:
32
32
  data:
33
33
  description: Data for the collect message.
34
34
  type: EsTypeMessageRepresentation
35
+ required: false
36
+ targetProperty:
37
+ description: Target property for the collect message.
38
+ type: string | nil
39
+ required: false
35
40
  targetType:
36
41
  description: Target type for the collect message.
37
42
  type: string
@@ -49,12 +54,28 @@ types:
49
54
  description: Bot conversation input
50
55
  type: object
51
56
  properties:
57
+ inReplyToMessageId:
58
+ description: Message ID that this message is replying to
59
+ type: string
60
+ required: false
61
+ intent:
62
+ description: Intent
63
+ type: string
64
+ required: false
52
65
  messageType:
53
66
  description: Message type
54
67
  type: string
55
68
  required: false
56
69
  enum:
57
70
  - Reply
71
+ planId:
72
+ description: PlanId
73
+ type: string
74
+ required: false
75
+ planTemplateVariables:
76
+ description: Additional Plan Templates Variables
77
+ type: any
78
+ required: false
58
79
  reply:
59
80
  description: Reply
60
81
  type: array
@@ -72,8 +93,13 @@ types:
72
93
  enum:
73
94
  - Cancel
74
95
  - EsMessage
96
+ - PlanTemplate
75
97
  - SetVariables
76
98
  - Text
99
+ userUtterance:
100
+ description: UserUtterance
101
+ type: string
102
+ required: false
77
103
  variables:
78
104
  description: Variables
79
105
  type: array
@@ -112,6 +138,10 @@ types:
112
138
  description: The failure code for a Failure message.
113
139
  type: string | nil
114
140
  required: false
141
+ feedbackId:
142
+ description: Feedback ID for this generated message.
143
+ type: string | nil
144
+ required: false
115
145
  id:
116
146
  description: Unique id of this message
117
147
  type: string
@@ -123,6 +153,10 @@ types:
123
153
  description: The message type for an ES Type message.
124
154
  type: string | nil
125
155
  required: false
156
+ planId:
157
+ description: Plan ID for the generated plan.
158
+ type: string | nil
159
+ required: false
126
160
  result:
127
161
  description: The result response for an Inform message.
128
162
  type: array
@@ -198,6 +232,10 @@ types:
198
232
  description: Represents a ES type message
199
233
  type: object
200
234
  properties:
235
+ property:
236
+ description: Property for the ES type message.
237
+ type: string | nil
238
+ required: false
201
239
  type:
202
240
  description: Type for the ES type message.
203
241
  type: string
@@ -214,6 +252,48 @@ types:
214
252
  value:
215
253
  description: Value of the variable
216
254
  type: string
255
+ required: false
256
+ PlanTemplateRepresentation:
257
+ description: Represents a plan template which can be executed by a Copilot client.
258
+ type: object
259
+ properties:
260
+ intent:
261
+ description: Intent used by Planner when executing this plan template.
262
+ type: string
263
+ label:
264
+ description: Label to display when rendering this plan template in a Copilot
265
+ client.
266
+ type: string
267
+ planTemplateId:
268
+ description: ID of a plan template.
269
+ type: string
270
+ userUtterance:
271
+ description: User utterance to be recorded in conversation history by Planner
272
+ when executing this plan template.
273
+ type: string
274
+ variables:
275
+ description: Variables for executing this plan template.
276
+ type: object
277
+ properties:
278
+ //:
279
+ type: string
280
+ RecommendedPlanTemplatesRepresentation:
281
+ description: Represents the result of a get recommended plan templates request.
282
+ type: object
283
+ properties:
284
+ errorMessage:
285
+ description: Error message for the failed get operation.
286
+ type: string
287
+ required: false
288
+ isSuccess:
289
+ description: Success indicator of the get operation.
290
+ type: boolean
291
+ planTemplates:
292
+ description: Recommended plan templates.
293
+ type: array
294
+ items:
295
+ type: PlanTemplateRepresentation
296
+
217
297
  /connect:
218
298
  /conversation-runtime-proxy:
219
299
  get:
@@ -251,3 +331,20 @@ types:
251
331
  application/json:
252
332
  type: ConversationRuntimeProxyInputRepresentation
253
333
  (oas-body-name): postBody
334
+ /recommended-plan-templates/{pageType}/{objectType}:
335
+ get:
336
+ displayName: getRecommendedPlanTemplates
337
+ description: Gets a list of recommended plan templates based on the page/app
338
+ responses:
339
+ '200':
340
+ description: Success
341
+ body:
342
+ application/json:
343
+ type: RecommendedPlanTemplatesRepresentation
344
+ uriParameters:
345
+ pageType:
346
+ type: string
347
+ required: true
348
+ objectType:
349
+ type: string
350
+ 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