AIS | AI Search general troubleshooting and debugging - Support and Troubleshooting

AIS | AI Search general troubleshooting and debugging  Description This article talks about the basic troubleshooting and debugging steps for working on AIS issues

Troubleshooting and Debugging AI Search 1. In order to turn on the logs, From the filter navigator System Diagnostics > Debug AI Search You can see similar debug messages below

2. You could check for logs by navigating to AI Search > All or AI Search > Ingestion Warnings & Errors. Refer AI Search logging and debugging

3. Use Search Preview UI by installing the application Advanced AI Search Management Tools and once the app is installed Navigate to Ai Serch > Preview > Search Preview

3. a. Choose the search profile on the dropdown on the top left

3.b. In the field which says 'Search here' enter the search term > Hit 'Search' button

4. check localhost logs as well.

5. If you would like to test the search query for an NLU model, you could search from "Scripts - background' and check the results and debug logs

//Enter the solution name you are testing in the line #1 like ml_x_snc_sn_km_mr_global_ais_gra_b8bc699a67621010b3d782f45685efa5

var geniusSearchSolutionName = ' enter the solution name ';

var searchQuery = new sn_ml.GeniusSearchQuery("abraham lincoln");

var searchContext = new sn_ml.GeniusSearchContext({"session" : ""});

var geniusSearchSolution = sn_ml.GeniusSearchSolutionStore.get(geniusSearchSolutionName)

geniusSearchSolution = sn_ml.GeniusSearchSolutionStore.get(geniusSearchSolutionName);

var result = geniusSearchSolution.search(searchQuery, searchContext, {});

gs.print(JSON.stringify(JSON.parse(result), false, 4));

6. Along with the Search Preview UI, you can use the below script to debug the results with search profile or narrow down the search issue. The AISASearchUtil API below is unsupported and should only be used for debugging purposes.

//Make changes to the searchParams based on your requirements. //Just need to change searchContextConfigId and searchTerm to get started.

searchParams = { searchContextConfigId: '00731b9d5b231010d9a5ce1a8581c7dd', //sys_id of the Search Application configuration[sys_search_context_config] record that you want to use for searching. searchTerm: '***', // The search term *** returns all records that have been indexed. paginationToken: '', // Leaving paginationToken empty returns the data for the first page. To get the paginationToken for 2nd page, click the next page button on the portal after doing the search and check the URL for paginationToken. disableSpellCheck: false, facetFilters: [], searchFilters: [], requestedFields: {}, rpSysId: 'test' // Just a dummy value that is needed for the script to work. };

var aiSearchUtil = new AISASearchUtil(); var result = aiSearchUtil.search(searchParams);

var searchResult = result.data.search.searchResults;

gs.info(searchResult.length);

for (var i=0; i gs.info(searchResult[i].title + " | " + searchResult[i].text); }

gs.info(JSON.stringify(result));

//Note: Ensure that search sources have been indexed before trying to search. Common spot checks to perform if AI Search does not display search results: 1. Check if AI Search is enabled ' glide.ais.enabled ' should be set to true. and also check AI Search > Connection > Test Connection

If there are any connection issues, please reach out to Tech Support 2. If the Genius results are not being returned check if ' glide.ais.genius_result.enabled ' is set to ' true ',

2.a. Check if facet is clicked and then genius result is not displayed then check 'glide.ais.genius_result.enabled_with_facet_filter' to false

2.b. If for any non-English language Genius results are not working, because it's not supported. Genius results is supported only for English even though AI Search supports several languages Refer Internationalization support for AI Search

2.c. If the Genius result is not working check if there is an EVAM configuration is added for the corresponding Genius result. For example Peoplefind Genius result will not work unless you add one manually in sys_ux_composite_data_template_predicate_bundle , See EVAM Configuration

3. If the expected results are not displayed > then check the following

3.a. Check if the correct ' Search Profile ' is being linked

3.b. Check if the ' Search Profile ' is ' Published ' if not publish again and retest

4. If the expected results are not present, check the ' Search Source ' filter condition. For example, if a 'search source' filters out certain records, then those records would never show up in the results. Other reasons would be ACL , Domain Separation , User Criteria and Before Query Business Rules .

5. If expected number of results are not displayed, go to the Search application configuration (sys_search_context_config) and check the search results limit

Other issues with AI Search: 1. Check if Edge encryption, Encryption support is enabled since this is not supported as of Quebec

2. If any event-related issue Event queue where all event starts with "ais_index"

3. For any performance-related issues identify the content security features that are being applied to search results.

•Are there many User Criteria being evaluated? •Are there many ACLs on the tables that are being searched? Be careful when testing AI Search performance in cloned non-production instances. The same dedicated AI Search nodes handle search query traffic from all of your instances. As a result, search queries on non-production instances may impact search query performance in your production instance. 4. If AI Search modules are missing, see if you had a recent clone, contact Tech Support and you may also refer them to KB0967216( This is a Servicenow internal KB) 5. If you can not enable AI Search for certain Service Portals, Then likely it is not available. AI Search can be enabled for all custom created Portals however for OOB portals/Store portals if it's available it will be enabled by default. 6. Task,cmdb related tables and other tables in the zing block list can not be indexed with the exception of sc_cat_item and kb_knowledge. If a parent table is indexed and all the child tables should also be manually added and indexed. Reference AI Search

AI Search reference

AI Search logging and debugging

Search Preview UI

Advanced AI Search Management Tools