From 56e4ec560c2ba98e75fe38512736072f7e30e51c Mon Sep 17 00:00:00 2001 From: Moxie Date: Sat, 3 Feb 2024 01:44:22 +0530 Subject: [PATCH 1/3] adding steps for openai key generation --- docs/guides/setup-openai-key.mdx | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/docs/guides/setup-openai-key.mdx b/docs/guides/setup-openai-key.mdx index 2841e3a..c6264f5 100644 --- a/docs/guides/setup-openai-key.mdx +++ b/docs/guides/setup-openai-key.mdx @@ -2,3 +2,25 @@ title: Setting Up OpenAI API Key description: "Learn how to set up your OpenAI API key to use it with NeoGPT" --- + + + These steps are applicable to Windows, Linux as well as MacOS. + + + + + Go to the [OpenAI website](https://openai.com/) and create an account. Once you have created an account, or logged in to your existing account, go to the [APPS Page](https://platform.openai.com/apps) and choose the API app. + + + Go to the [API keys page](https://platform.openai.com/account/api-keys) or choose the "API Keys" option from the left-hand menu and click on the "Create new Secret Key" button. + + + Give your key a name and click on the "Create" button. The permissions for the key should be set to "All" to allow NeoGPT to use the key. + + + Copy the API key that is generated for you. You will need this key to use the OpenAI API with NeoGPT. + + + Open the `.env-template` file or your `.env` file in the root directory of your NeoGPT project and update the `OPENAI_API_KEY` variable with the API key you copied earlier. + + \ No newline at end of file From 141f2c3f4dfe86cbf143b8b14e6a5273048fa749 Mon Sep 17 00:00:00 2001 From: Moxie Date: Sat, 3 Feb 2024 01:44:37 +0530 Subject: [PATCH 2/3] adding .env setup step in quick-start --- docs/guides/quick-start.mdx | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/guides/quick-start.mdx b/docs/guides/quick-start.mdx index 8b33261..69292cb 100644 --- a/docs/guides/quick-start.mdx +++ b/docs/guides/quick-start.mdx @@ -17,6 +17,10 @@ To get started with NeoGPT, make sure you have completed the [installation](http python main.py --build ``` + + The `.env-template` file contains the environment variables that are used by NeoGPT. Edit the file as per your requirements.\ + Read [OpenAI API Key Guide](/guides/setup-openai-key) on how to get the OpenAI API key. + Once the vector store is built, you can run NeoGPT. In the CLI using the following command: From f6d36b670c623eddbc7e020b8d2033a7d400500d Mon Sep 17 00:00:00 2001 From: Moxie Date: Sat, 3 Feb 2024 01:44:49 +0530 Subject: [PATCH 3/3] adding setup page to navigation bar --- docs/mint.json | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/mint.json b/docs/mint.json index 64fabf2..0f172d2 100644 --- a/docs/mint.json +++ b/docs/mint.json @@ -47,7 +47,8 @@ { "group": "Guides", "pages" : [ - "guides/quick-start" + "guides/quick-start", + "guides/setup-openai-key" ] }, {