{"id":19242658,"url":"https://github.com/apolloconfig/apollo-qa-bot","last_synced_at":"2025-04-21T09:32:38.088Z","repository":{"id":176368609,"uuid":"657981163","full_name":"apolloconfig/apollo-qa-bot","owner":"apolloconfig","description":"A smart qa bot that can answer questions based on existing documents","archived":false,"fork":false,"pushed_at":"2024-11-15T09:50:23.000Z","size":80,"stargazers_count":13,"open_issues_count":1,"forks_count":8,"subscribers_count":10,"default_branch":"main","last_synced_at":"2025-04-10T18:47:26.511Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/apolloconfig.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-06-24T11:53:53.000Z","updated_at":"2025-02-15T08:24:29.000Z","dependencies_parsed_at":null,"dependency_job_id":"8973ac52-2bdb-4757-83d1-188d3b3d3e7c","html_url":"https://github.com/apolloconfig/apollo-qa-bot","commit_stats":{"total_commits":8,"total_committers":2,"mean_commits":4.0,"dds":0.125,"last_synced_commit":"e42fed026fabb1aada05fb4cd339462babd7f01a"},"previous_names":["apolloconfig/apollo-qa-bot"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apolloconfig%2Fapollo-qa-bot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apolloconfig%2Fapollo-qa-bot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apolloconfig%2Fapollo-qa-bot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apolloconfig%2Fapollo-qa-bot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/apolloconfig","download_url":"https://codeload.github.com/apolloconfig/apollo-qa-bot/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248997462,"owners_count":21195881,"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-09T17:15:01.058Z","updated_at":"2025-04-21T09:32:37.995Z","avatar_url":"https://github.com/apolloconfig.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# qa-bot\n\nA smart qa bot that can answer questions based on existing documents.\n\n## Getting Started\n\n### Prerequisites\n\n1. Java 17+\n2. Milvus 2.2.0+\n\n### Installation\n\n1. Clone this repo\n2. Execute `./build.sh`\n3. Upload and unzip the generated `qa-bot-x.x.x.jar` to the server\n\n### Configuration\n\n#### Edit the `config/application.yaml`\n\n1. Config the `markdown.files.location` to the directory of the markdown files\n2. Config the `markdown.files.scheduleEnabled` to `true` if you want to auto update the markdown files\n3. Config the `milvus.host` and `milvus.port` to the Milvus server\n4. Config the `milvus.useZillzCloud`, `milvus.zillizCloudUri` and `milvus.zillizCloudToken` if you are using Zilliz Cloud\n5. Config other parameters as needed\n\n#### Edit the `qa-bot.conf`\n\n1. Config the `OPENAI_API_KEY` to the OpenAI API key\n2. Config the `HTTP_PROXY` to the proxy server if needed\n\n```bash\nexport OPENAI_API_KEY=sk-************************************************\nexport HTTP_PROXY=http{s}://${username}:${password}@${url}:${port}\n```\n\n### Usage\n\n1. Start the service: `./scripts/startup.sh`\n2. Stop the service: `./scripts/shutdown.sh`\n3. Check the logs: `tail -f /opt/logs/qa-bot.log`\n4. Manually trigger the markdown files processing: `curl http://${your-server-url}:9090/markdown/load`\n5. Test the QA bot via browser: `http://${your-server-url}:9090`\n\n#### Integrate the QA bot with your website\n\nRefer [apollo pr](https://github.com/apolloconfig/apollo/pull/4908/) for an example.\n\n```html\n\n\u003chtml\u003e\n    \u003chead\u003e\n      ...\n    \u003c/head\u003e\n    \u003cbody\u003e\n      ...\n    \u003c/body\u003e\n    \u003c!-- add qa bot --\u003e\n    \u003cscript\u003e\n      (function() {\n        var link = document.createElement('link');\n        link.rel = 'stylesheet';\n        link.href = 'http://${your-server-url}:9090/qa-bot.css';\n        document.head.appendChild(link);\n\n        var script = document.createElement('script');\n        script.src = 'http://${your-server-url}:9090/qa-bot.js';\n        script.onload = function () {\n          QABot.initialize({\n            \"serverUrl\": \"http://${your-server-url}:9090/qa\",\n            \"documentSiteUrlPrefix\": \"https://${your-documentation-site-prefix-url}\"\n          });\n        };\n        document.body.appendChild(script);\n      })();\n    \u003c/script\u003e\n\u003c/html\u003e\n```","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapolloconfig%2Fapollo-qa-bot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fapolloconfig%2Fapollo-qa-bot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapolloconfig%2Fapollo-qa-bot/lists"}