Update Model Client Docs to Mention API Key from Environment Variables #5515
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.
Adds the following blurb to the model clients docs
API Keys From Environment Variables
In the examples above, we show that you can provide the API key through the
api_key
argument. Importantly, the OpenAI and Azure OpenAI clients use the openai package, which will automatically read an api key from the environment variable if one is not provided.OPENAI_API_KEY
environment variable.AZURE_OPENAI_API_KEY
environment variable.This is a good practice to explore, as it avoids including sensitive api keys in your code.
Why are these changes needed?
Related issue number
Checks