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

Describe openAIApiKey in more detail. Fixes #318 #340

Merged

Conversation

EdwinOtten
Copy link
Contributor

Improve the experience when running azd up by providing more context on how to use the openAIApiKey parameter.

Purpose

When following the Deployment instructions and running azd up, the user gets prompted to enter a parameter without much context:

? Enter a value for the 'openAIApiKey' infrastructure parameter: [? for help]

In #318 FBoucher mentioned that the parameter is optional and can be left empty. Sadly the hint doesn't say that:

Hint: OpenAI API Key

Does this introduce a breaking change?

[ ] Yes
[x] No

Pull Request Type

What kind of change does this Pull Request introduce?

[ ] Bugfix
[x] Feature
[ ] Code style update (formatting, local variables)
[ ] Refactoring (no functional changes, no api changes)
[ ] Documentation content changes
[ ] Other... Please describe:

How to Test

  • Get the code
git clone https://github.com/EdwinOtten/azure-search-openai-demo-csharp.git
cd [local directory]
git checkout feature/azd-up-improve-experience

What to Check

Verify that the following are valid:

  • The hint for the openAIApiKey now says:
    • OpenAI API Key, leave empty to provision a new Azure OpenAI instance

Improve the experience when running `azd up` by providing more context on how to use the openAIApiKey parameter.
Copy link

@rashadh rashadh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

if no api key is available it will be provisioned, thanks for clarifying it

@elbruno elbruno merged commit d722ba4 into Azure-Samples:main Aug 26, 2024
1 check passed
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

Successfully merging this pull request may close these issues.

3 participants