Deploying an AI Agent

Owned by Alex Roytman
Last updated: Jul 16, 2024 by Matt Denninghoff
3 min read

After designing and configuring your AI Agent, you can deploy it to your application or website. First, make sure to save the agent into a subdirectory of the modules directory. Also ensure that this subdirectory is included in the pathlist of your config.js file.

The next step is to select Launch → Deploy this Agent from the menu.

The Deploy Agent dialog will appear.

Select the desired options, copy the provided code using the icon in the top-right corner of the code snippet, and follow the instructions for pasting it into your application.

Deploy As Web App Onclick Event

When deploying as a Web App Onclick Event, you must create your own button (or some other interface element like a hyperlink or an icon) to trigger launching the agent. Then paste the provided code into the appropriate event.

Deploy As Web App Embed Icon

When deploying as a Web App Embed Icon, paste the provided code into your application, and a “chat” icon to trigger the agent will be rendered in the bottom right corner of the application.

Deploy as Server Side Code

Use this option to interact with the agent from backend processes. This capability allows the agent to be deployed more autonomously. You can embed the capabilities of AI directly into your applications and workflow without an interactive chat interface.

For more details, see the pjs.askAgent() API.

Deploy As Slack Bot

To deploy the agent as a Slack Bot, you must have administrator rights to your Slack workspace. Copy the provided Slack App Manifest and click the Create New Slack App link. On the Slack API site, click Create New App and then select “From an App Manifest”. After the App is created, you must copy the App Credentials into your config.js file and restart the server.

Deploy As OpenAI Plugin

Deploying your agent as an OpenAI Plugin allows you to interface with other assistant ecosystems, such as the ChatGPT website or Microsoft Copilot. Copy the provided URL and paste it when asked for the OpenAI Manifest URL.

Deploy on another domain

Select this box if your application is running on a separate domain or port than the Profound AI server. In addition, make sure to Enable CORS. CORS can be enabled for a specific application’s domain or for all routes.

Deploy in Profound UI/Genie interface

Select this option if your application is based on Profound UI or Genie interfaces (this includes Profound.js Rich Display applications). The latest versions of these interfaces include the necessary Profound AI code and do not require an additional <script> tag to be pasted into your HTML code.

(The minimum Profound UI release to support Profound AI is Version 6 Fix Pack 24.0)

Alternate Prompt Placeholder

The default placeholder is “Send a message…”. You can adjust this text when deploying your agent. Simply type a different placeholder entry and it will be reflected in the provided code snippet.

Alternate Loader Message

The default loader message when the AI Agent is processing a request is “Thinking”. You can adjust this text when deploying your agent. Simply type a different message and it will be reflected in the provided code snippet.