{"id":22772804,"url":"https://github.com/athrael-soju/copperai","last_synced_at":"2025-04-15T06:49:57.544Z","repository":{"id":163546517,"uuid":"631749044","full_name":"athrael-soju/CopperAI","owner":"athrael-soju","description":"CopperAI offers a hands-free, voice-to-voice interaction system with a Large Language Model (LLM)","archived":true,"fork":false,"pushed_at":"2023-11-20T23:56:35.000Z","size":29902,"stargazers_count":31,"open_issues_count":7,"forks_count":6,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-15T06:49:51.487Z","etag":null,"topics":["chatbot","chatgpt","docker","eleven-labs-api","google-cloud","hooks-api-react","langchain-js","nextjs","nodejs","openai","react"],"latest_commit_sha":null,"homepage":"https://copper-ai.vercel.app","language":"TypeScript","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/athrael-soju.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-04-24T01:08:26.000Z","updated_at":"2025-03-23T06:43:40.000Z","dependencies_parsed_at":"2024-01-07T04:50:14.264Z","dependency_job_id":null,"html_url":"https://github.com/athrael-soju/CopperAI","commit_stats":null,"previous_names":["athrael-soju/copperai"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/athrael-soju%2FCopperAI","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/athrael-soju%2FCopperAI/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/athrael-soju%2FCopperAI/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/athrael-soju%2FCopperAI/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/athrael-soju","download_url":"https://codeload.github.com/athrael-soju/CopperAI/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249023707,"owners_count":21199958,"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","chatgpt","docker","eleven-labs-api","google-cloud","hooks-api-react","langchain-js","nextjs","nodejs","openai","react"],"created_at":"2024-12-11T17:09:43.133Z","updated_at":"2025-04-15T06:49:57.526Z","avatar_url":"https://github.com/athrael-soju.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n![ezgif-4-58049cbd43](https://github.com/athrael-soju/CopperAI/assets/25455658/0d9f84f6-26a9-41c2-b223-7c941204b422)\n\n\u003c/p\u003e\n\u003ch3 align=\"center\"\u003eCopper AI\u003c/h3\u003e\n\n\u003cdiv align=\"center\"\u003e\n\n[![Status](https://img.shields.io/badge/status-active-success.svg)]()\n[![GitHub Issues](https://img.shields.io/github/issues/kylelobo/The-Documentation-Compendium.svg)](https://github.com/athrael-soju/CopperAI/issues)\n[![GitHub Pull Requests](https://img.shields.io/github/issues-pr/kylelobo/The-Documentation-Compendium.svg)](https://github.com/athrael-soju/CopperAI/pulls)\n[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE.md)\n\n\u003c/div\u003e\n\n---\n\n\u003cp align=\"center\"\u003e Copper AI is a Voice to Voice Web Application that leverages the latest LLM Technologies to deliver a hands free user experience.\n    \u003cbr\u003e \n\u003c/p\u003e\n\n## 📝 Table of Contents\n\n- [Problem Statement](#problem_statement)\n- [Idea / Solution](#idea)\n- [Dependencies / Limitations](#limitations)\n- [Future Scope](#future_scope)\n- [Getting Started](#getting_started)\n- [Usage](#usage)\n- [Technology Stack](#tech_stack)\n- [Authors](#authors)\n- [Acknowledgments](#acknowledgments)\n- [Contribute](#contribute)\n\n## 🧐 Problem Statement \u003ca name = \"problem_statement\"\u003e\u003c/a\u003e\n\nProfessionals across various fields often confront unfamiliar or intricate situations, leading to inefficiencies and reduced customer satisfaction. Traditional solutions can be cumbersome, especially when professionals need hands-on interaction.\n\n## 💡 Idea / Solution \u003ca name = \"idea\"\u003e\u003c/a\u003e\n\nCopperAI offers a hands-free, voice-to-voice interaction system with a Large Language Model (LLM). Using voice commands, professionals can get instant guidance, troubleshooting steps, or relevant information without diverting their attention. Features:\n- Fully voiced, hands free interaction.\n- Persistent, multi user Vector based memory.\n- The Ability to ingest and interact with custom documents, or even books.\n- The ability to adjust its persona and response type based on user profile and professional aptitude.\n\n## ⛓️ Dependencies / Limitations \u003ca name = \"limitations\"\u003e\u003c/a\u003e\n\n - **Dependencies**: Next.js, OpenAI, LangChain, Pinecone, MongoDB, Google Cloud Text-to-Speech, ElevenLabs and more.\n - **Limitations**: Potential limitations could relate to the accuracy of voice recognition, the need for an active internet connection\n\n## 🚀 Future Scope \u003ca name = \"future_scope\"\u003e\u003c/a\u003e\n\nFuture enhancements could include integrating more advanced LLMs, expanding voice command capabilities, and supporting additional languages.\n\n## 🏁 Getting Started \u003ca name = \"getting_started\"\u003e\u003c/a\u003e\n\nThese instructions will guide you on setting up CopperAI on your local machine for development.\n\n### Prerequisites\n\n- Ensure you have Node.js, MongoDB, and other related dependencies installed. \n- Copy your .env.public file to .env.local and populate environment variables.\n```\n# Main\nNEXT_PUBLIC_AUDIO_DB_SENSITIVITY='-55'\n\n# OpenAI\nNEXT_PUBLIC_OPENAI_API_MODEL=\nNEXT_PUBLIC_OPENAI_API_KEY=\n\n# Auth\nNEXTAUTH_URL=\"http://localhost:3000\"\nNEXTAUTH_SECRET='secret'\nGITHUB_ID=\nGITHUB_SECRET=\nGOOGLE_ID=\nGOOGLE_SECRET=\n\n# TTS - google | elevenlabs\nNEXT_PUBLIC_TTS_PROVIDER=\"google\"\n\n# Google Cloud TTS\nNEXT_PUBLIC_GOOGLE_CLOUD_TTS_ENCODING=MP3\nNEXT_PUBLIC_GOOGLE_CLOUD_TTS_CLIENT_EMAIL=\nNEXT_PUBLIC_GOOGLE_CLOUD_TTS_API_KEY=\n\n# Eleven Labs TTS\nNEXT_PUBLIC_ELEVENLABS_TTS_API_KEY=\nNEXT_PUBLIC_ELEVENLABS_TTS_VOICE_ID_IRIS=\nNEXT_PUBLIC_ELEVENLABS_TTS_VOICE_ID_JUDE=\n\n# MongoDB\nMONGODB_URI=\"mongodb+srv://\u003cusername\u003e:\u003cpassword\u003e@\u003ccollection\u003e.mongodb.net/?retryWrites=true\u0026w=majority\"\n\n# Pinecone\nNEXT_PUBLIC_PINECONE_API_KEY=\nNEXT_PUBLIC_PINECONE_ENVIRONMENT=\nNEXT_PUBLIC_PINECONE_NAMESPACE=\nNEXT_PUBLIC_PINECONE_INDEX=\nNEXT_PUBLIC_PINECONE_SIMILARITY_CUTOFF=0.75\nNEXT_PUBLIC_PINECONE_TOPK=5\n\n# Langchain \nNEXT_PUBLIC_LANGCHAIN_ENABLED=\"false\"\nNEXT_PUBLIC_LANGCHAIN_CHUNK_SIZE=1000\nNEXT_PUBLIC_LANGCHAIN_OVERLAP_SIZE=0.2\nNEXT_PUBLIC_USE_CHAT_HISTORY=\"false\"\nNEXT_PUBLIC_USE_CHAT_TEMPERATURE=0\nNEXT_PUBLIC_USE_DOC_TEMPERATURE=0\nNEXT_PUBLIC_RETURN_SOURCE_DOCS=\"true\"\n\n# Speechly Polyfill\nNEXT_PUBLIC_SPEECHLY_APP_ID=\n\n# File Upload\nTMP_DIR=\"tmp\"\n```\n\n### Installing\n\nClone the repository and install the required packages.\n```\ngit clone https://github.com/athrael-soju/CopperAI.git\ncd CopperAI\nnpm install\n```\n\n## 🎈 Usage \u003ca name=\"usage\"\u003e\u003c/a\u003e\n\nAfter setting up, run `npm run dev` to launch the application. Visit `http://localhost:3000` to access CopperAI. \nAlternatively:\n- Run docker-compose up --build -d for a local container\n- Deploy the app on Vercel viat github.\n\n## ⛏️ Tech Stack \u003ca name = \"tech_stack\"\u003e\u003c/a\u003e\n\n- [Next.js](https://nextjs.org/) - Web Framework\n- [Docker](https://www.docker.com/) - Containerization and deployment.\n- [NodeJs](https://nodejs.org/en/) - Backend, utilized by Next.js.\n- [OpenAI API](https://openai.com/blog/introducing-chatgpt-and-whisper-apis) - ChatGPT model integration for chatbot functionality.\n- [Google TTS](https://cloud.google.com/text-to-speech/) - Converts text into natural-sounding speech in a variety of languages and voices.\n- [Eleven Labs TTS](https://elevenlabs.io/) - Generative AI Text to Speech \u0026 Voice Cloning \n- [Langchain](https://js.langchain.com/docs/) - Framework for developing applications powered by language models.\n- [MongoDB Atlas](https://www.mongodb.com/atlas/database) - Cloud Database\n\n## ✍️ Authors \u003ca name = \"authors\"\u003e\u003c/a\u003e\n\n- [@athrael-soju](https://github.com/athrael-soju) - Idea \u0026 Initial work\n\n## 🎉 Acknowledgments \u003ca name = \"acknowledgments\"\u003e\u003c/a\u003e\n\nThis is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).\n\n## Contribute \u003ca name = \"contribute\"\u003e\u003c/a\u003e\n- Fork the repo\n- Make your changes\n- Submit a pull request\n- I'll review it and merge it\n\n\u003c!-- \n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://www.youtube.com/watch?v=AdtQZ7iXkQ0\" target=\"_blank\" rel=\"noopener\"\u003e\n \u003cimg src=\"https://github.com/athrael-soju/whisperChat/blob/main/Landing-s.png\" alt=\"Project logo\"\u003e\u003c/a\u003e \n\u003c/p\u003e\n\u003cdiv align=\"center\"\u003e\n\n[![Status](https://img.shields.io/badge/status-active-success.svg)]()\n[![GitHub Issues](https://img.shields.io/github/issues/athrael-soju/whisperChat)](https://github.com/athrael-soju/whisperChat/issues)\n[![GitHub Pull Requests](https://img.shields.io/github/issues-pr/athrael-soju/whisperChat)](https://img.shields.io/github/issues-pr/athrael-soju/whisperChat)\n[![License](https://img.shields.io/badge/license-GNU%20GPL-blue.svg)](/LICENSE)\n\n\u003c/div\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fathrael-soju%2Fcopperai","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fathrael-soju%2Fcopperai","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fathrael-soju%2Fcopperai/lists"}