@salesforce/lds-adapters-service-einsteinllm 1.380.0-dev2 → 1.380.0-dev20

package/src/raml/api.raml

@@ -372,19 +372,14 @@ types:
             type: any # TODO Hand-rolled W-18886332
       fields:
         description: GenAiPromptTemplate Fields
-        type: array
-        items:
-          type: object
-          properties:
-            //:
-              type: any # TODO Hand-rolled W-18886332
+        type: object
+        properties:
+          //:
+            type: any # TODO Hand-rolled W-18886332
       id:
         description: The ID of the prompt template
         type: string
         required: false # TODO Hand-rolled W-18886332
-      isStandard:
-        description: isStandard
-        type: boolean
   EinsteinPromptRecordRepresentation:
     description: Representation of a single Prompt Template
     type: object
@@ -467,6 +462,10 @@ types:
     description: Output of a einstein llm generations response for given prompt template
     type: object
     properties:
+      citations:
+        description: Generation Citations Mapping
+        required: false # TODO Hand-rolled W-19304625
+        type: EinsteinLlmGenerationCitationRepresentation
       generationErrors:
         description: generated prompt template generationErrors
         type: array
@@ -485,6 +484,9 @@ types:
       prompt:
         description: Prompt used for the generation
         type: string | nil # Hand-rolled union 'nil'
+      rawPrompt:
+        description: Raw prompt with unresolved merge fields
+        type: string | nil # Hand-rolled union 'nil'
       promptTemplateDevName:
         description: generated prompt template promptTemplateDevName
         type: string
@@ -518,6 +520,49 @@ types:
         required: false # TODO Hand-rolled W-17552098
         items:
           type: EinsteinPromptTemplateAttachmentRepresentation
+  EinsteinLlmGenerationCitationRepresentation:
+    description: Output of a Einstein LLM Generation Citation output
+    type: object
+    properties:
+      citedReferences:
+        description: Cited References
+        required: false # TODO Hand-rolled W-19304625
+        type: array
+        items:
+          type: EinsteinLlmGenerationGenAiCitedReferenceRepresentation
+  EinsteinLlmGenerationGenAiCitedReferenceRepresentation:
+    description: Output of a Einstein LLM Generation Gen AI Citation output
+    type: object
+    properties:
+      citationLocations:
+        description: Array of locations where that particular citation needs to appear
+          in the input text
+        type: array
+        required: false # TODO Hand-rolled W-19304625
+        items:
+          type: integer
+      claims:
+        description: Matching chunk from the input text
+        type: array
+        required: false # TODO Hand-rolled W-19304625
+        items:
+          type: string
+      link:
+        description: Link
+        type: string
+        required: false # TODO Hand-rolled W-19304625
+      label:
+        description: Label
+        type: string
+        required: false
+      sourceObjectApiName:
+        description: SourceObjectApiName
+        type: string
+        required: false # TODO Hand-rolled W-19304625
+      sourceObjectRecordId:
+        description: SourceObjectRecordId
+        type: string
+        required: false # TODO Hand-rolled W-19304625
   EinsteinPromptTemplateAttachmentRepresentation:
     description: Representation of file data for prompt template attachments
     type: object
@@ -645,6 +690,56 @@ types:
       languageDisplayName:
         description: Language Display Name
         type: string
+  EinsteinPromptTypeRecordRepresentation:
+    description: Representation of a single Prompt Template Type
+    type: object
+    properties:
+      excludedGlobalVariables:
+        description: The list of excluded global variables
+        type: array
+        items:
+          type: string
+      schema:
+        description: The schema of the prompt template type
+        type: EinsteinPromptTypeSchemaRepresentation
+      templateTypeName:
+        description: The unique name of the prompt template type
+        type: string
+  EinsteinPromptTypeSchemaInputFieldRepresentation:
+    description: Representation of an input in the schema of Prompt Template Type
+    type: object
+    properties:
+      apiName:
+        description: The unique API name of the input
+        type: string
+      label:
+        description: The label of the input
+        type: string
+        required: false
+      referenceName:
+        description: The reference name of the input
+        type: string
+        required: false
+      typeDefinition:
+        description: The type definition of the input
+        type: string
+        required: false
+  EinsteinPromptTypeSchemaRepresentation:
+    description: Representation of the schema of a Prompt Template type
+    type: object
+    properties:
+      allowInputExtension:
+        description: Whether to allow input extension
+        type: boolean
+      inputs:
+        description: Inputs in this template type
+        type: array
+        items:
+          type: EinsteinPromptTypeSchemaInputFieldRepresentation
+      primaryObjectId:
+        description: The ID of the primary object in the template type
+        type: string
+        required: false
   PromptTemplateDataProviderDiscoveryInputRepresentation:
     description: Input for data provider discovery API to find available data providers
       based on criteria
@@ -699,9 +794,10 @@ types:
       additionalParam:
         description: Additional parameters for the data provider configuration
         type: object
+        required: false # TODO Hand-rolled W-18968514
         properties:
           //:
-            type: object
+            type: any #TODO Hand-rolled W-18968514
       definition:
         description: The definition of the data provider instance
         type: string
@@ -757,6 +853,7 @@ types:
       nodeIcon:
         description: The icon identifier for the data provider instance
         type: string | nil
+        required: false # TODO Hand-rolled W-18968514
       outputParams:
         description: The list of all output parameters for the data provider instance
         type: array
@@ -786,6 +883,49 @@ types:
       label:
         description: The label of the output parameter
         type: string
+      type:
+        description: The type of the output parameter
+        type: string
+        required: false # TODO Hand-rolled W-19622413
+  PromptTemplateDataProviderTypeConfigCollectionRepresentation:
+    description: Collection of data provider type configurations for a prompt template
+      type
+    type: object
+    properties:
+      dataProviderTypeConfigs:
+        description: List of data provider type configs
+        type: array
+        items:
+          type: PromptTemplateDataProviderTypeConfigRepresentation
+  PromptTemplateDataProviderTypeConfigRepresentation:
+    description: Output representation of a data provider type configuration
+    type: object
+    properties:
+      description:
+        description: The localized description of the data provider type
+        type: string
+        required: false # TODO Hand-rolled W-19333313
+      groupName:
+        description: The group name of the data provider type
+        type: string
+      icon:
+        description: The icon identifier for the data provider type
+        type: string
+      isTopLevel:
+        description: Indicates whether this is a top level data provider type
+        type: boolean
+      label:
+        description: The localized label of the data provider type
+        type: string
+      parentNode:
+        description: The parent node identifier for hierarchical data provider types
+        type: string
+        required: false # TODO Hand-rolled W-19333313
+      scope:
+        description: The scope configuration for the data provider type (can be 'ALL'
+          or list of specific scopes)
+        type: any # TODO Hand-rolled W-19333313, scope can be a string, list of string, or just "ALL"
+        required: false # TODO Hand-rolled W-19333313
   EinsteinPromptTemplateVersionOutputLanguagesRepresentation:
     description: Representation of all supported output languages for a given Prompt
       Template Version
@@ -828,7 +968,7 @@ types:
         type: object
         properties:
           //:
-            type: object
+            type: any
   WrappedValue:
     description: Wrapped Object for use in Einstein LLM.
     type: object
@@ -945,20 +1085,78 @@ types:
         application/json:
           type: EinsteinPromptRecordInputRepresentation
           (oas-body-name): templateInput
-  /prompt-templates/data-providers/mapped:
+  /prompt-templates/data-providers:
+    /mapped:
+      post:
+        displayName: postDataProviderInputMatchDiscovery
+        description: Get Data Provider Discovery Info List
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: PromptTemplateDataProviderInstanceConfigCollectionRepresentation
+        body:
+          application/json:
+            type: PromptTemplateDataProviderDiscoveryInputRepresentation
+            (oas-body-name): dataProviderDiscoveryInput
+    /{templateType}:
+      get:
+        displayName: getPromptTemplateDataProviderDiscovery
+        description: Discover available data providers for prompt templates
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: PromptTemplateDataProviderInstanceConfigCollectionRepresentation
+        queryParameters:
+          groupNames:
+            description: The group names for data provider discovery
+            type: array
+            required: false
+            items:
+              type: string
+              (oas-collectionFormat): csv
+          targets:
+            description: The scoped targets for data provider discovery
+            type: array
+            required: false
+            items:
+              type: string
+              (oas-collectionFormat): csv
+      uriParameters:
+        templateType:
+          type: string
+          required: true
+  /prompt-templates/data-provider/describe:
     post:
-      displayName: postDataProviderInputMatchDiscovery
-      description: Get Data Provider Discovery Info List
+      displayName: postPromptTemplateDataProviderInstanceConfig
+      description: Get Data Provider Instance Configuration for given definition name
       responses:
         '200':
           description: Success
           body:
             application/json:
-              type: PromptTemplateDataProviderInstanceConfigCollectionRepresentation
+              type: PromptTemplateDataProviderInstanceConfigRepresentation
       body:
         application/json:
-          type: PromptTemplateDataProviderDiscoveryInputRepresentation
-          (oas-body-name): dataProviderDiscoveryInput
+          type: PromptTemplateDataProviderInstanceConfigInputRepresentation
+          (oas-body-name): dataProviderInstanceConfigInput
+  /prompt-templates/data-provider-types/{templateType}:
+    get:
+      displayName: getPromptTemplateDataProviderTypeConfig
+      description: Get available data provider types for the specified template type
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: PromptTemplateDataProviderTypeConfigCollectionRepresentation
+    uriParameters:
+      templateType:
+        type: string
+        required: true
   /prompt-templates/{promptTemplateDevName}:
     get:
       displayName: getEinsteinPromptTemplate
@@ -978,6 +1176,22 @@ types:
         type: string
         required: true
     /versions:
+      get:
+        displayName: getEinsteinPromptTemplateVersions
+        description: Get Prompt Template Versions by DeveloperName
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: EinsteinPromptRecordRepresentation
+        queryParameters:
+          includingContent:
+            type: boolean
+            required: false
+          includingVersionDetail:
+            type: boolean
+            required: false
       post:
         displayName: postEinsteinPromptTemplateVersion
         description: Create a prompt template Version
@@ -996,6 +1210,22 @@ types:
           type: string
           required: true
     /versions/{versionId}:
+      get:
+        displayName: getEinsteinPromptTemplateVersion
+        description: Get Prompt Template Version by DeveloperName and VersionId
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: EinsteinPromptRecordRepresentation
+        queryParameters:
+          includingContent:
+            type: boolean
+            required: false
+          includingVersionDetail:
+            type: boolean
+            required: false
       put:
         displayName: putEinsteinPromptTemplateVersion
         description: Modify a prompt template Version
@@ -1016,6 +1246,30 @@ types:
         versionId:
           type: string
           required: true
+    /versions/{versionId}/status:
+      put:
+        displayName: putEinsteinPromptTemplateVersionStatus
+        description: Update prompt template version status (activate/deactivate)
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: EinsteinPromptTemplateRepresentation
+        queryParameters:
+          action:
+            type: string
+            required: false
+          ignoreWarnings:
+            type: boolean
+            required: false
+      uriParameters:
+        promptTemplateDevName:
+          type: string
+          required: true
+        versionId:
+          type: string
+          required: true
   /prompt-templates/{promptTemplateDevName}/generations:
     post:
       displayName: postEinsteinPromptTemplateGenerations
@@ -1039,6 +1293,20 @@ types:
       promptTemplateDevName:
         type: string
         required: true
+  /prompt-template-types/{templateTypeName}:
+    get:
+      displayName: getEinsteinPromptTemplateType
+      description: Get A Prompt Type Configuration by templateTypeName
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: EinsteinPromptTypeRecordRepresentation
+    uriParameters:
+      templateTypeName:
+        type: string
+        required: true
   /prompt-template/{promptTemplateDevName}/output-languages:
     get:
       displayName: getEinsteinPromptTemplateOutputLanguages

package/src/raml/luvio.raml

@@ -36,6 +36,14 @@ types:
   PromptTemplateDataProviderInstanceConfigCollectionRepresentation:
     (luvio.ttl): 300
     (luvio.opaque): true
+  PromptTemplateDataProviderInstanceConfigRepresentation:
+    (luvio.ttl): 300
+    (luvio.opaque): true
+  PromptTemplateDataProviderTypeConfigCollectionRepresentation:
+    (luvio.ttl): 300
+    (luvio.opaque): true
+  EinsteinPromptTypeRecordRepresentation:
+    (luvio.ttl): 300
 
 /einstein/llm/prompt/generations:
   post:
@@ -57,6 +65,23 @@ types:
     (luvio.adapter):
       name: getInputMappedDataProviders
 
+# Treat this POST operation as GET, so LDS can handle automatic caching,
+/einstein/prompt-templates/data-provider/describe:
+  post:
+    (luvio.method): get
+    (luvio.adapter):
+      name: getDataProviderInstanceConfig
+
+/einstein/prompt-templates/data-providers/{templateType}:
+  get:
+    (luvio.adapter):
+      name: getDataProviders
+
+/einstein/prompt-templates/data-provider-types/{templateType}:
+  get:
+    (luvio.adapter):
+      name: getDataProviderTypeConfigs
+
 /einstein/prompt-templates/{promptTemplateDevName}:
   get:
     (luvio.adapter):
@@ -71,11 +96,17 @@ types:
   post:
     (luvio.adapter):
       name: createPromptTemplateVersion
+  get:
+    (luvio.adapter):
+      name: getPromptTemplateVersions
 
 /einstein/prompt-templates/{promptTemplateDevName}/versions/{versionId}:
   put:
     (luvio.adapter):
       name: updatePromptTemplateVersion
+  get:
+    (luvio.adapter):
+      name: getPromptTemplateVersion
 
 /einstein/prompt-template/{promptTemplateDevName}/output-languages:
   get:
@@ -92,3 +123,13 @@ types:
     (luvio.method): get
     (luvio.adapter):
       name: createEmbeddings
+
+/einstein/prompt-templates/{promptTemplateDevName}/versions/{versionId}/status:
+  put:
+    (luvio.adapter):
+      name: putEinsteinPromptTemplateVersionStatus
+
+/einstein/prompt-template-types/{templateTypeName}:
+  get:
+    (luvio.adapter):
+      name: getTemplateType