{"id":28166441,"url":"https://github.com/finki-hub/finki-chat-bot","last_synced_at":"2025-05-15T13:13:21.449Z","repository":{"id":280356121,"uuid":"937326279","full_name":"finki-hub/finki-chat-bot","owner":"finki-hub","description":"Server and chatbot for questions related to FINKI","archived":false,"fork":false,"pushed_at":"2025-04-30T06:24:38.000Z","size":139,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-30T07:33:35.839Z","etag":null,"topics":["chatbot","fcse","finki","rag","ukim"],"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/finki-hub.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,"zenodo":null}},"created_at":"2025-02-22T21:16:26.000Z","updated_at":"2025-04-30T06:24:39.000Z","dependencies_parsed_at":"2025-04-14T20:46:23.578Z","dependency_job_id":"20c63a64-91b0-4acd-8d5f-ece40ebcd379","html_url":"https://github.com/finki-hub/finki-chat-bot","commit_stats":null,"previous_names":["delemangi/finki-chat-bot","finki-hub/finki-chat-bot"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/finki-hub%2Ffinki-chat-bot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/finki-hub%2Ffinki-chat-bot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/finki-hub%2Ffinki-chat-bot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/finki-hub%2Ffinki-chat-bot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/finki-hub","download_url":"https://codeload.github.com/finki-hub/finki-chat-bot/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254346598,"owners_count":22055809,"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","fcse","finki","rag","ukim"],"created_at":"2025-05-15T13:12:18.579Z","updated_at":"2025-05-15T13:13:21.437Z","avatar_url":"https://github.com/finki-hub.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# FINKI Chat Bot\n\nRAG chat bot for the [`FCSE Students`](https://discord.gg/finki-studenti-810997107376914444) Discord server, powered by [LangChain](https://github.com/langchain-ai/langchain) and [FastAPI](https://github.com/fastapi/fastapi). Uses [PostgreSQL](https://github.com/postgres/postgres) and [pgvector](https://github.com/pgvector/pgvector) for keeping documents. Has support for multiple LLMs.\n\nIt currently works on a dataset of documents (FAQ) by conditionally injecting them in the context if they are related to the prompt.\n\n**WARNING**: Extremely WIP! Things can and will break frequently.\n\n## Quick Setup (Production)\n\nIt's highly recommended to do this in Docker.\n\nTo run the chat bot:\n\n1. Download [`compose.prod.yaml`](./compose.prod.yaml)\n2. Download [`.env.sample`](.env.sample), rename it to `.env` and change it to your liking\n3. Run `docker compose -f compose.prod.yaml up -d`\n\nThe API will be running on port `8880`. This also brings up a `pgAdmin` instance. You may use it to view or create documents. It's accesible on port `5555` by default.\n\n## Quick Setup (Development)\n\nRequires Python \u003e= 3.13 and [`uv`](https://github.com/astral-sh/uv).\n\n1. Clone the repository: `git clone https://github.com/finki-hub/finki-chat-bot.git`\n2. Install dependencies: `cd api \u0026\u0026 uv sync`\n3. Prepare env. variables by copying `env.sample` to `.env` - minimum setup requires the database configuration, it can be left as is\n4. Run it: `docker compose up -d`\n\nThis also brings up an OpenAPI instance at `localhost:8880/docs`.\n\n## Endpoints\n\nThis is an incomplete list. You may view all available endpoints on the OpenAPI instance.\n\n- `/questions/list` - get all questions\n- `/questions/name/\u003cname\u003e` - get a question by its name\n- `/questions/embed` - generate embeddings for all questions for a given model\n\n## License\n\nThis project is licensed under the terms of the MIT license.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffinki-hub%2Ffinki-chat-bot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffinki-hub%2Ffinki-chat-bot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffinki-hub%2Ffinki-chat-bot/lists"}