Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Adding OpenAI API Key Docs #164

Merged
merged 3 commits into from
Feb 3, 2024
Merged

Adding OpenAI API Key Docs #164

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
56e4ec5
adding steps for openai key generation
yashasvini121 Feb 2, 2024
141f2c3
adding .env setup step in quick-start
yashasvini121 Feb 2, 2024
f6d36b6
adding setup page to navigation bar
yashasvini121 Feb 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/guides/quick-start.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,10 @@ To get started with NeoGPT, make sure you have completed the [installation](http
python main.py --build
```
</Step>
<Step title="Update the .env-template file">
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.
</Step>
<Step title="Run NeoGPT">
Once the vector store is built, you can run NeoGPT. In the CLI using the following command:

Expand Down
22 changes: 22 additions & 0 deletions docs/guides/setup-openai-key.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"
---

<Note>
These steps are applicable to Windows, Linux as well as MacOS.
</Note>

<Steps>
<Step index="1" title="Create an OpenAI Account">
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.
</Step>
<Step index="2" title="Get API Key">
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.
</Step>
<Step index="3" title="Naming the Key">
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.
</Step>
<Step index="4" title="Copy API Key">
Copy the API key that is generated for you. You will need this key to use the OpenAI API with NeoGPT.
</Step>
<Step index="5" title="Adding API Key to 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.
</Step>
</Steps>
3 changes: 2 additions & 1 deletion docs/mint.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,8 @@
{
"group": "Guides",
"pages" : [
"guides/quick-start"
"guides/quick-start",
"guides/setup-openai-key"
]
},
{
Expand Down