Rulga commited on
Commit
0e0b35b
Β·
1 Parent(s): d4835b5

Enhance README.md: Update knowledge base management section with new features, including custom URL handling, selective source management, and detailed update operations.

Browse files
Files changed (1) hide show
  1. README.md +39 -0
README.md CHANGED
@@ -19,6 +19,15 @@ Status Law Assistant is a smart chatbot that answers user questions about Status
19
 
20
  ## ✨ Key Features
21
 
 
 
 
 
 
 
 
 
 
22
  - Automatic creation and updating of knowledge base from status.law website content
23
  - Intelligent information retrieval for query responses
24
  - Context-aware response generation
@@ -139,6 +148,36 @@ from src.training.model_manager import switch_to_model
139
  switch_to_model("llama-7b") # or "zephyr-7b", "mistral-7b", "xglm-7b"
140
  ```
141
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
142
  ## πŸ”— Related Links
143
 
144
  - [Status Law Website](https://status.law)
 
19
 
20
  ## ✨ Key Features
21
 
22
+ - Knowledge Base Management:
23
+ - Dynamic URL management for knowledge base sources
24
+ - Ability to add custom URLs for information extraction
25
+ - Selective source inclusion/exclusion
26
+ - Two modes of knowledge base updates:
27
+ - Update Mode: Adds new information while preserving existing knowledge
28
+ - Rebuild Mode: Complete recreation of knowledge base from selected sources
29
+ - Real-time status tracking for knowledge base operations
30
+ - Automatic metadata management and versioning
31
  - Automatic creation and updating of knowledge base from status.law website content
32
  - Intelligent information retrieval for query responses
33
  - Context-aware response generation
 
148
  switch_to_model("llama-7b") # or "zephyr-7b", "mistral-7b", "xglm-7b"
149
  ```
150
 
151
+ ## πŸ”„ Knowledge Base Management
152
+
153
+ The application provides a flexible interface for managing knowledge sources:
154
+
155
+ 1. **Source Management**:
156
+ - View and edit the list of source URLs
157
+ - Enable/disable specific sources
158
+ - Add custom URLs for information extraction
159
+ - Monitor source status and availability
160
+
161
+ 2. **Update Operations**:
162
+ - **Update Knowledge Base**: Incrementally add new information while preserving existing knowledge
163
+ - **Rebuild Knowledge Base**: Completely recreate the knowledge base using only selected sources
164
+ - Real-time operation status tracking
165
+ - Automatic backup of previous versions
166
+
167
+ 3. **Usage**:
168
+ ```python
169
+ # Add new URL to knowledge base
170
+ sources_df.append({"URL": "https://example.com", "Include": True, "Status": "Ready"})
171
+
172
+ # Update knowledge base with selected sources
173
+ update_kb_with_selected(sources_df)
174
+
175
+ # Rebuild knowledge base from scratch
176
+ rebuild_kb_with_selected(sources_df)
177
+ ```
178
+
179
+ All changes to the knowledge base are automatically synchronized with the Hugging Face dataset, ensuring data persistence and version control.
180
+
181
  ## πŸ”— Related Links
182
 
183
  - [Status Law Website](https://status.law)