Skip to content

Commit 05f1112

Browse files
committed
Acrolinx updates
1 parent 4ed5e56 commit 05f1112

File tree

1 file changed

+21
-21
lines changed

1 file changed

+21
-21
lines changed

articles/ai-services/openai/how-to/use-web-app.md

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -20,16 +20,16 @@ Along with Azure OpenAI Studio, APIs, and SDKs, you can use the available standa
2020

2121
## Important considerations
2222

23-
- Publishing creates an Azure App Service instance in your subscription. It might incur costs depending on the [pricing plan](https://azure.microsoft.com/pricing/details/app-service/windows/) that you select. When you're done with your app, you can delete it from the Azure portal.
24-
- GPT-4 Turbo with Vision models are not supported.
23+
- Publishing creates an Azure App Service instance in your subscription. It might incur costs depending on the [pricing plan](https://azure.microsoft.com/pricing/details/app-service/windows/) that you select. When finished with your app, you can delete it from the Azure portal.
24+
- GPT-4 Turbo with Vision models aren't supported.
2525
- By default, the app is deployed with the Microsoft identity provider already configured. The identity provider restricts access to the app to members of your Azure tenant. To add or modify authentication:
2626
1. Go to the [Azure portal](https://portal.azure.com/#home) and search for the app name that you specified during publishing. Select the web app, and then select **Authentication** on the left menu. Then select **Add identity provider**.
2727

2828
:::image type="content" source="../media/quickstarts/web-app-authentication.png" alt-text="Screenshot of the authentication pane in the Azure portal." lightbox="../media/quickstarts/web-app-authentication.png":::
2929

3030
1. Select Microsoft as the identity provider. The default settings on this page restrict the app to your tenant only, so you don't need to change anything else here. Select **Add**.
3131

32-
Now users will be asked to sign in with their Microsoft Entra account to access your app. You can follow a similar process to add another identity provider if you prefer. The app doesn't use the user's sign-in information in any way other than verifying that the user is a member of your tenant.
32+
Now users are asked to sign in with their Microsoft Entra account to access your app. You can follow a similar process to add another identity provider if you prefer. The app doesn't use the user's sign-in information in any way other than verifying that the user is a member of your tenant.
3333

3434
## Web app customization
3535

@@ -39,7 +39,7 @@ When you're customizing the app, we recommend:
3939

4040
- Resetting the chat session (clear chat) if users change any settings. Notify the users that their chat history will be lost.
4141

42-
- Clearly communicating how each setting that you implement will affect the user experience.
42+
- Clearly communicating how each setting that you implement affects the user experience.
4343

4444
- Updating the app settings for each of your deployed apps to use new API keys after you rotate keys for your Azure OpenAI or Azure AI Search resource.
4545

@@ -82,30 +82,30 @@ After you turn on chat history, your users can show and hide it in the upper-rig
8282

8383
## Deleting your Cosmos DB instance
8484

85-
Deleting your web app does not delete your Cosmos DB instance automatically. To delete your Cosmos DB instance along with all stored chats, you need to go to the associated resource in the [Azure portal](https://portal.azure.com) and delete it. If you delete the Cosmos DB resource but keep the chat history option turned on in the studio, your users are notified of a connection error but can continue to use the web app without access to the chat history.
85+
Deleting your web app doesn't delete your Cosmos DB instance automatically. To delete your Cosmos DB instance along with all stored chats, you need to go to the associated resource in the [Azure portal](https://portal.azure.com) and delete it. If you delete the Cosmos DB resource but keep the chat history option turned on in the studio, your users aren'tified of a connection error but can continue to use the web app without access to the chat history.
8686

87-
## Enabling Entra ID authentication between services
87+
## Enabling Microsoft Entra ID authentication between services
8888

89-
To enable Entra ID for intra-service authentication for your web app, please follow these steps.
89+
To enable Microsoft Entra ID for intra-service authentication for your web app, follow these steps.
9090

9191
### Enable managed identity on your Azure OpenAI resource and Azure App Service
9292

93-
You can enable managed identity for the Azure OpenAI resource and the Azure App Service by navigating to "Identity" and turning on the system assigned managed identity in the Azure Portal for each resource.
93+
You can enable managed identity for the Azure OpenAI resource and the Azure App Service by navigating to "Identity" and turning on the system assigned managed identity in the Azure portal for each resource.
9494

9595

96-
![Screenshot that shows the application identity configuration in the Azure Portal](../media/use-your-data/openai-managed-identity.png)
96+
![Screenshot that shows the application identity configuration in the Azure portal](../media/use-your-data/openai-managed-identity.png)
9797

98-
Note: If you are using an embedding model deployed to the same resource used for inference, you only need to enable managed identity on one Azure OpenAI resource. If using an embedding model on a different resource from the one used for inference, you will also need to enable managed identity on the Azure OpenAI resource used to deploy your embedding model as well.
98+
Note: If you are using an embedding model deployed to the same resource used for inference, you only need to enable managed identity on one Azure OpenAI resource. If using an embedding model deployed to a different resource from the one used for inference, you also need to enable managed identity on the Azure OpenAI resource used to deploy your embedding model.
9999

100-
### Enable role-based access control on your Azure Search resource (optional)
100+
### Enable role-based access control (RBAC) on your Azure Search resource (optional)
101101

102-
If using On Your Data with Azure Search you should follow this step.
102+
If using On Your Data with Azure Search, you should follow this step.
103103

104-
To enable authentication to an Azure Search resource, you will need to enable role-based access control on the resource. Learn more about [enabling RBAC roles](../../../search/search-security-enable-roles.md) for your resources.
104+
To enable your Azure OpenAI resource to access your Azure Search resource, you need to enable role-based access control on your Azure Search resource. Learn more about [enabling RBAC roles](../../../search/search-security-enable-roles.md) for your resources.
105105

106106
### Assign RBAC roles to enable intra-service communication
107107

108-
The following table summarizes the RBAC role assignments needed for the Azure OpenAI resource used for inference, the Azure OpenAI resource used for embeddings (if using a separate resource for this purpose), Azure Search resource (if using) and the Azure App Service.
108+
The following table summarizes the RBAC role assignments needed for the Azure OpenAI resource used for inference, the Azure OpenAI resource used for embeddings (if using a separate resource for this purpose), Azure Search resource (if using), and the Azure App Service.
109109

110110
| Role | Assignee | Resource |
111111
| -------------------------------- | ------------------------ | ------------------------- |
@@ -120,16 +120,16 @@ To assign these roles, follow [these instructions](../../../role-based-access-co
120120

121121
In the webapp application settings, navigate to "Environment Variables" and make the following changes:
122122

123-
* Remove the environment variable `AZURE_OPENAI_KEY`, as it is no longer needed.
124-
* If using On Your Data with Azure Search and are using Entra ID authentication between Azure OpenAI and Azure Search, you should also delete the `AZURE_SEARCH_KEY` environment variables for the data source access keys as well.
123+
* Remove the environment variable `AZURE_OPENAI_KEY`, as it's no longer needed.
124+
* If using On Your Data with Azure Search and are using Microsoft Entra ID authentication between Azure OpenAI and Azure Search, you should also delete the `AZURE_SEARCH_KEY` environment variables for the data source access keys as well.
125125

126-
If using an embedding model deployed to the same resource as your model used for inference, there are no additional settings changes required.
126+
If using an embedding model deployed to the same resource as your model used for inference, there are no other settings changes required.
127127

128-
However, if you're using an embedding model deployed to a different resource, please make the following additional changes to your app's environment variables:
129-
* Set `AZURE_OPENAI_EMBEDDING_ENDPOINT` variable to the full API path of the embedding API for the resource you're using for embeddings, e.g. `https://<your embedding AOAI resource name>.openai.azure.com/openai/deployments/<your embedding deployment name>/embeddings`
130-
* Delete the `AZURE_OPENAI_EMBEDDING_KEY` variable to use Entra ID authentication.
128+
However, if you're using an embedding model deployed to a different resource, make the following additional changes to your app's environment variables:
129+
* Set `AZURE_OPENAI_EMBEDDING_ENDPOINT` variable to the full API path of the embedding API for the resource you're using for embeddings, for example, `https://<your embedding AOAI resource name>.openai.azure.com/openai/deployments/<your embedding deployment name>/embeddings`
130+
* Delete the `AZURE_OPENAI_EMBEDDING_KEY` variable to use Microsoft Entra ID authentication.
131131

132-
Once all of the environment variable changes are completed, restart the webapp to begin using Entra ID authentication between services in the webapp. It will take a few minutes after restarting for any settings changes to take effect.
132+
Once all of the environment variable changes are completed, restart the webapp to begin using Microsoft Entra ID authentication between services in the webapp. It will take a few minutes after restarting for any settings changes to take effect.
133133

134134
## Related content
135135

0 commit comments

Comments
 (0)