Skip to main content

Solr Auto Suggester With Sitecore

Solr Auto Suggester With Sitecore

What is a Solr Suggester?

The Solr suggester component provides automatic suggestions to users, just like Google provides suggestions. Solr has a suggester component which is called SuggestComponent. More detail is available here

solr search suggester

















Configuration the SuggesterComponent

Navigate to this location “SolrFolder\server\solr\configsets\INDEXNAME \conf” and open “solrconfig.xml”. Search below comment in “solrconfig.xml” file.

 <!-- SearchHandler  
     http://wiki.apache.org/solr/SearchHandler  
     For processing Search Queries, the primary Request Handler  
     provided with Solr is "SearchHandler" It delegates to a sequent  
     of SearchComponents (see below) and supports distributed  
     queries across multiple shards  
   -->  
and paste the below code:
 <searchComponent name="suggest" class="solr.SuggestComponent">   
   <lst name="suggester">  
   <str name="name">contentSuggester</str>  
   <str name="lookupImpl">AnalyzingInfixLookupFactory</str>  
   <str name="dictionaryImpl">DocumentDictionaryFactory</str>  
   <str name="field">title_t</str>  
   <str name="contextField">_template</str>   
   <str name="suggestAnalyzerFieldType">text_general</str>  
   <str name="buildOnStartup">false</str>  
      <str name="highlight">false</str>  
  </lst>   
 </searchComponent>  

Adding the Suggest Request Handler

 <requestHandler name="/suggest" class="solr.SearchHandler" startup="lazy">  
  <lst name="defaults">  
   <str name="suggest">true</str>  
   <str name="suggest.count">10</str>  
       <str name="suggest.dictionary">contentSuggester</str>  
  </lst>  
  <arr name="components">  
   <str>suggest</str>  
  </arr>  
 </requestHandler>  
After this do not forget to reload Solr. 

To test Solr search suggester please follow the below steps:
  • Go to Solr console.
  • Select Core from “Core Selector”.
  • Click on Query.
  • Now type “/suggest” in Request-Handler(qt) .
  • And type keyword in “q” which you want to search, in my case I am searching “sitecore” keyword.
  • At last click on the “Execute Query” button.
  • Now you can see results in which “sitecore” keyword is matched in the “_name” field.
solr seach suggester

If you want to filter value on basis of “contextField” which is a “_template” in my case then you can pass value in “suggest.cfq” just like this:

https://localhost:8988/solr/sc101_custom_master_index/suggest?q=sitecore&suggest.cfq=455a3e98a6274b408035e683a0331ac7

Create Helper class

  • Add reference of below DLLs:
    • SolrNet.dll
    • Sitecore.ContentSearch.dll
    • Sitecore.ContentSearch.SolrProvider.dll
    • Sitecore.ContentSearch.SolrNetExtension.dll 
  • Import the following namespaces:
    • System.Collections.Generic
    • System.Linq
    • Sitecore.ContentSearch
    • Sitecore.ContentSearch.SolrNetExtension
    • Sitecore.ContentSearch.SolrProvider.SolrNetIntegration
Write below code, it will return a list of string:

 public IEnumerable<string> GetSearchSuggestion(string searchTerm,string templateId)  
 {  
   using (var ctx = ContentSearchManager.GetIndex("sc101_custom_master_index").CreateSearchContext())  
   {  
     SolrSuggestQuery q = searchTerm;      
     var options = new SuggestHandlerQueryOptions  
     {  
       Parameters = new SuggestParameters  
       {  
         Count = 10,  
         Build = true,  
                     ContextFilterQuery = templateId  
       }  
     };  
     var result = ctx.Suggest(q, options);  
     return result.Suggestions["contentSuggester"].Suggestions.Select(a => a.Term);  
   }  
 }  

Comments

Popular posts from this blog

Sitecore 10.2 - “Failed to start service ‘Sitecore Marketing Automation Engine’” on Windows 11

Sitecore 10.2 - “Failed to start service ‘Sitecore Marketing Automation Engine' ” on Windows 11 Today I started to install Sitecore 10.2 using Sitecore Instance Manager on Windows 11 and I got this issue “Failed to start service ‘Sitecore Marketing Automation Engine' ” . Error : On event viewer it was showing the below error: I also tried to run ‘ Sitecore.MAEngine.exe ’ like this C:\Windows\system32>C:\inetpub\wwwroot\sclocal102xconnect.dev.local\App_Data\jobs\continuous\AutomationEngine\Sitecore.MAEngine.exe Which was throwing below error: Starting Marketing Automation Engine... 2022-01-29 22:21:11 ERR Error initializing XConnect client. System.AggregateException: One or more errors occurred. ---> Sitecore.XConnect.XdbCollectionUnavailableException: An error occurred while sending the request. ---> System.Net.Http.HttpRequestException: An error occurred while sending the request. ---> System.Net.WebException: The underlying connection was closed: An unexpected err...

Sitecore Custom API Issue with Federation Authentication

Sitecore Custom API Issue with Federation Authentication In earlier segments, detailed in Part 1 and Part 2 of the blogs on Keycloak Integration with Sitecore, I introduced Keycloak functionality for CM login. Concurrently, I addressed a necessity to develop custom APIs for retrieving Sitecore users and roles. Following the development of custom APIs, during authentication failures, the API erroneously returned a status code of 200 instead of 401. The problem arose because API requests were being routed through the "owin.identityProviders" pipeline, which was not intended for API usage. Solution: When OWIN identifies a 401 response and the AuthenticationMode is set to "Active," it fails to capture the URL hash included in the request. Another choice is to activate the "Passive" AuthenticationMode, wherein OWIN refrains from actively intercepting 401 responses. In passive mode, your application needs to explicitly issue a Challenge to trigger the OWIN aut...

Azure AD Integration with Sitecore 10.2

 Azure AD Integration with Sitecore 10.2 Sitecore identity server that comes with Sitecore 9.1 allows you to log in through an external identity provider like Azure Active Directory, Facebook, Apple, or Google. It is built on Federation Authentication. What is Federation Authentication? Federation authentication is a technology to allows users to access multiples application, tools, and domains using one credential. Using one set of credential user can access multiple applications, and resources after authentication.  Federation authentication consists of two systems, the Identity provider and the Service provider. Identity providers that maintain/create/manage identity information like name, email address, device, and location. Some examples of identity providers are Azure AD, Google, Facebook, and Apple. Service providers basically refer to a website, software, or app that the user is trying to access and SP basically relies on the identity provider to authenticate the user ...