{"id":18260549,"url":"https://github.com/ssk-14/chatbot-guardrails","last_synced_at":"2025-04-04T19:33:19.271Z","repository":{"id":187383743,"uuid":"672441189","full_name":"SSK-14/chatbot-guardrails","owner":"SSK-14","description":"💂🏼 Build your Documentation AI with Nemo Guardrails","archived":false,"fork":false,"pushed_at":"2024-10-18T05:04:19.000Z","size":14805,"stargazers_count":13,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-20T17:40:17.730Z","etag":null,"topics":["chatbot","documentation","github","gradio","guardrails","langchain","llm","nemo-guardrails","rag"],"latest_commit_sha":null,"homepage":"https://ssk-14-nemo-ai.hf.space/","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/SSK-14.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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":"2023-07-30T05:08:44.000Z","updated_at":"2024-11-26T07:55:55.000Z","dependencies_parsed_at":"2024-02-28T09:46:07.705Z","dependency_job_id":"d3e6d56d-2003-4cb3-9c5d-432ff7407b72","html_url":"https://github.com/SSK-14/chatbot-guardrails","commit_stats":null,"previous_names":["ssk-14/chatbot-guardrails"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SSK-14%2Fchatbot-guardrails","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SSK-14%2Fchatbot-guardrails/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SSK-14%2Fchatbot-guardrails/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SSK-14%2Fchatbot-guardrails/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/SSK-14","download_url":"https://codeload.github.com/SSK-14/chatbot-guardrails/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247238457,"owners_count":20906445,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["chatbot","documentation","github","gradio","guardrails","langchain","llm","nemo-guardrails","rag"],"created_at":"2024-11-05T10:45:53.419Z","updated_at":"2025-04-04T19:33:17.616Z","avatar_url":"https://github.com/SSK-14.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# 💂🏼 Build your Documentation AI with Nemo Guardrails\n\n![OpenAI](https://img.shields.io/badge/OpenAI-412991.svg?style=for-the-badge\u0026logo=OpenAI\u0026logoColor=white)\n![Google Gemini](https://img.shields.io/badge/Google%20Gemini-8E75B2.svg?style=for-the-badge\u0026logo=Google-Gemini\u0026logoColor=white)\n![Nvidia Nemo](https://img.shields.io/badge/NVIDIA-76B900.svg?style=for-the-badge\u0026logo=NVIDIA\u0026logoColor=white)\n\n## 📜 Description\nThe application showcases the integration of github repos or documentations with llm powered assistance with Nemo Guardrails. By combining these technologies, the application ensures advanced safety features and effective mitigation's, enhancing the overall security and reliability of the chatbot system.\n\n## 🚀 Demo\n\n[NeMo Guardrails Chatbot](https://ssk-14-nemo-ai.hf.space/)\n\n| Without Guardrails |\n|------------|\n| ![Without Guardrails](./images/without-guardrails.png) |\n\n| With Guardrails |\n|------------|\n| ![With Guardrails](./images/with-guardrails.png) |\n\n---\n\n## 🛠️ Run The Application\n\n#### Clone the repo\n```\ngit clone https://github.com/SSK-14/chatbot-guardrails.git\n```\n\n#### If running for the first time,\n\n1. Create virtual environment\n\n```\npip3 install env\npython3 -m venv env\nsource env/bin/activate\n```\n\n2. Install required libraries\n\n```\npip3 install -r requirements.txt\n```\n\n#### Create an .env file from .env.example\n\n- Get an [Gemini API key](https://makersuite.google.com/app/apikey) or [OpenAI API key](https://platform.openai.com/account/api-keys) or [Groq API key](https://console.groq.com) or Use local models using [Ollama](https://ollama.ai/).\n\n- Setup a vector database [Qdrant Cloud](https://cloud.qdrant.io/).\n\nMake sure you replace your key rightly.\n```\n# You can use your preferred models.\nMODEL_API_KEY = \"Your OpenAI/Gemini/Groq API Key\"\nQDRANT_URL = \"Your Qdrant cloud cluster URL\"\n#If you are using qdrant cloud\nQDRANT_API_KEY = \"Your Qdrant API Key\"\n```\n\n#### Loading the Vectorstore 🗃️ \n\n1. Update the constants in `vectorstore.py` and `nemo/config.py` \u003c!-- Update env if with qdrant url and key. --\u003e\n- Change GITHUB_URL and BRANCH for your preferred github repo.\n2. Run the command - `python vectorstore.py` \u003c!-- Will create a vector collection. --\u003e\n\n#### Run the Gradio app\n\n```\ngradio app.py\n```\n\n#### Run using NeMo Guardrails UI\n\n- Update the `nemo/config.yml` file with models and `export OPENAI_API_KEY=sk...` \u003c!-- Update based on model provider. --\u003e\n```\nnemoguardrails server --config nemo\n```\n\n## 📁 Project Structure\n\n```\nchatbot-guardrails/\n│\n├── nemo/  // Contains all files for Guardrails\n├── app.py // Main file to run for gradio UI\n├── vectorstore.py // Run this to create vectorstore\n├── README.md\n└── requirements.txt\n```\n\n## Contributing 🤝\nContributions to this project are welcome! If you find any issues or have suggestions for improvement, please open an issue or submit a pull request on the project's GitHub repository.\n\n## License 📝\nThis project is licensed under the [MIT License](https://github.com/SSK-14/chatbot-guardrails/blob/main/LICENSE). Feel free to use, modify, and distribute the code as per the terms of the license.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fssk-14%2Fchatbot-guardrails","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fssk-14%2Fchatbot-guardrails","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fssk-14%2Fchatbot-guardrails/lists"}