/Iridium-AI

Inspired by the Vercel-Pinecone template

Primary LanguageTypeScript

Project logo

iridium-ai

Status GitHub Issues GitHub Pull Requests License


Iridium-AI is an Open Source Conversational Assistant, heavily inspired by pinecone-vercel-starter. Fell free to clone/Fork, or even use as a template.

📝 Table of Contents

🧐 About

Iridium-AI is based on pinecone-vercel-starter, but adds several new features, such as:

  • Multi-user auth.
  • Multi-file Upload via FilePond.
  • Bi-directional Audio via Web-Speech API.
  • Extended web crawl functionality to allow custom URL's, or google search.
  • Enhanced UI, with a retractable configuration pane, larger chat window and Web Speech options.

ezgif com-gif-maker

🏁 Getting Started

All you need to get started is to create a new env.local file in the project root folder and add required values:


# Optional, defaults to gtp-3.5-turbo
OPENAI_API_MODEL=

# Required
OPENAI_API_KEY=

# Optional, defaults to text-embedding-ada-002
OPENAI_API_EMBEDDING_MODEL=

# Required
PINECONE_API_KEY=
PINECONE_ENVIRONMENT=
PINECONE_INDEX=

See deployment for notes on how to deploy the project on a live system.

🎈 Setup

Once you clone/fork the repo, you will need access to:

  • OpenAI Account & API key
  • Pinecone Account & API key

Then,

npm install
npm run dev

🚀 Deployment

You can use Vercel to deploy the application + add your environment variables in just a few clicks!

⛏️ Built Using

  • Next.js - Front & Backend.
  • Vercel - Platform for Rapid build and deployment of web apps.
  • Pinecone - Vector Database.
  • Langchain - Framework for developing applications powered by language models

✍️ Authors

🎉 Acknowledgements