-
Notifications
You must be signed in to change notification settings - Fork 4.6k
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.
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
Add instruction to set openai configuration information #12531
Merged
Merged
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -47,8 +47,17 @@ interaction between the two. | |
|
||
To configure the API token, follow these steps: | ||
|
||
1. [Instructions to get your API token] | ||
2. [Instructions to set the token in your LLM configuration] | ||
1. If you haven't already, sign up for an account on the OpenAI platform. | ||
Navigate to the OpenAI Key Management page at https://platform.openai.com/account/api-keys. | ||
Once there, click on the "Create New Secret Key" button to initiate the process of | ||
obtaining your API key. | ||
|
||
2. Setting the API key as an environment variable, you can use the following command in a | ||
terminal or command prompt: | ||
```shell Copy code | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. we might want to also give instructions on how to do it on Powershell. To that end we could use tabs like here |
||
export OPENAI_API_KEY=<your-api-key> | ||
``` | ||
Replace `<your-api-key>` with the actual API key you obtained from the OpenAI platform. | ||
m-vdb marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
### Model Configuration | ||
|
||
|
@@ -70,14 +79,19 @@ to be configured: | |
OpenAI Service. | ||
- `openai.api_base`: This should be the URL for your Azure OpenAI instance. An | ||
example might look like this: "https://docs-test-001.openai.azure.com/". | ||
- `openai.api_version`: This should be the version of Azure OpenAI you are | ||
using, such as "2023-05-15". | ||
|
||
|
||
To configure these parameters, follow these steps: | ||
|
||
1. [Instructions to set `openai.api_type`] | ||
2. [Instructions to set `openai.api_base`] | ||
3. [Instructions to set `openai.api_version`] | ||
1. To configure the `openai.api_type` as an environment variable: | ||
m-vdb marked this conversation as resolved.
Show resolved
Hide resolved
|
||
```shell | ||
export OPENAI_API_TYPE="azure" | ||
``` | ||
2. To configure the `openai.api_base` as an environment variable: | ||
m-vdb marked this conversation as resolved.
Show resolved
Hide resolved
|
||
```shell | ||
export OPENAI_API_BASE=<your-azure-openai-instance-url> | ||
``` | ||
|
||
|
||
## Other LLM providers | ||
|
||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.