{"id":8907846,"url":"https://github.com/whyhow-ai/rule-based-retrieval","last_synced_at":"2026-04-04T14:42:41.384Z","repository":{"id":228486429,"uuid":"773680574","full_name":"whyhow-ai/rule-based-retrieval","owner":"whyhow-ai","description":"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 or Milvus for efficient vector database management.","archived":false,"fork":false,"pushed_at":"2024-10-04T19:23:39.000Z","size":791,"stargazers_count":248,"open_issues_count":4,"forks_count":28,"subscribers_count":5,"default_branch":"main","last_synced_at":"2026-02-18T07:18:51.848Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/whyhow-ai.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-03-18T07:51:56.000Z","updated_at":"2026-01-15T07:23:47.000Z","dependencies_parsed_at":"2024-12-12T12:31:04.971Z","dependency_job_id":"b0d1cc5c-33f2-4d15-a60a-f4836a19f01c","html_url":"https://github.com/whyhow-ai/rule-based-retrieval","commit_stats":null,"previous_names":["whyhow-ai/rule-based-retrieval"],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/whyhow-ai/rule-based-retrieval","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/whyhow-ai%2Frule-based-retrieval","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/whyhow-ai%2Frule-based-retrieval/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/whyhow-ai%2Frule-based-retrieval/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/whyhow-ai%2Frule-based-retrieval/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/whyhow-ai","download_url":"https://codeload.github.com/whyhow-ai/rule-based-retrieval/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/whyhow-ai%2Frule-based-retrieval/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31403391,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-04T10:20:44.708Z","status":"ssl_error","status_checked_at":"2026-04-04T10:20:06.846Z","response_time":60,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-05-01T19:04:49.641Z","updated_at":"2026-04-04T14:42:41.368Z","avatar_url":"https://github.com/whyhow-ai.png","language":"Python","funding_links":[],"categories":["A01_文本生成_文本对话","Neural Search and Retrieval","开源工具"],"sub_categories":["大语言对话模型及数据","其他"],"readme":"# Rule-based Retrieval\n\n[![Python Version](https://img.shields.io/badge/python-3.10%2B-blue)](https://www.python.org/downloads/)\n[![License](https://img.shields.io/badge/license-MIT-green)](https://opensource.org/licenses/MIT)\n[![PyPI Version](https://img.shields.io/pypi/v/rule-based-retrieval)](https://pypi.org/project/rule-based-retrieval/)\n[![Code Style: Black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)\n[![Checked with mypy](https://img.shields.io/badge/mypy-checked-blue)](https://mypy-lang.org/)\n[![Whyhow Discord](https://dcbadge.vercel.app/api/server/PAgGMxfhKd?compact=true\u0026style=flat)](https://discord.gg/PAgGMxfhKd)\n\nThe 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.\n\n# Installation\n\n### Prerequisites\n\n- Python 3.10 or higher\n- OpenAI API key\n- Pinecone, Milvus or Qdrant credentials\n\n### Install from PyPI\n\nYou can install the package directly from PyPI using pip:\n\n```shell\npip install rule-based-retrieval\n```\n\n### Install from GitHub\n\nAlternatively, you can clone the repo and install the package:\n\n```shell\ngit clone git@github.com:whyhow-ai/rule-based-retrieval.git\ncd rule-based-retrieval\npip install .\n```\n\n### Developer Install\n\nFor a developer installation, use an editable install and include the development dependencies:\n\n```shell\npip install -e .[dev]\n```\n\nFor ZSH:\n\n```shell\npip install -e \".[dev]\"\n```\n\nIf you want to install the package directly without explicitly cloning yourself\nrun\n\n```shell\npip install git+ssh://git@github.com/whyhow-ai/rule-based-retrieval\n```\n\n# Documentation\n\nDocumentation can be found [here](https://whyhow-ai.github.io/rule-based-retrieval/).\n\nTo serve the docs locally run\n\n```shell\npip install -e .[docs]\nmkdocs serve\n```\n\nFor ZSH:\n\n```shell\npip install -e \".[docs]\"\nmkdocs serve\n```\n\nNavigate to http://127.0.0.1:8000/ in your browser to view the documentation.\n\n# Examples\n\nCheck out the `examples/` directory for sample scripts demonstrating how to use the Rule-based Retrieval package.\n\n# How to\n\n### [Demo](https://www.loom.com/share/089101b455b34701875b9f362ba16b89)\n`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:\n\n- [Milvus](docs/milvus.md) \n- [Pinecone](docs/pinecone.md)\n- [Qdrant](docs/qdrant.md)\n\n# Contributing\n\nWe 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.\n\nIf you'd like to contribute code, please follow these steps:\n\n1. Fork the repository\n2. Create a new branch for your feature or bug fix\n3. Make your changes and commit them with descriptive messages\n4. Push your changes to your forked repository\n5. Open a pull request to the main repository\n\n### License\n\nThis project is licensed under the MIT License.\n\n### Support\n\nWhyHow.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](https://www.whyhow.ai/). Join our discussions about rules, determinism and knowledge graphs in RAG on our newly-created [Discord](https://discord.com/invite/9bWqrsxgHr).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwhyhow-ai%2Frule-based-retrieval","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwhyhow-ai%2Frule-based-retrieval","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwhyhow-ai%2Frule-based-retrieval/lists"}