Search settings
The Search configuration decides which tag the search box uses and what happens when the user presses Enter on the bundled GUI.
| Field | Type | Default | Description |
|---|---|---|---|
tag | string | Only agents carrying this tag are matched. Default is an empty string, which matches all tags. | |
searchBehavior | "executeTopMatch" | "executeOnlyMatch" | "showResults" | "executeTopMatch" | Decides what happens when the user hits enter on a new search. |
followupBehavior | "executeTopMatch" | "executeOnlyMatch" | "showResults" | "executePrevious" | "executeTopMatch" | Decides what happens when the user hits enter on a followup. |
Leave tag empty and the search box searches agents of every tag. Set a tag and only agents carrying that tag are matched. See Tags.
Search behavior
| Value | Meaning |
|---|---|
executeTopMatch | Always execute the top match (Default) |
executeOnlyMatch | When there is a single match, execute automatically. If there are more, show them to the user. |
showResults | Even when there is a single match, show it to the user. Do not run automatically. |
A search returns one, two or three agents, or none; see How matching works. The default setting runs the top match at once. The other two settings turn the results into choices. executeOnlyMatch still runs a single match without asking. showResults always waits for the user.
Follow-up behavior
A follow-up is a query typed into an existing conversation. The previous agent is the agent that answered last.
| Value | Meaning |
|---|---|
executeTopMatch | Always execute the top match. If there are no matches, execute the previous (Default) |
executeOnlyMatch | When there is a single match, execute automatically. If there are more, show them to the user. Add the previous agent to the end, if it doesn't exist in the search results. |
showResults | Even when there is a single match, show it to the user. Do not run automatically. Also, append the previous agent to the list at the end, if it does not already exist in the search results. |
executePrevious | Always execute the same agent in a conversation |
The first three settings search the follow-up like a new query, with the previous agent as the fallback. Under the default setting, the previous agent answers when nothing else matches. Under the two choice settings, the previous agent is added to the end of the choices. executePrevious never searches a follow-up: the conversation stays on the agent that started it.
Changes take effect on the next search. Search settings are edited under Agents → Search by a developer or an administrator.
Custom GUI / Chat interface
These setting can be safely ignored when you develop your own search UI or when you create a chat integration.