FLOWISE - CHAT STREAMING   ==================================

ELEMENT DESCRIPTION  
----------------------------------  
 FLOWISE - CHAT STREAMING provides streaming capabilities to your Flowise deployment.

STEP-BY-STEP SETUP  
--------------------------------  
 0) Set up your Flowise deployment. Different options are available at https://docs.flowiseai.com/configuration/deployment.  
 
 1) Generate your Flowise API Key. See https://docs.flowiseai.com/configuration/authorization/chatflow-level#api-key.  
 
 2) Register on plugins.wiseable.io. Create a new Credential that associates your BUBBLE APP URL and your FLOWISE AI 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.

 3) In the Plugin Settings, enter your PUBLIC ACCESS KEY generated in the previous step, your FLOWISE API KEY (Bearer XXX format), along with your FLOWISE BASE DOMAIN.

 4) Add the FLOWISE - CHAT STREAMING element to the page where the chat will be integrated.

 5) Add an element supporting input text for the user prompt.

 6) Create a Repeating Group with the "GET CHAT MESSAGES BODY (FLOWISE)" data type to display the conversation. In the data source, use the FLOWISE - GET CHAT MESSAGES with a TIME dynamic field, which will trigger the refresh at the desired moment, typically once the user has sent their request. This data source will be merged with the FLOWISE - CHAT STREAMING element's STREAMED RESPONSE to ensure streaming.

 7) Integrate the logic into your application using the following FLOWISE - ASSISTANT STREAMING element's states and actions:

 FIELDS:  
 - RESULT TYPE: Must always be "GET CHAT MESSAGES BODY (FLOWISE)".

 EVENTS:  
 - ERROR: Event triggered when an error occurs.  
 - STREAMING STARTED: Event triggered when streaming starts.  
 - STREAMING ENDED: Event triggered when streaming ends.
 - READY: Event triggered when this element's fields have been set and element is ready to serve requests.

 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 FLOWISE - ASSISTANT STREAMING element:  
 - ERROR: Error message upon error event trigger.  
 - IS STREAMING: Returns true when streaming is in progress.  
 - STREAMED RESPONSE: List of the messages of the current Thread ID along with the RUN ID.

 ELEMENT ACTIONS - TRIGGERED IN WORKFLOW:  
   - SEND USER PROMPT: Sends the user prompt to the specified CHATFLOW ID and optionally SESSION ID.  
     Input Fields:  
       - USER PROMPT: The user prompt.  
       - CHATFLOW ID: An existing CHATFLOW ID on your deployment.  
       - SESSION ID: If empty, a unique SESSION ID will be generated.
   - RESET: Reset the element.    

8) (Optional) Add the FLOWISE - MARKDOWN & LATEX PARSER element to display markdown formatting.

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

TROUBLESHOOTING  
================  
Any plugin-related errors 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 feature requests or support questions.