@salesforce/lds-adapters-service-einsteinllm 1.379.1 → 1.380.0-dev10

package/src/raml/api.raml

@@ -357,6 +357,29 @@ types:
       value:
         description: The value of a field in its raw data form.
         type: boolean | integer | string | nil
+  EinsteinPromptRecordInputRepresentation:
+    description: Input representation for creating a prompt template
+    type: object
+    properties:
+      apiName:
+        description: apiName
+        type: string
+      childRelationships:
+        description: Prompt Record ChildRelationships
+        type: object
+        properties:
+          //:
+            type: any # TODO Hand-rolled W-18886332
+      fields:
+        description: GenAiPromptTemplate Fields
+        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
   EinsteinPromptRecordRepresentation:
     description: Representation of a single Prompt Template
     type: object
@@ -439,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
@@ -457,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
@@ -490,6 +520,45 @@ 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
+      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
@@ -524,6 +593,44 @@ types:
       isExcluded:
         description: true if the file is excluded from LLM request, false otherwise
         type: boolean
+  EinsteinPromptTemplateRepresentation:
+    description: Comprehensive representation for prompt template operations including
+      creation, updates, and activation
+    type: object
+    properties:
+      additionalData?: # TODO Hand-rolled W-18886332
+        description: Additional data, such as references
+        type: WrappedMap
+      errorMessages:
+        description: Error Messages
+        type: array
+        items:
+          type: string
+      hasWarning:
+        description: has warning messages
+        type: boolean
+      isSuccessful:
+        description: IsSuccessful
+        type: boolean
+      statusCode:
+        description: Status Code of connect api
+        type: string
+        required: false # TODO Hand-rolled W-18886332
+      templateId:
+        description: Template Id
+        type: string
+      templateType:
+        description: Template Type
+        type: string
+        required: false # TODO Hand-rolled W-18886332
+      versionId:
+        description: Version Id
+        type: string
+      warningMessages:
+        description: Warning Messages
+        type: array
+        items:
+          type: string
   EinsteinPromptTemplateMaskContentRepresentation:
     description: Output of a einstein mask data request and response for given prompt template
     type: object
@@ -579,6 +686,188 @@ types:
       languageDisplayName:
         description: Language Display Name
         type: string
+  PromptTemplateDataProviderDiscoveryInputRepresentation:
+    description: Input for data provider discovery API to find available data providers
+      based on criteria
+    type: object
+    properties:
+      groupName:
+        description: The expression group name for the data provider
+        type: string
+        required: false # TODO Hand-rolled W-18968514
+      target:
+        description: The scoped target for data provider discovery
+        type: string
+        required: false # TODO Hand-rolled W-18968514
+      templateInputs:
+        description: List of template input parameters for data provider discovery
+        type: array
+        items:
+          type: any #TODO Hand-rolled W-18968514
+      templateTypeName:
+        description: The template type name to filter data providers by
+        type: string
+  PromptTemplateDataProviderInputParamRepresentation:
+    description: Represents an input parameter for a data provider instance
+    type: object
+    properties:
+      apiName:
+        description: The api name of the input parameter
+        type: string
+      label:
+        description: The label of the input parameter
+        type: string
+      required:
+        description: The flag to identify if input is mandatory
+        type: boolean
+      type:
+        description: The data type of the input parameter
+        type: string
+  PromptTemplateDataProviderInstanceConfigCollectionRepresentation:
+    description: Collection of data provider instance configurations for a prompt
+      template version
+    type: object
+    properties:
+      dataProviderInstanceConfigs:
+        description: List of data provider instance configurations
+        type: array
+        items:
+          type: PromptTemplateDataProviderInstanceConfigRepresentation
+  PromptTemplateDataProviderInstanceConfigInputRepresentation:
+    description: Input for data provider instance configuration generation
+    type: object
+    properties:
+      additionalParam:
+        description: Additional parameters for the data provider configuration
+        type: object
+        required: false # TODO Hand-rolled W-18968514
+        properties:
+          //:
+            type: any #TODO Hand-rolled W-18968514
+      definition:
+        description: The definition of the data provider instance
+        type: string
+      groupName:
+        description: The expression group name for the data provider
+        type: string
+  PromptTemplateDataProviderInstanceConfigRepresentation:
+    description: Configuration for a specific instance of a data provider that drives
+      PB UI capabilities
+    type: object
+    properties:
+      apiName:
+        description: The API name of the discovered data provider
+        type: string
+      dataProviderBundle:
+        description: The data provider bundle containing configuration and schema
+          information
+        type: object
+        required: false # TODO Hand-rolled W-18968514
+        properties:
+          //:
+            type: any # TODO Hand-rolled W-18968514
+      defaultOutputParam:
+        description: The default output parameter for the data provider instance
+        type: PromptTemplateDataProviderOutputParamRepresentation
+        required: false # TODO Hand-rolled W-18968514
+      definition:
+        description: The definition field for the data provider instance
+        type: string
+      description:
+        description: The description of data provider
+        type: string | nil
+        required: false # TODO Hand-rolled W-18968514
+      groupName:
+        description: The expression group name for the data provider instance
+        type: string
+      inputParams:
+        description: The list of all input parameters for the data provider instance
+        type: array
+        required: false # TODO Hand-rolled W-18968514
+        items:
+          type: PromptTemplateDataProviderInputParamRepresentation
+      label:
+        description: The display label for the data provider instance
+        type: string
+      mappedInputs:
+        description: The mapped inputs for data provider
+        type: object
+        required: false # TODO Hand-rolled W-18968514
+        properties:
+          //:
+            type: any # TODO Hand-rolled W-18968514
+      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
+        required: false # TODO Hand-rolled W-18968514
+        items:
+          type: PromptTemplateDataProviderOutputParamRepresentation
+      referenceName:
+        description: The reference name for the data provider instance
+        type: string
+      scopedToTarget:
+        description: The target scope for non-top level providers scoped to a specific
+          target
+        type: string | nil
+        required: false # TODO Hand-rolled W-18968514
+      subGroup:
+        description: The sub-group used to categorize data providers in the resource
+          picker
+        type: string | nil
+        required: false # TODO Hand-rolled W-18968514
+  PromptTemplateDataProviderOutputParamRepresentation:
+    description: Represents an output parameter for a data provider instance
+    type: object
+    properties:
+      apiName:
+        description: The value of the output parameter
+        type: string
+      label:
+        description: The label of the output parameter
+        type: string
+  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
@@ -621,7 +910,7 @@ types:
         type: object
         properties:
           //:
-            type: object
+            type: any
   WrappedValue:
     description: Wrapped Object for use in Einstein LLM.
     type: object
@@ -725,6 +1014,91 @@ types:
         sortBy:
           type: string
           required: false
+    post:
+      displayName: postEinsteinPromptTemplateCollection
+      description: Create a prompt template
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: EinsteinPromptTemplateRepresentation
+      body:
+        application/json:
+          type: EinsteinPromptRecordInputRepresentation
+          (oas-body-name): templateInput
+  /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: postPromptTemplateDataProviderInstanceConfig
+      description: Get Data Provider Instance Configuration for given definition name
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: PromptTemplateDataProviderInstanceConfigRepresentation
+      body:
+        application/json:
+          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
@@ -743,6 +1117,101 @@ types:
       promptTemplateDevName:
         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
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: EinsteinPromptTemplateRepresentation
+        body:
+          application/json:
+            type: EinsteinPromptRecordInputRepresentation
+            (oas-body-name): templateInput
+      uriParameters:
+        promptTemplateDevName:
+          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
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: EinsteinPromptTemplateRepresentation
+        body:
+          application/json:
+            type: EinsteinPromptRecordInputRepresentation
+            (oas-body-name): templateInput
+      uriParameters:
+        promptTemplateDevName:
+          type: string
+          required: true
+        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

package/src/raml/luvio.raml

@@ -29,6 +29,19 @@ types:
   EinsteinPromptRecordRepresentation:
     (luvio.ttl): 100
     (luvio.opaque): true
+  EinsteinPromptTemplateRepresentation:
+    (luvio.ttl): 100
+    (luvio.key):
+      versionId: versionId
+  PromptTemplateDataProviderInstanceConfigCollectionRepresentation:
+    (luvio.ttl): 300
+    (luvio.opaque): true
+  PromptTemplateDataProviderInstanceConfigRepresentation:
+    (luvio.ttl): 300
+    (luvio.opaque): true
+  PromptTemplateDataProviderTypeConfigCollectionRepresentation:
+    (luvio.ttl): 300
+    (luvio.opaque): true
 
 /einstein/llm/prompt/generations:
   post:
@@ -39,6 +52,33 @@ types:
   get:
     (luvio.adapter):
       name: getPromptTemplates
+  post:
+    (luvio.adapter):
+      name: createPromptTemplate
+
+# Treat this POST operation as GET, so LDS can handle automatic caching,
+/einstein/prompt-templates/data-providers/mapped:
+  post:
+    (luvio.method): get
+    (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:
@@ -50,6 +90,22 @@ types:
     (luvio.adapter):
       name: createGenerationsForPromptTemplate
 
+/einstein/prompt-templates/{promptTemplateDevName}/versions:
+  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:
     (luvio.adapter):
@@ -65,3 +121,8 @@ types:
     (luvio.method): get
     (luvio.adapter):
       name: createEmbeddings
+
+/einstein/prompt-templates/{promptTemplateDevName}/versions/{versionId}/status:
+  put:
+    (luvio.adapter):
+      name: putEinsteinPromptTemplateVersionStatus