0️⃣ : AUTOMATED CONFIGURATION =============================================
The steps from 0) to 1) of DETECT ENTITIES, DETECT SYNTAX & DETECT KEY PHRASES can be automatically performed by using this deployment template:
   https://console.aws.amazon.com/cloudformation/home?#/stacks/create/review?stackName=BubbleComprehendSyncOnly&templateURL=https://bubble-resources.s3.amazonaws.com/deployment-assets/CloudFormation-AWSComprehendSyncOnly.yaml

 You will find the required parameters values used across the plugin in the "OUTPUT" tab of the created stack.

1️⃣ : DETECT ENTITIES (BACK-END)
===========================

📋 ACTION DESCRIPTION
--------------------------------
 DETECT ENTITIES inspects text for named entities, and returns information such as text type (for instance a location, organization, date, person name, event and much more), the text itself and its position.

🔧 STEP-BY-STEP SETUP
--------------------------------
ℹ️ The steps from 0) to 1) can be automatically performed using the deployment template mentioned in the AUTOMATED CONFIGURATION section.

 0) Sign-up for AWS COMPREHEND: https://console.aws.amazon.com/comprehend/home?p=ply&cp=bn&ad=c

 1) Create your AWS COMPREHEND ACCESS KEY & ACCESS KEY SECRET, then add to the credentials the AWS COMPREHEND READ-ACCESS policy: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys

 2) In the Plugin Settings, enter the following:
     - AWS COMPREHEND ACCESS KEY & ACCESS KEY SECRET
     - AWS SERVICE ENDPOINT REGION (if not provided, default endpoint is "us-east-1").

 3) Set up the "DETECT ENTITIES (BACK-END)" action in the workflow.
   Inputs Fields:
     - TEXT TO ANALYZE: A UTF-8 text string. Each string should contain at least 20 characters and must contain fewer that 5,000 bytes of UTF-8 encoded characters.
     - LANGUAGE CODE: The language of the input text. You can specify any of the primary languages supported by AWS COMPREHEND. All documents must be in the same language.
Possible values are listed here: https://docs.aws.amazon.com/comprehend/latest/dg/how-languages.html
      For automated language detection, please use our "AWS Comprehend - Language Detection" plugin.
   Output Fields:
     - RESULTS: Returns a list of entities, also known as textual reference to the unique name of a real-world object such as people, places, and commercial items, and to precise references to measures such as dates and quantities, along with confidence score and positions.

2️⃣ : DETECT SYNTAX (BACK-END)
===========================

📋 ACTION DESCRIPTION
--------------------------------
 DETECT SYNTAX inspects text to parse the words from the document and returns the text, the token type, where the text begins and ends, and the level of confidence that AWS COMPREHEND has that the token is correct.

🔧 STEP-BY-STEP SETUP
--------------------------------
ℹ️ The steps from 0) to 1) can be automatically performed using the deployment template mentioned in the AUTOMATED CONFIGURATION section.

 0) Sign-up for AWS COMPREHEND: https://console.aws.amazon.com/comprehend/home?p=ply&cp=bn&ad=c

 1) Create your AWS COMPREHEND ACCESS KEY & ACCESS KEY SECRET, then add to the credentials the AWS COMPREHEND READ-ACCESS policy: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys

 2) In the Plugin Settings, enter the following:
     - AWS COMPREHEND ACCESS KEY & ACCESS KEY SECRET
     - AWS SERVICE ENDPOINT REGION (if not provided, default endpoint is "us-east-1").

 3) Set up the "DETECT SYNTAX (BACK-END)" action in the workflow.
   Inputs Fields:
     - TEXT TO ANALYZE: A UTF-8 text string. Each string should contain at least 20 characters and must contain fewer that 5,000 bytes of UTF-8 encoded characters.
     - LANGUAGE CODE: The language of the input text. You can specify any of the primary languages supported by AWS COMPREHEND. All documents must be in the same language.
Possible values are listed here: https://docs.aws.amazon.com/comprehend/latest/dg/how-languages.html
      For automated language detection, please use our "AWS Comprehend - Language Detection" plugin.

   Output Fields:
     - RESULTS: Returns a collection of syntax tokens identified in the input text.
For each token, the response provides the text, the token type, where the text begins and ends, and the level of confidence that AWS COMPREHEND has that the token is correct.

3️⃣ : DETECT KEY PHRASES (BACK-END)
===========================

📋 ACTION DESCRIPTION
--------------------------------
 DETECT KEY PHRASES inspects text to parse the words from the document and returns the text, the token type, where the text begins and ends, and the level of confidence that Amazon Comprehend has that the token is correct.

🔧 STEP-BY-STEP SETUP
--------------------------------
ℹ️ The steps from 0) to 1) can be automatically performed using the deployment template mentioned in the AUTOMATED CONFIGURATION section.

 0) Sign-up for AWS COMPREHEND: https://console.aws.amazon.com/comprehend/home?p=ply&cp=bn&ad=c

 1) Create your AWS COMPREHEND ACCESS KEY & ACCESS KEY SECRET, then add to the credentials the AWS COMPREHEND READ-ACCESS policy: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys

 2) In the Plugin Settings, enter the following:
     - AWS COMPREHEND ACCESS KEY & ACCESS KEY SECRET
     - AWS SERVICE ENDPOINT REGION (if not provided, default endpoint is "us-east-1").

 3) Set up the "DETECT KEY PHRASES (BACK-END)" action in the workflow.
   Inputs Fields:
     - TEXT TO ANALYZE: A UTF-8 text string. Each string should contain at least 20 characters and must contain fewer that 5,000 bytes of UTF-8 encoded characters.
     - LANGUAGE CODE: The language of the input text. You can specify any of the primary languages supported by AWS COMPREHEND. All documents must be in the same language.
Possible values are listed here: https://docs.aws.amazon.com/comprehend/latest/dg/how-languages.html
      For automated language detection, please use our "AWS Comprehend - Language Detection" plugin.
   Output Fields:
     - RESULTS: Returns the list of key phrases, confidence score and position information.

4️⃣ : AWS COMPREHEND - TEXT ANALYSIS (FRONT-END)
===========================

📋 ELEMENT DESCRIPTION
--------------------------------
 AWS COMPREHEND - TEXT ANALYSIS (FRONT-END) provides client-side text analysis capabilities with improved responsiveness. The element supports all three analysis types: DETECT ENTITIES, DETECT SYNTAX, and DETECT KEY PHRASES.

🔧 STEP-BY-STEP SETUP
--------------------------------
ℹ️ The steps from 0) to 1) can be automatically performed using the deployment template mentioned in the AUTOMATED CONFIGURATION section.

 0) Sign-up for AWS COMPREHEND: https://console.aws.amazon.com/comprehend/home?p=ply&cp=bn&ad=c

 1) Create your AWS COMPREHEND ACCESS KEY & ACCESS KEY SECRET, then add to the credentials the AWS COMPREHEND READ-ACCESS policy: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys

 2) Register on plugins.wiseable.io. Create a new Credential which associates your BUBBLE APP URL, AWS ACCESS KEY & ACCESS KEY SECRET.
    The registration service will generate your PUBLIC ACCESS KEY. This key serves as a secure proxy for your real API key. It allows your application to communicate with the service without exposing your real API key. Since this PUBLIC ACCESS KEY is explicitly tied to your registered BUBBLE APP URL, it can only be used from that domain, ensuring that even if the key is publicly visible, it remains safe and cannot be misused by unauthorized sources.

 3) In the Plugin Settings, enter the following:
     - PUBLIC ACCESS KEY (GENERATED FROM PLUGINS.WISEABLE.IO)
     - AWS SERVICE ENDPOINT REGION (if not provided, default endpoint is "us-east-1").

 4) Add the AWS COMPREHEND - TEXT ANALYSIS (FRONT-END) element to your page.

 5) Integrate the logic into your application using the following element's states and actions:

FIELDS:
 - RESULT DATA TYPE: Returned type, must always be set to "RESULT (COMPREHEND - TEXT ANALYTICS)".

EVENTS:
 - SUCCESS: Event triggered upon successful analysis
 - ERROR: Event triggered when an error occurs

EXPOSED STATES:
 - RESULTS: Populated upon SUCCESS event. Returns the analysis results based on the requested operation.
 - ERROR MESSAGE: Populated upon ERROR event with detailed error information.
 - IS PROCESSING: Set to true when processing is in progress, false otherwise.
 - REQUESTED ACTION: Contains the name of the last requested action.

ELEMENT ACTIONS - TRIGGERED IN WORKFLOW:
 - DETECT ENTITIES (FRONT-END): Analyze text to identify named entities.
   Inputs Fields:
     - TEXT TO ANALYZE: A UTF-8 text string. Each string should contain at least 20 characters and must contain fewer that 5,000 bytes of UTF-8 encoded characters.
     - LANGUAGE CODE: The language of the input text. You can specify any of the primary languages supported by AWS COMPREHEND.

 - DETECT SYNTAX (FRONT-END): Analyze text to identify syntax tokens.
   Inputs Fields:
     - TEXT TO ANALYZE: A UTF-8 text string. Each string should contain at least 20 characters and must contain fewer that 5,000 bytes of UTF-8 encoded characters.
     - LANGUAGE CODE: The language of the input text. You can specify any of the primary languages supported by AWS COMPREHEND.

 - DETECT KEY PHRASES (FRONT-END): Analyze text to identify key phrases.
   Inputs Fields:
     - TEXT TO ANALYZE: A UTF-8 text string. Each string should contain at least 20 characters and must contain fewer that 5,000 bytes of UTF-8 encoded characters.
     - LANGUAGE CODE: The language of the input text. You can specify any of the primary languages supported by AWS COMPREHEND.

🔍 IMPLEMENTATION EXAMPLE
======================
Feel free to browse the app editor in the Service URL for an implementation example.

ℹ️ ADDITIONAL INFORMATION
======================
> Entities details: https://docs.aws.amazon.com/comprehend/latest/dg/how-entities.html
> Syntax details: https://docs.aws.amazon.com/comprehend/latest/dg/how-syntax.html
> Key Phrases details: https://docs.aws.amazon.com/comprehend/latest/dg/how-key-phrases.html

> AWS COMPREHEND service limits: https://docs.aws.amazon.com/comprehend/latest/dg/guidelines-and-limits.html#limits-all
> AWS services availability per region: https://aws.amazon.com/about-aws/global-infrastructure/regional-product-services/
> AWS Service endpoints list: https://docs.aws.amazon.com/general/latest/gr/rande.html

⚡ PERFORMANCE CONSIDERATIONS
===========================
The largest retrievable result-set from AWS COMPREHEND for back-end actions is capped at 30 seconds duration time - this does not apply to front-end actions.

⏱️ BACK-END ACTION START DELAY
-----------------------------------------------
Each time a server-side action is called, Bubble initializes a small virtual machine to execute the action. If the same action is called shortly after, the caching mechanism kicks in, resulting in faster execution on subsequent calls.

A useful workaround is to fire a dummy execution at page load, which pre-warms the Bubble engine for the next few minutes, reducing the impact of cold starts for your users.

⚠️ TROUBLESHOOTING
================
Any plugin related error will be posted to the the Logs tab, "Server logs" section of your App Editor.
Make sure that "Plugin server side output" and "Plugin client side output" is selected in "Show Advanced".

For front-end actions, you can also open your browser's developer console (F12 or Ctrl+Shift+I in most browsers) to view detailed error messages and logs.

Always check the ERROR MESSAGE state of the element and implement error handling using the ERROR event to provide a better user experience.

> Server Logs Details: https://manual.bubble.io/core-resources/bubbles-interface/logs-tab#server-logs

❓ QUESTIONS?
===========
Contact us at [email protected] for any additional feature you would require or support question.