@salesforce/lds-adapters-service-einsteinllm 1.287.0-dev1 → 1.287.0-dev11

package/src/raml/api.raml

@@ -2,7 +2,7 @@
 securedBy:
   - OAuth2
 title: Salesforce Connect API
-version: '59.0'
+version: '61.0'
 mediaType: application/json
 protocols:
   - https
@@ -136,16 +136,36 @@ types:
     description: Output of a einstein llm generation item response
     type: object
     properties:
+      contentQualityRepresentation:
+        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
         type: string
+      responseId:
+        description: Generations Response Id
+        type: string
+      safetyScoreRepresentation:
+        description: 'Generations Safety Score Representation '
+        type: EinsteinLlmGenerationsSafetyScoreRepresentation | nil # Hand-rolled union 'nil'
+        required: false # TODO Hand-rolled W-9314597
       text:
         description: Text
         type: string
-      responseId:
-        description: Id of the generation response
-        type: string
+  EinsteinLlmGenerationsContentQualityRepresentation:
+    description: Output of a einstein llm generation content quality representation
+    type: object
+    properties:
+      isToxicityDetected:
+        description: Content Quality
+        required: false # TODO Hand-rolled W-9314597
+        type: boolean | nil # Hand-rolled union 'nil'
   # TODO Hand-rolled W-8334626
   # Need to manually wrap the input representation with what the aura controller is expecting
   EinsteinLlmGenerationsInputWrapperRepresentation:
@@ -198,6 +218,56 @@ types:
       promptTemplateGenerationsInput:
         description: Set the parameters for prompt template message generation
         type: EinsteinPromptTemplateGenerationsInputRepresentation
+  EinsteinLlmGenerationsSafetyScoreRepresentation:
+    description: Output of a einstein llm generation safety score representation
+    type: object
+    properties:
+      hateScore:
+        description: Hate Score
+        type: number | nil # Hand-rolled union 'nil'
+        required: false # TODO Hand-rolled W-9314597
+      physicalScore:
+        description: Physical Score
+        type: number | nil # Hand-rolled union 'nil'
+        required: false # TODO Hand-rolled W-9314597
+      profanityScore:
+        description: Profanity Score
+        type: number | nil # Hand-rolled union 'nil'
+        required: false # TODO Hand-rolled W-9314597
+      safetyScore:
+        description: Safety Score
+        type: number | nil # Hand-rolled union 'nil'
+        required: false # TODO Hand-rolled W-9314597
+      sexualScore:
+        description: Sexual Score
+        type: number | nil # Hand-rolled union 'nil'
+        required: false # TODO Hand-rolled W-9314597
+      toxicityScore:
+        description: Toxicity Score
+        type: number | nil # Hand-rolled union 'nil'
+        required: false # TODO Hand-rolled W-9314597
+      violenceScore:
+        description: Violence Score
+        type: number | nil # Hand-rolled union 'nil'
+        required: false # TODO Hand-rolled W-9314597
+  EinsteinPromptTemplateGenerationsErrorRepresentation:
+    description: Error output of a EinsteinPromptTemplateGeneration request
+    type: object
+    properties:
+      errorMessage:
+        description: This is the error message meant for client consumption. It may
+          differ from the Gateway Error Message
+        type: string
+      httpErrorCode:
+        description: HTTP Error Code classifying the error
+        type: string
+      localizedErrorMessage:
+        description: This is the localized error message.
+        type: string
+        required: false # TODO Hand-rolled W-9314597
+      messageCode:
+        description: The message code received from the LLM Gateway
+        type: string
   EinsteinPromptTemplateGenerationsInputRepresentation:
     description: Input representation for generating prompt template responses with
       Einstein LLM
@@ -218,6 +288,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
@@ -226,6 +300,12 @@ types:
     description: Output of a einstein llm generations response for given prompt template
     type: object
     properties:
+      generationErrors:
+        description: generated prompt template generationErrors
+        type: array
+        required: false # TODO Hand-rolled W-9314597
+        items:
+          type: EinsteinPromptTemplateGenerationsErrorRepresentation
       generations:
         description: List of generated text
         type: array
@@ -244,6 +324,56 @@ types:
       requestId:
         description: ID of the generation request
         type: string
+      requestMessages?: # TODO Hand-rolled W-15709657
+        description: generated prompt template RequestMessages
+        type: array
+        items:
+          type: EinsteinPromptTemplateMaskContentRepresentation
+      responseMessages?: # TODO Hand-rolled W-15709657
+        description: generated prompt template ResponseMessages
+        type: array
+        items:
+          type: EinsteinPromptTemplateMaskContentRepresentation
+      slotsMaskingInformation?: # TODO Hand-rolled W-15709657
+        description: generated prompt template slotsMaskingInformation
+        type: array
+        items:
+          type: EinsteinPromptTemplateMaskDataRepresentation
+  EinsteinPromptTemplateMaskContentRepresentation:
+    description: Output of a einstein mask data request and response for given prompt template
+    type: object
+    properties:
+      content:
+        description: content value
+        type: string
+      moderationSettings?:
+        description: moderationSettings value
+        type: EinsteinPromptTemplateMaskSettingsRepresentation | nil # TODO Hand-rolled W-15709657
+      role?:
+        description: RoleEnum value
+        type: string
+  EinsteinPromptTemplateMaskDataRepresentation:
+    description: Output of a einstein mask data response for given prompt template
+    type: object
+    properties:
+      originalValue:
+        description: original field value
+        type: string
+      placeHolder:
+        description: placeholder value
+        type: string
+      recognizers:
+        description: recognizers
+        type: array
+        items:
+          type: string
+  EinsteinPromptTemplateMaskSettingsRepresentation:
+    description: Output of a einstein mask data moderation setting for given prompt template
+    type: object
+    properties:
+      enableModeration:
+        description: enable moderation value
+        type: boolean
   WrappedListString:
     description: Wrapped list of String for use in Apex.
     type: object
@@ -282,35 +412,35 @@ types:
             type: object
 /einstein:
   /llm:
-    # Hand-rolled remove /embeddings endpoint; not in scope for current work
-    /prompt/generations:
+    /feedback:
       post:
-        displayName: postEinsteinLlmGenerations
-        description: Generates a response based on the provided prompt and parameters
+        displayName: postEinsteinLlmFeedback
+        description: Send feedback for a generations.response object
         responses:
           '200':
             description: Success
             body:
               application/json:
-                type: EinsteinLlmGenerationsRepresentation
+                type: EinsteinLlmFeedbackRepresentation
         body:
           application/json:
-            type: EinsteinLlmGenerationsInputWrapperRepresentation
-            (oas-body-name): generationsInput
-    /feedback:
+            type: EinsteinLlmFeedbackWrapperRepresentation
+            (oas-body-name): feedbackInput
+    # Hand-rolled remove /embeddings endpoint; not in scope for current work
+    /prompt/generations:
       post:
-        displayName: postEinsteinLlmFeedback
-        description: Send feedback for a generations.response object
+        displayName: postEinsteinLlmGenerations
+        description: Generates a response based on the provided prompt and parameters
         responses:
           '200':
             description: Success
             body:
               application/json:
-                type: EinsteinLlmFeedbackRepresentation
+                type: EinsteinLlmGenerationsRepresentation
         body:
           application/json:
-            type: EinsteinLlmFeedbackWrapperRepresentation
-            (oas-body-name): feedbackInput
+            type: EinsteinLlmGenerationsInputWrapperRepresentation
+            (oas-body-name): generationsInput
   /prompt-templates/{promptTemplateDevName}/generations:
     post:
       displayName: postEinsteinPromptTemplateGenerations