Use the new GPT-4 api to build a chatGPT chatbot for Large PDF docs.
Tech stack used includes LangChain, Pinecone, Typescript, Openai, and Next.js. LangChain is a framework that makes it easier to build scalable AI/LLM apps and chatbots. Pinecone is a vectorstore for storing embeddings and your PDF in text to later retrieve similar docs.
The visual guide of this repo and tutorial is in the visual guide
folder.
- Clone the repo
git clone [github https url]
- Install packages
pnpm install
- Set up your
.env
file
- Copy
.env.example
into.env
Your.env
file should look like this:
OPENAI_API_KEY=
PINECONE_API_KEY=
PINECONE_ENVIRONMENT=
- Visit openai to retrieve API keys and insert into your
.env
file. - Visit pinecone to create and retrieve your API keys.
-
In the
config
folder, replace thePINECONE_INDEX_NAME
andPINECONE_NAME_SPACE
with your own details from your pinecone dashboard. -
In
utils/makechain.ts
chain change theQA_PROMPT
for your own usecase. ChangemodelName
innew OpenAIChat
to a different api model if you don't have access togpt-4
. See the OpenAI docs for a list of supportedmodelName
s. For example you could usegpt-3.5-turbo
if you do not have access togpt-4
, yet.
-
In
docs
folder replace the pdf with your own pdf doc. -
In
scripts/ingest-data.ts
replacefilePath
withdocs/{yourdocname}.pdf
-
Run the script
npm run ingest
to 'ingest' and embed your docs -
Check Pinecone dashboard to verify your namespace and vectors have been added.
Once you've verified that the embeddings and content have been successfully added to your Pinecone, you can run the app npm run dev
to launch the local dev environment and then type a question in the chat interface.
In general, keep an eye out in the issues
and discussions
section of this repo for solutions.
General errors
- Make sure you're running the latest Node version. Run
node -v
- Make sure you're using the same versions of LangChain and Pinecone as this repo.
- Check that you've created an
.env
file that contains your valid (and working) API keys. - If you change
modelName
inOpenAIChat
note that the correct name of the alternative model isgpt-3.5-turbo
- Pinecone indexes of users on the Starter(free) plan are deleted after 7 days of inactivity. To prevent this, send an API request to Pinecone to reset the counter.
Pinecone errors
- Make sure your pinecone dashboard
environment
andindex
matches the one in yourconfig
folder. - Check that you've set the vector dimensions to
1536
. - Switch your Environment in pinecone to
us-east1-gcp
if the other environment is causing issues.
If you're stuck after trying all these steps, delete node_modules
, restart your computer, then pnpm install
again.
Frontend of this repo is inspired by langchain-chat-nextjs Tutorial from Mayowa Oshin (https://github.com/mayooear/gpt4-pdf-chatbot-langchain)