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.

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

ENH -- Swap "AZURE_OPENAI_KEY" for "AZURE_OPENAI_API_KEY" #486

Open
it176131 opened this issue Oct 15, 2024 · 0 comments
Open

ENH -- Swap "AZURE_OPENAI_KEY" for "AZURE_OPENAI_API_KEY" #486

it176131 opened this issue Oct 15, 2024 · 0 comments

Comments

@it176131
Copy link

In the Microsoft docs they mention setting the environment variable to "AZURE_OPENAI_API_KEY" rather than "AZURE_OPENAI_KEY".

This is also reflected in langchain's implementation.

Users could have the same key with two different variable names, but I think it'd be easier if we switched to the recommended name in the MS docs.

# from https://github.com/explosion/spacy-llm/blob/117f68963870fd2a4af4c706c40cf223c6ae6fde/spacy_llm/models/rest/azure/model.py#L62
    @property
    def credentials(self) -> Dict[str, str]:
        # Fetch and check the key
-       api_key = os.getenv("AZURE_OPENAI_KEY")
+       api_key = os.getenv("AZURE_OPENAI_API_KEY")
        if api_key is None:
            warnings.warn(
                "Could not find the API key to access the Azure OpenAI API. Ensure you have an API key "
                "set up (see "
                "https://learn.microsoft.com/en-us/azure/ai-services/openai/quickstart?pivots=rest-api&tabs=bash#set-up"
                ", then make it available as an environment variable 'AZURE_OPENAI_KEY'."
            )
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant