Basic Setup

To get started with NeoGPT, make sure you have completed the installation step.

1

Build the vector store

The first step is to build the vector store. This is a one-time process that takes few minutes to complete. The vector store is built using the documents in the documents directory. If you want to use your own documents, read the custom documents section.

Terminal
python main.py --build
2

Run NeoGPT

Once the vector store is built, you can run NeoGPT. In the CLI using the following command:

Terminal
python main.py 

For the initial startup, this process may take a few minutes if the model has not been downloaded previously.

Once the model is loaded, you will see the following prompt:

Custom Documents

To use your own documents, you can add them to the documents directory. The following formats are supported by NeoGPT:

Adding Youtube Videos

You can add youtube videos to the vector store you can add the urls to builder.url file inside the documents directory. The following is an example of the builder.url file:

builder.url
https://www.youtube.com/watch?v=BPknz-hCnec

Adding Websites

You can add websites to the vector store you can add the urls to builder.url file inside the documents directory. The following is an example of the builder.url file:

builder.url
https://neokd.github.io/NeoGPT/

You can add --recursive flag to the --build command to recursively scrapes all the links in the builder.url file.