GETTING STARTED
SearchAssist Overview
SearchAssist Introduction
Onboarding SearchAssist
Build your first App
Glossary
Release Notes
What's new in SearchAssist
Previous Versions

CONCEPTS
Managing Sources
Introduction
Files
Web Pages
FAQs
Structured Data 
Connectors
Introduction to Connectors
Azure Storage Connector
Confluence Cloud Connector
Confluence Server Connector
Custom Connector
DotCMS Connector
Dropbox Connector
Google Drive Connector
Oracle Knowledge Connector
Salesforce Connector
ServiceNow Connector
SharePoint Connector
Zendesk Connector
RACL
Virtual Assistants
Managing Indices
Introduction
Index Fields
Traits
Workbench
Introduction to Workbench
Field Mapping
Entity Extraction
Traits Extraction
Keyword Extraction
Exclude Document
Semantic Meaning
Snippet Extraction
Custom LLM Prompts
Index Settings
Index Languages
Managing Chunks
Chunk Browser
Managing Relevance
Introduction
Weights
Highlighting
Presentable
Synonyms
Stop Words
Search Relevance
Spell Correction
Prefix Search
Custom Configurations
Personalizing Results
Introduction
Answer Snippets
Introduction
Extractive Model
Generative Model
Enabling Both Models
Simulation and Testing
Debugging
Best Practices and Points to Remember
Troubleshooting Answers
Answer Snippets Support Across Content Sources
Result Ranking
Facets
Business Rules
Introduction
Contextual Rules
NLP Rules
Engagement
Small Talk
Bot Actions
Designing Search Experience
Introduction
Search Interface
Result Templates
Testing
Preview and Test
Debug Tool
Running Experiments
Introduction
Experiments
Analyzing Search Performance
Overview
Dashboard
User Engagement
Search Insights
Result Insights
Answer Insights

ADMINISTRATION
General Settings
Credentials
Channels
Team
Collaboration
Integrations
OpenAI Integration
Azure OpenAI Integration
Custom Integration
Billing and Usage
Plan Details
Usage Logs
Order and Invoices
Smart Hibernation

SearchAssist APIs
API Introduction
API List

SearchAssist SDK

HOW TOs
Use Custom Fields to Filter Search Results and Answers
Add Custom Metadata to Ingested Content
Write Painless Scripts
Configure Business Rules for Generative Answers

Managing Relevance

SearchAssist manages relevance by allowing you to fine-tune search parameters and prioritize query results displayed to the end-user. This helps improve the search experience by providing users with the most relevant and purposeful views and results.

Customize search results by fine-tuning the following elements. There are two dimensions of managing relevance: search parameters and results prioritization.

Search parameters

  • Weights  Each field is assigned a weight that plays an important role in ranking the results. Weights can be modified to fine-tune search relevance.
  • Synonyms  A broader range of words can help ensure the SearchAssist app identifies user queries more effectively.
  • Stop Words  Some words might dilute or mislead search results. Marking Stop Words can improve search efficacy.

Results prioritization

  • Results Ranking  Customize and preview search results as per the business needs.
  • Facets provide users with an option to refine their search results by selecting appropriate filters.
  • Business Rules  Personalize and fine-tune search results based on contexts.

Configuring Search

Search Configuration is the core of results customization. The following elements contribute to results-optimization and can be configured from Search Configuration.

SearchAssist creates a Default Search configuration. You can refine, clone and tweak it or create your own search configuration. Create multiple search configurations to test and enhance search results or cater to different regions, people groups, and contexts.

You can, for example, set a top-down experience for users searching from one region, say India, and assign a bottom-up search experience for users from another region, say the USA.

Creating Search Configurations

Follow these steps to create a custom index:

  1. Click the Indices tab on the top.
  2. On the left pane, under the Search Configuration section, click the dropdown.
  3. Click+ New Profile
  4. On the New Index Configuration dialog box, select Create New option.
  5. Enter a unique name.
  6. Click Add.

Cloning Search Configurations

Follow these steps to clone an existing search configuration:

  1. Click the Indices tab on the top.
  2. On the left pane, under the Search Configuration section, click the dropdown icon.
  3. Click New Profile.
  4. On the New Search Configuration dialog box, by default, Create New option is selected. Select Clone Configuration.
  5. Click the Search Configuration field and select an option on the drop-down menu.
  6. Click Clone.

Note: You can also click the clone icon next to the name of a configuration. Click the drop-down icon and hover over the configuration to display a list of options.

Managing Search Configurations

You can perform the following actions on an existing search configuration:

  • Mark a configuration as the Default using the star icon.
  • Clone the configuration.
  • Edit the name of the configuration.
  • Delete the index.

Adding Weights

Fields in SearchAssist are assigned weights that help calculate and determine the relevance score of search results. Search relevance can move results up or down the display by fine-tuning the weights assigned to the fields defined in the Managing Indices section.

Assigning weights to fields makes them searchable (i.e. queries are matched with the values in these fields). It also helps determine the significance of these fields when prioritizing search results.

By default, SearchAssist identifies a list of system-defined searchable fields like proximity, exact match, and popularity from the extracted documents and assigns weights to them. You can change the weights of the system-defined fields or add new searchable fields to fine-tune the search results.

Each field is assigned a weight on a scale of 0 through 10. Increasing a field’s weight increases its significance.

If you want a particular page to get more attention or project a particular item in your merchandise (like the latest edition of a book or the model of a smartphone), increase the weights associated with that page title so that it displays above other results.

On the Weights page, you can add various fields and change the weight settings of each field. Run test queries in the search bar and fine-tune your weights until the expected results appear.

Assigning Weights

Follow these steps to add a searchable field and assign a weight to it:

  1. Click the Indices menu tab.
  2. In the left pane, click Weights.
  3. Click Add Searchable Field in the top-right corner of the Weights page.
  4. On the dialog box, click the Choose field bar and select an item on the drop-down menu.
  5. Enter a description.
  6. Drag the slider to set the weight from 0 through 10.
  7. Click Add.

 

Managing Weights

SearchAssist allows you to perform the following actions on Weights:

  1. Change the weight using the slider to increase or decrease the weight.
  2. For custom fields, click the edit icon to update the description.
  3. For custom fields, click the trash icon to delete the field.
  4. Reset the weights using the Reset to Default option. This reverts the weights-configuration to the system default:
    • All the custom fields configured by you are removed.
    • Any system-defined weights that you removed are restored.
    • The weights assigned to each of the system-defined fields are restored to the default values.

 

Adding Synonyms

Synonyms are words used interchangeably to convey the same intent or sentiment. In the context of search and virtual assistants, a synonym yields the same result produced by a different query word or phrase. For example, in a banking scenario, transfer fundsmove moneypay dues, or clear dues all refer to the same intent of making a payment.

The synonyms feature lets you define a set of equivalent words or phrases that expand the range of searching documents with equivalent words thereby improving search quality.

You can add multiple synonyms for a single word. Once created, all synonyms have the same weight as the original word and can be used interchangeably in user utterances.

Synonyms in SearchAssist are further classified into:

  • Regular Synonyms  Each word in a list can replace every other word in the list. For example, consider a synonym list of [debit ⇔ pay, credit ⇔ receive, get paid]. A search for debit will find results with cards and a search for cards will find debit.
  • One-way Synonyms  A word or phrase that yields the results exactly or nearly the same as another word, but not in reverse. For example, consider the search for a car. You can search for vehicles to find a car, but not the other way round. You don’t want a car search to find all vehicles (e.g. a search for cars should not result in trucks.) You can achieve this by defining one-way synonyms [transaction  -> payment].

Adding Synonyms

Follow these steps:

  1. Click the Indices menu tab.
  2. In the left pane, click Synonyms.
  3. On the Synonyms page, click +Add Synonym.
  4. Under the Add Synonym section, select Synonym or One-way Synonym.
  5. In the text field, enter a synonym
  6. Click Save.

 

One-way Synonyms

In the case of a one-way synonym:

  1. Add the search term.
  2. Add one or more synonyms in the alternative field.
  3. Click Save.

Managing Synonyms

SearchAssist allows you to:

  1. Order the synonyms by increasing or decreasing the alphabetical order of the term name.
  2. Filter based on the type of synonym: all, one-way, synonym.
  3. Edit to add or delete terms from the synonym list.
  4. Delete a defined synonym if required.

Adding Stop Words

Stop words are common words (such as the, is, in, a, to, all) that dilute the importance of keywords in a search query. SearchAssist’s search engine is designed to ignore stop words at the query or input level. Ignoring stop words in search queries helps generate more relevant results.

SearchAssist provides an out-of-the-box solution to add and manage stop words. It comes with a default set of stop words which you can edit. You can also create your own list of stop words from scratch.

Adding New Stop Words

You can add stop words to the Default list or create a new list of stop words from scratch. Follow these steps:

  1. Click the Indices menu tab.
  2. In the left pane, click Stop Words.
  3. Click the Add Stop Words button.
  4. In the dialogue box, check the Default Stop Words option and click Continue. This page disappears as soon as you select an option.
  5. On the Stop Words page, review the list and delete unwanted words.
  6. In the Add Stop Word field, add a word. (optional)
  7. Click Add.
  8. Add multiple stop words with comma separation. (optional)

.

Managing Stop Words

  1. Enable or disable the stop words list with the toggle in the top-right corner of the page.
  2. Click the search field to look for a specific stop word.
  3. Click Reset to Default to remove custom changes.
  4. Click Delete All to remove the entire list.
  5. Click the X icon to remove a stop word from the list.

Note: If you delete all the words in the default list by accident, click Reset to Default. SearchAssist restores the default list.

Creating Facets

Facets provide a comprehensive view of search results with single or multiple search criteria or filters.

Facets allow your customers or employees to refine their search results by applying filters based on certain field values or ranges. The facets tool lets your customers or users define how to generate more precise and relevant search results. Activating a facet applies all the associated filters based on the field values and counts. The results are displayed by prioritizing the facet applied.

SearchAssist allows you to add, configure and manage facets for your SearchAssist app. You can mark any indexed field as a facet. Enabling a facet allows the search user to view the filters associated with it and get a count of matched results in the filter.

End-users can apply multiple filters simultaneously to narrow down the search results closer to their requirements. These filters fine-tune the search results and categorize listings without the need to scroll down through long lists.

For example, in an e-commerce search, a user can filter product options based on price range and color at the same time. Items with the specified color in the given price range are listed in the sought order of ascending or descending value of the pricing.

SearchAssist allows you to define two types of facets:

  • Range Facet  Filter attributes with a predefined range of values such as price and age. It returns the result within the selected range. For example, on an e-commerce website, you can apply Range Facet to show all smartphones in the $1000 to $2000 price range.
  • Value Facet  Filter attributes that are treated as labels such as color, or gender.

Configure both single-select and multi-select facets. The multi-select facet option lets users select multiple parameters in a filter. With a simple drag and drop operation on the Facets, you can customize the order in which filters are applied and displayed in the search UI.  

Adding Facets

Follow these steps:

  1. Click the Indices menu tab.
  2. On the left pane, click Facets.
  3. On the Facets page, click + Add Facet.
  4. Select a facet type: filter, sortable, or tab.

Filter Facets

Choose this option to sort data by values or numerical ranges.

  1. Click Filter facet.
  2. Click Value or Range.
  3. Click Field and select an option on the drop-down menu.
  4. Enter a unique name.

If you choose Value:

  1. Click Sort by and choose an option: Label or Count.
  2. Click Select order and choose an option: Ascending or Descending.
  3. Click the plus or minus icon to set the maximum number of facet values that the SearchAssist app displays.
  4. Switch the toggle to the Enable position to allow multiple facets. The default setting is Disabled.
  5. Click Add.

If you choose Range:

  1. Enter a unique name for the facet and range.
  2. Enter range values.
  3. Add multiple ranges. (optional)
  4. Switch the toggle to the Enable position to allow multiple facets. The default setting is Disabled.
  5. Click Add.

Sortable Facets

Choose this option to sort data in an order.

  1. Click Field and select an option on the drop-down menu.
  2. Enter a unique facet name.
  3. Click Select by and choose an option: Ascending or Descending.
  4. Click Add.

Tab Facets

Choose this option to customize the Display Name that appears as a sub-menu on the results page.

  1. Click the Tab facet menu tab.
  2. Click the Configure icon.
  3. Edit the facets and display names. (optional)
  4. Click Save.
  5. Click Save again.
  6. Click Test to review the results.

Dynamic Facets

Dynamic Facets are a built-in capability that enables the SearchAssist app to detect facets from the user’s search query and then automatically apply appropriate filters. In response to the query, the app personalizes the display of results. Dynamic facets depend on structured data like product catalogs in CSV or JSON formats.

Pre-existing custom facets, if any, have precedence and priority over dynamic facets. The business user or the search engineer has to identify which fields should be considered for dynamic faceting when uploading the structured data.

Managing Facets

SearchAssist provides the following features on the Facets page:

  1. Search for a Facet by name.
  2. Filter  Facets by Type, Selection criteria, and Status.
  3. Edit or Delete a Facet using the edit/delete icons. You can also delete facets in bulk with the Bulk Select option.
  4. Use the handlebar to specify the order in which facets are presented to the user.

Managing Relevance

SearchAssist manages relevance by allowing you to fine-tune search parameters and prioritize query results displayed to the end-user. This helps improve the search experience by providing users with the most relevant and purposeful views and results.

Customize search results by fine-tuning the following elements. There are two dimensions of managing relevance: search parameters and results prioritization.

Search parameters

  • Weights  Each field is assigned a weight that plays an important role in ranking the results. Weights can be modified to fine-tune search relevance.
  • Synonyms  A broader range of words can help ensure the SearchAssist app identifies user queries more effectively.
  • Stop Words  Some words might dilute or mislead search results. Marking Stop Words can improve search efficacy.

Results prioritization

  • Results Ranking  Customize and preview search results as per the business needs.
  • Facets provide users with an option to refine their search results by selecting appropriate filters.
  • Business Rules  Personalize and fine-tune search results based on contexts.

Configuring Search

Search Configuration is the core of results customization. The following elements contribute to results-optimization and can be configured from Search Configuration.

SearchAssist creates a Default Search configuration. You can refine, clone and tweak it or create your own search configuration. Create multiple search configurations to test and enhance search results or cater to different regions, people groups, and contexts.

You can, for example, set a top-down experience for users searching from one region, say India, and assign a bottom-up search experience for users from another region, say the USA.

Creating Search Configurations

Follow these steps to create a custom index:

  1. Click the Indices tab on the top.
  2. On the left pane, under the Search Configuration section, click the dropdown.
  3. Click+ New Profile
  4. On the New Index Configuration dialog box, select Create New option.
  5. Enter a unique name.
  6. Click Add.

Cloning Search Configurations

Follow these steps to clone an existing search configuration:

  1. Click the Indices tab on the top.
  2. On the left pane, under the Search Configuration section, click the dropdown icon.
  3. Click New Profile.
  4. On the New Search Configuration dialog box, by default, Create New option is selected. Select Clone Configuration.
  5. Click the Search Configuration field and select an option on the drop-down menu.
  6. Click Clone.

Note: You can also click the clone icon next to the name of a configuration. Click the drop-down icon and hover over the configuration to display a list of options.

Managing Search Configurations

You can perform the following actions on an existing search configuration:

  • Mark a configuration as the Default using the star icon.
  • Clone the configuration.
  • Edit the name of the configuration.
  • Delete the index.

Adding Weights

Fields in SearchAssist are assigned weights that help calculate and determine the relevance score of search results. Search relevance can move results up or down the display by fine-tuning the weights assigned to the fields defined in the Managing Indices section.

Assigning weights to fields makes them searchable (i.e. queries are matched with the values in these fields). It also helps determine the significance of these fields when prioritizing search results.

By default, SearchAssist identifies a list of system-defined searchable fields like proximity, exact match, and popularity from the extracted documents and assigns weights to them. You can change the weights of the system-defined fields or add new searchable fields to fine-tune the search results.

Each field is assigned a weight on a scale of 0 through 10. Increasing a field’s weight increases its significance.

If you want a particular page to get more attention or project a particular item in your merchandise (like the latest edition of a book or the model of a smartphone), increase the weights associated with that page title so that it displays above other results.

On the Weights page, you can add various fields and change the weight settings of each field. Run test queries in the search bar and fine-tune your weights until the expected results appear.

Assigning Weights

Follow these steps to add a searchable field and assign a weight to it:

  1. Click the Indices menu tab.
  2. In the left pane, click Weights.
  3. Click Add Searchable Field in the top-right corner of the Weights page.
  4. On the dialog box, click the Choose field bar and select an item on the drop-down menu.
  5. Enter a description.
  6. Drag the slider to set the weight from 0 through 10.
  7. Click Add.

 

Managing Weights

SearchAssist allows you to perform the following actions on Weights:

  1. Change the weight using the slider to increase or decrease the weight.
  2. For custom fields, click the edit icon to update the description.
  3. For custom fields, click the trash icon to delete the field.
  4. Reset the weights using the Reset to Default option. This reverts the weights-configuration to the system default:
    • All the custom fields configured by you are removed.
    • Any system-defined weights that you removed are restored.
    • The weights assigned to each of the system-defined fields are restored to the default values.

 

Adding Synonyms

Synonyms are words used interchangeably to convey the same intent or sentiment. In the context of search and virtual assistants, a synonym yields the same result produced by a different query word or phrase. For example, in a banking scenario, transfer fundsmove moneypay dues, or clear dues all refer to the same intent of making a payment.

The synonyms feature lets you define a set of equivalent words or phrases that expand the range of searching documents with equivalent words thereby improving search quality.

You can add multiple synonyms for a single word. Once created, all synonyms have the same weight as the original word and can be used interchangeably in user utterances.

Synonyms in SearchAssist are further classified into:

  • Regular Synonyms  Each word in a list can replace every other word in the list. For example, consider a synonym list of [debit ⇔ pay, credit ⇔ receive, get paid]. A search for debit will find results with cards and a search for cards will find debit.
  • One-way Synonyms  A word or phrase that yields the results exactly or nearly the same as another word, but not in reverse. For example, consider the search for a car. You can search for vehicles to find a car, but not the other way round. You don’t want a car search to find all vehicles (e.g. a search for cars should not result in trucks.) You can achieve this by defining one-way synonyms [transaction  -> payment].

Adding Synonyms

Follow these steps:

  1. Click the Indices menu tab.
  2. In the left pane, click Synonyms.
  3. On the Synonyms page, click +Add Synonym.
  4. Under the Add Synonym section, select Synonym or One-way Synonym.
  5. In the text field, enter a synonym
  6. Click Save.

 

One-way Synonyms

In the case of a one-way synonym:

  1. Add the search term.
  2. Add one or more synonyms in the alternative field.
  3. Click Save.

Managing Synonyms

SearchAssist allows you to:

  1. Order the synonyms by increasing or decreasing the alphabetical order of the term name.
  2. Filter based on the type of synonym: all, one-way, synonym.
  3. Edit to add or delete terms from the synonym list.
  4. Delete a defined synonym if required.

Adding Stop Words

Stop words are common words (such as the, is, in, a, to, all) that dilute the importance of keywords in a search query. SearchAssist’s search engine is designed to ignore stop words at the query or input level. Ignoring stop words in search queries helps generate more relevant results.

SearchAssist provides an out-of-the-box solution to add and manage stop words. It comes with a default set of stop words which you can edit. You can also create your own list of stop words from scratch.

Adding New Stop Words

You can add stop words to the Default list or create a new list of stop words from scratch. Follow these steps:

  1. Click the Indices menu tab.
  2. In the left pane, click Stop Words.
  3. Click the Add Stop Words button.
  4. In the dialogue box, check the Default Stop Words option and click Continue. This page disappears as soon as you select an option.
  5. On the Stop Words page, review the list and delete unwanted words.
  6. In the Add Stop Word field, add a word. (optional)
  7. Click Add.
  8. Add multiple stop words with comma separation. (optional)

.

Managing Stop Words

  1. Enable or disable the stop words list with the toggle in the top-right corner of the page.
  2. Click the search field to look for a specific stop word.
  3. Click Reset to Default to remove custom changes.
  4. Click Delete All to remove the entire list.
  5. Click the X icon to remove a stop word from the list.

Note: If you delete all the words in the default list by accident, click Reset to Default. SearchAssist restores the default list.

Creating Facets

Facets provide a comprehensive view of search results with single or multiple search criteria or filters.

Facets allow your customers or employees to refine their search results by applying filters based on certain field values or ranges. The facets tool lets your customers or users define how to generate more precise and relevant search results. Activating a facet applies all the associated filters based on the field values and counts. The results are displayed by prioritizing the facet applied.

SearchAssist allows you to add, configure and manage facets for your SearchAssist app. You can mark any indexed field as a facet. Enabling a facet allows the search user to view the filters associated with it and get a count of matched results in the filter.

End-users can apply multiple filters simultaneously to narrow down the search results closer to their requirements. These filters fine-tune the search results and categorize listings without the need to scroll down through long lists.

For example, in an e-commerce search, a user can filter product options based on price range and color at the same time. Items with the specified color in the given price range are listed in the sought order of ascending or descending value of the pricing.

SearchAssist allows you to define two types of facets:

  • Range Facet  Filter attributes with a predefined range of values such as price and age. It returns the result within the selected range. For example, on an e-commerce website, you can apply Range Facet to show all smartphones in the $1000 to $2000 price range.
  • Value Facet  Filter attributes that are treated as labels such as color, or gender.

Configure both single-select and multi-select facets. The multi-select facet option lets users select multiple parameters in a filter. With a simple drag and drop operation on the Facets, you can customize the order in which filters are applied and displayed in the search UI.  

Adding Facets

Follow these steps:

  1. Click the Indices menu tab.
  2. On the left pane, click Facets.
  3. On the Facets page, click + Add Facet.
  4. Select a facet type: filter, sortable, or tab.

Filter Facets

Choose this option to sort data by values or numerical ranges.

  1. Click Filter facet.
  2. Click Value or Range.
  3. Click Field and select an option on the drop-down menu.
  4. Enter a unique name.

If you choose Value:

  1. Click Sort by and choose an option: Label or Count.
  2. Click Select order and choose an option: Ascending or Descending.
  3. Click the plus or minus icon to set the maximum number of facet values that the SearchAssist app displays.
  4. Switch the toggle to the Enable position to allow multiple facets. The default setting is Disabled.
  5. Click Add.

If you choose Range:

  1. Enter a unique name for the facet and range.
  2. Enter range values.
  3. Add multiple ranges. (optional)
  4. Switch the toggle to the Enable position to allow multiple facets. The default setting is Disabled.
  5. Click Add.

Sortable Facets

Choose this option to sort data in an order.

  1. Click Field and select an option on the drop-down menu.
  2. Enter a unique facet name.
  3. Click Select by and choose an option: Ascending or Descending.
  4. Click Add.

Tab Facets

Choose this option to customize the Display Name that appears as a sub-menu on the results page.

  1. Click the Tab facet menu tab.
  2. Click the Configure icon.
  3. Edit the facets and display names. (optional)
  4. Click Save.
  5. Click Save again.
  6. Click Test to review the results.

Dynamic Facets

Dynamic Facets are a built-in capability that enables the SearchAssist app to detect facets from the user’s search query and then automatically apply appropriate filters. In response to the query, the app personalizes the display of results. Dynamic facets depend on structured data like product catalogs in CSV or JSON formats.

Pre-existing custom facets, if any, have precedence and priority over dynamic facets. The business user or the search engineer has to identify which fields should be considered for dynamic faceting when uploading the structured data.

Managing Facets

SearchAssist provides the following features on the Facets page:

  1. Search for a Facet by name.
  2. Filter  Facets by Type, Selection criteria, and Status.
  3. Edit or Delete a Facet using the edit/delete icons. You can also delete facets in bulk with the Bulk Select option.
  4. Use the handlebar to specify the order in which facets are presented to the user.