IMPORTANT: This feature is currently in beta. During this time, the user experience is actively in development and subject to change.
As you test this feature, your feedback is welcome. Send your thoughts and suggestions to uxfeedback@higherlogic.com.
This article describes the AI Search Agents page where you can create and manage (edit, deactivate, delete) your account's AI Search Agents.
AI Search Agents are custom-built "search assistants" that you can enable in your community so that your community users get search results that are more focused. This focus is the result of you being able to configure your AI Search Agents to target subsets of your community content based on community name, type of content, and/or tags that have been applied to the content.
In order to be able to use AI Search Agents:
- a Super Admin in your account must review and accept the AI Terms and
- the AI Assistant & AI Search feature has to be enabled.
TIP: Both of these actions are taken on the AI Features page in the Admin interface.
NOTE: This article assumes that the terms have been accepted and the feature has been enabled:
Access the AI Search Agents page
The AI Search Agents page is where you manage all aspects of your community's unique AI Search Agents.
To access your AI Search Agents:
- In the Admin Toolbar, click Admin.
- Navigate to AI Features > AI Search Agents.
The out-of-the-box search agent, Standard Search Agent, already populates the AI Search Agents list page.
Standard Search Agent is a system search agent and, as such:
- It cannot be edited or deleted; this ensures that there is always at least one search agent in your account from which you can create others.
- It can be the basis for custom agents that you create and which can be edited (customized).
Manage the display
The AI Search Agents list page has a row for each search agent and several default columns. You can manage what data display on the page and how.
- Click the "entries" dropdown below the list to set how many agents display per page.
- Click the column count below the list to add and remove columns in the current view.
- Click the page navigation in the bottom right to access additional list pages, if there are any.
- Click the following column headers to sort the list on that column; click the header again to reverse the sort order. An arrow icon (↑ or ↓) in a header indicates that column is sorted on and the sort order.
-
- Agent
- Agent Code
- Type
- Updated On
- Last Updated By
Let's look at how to create a search agent and then how to manage your agents on the list page.
Create a Search Agent
- Click the plus sign icon to the right of the page title to open the Create Agent overlay dialog.
- Click the Base Agent dropdown and select an existing agent from which to build your new AI agent, and click Next.
NOTE: If you have selected an agent in the list (the row is shaded) and you click Create, that agent prepopulates the Base Agent field; you can select a different base agent from the dropdown.
On the Create/Edit dialog, configure the following settings to create your agent.
Setting | Description |
---|---|
Agent Name | Specify an "internal identifier" for this custom agent. Search Agent names can contain numerals and special characters. |
Display Name | Specify a "friendly" name (e.g., Community Search Assistant) that displays to members in the community. Display names can contain numerals and special characters. |
Recipe Code | This is a Higher Logic-only field. |
Initial Message | Accept the default text or specify a "welcome" message that displays to members when they encounter this agent in the community. The maximum is 280 characters.
TIP: If you accept the default text, consider changing "I'm your AI Assistant" to the Display Name you've specified. |
Additional Instructions | You can append additional instructions to the system agent's prompt (i.e., effectively saying "...and do these things as well.").
NOTE: Your instructions could alter the context or accuracy of the responses provided, so be sure that supplementary prompts align with your intended search. |
Agent Description (optional) | Provide information that makes clear to community users the purpose of this agent. This is especially useful if you're running multiple Search Agents in the community. |
Filters | You can apply one or more filters as "data limiters" for the agent; filters limit which data the agent can access. Refer to Filters, below, to learn how to use filters with a Search Agent. |
Filters
You can apply filters to a Search Agent in order to limit which data it can access.
NOTE: Filtering is inclusive. This means, for example, that the communities you select in the Communities filter are the only communities that the agent can search in. If you do not select a community in the Communities filter, the agent can search in all of your communities.
Choose the (Current Community) option to have the agent restrict its search to only the content in the community in which the widget is embedded.
You can filter by one or more Locations and/or Content Types and/or Tags. Configure the agent with whatever combination of filters you want.
Multiple filters explained and examples
Before setting filters for AI Search Agent, it's a good idea to understand how they are going to work when a community user does a search.
In the following examples, assume the user is searching on the phrase "super forum sessions".
Multiple selections in one field of a filter
-
Filter: Location
- Field: Communities = Community-A and Community-B
- Result: AI Search Agent will look for "super forum sessions" in Community-A and Community-B only.
Multiple selections in multiple fields of a filter
-
Filter: Location
- Field: Communities = Community-A and Community-B
- Field: Microsites = Microsite-1
- Result: AI Search Agent will look for "super forum sessions" in Community-A and Community-B and Microsite-1.
Multiple selections in multiple filters
-
Filter: Location
- Field: Communities = Community-A and Community-B
- Field: Microsites = Microsite-1
-
Filter: Content
- Field: Content Types = Discussion Posts
- Result: AI Search Agent will look for "super forum sessions" in all discussion posts only (not blogs, announcements, events, etc.) in Community-A and Community-B and Microsite-1.
Location
Click into the fields to choose one or more Microsites, Communities, and/or Standalone Libraries.
Content
Click into these fields to choose one or more Content Types and/or External Content Types.
Tags
Click into this field to choose one or more Formal Tags.
Manage the Search Agents
The AI Search Agents list page has several management options in the upper right with which you can manage your Search Agents. You have to select an agent in order to enable the management buttons.
When you select an agent, it's dedicated Preview Panel flies in on the right side of the page.
To manage an agent, click its row to select it, then click:
-
Deactivate - to deactivate the agent. A confirmation message at the top of the page indicates that any affected widgets will now use the default agent.
- The checkmark is removed from the Active column and the button updates to Activate whenever this agent is selected.
- When you activate an agent, a confirmation message displays at the top of the page.
NOTE: A re-activated agent that had been deactivated does not reclaim its prior widgets.
-
Edit - to open the Create/Edit overlay dialog.
- You can change any of the agent's properties (refer to the table in the Create a Search Agent section) and any of the filters (refer to Filters, above).
- Delete - to delete the agent.
IMPORTANT: Deleting a Search Agent is an irrevocable action. After confirming the deletion, you cannot "undelete" the agent. Deactivate might be the better option.
-
- Review the "default agent" information on the confirmation prompt; click Delete to continue.
- A confirmation message at the top of the page confirms the deletion.
Search field
You can use the search feature to quickly locate a Search Agent or several Search Agents that have something in common.
- Click the magnifying glass icon to expand the search field.
- The search queries the Agent and Display Name columns.
- Type letters, numerals, and/or special characters in the field; the search is initiated on the first typed character.
- The list automatically updates with each typed character and displays all records that contain a match. The results become more refined with additional characters.
- Click the X to clear the search field and restore the original list.
Preview Panel
When you select a Search Agent on the list, the Preview Panel "flies" in on the right side of the browser; it displays information that is unique to the selected agent.
- The Preview Panel is an easier way to review the agent's settings and properties than editing the agent to review them on the Create/Edit dialog.
- The panel displays the same information as the list columns.
- The panel also conveniently displays other information, such as which filters are applied (as opposed to just indicating Filtered in the list) and the content in the Initial Message, Additional Instructions, and Agent Description fields.
- Click a different agent's row to open its Preview Panel.
- Click a selected row again, or the X, to close the Preview Panel.