HUME AI - FACIAL EXPRESSION ANALYZER ====================================

HUME AI - FACIAL EXPRESSION ANALYZER - ELEMENT DESCRIPTION
------------------------------------------------------------------------------
 HUME AI - FACIAL EXPRESSION ANALYZER provides realtime expression detection from video devices.

STEP-BY-STEP SETUP
--------------------------------
 0) Register on Hume AI and get your HUME AI API KEY.

 1) Register on plugins.wiseable.io. Create a new Credential which associates your BUBBLE APP URL and your HUME AI API KEY.
  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.

 2) Create a configuration on HUME AI and test it on the playground.

 3) In the Plugin Settings, enter your PUBLIC ACCESS KEY generated at the previous step.

 4) Add the HUME AI - FACIAL EXPRESSION ANALYZER ELEMENT to the page on which the chat must be integrated. Select the RESULT DATA TYPE as EXPRESSIONS (HUME AI FACIAL EXPRESSION ANALYZER).

 5) Integrate the logic into your application using the following HUME AI - FACIAL EXPRESSION ANALYZER element's states and actions:

 FIELDS:
   - RESULT DATA TYPE: Must always be selected as EXPRESSIONS (HUME AI REALTIME).      
   - VIDEO DEVICE NAME: Video device name to use as a source. It must be one of the items of the VIDEO DEVICES state.

 EVENTS:
 - ERROR: Event triggered when an error occurs.

 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 HUME AI - FACIAL EXPRESSION ANALYZER ELEMENT:
 - ERROR: Error message upon Error event trigger.
 - VIDEO DEVICES : List of detected video devices, populated after DETECT VIDEO DEVICES action.
 - IS VIDEO DEVICE ON : Returns true when video device is on.
 - EXPRESSIONS : Returns the list of detected EXPRESSIONS while analyzing is in progress.

 ELEMENT ACTIONS - TRIGGERED IN WORKFLOW:
   - DETECT VIDEO DEVICES: Detect the video devices. You must pass one of those values into VIDEO DEVICE NAME.
   - START EXPRESSIONS DETECTION: Start detecting EXPRESSIONS on the video device's stream.
   - STOP EXPRESSIONS DETECTION: Stop detecting EXPRESSIONS on the video device's stream.

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

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 output" and "Plugin client side output" are selected in "Show Advanced".

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

PERFORMANCE CONSIDERATIONS
===========================
 N/A

QUESTIONS?
===========
Contact us at [email protected] for any additional features you would require or support questions.