Configuring AI Assist
jhDocs provides 3 ways for users to find the information they need in your documentation site:
- Navigation: The user selects documents from your site’s navigation bar.
- Keyword search: The user enters text into the search box and jhDocs performs a keyword search for that term, finding documents that contain that word.
- AI Assist: The user enters text into the search box and jhDocs passes that to the AI Assist feature. This section explores how that process works.
How does AI Assist differ from traditional search?
The biggest difference between keyword search and AI Assist is that the AI Assist feature understands what you’re searching for in a way that keyword search cannot. If the search phrase contains a typo or is poorly worded, AI Assist will typically still understand what is needed and can find the content that the user is actually looking for, despite how the prompt was worded.
How do users access AI Assist?
After AI Assist has been configured for your jhDocs repo, all searches in your documentation site will route both through keyword search and AI Assist.
AI Assist will often have a meaningful result, but not always, depending on what is being searched. If AI Assist returns meaningful results, those are displayed in a box at the top of the first page of search results, above the keyword search results. (Keyword search results always display.)
AI Assist tends to provide more meaningful answers when the search string is longer. If the user searches for a single short word, they may not see AI Assist results.
Availability
AI Assist is available for every jhDocs site. Follow the steps in this section to get AI Assist set up in your repo too.
Automatic syncing
Once AI Assist has been fully configured for your jhDocs site, all content changes that are committed to your jhDocs repo – additions, changes, and deletions – are automatically synced with your AI Assist knowledge base via GitHub workflows. (More on that later.)
Configuration
There are 3 levels of configuration that must be performed to configure AI Assist for your jhDocs site, described in this section.
Next topic: Requesting an AskJack Agent and Knowledge BaseTopics in this section
- Requesting an AskJack Agent and Knowledge Base
- Configuring your Repo for AI Assist
- Configuring jhDocs for AI Assist