🧩 Overview

This asset provides a ready-to-use Chat Interface for connecting your OutSystems Agent to an interactive UI.
It includes message handling, chat history storage, image uploads, and UI helpers for agent-based interactions.

Use it as the front-end for any OutSystems Agent or conversational API.

⚙️ Setup Instructions

After installing the module, go to ODC studio, click Create and select 'From a Custom Template' to create your new app:

In your new created app follow the reminders included within it:

These steps connect your Agent and enable full chat functionality:

1️⃣ Add or Configure Your Agent Function

• Inside your Agent module, create a function that receives a prompt (text message) and returns your agent’s response.

• The Chat Interface uses this function to send user input to your Agent.

• If you already have such a function, you can simply update the placeholder logic in the Chat Interface to call it.

Alternatively, you can update the text shown in the help section if you want to display custom instructions or examples.

2️⃣ Expose the Memory Entity from Your Agent

• The chat UI relies on the Agent’s Memory entity to persist conversation history.

• In your Agent module, expose the Memory entity as a public entity.

• This allows the Chat Interface to store and retrieve messages, maintaining full chat context between user sessions.
  
  
  

3️⃣ Connect the Chat Interface to Your Agent

• Inside the Chat Interface module, call your Agent’s main action from the “Send Message” logic.

• Replace the placeholder comment // Call your agent action here with your actual Agent action call.

• Make sure the Client Variable AgentName matches your agent’s name exactly.
  This variable defines which Agent the interface connects to.
  
  
  

✅ You’re done!

You now have a functional, extensible chat UI integrated with your OutSystems Agent — with persistent history, image upload, and a modern ChatGPT-style interface.

Feel free to use it as an accelerator for your own needs!