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

Index Management

Indexing is the technique by which search engines process information to enable quick responses to users’ queries. The search engine retrieves search responses by searching an index instead of searching the text directly.
An index is a collection of documents and each document is a collection of fields that contains the data. It is a database used by the search engine. Searching with an index is a much faster and efficient way to retrieve information when compared to text search.
But, identifying relevant information by sifting through individual pages for keywords to the index can be a very slow process. Instead, an inverted index can be more efficient. Inverted Index is a process that inverts a page-centric data structure to a keyword-centric data structure. 

By default, SearchAssist’s search engine applies the inverted index process and indexes all the data in every field, and each indexed field has a separate data structure.

SearchAssist’s Index Configuration allows you to configure the fields relevant to your business use case so that the application can manipulate documents and fields to customize the data and results.

Index Configuration

As mentioned above, once you create an application in SearchAssist, a Default Index is automatically created. By default, SearchAssist creates some fields that will be used in the indexing pipeline. You can fine-tune this Default Index or create your own index configuration. Ensure to Train your app each time you make changes to any index configuration. This builds the index based on the updated configurations.

See below to create an index configuration.

The index configuration involves the following processes:

  • Add Fields as the properties from the data sources that you would want to be included or excluded from the index. Refer here for details.
  • Add Traits to help identify specific entities or attributes that can be extracted from the users’ input. Refer here for details.
  • Configure Index Pipeline Stages to transform the incoming data into optimized documents using the Workbench. Refer here for details.

You can have multiple index configurations to test a combination of configurations before identifying the one that suits your requirements. Sources are common for all the indices. Each index can have an index configuration (Traits, Workbench, Fields) and one or more search configurations.

To create multiple indices, you can clone an existing configuration or create a new configuration.

Creation

To create an index, follow the below steps:

  1. Click the Indices tab on the top.
  2. On the left pane, under the Index Configuration section, click the dropdown against the current index.
  3. Click Create New.
  4. On the New Index Configuration dialog box, select Create New option.
  5. Enter a name in the Name of Index Configuration field.
  6. Click Add.

Clone

To clone an index, follow the below steps:

  1. Click the Indices tab on the top.
  2. On the left pane, under the Index Configuration section, click the dropdown against the current index.
  3. From the list, click the clone icon of the respective index (Index A).
  4. On the Clone Index Configuration dialog box, enter a name for the new index (Index B) in the Index Configuration Name field.
  5. Click Clone.

Actions

You can perform the following actions on an existing index:

  1. Click the Indices tab on the top.
  2. On the left pane, under the Index Configuration section, click the dropdown against the current index.
  3. Hover over the index name.
  4. You can:
    1. Mark the index as default using the star icon;
    2. Clone the index;
    3. Edit the name of the index;
    4. Delete the index.

Index Management

Indexing is the technique by which search engines process information to enable quick responses to users’ queries. The search engine retrieves search responses by searching an index instead of searching the text directly.
An index is a collection of documents and each document is a collection of fields that contains the data. It is a database used by the search engine. Searching with an index is a much faster and efficient way to retrieve information when compared to text search.
But, identifying relevant information by sifting through individual pages for keywords to the index can be a very slow process. Instead, an inverted index can be more efficient. Inverted Index is a process that inverts a page-centric data structure to a keyword-centric data structure. 

By default, SearchAssist’s search engine applies the inverted index process and indexes all the data in every field, and each indexed field has a separate data structure.

SearchAssist’s Index Configuration allows you to configure the fields relevant to your business use case so that the application can manipulate documents and fields to customize the data and results.

Index Configuration

As mentioned above, once you create an application in SearchAssist, a Default Index is automatically created. By default, SearchAssist creates some fields that will be used in the indexing pipeline. You can fine-tune this Default Index or create your own index configuration. Ensure to Train your app each time you make changes to any index configuration. This builds the index based on the updated configurations.

See below to create an index configuration.

The index configuration involves the following processes:

  • Add Fields as the properties from the data sources that you would want to be included or excluded from the index. Refer here for details.
  • Add Traits to help identify specific entities or attributes that can be extracted from the users’ input. Refer here for details.
  • Configure Index Pipeline Stages to transform the incoming data into optimized documents using the Workbench. Refer here for details.

You can have multiple index configurations to test a combination of configurations before identifying the one that suits your requirements. Sources are common for all the indices. Each index can have an index configuration (Traits, Workbench, Fields) and one or more search configurations.

To create multiple indices, you can clone an existing configuration or create a new configuration.

Creation

To create an index, follow the below steps:

  1. Click the Indices tab on the top.
  2. On the left pane, under the Index Configuration section, click the dropdown against the current index.
  3. Click Create New.
  4. On the New Index Configuration dialog box, select Create New option.
  5. Enter a name in the Name of Index Configuration field.
  6. Click Add.

Clone

To clone an index, follow the below steps:

  1. Click the Indices tab on the top.
  2. On the left pane, under the Index Configuration section, click the dropdown against the current index.
  3. From the list, click the clone icon of the respective index (Index A).
  4. On the Clone Index Configuration dialog box, enter a name for the new index (Index B) in the Index Configuration Name field.
  5. Click Clone.

Actions

You can perform the following actions on an existing index:

  1. Click the Indices tab on the top.
  2. On the left pane, under the Index Configuration section, click the dropdown against the current index.
  3. Hover over the index name.
  4. You can:
    1. Mark the index as default using the star icon;
    2. Clone the index;
    3. Edit the name of the index;
    4. Delete the index.