1️⃣: AWS COMPREHEND - LANGUAGE DETECTION (FRONT-END) ===========================================

📋 ELEMENT DESCRIPTION
--------------------------------
AWS COMPREHEND - LANGUAGE DETECTION (FRONT-END) provides DETECT DOMINANT LANGUAGE action to determine the dominant language of text input. The front-end element is suitable for applications when reactivity is desired, such as but not limited to, mobile applications.

🔧 STEP-BY-STEP SETUP
--------------------------------
ℹ️ The steps from 0) to 1) 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.

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 COMPREHEND 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) Enter in the PLUGIN SETTINGS your PUBLIC ACCESS KEY (used for this element only), AWS SERVICE ENDPOINT REGION (if not provided, the default endpoint is "us-east-1").

4) Add the AWS COMPREHEND - LANGUAGE DETECTION (FRONT-END) element to the page on which the language detection feature must be integrated. Select the RESULT DATA TYPE as Returned type, must always be set to "RESULT (COMPREHEND - LANGUAGE DETECTION)".

5) Integrate the logic into your application using the following AWS COMPREHEND - LANGUAGE DETECTION (FRONT-END) element's states and actions:

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

EVENTS:
- SUCCESS: Event triggered upon success
- ERROR: Event triggered upon error

EXPOSED STATES:
Use any element able to show/process the data of interest (such as a Group with a Text field) stored within the result of the following states of the AWS COMPREHEND - LANGUAGE DETECTION (FRONT-END) element:
- RESULTS: Populated upon SUCCESS event. Returns the languages that AWS COMPREHEND detected in the input text. For each language, the response returns the RFC 5646 language code and the level of confidence that AWS COMPREHEND has in the accuracy of its inference.
- ERROR MESSAGE: Populated upon ERROR event.
- IS PROCESSING: Set to true when processing is in progress, false otherwise.

ELEMENT ACTIONS - TRIGGERED IN WORKFLOW:
- DETECT DOMINANT LANGUAGE (FRONT-END): Examines text to determine the dominant language. Populates RESULTS state upon completion.

  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.

2️⃣: DETECT DOMINANT LANGUAGE (BACK-END)
==================================

📋 ACTION DESCRIPTION
--------------------------------
DETECT DOMINANT LANGUAGE (BACK-END) examines text to determine the dominant language. For each language, the response returns the RFC 5646 language code and the level of confidence that AWS COMPREHEND has in the accuracy of its inference.
The back-end action is suitable for applications when volume or asynchronous processing is desired.

🔧 STEP-BY-STEP SETUP
--------------------------------
ℹ️ If not already done, perform steps 0, 1, and 3 of the first element setup. The back-end action does not require the PUBLIC ACCESS KEY.

1) Set up the "DETECT DOMINANT LANGUAGE (BACK-END)" action in the workflow.

  Input 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.
     - RESULT DATA TYPE: Returned type, must always be set to "RESULT (COMPREHEND - LANGUAGE DETECTION)".
 
  Output Fields:
     - RESULTS: Returns the languages that AWS COMPREHEND detected in the input text. For each language, the response returns the RFC 5646 language code and the level of confidence that AWS COMPREHEND has in the accuracy of its inference.

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

ℹ️ ADDITIONAL INFORMATION
======================
> Detect Dominant Language details: https://docs.aws.amazon.com/comprehend/latest/dg/API_DetectDominantLanguage.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

⚠️ TROUBLESHOOTING
================
Any plugin related error will be posted to the Logs tab, "Server logs" section of your App Editor.
Make sure that "Plugin server side logging" and "Plugin client side logging" are 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

⚡ PERFORMANCE CONSIDERATIONS
===========================

GENERAL
-------------
For back-end actions, the maximum processing duration of this action is capped at 30 seconds as per Bubble.io design. This time limitation 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.

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