rule-based-retrieval
Readme
The Rule-based Retrieval package is a Python package that enables you to create and manage Retrieval Augmented Generation (RAG) applications with advanced filtering capabilities. It seamlessly integrates with OpenAI for text generation and Pinecone for efficient vector database management.
You can install the package directly from PyPI using pip:
pip install rule-based-retrieval
Alternatively, you can clone the repo and install the package:
git clone git@github.com:whyhow-ai/rule-based-retrieval.git
cd rule-based-retrieval
pip install .
For a developer installation, use an editable install and include the development dependencies:
pip install -e .[dev]
For ZSH:
pip install -e ".[dev]"
If you want to install the package directly without explicitly cloning yourself run
pip install git+ssh://git@github.com/whyhow-ai/rule-based-retrieval
Documentation can be found here.
To serve the docs locally run
pip install -e .[docs]
mkdocs serve
For ZSH:
pip install -e ".[docs]"
mkdocs serve
Navigate to http://127.0.0.1:8000/ in your browser to view the documentation.
Check out the examples/ directory for sample scripts demonstrating how to use the Rule-based Retrieval package.
whyhow_rbr offers different ways to implement Rule-based Retrieval through two databases and down below are the documentations(tutorial and example) for each implementation:
We welcome contributions to improve the Rule-based Retrieval package! If you have any ideas, bug reports, or feature requests, please open an issue on the GitHub repository.
If you'd like to contribute code, please follow these steps:
This project is licensed under the MIT License.
WhyHow.AI is building tools to help developers bring more determinism and control to their RAG pipelines using graph structures. If you're thinking about, in the process of, or have already incorporated knowledge graphs in RAG, we’d love to chat at team@whyhow.ai, or follow our newsletter at WhyHow.AI. Join our discussions about rules, determinism and knowledge graphs in RAG on our newly-created Discord.
FAQs
Python package for Rule-based Retrieval using RAG
We found that rule-based-retrieval demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.
Security News
UnitedHealth Group disclosed that the ransomware attack on Change Healthcare compromised protected health information for millions in the U.S., with estimated costs to the company expected to reach $1 billion.