Knowledge Base

Display the Knowledge Base settings by navigating to "Side Menu" - "Configuration and Monitoring" - "Knowledge Base".
You can configure settings to use the pre-built RAG environment provided by WebPerformer-NX.
By synchronizing documents (data sources) placed in the File Manager with the Knowledge Base, you can use the RAG functionality of the Chatbot component without integrating with external services.
This feature was added in v4.1.0.

Note

• The Knowledge Base is not available on the Free plan.
• It is also not available if the INTERNAL Generative AI Option has not been subscribed.

Knowledge Base List

Records are displayed for the number of Knowledge Bases determined at the time of the INTERNAL Generative AI Option subscription.
Each Knowledge Base is assigned a pre-issued Knowledge Base ID (a random 10-character alphanumeric uppercase string).
From the menu icon on each record, you can execute "Update", "Sync", "Stop Sync", and "Delete" for the Knowledge Base.

Note

• You can subscribe to a maximum of 20 Knowledge Bases.
• The number of Knowledge Bases can be increased or decreased in units of one.
• There is a one-to-one relationship between a Knowledge Base and a data source path.
• Data from different Knowledge Bases is not shared.
• Knowledge Base records are displayed in ascending order of creation date and time.

Update

You can change the description and data source path for a Knowledge Base by following the steps below.

1. Click the "Menu" icon on the desired record.
2. Click "Update" from the displayed menu.
3. The Knowledge Base update dialog will appear.
4. Change the data source path and description in the dialog.
5. Click the "Update" button.

Note

• The data source path can be entered directly or inserted from the File Manager.
• The data source path must start with ”/”.
• The data source path must be 256 characters or less.
• The data source path is evaluated with a prefix match, so if you set “/path/to/sample.pdf”, it will be treated as “/path/to/sample.pdf*”.
• The description must be 200 characters or less.

Sync

To use the Knowledge Base for RAG, you need to synchronize the documents at the data source path with the Knowledge Base.
You can synchronize the documents under the configured data source path with the Knowledge Base by following the steps below.

1. Click the "Menu" icon on the desired record.
2. Click "Sync" from the displayed menu.
3. A warning dialog will appear. Confirm the contents and click "Sync".

Note

• The synchronization method is incremental sync.
• If an error occurs during synchronization, the sync count will not be incremented.
• When an error occurs, detailed information is output to the error log.
• The following file formats are supported for documents to be synchronized:
  • txt
  • md
  • html
  • doc/docx
  • csv
  • xls/xlsx
  • pdf
• The maximum size per document to be synchronized is 50 MB.
• Doc/docx files containing images may result in an error even if they are under 50 MB. In that case, please split the file to approximately 15 MB.

Stop Sync

You can stop a running synchronization by following the steps below.

1. Click the "Menu" icon on the record that is currently syncing.
2. Click "Stop Sync" from the displayed menu.

Delete

You can delete data sources that have been synchronized to the Knowledge Base by following the steps below.

1. Click the "Menu" icon on a synced record.
2. Click "Delete" from the displayed menu.
3. A warning dialog will appear. Confirm the contents and click "Delete".

Sync History List

The synchronization execution history for each Knowledge Base is displayed.
By selecting a Knowledge Base ID from the select box, you can view the sync history and information about the synchronized documents for that Knowledge Base.

Note

• The sync history is displayed in descending order of sync start time.
• The statuses displayed in the sync history table are as follows:
  • COMPLETE - Completed
  • FAILED - Failed
  • IN_PROGRESS - Syncing
  • STARTING - Starting
  • STOPPED - Stopped
  • STOPPING - Stopping
• The statuses displayed in the document table are as follows:
  • STARTING – An ingestion job containing the document has been submitted.
  • PENDING – The document is waiting to be ingested.
  • IN_PROGRESS – The document is currently being ingested.
  • INDEXED – The document was successfully indexed.
  • PARTIALLY_INDEXED – The document was only partially indexed.
  • METADATA_PARTIALLY_INDEXED – A metadata update for an existing document was submitted and only partially indexed.
  • METADATA_UPDATE_FAILED – A metadata update for an existing document was submitted but failed.
  • FAILED – Document ingestion failed.
  • NOT_FOUND – The document was not found.
  • IGNORED – The document was ignored during ingestion.
  • DELETING – A deletion job containing the document has been submitted.
  • DELETE_IN_PROGRESS – The document is currently being deleted.