{"id":17686648,"url":"https://github.com/vinhnx/inkchatgpt","last_synced_at":"2025-05-13T00:34:42.432Z","repository":{"id":230560073,"uuid":"779540417","full_name":"vinhnx/InkChatGPT","owner":"vinhnx","description":"📕 Simple document Retrieval-augmented generation (RAG) LLM app","archived":false,"fork":false,"pushed_at":"2024-04-14T13:32:30.000Z","size":885,"stargazers_count":6,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-04-14T13:58:19.980Z","etag":null,"topics":["ai","chromadb","gpt","langchain","llm","openai","rag","streamlit","vector-database"],"latest_commit_sha":null,"homepage":"https://inkchatgpt.streamlit.app","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/vinhnx.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-03-30T05:04:08.000Z","updated_at":"2024-04-18T20:20:32.234Z","dependencies_parsed_at":"2024-04-18T20:20:30.144Z","dependency_job_id":null,"html_url":"https://github.com/vinhnx/InkChatGPT","commit_stats":null,"previous_names":["vinhnx/inkchatgpt"],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vinhnx%2FInkChatGPT","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vinhnx%2FInkChatGPT/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vinhnx%2FInkChatGPT/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vinhnx%2FInkChatGPT/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vinhnx","download_url":"https://codeload.github.com/vinhnx/InkChatGPT/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253850434,"owners_count":21973662,"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":["ai","chromadb","gpt","langchain","llm","openai","rag","streamlit","vector-database"],"created_at":"2024-10-24T10:45:30.828Z","updated_at":"2025-05-13T00:34:42.408Z","avatar_url":"https://github.com/vinhnx.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"---\ntitle: InkChatGPT\nemoji: 📚\nsdk: streamlit\nsdk_version: 1.33.0 # The latest supported version\napp_file: app.py\npinned: true\n---\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"./assets/large_icon.png\" height=\"200\" alt=\"icon\" /\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003cem\u003e📚 InkChatGPT - Chat with Documents\u003c/em\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n   \u003ca href=\"https://inkchatgpt.streamlit.app/\"\u003e\u003cimg src=\"https://static.streamlit.io/badges/streamlit_badge_black_white.svg\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n \u003ca href=\"https://huggingface.co/spaces/vinhnx90/inkchatgpt/\"\u003e🤗 Hugging Face\u003c/a\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n\u003cb\u003e\u003ca href=\"https://x.com/vinhnx\"\u003eTwitter\u003c/a\u003e\n\u003cspan\u003e\u0026nbsp;\u0026nbsp;•\u0026nbsp;\u0026nbsp;\u003c/span\u003e\n\u003ca href=\"https://github.com/vinhnx\"\u003eGitHub\u003c/a\u003e\u003c/b\u003e\n\u003c/p\u003e\n\n# InkChatGPT\n\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\n\n[![GitHub User's stars](https://img.shields.io/github/stars/vinhnx)](https://github.com/vinhnx)\n[![HackerNews User Karma](https://img.shields.io/hackernews/user-karma/vinhnx)](https://news.ycombinator.com/user?id=vinhnx)\n[![X (formerly Twitter) Follow](https://img.shields.io/twitter/follow/vinhnx)](https://x.com/vinhnx)\n\n`InkChatGPT` is a `Streamlit` application that allows users to upload PDF documents and engage in a conversational Q\u0026A with a language model (`LLM`) based on the content of those documents.\n\n--\n\nNew front end via Chainlit\nhttps://github.com/vinhnx/InkChatGPT/tree/try_chainlit\n\n--\n\n### Features\n\n-   Upload any documents and start asking key information about it, currently supports: PDF, TXT, DOCX, EPUB\n-   Limit 200MB per file\n-   Conversational Q\u0026A with LLM (powered by `OpenAI`'s `gpt-3.5-turbo` model)\n-   `HuggingFace` embeddings to generate embeddings for the document chunks with `all-MiniLM-L6-v2` model.\n-   `VectorDB` for document vector retrieval storage\n\n## Prerequisites\n\n-   Python 3.7 or later\n-   OpenAI API key (set as an environment variable: `OPENAI_API_KEY`)\n\n## Installation\n\n1. Clone the repository:\n\n```sh\ngit clone https://github.com/vinhnx/InkChatGPT.git\ncd InkChatGPT\n```\n\n2. Setup Virtual Environment\n   We recommend setting up a virtual environment to isolate Python dependencies, ensuring project-specific packages without conflicting with system-wide installations.\n\n```sh\npython3 -m venv venv\nsource venv/bin/activate\n```\n\n3. Install the required dependencies:\n\n```sh\npip install -r requirements.txt\n```\n\n## Usage\n\n1. Set the `OPENAI_API_KEY` environment variable with your OpenAI API key:\n\n```sh\nexport OPENAI_API_KEY=YOUR_API_KEY\n```\n\n2. Run the Streamlit app:\n\n```sh\nstreamlit run app.py\n```\n\n3. Upload PDF documents and start chatting with the LLM!\n\n## Contributing\n\nContributions are welcome! Please open an issue or submit a pull request if you have any improvements or bug fixes.\n\n## License\n\nThis project is licensed under the [MIT License](LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvinhnx%2Finkchatgpt","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvinhnx%2Finkchatgpt","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvinhnx%2Finkchatgpt/lists"}