@salesforce/lds-adapters-service-einstein-copilot-bot 1.287.0-dev1 → 1.287.0-dev10

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,121 @@ types:
228
228
  isSuccess:
229
229
  description: Success indicator of the get operation.
230
230
  type: boolean
231
+ CopilotLLMFeedbackInputRepresentation:
232
+ description: Copilot LLM feedback input
233
+ type: object
234
+ properties:
235
+ details:
236
+ description: details
237
+ type: object
238
+ properties:
239
+ //:
240
+ type: any # TODO Hand-rolled W-886340
241
+ feedback:
242
+ description: Structured feedback enum, thumbs up/down, good/bad
243
+ type: string
244
+ enum:
245
+ - Bad
246
+ - Good
247
+ feedbackId:
248
+ description: Feedback ID
249
+ type: string
250
+ sessionId:
251
+ description: Session ID
252
+ type: string
253
+ text:
254
+ description: User provided long-form feedback
255
+ type: string
256
+ CopilotLLMFeedbackOutputRepresentation:
257
+ description: CopilotLLMFeedback
258
+ type: object
259
+ properties:
260
+ submitFeedbackStatus:
261
+ description: Bot Runtime feedback response
262
+ type: string
263
+ CopilotQuickActionRepresentation:
264
+ description: Represents a Copilot QuickAction which can be executed by a Copilot client.
265
+ type: object
266
+ properties:
267
+ type:
268
+ description: Type of Copilot QuickAction.
269
+ type: string
270
+ required: false
271
+ label:
272
+ description: Label to display when rendering Copilot QuickAction.
273
+ type: string
274
+ required: false
275
+ icon:
276
+ description: Icon name for the Recommended Action to be used by the client when rendering the QuickAction in the UI.
277
+ type: string
278
+ required: false
279
+ description:
280
+ description: Description of Copilot QuickAction.
281
+ type: string
282
+ required: false
283
+ planTemplateId:
284
+ description: Plan TemplateId associated to the Copilot QuickAction.
285
+ type: string
286
+ required: false
287
+ intent:
288
+ description: Intent associated to the Copilot QuickAction which is used by the planner.
289
+ type: string
290
+ required: false
291
+ userUtterance:
292
+ description: User utterance to be recorded in conversation history by Planner when executing this Copilot Quick Action.
293
+ type: string
294
+ required: false
295
+ actionApiName:
296
+ description: Api name of Copilot QuickAction.
297
+ type: string
298
+ required: false
299
+ createdDate:
300
+ description: Creation date of Copilot QuickAction.
301
+ type: string
302
+ required: false
303
+ lastModifiedDate:
304
+ description: Last Modified date of Copilot QuickAction
305
+ type: string
306
+ required: false
307
+ isGlobal:
308
+ description: Is the copilot QuickAction global or not.
309
+ type: boolean
310
+ required: false
311
+ planTemplateInput:
312
+ description: Input Variables for executing this plan template.
313
+ type: object
314
+ required: false
315
+ properties:
316
+ //:
317
+ type: string
318
+ isStandard:
319
+ description: Is the Copilot QuickAction a standard Action.
320
+ type: boolean
321
+ required: false
322
+ orgAccess:
323
+ description: Level of Org access required for this QuickAction to be visible for the org.
324
+ type: string
325
+ required: false
326
+ namespace:
327
+ description: Namespace of the Copilot QuickAction
328
+ type: string
329
+ required: false
330
+ RecommendedActionsRepresentation:
331
+ description: Represents the result of a get recommended actions request.
332
+ type: object
333
+ properties:
334
+ copilotQuickActions:
335
+ description: Recommended copilot Quick Actions.
336
+ type: array
337
+ items:
338
+ type: CopilotQuickActionRepresentation
339
+ isSuccess:
340
+ description: Success indicator of the get operation.
341
+ type: boolean
342
+ errorMessage:
343
+ description: Error message for the failed get operation
344
+ type: string
345
+ required: false
231
346
  EsTypeMessageRepresentation:
232
347
  description: Represents a ES type message
233
348
  type: object
@@ -249,9 +364,12 @@ types:
249
364
  name:
250
365
  description: Name of the variable
251
366
  type: string
367
+ type:
368
+ description: Type of the variable
369
+ type: string
252
370
  value:
253
371
  description: Value of the variable
254
- type: string
372
+ type: any
255
373
  required: false
256
374
  PlanTemplateRepresentation:
257
375
  description: Represents a plan template which can be executed by a Copilot client.
@@ -348,3 +466,53 @@ types:
348
466
  objectType:
349
467
  type: string
350
468
  required: true
469
+ /copilot/feedback:
470
+ post:
471
+ displayName: postConversationLLMFeedback
472
+ description: Submit feedback to the chatbot runtime.
473
+ responses:
474
+ '200':
475
+ description: Success
476
+ body:
477
+ application/json:
478
+ type: CopilotLLMFeedbackOutputRepresentation
479
+ body:
480
+ application/json:
481
+ type: CopilotLLMFeedbackInputRepresentation
482
+ (oas-body-name): submitFeedback
483
+ /recommended-actions:
484
+ get:
485
+ displayName: getRecommendedActions
486
+ description: Provides a list of recommended actions based on the criteria passed in.
487
+ responses:
488
+ '200':
489
+ description: Success
490
+ body:
491
+ application/json:
492
+ type: RecommendedActionsRepresentation
493
+ queryParameters:
494
+ pageName:
495
+ type: string
496
+ required: false
497
+ pageType:
498
+ type: string
499
+ required: false
500
+ actionName:
501
+ type: string
502
+ required: false
503
+ objectApiName:
504
+ type: string
505
+ required: false
506
+ customApplicationName:
507
+ type: string
508
+ required: false
509
+ sessionId:
510
+ type: string
511
+ required: false
512
+ formFactor:
513
+ type: string
514
+ required: false
515
+ enum:
516
+ - Large
517
+ - Medium
518
+ - Small
@@ -15,6 +15,10 @@ types:
15
15
  (luvio.ttl): 30000
16
16
  (luvio.key):
17
17
  id: id
18
+ CopilotLLMFeedbackOutputRepresentation:
19
+ (luvio.ttl): 100
20
+ (luvio.key):
21
+ id: submitFeedbackStatus
18
22
  ConversationRuntimeProxyChoiceRepresentation:
19
23
  (luvio.ttl): 30000
20
24
  CollectMessageRepresentation:
@@ -29,6 +33,10 @@ types:
29
33
  (luvio.ttl): 900000
30
34
  RecommendedPlanTemplatesRepresentation:
31
35
  (luvio.ttl): 900000
36
+ CopilotQuickActionRepresentation:
37
+ (luvio.ttl): 900000
38
+ RecommendedActionsRepresentation:
39
+ (luvio.ttl): 900000
32
40
 
33
41
  /connect:
34
42
  /conversation-runtime-proxy:
@@ -42,3 +50,11 @@ types:
42
50
  get:
43
51
  (luvio.adapter):
44
52
  name: getRecommendedPlanTemplates
53
+ /recommended-actions:
54
+ get:
55
+ (luvio.adapter):
56
+ name: getRecommendedActions
57
+ /copilot/feedback:
58
+ post:
59
+ (luvio.adapter):
60
+ name: submitFeedback