Getting started with PageBrain Search
Installation
Prerequisites
You must be:
- An admin of the Confluence Cloud instance.
- Either a technical contact or billing contact of the Confluence Cloud instance. To verify, log in to MyAtlassian and ensure the Confluence Cloud instance appears in the Licenses page.
- Click on the Confluence icon in the top-left corner.
- Go to Apps > Find new apps.
- When the Find new apps screen loads, locate “PageBrain Search for Confluence”.
- Click Install (or Free Trial if the app requires a paid license) to download and install. If the app requires a paid license, you will be provided with a minimum of 30-day free trial.
- Click Close in the Installed and ready to go dialog box.
Getting started
Once the add-on is installed we will try to crawl all contents of your Confluence instance. This process can take a few minutes to a couple of hours depending on the size of your Confluence instance. While you can still perform search queries when our crawlers are indexing your Confluence instance, the results might not be optimal.
Here are some tips on using PageBrain Search:
- Try asking questions in natural language (e.g. “What time is the town hall meeting?” instead of “town hall time”).
- Search for the contents of an image instead of filenames (e.g. “company trip to vietnam” instead of “dslr_001.jpg”) to take advantage of our image search.
- Use double quotes to perform an exact search (e.g. “getApiLimit”).
- Add stopwords and synonyms to customize search results for your company's use case (e.g. synonym: PTO, Paid Time Off; stopwords: the, a, is).
Setting up Federated Search
If you want to be able to search the contents of instance A from instance B:
- Go to the PageBrain Settings page in instance A and copy the Federated token.
- Go to the PageBrain Settings page in instance B and paste the Federated token.
- Copy and paste the Federated token from instance B to instance A if you want to search the other way too.
Now when you search from one instance, the results will also include results from the other instance.
FAQ
How does Question Answering / PageBrain Ranking work?
We use state-of-the-art machine learning models to perform inference on the search results to refine and prioritise the most relevant information.
Do you store Confluence data on your servers?
We only store cached copies of your Confluence pages and images for search and retrieval.