Improve the documentation of Azure OpenAI #18
Merged
Conversation
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
github-actions
bot
added
the
documentation
aarthiem
reviewed
Jul 31, 2023
README.md
Outdated
|
|
||
| Here's a high level architecture diagram that illustrates these components. Excepted Azure OpenAI, all the other resources are provisioned in a single [resource group](https://learn.microsoft.com/en-us/azure/azure-resource-manager/management/manage-resource-groups-portal) that is created when you create your resources using `azd up`. | ||
|
|
||
|  | ||
|
|
||
| > This template provisions resources to an Azure subscription that you will select upon provisioning them. Please refer to the [Pricing calculator for Microsoft Azure](https://azure.microsoft.com/pricing/calculator/) and, if needed, update the included Azure resource definitions found in `infra/main.bicep` to suit your needs. | ||
|
|
||
| ## Azure OpenAI | ||
|
|
||
| This sample application uses Azure OpenAI. It is not part of the automated deployment process. You will need to create an Azure OpenAI resource and configure the application to use it. Please follow the instructions in the [Azure OpenAI documentation](https://learn.microsoft.com/en-us/azure/ai-services/openai/overview#how-do-i-get-access-to-azure-openai) to get access to Azure OpenAI. This sample app was developed and tested using `gpt-4` model. You need the following information from the Azure OpenAI resource to configure the application: |
There was a problem hiding this comment.
Add a note for networking options or go with default ones?
|
|
||
| - `azureOpenAiApiKey` - Azure OpenAI API key | ||
| - `azureOpenAiEndpoint` - Azure OpenAI endpoint | ||
| - `azureOpenAiDeploymentId` - Azure OpenAI deployment ID of `gpt-4` model |
There was a problem hiding this comment.
add details for how to retrieve the open ai deployment id
There was a problem hiding this comment.
also, lets add links for responsible AI documentation
…-java-openai-springapps into feature/15-update-the-documentation-to-explain-how-azure-sdk-for-java-is-used-for-openai
…ractices for Azure OpenAI models. Add how to get the key, the endpoint and the deployment id.
aarthiem
deleted the
feature/15-update-the-documentation-to-explain-how-azure-sdk-for-java-is-used-for-openai
branch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Purpose
Does this introduce a breaking change?
Pull Request Type
What kind of change does this Pull Request introduce?
How to Test
What to Check
Verify that the following are valid
Other Information