HUME AI - REALTIME VOICE CHAT ====================================

HUME AI - REALTIME VOICE CHAT - ELEMENT DESCRIPTION
------------------------------------------------------------------------------
 HUME AI - REALTIME VOICE CHAT provides realtime voice chat with emotional intelligence.

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 - REALTIME VOICE CHAT ELEMENT to the page on which the chat must be integrated. Select the RESULT DATA TYPE as CONVERSATION (HUME AI REALTIME).

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

 FIELDS:
   - RESULT DATA TYPE: Must always be selected as CONVERSATION (HUME AI REALTIME).      
   - MICROPHONE NAME: Microphone Name to use as a source. It must be one of the items of the DEVICES state.
   - ECHO CANCELLATION : Echo cancellation is a feature which attempts to prevent echo effects on a two-way audio connection by attempting to reduce or eliminate crosstalk between the user's output device and their input device.
   - NOISE SUPPRESSION : Noise suppression automatically filters the audio to remove background noise, hum caused by equipment, and the like from the sound before delivering it to your code.
   - AUTO GAIN CONTROL : Automatic gain control is a feature in which a sound source automatically manages changes in the volume of its source media to maintain a steady overall volume level.


 EVENTS:
 - ERROR: Event triggered when an error occurs.
 - CALL TOOL: Event triggered when a function is triggered, as defined in TOOLS of START CONVERSATION action.
 - CONVERSATION TO SAVE: Event triggered when any of the conversation has changed.

 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 - REALTIME VOICE CHAT ELEMENT:
 - ERROR: Error message upon Error event trigger.
 - IS LISTENING: Returns true when listening is in progress.
 - TOOL NAME: Name of the tool, set upon CALL TOOL event.
 - TOOL ARGUMENTS: Arguments of the tool, set upon CALL TOOL event.
 - TOOL CALL ID: Unique identifier of the tool call, set upon CALL TOOL event.
 - ALL CONVERSATIONS : List of conversations containing a list of role and message content.
 - ALL CONVERSATIONS (RAW DATA) : String containing All Conversations in JSON format. You may use this string to load threads in "LOAD CONVERSATIONS" action.


 ELEMENT ACTIONS - TRIGGERED IN WORKFLOW:
   - DETECT MICROPHONES: Detect the microphone devices. You must pass one of those values into MICROPHONE NAME.
   - START CONVERSATION: Start Voice Conversation.
  Inputs Fields:
       - EVI CONFIGURATION ID: Set your configuration ID set on https://platform.hume.ai/evi/configs
       - RESUMED CONVERSATION ID: Must be one of the CONVERSATION ID of ALL CONVERSATIONS state.
   - STOP CONVERSATION: Stop Voice Conversation.
  Inputs Fields:
       - INTERRUPT PLAYBACK : If true, immediately interrupt playback. If false, buffered audio will continue playing until completed.
   - SET CONVERSATION TITLE : Set a custom Conversation Title of a given Conversation ID.
  Inputs Fields :
       - CONVERSATION ID : Set the title to this Conversation ID. A valid Conversation ID is one of the exposed state ALL CONVERSATIONS.
   - SEND TEXT MESSAGE : Send a message in text format.
  Inputs Fields:
       - MESSAGE : The message in text format.
   - SEND TOOL RESULT: Send the tool results.
  Inputs Fields:
       - TOOL CALL ID: Unique identifier of the tool call from the TOOL CALL ID state, which is set upon CALL TOOL event.
       - TOOL RESULT: Result of the tool to pass.
  - LOAD CONVERSATIONS : Load the conversations.
     Inputs Fields :
       - CONVERSATIONS (RAW DATA) : String formatted as JSON-safe, containing the conversations in JSON format.
   - DELETE CONVERSATION ID : Delete the specified CONVERSATION ID.
     Inputs Fields :
       - CONVERSATION ID : Delete the specified CONVERSATION ID.  

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.