Enterprise knowledge base Q&A

Applicable editions

Enterprise Standard Edition, Enterprise Dedicated Edition

Qoder CN administrators and global administrators within the organization (Dedicated) can use the Knowledge Base in the Qoder CN management console to add or delete knowledge documents, and enable or disable the retrieval augmentation feature.

To get started with practical use cases for Enterprise Knowledge Base Q&A, see Get started with Qoder CN Enterprise Knowledge Base Q&A in 5 scenarios.

Enterprise knowledge base management

Qoder CN admins and organization-level global admins (for Enterprise Dedicated Edition) can manage enterprise knowledge bases. This includes creating, editing, and deleting knowledge bases, managing member access, and adding or removing documents from a knowledge base.

Create, edit, and delete a knowledge base

Create a knowledge base

1. In the side navigation, click Knowledge Base.

2. On the Knowledge Base page, click Create Knowledge Base.

3. In the Create Knowledge Base dialog box, provide the following information:

   • Set Scenarios to Chat.

   • Enter a descriptive Knowledge Base Name.

   • (Optional) Provide a Description to summarize the content or purpose of the knowledge base.

   • For Access Control, select the knowledge base's visibility. The default, Private, makes it visible only to its members.

4. After you enter the information, click OK.

5. The new knowledge base is now listed on the Knowledge Base page.

Edit a knowledge base

You can modify a knowledge base's name, description, and access control settings in two ways:

1. From the Knowledge Base page: In the knowledge base list, find the knowledge base and click its Edit icon.

2. From the knowledge base details page: Click the Edit button.

Delete a knowledge base

To delete a knowledge base, go to its details page, click the Delete button, and then enter the knowledge base name to confirm the deletion.

Upload documents

On the Knowledge Base tab of the knowledge base details page, the Knowledge List displays the name, size, and data processing status of uploaded files. Click the Add Data button to upload documents.

Qoder CN admins and organization-level global admins (for Enterprise Dedicated Edition) can manage the data within a knowledge base. Follow these steps to upload documents:

1. Click the Add Data button to open the Add Data page.

2. Set the data type to Document. Click or drag files into the upload area (the gray area) to upload documents. When uploading files, note the following requirements:

   • You can upload a maximum of 10 files at a time.

   • Supported file formats: PDF, DOCX, TXT, Markdown, and CSV (for Enterprise Dedicated Edition).

   • The size of a single file cannot exceed 5 MB.

   • The file name cannot exceed 200 characters. Only UTF-8 and GBK file encodings are supported.

   • For best results, use structured documents with a clear hierarchy to improve retrieval accuracy.

3. After the upload is complete, click Add. The documents then enter the data processing queue.

Enable or disable retrieval augmentation

After the data processing is complete, you can enable or disable retrieval augmentation for the knowledge base in two ways:

1. From the Knowledge Base page: In the knowledge base list, find the corresponding knowledge base and turn on the toggle switch for retrieval augmentation.

2. From the knowledge base details page: Turn on the toggle switch for retrieval augmentation.

Once enabled, when an authorized developer uses the Chat feature in their IDE client, Qoder CN uses data from knowledge bases within the developer's access control scope to generate responses. To disable this, turn the toggle off.

Manage knowledge base access control

Qoder CN admins and organization-level global admins (for Enterprise Dedicated Edition) can change the access control for an enterprise knowledge base in one of two ways:

1. Edit the knowledge base to modify its access control settings.

2. Go to the knowledge base, click the Access Control tab, and then add or remove members.

Check document processing status

After you upload documents, the system applies vector persistence to index them for searching. You can view the status of this data processing in the document list. The possible statuses are:

• Awaiting: The file is in the queue, awaiting processing.

• Processing: The file is being analyzed and vectorized.

• Completed: Document analysis and vector persistence are complete.

• Error: An error occurred during document processing. Hover over the status to view the reason. Depending on the error, you may need to reprocess the document or delete the failed entry.

• Duplicate Files: The content of this file is identical to another file that has already been processed. The system skips processing this file. You can delete the duplicate.

Update documents

To update a document, simply upload the new version. The system automatically reprocesses the file.

Delete documents

You can delete documents that are in an Error status, are duplicates, or are no longer needed. To delete a single document, click its delete icon. To delete multiple documents, select their checkboxes in the document list and then click the Delete button.