Knowledge Management
Introductionโ
This document provides comprehensive guidance on using the Knowledge Management system. The Knowledge Management module enables users to connect various data sources, manage knowledge objects, create FAQs, and organize information into knowledge sets for efficient retrieval and utilization in chat and search functionalities.
Table of Contentsโ
- Introduction
- Table of Contents
- Accessing Knowledge Management
- Adding Knowledge
- Managing Knowledge
- FAQs
- Knowledge Sets
- Result Ranking
- Conclusion
Accessing Knowledge Managementโ
Navigate to the Knowledge Management section from the main navigation bar.
Adding Knowledgeโ
To add new knowledge to the system:
- From the navigation bar, click on Knowledge Management
- Select Add Knowledge
- Choose from the available connectors in the dropdown menu
Available Connectorsโ
The system supports the following connectors:
Connector | Purpose |
---|---|
Web | Scrapes data from websites |
Files | Upload documents (PDF, DOCX, HTML, JSON, TXT) |
SharePoint | Connect to SharePoint resources |
Minio | Connect to Minio storage |
API | Connect via API endpoints |
Confluence | Import Confluence content |
YouTube | Extract data from YouTube videos |
GitHub | Connect to GitHub repositories |
Google Drive | Access Google Drive documents |
Jira | Import Jira tickets and documentation |
Postgres | Connect to PostgreSQL databases |
Web Connector Configurationโ
To add a website as a knowledge source:
- Select Web from the connectors dropdown
- Choose a scrape method:
- Recursive
- Sitemap
- Single page
- XML
- Enter the website URL
- Provide a knowledge name
- Configure recording settings (optional):
- Enable recording to schedule recurring data retrieval
- Set frequency (e.g., daily, weekly)
- Select user groups to grant access permissions
- Click Save
After saving, you will be redirected to the Existing Website tab showing:
- Website link
- Knowledge name
- Scrape method
- Status (Enable/Success)
- Connected details
- Actions (Delete)
Managing Knowledgeโ
The Manage Knowledge section allows you to review and monitor your knowledge sources.
Review Knowledgeโ
To review a knowledge source:
- Click on the Review button in the Connected details column
- This redirects to the Manage Knowledge page with the following information:
- Knowledge name
- Configuration details (website URL, scrape method)
- Cron job schedule
- File path (for uploaded files)
- Creator information
- Group permissions
- Indexing attempts
To check indexing logs:
- Click the Logs button in the Indexing attempts section
- A pop-up will display the logs showing progress or errors
Knowledge Objectsโ
To view the content extracted from knowledge sources:
- Navigate to Knowledge Objects
- This displays all objects (e.g., extracted URLs from sitemaps)
- Click the Preview button to view the scraped data
My Knowledgeโ
The My Knowledge section allows individual users to add personal knowledge sources that won't be shared with others.
- This feature becomes available after admin configuration of connectors
- Users can add personal knowledge sources following the same process as Add Knowledge
- Personal knowledge is only accessible to the user who created it
The My Knowledge dashboard displays:
- Knowledge name
- Type (Website, File, GitHub, etc.)
- Status
- Creation date
- Actions (Edit, Delete)
FAQsโ
To manage Frequently Asked Questions:
- Navigate to the FAQ section
- Create categories to organize FAQs
- Add questions and answers within categories:
- Click Add New Question
- Enter the question
- Provide the response
- Set group permissions
- Click Add
To view or manage existing FAQs:
- Click on the FAQ name to view details
- The popup shows:
- Creator information
- Last modification date
- Category
- Actions (Edit, Group Permissions, Delete)
Knowledge Setsโ
Knowledge Sets allow you to group related knowledge sources together:
- Click Add Knowledge Set
- Provide:
- Knowledge set name
- Description
- Group permissions
- Add existing knowledge to the set:
- Use Existing Knowledge option to add complete knowledge sources
- Use Add Information Using Search to add specific knowledge objects
After adding a knowledge set, you can:
- Edit the knowledge set details
- Delete the knowledge set
Result Rankingโ
The Result Ranking feature helps prioritize search results:
- Enter a search term (e.g., "katonic")
- View all relevant knowledge related to the search term
- Adjust relevance scores for results
- Hide irrelevant results
Conclusionโ
Knowledge Management is a critical component that must be configured before using chat and search functionalities. Proper setup of knowledge sources ensures that the system can retrieve and utilize relevant information effectively.
For optimal performance, add all necessary knowledge sources during the initial platform configuration.