{"id":20505597,"url":"https://github.com/openbankproject/obp-opey","last_synced_at":"2026-02-17T21:36:06.874Z","repository":{"id":243838998,"uuid":"813582930","full_name":"OpenBankProject/OBP-Opey","owner":"OpenBankProject","description":null,"archived":false,"fork":false,"pushed_at":"2025-02-19T13:30:24.000Z","size":5323,"stargazers_count":0,"open_issues_count":3,"forks_count":3,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-05T21:27:14.597Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Jupyter Notebook","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/OpenBankProject.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":"2024-06-11T10:55:14.000Z","updated_at":"2025-02-19T13:30:28.000Z","dependencies_parsed_at":"2025-01-23T14:39:25.277Z","dependency_job_id":null,"html_url":"https://github.com/OpenBankProject/OBP-Opey","commit_stats":null,"previous_names":["openbankproject/obp-gpt","openbankproject/obp-opey"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OpenBankProject%2FOBP-Opey","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OpenBankProject%2FOBP-Opey/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OpenBankProject%2FOBP-Opey/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OpenBankProject%2FOBP-Opey/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/OpenBankProject","download_url":"https://codeload.github.com/OpenBankProject/OBP-Opey/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":242105234,"owners_count":20072453,"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":[],"created_at":"2024-11-15T19:48:16.996Z","updated_at":"2026-02-17T21:36:01.835Z","avatar_url":"https://github.com/OpenBankProject.png","language":"Jupyter Notebook","funding_links":[],"categories":[],"sub_categories":[],"readme":"# OBP-GPT (Opey)\nA helpful chatbot trained on Open Bank Project API documentation\n\n### Running with Docker (reccommended)\n#### 1. Set up Environment\n* [Install](https://docs.docker.com/compose/install/) docker compose if you haven't already\n* Copy .env-example to .env\n    * Copy over your OpenAI API Key\n\n* Make sure you have a `./certs/public_key.pem` file. Make the directory and copy over the key from API Explorer II if not.\n\nChange the .env file to have \n```.env\nENDPOINT_METADATA_PATH=./vector-database/endpoint_metadata.json\nGLOSSAY_METADATA_PATH=./vector-database/glossary_metadata.json\n\nENDPOINT_VECTOR_DATABASE_PATH=./vector-database/endpoint_index.faiss\nGLOSSARY_VECTOR_DATABASE_PATH=./vector-database/glossary_index.faiss\n```\n\n#### 2. Build App\n```bash\nsudo docker compose build\n```\n#### 3. Run\n```bash\nsudo docker compose up\n```\nNote: If you are running this on your local docker engine and you already have an instance of redis running, you may need to change the ```REDIS_PORT``` in the env file to avoid clashing.\n#### 4. Chat\nThe chat endpoint should now be running at http://127.0.0.1:5000/chat\n\nThe best way to interact with Opey locally is by running a version of [Api Explorer II](https://github.com/nemozak1/API-Explorer-II) Locally and using the chat widget.\n\nElse you can chat with the bot using curl (or whatever http client you like):\n\n```curl\ncurl -XPOST -H \"Content-type: application/json\" -d '{\n  \"session_id\": \"123456789\", \"obp_api_host\": \"https://test.openbankproject.com\", \"message\": \"Which endpoint would I use to create a new customer at a bank?\"\n}' 'http://127.0.0.1:5000/chat'\n```\n### Running Locally\n#### 1. Install dependencies\n```bash\npip install -r requirements.txt\n```\n#### 2. Set up Environment\n* Copy .env-example to .env\n    * Copy over your OpenAI API Key\n    * For running locally, set ```REDIS_HOST=localhost```\n    * **You will also need redis set up and running locally**, find instructions for this [here](https://redis.io/docs/latest/operate/oss_and_stack/install/install-redis/)\n\n#### 3. Create vector index\nWe need to register the OBP API documentation in a vector index, run:\n```bash\npython create_vector_index.py\n```\n#### 4. Run\nFor development:\n```\npython app.py\n```\nFor production we use gunicorn:\n```\ngunicorn --bind 0.0.0.0:5000 aop:app\n```\n#### 5. Chat\nSame as for docker (see above)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenbankproject%2Fobp-opey","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopenbankproject%2Fobp-opey","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenbankproject%2Fobp-opey/lists"}