@salesforce/lds-adapters-service-einsteinllm 1.204.0

package/src/raml/api.raml

@@ -0,0 +1,275 @@
+#%RAML 1.0
+securedBy:
+  - OAuth2
+title: Salesforce Connect API
+version: '59.0'
+mediaType: application/json
+protocols:
+  - https
+baseUri: /services/data/v59.0
+securitySchemes:
+  OAuth2:
+    type: OAuth 2.0
+    settings:
+      authorizationUri: https://example.com/oauth/authorize
+      accessTokenUri: ''
+      authorizationGrants:
+        - implicit
+annotationTypes:
+  oas-readOnly:
+    type: boolean
+    allowedTargets: TypeDeclaration
+  oas-collectionFormat:
+    type: string
+  oas-body-name:
+    type: string
+    allowedTargets: TypeDeclaration
+types:
+  EinsteinLlmAdditionalConfigInputRepresentation:
+    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: object
+      applicationName:
+        description: 'Salesforce Hawking Application Name '
+        type: string
+        required: false # TODO Hand-rolled W-9314597
+      enablePiiMasking:
+        description: Whether to mask PII for this request. Defaults is provider specific.
+        type: boolean
+        required: false # TODO Hand-rolled W-9314597
+      frequencyPenalty:
+        description: Defaults to 0.0, min value of 0.0, max value of 1.0. Can be used
+          to reduce repetitiveness of generated tokens. The higher the value, the
+          stronger a penalty is applied to previously present tokens, proportional
+          to how many times they have already appeared in the prompt or prior generation.
+        format: double
+        type: number
+        required: false # TODO Hand-rolled W-9314597
+      maxTokens:
+        description: Maximum number of tokens to be generated
+        type: integer
+        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
+      numGenerations:
+        description: Number of completions to be generated for this prompt
+        type: integer
+        required: false # TODO Hand-rolled W-9314597
+      presencePenalty:
+        description: Defaults to 0.0, min value of 0.0, max value of 1.0. Can be used
+          to reduce repetitiveness of generated tokens. Similar to frequency_penalty,
+          except that this penalty is applied equally to all tokens that have already
+          appeared, regardless of their exact frequencies.
+        format: double
+        type: number
+        required: false # TODO Hand-rolled W-9314597
+      stopSequences:
+        description: The generated text will be cut at the end of the earliest occurence
+          of a stop sequence.
+        type: array
+        required: false # TODO Hand-rolled W-9314597
+        items:
+          type: string
+      temperature:
+        description: Sampling temperature to be used. Higher values means the model
+          will take more risks. Lower temperatures mean less random generations. Min
+          value of 0 and max value of 1.0
+        format: double
+        type: number
+        required: false # TODO Hand-rolled W-9314597
+  # Hand-rolled remove all EinsteinLlmEmbedding*Representation types; not in scope for current work
+  EinsteinLlmGenerationItemRepresentation:
+    description: Output of a einstein llm generation item response
+    type: object
+    properties:
+      parameters:
+        description: Any provider specific attributes will be included as part of
+          this object
+        type: string
+      text:
+        description: Text
+        type: string
+  # TODO Hand-rolled W-8334626
+  # Need to manually wrap the input representation with what the aura controller is expecting
+  EinsteinLlmGenerationsInputWrapperRepresentation:
+    description: Input wrapper for generations input representation
+    type: object
+    properties:
+      generationsInput:
+        description: Set the parameters for message generation
+        type: EinsteinLlmGenerationsInputRepresentation
+  EinsteinLlmGenerationsInputRepresentation:
+    description: Input representation for generating responses with Einstein LLM
+    type: object
+    properties:
+      additionalConfig:
+        description: Additional configuration to fine tune model parameters
+        type: EinsteinLlmAdditionalConfigInputRepresentation # Hand-rolled update from 'object'
+        required: false # TODO Hand-rolled W-9314597
+      promptTextorId:
+        description: Represents the promptTextorId or text to be completed.
+        type: string
+      provider:
+        description: LLM Provider
+        type: string
+        required: false # TODO Hand-rolled W-9314597
+  EinsteinLlmGenerationsRepresentation:
+    description: Output of a einstein llm generations response
+    type: object
+    properties:
+      generations:
+        description: List of generated text
+        type: array
+        items:
+          type: EinsteinLlmGenerationItemRepresentation
+      parameters:
+        description: Any provider specific attributes will be included as part of
+          this object
+        type: WrappedMap | nil # Hand-rolled union 'nil'
+      prompt:
+        description: Prompt used for the generation
+        type: string | nil # Hand-rolled union 'nil'
+      requestId:
+        description: ID of the generation request
+        type: string
+  # TODO Hand-rolled W-8334626
+  # Need to manually wrap the input representation with what the aura controller is expecting
+  EinsteinPromptTemplateGenerationsInputWrapperRepresentation:
+    description: Input wrapper for prompt template generations input representation
+    type: object
+    properties:
+      promptTemplateGenerationsInput:
+        description: Set the parameters for prompt template message generation
+        type: EinsteinPromptTemplateGenerationsInputRepresentation
+  EinsteinPromptTemplateGenerationsInputRepresentation:
+    description: Input representation for generating prompt template responses with
+      Einstein LLM
+    type: object
+    properties:
+      additionalConfig:
+        description: Additional configuration to fine tune model parameters
+        type: EinsteinLlmAdditionalConfigInputRepresentation # Hand-rolled update from 'object'
+        required: false # TODO Hand-rolled W-9314597
+      inputParams:
+        description: Dictionary of input parameters to generate prompt from prompt
+          template.
+        type: WrappedValueMap # Hand-rolled update from 'object'
+        properties:
+          //:
+            type: object
+      isPreview:
+        description: Whether to generate prompt template preview  by resolving merge
+          fields
+        type: boolean
+      provider:
+        description: LLM Provider
+        type: string
+        required: false # TODO Hand-rolled W-9314597
+  EinsteinPromptTemplateGenerationsRepresentation:
+    description: Output of a einstein llm generations response for given prompt template
+    type: object
+    properties:
+      generations:
+        description: List of generated text
+        type: array
+        items:
+          type: EinsteinLlmGenerationItemRepresentation
+      parameters:
+        description: Any provider specific attributes will be included as part of
+          this object
+        type: WrappedMap | nil # Hand-rolled union 'nil'
+      prompt:
+        description: Prompt used for the generation
+        type: string | nil # Hand-rolled union 'nil'
+      promptTemplateDevName:
+        description: generated prompt template promptTemplateDevName
+        type: string
+      requestId:
+        description: ID of the generation request
+        type: string
+  WrappedListString:
+    description: Wrapped list of String for use in Apex.
+    type: object
+    properties:
+      wrappedListString:
+        description: wrappedListString
+        type: array
+        items:
+          type: string
+  WrappedMap:
+    description: Wrapped map for use in Connect API.
+    type: object
+    properties:
+      wrappedMap:
+        description: wrapped map
+        type: object
+        properties:
+          //:
+            type: object
+  WrappedValue:
+    description: Wrapped Object for use in Einstein LLM.
+    type: object
+    properties:
+      value:
+        description: Value
+        type: object
+  WrappedValueMap:
+    description: Wrapped Map of Object for use in Apex.
+    type: object
+    properties:
+      valueMap:
+        description: Wrapped Value Map
+        type: object
+        properties:
+          //:
+            type: object
+/einstein:
+  /llm:
+    # Hand-rolled remove /embeddings endpoint; not in scope for current work
+    /prompt/generations:
+      post:
+        displayName: postEinsteinLlmGenerations
+        description: Generates a response based on the provided prompt and parameters
+        responses:
+          '200':
+            description: Success
+            body:
+              application/json:
+                type: EinsteinLlmGenerationsRepresentation
+        body:
+          application/json:
+            type: EinsteinLlmGenerationsInputWrapperRepresentation
+            (oas-body-name): generationsInput
+  /prompt-templates/{promptTemplateDevName}/generations:
+    post:
+      displayName: postEinsteinPromptTemplateGenerations
+      description: Generates a response based on the provided prompt template and
+        parameters
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: EinsteinPromptTemplateGenerationsRepresentation
+      body:
+        application/json:
+          type: EinsteinPromptTemplateGenerationsInputWrapperRepresentation
+          (oas-body-name): promptTemplateGenerationsInput
+    uriParameters:
+      promptTemplateDevName:
+        type: string
+        required: true

package/src/raml/luvio.raml

@@ -0,0 +1,27 @@
+#%RAML 1.0 Overlay
+extends: ./api.raml
+
+uses:
+  luvio: luvio://annotations.raml
+
+(luvio.keyPrefix): 'EinsteinLLM'
+
+types:
+  EinsteinLlmGenerationsRepresentation:
+    (luvio.ttl): 100
+    (luvio.key):
+      requestId: requestId
+  EinsteinPromptTemplateGenerationsRepresentation:
+    (luvio.ttl): 100
+    (luvio.key):
+      requestId: requestId
+
+/einstein/llm/prompt/generations:
+  post:
+    (luvio.adapter):
+      name: createGenerateMessages
+
+/einstein/prompt-templates/{promptTemplateDevName}/generations:
+  post:
+    (luvio.adapter):
+      name: createGenerateMessagesForPromptTemplate