@salesforce/lds-adapters-service-einsteinllm 1.382.0 → 1.384.0

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
@@ -467,6 +467,10 @@ types:
467
467
  description: Output of a einstein llm generations response for given prompt template
468
468
  type: object
469
469
  properties:
470
+ citations:
471
+ description: Generation Citations Mapping
472
+ required: false # TODO Hand-rolled W-19304625
473
+ type: EinsteinLlmGenerationCitationRepresentation
470
474
  generationErrors:
471
475
  description: generated prompt template generationErrors
472
476
  type: array
@@ -518,6 +522,45 @@ types:
518
522
  required: false # TODO Hand-rolled W-17552098
519
523
  items:
520
524
  type: EinsteinPromptTemplateAttachmentRepresentation
525
+ EinsteinLlmGenerationCitationRepresentation:
526
+ description: Output of a Einstein LLM Generation Citation output
527
+ type: object
528
+ properties:
529
+ citedReferences:
530
+ description: Cited References
531
+ required: false # TODO Hand-rolled W-19304625
532
+ type: array
533
+ items:
534
+ type: EinsteinLlmGenerationGenAiCitedReferenceRepresentation
535
+ EinsteinLlmGenerationGenAiCitedReferenceRepresentation:
536
+ description: Output of a Einstein LLM Generation Gen AI Citation output
537
+ type: object
538
+ properties:
539
+ citationLocations:
540
+ description: Array of locations where that particular citation needs to appear
541
+ in the input text
542
+ type: array
543
+ required: false # TODO Hand-rolled W-19304625
544
+ items:
545
+ type: integer
546
+ claims:
547
+ description: Matching chunk from the input text
548
+ type: array
549
+ required: false # TODO Hand-rolled W-19304625
550
+ items:
551
+ type: string
552
+ link:
553
+ description: Link
554
+ type: string
555
+ required: false # TODO Hand-rolled W-19304625
556
+ sourceObjectApiName:
557
+ description: SourceObjectApiName
558
+ type: string
559
+ required: false # TODO Hand-rolled W-19304625
560
+ sourceObjectRecordId:
561
+ description: SourceObjectRecordId
562
+ type: string
563
+ required: false # TODO Hand-rolled W-19304625
521
564
  EinsteinPromptTemplateAttachmentRepresentation:
522
565
  description: Representation of file data for prompt template attachments
523
566
  type: object
@@ -699,9 +742,10 @@ types:
699
742
  additionalParam:
700
743
  description: Additional parameters for the data provider configuration
701
744
  type: object
745
+ required: false # TODO Hand-rolled W-18968514
702
746
  properties:
703
747
  //:
704
- type: object
748
+ type: any #TODO Hand-rolled W-18968514
705
749
  definition:
706
750
  description: The definition of the data provider instance
707
751
  type: string
@@ -757,6 +801,7 @@ types:
757
801
  nodeIcon:
758
802
  description: The icon identifier for the data provider instance
759
803
  type: string | nil
804
+ required: false # TODO Hand-rolled W-18968514
760
805
  outputParams:
761
806
  description: The list of all output parameters for the data provider instance
762
807
  type: array
@@ -959,6 +1004,20 @@ types:
959
1004
  application/json:
960
1005
  type: PromptTemplateDataProviderDiscoveryInputRepresentation
961
1006
  (oas-body-name): dataProviderDiscoveryInput
1007
+ /prompt-templates/data-provider/describe:
1008
+ post:
1009
+ displayName: postPromptTemplateDataProviderInstanceConfig
1010
+ description: Get Data Provider Instance Configuration for given definition name
1011
+ responses:
1012
+ '200':
1013
+ description: Success
1014
+ body:
1015
+ application/json:
1016
+ type: PromptTemplateDataProviderInstanceConfigRepresentation
1017
+ body:
1018
+ application/json:
1019
+ type: PromptTemplateDataProviderInstanceConfigInputRepresentation
1020
+ (oas-body-name): dataProviderInstanceConfigInput
962
1021
  /prompt-templates/{promptTemplateDevName}:
963
1022
  get:
964
1023
  displayName: getEinsteinPromptTemplate
@@ -1016,6 +1075,30 @@ types:
1016
1075
  versionId:
1017
1076
  type: string
1018
1077
  required: true
1078
+ /versions/{versionId}/status:
1079
+ put:
1080
+ displayName: putEinsteinPromptTemplateVersionStatus
1081
+ description: Update prompt template version status (activate/deactivate)
1082
+ responses:
1083
+ '200':
1084
+ description: Success
1085
+ body:
1086
+ application/json:
1087
+ type: EinsteinPromptTemplateRepresentation
1088
+ queryParameters:
1089
+ action:
1090
+ type: string
1091
+ required: false
1092
+ ignoreWarnings:
1093
+ type: boolean
1094
+ required: false
1095
+ uriParameters:
1096
+ promptTemplateDevName:
1097
+ type: string
1098
+ required: true
1099
+ versionId:
1100
+ type: string
1101
+ required: true
1019
1102
  /prompt-templates/{promptTemplateDevName}/generations:
1020
1103
  post:
1021
1104
  displayName: postEinsteinPromptTemplateGenerations
@@ -36,6 +36,9 @@ types:
36
36
  PromptTemplateDataProviderInstanceConfigCollectionRepresentation:
37
37
  (luvio.ttl): 300
38
38
  (luvio.opaque): true
39
+ PromptTemplateDataProviderInstanceConfigRepresentation:
40
+ (luvio.ttl): 300
41
+ (luvio.opaque): true
39
42
 
40
43
  /einstein/llm/prompt/generations:
41
44
  post:
@@ -57,6 +60,13 @@ types:
57
60
  (luvio.adapter):
58
61
  name: getInputMappedDataProviders
59
62
 
63
+ # Treat this POST operation as GET, so LDS can handle automatic caching,
64
+ /einstein/prompt-templates/data-provider/describe:
65
+ post:
66
+ (luvio.method): get
67
+ (luvio.adapter):
68
+ name: getDataProviderInstanceConfig
69
+
60
70
  /einstein/prompt-templates/{promptTemplateDevName}:
61
71
  get:
62
72
  (luvio.adapter):
@@ -92,3 +102,8 @@ types:
92
102
  (luvio.method): get
93
103
  (luvio.adapter):
94
104
  name: createEmbeddings
105
+
106
+ /einstein/prompt-templates/{promptTemplateDevName}/versions/{versionId}/status:
107
+ put:
108
+ (luvio.adapter):
109
+ name: putEinsteinPromptTemplateVersionStatus