‼️This project is deprecated due to advancement of LLM eco system. To see more advancement based on current project, check our latest repo here: https://github.com/AierLab/MultiverseNote .
The Knowledge Database Management Service is designed to manage AI knowledge in a structured way that emphasizes human control over automatic management. In addition to providing basic CRUD (Create, Read, Update, Delete) functionality, this service integrates version control and enhanced management convenience, similar to practices in other domain-specific systems.
The repository is organized as follows:
knowledge-database-management-service/
├── src/
│ ├── control/ # Contains controllers for handling business logic
│ ├── dao/ # Data Access Objects for database interactions
│ ├── model/ # Data models representing the structure of knowledge entities
│ ├── utils/ # Utility functions for common operations
│ ├── view/ # Views for rendering outputs (e.g., APIs or CLI)
│ └── __init__.py # Initializer for the src package
├── storage/
│ ├── config/ # Configuration files
│ │ └── main_config.yaml # Main configuration file
│ └── log/ # Log files
│ └── .gitkeep # Keeps log directory in version control
├── tests/
│ ├── __init__.py # Initializer for the tests package
│ └── ... # Test modules for various components
├── .gitignore # Specifies files and directories to ignore in version control
├── LICENSE # License file
├── main.py # Entry point for running the service
├── README.md # Project description and instructions
└── setup.py # Setup script for packaging and distribution
To install the Knowledge Database Management Service, follow these steps:
Clone the Repository:
git clone https://github.com/your-repo/knowledge-database-management-service.git
cd knowledge-database-management-service
Install Dependencies:
Use pip to install the required dependencies:
pip install -e .
To start the service, run:
python main.py
This will launch the Knowledge Database Management Service, which you can interact with via the defined APIs or CLI.
To integrate the Knowledge Database Management Service into your existing project, you can install the module and call its functions directly from the view package or other modules as needed.
Install the Module:
Install the service as a package:
pip install -e /path/to/knowledge-database-management-service
Import and Use Functions in Your Code:
Once installed, you can import and use the functions provided by the service. For example, to use a function from the view module:
from knowledge_db_management.view import view_function_name
# Example usage
result = view_function_name(parameters)
print(result)
Replace view_function_name with the actual function you wish to use, and parameters with the appropriate arguments.
By integrating this module, you can leverage its knowledge management capabilities, version control, and enhanced CRUD operations directly within your application.
The service uses a YAML configuration file located at storage/config/main_config.yaml. You can modify this file to change the application’s settings, such as database connections, logging levels, and other parameters.
To run the test suite, use:
pytest tests/
This will execute all the test cases in the tests directory and provide a report of the test results.
We welcome contributions from the community. Please follow these steps to contribute:
This project is licensed under Apache License 2.0 - see the LICENSE file for more details.
Thank you for your interest in the Knowledge Database Management Service! If you have any questions or need further assistance, feel free to open an issue or contact us.