@salesforce/lds-adapters-industries-nlpservice 0.1.0-dev1

package/src/raml/api.raml

@@ -0,0 +1,404 @@
+#%RAML 1.0
+securedBy:
+  - OAuth2
+title: Salesforce Connect API
+version: '63.0'
+mediaType: application/json
+protocols:
+  - https
+baseUri: /services/data/v66.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:
+  AdditionalInformationRepresentation:
+    description: The output representation of the AdditionalInformation
+    type: object
+    properties:
+      generationsResponseIds:
+        description: The ids of the AINaturalLangProcessResult record
+        type: array
+        items:
+          type: string | nil
+        required: false
+      sessionId:
+        description: The session id for AINaturalLangProcessResult record processing
+        type: string | nil
+        required: false
+  AdditionalParametersInputMap:
+    description: Represents a map of additional parameters.
+    properties:
+      additionalParameters:
+        description: Additional context input parameters.
+        type: NullableAdditionalParametersInputMap
+        required: false
+    type: object
+  NullableAdditionalParametersInputMap:
+    description: Wrapper for Nullable Map Object.
+    type: object
+    properties:
+      //:
+        type: any
+  AINaturalLangProcessResultCollectionRepresentation:
+    description: The output representation of the list for AINaturalLangProcessResult
+    type: object
+    properties:
+      aiNaturalLangProcessResults:
+        description: Get a list of AINaturalLangProcessResult.
+        type: array
+        items:
+          type: AINaturalLangProcessResultRepresentation
+  AINaturalLangProcessResultInputWrapperRepresentation:
+    description: Wrapper for AINaturalLangProcessResultInputRepresentation.
+    type: object
+    properties:
+      aiNaturalLangProcessResultInputParam:
+        description: oas body name.
+        type: AINaturalLangProcessResultInputRepresentation
+  AINaturalLangProcessResultInputRepresentation:
+    description: Input representation for AINaturalLangProcessResult
+    type: object
+    properties:
+      additionalParameters:
+        description: Additional Parameters
+        type: AdditionalParametersInputMap
+        required: false # TODO Hand-rolled W-9314597
+      query:
+        description: Query
+        type: string
+        required: false # TODO Hand-rolled W-9314597
+      serviceType:
+        description: Service Type
+        type: string
+        enum:
+          - Amazon_Comprehend_Entity_Extraction
+          - Amazon_Comprehend_Keyphrase_Extraction
+          - Amazon_Comprehend_Targeted_Sentiment
+          - GenAI_Assessment_Questions_Extraction
+          - IndustriesFilebasedQuestionAnswer
+          - OpenAIClauseExtraction
+          - OpenAIClauseGeneration
+          - OpenAIComplianceClauseExtraction
+          - OpenAIEntityExtraction
+          - OpenAISurveyGeneration
+          - OpenAITranslation
+        required: false # TODO Hand-rolled W-9314597
+      configurationApiName:
+        description: Configuration Api Name
+        type: string
+        required: false # TODO Hand-rolled W-9314597
+  AINaturalLangProcessResultRepresentation:
+    description: The output representation of the AINaturalLangProcessResult
+    type: object
+    properties:
+      additionalInformation:
+        description: The reference record id on which the NLP operation was performed
+        type: AdditionalInformationRepresentation | nil
+        required: false
+      id:
+        description: The id of the AINaturalLangProcessResult record
+        type: string
+      referenceRecord:
+        description: The reference record id on which the NLP operation was performed
+        type: string | nil
+      requestText:
+        description: The Request Tex for the NLP operation
+        type: string | nil
+      response:
+        description: The Response of the NLP operation
+        type: object | string | nil
+      serviceType:
+        description: The type of NLP service and operation
+        type: string
+      sourceRecord:
+        description: The original source record id on which the NLP operation was
+          performed
+        type: string | nil
+      status:
+        description: The Status of the NLP operation
+        type: string
+  AWSEntityRepresentation:
+    description: Represents Entities fetched from AWS comprehend
+    type: object
+    properties:
+      detectedEntities:
+        description: Represents detected entities
+        type: array
+        items:
+          type: AWSEntityStructRepresentation
+      totalResults:
+        description: Represents total number of entities
+        type: integer
+  AWSEntityStructRepresentation:
+    description: Details of an Entity
+    type: object
+    properties:
+      beginOffset:
+        description: The zero-based offset from the beginning of the source text to
+          the first character in the entity
+        type: integer
+      endOffset:
+        description: The zero-based offset from the beginning of the source text to
+          the last character in the entity
+        type: integer
+      entityName:
+        description: Type of the entity
+        type: string
+      entityValue:
+        description: The text of the entity
+        type: string
+      score:
+        description: Level of confidence that Amazon Comprehend has in the accuracy
+          of the entity detection
+        format: double
+        type: number
+  AWSKeyPhraseRepresentation:
+    description: Represents Key phrases fetched from AWS comprehend
+    type: object
+    properties:
+      keyPhrases:
+        description: Represents a list of key phrases
+        type: array
+        items:
+          type: AWSKeyPhraseStructRepresentation
+      totalResults:
+        description: Represents total number of key phrases
+        type: integer
+  AWSKeyPhraseStructRepresentation:
+    description: Details of a Key Phrase
+    type: object
+    properties:
+      beginOffset:
+        description: The zero-based offset from the beginning of the source text to
+          the first character in the key phrase
+        type: integer
+      endOffset:
+        description: The zero-based offset from the beginning of the source text to
+          the last character in the key phrase
+        type: integer
+      keyPhrase:
+        description: The text of a key noun phrase
+        type: string
+      score:
+        description: Level of confidence that Amazon Comprehend has in the accuracy
+          of the key phrase detection
+        format: double
+        type: number
+  ClauseStructRepresentation:
+    description: Details of a Clause
+    type: object
+    properties:
+      clauseName:
+        description: The name of the Clause
+        type: string
+      clauseText:
+        description: The text in the Clause
+        type: string
+  ComplianceClauseStructRepresentation:
+    description: Details of a Clause
+    type: object
+    properties:
+      clauseName:
+        description: The name of the Clause
+        type: string
+      clauseText:
+        description: The text in the Clause
+        type: string
+  EntityStructRepresentation:
+    description: Details of an entity
+    type: object
+    properties:
+      entityName:
+        description: The name of the entity
+        type: string
+      entityValues:
+        description: The list of entities
+        type: array
+        items:
+          type: string
+  ErrorRepresentation:
+    description: Represents clause results fetched from OpenAI
+    properties:
+      errorCode:
+        description: Represents error code
+        type: integer
+      errorMessage:
+        description: Represents error message
+        type: string
+    type: object
+  OpenAIClauseRepresentation:
+    description: Represents clause results fetched from OpenAI
+    type: object
+    properties:
+      clauseResults:
+        description: Represents a list of clauses
+        type: array
+        items:
+          type: ClauseStructRepresentation
+      totalResults:
+        description: Represents total number of clauses
+        type: integer
+  OpenAIComplianceClauseRepresentation:
+    description: Represents clause results fetched from OpenAI
+    type: object
+    properties:
+      clauseResults:
+        description: Represents a list of clauses
+        type: array
+        items:
+          type: ComplianceClauseStructRepresentation
+      totalResults:
+        description: Represents total number of clauses
+        type: integer
+  OpenAISurveyGenerationRepresentation:
+    description: Represents survey generationr results from OpenAI
+    properties:
+      questionCount:
+        description: Represents the total count of survey questions
+        type: integer
+      questions:
+        description: Represents a list of survey questions
+        items:
+          type: SurveyStructRepresentation
+        type: array
+    type: object
+  SurveyStructRepresentation:
+    description: Contents within a survey question
+    properties:
+      questionChoices:
+        description: List of question choices
+        items:
+          type: string
+        type: array
+      questionDescription:
+        description: The question description
+        type: string
+      questionLabel:
+        description: The question label
+        type: string
+      questionType:
+        description: Generated question type
+        type: string
+      required:
+        description: Is question required
+        type: boolean
+    type: object
+  OpenAIEntityRepresentation:
+    description: Represents entity results fetched from OpenAI
+    type: object
+    properties:
+      entityResults:
+        description: Represents a list of entities
+        type: array
+        items:
+          type: EntityStructRepresentation
+      totalResults:
+        description: Represents total number of entities
+        type: integer
+  OpenAITranslationGenerationRepresentation:
+    description: Represents survey generation results from OpenAI
+    type: object
+    properties:
+      translatedContent:
+        description: Represents the output map of the translated content
+        type: object
+        properties:
+          //:
+            type: string
+/connect/nlp-service/aiNaturalLangProcessResults:
+  post:
+    displayName: postAINaturalLangProcessResult
+    description: Creates a AINaturalLangProcessResults record
+    responses:
+      '200':
+        description: Success
+        body:
+          application/json:
+            type: AINaturalLangProcessResultRepresentation
+    body:
+      application/json:
+        # TODO Hand-rolled W-10128739. Original type: RecommendationInputRepresentation
+        type: AINaturalLangProcessResultInputWrapperRepresentation
+        (oas-body-name): aiNaturalLangProcessResultInputParam
+/connect/nlp-service/aiNaturalLangProcessResults/referenceRecords/{referenceRecordId}:
+  get:
+    displayName: getAINaturalLangProcessResultCollection
+    description: Gives the AINaturalLangProcessResults for a Source Record (Content
+      Document) or Reference Record
+    responses:
+      '200':
+        description: Success
+        body:
+          application/json:
+            type: AINaturalLangProcessResultCollectionRepresentation
+    queryParameters:
+      serviceTypes:
+        type: array
+        required: false
+        items:
+          type: string
+          enum:
+            - Amazon_Comprehend_Entity_Extraction
+            - Amazon_Comprehend_Keyphrase_Extraction
+            - Amazon_Comprehend_Targeted_Sentiment
+            - GenAI_Assessment_Questions_Extraction
+            - IndustriesFilebasedQuestionAnswer
+            - OpenAIClauseExtraction
+            - OpenAIClauseGeneration
+            - OpenAIComplianceClauseExtraction
+            - OpenAIEntityExtraction
+            - OpenAISurveyGeneration
+            - OpenAITranslation
+          (oas-collectionFormat): csv
+  uriParameters:
+    referenceRecordId:
+      type: string
+      required: true
+/connect/nlp-service/aiNaturalLangProcessResults/sourceRecords/{sourceRecordId}:
+  get:
+    displayName: getAINaturalLangProcessResultCollection
+    description: Gives the AINaturalLangProcessResults for a Source Record (Content
+      Document) or Reference Record
+    responses:
+      '200':
+        description: Success
+        body:
+          application/json:
+            type: AINaturalLangProcessResultCollectionRepresentation
+    queryParameters:
+      serviceTypes:
+        type: array
+        required: false
+        items:
+          type: string
+          enum:
+            - Amazon_Comprehend_Entity_Extraction
+            - Amazon_Comprehend_Keyphrase_Extraction
+            - Amazon_Comprehend_Targeted_Sentiment
+            - GenAI_Assessment_Questions_Extraction
+            - IndustriesFilebasedQuestionAnswer
+            - OpenAIClauseExtraction
+            - OpenAIClauseGeneration
+            - OpenAIComplianceClauseExtraction
+            - OpenAIEntityExtraction
+            - OpenAISurveyGeneration
+            - OpenAITranslation
+          (oas-collectionFormat): csv
+  uriParameters:
+    sourceRecordId:
+      type: string
+      required: true

package/src/raml/luvio.raml

@@ -0,0 +1,33 @@
+#%RAML 1.0 Overlay
+extends: ./api.raml
+
+uses:
+  luvio: luvio://annotations.raml
+
+(luvio.keyPrefix): 'NlpService'
+(luvio.ttl): 2592000000
+
+types:
+  AINaturalLangProcessResultCollectionRepresentation:
+    (luvio.opaque): true
+    (luvio.ttl): 1000
+  AINaturalLangProcessResultRepresentation:
+    (luvio.ttl): 1000
+    (luvio.opaque): true
+    (luvio.key):
+      serviceType: serviceType
+
+/connect/nlp-service/aiNaturalLangProcessResults:
+  post:
+    (luvio.adapter):
+      name: createAINaturalLangProcessResult
+
+/connect/nlp-service/aiNaturalLangProcessResults/referenceRecords/{referenceRecordId}:
+  get:
+    (luvio.adapter):
+      name: getAINaturalLangProcessResultsByReferenceRecordId
+
+/connect/nlp-service/aiNaturalLangProcessResults/sourceRecords/{sourceRecordId}:
+  get:
+    (luvio.adapter):
+      name: getAINaturalLangProcessResultsBySourceId