Manage Knowledge
Introductionโ
Manage Knowledge is a feature within the Knowledge Management system that allows users to view, edit, and manage all knowledge sources within the platform. This documentation provides a comprehensive guide on navigating the Manage Knowledge interface and performing various actions on knowledge objects.
Table of Contentsโ
Accessing Manage Knowledgeโ
To access the Manage Knowledge feature:
- Navigate to the left side navigation bar
- Click on Knowledge Management
- Select Manage Knowledge from the dropdown
Interface Overviewโ
The Manage Knowledge page displays a table with the following columns:
Column | Description |
---|---|
Knowledge Name | Name of the knowledge source |
Knowledge Type | Type of connector (Website, SharePoint, File, GitHub, API, etc.) |
Status | Current status of the knowledge (Enabled, Success, Failed) |
Created At | Date and time when the knowledge was created |
Actions | Edit and Delete options for the knowledge |
Knowledge Status Typesโ
Knowledge sources can have one of three status types:
- Enabled: The knowledge source has been initiated and is in the process of retrieving data
- Success: The knowledge has been successfully obtained and added to the platform
- Failed: The knowledge retrieval process encountered an error
Note: If a knowledge source has a Failed status, contact an admin or super admin to check the knowledge logs or cron job logs to identify the issue.
Managing Knowledge Sourcesโ
Editing Knowledgeโ
To edit a knowledge source:
- Locate the knowledge in the table
- Click the Edit button in the Actions column
- A popup window titled "Edit Knowledge" will appear
- Modify the knowledge name and other settings as required
- Options available for editing will vary based on the knowledge connector type
- Adjust permissions as needed
- Save your changes
Deleting Knowledgeโ
To delete a knowledge source:
- Locate the knowledge in the table
- Click the Delete button in the Actions column
- A confirmation popup will appear with the message "Are you sure you want to delete the knowledge [knowledge name]? This cannot be undone."
- Click Delete to confirm or Close to cancel
Warning: Deleting a knowledge source is permanent and cannot be undone.
Knowledge Details Viewโ
To view detailed information about a knowledge source, click on the Knowledge Name in the main table. This will redirect you to a detailed view with the following information:
Configuration Informationโ
The details view shows:
- Knowledge Name
- Last Indexed On (timestamp of the last indexing job)
- Configuration Details (specific to the connector type):
- For Website connectors: Website URL, scrape method, cron job schedule
- For File connectors: File path, schedule settings
- For other connectors: Relevant configuration details
- Created By (user who created the knowledge source)
- Groups (which groups the knowledge has been shared with)
Indexing Attemptsโ
The Indexing Attempts tab displays information about all cron jobs/scheduled runs:
- Start Time (date and time)
- Actions
- View Logs: Click to view a popup with detailed backend logs of the knowledge and cron job
Knowledge Objectsโ
The Knowledge Objects tab displays a table of all data retrieved from the knowledge source:
Column | Description |
---|---|
Knowledge Object Name | Name of the knowledge object |
Status | Success or Failed status of the object |
Source Type | Type of source (Website, File, GitHub, etc.) |
Size | Size of the file (for uploaded files) in KB |
Path | Source path of the object |
Remark | If the status is Failed, shows the reason for failure |
Created At | When the knowledge object was created |
Updated At | When the knowledge object was last updated |
Actions | Contains a Preview button to view the object data |
Previewing Object Dataโ
To preview a knowledge object:
- Click the Preview button in the Actions column
- A popup titled "Preview Data" will appear
- View the scraped data, including text, links, paragraphs, etc.
- For longer content, use the Previous and Next buttons to navigate through different portions
- Click Cancel or X to close the preview
Actions and Operationsโ
From the knowledge details view, the following actions are available:
Action | Description |
---|---|
Run Indexing | Initiates a new indexing job to fetch fresh data from the knowledge source |
View Logs | Displays the overall/latest logs for the knowledge source |
Pause | Pauses the current schedule/cron job |
Edit | Opens the Edit Knowledge popup to modify settings |
Delete | Removes the knowledge source and all associated documents (cannot be undone) |
Warning: When deleting a knowledge source, all associated documents will also be deleted. This action cannot be undone.