Use the new GPT-4 api to build a chatGPT chatbot for Large PDF docs (56 pages used in this example).
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.
Get in touch via twitter if you have questions
The visual guide of this repo and tutorial is in the visual guide folder.
If you run into errors, please review the troubleshooting section further down this page.
- Clone the repo
git clone [github https url]
- Install packages
pnpm install
- Set up your
.envfile
- Copy
.env.exampleinto.envYour.envfile should look like this:
OPENAI_API_KEY=
PINECONE_API_KEY=
PINECONE_ENVIRONMENT=
PINECONE_INDEX_NAME=
- Visit openai to retrieve API keys and insert into your
.envfile. - Visit pinecone to create and retrieve your API keys, and also retrieve your environment and index name from the dashboard.
-
In the
configfolder, replace thePINECONE_NAME_SPACEwith anamespacewhere you'd like to store your embeddings on Pinecone when you runpnpm run ingest. This namespace will later be used for queries and retrieval. -
In
utils/makechain.tschain change theQA_PROMPTfor your own usecase. ChangemodelNameinnew OpenAIChattogpt-3.5-turbo, if you don't have access togpt-4. Please verify outside this repo that you have access togpt-4, otherwise the application will not work with it.
-
In
docsfolder replace the pdf with your own pdf doc. -
In
scripts/ingest-data.tsreplacefilePathwithdocs/{yourdocname}.pdf -
Run the script
pnpm run ingestto '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 pnpm 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
.envfile that contains your valid (and working) API keys, environment and index name. - If you change
modelNameinOpenAIChatnote that the correct name of the alternative model isgpt-3.5-turbo - Make sure you have access to
gpt-4if you decide to use. Test your openAI keys outside the repo and make sure it works and that you have enough API credits.
Pinecone errors
- Make sure your pinecone dashboard
environmentandindexmatches the one in thepinecone.tsand.envfiles. - Check that you've set the vector dimensions to
1536. - Make sure your pinecone namespace is in lowercase.
- 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.
- Retry with a new Pinecone index.
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