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

Files

Business information is available in a variety of formats and types, like, the company website, third-party content sources, blogs, etc. A lot of information is also available as documents and files on internal servers. SearchAssist allows you to upload and index files hosted on local machines or remote servers. This functionality streamlines the process of locating information, eliminating the need to manually locate specific documents and sift through their contents, thus saving users both time and energy.

You have the option to upload single files from a local device or a URL. Alternatively, you can also upload many files simultaneously from a designated directory. The uploaded files are organized into directories in the SearchAssist application. A default directory is always present to store individual files. Once a file is successfully uploaded to the SearchAssist application, it is automatically indexed and is readily available for search.

When content from a file is used to generate answers or search results, the response includes a preview of the relevant content along with a link to the file as a citation or source. Users can download the file using this link. Note that the URLs provided in the response are single-use only. This method ensures enhanced security and confidentiality by limiting access to a one-time use.

Supported File formats:

  • Search Results: PDF, DOCX, PPT, JPEG, PNG, and TXT
  • Extractive Answers: PDF
  • Generative Answers: PDF, DOCX, PPT and TXT

Scanned PDFs and password-encrypted PDFs are not currently supported.

Add content 

To add content from files, go to the File Upload page under the Sources tab. Click the Upload button.

Alternatively, if you are on the home page under Sources, click File Upload. 

The upload page gives you the option to upload a single file from your local device, a remotely hosted file, or a bunch of files from a given directory.

To upload an individual file, select the FILE radio button. Select the directory under which you want the file to be uploaded in the SearchAssist application. If no directory is created in the application, the files are uploaded to the default directory. After selecting the directory, provide the location of the file, and click Proceed. This will upload the local file and make it available in the SearchAssist application. 

Note that you can select a maximum of 40 files to be uploaded at once with each file not exceeding 15 MB in size. To add more files, repeat the process.

 

Similarly, to extract data from a file hosted on a given URL, select the URL radio button, provide the title for the file, the name of the directory where the file should be saved in the SearchAssist application, a description of the file, the URL where the file is hosted and click Proceed

You can also upload multiple files at once using the Directory upload option. Select the DIRECTORY radio button. Provide a title and description for the directory and browse to the directory on the local machine. Click Proceed to upload all the files under the directory.

 

Note that currently, you can upload a directory with a maximum of 20 files at once with each file not exceeding 15MB in size.

You can see the files that have been successfully uploaded, either individually or as part of the directory upload, under the File Upload page as shown below.

The page shows the directories on the left side and the pages under each directory and their details on the right. 

For each file, it displays the following fields:

Field Description
Source Title  Name of the file
No. of records Total number of records in the file.
Path Location of the file. For files uploaded from the local machine or a given URL, this field points to their directory in the SearchAssist application. For directory-uploaded files, this points to the location of the file on the local machine. 
Status The status field shows the progress of the ingestion process for each file. It can take the following values:

  • In Queue: When the data ingestion is yet to begin for the file. You can also choose to stop the file upload process at this stage.
  • In Progress: When the data ingestion process has begun but not completed. You can also choose to stop the file upload process during this phase.
  • Successful: When the file upload and its processing have been completed successfully. 
  • Failed: When the file ingestion process fails due to some reason. 

To upload more files, use the Upload button on the top right.

View File Details

To view the details of an uploaded file, click the corresponding source title. It will display the following details of the page:

Field Description
Directory Name Name of the directory under which the file is uploaded on SearchAssist
File Type Type of file
File Path In case of a directory upload, this points to the local machine path from where the file was uploaded. In the case of an individual file or a hosted file, it is the path at which the file is stored in SearchAssist. 
No. of records Total number of records in the file. Refer to the definition of a record here.
Last updated Last update time for the file. 
Preview A few lines from the file are displayed to the user as a preview in the search results. 

View Directory Details

To view the details of a directory, click the ellipses icon and select details. This shows the following details of the directory.

Field Description
Description Description of the directory
Created By The user who created the directory 
Created On Date of creation of the directory
Last Updated Date of the last update in the directory 
Number of files Total number of files in the directory
Number of records Total number of records across all the files  in the directory

Delete a file

To delete one or more files from the SearchAssist application, go to the corresponding folders, select the files, and click the Delete button on the top.  

Alternatively, click the delete icon corresponding to the file to be deleted.

Delete a directory

To delete a directory and all the files in the directory, click the ellipsis icon beside the directory name and click the delete button. 

Note that once a file or directory is deleted, the content can not be recovered.

Search Files

When there are many files, you can use the search feature to look for a specific file in a directory. 

Files

Business information is available in a variety of formats and types, like, the company website, third-party content sources, blogs, etc. A lot of information is also available as documents and files on internal servers. SearchAssist allows you to upload and index files hosted on local machines or remote servers. This functionality streamlines the process of locating information, eliminating the need to manually locate specific documents and sift through their contents, thus saving users both time and energy.

You have the option to upload single files from a local device or a URL. Alternatively, you can also upload many files simultaneously from a designated directory. The uploaded files are organized into directories in the SearchAssist application. A default directory is always present to store individual files. Once a file is successfully uploaded to the SearchAssist application, it is automatically indexed and is readily available for search.

When content from a file is used to generate answers or search results, the response includes a preview of the relevant content along with a link to the file as a citation or source. Users can download the file using this link. Note that the URLs provided in the response are single-use only. This method ensures enhanced security and confidentiality by limiting access to a one-time use.

Supported File formats:

  • Search Results: PDF, DOCX, PPT, JPEG, PNG, and TXT
  • Extractive Answers: PDF
  • Generative Answers: PDF, DOCX, PPT and TXT

Scanned PDFs and password-encrypted PDFs are not currently supported.

Add content 

To add content from files, go to the File Upload page under the Sources tab. Click the Upload button.

Alternatively, if you are on the home page under Sources, click File Upload. 

The upload page gives you the option to upload a single file from your local device, a remotely hosted file, or a bunch of files from a given directory.

To upload an individual file, select the FILE radio button. Select the directory under which you want the file to be uploaded in the SearchAssist application. If no directory is created in the application, the files are uploaded to the default directory. After selecting the directory, provide the location of the file, and click Proceed. This will upload the local file and make it available in the SearchAssist application. 

Note that you can select a maximum of 40 files to be uploaded at once with each file not exceeding 15 MB in size. To add more files, repeat the process.

 

Similarly, to extract data from a file hosted on a given URL, select the URL radio button, provide the title for the file, the name of the directory where the file should be saved in the SearchAssist application, a description of the file, the URL where the file is hosted and click Proceed

You can also upload multiple files at once using the Directory upload option. Select the DIRECTORY radio button. Provide a title and description for the directory and browse to the directory on the local machine. Click Proceed to upload all the files under the directory.

 

Note that currently, you can upload a directory with a maximum of 20 files at once with each file not exceeding 15MB in size.

You can see the files that have been successfully uploaded, either individually or as part of the directory upload, under the File Upload page as shown below.

The page shows the directories on the left side and the pages under each directory and their details on the right. 

For each file, it displays the following fields:

Field Description
Source Title  Name of the file
No. of records Total number of records in the file.
Path Location of the file. For files uploaded from the local machine or a given URL, this field points to their directory in the SearchAssist application. For directory-uploaded files, this points to the location of the file on the local machine. 
Status The status field shows the progress of the ingestion process for each file. It can take the following values:

  • In Queue: When the data ingestion is yet to begin for the file. You can also choose to stop the file upload process at this stage.
  • In Progress: When the data ingestion process has begun but not completed. You can also choose to stop the file upload process during this phase.
  • Successful: When the file upload and its processing have been completed successfully. 
  • Failed: When the file ingestion process fails due to some reason. 

To upload more files, use the Upload button on the top right.

View File Details

To view the details of an uploaded file, click the corresponding source title. It will display the following details of the page:

Field Description
Directory Name Name of the directory under which the file is uploaded on SearchAssist
File Type Type of file
File Path In case of a directory upload, this points to the local machine path from where the file was uploaded. In the case of an individual file or a hosted file, it is the path at which the file is stored in SearchAssist. 
No. of records Total number of records in the file. Refer to the definition of a record here.
Last updated Last update time for the file. 
Preview A few lines from the file are displayed to the user as a preview in the search results. 

View Directory Details

To view the details of a directory, click the ellipses icon and select details. This shows the following details of the directory.

Field Description
Description Description of the directory
Created By The user who created the directory 
Created On Date of creation of the directory
Last Updated Date of the last update in the directory 
Number of files Total number of files in the directory
Number of records Total number of records across all the files  in the directory

Delete a file

To delete one or more files from the SearchAssist application, go to the corresponding folders, select the files, and click the Delete button on the top.  

Alternatively, click the delete icon corresponding to the file to be deleted.

Delete a directory

To delete a directory and all the files in the directory, click the ellipsis icon beside the directory name and click the delete button. 

Note that once a file or directory is deleted, the content can not be recovered.

Search Files

When there are many files, you can use the search feature to look for a specific file in a directory.