Merge remote-tracking branch 'upstream/dev' into macae-v3-dev

Author: Fr4nc3

docs/DeploymentGuide.md

@@ -153,7 +153,8 @@ When you start the deployment, most parameters will have **default values**, but
 | **GPT Model Capacity**          | Sets the GPT model capacity.                                 | 150        |
 | **Image Tag**                  | Docker image tag used for container deployments.                                    | latest            |
 | **Enable Telemetry**           | Enables telemetry for monitoring and diagnostics.                                    | true              |
-
+| **Existing Log Analytics Workspace**        | To reuse an existing Log Analytics Workspace ID instead of creating a new one.              | *(none)*          |
+| **Existing Azure AI Foundry Project**        | To reuse an existing Azure AI Foundry Project ID instead of creating a new one.              | *(none)*          |
 
 </details>
 
@@ -176,6 +177,14 @@ To adjust quota settings, follow these [steps](./AzureGPTQuotaSettings.md).
 
 </details>
 
+<details>
+
+  <summary><b>Reusing an Existing Azure AI Foundry Project</b></summary>
+
+  Guide to get your [Existing Project ID](/docs/re-use-foundry-project.md)
+
+</details>
+
 ### Deploying with AZD
 
 Once you've opened the project in [Codespaces](#github-codespaces), [Dev Containers](#vs-code-dev-containers), or [locally](#local-environment), you can deploy it to Azure by following these steps:
@@ -311,11 +320,12 @@ The files for the dev container are located in `/.devcontainer/` folder.
 
 5. **Create a `.env` file:**
 
-   - Navigate to the `src` folder and create a `.env` file based on the provided `.env.sample` file.
+   - Navigate to the `src\backend` folder and create a `.env` file based on the provided `.env.sample` file.
 
 6. **Fill in the `.env` file:**
 
    - Use the output from the deployment or check the Azure Portal under "Deployments" in the resource group.
+   - Make sure to set APP_ENV to "**dev**" in `.env` file.
 
 7. **(Optional) Set up a virtual environment:**
 

docs/LocalDeployment.md

@@ -102,11 +102,16 @@ The files for the dev container are located in `/.devcontainer/` folder.
 
 6. **Create a `.env` file:**
 
-   - Navigate to the `src` folder and create a `.env` file based on the provided `.env.sample` file.
+   - Navigate to the `src\backend` folder and create a `.env` file based on the provided `.env.sample` file.
+   - Update the `.env` file with the required values from your Azure resource group in Azure Portal App Service environment variables.
+   - Alternatively, if resources were
+   provisioned using `azd provision` or `azd up`, a `.env` file is automatically generated in the `.azure/<env-name>/.env`
+   file. To get your `<env-name>` run `azd env list` to see which env is default.
 
 7. **Fill in the `.env` file:**
 
    - Use the output from the deployment or check the Azure Portal under "Deployments" in the resource group.
+   - Make sure to set APP_ENV to "**dev**" in `.env` file.
 
 8. **(Optional) Set up a virtual environment:**
 

docs/images/re_use_foundry_project/azure_ai_foundry_list.png

@@ -0,0 +1,44 @@
+[← Back to *DEPLOYMENT* guide](/docs/DeploymentGuide.md#deployment-steps)
+
+# Reusing an Existing Azure AI Foundry Project
+To configure your environment to use an existing Azure AI Foundry Project, follow these steps:
+---
+### 1. Go to Azure Portal
+Go to https://portal.azure.com
+
+### 2. Search for Azure AI Foundry
+In the search bar at the top, type "Azure AI Foundry" and click on it. Then select the Foundry service instance where your project exists.
+
+![alt text](../docs/images/re_use_foundry_project/azure_ai_foundry_list.png)
+
+### 3. Navigate to Projects under Resource Management
+On the left sidebar of the Foundry service blade:
+
+- Expand the Resource Management section
+- Click on Projects (this refers to the active Foundry project tied to the service)
+
+### 4. Click on the Project
+From the Projects view: Click on the project name to open its details
+
+    Note: You will see only one project listed here, as each Foundry service maps to a single project in this accelerator
+
+![alt text](../docs/images/re_use_foundry_project/navigate_to_projects.png)
+
+### 5. Copy Resource ID
+In the left-hand menu of the project blade: 
+
+- Click on Properties under Resource Management
+- Locate the Resource ID field
+- Click on the copy icon next to the Resource ID value
+
+![alt text](../docs/images/re_use_foundry_project/project_resource_id.png)
+
+### 6. Set the Foundry Project Resource ID in Your Environment
+Run the following command in your terminal
+```bash
+azd env set AZURE_ENV_FOUNDRY_PROJECT_ID '<Existing Foundry Project Resource ID>'
+```
+Replace `<Existing Foundry Project Resource ID>` with the value obtained from Step 5.
+
+### 7. Continue Deployment
+Proceed with the next steps in the [deployment guide](/docs/DeploymentGuide.md#deployment-steps).

docs/images/re_use_foundry_project/navigate_to_projects.png

@@ -1,4 +1,4 @@
-[← Back to *DEPLOYMENT* guide](/docs/DeploymentGuide.md#deployment-options--steps)
+[← Back to *DEPLOYMENT* guide](/docs/DeploymentGuide.md#deployment-steps)
 
 # Reusing an Existing Log Analytics Workspace
 To configure your environment to use an existing Log Analytics Workspace, follow these steps:
@@ -28,4 +28,4 @@ azd env set AZURE_ENV_LOG_ANALYTICS_WORKSPACE_ID '<Existing Log Analytics Worksp
 Replace `<Existing Log Analytics Workspace Id>` with the value obtained from Step 3.
 
 ### 5. Continue Deployment
-Proceed with the next steps in the [deployment guide](/docs/DeploymentGuide.md#deployment-options--steps).
+Proceed with the next steps in the [deployment guide](/docs/DeploymentGuide.md#deployment-steps).

docs/images/re_use_foundry_project/project_resource_id.png

@@ -18,6 +18,8 @@ param enableTelemetry bool = true
 
 param existingLogAnalyticsWorkspaceId string = ''
 
+param azureopenaiVersion string = '2025-01-01-preview'
+
 // Restricting deployment to only supported Azure OpenAI regions validated with GPT-4o model
 @metadata({
   azd : {
@@ -1000,7 +1002,7 @@ module containerApp 'br/public:avm/res/app/container-app:0.14.2' = if (container
           }
           {
             name: 'AZURE_OPENAI_API_VERSION'
-            value: '2025-01-01-preview' //TODO: set parameter/variable
+            value: azureopenaiVersion
           }
           {
             name: 'APPLICATIONINSIGHTS_INSTRUMENTATION_KEY'
@@ -1718,3 +1720,21 @@ type webSiteConfigurationType = {
   @description('Optional. The tag of the container image to be used by the Web Site.')
   containerImageTag: string?
 }
+
+
+output COSMOSDB_ENDPOINT string = 'https://${cosmosDbResourceName}.documents.azure.com:443/'
+output COSMOSDB_DATABASE string = cosmosDbDatabaseName
+output COSMOSDB_CONTAINER string = cosmosDbDatabaseMemoryContainerName
+output AZURE_OPENAI_ENDPOINT string = 'https://${aiFoundryAiServicesResourceName}.openai.azure.com/'
+output AZURE_OPENAI_MODEL_NAME string = aiFoundryAiServicesModelDeployment.name
+output AZURE_OPENAI_DEPLOYMENT_NAME string = aiFoundryAiServicesModelDeployment.name
+output AZURE_OPENAI_API_VERSION string = azureopenaiVersion
+// output APPLICATIONINSIGHTS_INSTRUMENTATION_KEY string = applicationInsights.outputs.instrumentationKey
+// output AZURE_AI_PROJECT_ENDPOINT string = aiFoundryAiServices.outputs.aiProjectInfo.apiEndpoint
+output AZURE_AI_SUBSCRIPTION_ID string = subscription().subscriptionId
+output AZURE_AI_RESOURCE_GROUP string = resourceGroup().name
+output AZURE_AI_PROJECT_NAME string = aiFoundryAiProjectName
+output AZURE_AI_MODEL_DEPLOYMENT_NAME string = aiFoundryAiServicesModelDeployment.name
+// output APPLICATIONINSIGHTS_CONNECTION_STRING string = applicationInsights.outputs.connectionString
+output AZURE_AI_AGENT_MODEL_DEPLOYMENT_NAME string = aiFoundryAiServicesModelDeployment.name
+output AZURE_AI_AGENT_ENDPOINT string = aiFoundryAiServices.outputs.aiProjectInfo.apiEndpoint

docs/re-use-foundry-project.md

@@ -8,6 +8,7 @@ dependencies = [
     "azure-ai-evaluation>=1.5.0",
     "azure-ai-inference>=1.0.0b9",
     "azure-ai-projects>=1.0.0b9",
+    "azure-ai-agents>=1.2.0b1",
     "azure-cosmos>=4.9.0",
     "azure-identity>=1.21.0",
     "azure-monitor-events-extension>=0.1.0",