jadouse5 / ai-template Goto Github PK

View Code? Open in Web Editor NEW

This project forked from jordan-gilliam/ai-template

0.0 0.0 0.0 2.01 MB

Mercury - Train your own custom GPT. Chat with any file, or website.

License: The Unlicense

JavaScript 1.52% TypeScript 96.14% CSS 2.34%

ai-template's Introduction

Mercury

Chat with any Document or Website

Train your own custom GPT

Train on specific websites that you define
Train on documents you upload
Builds on dialog with Chat History
Cites sources
Perplexity style UI

Supported Files

Coming Soon

Train

1. Upload: `/api/embed-file`

file is uploaded -> cleaned to plain text, and split into 1000-character documents.
OpenAI's embedding API is used to generate embeddings for each document using the "text-embedding-ada-002" model.
The embeddings are stored in a Pinecone namespace.

2. Scrape: `/api/embed-webpage`

Web pages are scraped using cheerio, cleaned to plain text, and split into 1000-character documents.
OpenAI's embedding API is used to generate embeddings for each document using the "text-embedding-ada-002" model.
The embeddings are stored in a Pinecone namespace.

Query

Responding to queries: `/api/query`

A single embedding is generated from the user prompt.
The embedding is used to perform a similarity search against the vector database.
The results of the similarity search are used to construct a prompt for GPT-3.
The GTP-3 response is then streamed back to the user.

Getting Started

1. Clone Repo and Install Deps

To create a new project based on this template using degit:

npx degit https://github.com/Jordan-Gilliam/ai-template ai-template

cd ai-template
code .

install dependencies

npm i

2. Set-up Pinecone

Visit pinecone to create a free tier account and from the dashboard.
Create a new Pinecone Index with Dimensions 1536 eg:

Copy your API key
Record your Environment name ex: us-central1-gcp
Record your index name ex: mercury

3. Set-up OpenAi API

Visit openai to create and copy your API key

You can find this in the OpenAI web portal under API Keys

4. Open the `.env.local` file and configure your environment

cp .env.example .env.local

# OpenAI
OPENAI_API_KEY="sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
# Pinecone
PINECONE_API_KEY="xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx"
PINECONE_ENVIRONMENT="us-central1-gcp"
PINECONE_INDEX_NAME="mercury"

5. Start the app

npm run dev

Open http://localhost:3000 in your browser to view the app.

Template Features

OpenAI API (for generating embeddings and GPT-3 responses)
Pinecone
Nextjs API Routes (Edge runtime) - streaming
Tailwind CSS
Fonts with @next/font
Icons from Lucide
Dark mode with next-themes
Radix UI Primitives
Automatic import sorting with @ianvs/prettier-plugin-sort-imports

Inspiration:

🍴 Huge thanks to @gannonh and @mayooear for their fantastic work that helped inspire this template.

How embeddings work:

ChatGPT is a great tool for answering general questions, but it falls short when it comes to answering domain-specific questions as it often makes up answers to fill its knowledge gaps and doesn't cite sources. To solve this issue, this starter app uses embeddings coupled with vector search. This app shows how OpenAI's GPT-3 API can be used to create conversational interfaces for domain-specific knowledge.

Embeddings are vectors of floating-point numbers that represent the "relatedness" of text strings. They are very useful for tasks like ranking search results, clustering, and classification. In text embeddings, a high cosine similarity between two embedding vectors indicates that the corresponding text strings are highly related.

This app uses embeddings to generate a vector representation of a document and then uses vector search to find the most similar documents to the query. The results of the vector search are then used to construct a prompt for GPT-3, which generates a response. The response is then streamed back to the user.

Recommend Projects