About User Experience Tuning Stages

Tip: Tuning stages were formerly referred to as "Pipeline" stages.

You can use SmartHub User Experience Tuning stages to further refine your metadata.

Tuning Stage Key Facts

Note the following basic information about Tuning stages:

Tuning stages can offer uniformity to the end user
- Each of the various tuning stages provide a different function
Tuning stages can apply to all of the active search engines in SmartHub (Global), or to specific search engines
- Global Tuning stages run before search engine-specific tuning stages run.
- Most Tuning stages are search-engine specific!!!!
- See Tuning Categories: Global and Search Engine , below
Tuning stages are set as one or both of the following two types:
- Query
- Results
Most Tuning stages require BOTH a Query and Results stage.
- Tuning stages that require both stages describe this requirement in the tuning stage description found in the Tuning stage dialogue box.
  - See Tuning Categories: Global and Search Engine , below.
The various Tuning stages are accessible from the drop-down menu in the tunings dialogue box that appears when adding a Query or Results Tuning stage.
- Example: "Search engine-specific Tuning Stage," below.
Tuning stages are used to do things like map names and values to match local refinements
- Different content sources use different names and values for a given term such as "date," or "title"
- Tuning stages such as the Property Mapper stage map these names and values
See Example: Achieving Term Uniformity section below

For a walk-through of the Tuning stage tool and further explanation, see the following video: Introduction to BA Insight SmartHub Pipelines

In the example below, the SmartHub Property Mapper tuning stage maps two terms:

This results in SmartHub users discovering consistent results when searching content across different content sources.

Tuning stages are one of two categories:

Order of Tuning Stages:

Global Tuning stages run first.
Search engine-specific Tuning stages run second. Most Tuning stages are search engine-specific!!!

Search engine-specific Tuning Stage

Tuning stages are available (and typically, must be created) as two different types of stages

The various available tuning stages (typically available as both Query and Results type), and their functions, are listed below.

See the individual tuning stage descriptions in the user interface for additional information.

Property Mapper
- Translates named properties to map them to an existing property on a specific search engine.
- In order to get results, this stage must be added to both the Query and Results stages.
Refinement Mapper
- Maps search engine refinement names and values to match the local refinements.
- In order to get the expected results, this tuning stage must be added to both the Query and Results stages.
NLQ Processing Stage
- Extracts information from the query using machine learning (ML) algorithms and append the extracted intent and entities to the query.
Range Facets
- Customize ranges for date, size, and so on.
  - This tuning stage must be added to both the Query and Results stages.

Playback and Recorder tuning stages:

Query Playback
- This user experience tuning overwrites the query with a previously captured query in JSON format.
Results Playback
- This user experience tuning overwrites the results with a previously captured results set in JSON format.
Query Recorder
- This user experience tuning saves in JSON format the executed search queries.
- Use local paths to make sure you have write access. The file is going to be created relative to root level.
- ".\Folder"
Results Recorder
- This user experience tuning saves in JSON format the received search results.
- Use local paths to make sure you have write access. The file is going to be created relative to root level.
- ".\Folder"

Query Scripting Processor
- This user experience tuning allows processing search queries using C# or VB scripts.
Query Suggestions Results Processor
- This user experience tuning allows processing suggestion queries using C# or VB scripts.
Results Scripting Processor
- This user experience tuning allows processing search results using C# or VB scripts.
Suggestion Query Processor
- This user experience tuning allows processing suggestion queries using C# or VB scripts.
Personalized Query: See the Personalize queries page.
- The stage requires the User Profile to be set.

SharePoint Online Refiner Mapper:
- Maps taxonomies so that the taxonomy labels are displayed and not the GUID.
- To get results, this stage must be added only as a Results tuning stage.
SharePoint OnPremise Refiner Mapper:
- Maps a search engine refinement names and values to match the local refinements.
- To get the expected results, this tuning stage must be added only as a Results tuning stage.

Parameters for each SmartHub Tuning stage are set in SmartHub.

SmartHub offers both global and search engine-specific tuning stages.
The Property Mapper tuning stage below is a global tuning stage that maps terms (parameters) across all of the search engines configured in SmartHub.
For more information, see How to Map Metadata Property Values: Property Mapper.

The mapping process described below is a common and popular use of Tuning stages.

For example, you may have 5 different content sources, and within each content source are various documents.

Every document in each content source has a title.

You want, in this case, all document titles labeled as "Title."

When performing queries with SmartHub users will see "Title" as an available search refinement.
Using a Tuning stage, you can map all document titles from all of your content sources to the same term - "Title".
When performing queries with SmartHub users will see "Title" as an available search refinement. and it will match with the corresponding titles in documents from all content sources.