{"id":18785267,"url":"https://github.com/andreped/referencebot","last_synced_at":"2026-04-09T12:10:22.160Z","repository":{"id":204430057,"uuid":"711834736","full_name":"andreped/ReferenceBot","owner":"andreped","description":"KnowledgeGPT + Azure OpenAI = \u003c3","archived":false,"fork":false,"pushed_at":"2023-10-30T14:48:18.000Z","size":48,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-08-01T19:17:00.441Z","etag":null,"topics":["ai","azure","bot","chatbot","huggingface","huggingface-spaces","knowledge-gpt","langchain","llm","mit","openai","streamlit"],"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/andreped.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-10-30T09:14:54.000Z","updated_at":"2023-12-23T14:52:17.000Z","dependencies_parsed_at":null,"dependency_job_id":"bf13ced1-e021-4704-99c5-f61707d49d71","html_url":"https://github.com/andreped/ReferenceBot","commit_stats":null,"previous_names":["andreped/referencebot"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/andreped/ReferenceBot","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/andreped%2FReferenceBot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/andreped%2FReferenceBot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/andreped%2FReferenceBot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/andreped%2FReferenceBot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/andreped","download_url":"https://codeload.github.com/andreped/ReferenceBot/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/andreped%2FReferenceBot/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":269748045,"owners_count":24469105,"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","status":"online","status_checked_at":"2025-08-10T02:00:08.965Z","response_time":71,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":["ai","azure","bot","chatbot","huggingface","huggingface-spaces","knowledge-gpt","langchain","llm","mit","openai","streamlit"],"created_at":"2024-11-07T20:46:05.927Z","updated_at":"2025-12-30T21:48:10.247Z","avatar_url":"https://github.com/andreped.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"---\ntitle: \"ReferenceBot: KnowledgeGPT + Azure OpenAI = \u003c3\"\ncolorFrom: indigo\ncolorTo: indigo\nsdk: docker\napp_port: 8501\nemoji: 💬\npinned: false\nlicense: mit\napp_file: knowledge_gpt/main.py\n---\n\n# [ReferenceBot](https://github.com/andreped/referencebot#referencebot)\n\n[![License](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT)\n\u003ca target=\"_blank\" href=\"https://huggingface.co/spaces/andreped/ReferenceBot\"\u003e\u003cimg src=\"https://img.shields.io/badge/🤗%20Hugging%20Face-Spaces-yellow.svg\"\u003e\u003c/a\u003e\n[![Streamlit App](https://static.streamlit.io/badges/streamlit_badge_black_white.svg)](https://referencebot.streamlit.app)\n[![CI/CD](https://github.com/andreped/ReferenceBot/actions/workflows/deploy.yml/badge.svg)](https://github.com/andreped/ReferenceBot/actions/workflows/deploy.yml)\n\n## [Continuous integration](https://github.com/andreped/referencebot#continuous-integration)\n\n| Build Type | Status |\n| - | - |\n| **HF Deploy** | [![Deploy](https://github.com/andreped/referencebot/workflows/Deploy/badge.svg)](https://github.com/andreped/referencebot/actions) |\n| **File size check** | [![Filesize](https://github.com/andreped/referencebot/workflows/Check%20file%20size/badge.svg)](https://github.com/andreped/referencebot/actions) |\n| **Formatting check** | [![Filesize](https://github.com/andreped/ReferenceBot/workflows/Linting/badge.svg)](https://github.com/andreped/ReferenceBot/actions) |\n\n## [Installation](https://github.com/andreped/referencebot#installation)\n\nFollow the instructions below to run the Streamlit server locally.\n\n### [Prerequisites](https://github.com/andreped/referencebot#prerequisites)\n\nMake sure you have Python `≥3.10` installed.\n\n### [Steps](https://github.com/andreped/referencebot#steps)\n\nThese instructions were tested on macOS 13.6 Ventura with ARM CPU and Python `3.10.11`.\n\n1. Clone the repository:\n\n```bash\ngit clone https://github.com/andreped/ReferenceBot\ncd ReferenceBot\n```\n\n2. Setup virtual environment and install dependencies:\n\n```bash\npython3 -m venv venv\nsource venv/bin/activate\npip install -r requirements.txt\n```\n\n3. Create the secrets file at `.streamlit/secrets.toml` and fill in the relevant info:\n\n```bash\nOPENAI_API_KEY = \"\u003cinsert OpenAI API key\u003e\"\nCHATGPT_MODEL = \"\u003cinsert model name\u003e\"\nOPENAI_API_BASE = \"https://\u003cinsert-openai-service-name\u003e.openai.azure.com\"\nOPENAI_API_VERSION = \"\u003cinsert version\u003e\"\nENGINE = \"\u003cinsert deployment model name\u003e\"\nENGINE_EMBEDDING = \"\u003cinsert deployment embedding name\u003e\"\n```\n\n4. Run the Streamlit server\n\n```bash\nstreamlit run knowledge_gpt/main.py\n```\n\n## [Build with Docker](https://github.com/andreped/referencebot#build-with-docker)\n\nRun the following commands to build and run the Docker image.\n\n```bash\ndocker build -t reference-bot .\ndocker run -p 8501:8501 reference-bot\n```\n\nOpen http://localhost:8501 in your browser to access the app.\n\n## [Demo](https://github.com/andreped/referencebot#demo) \u003ca target=\"_blank\" href=\"https://huggingface.co/spaces/andreped/ReferenceBot\"\u003e\u003cimg src=\"https://img.shields.io/badge/🤗%20Hugging%20Face-Spaces-yellow.svg\"\u003e\u003c/a\u003e\n\nA live demonstration is hosted at Hugging Face! Click the 🤗 badge above.\n\n![Screenshot 2023-10-30 at 15 35 51](https://github.com/andreped/ReferenceBot/assets/29090665/c64d8f54-d3da-41b8-8f57-0ed1eb3a1c30)\n\n## [Acknowledgements](https://github.com/andreped/referencebot#acknowledgements)\n\nWe have built on-top of [KnowledgeGPT](https://github.com/mmz-001/knowledge_gpt) to enable the tool be be used with Azure OpenAI Services. Thus, all credit should go towards the original developers.\n\n## [License](https://github.com/andreped/referencebot#license)\n\nDistributed under the MIT License. See [LICENSE](https://github.com/andreped/ReferenceBot/blob/main/LICENSE) for more information.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fandreped%2Freferencebot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fandreped%2Freferencebot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fandreped%2Freferencebot/lists"}