1️⃣: AWS REKOGNITION - COMPARE FACES (FRONT-END DESKTOP & NATIVE MOBILE) ===========================================

📋ELEMENT DESCRIPTION
--------------------------------
AWS REKOGNITION - COMPARE FACES (FRONT-END DESKTOP & NATIVE MOBILE) provides COMPARE FACES ON IMAGE action to compare a reference image file with a target image file, returning face details along with a similarity rate.
The front-end element is suitable for applications when reactivity is desired, such as but not limited to, mobile applications. It supports multiple image formats and automatically optimizes images to meet AWS requirements.

🔧 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=BubbleRekognitionSyncOnly&templateURL=https://bubble-resources.s3.amazonaws.com/deployment-assets/CloudFormation-AWSRekognitionSyncOnly.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 REKOGNITION by following this link: https://console.aws.amazon.com/rekognition/home?p=rkn&cp=bn&ad=c

1) Create your AWS REKOGNITION ACCESS KEY & ACCESS KEY SECRET and attach the AWS REKOGNITION READ ONLY or FULL ACCESS POLICY to COMPAREFACES API: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys

If you intend to use AWS S3 URI (s3://) with your own BUCKET, attach the AWS S3 READ ONLY policy to the considered BUCKET.

2) Register on plugins.wiseable.io. Create a new Credential which associates your BUBBLE APP URL, AWS REKOGNITION 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 REKOGNITION - COMPARE FACES (FRONT-END DESKTOP & NATIVE MOBILE) element to the page on which the comparison feature must be integrated. Select the RESULT DATA TYPE as Returned type, must always be set to "RESULT (REKOGNITION - COMPARE FACES)".

5) Integrate the logic into your application using the following AWS REKOGNITION - COMPARE FACES (FRONT-END DESKTOP & NATIVE MOBILE) element's states and actions:

FIELDS:
- RESULT DATA TYPE: Returned type, must always be set to "RESULT (REKOGNITION - COMPARE FACES)".  

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 REKOGNITION - COMPARE FACES (FRONT-END DESKTOP & NATIVE MOBILE) element:
- RESULTS: Populated upon SUCCESS event. Returns the details of the reference and the (un)detected faces such as a bounding box of the face, a confidence value (that the bounding box contains a face), a fixed set facial landmarks, along with the similarity percentage.
- ERROR MESSAGE: Populated upon ERROR event.
- IS PROCESSING: Set to true when processing is in progress, false otherwise.

ELEMENT ACTIONS - TRIGGERED IN WORKFLOW:
- COMPARE FACES ON IMAGE (FRONT-END DESKTOP & NATIVE MOBILE): Compare a reference image file with a target image file, returning face details along with a similarity rate. Populate RESULTS state upon completion.

  Inputs Fields:
     - REFERENCE IMAGE: Reference Image from the Bubble.io uploader, or a Protocol-relative URLs (//server/file.ext), a HTTPS file URL (https://server/file.ext), or a AWS S3 URI (s3://bucket/image.jpg). For both Protocol-relative and HTTPS URL, the file must be accessible through HTTPS Protocol.
     - TARGET IMAGE: Target Image from the Bubble.io uploader, a Protocol-relative URLs (//server/file.ext), or a HTTPS file URL, or a AWS S3 URI (s3://bucket/image.jpg). For both Protocol-relative and HTTPS URL, the file must be accessible through HTTPS Protocol.
     - SIMILARITY THRESHOLD: The minimum level of similarity that a match must meet to be included in the output array. Minimum value of 0. Maximum value of 100. Default value is 80.

2️⃣: COMPARE FACES ON IMAGE (BACK-END)
==================================

📋ACTION DESCRIPTION
--------------------------------
COMPARE FACES ON IMAGE (BACK-END) compares a reference image file with a target image file (JPEG or PNG), returning face details along with a similarity rate.
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 action "COMPARE FACES ON IMAGE (BACK-END)" action in the workflow.

  Input Fields:
     - REFERENCE IMAGE: Reference Image URL from the Bubble.io uploader, or a Protocol-relative URLs (//server/file.ext), a HTTPS file URL (https://server/file.ext), or a AWS S3 URI (s3://bucket/image.jpg). For both Protocol-relative and HTTPS URL, the file must be accessible through HTTPS Protocol.
     - TARGET IMAGE: Target Image URL from the Bubble.io uploader, a Protocol-relative URLs (//server/file.ext), or a HTTPS file URL, or a AWS S3 URI (s3://bucket/image.jpg). For both Protocol-relative and HTTPS URL, the file must be accessible through HTTPS Protocol.
     - SIMILARITY THRESHOLD: The minimum level of similarity that a match must meet to be included in the output array. Minimum value of 0. Maximum value of 100. Default value is 80.
     - RESULT DATA TYPE: Returned type, must always be set to "RESULT (REKOGNITION - COMPARE FACES)"
 
  Output Fields:
     - RESULTS: Returns the details of the reference and the (un)detected faces such as a bounding box of the face, a confidence value (that the bounding box contains a face), a fixed set facial landmarks, along with the similarity percentage.

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

ℹ️ ADDITIONAL INFORMATION
======================

⚠ WARNING: AWS REKOGNITION COMPARE FACES throws an error if no faces are detected in either the reference or target images, it is strongly advised to validate the input image with the "AWS Rekognition - Image Recognition" plugin before executing "Compare Faces On Image".
Please look at the service URL for a validation example.

> AWS REKOGNITION service limits: https://docs.aws.amazon.com/rekognition/latest/dg/limits.html
> 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, this implementation posts the file data to AWS for non-AWS Storage URI (e.g: non-s3://). 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.

FRONT-END VS BACK-END PROCESSING
----------------------------------------------------
The front-end element is designed to support and optimize multiple image formats and will automatically compress images to adhere to AWS requirements. The back-end action doesn't perform this optimization, so be careful with file size and format when using it.

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