Search Preview UI for AI Search
The Search Preview UI enables you to test AI Search queries using settings from a selected search profile. Administrator tools help you review search query performance data and feedback, debug queries, and override default query settings for testing purposes.
Access the Search Preview UI by navigating to AI Search > Preview > Search Preview.
Required ServiceNow AI Platform® roles
- The ais_admin role is required to view and use the Search Preview UI.
- The impersonator role is required for some AI Search administrator tools.
- The ais_high_security_admin role is required to bypass search source and content security filtering. For details on this procedure, see Diagnose search result access issues using the Search Preview UI.
Search Preview UI components
Image omitted: adv-ais-mgmt-search-preview.png
Sample Search Preview UI screen displaying sales laptop search query results.
Sample Search Preview UI screen displaying sales laptop search query results.
| Component | Description | |
|---|---|---|
| 1. Search profile list | Select the search profile to apply when previewing search queries. The list only includes published search profiles that have one or more linked search sources. Note: If a search profile has unpublished changes, the list displays a warning icon Image omitted: icon-warning-circle.png 2. Search input fieldand shows <code>[DRAFT]</code> after the profile's name. Publish the search profile to see these changes reflected in the search query preview.</p></td></tr><tr><td> | Enter search query terms and operators in this field. To preview the query's results using settings from the selected search profile, select Search. |
| 3. Table facet filter | View the distribution of search query results by source table. To filter the query results by table, select a table's name. To remove the table facet filter, select All. | |
| 4. Genius Result answers | Review the key-value pairs for each Genius Result answer the search query produces when executed with the selected search profile.Note: Genius Result answers may not appear for all search queries. | |
| 5. Search query results | Review the results the search query produces when executed with the selected search profile. To page through results, select Next or Previous. | |
| 6. AI Search administrator tools | Select the icon for the administrator tool that you want to use:- Process data tool Image omitted: icon-help.png - Alerts tool : View summary information on the search query's triggered result improvement rules, matched NLU model intents, and processing time. Image omitted: icon-alert.png - Dictionary and query feedback tool : Review alert feedback messages produced during processing of the search query. Image omitted: icon-book-open.png - Context settings tool : Review dictionary and query feedback messages and NLU model intent data for the search query. Enable debugging. Image omitted: icon-boolean.png - User impersonation tool : Specify user context values for the search query to trigger result improvement rules. Image omitted: icon-user.png For more detailed descriptions of each administrator tool's output, controls, and fields, see the following reference section.: Change the search query's user or locale to test access settings and view translated documents. |
Search preview admin tools
Understand the output, controls, and fields provided by admin tools in the search preview UI.
Process data tool
| Entry | Description |
|---|---|
| Query Rules Triggered | Count of result improvement rules triggered by the search query. |
| Intents Matched | Count and names of NLU model intents detected in the search query. |
| Total time | Total time spent processing the search query. Includes pre-processing, search query, Genius Result computation, and security processing times. |
| Pre-processing time | Time spent preparing the search query for execution. Includes time spent looking up the user's access permissions for content security. |
| Search query time | Time spent retrieving records that match the search query and generating the result set. |
| Genius Result computation | Time spent computing Genius Result answers for the search query. |
| Security processing time | Time spent filtering inaccessible records out of the search query's result set based on the user's access permissions. |
Alerts tool
This tool displays a list of alert feedback messages produced while processing the search query.
If the search query produced no alert feedback messages, the tool instead displays No Alert Feedback.
Dictionary and query feedback tool
This tool displays separate panes for dictionary feedback entries and query feedback controls.
| Entry | Description |
|---|---|
| Stop words | List of feedback messages relating to stop word removal for the search query. |
| Spellcheck | List of feedback messages relating to typo handling auto-correction for the search query. |
| Synonyms | List of feedback messages relating to synonym expansion for the search query. |
| Control | Description |
|---|---|
| Show all feedback | Display a JSON array of feedback messages produced for the search query. |
| Show all intent data | Display a JSON array of NLU model intents detected in the search query.Note: To use this tool, you must have the impersonator role. |
| Debug | Enable this option to set sysparm_debug to true when submitting search preview queries.Note: To use this tool, you must have the impersonator role. |
Context settings tool
With these tools, you can specify user context values to test user context triggers for result improvement rules.
| Field | Description |
|---|---|
| User Domain | To set a domain in the user context for search preview, enter the name of a group from the Group [sys_user_group] table. |
| User Company | To set a company in the user context for search preview, enter the name of a company from the Company [core_company] table. |
| User Office | To set an office in the user context for search preview, enter the name of a building from the Building [cmn_building] table. |
| User Department | To set a department in the user context for search preview, enter the name of a department from the Department [cmn_department] table. |
| User Title | To set a title in the user context for search preview, select it from the list. This list includes all Title values found in the User [sys_user] table. |
| User Location | To set a location in the user context for search preview, enter the name of a location from the Location [cmn_location] table. |
| User Role | To set a role in the user context for search preview, enter the name of a role from the Role [sys_user_role] table. |
| User Country | To set a country in the user context for search preview, select it from the list. This list includes all countries found in user locations from the User [sys_user] table. |
| User Language | To set a language in the user context for search preview, select it from the list of supported languages. |
| User Office Country | To set an office country in the user context for search preview, select it from the list. This list includes all countries found in user locations from the User [sys_user] table. |
| User Office City | To set an office city in the user context for search preview, enter it in this field. You can enable session debugging for AI Search to review values submitted for this user context field in user queries. |
| User Office State | To set an office state in the user context for search preview, enter it in this field. You can enable session debugging for AI Search to review values submitted for this user context field in user queries. |
| User OS | To set an operating system in the user context for search preview, enter its name in this field. You can enable session debugging for AI Search to review values submitted for this user context field in user queries. |
| User Device Type | To set a user device type in the user context for search preview, enter it in this field. You can enable session debugging for AI Search to review values submitted for this user context field in user queries. |
| User OS Version Type | To set an operating system version type in the user context for search preview, enter it in this field. You can enable session debugging for AI Search to review values submitted for this user context field in user queries. |
| User Browser Agent | To set a browser agent string in the user context for search preview, enter it in this field. You can enable session debugging for AI Search to review values submitted for this user context field in user queries. |
| User Browser | To set a browser name in the user context for search preview, enter it in this field. You can enable session debugging for AI Search to review values submitted for this user context field in user queries. |
| User Device Form | To set a device form in the user context for search preview, enter it in this field. You can enable session debugging for AI Search to review values submitted for this user context field in user queries. |
User impersonation tool
| Field | Description |
|---|---|
| Search as | To submit search preview queries as another user, enter the user's name from the User [sys_users] table. You must have the impersonator role. Use this control to see how content security affects search query results for specific user accounts. Searches performed while impersonating another user don't affect the Search users metric, trend, and report on the AI Search Analytics dashboard. Note: Changing the value of this field terminates elevated privileges for the ais_high_security_admin role. To bypass filters after changing this field's value, you must re-elevate to the ais_high_security_admin role. |
| Query Locale | To submit search preview queries using a specific supported language, select the language from the list. Use this control to observe differences in search query results for different languages. |