{"id":19834511,"url":"https://github.com/rishit7/corpusqnatool","last_synced_at":"2025-08-26T00:06:15.688Z","repository":{"id":235413061,"uuid":"790558261","full_name":"RISHIT7/CorpusQnATool","owner":"RISHIT7","description":"CorpusQnATool that uses a Corpus and chatGPT to for answers to input queries.","archived":false,"fork":false,"pushed_at":"2024-04-23T05:58:25.000Z","size":2518,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-28T21:48:40.549Z","etag":null,"topics":["corpus-tools","kmp-algorithm","llm"],"latest_commit_sha":null,"homepage":"","language":"C++","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/RISHIT7.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}},"created_at":"2024-04-23T05:20:34.000Z","updated_at":"2024-05-08T16:54:11.000Z","dependencies_parsed_at":"2024-04-23T09:45:09.536Z","dependency_job_id":"87a8318f-c347-4ffe-8856-a9367c943a2c","html_url":"https://github.com/RISHIT7/CorpusQnATool","commit_stats":null,"previous_names":["rishit7/corpusqnatool"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/RISHIT7/CorpusQnATool","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RISHIT7%2FCorpusQnATool","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RISHIT7%2FCorpusQnATool/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RISHIT7%2FCorpusQnATool/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RISHIT7%2FCorpusQnATool/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/RISHIT7","download_url":"https://codeload.github.com/RISHIT7/CorpusQnATool/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RISHIT7%2FCorpusQnATool/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":272149876,"owners_count":24882043,"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-25T02:00:12.092Z","response_time":1107,"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":["corpus-tools","kmp-algorithm","llm"],"created_at":"2024-11-12T12:04:56.304Z","updated_at":"2025-08-26T00:06:15.634Z","avatar_url":"https://github.com/RISHIT7.png","language":"C++","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Corpus QnA Tool\r\n\r\nWelcome to the Corpus QnA Tool! This project leverages the power of ChatGPT to provide answers to questions based on a custom input corpus. The tool allows you to input a query and receive relevant answers using the provided corpus for context.\r\n\r\n## Table of Contents\r\n- [Overview](#overview)\r\n- [Project Structure](#project-structure)\r\n- [Installation](#installation)\r\n- [Usage](#usage)\r\n- [Customization](#customization)\r\n- [Contributing](#contributing)\r\n- [License](#license)\r\n\r\n## Overview\r\nThe Corpus QnA Tool is designed to answer user queries based on a specified input corpus. By utilizing ChatGPT, the tool offers intelligent and context-aware responses to your questions. This tool is ideal for projects that require customized QnA capabilities using specific datasets or documents.\r\n\r\n## Project Structure\r\nThe project is organized as follows:\r\n\r\n```\r\n.\r\n├── Corpus\r\n│   ├── Book_1.txt                    # Input corpus for answering queries\r\n│   ├── Book_2.txt                \r\n|   ├──    ...    \r\n|   └── Book_n.txt\r\n├── results\r\n│   ├── paragraph_1.txt               # Most relevant paragraphs\r\n|   ├──    ...\r\n|   ├── paragraph_7.txt\r\n|   └── query.txt                     # Input query\r\n├── .gitignore                        # to Ignore certain files\r\n├── api_call.py                       # To call the chatGPT api\r\n├── Makefile\r\n├── Node.cpp\r\n├── Node.h\r\n├── qna_tool.cpp\r\n├── qna_tool.h\r\n├── tester.cpp\r\n└── README.md                         # Project README\r\n```\r\n\r\n- **Corpus**: Contains the input corpus used for answering queries.\r\n- **README.md**: This file provides an overview and guide to the project.\r\n- **requirements.txt**: Lists the Python packages required for the project.\r\n\r\n## Installation\r\nTo install the required dependencies, run the following command in your terminal:\r\n\r\n```bash\r\npip install -r requirements.txt\r\n```\r\n\r\n## Usage\r\n1. **Prepare the Corpus**: Place your input corpus file in the `Corpus` directory. Ensure the file is in a text format and has a file name Book_1.txt, and that the numbers are squential (e.g., `Book_1.txt`, `Book_2.txt`, `...`).\r\n\r\n2. **Run the make file**: Run the make file with your chatGPT API_KEY as\r\n```bash\r\nmake API_KEY=key\r\n```\r\n\r\n3. **Ask Questions**: Once the QnA tool is running, you can input a query and receive an answer based on the provided corpus.\r\n\r\n## Customization\r\nYou can customize the tool by modifying the source code. For example, you can adjust the response format, specify additional options for ChatGPT, or add support for other types of input corpora.\r\n\r\n## Contributing\r\nContributions are welcome! Please follow the [contribution guidelines](CONTRIBUTING.md) when submitting pull requests or issues.\r\n\r\n## License\r\nThis project is licensed under the [MIT License](LICENSE). Please see the LICENSE file for more details.\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frishit7%2Fcorpusqnatool","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frishit7%2Fcorpusqnatool","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frishit7%2Fcorpusqnatool/lists"}