openai-cookbook/apps/file-q-and-a/nextjs
2023-04-02 17:32:37 -07:00
..
public File Q and A app 2023-02-11 16:29:30 -08:00
src Update FileQandAArea.tsx 2023-04-02 17:32:37 -07:00
.env.local.example File Q and A app 2023-02-11 16:29:30 -08:00
.eslintrc.json File Q and A app 2023-02-11 16:29:30 -08:00
.gitignore File Q and A app 2023-02-11 16:29:30 -08:00
next.config.js File Q and A app 2023-02-11 16:29:30 -08:00
package-lock.json increase OpenAI NodeJS client version 2023-04-02 17:26:19 -07:00
package.json increase OpenAI NodeJS client version 2023-04-02 17:26:19 -07:00
postcss.config.js File Q and A app 2023-02-11 16:29:30 -08:00
README.md File Q and A app 2023-02-11 16:29:30 -08:00
tailwind.config.js File Q and A app 2023-02-11 16:29:30 -08:00
tsconfig.json File Q and A app 2023-02-11 16:29:30 -08:00

File Q&A

File Q&A is a Next.js app that lets you find answers in your files using OpenAI APIs. You can upload files and ask questions related to their content, and the app will use embeddings and GPT to generate answers from the most relevant files.

Requirements

To run the app, you need an OpenAI API key. You can create a new API key here.

Set Up

If you don't have Node.js and npm already, install them from https://nodejs.org/en/download/.

In your terminal, navigate to the nextjs directory of this example app, and then install dependencies:

npm install

Copy the .env.local.example file into a .env.local file and fill out the OpenAI API key field.

Development

Run the development server:

npm run dev

Open http://localhost:3000 with your browser to see the app.

Deployment

You can deploy the app on Vercel, the platform from the creators of Next.js. Check out the Next.js deployment documentation for more details.

Limitations

Uploaded files and generated embeddings don't persist on browser refresh. If you want to store more embeddings, we recommend using a vector database (e.g. Pinecone, Weaviate, Milvus, Qdrant, Redis, FAISS, etc.). The nextjs-with-flask-server version of this demo uses a Pinecone vector database.

The app may sometimes generate answers that are not in the files, or hallucinate about the existence of files that are not uploaded.