@salesforce/lds-adapters-service-einstein-copilot-bot 1.287.0-dev13 → 1.287.0-dev15

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
@@ -228,6 +228,21 @@ types:
228
228
  isSuccess:
229
229
  description: Success indicator of the get operation.
230
230
  type: boolean
231
+ CopilotFollowUpActionsRepresentation:
232
+ description: Copilot FollowUp Actions resource output
233
+ type: object
234
+ properties:
235
+ actions:
236
+ description: list of actions. position in this list matches position of query in input FollowUpActionsListInputRepresentation. nil unless isSuccess = true.
237
+ type: array
238
+ items: FollowUpActionsRepresentation
239
+ isSuccess:
240
+ type: boolean
241
+ description: indicates success or failure
242
+ errorMessage:
243
+ type: string
244
+ required: false
245
+ description: optional error message. present only if isSuccess = false.
231
246
  CopilotLLMFeedbackInputRepresentation:
232
247
  description: Copilot LLM feedback input
233
248
  type: object
@@ -327,6 +342,101 @@ types:
327
342
  description: Namespace of the Copilot QuickAction
328
343
  type: string
329
344
  required: false
345
+ FollowUpActionsRepresentation:
346
+ description: basic output item type of /connect/follow-up-actions endpoint
347
+ type: object
348
+ properties:
349
+ actions:
350
+ type: any
351
+ blockRenderers:
352
+ type: any
353
+ FollowUpActionsListInputRepresentation:
354
+ description: top-level input type to FollowUp Actions endpoint
355
+ type: object
356
+ properties:
357
+ language:
358
+ required: false
359
+ type: string
360
+ description: human language to localize to
361
+ followUpActionsInputs:
362
+ required: true
363
+ type: array
364
+ items: FollowUpActionsInputRepresentation
365
+ description: list of queries for actions
366
+ FollowUpActionsInputRepresentation:
367
+ description: a query to EM getType for follow-up actions
368
+ type: object
369
+ properties:
370
+ descriptor:
371
+ type: string
372
+ required: true
373
+ description: query descriptor for EM getType call
374
+ sourceDescriptor:
375
+ type: FollowUpActionsSourceDescriptorRepresentation
376
+ required: false
377
+ description: similar to ExperienceModelSourceDescriptorRepresentation
378
+ schemaConfig:
379
+ type: FollowUpActionsSchemaConfigRepresentation
380
+ required: false
381
+ description: similar to ExperienceModelSchemaConfigRepresentation
382
+ designConfig:
383
+ type: FollowUpActionsDesignConfigRepresentation
384
+ required: false
385
+ description: mutually exclusive with renditionConfig. only one can be present and one or the other must be present. similar to ExperienceModelDesignConfigRepresentation.
386
+ renditionConfig:
387
+ type: FollowUpActionsRenditionConfigRepresentation
388
+ required: false
389
+ description: mutually exclusive with designConfig. only one can be present and one or the other must be present. similar to ExperienceModelRenditionConfigRepresentation.
390
+ FollowUpActionsFilterConfigRepresentation:
391
+ description: similar to ExperienceModelFilterConfigRepresentation.
392
+ type: object
393
+ properties:
394
+ propertyNames:
395
+ type: array
396
+ required: false
397
+ items: string
398
+ description: list of fields
399
+ FollowUpActionsSchemaConfigRepresentation:
400
+ description: similar to ExperienceModelSchemaConfig
401
+ type: object
402
+ properties:
403
+ subSchemaDefinitions:
404
+ type: boolean
405
+ required: false
406
+ description: whether to include sub-schema definitions or not
407
+ filterConfig:
408
+ type: FollowUpActionsFilterConfigRepresentation
409
+ required: false
410
+ FollowUpActionsSourceDescriptorRepresentation:
411
+ description: similar to ExperienceModelSourceDescriptorRepresentation
412
+ type: object
413
+ properties:
414
+ descriptor:
415
+ type: string
416
+ required: false
417
+ propertyName:
418
+ type: string
419
+ required: false
420
+ FollowUpActionsDesignConfigRepresentation:
421
+ description: similar to ExperienceModelDesignConfigRendition
422
+ type: object
423
+ properties:
424
+ target:
425
+ type: string
426
+ required: false
427
+ subViewDefinitions:
428
+ type: boolean
429
+ required: false
430
+ FollowUpActionsRenditionConfigRepresentation:
431
+ description: similar to ExperienceModelRenditiionConfigRendition
432
+ type: object
433
+ properties:
434
+ target:
435
+ type: string
436
+ required: false
437
+ subViewDefinitions:
438
+ type: boolean
439
+ required: false
330
440
  RecommendedActionsRepresentation:
331
441
  description: Represents the result of a get recommended actions request.
332
442
  type: object
@@ -480,6 +590,20 @@ types:
480
590
  application/json:
481
591
  type: CopilotLLMFeedbackInputRepresentation
482
592
  (oas-body-name): submitFeedback
593
+ /follow-up-actions:
594
+ post:
595
+ displayName: getFollowUpActions
596
+ description: Provides a list of FollowUp Actions based on the EM getType() calls for criteria passed in.
597
+ responses:
598
+ '200':
599
+ description: Success
600
+ body:
601
+ application/json:
602
+ type: CopilotFollowUpActionsRepresentation
603
+ body:
604
+ application/json:
605
+ type: FollowUpActionsListInputRepresentation
606
+ (oas-body-name): postBody
483
607
  /recommended-actions:
484
608
  get:
485
609
  displayName: getRecommendedActions
@@ -37,6 +37,8 @@ types:
37
37
  (luvio.ttl): 900000
38
38
  RecommendedActionsRepresentation:
39
39
  (luvio.ttl): 900000
40
+ CopilotFollowUpActionsRepresentation:
41
+ (luvio.ttl): 900000
40
42
 
41
43
  /connect:
42
44
  /conversation-runtime-proxy:
@@ -46,6 +48,11 @@ types:
46
48
  post:
47
49
  (luvio.adapter):
48
50
  name: sendMessage
51
+ /follow-up-actions:
52
+ post:
53
+ (luvio.method): get
54
+ (luvio.adapter):
55
+ name: getFollowUpActions
49
56
  /recommended-plan-templates/{pageType}/{objectType}:
50
57
  get:
51
58
  (luvio.adapter):