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

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
@@ -145,6 +145,10 @@ types:
145
145
  id:
146
146
  description: Unique id of this message
147
147
  type: string
148
+ isContentSafe:
149
+ description: Boolean flag to indicate safety score.
150
+ type: boolean | nil
151
+ required: false
148
152
  message:
149
153
  description: The message for an ES Type message.
150
154
  type: string | nil
@@ -228,6 +232,89 @@ types:
228
232
  isSuccess:
229
233
  description: Success indicator of the get operation.
230
234
  type: boolean
235
+ CopilotQuickActionRepresentation:
236
+ description: Represents a Copilot QuickAction which can be executed by a Copilot client.
237
+ type: object
238
+ properties:
239
+ type:
240
+ description: Type of Copilot QuickAction.
241
+ type: string
242
+ required: false
243
+ label:
244
+ description: Label to display when rendering Copilot QuickAction.
245
+ type: string
246
+ required: false
247
+ icon:
248
+ description: Icon name for the Recommended Action to be used by the client when rendering the QuickAction in the UI.
249
+ type: string
250
+ required: false
251
+ description:
252
+ description: Description of Copilot QuickAction.
253
+ type: string
254
+ required: false
255
+ planTemplateId:
256
+ description: Plan TemplateId associated to the Copilot QuickAction.
257
+ type: string
258
+ required: false
259
+ intent:
260
+ description: Intent associated to the Copilot QuickAction which is used by the planner.
261
+ type: string
262
+ required: false
263
+ userUtterance:
264
+ description: User utterance to be recorded in conversation history by Planner when executing this Copilot Quick Action.
265
+ type: string
266
+ required: false
267
+ actionApiName:
268
+ description: Api name of Copilot QuickAction.
269
+ type: string
270
+ required: false
271
+ createdDate:
272
+ description: Creation date of Copilot QuickAction.
273
+ type: string
274
+ required: false
275
+ lastModifiedDate:
276
+ description: Last Modified date of Copilot QuickAction
277
+ type: string
278
+ required: false
279
+ isGlobal:
280
+ description: Is the copilot QuickAction global or not.
281
+ type: boolean
282
+ required: false
283
+ planTemplateInput:
284
+ description: Input Variables for executing this plan template.
285
+ type: object
286
+ required: false
287
+ properties:
288
+ //:
289
+ type: string
290
+ isStandard:
291
+ description: Is the Copilot QuickAction a standard Action.
292
+ type: boolean
293
+ required: false
294
+ orgAccess:
295
+ description: Level of Org access required for this QuickAction to be visible for the org.
296
+ type: string
297
+ required: false
298
+ namespace:
299
+ description: Namespace of the Copilot QuickAction
300
+ type: string
301
+ required: false
302
+ RecommendedActionsRepresentation:
303
+ description: Represents the result of a get recommended actions request.
304
+ type: object
305
+ properties:
306
+ copilotQuickActions:
307
+ description: Recommended copilot Quick Actions.
308
+ type: array
309
+ items:
310
+ type: CopilotQuickActionRepresentation
311
+ isSuccess:
312
+ description: Success indicator of the get operation.
313
+ type: boolean
314
+ errorMessage:
315
+ description: Error message for the failed get operation
316
+ type: string
317
+ required: false
231
318
  EsTypeMessageRepresentation:
232
319
  description: Represents a ES type message
233
320
  type: object
@@ -348,3 +435,39 @@ types:
348
435
  objectType:
349
436
  type: string
350
437
  required: true
438
+ /recommended-actions:
439
+ get:
440
+ displayName: getRecommendedActions
441
+ description: Provides a list of recommended actions based on the criteria passed in.
442
+ responses:
443
+ '200':
444
+ description: Success
445
+ body:
446
+ application/json:
447
+ type: RecommendedActionsRepresentation
448
+ queryParameters:
449
+ pageName:
450
+ type: string
451
+ required: false
452
+ pageType:
453
+ type: string
454
+ required: false
455
+ actionName:
456
+ type: string
457
+ required: false
458
+ objectApiName:
459
+ type: string
460
+ required: false
461
+ customApplicationName:
462
+ type: string
463
+ required: false
464
+ sessionId:
465
+ type: string
466
+ required: false
467
+ formFactor:
468
+ type: string
469
+ required: false
470
+ enum:
471
+ - Large
472
+ - Medium
473
+ - Small
@@ -29,6 +29,10 @@ types:
29
29
  (luvio.ttl): 900000
30
30
  RecommendedPlanTemplatesRepresentation:
31
31
  (luvio.ttl): 900000
32
+ CopilotQuickActionRepresentation:
33
+ (luvio.ttl): 900000
34
+ RecommendedActionsRepresentation:
35
+ (luvio.ttl): 900000
32
36
 
33
37
  /connect:
34
38
  /conversation-runtime-proxy:
@@ -42,3 +46,7 @@ types:
42
46
  get:
43
47
  (luvio.adapter):
44
48
  name: getRecommendedPlanTemplates
49
+ /recommended-actions:
50
+ get:
51
+ (luvio.adapter):
52
+ name: getRecommendedActions