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

Field Mapping

The Field Mapping stage can be used to map fields in a document to a target field. The mapping is performed on the fields that satisfy the conditions defined for the mapping.  SearchAssist allows you to perform the following operations on the fields:

  • Set the value of a field value
  • Rename a field
  • Copy the value of one field to another
  • Remove a field

To define this type of stage, go to the workbench, add a new stage and set the stage type to Field Mapping

Field Mapping Configuration

The field mapping configuration has the following configuration properties:

  • Stage Name – the name used to identify the index pipeline stage uniquely.
  • Condition – Criteria to select the data on which field mapping is to be performed. There are two ways of defining the condition for the mapping: Basic and Script. When using the Basic method, you can define a condition using the index fields and operator. For example, if you want to perform field mapping for fields in file type of content, use the index field, ‘file_content’ and operator, ‘exists’ to define the condition to select the type of data on which processing is to be done. You can use the logical AND operator to add more than one check in a condition. When using the Script, you can provide a custom script to add your condition for field mapping.
  • Stage Definition – Set of rules to define the changes to be made to the fields which satisfy the conditions. You can add more than one set of actions. When there are multiple actions defined, the actions are applied one after the other in the sequence in which they are defined. Use the + icon to add multiple actions to the stage definition and use the draggable dots icon to arrange the actions in the desired order. 

You can take the following actions on the fields:

Set Sets the value of a particular field. It overrides the existing value of the field. 
Rename Renames the selected field
Copy  Copies the value of the source field to the target field. 
Remove Removes a particular field from the document. 

 

Note that the actions are applied in the order in which they are defined under stage definition, which may have an impact on the final document generated after this stage.

Field Mapping

The Field Mapping stage can be used to map fields in a document to a target field. The mapping is performed on the fields that satisfy the conditions defined for the mapping.  SearchAssist allows you to perform the following operations on the fields:

  • Set the value of a field value
  • Rename a field
  • Copy the value of one field to another
  • Remove a field

To define this type of stage, go to the workbench, add a new stage and set the stage type to Field Mapping

Field Mapping Configuration

The field mapping configuration has the following configuration properties:

  • Stage Name – the name used to identify the index pipeline stage uniquely.
  • Condition – Criteria to select the data on which field mapping is to be performed. There are two ways of defining the condition for the mapping: Basic and Script. When using the Basic method, you can define a condition using the index fields and operator. For example, if you want to perform field mapping for fields in file type of content, use the index field, ‘file_content’ and operator, ‘exists’ to define the condition to select the type of data on which processing is to be done. You can use the logical AND operator to add more than one check in a condition. When using the Script, you can provide a custom script to add your condition for field mapping.
  • Stage Definition – Set of rules to define the changes to be made to the fields which satisfy the conditions. You can add more than one set of actions. When there are multiple actions defined, the actions are applied one after the other in the sequence in which they are defined. Use the + icon to add multiple actions to the stage definition and use the draggable dots icon to arrange the actions in the desired order. 

You can take the following actions on the fields:

Set Sets the value of a particular field. It overrides the existing value of the field. 
Rename Renames the selected field
Copy  Copies the value of the source field to the target field. 
Remove Removes a particular field from the document. 

 

Note that the actions are applied in the order in which they are defined under stage definition, which may have an impact on the final document generated after this stage.