- 27 Aug 2024
- 4 Minutes To Read
-
Print
-
DarkLight
-
PDF
Understand how Search Works in Self Help
- Updated On 27 Aug 2024
- 4 Minutes To Read
-
Print
-
DarkLight
-
PDF
When your end user searches for content in Self Help, the search term goes through a series of algorithmic processes (described in the following article) before it can display the most relevant content.
Step 1: Analysis of the search phrase
As soon as you enter the search term, it is analyzed, and stop words such as a, at, be, but, by, for, and more are removed. Stop words do not impact the search results.
The list of stop words ignored are a, an, and, are, as, at, be, but, by, for, if, in, into, is, it, no, not, of, on, or, such, that, the, their, then, there, these, they, this, to, was, will, with
Once the stop words are removed, the search phrase is analyzed to find the exact match of the term entered using the EXACT match process. The content found as exact matches are displayed at the top of the search result.
For example:
Searching for the word 'creating' yields content with the exact word used in the following titles.
- Creating Link
- Creating a Flow
- Creating a Tag
Step 2: Stemming
After analyzing the search term, it is reduced to its root form using a process called Stemming. This is done to ensure the search word returns relevant matches to the content, increasing retrieval accuracy.
Stemming is a technique used to extract the base form of words by removing affixes from them.
For Example:
- creating after stemming is creat
- opportunities after stemming is opportunit
Even though there is no word called creat, it's that part of the word that is found in all variations of the word. Create, creating, created - all have creat in them. Thus, someone searching for any form of the word finds all content that uses any variation of the word.
Step 3: Organize the Results
Once the search phrase is analyzed, it is stored in 3 variations — Shingles, Root Word, and Keyword. They are organized in such a way as to help in displaying the most relevant results first to the user.
The term creating leads in salesforce after stemming becomes creat lead salesforce and is organized as,
Creat lead | Shingles |
---|---|
lead salesforce | Keyword |
creating | Keyword |
leads | Keyword |
salesforce | Keyword |
creat | Root Word (after stemming) |
lead | Root Word (after stemming) |
salesforce | Root Word (after stemming) |
Whenever you create content in Whatfix, it is immediately analyzed and organized in our database. This helps in reducing the processing time during the search.
Step 4: Comparison of Search Phrase and your Content
The search phrase and the Whatfix content (Flow, Smart Tip, video, Beacon) are compared and mapped.
- Terms in both the title and the body of the content are considered during the comparison. However, if the term is found in the title, it is given a higher weightage.
- In the case of Whatfix videos, only the terms in the title of the video are considered during a comparison.
For example:
The word lead is present in content1, content3, content6…
The word creat is present in content2, content3, content9… so on and so forth.
Step 5: Boosting
To decide which content to display first, the contents are scored based on the number of times the analyzed phrase is used in the content and where (position) the analyzed phrase is used.
For example, if the word creat is present in the description of flow1 and the title of flow2. Then, flow2 appears first in the search result.
This is because the title of the content (Flow, Smart Tip, Video, Beacon) has a higher weightage compared to the step title or description.
The weightage is applied in the following hierarchy.
Name of your Flow > Search Keywords > Describe your Flow > Purpose of this step > Describe the step action
Also, the weightage is higher for Shingles, followed by Keyword, and then Raw.
Shingles > Keyword > Raw
This process is called Boosting.
Step 6: Display the Result
Once the search phrase is compared with the Whatfix content and scored, the highest-scored content is displayed first.
For example,
Contents in Whatfix | Search Phrase Entered in Self Help | Results Displayed (same order as listed) |
| create lead in salesforce |
|
The example scenario used above is calculated only using the Title. The result may vary if you factor in the description, step title, and step description.
Languages supported in Self Help Search
The Self Help search supports all the languages that Whatfix supports.
However, stop words optimization and Stemming processes apply only to the following languages:
- English
- German
- Spanish
- Portuguese-Brazil
- Italian
- French
- Norwegian
- Dutch
- Add search keywords to Flows when you translate Whatfix content using the UI. This improves the visibility of your content when your end user searches for it.
- Search Keywords can be added only to Flows while translating content in the UI.
History and Suggestions in Self Help Search
- Whatfix retains 5 recently viewed contents in the Self Help widget as the search history. This means that the end user can see the search history and also consume content from this again.
- The recently viewed content keeps getting updated as the end user consumes the Whatfix content.
- The end users can see the last seen content first in the search history.
- This is visible to the end users for 90 days or until the browser cache is cleared; whichever happens earlier.
![Retained recent history SH](https://cdn.document360.io/a268766e-d74d-4619-9613-e2472f809ffb/Images/Documentation/Retained%20recent%20history%20SH.gif?sv=2022-11-02&spr=https&st=2024-09-08T02%3A35%3A45Z&se=2024-09-08T02%3A45%3A45Z&sr=c&sp=r&sig=L%2B2RMcID15IKXsyJHkIKYAh5WaQUQHBjxK%2FD5HGJqt4%3D)
To yield relevant results on Self Help, Whatfix uses a matching ability that suggests the right results, even when the search term is incomplete.
Whatfix also suggests the right search results when the search query is misspelled or mistyped. Your end users see this suggestion only if there is any content with an alternative search term that is mapped to Self Help.