Skip to content

Commit 5c69e25

Browse files
authored
Merge pull request #88 from Azure-Samples/howie/doc-update
doc update
2 parents 3502bd7 + fd6823f commit 5c69e25

File tree

3 files changed

+6
-2
lines changed

3 files changed

+6
-2
lines changed

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,10 @@ For a more comprehensive list of best practices and security recommendations for
1010

1111
## Features
1212

13-
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.
13+
This solution deploys a web-based chat application with an AI agent running in Azure Container Apps. Here is a screenshot:
14+
![Screenshot of chatting web application showing requests and responses between assistants and the user.](docs/webapp_screenshot.png)
15+
16+
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.
1417

1518
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.
1619

@@ -72,6 +75,7 @@ When you start a deployment, most parameters will have default values. You can c
7275

7376
| **Setting** | **Description** | **Default value** |
7477
|------------|----------------| ------------|
78+
| **Existing Project Connection String** | Specify an existing project connection string to be used instead of provisioning new resources. | |
7579
| **Azure Region** | Select a region with quota which supports your selected model. | |
7680
| **Model** | Choose from the [list of models supported by Azure AI Agent Service](https://learn.microsoft.com/azure/ai-services/agents/concepts/model-region-support) for your selected region. | gpt-4o-mini |
7781
| **Model Format** | Choose from OpenAI or Microsoft, depending on your model. | OpenAI |

docs/deploy_customization.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,9 @@ Once you disable these resources, they will not be deployed when you run `azd up
2222
By default, this template will use a naming convention with unique strings to prevent naming collisions within Azure.
2323
To override default naming conventions, the following keys can be set:
2424

25+
* `AZURE_EXISTING_AIPROJECT_CONNECTION_STRING` - An existing connection string to be use. If specified, resources for AI Foundry Hub, AI Foundry Project, and Azure AI service will not be created.
2526
* `AZURE_AIHUB_NAME` - The name of the AI Foundry Hub resource
2627
* `AZURE_AIPROJECT_NAME` - The name of the AI Foundry Project
27-
* `AZURE_AIENDPOINT_NAME` - The name of the AI Foundry online endpoint used for deployments
2828
* `AZURE_AISERVICES_NAME` - The name of the Azure AI service
2929
* `AZURE_SEARCH_SERVICE_NAME` - The name of the Azure Search service
3030
* `AZURE_STORAGE_ACCOUNT_NAME` - The name of the Storage Account

docs/webapp_screenshot.png

216 KB
Loading

0 commit comments

Comments
 (0)