@salesforce/lds-adapters-service-einsteinllm 1.296.0 → 1.297.0

package/src/raml/api.raml

@@ -91,6 +91,86 @@ types:
         format: double
         type: number
         required: false # TODO Hand-rolled W-9314597
+  EinsteinLlmEmbeddingItemRepresentation:
+    description: Output of a einstein llm embedding item response
+    type: object
+    properties:
+      embedding:
+        description: Embedding of the text
+        type: array
+        items:
+          format: double
+          type: number
+      index:
+        description: Index of the input text to which this embedding belongs
+        type: integer
+  EinsteinLlmEmbeddingsAdditionalConfigInputRepresentation:
+    description: Input representation for additional configurations for Einstein LLM
+      generations
+    type: object
+    properties:
+      additionalParameters:
+        description: Dictionary of any other parameters that are required by the specific
+          provider. The values will be passed as is to the provider. This is to allow
+          parameters that are unique to each provider to be specified as part of the
+          request.
+        type: object
+        required: false # TODO Hand-rolled W-9314597
+        properties:
+          //:
+            type: any
+      applicationName:
+        description: 'Salesforce Einstein Application Name '
+        type: string
+      enablePiiMasking:
+        description: Whether to mask PII for this request. Defaults is provider specific.
+        type: boolean
+        required: false # TODO Hand-rolled W-9314597
+      model:
+        description: The model to be used for the generations request. Defaults to
+          provider specific model.
+        type: string
+        required: false # TODO Hand-rolled W-9314597
+  # TODO Hand-rolled W-8334626
+  # Need to manually wrap the input representation with what the aura controller is expecting
+  EinsteinLlmEmbeddingsWrapperRepresentation:
+    description: Input wrapper for embeddings representation
+    type: object
+    properties:
+      embeddingsInput:
+        description: Set the parameters for embeddings request
+        type: EinsteinLlmEmbeddingsInputRepresentation
+  EinsteinLlmEmbeddingsInputRepresentation:
+    description: Input representation for creating embedding vector with Einstein
+      LLM
+    type: object
+    properties:
+      additionalConfig:
+        description: Additional configuration to fine tune model parameters
+        type: EinsteinLlmEmbeddingsAdditionalConfigInputRepresentation
+      prompts:
+        description: Input texts to get embeddings for, encoded as an array of strings
+        type: WrappedListString
+      provider:
+        description: Provider to be used. Should be one of OpenAI|Cohere
+        type: string
+        required: false # TODO Hand-rolled W-9314597
+  EinsteinLlmEmbeddingsRepresentation:
+    description: Output of a einstein llm embeddings response
+    type: object
+    properties:
+      embeddings:
+        description: Embeddings of the text
+        type: array
+        items:
+          type: EinsteinLlmEmbeddingItemRepresentation
+      parameters:
+        description: Any provider specific attributes will be included as part of
+          this object
+        type: object
+        properties:
+          //:
+            type: any
   # TODO Hand-rolled W-8334626
   # Need to manually wrap the input representation with what the aura controller is expecting
   EinsteinLlmFeedbackWrapperRepresentation:
@@ -140,6 +220,10 @@ types:
         description: Generations Content Quality Representation
         type: EinsteinLlmGenerationsContentQualityRepresentation | nil # Hand-rolled union 'nil'
         required: false # TODO Hand-rolled W-9314597
+      isSummarized:
+        description: Flag indicating summarization was done
+        type: boolean
+        required: false # TODO Hand-rolled W-15576505
       parameters:
         description: Any provider specific attributes will be included as part of
           this object
@@ -284,6 +368,10 @@ types:
         description: Whether to generate prompt template preview  by resolving merge
           fields
         type: boolean
+      outputLanguage:
+        description: Output Language
+        type: string
+        required: false # TODO Hand-rolled W-15576505
       provider:
         description: LLM Provider
         type: string
@@ -404,6 +492,20 @@ types:
             type: object
 /einstein:
   /llm:
+    /embeddings:
+      post:
+        displayName: postEinsteinLlmEmbeddings
+        description: Creates an embedding vector representing the input text.
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: EinsteinLlmEmbeddingsRepresentation
+        body:
+          application/json:
+            type: EinsteinLlmEmbeddingsWrapperRepresentation
+            (oas-body-name): embeddingsInput
     /feedback:
       post:
         displayName: postEinsteinLlmFeedback

package/src/raml/luvio.raml

@@ -19,6 +19,8 @@ types:
     (luvio.ttl): 100
     (luvio.key):
       message: message
+  EinsteinLlmEmbeddingsRepresentation:
+    (luvio.ttl): 100
 
 /einstein/llm/prompt/generations:
   post:
@@ -34,3 +36,9 @@ types:
   post:
     (luvio.adapter):
       name: createFeedback
+
+/einstein/llm/embeddings:
+  post:
+    (luvio.method): get
+    (luvio.adapter):
+      name: createEmbeddings