Skip to content

Commit ea8531f

Browse files
update readme with security notice (#77)
add the required security notice
1 parent 3f813c1 commit ea8531f

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

README.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,17 @@
22

33
MENU: [**FEATURES**](#features) \| [**QUICK DEPLOY**](#quick-deploy) \| [**GETTING STARTED**](#getting-started) \| [**DEVELOPMENT**](#development) \| [**DEPLOYMENT**](#deployment) \| [**TRACING AND MONITORING**](#tracing-and-monitoring) \| [**DEVELOPMENT OPTIONS**](#development-options) \| [**GUIDANCE**](#guidance) \| [**TROUBLESHOOTING**](#troubleshooting)
44

5+
## Important Security Notice
6+
7+
This template, the application code and configuration it contains, has been built to showcase Microsoft Azure specific services and tools. We strongly advise our customers not to make this code part of their production environments without implementing or enabling additional security features.
8+
9+
For a more comprehensive list of best practices and security recommendations for Intelligent Applications, [visit our official documentation](https://learn.microsoft.com/en-us/azure/ai-foundry/).
10+
511
## Features
612

713
This solution deploys a web-based chat application with an AI agent running in Azure Container Apps. The agent leverages the Azure AI Agent service and utilizes Azure AI Search for knowledge retrieval from uploaded files, enabling it to generate responses with citations. The solution also includes built-in monitoring capabilities with tracing to ensure easier troubleshooting and optimized performance.
814

9-
This solution creates an Azure AI Foundry hub, project and connected resources including Azure AI Services, AI Search and more. More details about the resources that are created are located in the [resources](#resources) documentation. There are options to enable Retrieval-Augmented Generation (RAG) and use logging, tracing, and monitoring.
15+
This solution creates an Azure AI Foundry hub, project and connected resources including Azure AI Services, AI Search and more. More details about the resources can be found in the [resources](#resources) documentation. There are options to enable Retrieval-Augmented Generation (RAG) and use logging, tracing, and monitoring.
1016

1117
Instructions are provided for deployment through GitHub Codespaces, VS Code Dev Containers, and your local development environment.
1218

@@ -87,7 +93,7 @@ By default, the template deploys OpenAI's [file search](https://learn.microsoft.
8793
To use index search, please set the local environment variable `USE_AZURE_AI_SEARCH_SERVICE` to `true` during the `azd up` command. In this case the Azure AI Search resource will be deployed and used.
8894

8995
#### Logging
90-
If you want to enable logging to a file, navigate to `src/Dockerfile` and edit the code to uncomment the following line:
96+
To enable logging to a file, navigate to `src/Dockerfile` and edit the code to uncomment the following line:
9197

9298
```
9399
# ENV APP_LOG_FILE=app.log

0 commit comments

Comments
 (0)