GETTING STARTED
SearchAssist Overview
SearchAssist Introduction
Onboarding SearchAssist
Build your first App
Glossary
Release Notes
Current Version
Recent Updates
Previous Versions

CONCEPTS
Managing Sources
Introduction
Files
Web Pages
FAQs
Structured Data 
Connectors
Introduction to Connectors
SharePoint Connector
Confluence Connector
Zendesk Connector
ServiceNow Connector
Salesforce Connector
Azure Storage Connector
Google Drive Connector
Dropbox Connector
Oracle Knowledge Connector
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
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
Collaboration
Integrations
OpenAI Integration
Azure OpenAI Integration
Billing and Usage
Plan Details
Usage Logs
Order and Invoices

SearchAssist PUBLIC 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

Confluence Connector

To integrate SearchAssist with Confluence Cloud, you need to 

  • Create an OAuth 2.0 integration on the Atlassian developer portal.
  • Configure the connector in SearchAssist with the OAuth 2.0 integration details.

Specifications

Type of Repository  Cloud
Supported API version REST API v1
Search Results Support Only manually created Knowledge articles in Confluence. 
Extractive Model for Answers  Knowledge Articles
Generative Model for Answers Knowledge Articles
Note: Searching through any other types of uploaded content like PDF files,  docs, and images is not supported.

Configuring OAuth application on Confluence Cloud

Prerequisites 

To create an OAuth 2.0 integration on the Confluence cloud, you need the following:   

  1. An admin account in Atlassian’s Confluence.
  2. A target domain.

Note: Currently SearchAssist supports searching through only manually created pages in Confluence and does not search through any other types of uploaded content like PDF files,  docs, and images. 

Steps to create the OAuth application

  • Sign into your developer account in the Atlassian developer portal. Click on the profile name at the top right corner and navigate to the Developer Console.

  • The developer console will list all your apps.

  • Click the Create button and select OAuth 2.0 Integration.

  • Provide a name for the application and click Create.

  • Once the application is created, you can update its name, description from the Settings tab. You can also add an avatar for the application. Update the settings and click Save changes.

  • The next step is to grant the necessary permissions. Go to the Permissions tab. Add the following scopes:
    • User Identity API
    • Confluence API

  • For the User Identity API, to add the permissions, click the config link.

  • On the following page, click the Edit Scopes button.

  • Grant the following permissions and click Save
    • Read:me
    • Read:account

  • Similarly, for Confluence API, go to the Granular Scopes and click Edit Scopes. Add a read operation filter, select all the filtered permissions, and click Save.  

  • After adding permissions, go to Settings and find the Client ID and Secret at the end of the page. Save these fields as these will be used for configuring the SearchAssist connector in the next step.

  • We also need the Host URL in Confluence for configuring the SearchAssist Connector.  To fetch this field, go to your Confluence home page and click on Profile.

  • Go to the Products tab.  

The host URL will be displayed at the bottom of the page.

Configuring SearchAssist Connector

To complete the integration, do the following configuration on the SearchAssist application. 

  • Go to Connectors under the Sources tab.

  • The following page provides instructions for the integration. Click Proceed.
  • Next, provide the details of the OAuth 2.0 application created on Confluence, click Connect, and authorize the connection.
Fields Description
Name  Name for the connector
Client ID Client ID of the OAuth application created on Confluence, as fetched in the last step above.
Client Secret Client secret generated for communication with Confluence. 
Host URL  The confluence server base URL  (without trailing slash), as fetched from the Confluence in the last step.

Confluence Connector

To integrate SearchAssist with Confluence Cloud, you need to 

  • Create an OAuth 2.0 integration on the Atlassian developer portal.
  • Configure the connector in SearchAssist with the OAuth 2.0 integration details.

Specifications

Type of Repository  Cloud
Supported API version REST API v1
Search Results Support Only manually created Knowledge articles in Confluence. 
Extractive Model for Answers  Knowledge Articles
Generative Model for Answers Knowledge Articles
Note: Searching through any other types of uploaded content like PDF files,  docs, and images is not supported.

Configuring OAuth application on Confluence Cloud

Prerequisites 

To create an OAuth 2.0 integration on the Confluence cloud, you need the following:   

  1. An admin account in Atlassian’s Confluence.
  2. A target domain.

Note: Currently SearchAssist supports searching through only manually created pages in Confluence and does not search through any other types of uploaded content like PDF files,  docs, and images. 

Steps to create the OAuth application

  • Sign into your developer account in the Atlassian developer portal. Click on the profile name at the top right corner and navigate to the Developer Console.

  • The developer console will list all your apps.

  • Click the Create button and select OAuth 2.0 Integration.

  • Provide a name for the application and click Create.

  • Once the application is created, you can update its name, description from the Settings tab. You can also add an avatar for the application. Update the settings and click Save changes.

  • The next step is to grant the necessary permissions. Go to the Permissions tab. Add the following scopes:
    • User Identity API
    • Confluence API

  • For the User Identity API, to add the permissions, click the config link.

  • On the following page, click the Edit Scopes button.

  • Grant the following permissions and click Save
    • Read:me
    • Read:account

  • Similarly, for Confluence API, go to the Granular Scopes and click Edit Scopes. Add a read operation filter, select all the filtered permissions, and click Save.  

  • After adding permissions, go to Settings and find the Client ID and Secret at the end of the page. Save these fields as these will be used for configuring the SearchAssist connector in the next step.

  • We also need the Host URL in Confluence for configuring the SearchAssist Connector.  To fetch this field, go to your Confluence home page and click on Profile.

  • Go to the Products tab.  

The host URL will be displayed at the bottom of the page.

Configuring SearchAssist Connector

To complete the integration, do the following configuration on the SearchAssist application. 

  • Go to Connectors under the Sources tab.

  • The following page provides instructions for the integration. Click Proceed.
  • Next, provide the details of the OAuth 2.0 application created on Confluence, click Connect, and authorize the connection.
Fields Description
Name  Name for the connector
Client ID Client ID of the OAuth application created on Confluence, as fetched in the last step above.
Client Secret Client secret generated for communication with Confluence. 
Host URL  The confluence server base URL  (without trailing slash), as fetched from the Confluence in the last step.