Development

1. Clone the repo or download the ZIP

git clone [github https url]

2. Install packages

First run npm install yarn -g to install yarn globally (if you haven't already). or npm install

Then run:

yarn install

or

npm install

After installation, you should now see a node_modules folder.

3. Set up your .env file

• Copy .env.example into .env

4. npm run dev

• Visit openai to retrieve API keys and insert into your .env file.
• Visit pinecone to create and retrieve your API keys, and also retrieve your environment and index name from the dashboard.
• Check that you've set the vector dimensions to 1536 you can use the free plan

5. In utils/makechain.ts chain change the QA_PROMPT for your own usecase. Change modelName in new OpenAI to gpt-4, if you have access to gpt-4 api. Please verify outside this repo that you have access to gpt-4 api, otherwise the application will not work.

Run the app

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.

Step 1: Process

1. Go to the webapp frontend running in your browser (npm run dev), input the public github URL and click process (or ingest button, one or the other will download a zip file) and it will fetch all the repo data with the github api and more and make it all into a zip file.
2. Unzip the zip file into docs folder in the source code (you can keep it all in one folder)

Step 2: Ingest

1. Now that you have a folder in the docs folder that contains all the processed files from your github URL, go to terminal and run:

2. Run the script npm run ingest to 'ingest' and embed your docs. If you run into errors troubleshoot below.

3. Check Pinecone dashboard to verify your namespace and vectors have been added.

Troubleshooting

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
• Try a different PDF or convert your PDF to text first. It's possible your PDF is corrupted, scanned, or requires OCR to convert to text.
• Console.log the env variables and make sure they are exposed.
• 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, environment and index name.
• If you change modelName in OpenAI, make sure you have access to the api for the appropriate model.
• Make sure you have enough OpenAI credits and a valid card on your billings account.
• Check that you don't have multiple OPENAPI keys in your global environment. If you do, the local env file from the project will be overwritten by systems env variable.
• Try to hard code your API keys into the process.env variables if there are still issues.

Pinecone errors

• Make sure your pinecone dashboard environment and index matches the one in the pinecone.ts and .env files.
• 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 before 7 days.
• Retry from scratch with a new Pinecone project, index, and cloned repo.

Credit

Frontend of this repo is inspired by langchain-chat-nextjs