How to connect the backend - UNC-Project-Open-AAC/OS-DPI GitHub Wiki

The backend is currently deployed temporarily on the UNC MURGe-Lab server.
All four AI plugin features use the same URL: https://be12-152-2-133-84.ngrok-free.app.
If future developers wish to replace the backend with their own models, they should update the URL used in the socket connection.
For a local setup, the URL should be in the following format: ws://localhost:4560/.
You can find the backend scripts at this repository: ai-plugin

---

The backend socket should be automatically integrated when loading the AI plugin. However, if the integration fails or you prefer to set it up manually, here is the instructions:

Step 1. Click on the Methods tab and add a new Method

Step 2. In the New method, add a Socket Handler

Step 3. Modify the settings of the Socket Handler

• Name: socket
• Active: ✅
• State Name:$socket
• URL: https://be12-152-2-133-84.ngrok-free.app
• Responses: emit
• (Optional) Filters: Field - #sheetName, Operator - equals, Value - 'prompts'; If want to know what Filters do, please see the wiki page How to customize the prompt.

Step 4. Enter a keyword or an image to interact with the backend!

• If you want to know how to interact with the AI-plugin features, please see the wiki page How to interact with the plugins.