+
+[**SOLUTION OVERVIEW**](#solution-overview) \| [**GETTING STARTED**](#getting-started) \| [**LOCAL DEVELOPMENT**](#local-development) \| [**RESOURCE CLEAN-UP**](#resource-clean-up) \| [**GUIDANCE**](#guidance) \| [**TROUBLESHOOTING**](./docs/troubleshooting.md)
+
+
+
+## Solution Overview
+
+This solution deploys a web-based chat application with an AI agent running in Azure Container App.
+
+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.
+
+This solution creates an Azure AI Foundry project and Azure AI services. More details about the resources can be found in the [resources](#resources) documentation. There are options to enable logging, tracing, and monitoring.
+
+Instructions are provided for deployment through GitHub Codespaces, VS Code Dev Containers, and your local development environment.
+
+### Solution Architecture
+
+
+
+The app code runs in Azure Container App to process the user input and generate a response to the user. It leverages Azure AI projects and Azure AI services, including the model and agent.
+
+### Key Features
+
+- **[Knowledge Retrieval](./docs/deploy_customization.md#enabling-and-disabling-resources-provision)**+The AI agent uses file search or Azure AI Search to retrieve knowledge from uploaded files. + +- **[Customizable AI Model Deployment](./docs/deploy_customization.md#customizing-model-deployments)**
+The solution allows users to configure and deploy AI models, such as gpt-4o-mini, with options to adjust model capacity, and knowledge retrieval methods. + +- **[Built-in Monitoring and Tracing](./docs/other_features.md#tracing-and-monitoring)**
+Integrated monitoring capabilities, including Azure Monitor and Application Insights, enable tracing and logging for easier troubleshooting and performance optimization. + +- **[Flexible Deployment Options](./docs/deployment.md)**
+The solution supports deployment through GitHub Codespaces, VS Code Dev Containers, or local environments, providing flexibility for different development workflows. + +- **[Agent Evaluation](./docs/other_features.md#agent-evaluation)**
+This solution demonstrates how you can evaluate your agent's performance and quality during local development and incorporate it into monitoring and CI/CD workflow. + +- **[AI Red Teaming Agent](./docs/other_features.md#ai-red-teaming-agent)**
+Facilitates the creation of an AI Red Teaming Agent that can run batch automated scans for safety and security scans on your Agent solution to check your risk posture before deploying it into production. + +
+ +Here is a screenshot showing the chatting web application with requests and responses between the system and the user: + + + +## Getting Started + +| [](https://codespaces.new/Azure-Samples/get-started-with-ai-agents) | [](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/Azure-Samples/get-started-with-ai-agents) | +|---|---| + +1. Click `Open in GitHub Codespaces` or `Dev Containers` button above +2. Wait for the environment to load +3. Run the following commands in the terminal: + ```bash + azd up + ``` +4. Follow the prompts to select your Azure subscription and region +5. Wait for deployment to complete (5-20 minutes) - you'll get a web app URL when finished + +For detailed deployment options and troubleshooting, see the [full deployment guide](./docs/deployment.md). +**After deployment, try these [sample questions](./docs/sample_questions.md) to test your agent.** + +## Local Development + +For developers who want to run the application locally or customize the agent: + +- **[Local Development Guide](./docs/local_development.md)** - Set up a local development environment, customize the frontend (starting with AgentPreview.tsx), modify agent instructions and tools, and use evaluation to improve your code. + +This guide covers: +- Environment setup and prerequisites +- Running the development server locally +- Frontend customization and backend communication +- Agent instructions and tools modification +- File management and agent recreation +- Using agent evaluation for code improvement + + +## Resource Clean-up + +To prevent incurring unnecessary charges, it's important to clean up your Azure resources after completing your work with the application. + +- **When to Clean Up:** + - After you have finished testing or demonstrating the application. + - If the application is no longer needed or you have transitioned to a different project or environment. + - When you have completed development and are ready to decommission the application. + +- **Deleting Resources:** + To delete all associated resources and shut down the application, execute the following command: + + ```bash + azd down + ``` + + Please note that this process may take up to 20 minutes to complete. + +⚠️ Alternatively, you can delete the resource group directly from the Azure Portal to clean up resources. + +## Guidance + +### Costs + +Pricing varies per region and usage, so it isn't possible to predict exact costs for your usage. +The majority of the Azure resources used in this infrastructure are on usage-based pricing tiers. + +You can try the [Azure pricing calculator](https://azure.microsoft.com/pricing/calculator) for the resources: + +- **Azure AI Foundry**: Free tier. [Pricing](https://azure.microsoft.com/pricing/details/ai-studio/) +- **Azure Storage Account**: Standard tier, LRS. Pricing is based on storage and operations. [Pricing](https://azure.microsoft.com/pricing/details/storage/blobs/) +- **Azure AI Services**: S0 tier, defaults to gpt-4o-mini. Pricing is based on token count. [Pricing](https://azure.microsoft.com/pricing/details/cognitive-services/) +- **Azure Container App**: Consumption tier with 0.5 CPU, 1GiB memory/storage. Pricing is based on resource allocation, and each month allows for a certain amount of free usage. [Pricing](https://azure.microsoft.com/pricing/details/container-apps/) +- **Log analytics**: Pay-as-you-go tier. Costs based on data ingested. [Pricing](https://azure.microsoft.com/pricing/details/monitor/) +- **Agent Evaluations**: Incurs the cost of your provided model deployment used for local evaluations. +- **AI Red Teaming Agent**: Leverages Azure AI Risk and Safety Evaluations to assess attack success from the automated AI red teaming scan. Users are billed based on the consumption of Risk and Safety Evaluations as listed in [our Azure pricing page](https://azure.microsoft.com/pricing/details/ai-foundry/). Click on the tab labeled “Complete AI Toolchain” to view the pricing details. + +⚠️ To avoid unnecessary costs, remember to take down your app if it's no longer in use, +either by deleting the resource group in the Portal or running `azd down`. + +### Security guidelines + +This template also uses [Managed Identity](https://learn.microsoft.com/entra/identity/managed-identities-azure-resources/overview) for local development and deployment. + +To ensure continued best practices in your own repository, we recommend that anyone creating solutions based on our templates ensure that the [Github secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning) setting is enabled. + +You may want to consider additional security measures, such as: + +- Enabling Microsoft Defender for Cloud to [secure your Azure resources](https://learn.microsoft.com/azure/defender-for-cloud/). +- Protecting the Azure Container Apps instance with a [firewall](https://learn.microsoft.com/azure/container-apps/waf-app-gateway) and/or [Virtual Network](https://learn.microsoft.com/azure/container-apps/networking?tabs=workload-profiles-env%2Cazure-cli). + +> **Important Security Notice**
+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.
+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/). + +### Resources + +This template creates everything you need to get started with Azure AI Foundry: + +| Resource | Description | +|----------|-------------| +| [Azure AI Project](https://learn.microsoft.com/azure/ai-studio/how-to/create-projects) | Provides a collaborative workspace for AI development with access to models, data, and compute resources | +| [Azure OpenAI Service](https://learn.microsoft.com/azure/ai-services/openai/) | Powers the AI agents for conversational AI and intelligent search capabilities. Default models deployed are gpt-4o-mini, but any Azure AI models can be specified per the [documentation](docs/deploy_customization.md#customizing-model-deployments) | +| [Azure Container Apps](https://learn.microsoft.com/azure/container-apps/) | Hosts and scales the web application with serverless containers | +| [Azure Container Registry](https://learn.microsoft.com/azure/container-registry/) | Stores and manages container images for secure deployment | +| [Storage Account](https://learn.microsoft.com/azure/storage/blobs/) | Provides blob storage for application data and file uploads | +| [AI Search Service](https://learn.microsoft.com/azure/search/) | *Optional* - Enables hybrid search capabilities combining semantic and vector search | +| [Application Insights](https://learn.microsoft.com/azure/azure-monitor/app/app-insights-overview) | *Optional* - Provides application performance monitoring, logging, and telemetry for debugging and optimization | +| [Log Analytics Workspace](https://learn.microsoft.com/azure/azure-monitor/logs/log-analytics-workspace-overview) | *Optional* - Collects and analyzes telemetry data for monitoring and troubleshooting | + +## Troubleshooting + +For solutions to common deployment, container app, and agent issues, see the [Troubleshooting Guide](./docs/troubleshooting.md). + + +## Disclaimers + +To the extent that the Software includes components or code used in or derived from Microsoft products or services, including without limitation Microsoft Azure Services (collectively, “Microsoft Products and Services”), you must also comply with the Product Terms applicable to such Microsoft Products and Services. You acknowledge and agree that the license governing the Software does not grant you a license or other right to use Microsoft Products and Services. Nothing in the license or this ReadMe file will serve to supersede, amend, terminate or modify any terms in the Product Terms for any Microsoft Products and Services. + +You must also comply with all domestic and international export laws and regulations that apply to the Software, which include restrictions on destinations, end users, and end use. For further information on export restrictions, visit
+
+
+Deploy in GitHub Codespaces
+ +### GitHub Codespaces + +You can run this template virtually by using GitHub Codespaces. The button will open a web-based VS Code instance in your browser: + +1. Open the template (this may take several minutes): + + [](https://codespaces.new/Azure-Samples/get-started-with-ai-agents) + +2. Open a terminal window +3. Continue with the [deploying steps](#deploying-with-azd) + +
+
+
+Deploy in VS Code
+ +### VS Code Dev Containers + +A related option is VS Code Dev Containers, which will open the project in your local VS Code using the [Dev Containers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers): + +1. Start Docker Desktop (install it if not already installed [Docker Desktop](https://www.docker.com/products/docker-desktop/)) +2. Open the project: + + [](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/Azure-Samples/get-started-with-ai-agents) + +3. In the VS Code window that opens, once the project files show up (this may take several minutes), open a terminal window. +4. Continue with the [deploying steps](#deploying-with-azd). + +
+
+
+Deploy in your local Environment
+ +### Local Environment + +If you're not using one of the above options for opening the project, then you'll need to: + +1. Make sure the following tools are installed: + + - [Azure Developer CLI (azd)](https://aka.ms/install-azd) Install or update to the latest version. Instructions can be found on the linked page. + - [Python 3.9+](https://www.python.org/downloads/) + - [Git](https://git-scm.com/downloads) + - \[Windows Only\] [PowerShell](https://learn.microsoft.com/powershell/scripting/install/installing-powershell-on-windows) of the latest version, needed only for local application development on Windows operation system. Please make sure that path to power shell executable `pwsh.exe` is added to the `PATH` variable. + +2. Clone the repository or download the project code via command-line: + + ```shell + azd init -t get-started-with-ai-agents + ``` + +3. Open the project folder in your terminal or editor. +4. Continue with the [deploying steps](#deploying-with-azd). + +
+ ' in the terminal, which should open a new tab in the browser.
+
+13. Enter your message in the box.
+
+
+
+Develop with Local Development Server
+ +### Develop with Local Development Server + +You can optionally use a local development server to test app changes locally. Make sure you first [deployed the app](#deploying-with-azd) to Azure before running the development server. + +1. Create a [Python virtual environment](https://docs.python.org/3/tutorial/venv.html#creating-virtual-environments) and activate it. + + On Windows: + + ```shell + python -m venv .venv + .venv\scripts\activate + ``` + + On Linux: + + ```shell + python3 -m venv .venv + source .venv/bin/activate + ``` + +2. Navigate to the `src` directory: + + ```shell + cd src + ``` + +3. Install required Python packages: + + ```shell + python -m pip install -r requirements.txt + ``` + +4. Install [Node.js](https://nodejs.org/) (v20 or later). + +5. Install [pnpm](https://pnpm.io/installation) + +6. Navigate to the frontend directory and setup for React UI: + + ```shell + cd src/frontend + pnpm run setup + ``` + +7. Fill in the environment variables in `.env`. + +9. (Optional) if you have changes in `src/frontend`, execute: + + ```shell + pnpm build + ``` + + The build output will be placed in the `../api/static/react` directory, where the backend can serve it. + +10. (Optional) If you have changes in `gunicorn.conf.py`, execute: + + ```shell + python gunicorn.conf.py + ``` + +11. Run the local server: + + ```shell + python -m uvicorn "api.main:create_app" --factory --reload + ``` + +12. Click '+ +Consider the following settings during deployment: + +
+
+
+Configurable Deployment Settings
+ +When you start a deployment, most parameters will have default values. You can change the following default settings: + +| **Setting** | **Description** | **Default value** | +|------------|----------------| ------------| +| **Existing Project Resource ID** | Specify an existing project resource ID to be used instead of provisioning new Azure AI Foundry project and Azure AI services. | | +| **Azure Region** | Select a region with quota which supports your selected model. | | +| **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 | +| **Model Format** | Choose from OpenAI or Microsoft, depending on your model. | OpenAI | +| **Model Deployment Capacity** | Configure capacity for your model. | 80k | +| **Embedding Model** | Choose from text-embedding-3-large, text-embedding-3-small, and text-embedding-ada-002. This may only be deployed if Azure AI Search is enabled. | text-embedding-3-small | +| **Embedding Model Capacity** | Configure capacity for your embedding model. | 50k | +| **Knowledge Retrieval** | Choose OpenAI's file search or Azure AI Search Index. | OpenAI's file search | + +For a detailed description of customizable fields and instructions, view the [deployment customization guide](deploy_customization.md). + + +
+
+azd env set AZURE_AI_AGENT_MODEL_VERSION
+```
+
+
+Configurable Agents Knowledge Retrieval
+ +### Configurable Agents Knowledge Retrieval + +By default, the template deploys OpenAI's [file search](https://learn.microsoft.com/azure/ai-services/agents/how-to/tools/file-search?tabs=python&pivots=overview) for agent's knowledge retrieval. An agent also can perform search using the search index, deployed in Azure AI Search resource. The semantic index search represents so-called hybrid search i.e. it uses LLM to search for the relevant context in the provided index as well as embedding similarity search. This index is built from the `embeddings.csv` file, containing the embeddings vectors, followed by the contexts. +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. For more information on Azure AI serach, please see the [Azure AI Search Setup Guide](ai_search.md) + +To specify the model (e.g. gpt-4o-mini, gpt-4o) that is deployed for the agent when `azd up` is called, set the following environment variables: + +```shell +azd env set AZURE_AI_AGENT_MODEL_NAME
+
+
+Configure Tracing and Azure Monitor
+To enable tracing for AI Agent to Azure Monitor, set the following environment variable: + +```shell +azd env set ENABLE_AZURE_MONITOR_TRACING true +``` + +To enable message contents to be included in the traces, set the following environment variable. Note that the messages may contain personally identifiable information. + +```shell +azd env set AZURE_TRACING_GEN_AI_CONTENT_RECORDING_ENABLED true +``` + +You can view the App Insights tracing in Azure AI Foundry. Select your project on the Azure AI Foundry page and then click 'Tracing'. + +
+
+
+
+### Deploying with AZD
+
+Once you've opened the project in [Codespaces](#github-codespaces) or in [Dev Containers](#vs-code-dev-containers) or [locally](#local-environment), you can deploy it to Azure following the following steps.
+
+1. (Optional) If you would like to customize the deployment to [disable resources](deploy_customization.md#enabling-and-disabling-resources-provision), [customize resource names](deploy_customization.md#customizing-resource-names), [customize the models](deploy_customization.md#customizing-model-deployments) or [increase quota](deploy_customization.md#setting-models-capacity-and-deployment-sku), you can follow those steps now.
+
+ ⚠️ **NOTE!** For optimal performance, the recommended quota is 100k tokens per minute. If you have the capacity, we recommend increasing the quota by running the following command:
+
+ ```shell
+ azd env set AZURE_AI_AGENT_DEPLOYMENT_CAPACITY 100
+ ```
+
+ ⚠️ If you do not increase your quota, you may encounter rate limit issues. If needed, you can increase the quota after deployment by editing your model in the Models and Endpoints tab of the [Azure AI Foundry Portal](https://ai.azure.com/).
+
+2. Provision resources, build a docker image using `src` folder, and deploy:
+
+ ```shell
+ azd up
+ ```
+
+3. You will be prompted to provide an `azd` environment name (like "azureaiapp"), select a subscription from your Azure account, and select a location which has quota for all the resources. Then, it will provision the resources in your account and deploy the latest code.
+
+ - For guidance on selecting a region with quota and model availability, follow the instructions in the [quota recommendations](#quota-recommendations) section and ensure that your model is available in your selected region by checking the [list of models supported by Azure AI Agent Service](https://learn.microsoft.com/azure/ai-services/agents/concepts/model-region-support)
+ - This deployment will take 7-10 minutes to provision the resources in your account and set up the solution with sample data.
+ - If you get an error or timeout with deployment, changing the location can help, as there may be availability constraints for the resources. You can do this by running `azd down` and deleting the `.azure` folder from your code, and then running `azd up` again and selecting a new region.
+
+ **NOTE!** If you get authorization failed and/or permission related errors during the deployment, please refer to the Azure account requirements in the [Prerequisites](#prerequisites) section. If you were recently granted these permissions, it may take a few minutes for the authorization to apply.
+
+4. When `azd` has finished deploying, you'll see an endpoint URI in the command output. Visit that URI, and you should see the app! 🎉
+
+ - From here, you can interact with the agent. Try chatting with the agent by asking for a joke, or you could try a more specific query to see the agent's citation capabilities. By default, this solution uploads two documents from the `src/files` folder. To see the agent use this information, try asking about Contoso's products.
+
+ - You can view information about your deployment with:
+
+ ```shell
+ azd show
+ ```
+
+5. (Optional) Now that your app has deployed, you can view your resources in the Azure Portal and your deployments in Azure AI Foundry.
+ - In the [Azure Portal](https://portal.azure.com/), navigate to your environment's resource group. The name will be `rg-[your environment name]`. Here, you should see your container app, storage account, and all of the other [resources](#resources) that are created in the deployment.
+ - In the [Azure AI Foundry Portal](https://ai.azure.com/), select your project. If you navigate to the Agents tab, you should be able to view your new agent, named `agent-template-assistant`. If you navigate to the Models and Endpoints tab, you should see your AI Services connection with your model deployments.
+
+6. (Optional) You can use a local development server to test app changes locally. To do so, follow the steps in [local deployment server](#develop-with-local-development-server) after your app is deployed.
+
+7. (Optional) To redeploy, run `azd deploy`. This will cause new docker image rebuilt, push to Azure Container Registry, and a new revision in Azure Container App with a new docker image.
+
+This will rebuild the source code, package it into a container, and push it to the Azure Container Registry associated with your deployment.
+
+This guide provides step-by-step instructions for deploying your application using Azure Container Registry (ACR) and Azure Container Apps.
+
+There are several ways to deploy the solution. You can deploy to run in Azure in one click, or manually, or you can deploy locally.
+
+When Deployment is complete, follow steps in [Set Up Authentication in Azure App Service](azure_app_service_auth_setup.md) to add app authentication with AAD to your web app running on Azure App Service. Alternatively, run `./scripts/setup_credential.ps1` or `./scripts/setup_credential.sh` to setup basic auth with username and password.
+
diff --git a/.azd-setup/docs/images/agent_id_in_foundry_ui.png b/.azd-setup/docs/images/agent_id_in_foundry_ui.png
new file mode 100644
index 0000000..484ec1c
Binary files /dev/null and b/.azd-setup/docs/images/agent_id_in_foundry_ui.png differ
diff --git a/.azd-setup/docs/images/app_insight_logs_query.png b/.azd-setup/docs/images/app_insight_logs_query.png
new file mode 100644
index 0000000..bf3e313
Binary files /dev/null and b/.azd-setup/docs/images/app_insight_logs_query.png differ
diff --git a/.azd-setup/docs/images/architecture.png b/.azd-setup/docs/images/architecture.png
new file mode 100644
index 0000000..76e797e
Binary files /dev/null and b/.azd-setup/docs/images/architecture.png differ
diff --git a/.azd-setup/docs/images/azure-app-service-auth-setup/AddDetails.png b/.azd-setup/docs/images/azure-app-service-auth-setup/AddDetails.png
new file mode 100644
index 0000000..f36b596
Binary files /dev/null and b/.azd-setup/docs/images/azure-app-service-auth-setup/AddDetails.png differ
diff --git a/.azd-setup/docs/images/azure-app-service-auth-setup/AddPlatform.png b/.azd-setup/docs/images/azure-app-service-auth-setup/AddPlatform.png
new file mode 100644
index 0000000..6c74919
Binary files /dev/null and b/.azd-setup/docs/images/azure-app-service-auth-setup/AddPlatform.png differ
diff --git a/.azd-setup/docs/images/azure-app-service-auth-setup/AddRedirectURL.png b/.azd-setup/docs/images/azure-app-service-auth-setup/AddRedirectURL.png
new file mode 100644
index 0000000..d5cbcfa
Binary files /dev/null and b/.azd-setup/docs/images/azure-app-service-auth-setup/AddRedirectURL.png differ
diff --git a/.azd-setup/docs/images/azure-app-service-auth-setup/AppAuthIdentityProvider.png b/.azd-setup/docs/images/azure-app-service-auth-setup/AppAuthIdentityProvider.png
new file mode 100644
index 0000000..ca9ea30
Binary files /dev/null and b/.azd-setup/docs/images/azure-app-service-auth-setup/AppAuthIdentityProvider.png differ
diff --git a/.azd-setup/docs/images/azure-app-service-auth-setup/AppAuthIdentityProviderAdd.png b/.azd-setup/docs/images/azure-app-service-auth-setup/AppAuthIdentityProviderAdd.png
new file mode 100644
index 0000000..17ccf13
Binary files /dev/null and b/.azd-setup/docs/images/azure-app-service-auth-setup/AppAuthIdentityProviderAdd.png differ
diff --git a/.azd-setup/docs/images/azure-app-service-auth-setup/AppAuthIdentityProviderAdded.png b/.azd-setup/docs/images/azure-app-service-auth-setup/AppAuthIdentityProviderAdded.png
new file mode 100644
index 0000000..ea94ce8
Binary files /dev/null and b/.azd-setup/docs/images/azure-app-service-auth-setup/AppAuthIdentityProviderAdded.png differ
diff --git a/.azd-setup/docs/images/azure-app-service-auth-setup/AppAuthentication.png b/.azd-setup/docs/images/azure-app-service-auth-setup/AppAuthentication.png
new file mode 100644
index 0000000..e2a8ca0
Binary files /dev/null and b/.azd-setup/docs/images/azure-app-service-auth-setup/AppAuthentication.png differ
diff --git a/.azd-setup/docs/images/azure-app-service-auth-setup/AppAuthenticationIdentity.png b/.azd-setup/docs/images/azure-app-service-auth-setup/AppAuthenticationIdentity.png
new file mode 100644
index 0000000..79f4581
Binary files /dev/null and b/.azd-setup/docs/images/azure-app-service-auth-setup/AppAuthenticationIdentity.png differ
diff --git a/.azd-setup/docs/images/azure-app-service-auth-setup/Appregistrations.png b/.azd-setup/docs/images/azure-app-service-auth-setup/Appregistrations.png
new file mode 100644
index 0000000..af2d3ae
Binary files /dev/null and b/.azd-setup/docs/images/azure-app-service-auth-setup/Appregistrations.png differ
diff --git a/.azd-setup/docs/images/azure-app-service-auth-setup/MicrosoftEntraID.png b/.azd-setup/docs/images/azure-app-service-auth-setup/MicrosoftEntraID.png
new file mode 100644
index 0000000..1f24b89
Binary files /dev/null and b/.azd-setup/docs/images/azure-app-service-auth-setup/MicrosoftEntraID.png differ
diff --git a/.azd-setup/docs/images/azure-app-service-auth-setup/NewRegistration.png b/.azd-setup/docs/images/azure-app-service-auth-setup/NewRegistration.png
new file mode 100644
index 0000000..288f9af
Binary files /dev/null and b/.azd-setup/docs/images/azure-app-service-auth-setup/NewRegistration.png differ
diff --git a/.azd-setup/docs/images/azure-app-service-auth-setup/Web.png b/.azd-setup/docs/images/azure-app-service-auth-setup/Web.png
new file mode 100644
index 0000000..35f8464
Binary files /dev/null and b/.azd-setup/docs/images/azure-app-service-auth-setup/Web.png differ
diff --git a/.azd-setup/docs/images/azure-app-service-auth-setup/WebAppURL.png b/.azd-setup/docs/images/azure-app-service-auth-setup/WebAppURL.png
new file mode 100644
index 0000000..40c6740
Binary files /dev/null and b/.azd-setup/docs/images/azure-app-service-auth-setup/WebAppURL.png differ
diff --git a/.azd-setup/docs/images/tracing_eval_screenshot.png b/.azd-setup/docs/images/tracing_eval_screenshot.png
new file mode 100644
index 0000000..1bab0dd
Binary files /dev/null and b/.azd-setup/docs/images/tracing_eval_screenshot.png differ
diff --git a/.azd-setup/docs/images/tracing_tab.png b/.azd-setup/docs/images/tracing_tab.png
new file mode 100644
index 0000000..2163497
Binary files /dev/null and b/.azd-setup/docs/images/tracing_tab.png differ
diff --git a/.azd-setup/docs/images/webapp_screenshot.png b/.azd-setup/docs/images/webapp_screenshot.png
new file mode 100644
index 0000000..d9882e2
Binary files /dev/null and b/.azd-setup/docs/images/webapp_screenshot.png differ
diff --git a/.azd-setup/docs/local_development.md b/.azd-setup/docs/local_development.md
new file mode 100644
index 0000000..404d8af
--- /dev/null
+++ b/.azd-setup/docs/local_development.md
@@ -0,0 +1,184 @@
+# Local Development Guide
+
+This guide helps you set up a local development environment to test and modify the AI agents application. Make sure you first [deployed the app](#deploying-with-azd) to Azure before running the development server.
+
+## Prerequisites
+
+- Python 3.8 or later
+- [Node.js](https://nodejs.org/) (v20 or later)
+- [pnpm](https://pnpm.io/installation)
+- An Azure deployment of the application (completed via `azd up`)
+
+## Environment Setup
+
+### 1. Python Environment
+
+Create a [Python virtual environment](https://docs.python.org/3/tutorial/venv.html#creating-virtual-environments) and activate it:
+
+**On Windows:**
+```shell
+python -m venv .venv
+.venv\scripts\activate
+```
+
+**On Linux:**
+```shell
+python3 -m venv .venv
+source .venv/bin/activate
+```
+
+### 2. Install Dependencies
+
+Navigate to the `src` directory and install Python packages:
+
+```shell
+cd src
+python -m pip install -r requirements.txt
+```
+
+### 3. Frontend Setup
+
+Navigate to the frontend directory and setup for React UI:
+
+```shell
+cd src/frontend
+pnpm run setup
+```
+
+### 4. Environment Configuration
+
+Fill in the environment variables in `.env` file in the `src` directory.
+
+## Running the Development Server
+
+### 1. Build Frontend (Optional)
+
+If you have changes in `src/frontend`, build the React application:
+
+```shell
+cd src/frontend
+pnpm build
+```
+
+The build output will be placed in the `../api/static/react` directory, where the backend can serve it.
+
+### 2. Test Agent Configuration (Optional)
+
+If you have changes in `gunicorn.conf.py`, test the agent configuration:
+
+```shell
+cd src
+python gunicorn.conf.py
+```
+
+### 3. Start the Server
+
+Run the local development server:
+
+```shell
+cd src
+python -m uvicorn "api.main:create_app" --factory --reload
+```
+
+### 4. Access the Application
+
+Click 'Quota Recommendations
+ +### Quota Recommendations + +The default for the model capacity in deployment is 80k tokens for chat model and 50k for embedded model for AI Search. For optimal performance, it is recommended to increase to 100k tokens. You can change the capacity by following the steps in [setting capacity and deployment SKU](deploy_customization.md#customizing-model-deployments). + +- Navigate to the home screen of the [Azure AI Foundry Portal](https://ai.azure.com/) +- Select Quota Management buttom at the bottom of the home screen +* In the Quota tab, click the GlobalStandard dropdown and select the model and region you are using for this accelerator to see your available quota. Please note gpt-4o-mini and text-embedding-3-small are used as default. +- Request more quota or delete any unused model deployments as needed. + +
+
+
+ 
+
+ );
+}
diff --git a/.azd-setup/src/frontend/src/components/agents/AgentPreview.module.css b/.azd-setup/src/frontend/src/components/agents/AgentPreview.module.css
new file mode 100644
index 0000000..a582bdc
--- /dev/null
+++ b/.azd-setup/src/frontend/src/components/agents/AgentPreview.module.css
@@ -0,0 +1,263 @@
+.container {
+ position: relative;
+
+ overflow: hidden;
+ display: flex;
+ flex-direction: column;
+
+ width: 100%;
+ max-width: 100%;
+ height: 100vh;
+}
+
+.topBar {
+ display: flex;
+ flex-shrink: 0;
+ align-items: center;
+ justify-content: space-between;
+
+ box-sizing: border-box;
+ width: 100%;
+ max-width: 100%;
+ padding: 16px 24px;
+}
+
+.leftSection {
+ overflow: hidden;
+ display: flex;
+ flex: 1;
+ gap: 16px;
+ align-items: center;
+
+ min-width: 0;
+}
+
+.rightSection {
+ display: flex;
+ flex-shrink: 0;
+ gap: 8px;
+ align-items: center;
+}
+
+.agentIconContainer {
+ display: flex;
+ gap: 8px;
+ align-items: center;
+}
+
+.agentIcon {
+ flex-shrink: 0;
+ width: 32px;
+ height: 32px;
+}
+
+.agentIcon.newAgent {
+ background-color: var(--colorNeutralForegroundDisabled);
+ border-radius: 50%;
+}
+
+.agentName {
+ overflow: hidden;
+ font-weight: 600;
+ text-overflow: ellipsis;
+ white-space: nowrap;
+}
+
+.agentName.newAgent {
+ color: var(--colorNeutralForegroundDisabled);
+}
+
+.content {
+ position: relative;
+
+ overflow: hidden;
+ display: grid;
+ grid-template-columns: 1fr minmax(min(500px, 100%), 50%) 1fr;
+ flex-direction: column;
+ align-items: center;
+ justify-content: center;
+
+ box-sizing: border-box;
+ width: 100%;
+ height: 100%;
+ padding-bottom: 12px;
+}
+
+.builtWithBadge {
+ position: absolute;
+ bottom: 24px;
+ left: 24px;
+ z-index: 10;
+
+ /* No design yet for how to handle the badge on smaller screens, hide it for now */
+ @media (width <= 768px) {
+ display: none;
+ }
+}
+
+.chatbot {
+ overflow: hidden;
+ display: flex;
+ grid-column: 2;
+ flex: 1;
+ flex-direction: column;
+}
+
+.chatbot:not(:has(.emptyChatContainer)) {
+ height: 100%;
+}
+
+.emptyChatContainer {
+ display: flex;
+ flex-direction: column;
+ align-items: center;
+}
+
+.wavesContainer {
+ pointer-events: none;
+
+ position: absolute;
+ z-index: 0;
+ bottom: 0;
+ left: 0;
+
+ overflow: hidden;
+
+ width: 100%;
+ height: 300px;
+ max-height: 100%;
+
+ animation: waves-fade-in 1s ease-in-out;
+}
+
+.wavesContainer > canvas {
+ width: 100%;
+ height: 100%;
+}
+
+@keyframes waves-fade-in {
+ from {
+ opacity: 0;
+ }
+
+ to {
+ opacity: 1;
+ }
+}
+
+/* Legacy styles kept for compatibility */
+.emptyStateAgentIcon {
+ width: 64px;
+ height: 64px;
+ border-radius: 8px;
+ margin-bottom: 16px;
+}
+
+.content > .agentName {
+ margin-bottom: 8px;
+}
+
+.menuButtonContainer {
+ position: relative;
+ display: inline-block;
+}
+
+.menuButton {
+ position: relative;
+}
+
+.menu {
+ position: absolute;
+ top: 100%;
+ right: 0;
+ background-color: var(--colorNeutralBackground1);
+ border: 1px solid var(--colorNeutralStroke1);
+ border-radius: 4px;
+ box-shadow: 0 2px 8px rgba(0, 0, 0, 0.15);
+ z-index: 1000;
+ min-width: 200px;
+ display: none;
+}
+
+.menuButtonContainer:hover .menu,
+.menuButton:focus-within .menu {
+ display: block;
+}
+
+.menuItem {
+ display: flex;
+ align-items: center;
+ padding: 8px 16px;
+ cursor: pointer;
+ gap: 8px;
+}
+
+.menuItem:hover {
+ background-color: var(--colorNeutralBackground2);
+}
+
+.externalLink {
+ text-decoration: none;
+ color: inherit;
+ display: flex;
+ align-items: center;
+ width: 100%;
+}
+
+.menuButtonContainer {
+ position: relative;
+ display: inline-block;
+}
+
+.emptyChatContainer {
+ display: flex;
+ flex-direction: column;
+ gap: 16px;
+ align-items: center;
+
+ padding: 24px;
+
+ text-align: center;
+}
+
+.menuButton {
+ position: relative;
+}
+
+.menu {
+ position: absolute;
+ top: 100%;
+ right: 0;
+ background-color: var(--colorNeutralBackground1);
+ border: 1px solid var(--colorNeutralStroke1);
+ border-radius: 4px;
+ box-shadow: 0 2px 8px rgba(0, 0, 0, 0.15);
+ z-index: 1000;
+ min-width: 200px;
+ display: none;
+}
+
+.menuButtonContainer:hover .menu,
+.menuButton:focus-within .menu {
+ display: block;
+}
+
+.menuItem {
+ display: flex;
+ align-items: center;
+ padding: 8px 16px;
+ cursor: pointer;
+ gap: 8px;
+}
+
+.menuItem:hover {
+ background-color: var(--colorNeutralBackground2);
+}
+
+.externalLink {
+ text-decoration: none;
+ color: inherit;
+ display: flex;
+ align-items: center;
+ width: 100%;
+}
\ No newline at end of file
diff --git a/.azd-setup/src/frontend/src/components/agents/AgentPreview.tsx b/.azd-setup/src/frontend/src/components/agents/AgentPreview.tsx
new file mode 100644
index 0000000..0e8b520
--- /dev/null
+++ b/.azd-setup/src/frontend/src/components/agents/AgentPreview.tsx
@@ -0,0 +1,556 @@
+import { ReactNode, useState, useMemo, useEffect } from "react";
+import {
+ Body1,
+ Button,
+ Caption1,
+ Spinner,
+ Title3,
+} from "@fluentui/react-components";
+import { ChatRegular, MoreHorizontalRegular } from "@fluentui/react-icons";
+import clsx from "clsx";
+
+import { AgentIcon } from "./AgentIcon";
+import { SettingsPanel } from "../core/SettingsPanel";
+import { AgentPreviewChatBot } from "./AgentPreviewChatBot";
+import { MenuButton } from "../core/MenuButton/MenuButton";
+import { IChatItem } from "./chatbot/types";
+import { Waves } from "./Waves";
+import { BuiltWithBadge } from "./BuiltWithBadge";
+
+import styles from "./AgentPreview.module.css";
+
+interface IAgent {
+ id: string;
+ object: string;
+ created_at: number;
+ name: string;
+ description?: string | null;
+ model: string;
+ instructions?: string;
+ tools?: Array<{ type: string }>;
+ top_p?: number;
+ temperature?: number;
+ tool_resources?: {
+ file_search?: {
+ vector_store_ids?: string[];
+ };
+ [key: string]: any;
+ };
+ metadata?: Record
+
+ );
+}
diff --git a/.azd-setup/src/frontend/src/components/agents/AgentPreviewChatBot.module.css b/.azd-setup/src/frontend/src/components/agents/AgentPreviewChatBot.module.css
new file mode 100644
index 0000000..d7ee249
--- /dev/null
+++ b/.azd-setup/src/frontend/src/components/agents/AgentPreviewChatBot.module.css
@@ -0,0 +1,141 @@
+.chatContainer {
+ position: relative;
+
+ overflow: hidden;
+ display: flex;
+ flex-direction: column;
+ gap: 16px;
+
+ width: 100%;
+ height: 100%;
+
+ > div:first-child {
+ overflow-y: auto;
+ display: flex;
+ flex: 1;
+ flex-direction: column;
+ gap: 16px;
+ }
+
+ div[role='feed'] {
+ overflow-y: auto;
+ display: flex;
+ flex: 1;
+ flex-direction: column;
+
+ padding: 8px 12px 0;
+ }
+}
+
+/* When there are messages, make the chat fill the available space */
+.hasMessages {
+ height: 100%;
+}
+
+.emptyChatContainer {
+ height: auto;
+}
+
+.userMessage {
+ padding-top: 0;
+ padding-bottom: 0;
+}
+
+.copilotChatContainer {
+ transform: translateY(0);
+
+ display: flex;
+ flex-direction: column;
+ flex: 1;
+
+ border-radius: 8px;
+
+ opacity: 1;
+ background-color: var(--colorNeutralBackground3);
+
+ transition:
+ opacity 0.3s ease-in-out,
+ transform 0.3s ease-in-out;
+ animation: fade-in 0.3s ease-in-out;
+}
+
+@keyframes fade-in {
+ from {
+ transform: translateY(10px);
+ opacity: 0;
+ }
+
+ to {
+ transform: translateY(0);
+ opacity: 1;
+ }
+}
+
+/* Transition for empty state to messages state */
+.emptyChatContainer + div div:empty + .inputContainer,
+.emptyChatContainer + .copilotChatContainer {
+ transition:
+ opacity 0.3s ease-in-out,
+ transform 0.3s ease-in-out;
+}
+
+
+.inputContainer {
+ /* TODO: File an issue with Fluent team to allow for a safer override of the input box styles, or figure out a better approach to customize the chat input box styles */
+ > div:first-child > div:first-child {
+ padding: 12px 12px 6px;
+ border: none;
+ background-color: var(--colorNeutralBackground3);
+ }
+}
+
+.emptyState {
+ display: flex;
+ flex-direction: column;
+ align-items: center;
+ justify-content: center;
+ text-align: center;
+ height: 100%;
+ padding: 2rem;
+ color: var(--colorNeutralForeground2);
+ flex: 1;
+}
+
+.emptyState h2 {
+ font-size: 1.25rem;
+ font-weight: 600;
+ color: var(--colorNeutralForeground1);
+ margin-top: 1rem;
+ margin-bottom: 0;
+}
+
+.emptyStateAgentIcon {
+ display: flex;
+ align-items: center;
+ justify-content: center;
+ width: 64px;
+ height: 64px;
+ border-radius: 50%;
+ background-color: var(--colorNeutralBackground3);
+ overflow: hidden;
+ margin-bottom: 1rem;
+}
+
+.avatarImage {
+ max-width: 100%;
+ max-height: 100%;
+}
+
+.copilotChatMessage {
+ display: flex;
+ margin: 0 16px;
+ padding: 4px 0;
+}
+
+/* Transition for empty state to messages state */
+.emptyChatContainer .copilotChatContainer,
+.hasMessages .copilotChatContainer {
+ transition:
+ opacity 0.3s ease-in-out,
+ transform 0.3s ease-in-out;
+}
\ No newline at end of file
diff --git a/.azd-setup/src/frontend/src/components/agents/AgentPreviewChatBot.tsx b/.azd-setup/src/frontend/src/components/agents/AgentPreviewChatBot.tsx
new file mode 100644
index 0000000..b5b2125
--- /dev/null
+++ b/.azd-setup/src/frontend/src/components/agents/AgentPreviewChatBot.tsx
@@ -0,0 +1,77 @@
+import React, { useState, useMemo } from "react";
+import { AssistantMessage } from "./AssistantMessage";
+import { UserMessage } from "./UserMessage";
+import { ChatInput } from "./chatbot/ChatInput";
+import { AgentPreviewChatBotProps } from "./chatbot/types";
+
+import styles from "./AgentPreviewChatBot.module.css";
+import clsx from "clsx";
+
+export function AgentPreviewChatBot({
+ agentName,
+ agentLogo,
+ chatContext,
+}: AgentPreviewChatBotProps): React.JSX.Element {
+ const [currentUserMessage, setCurrentUserMessage] = useState<
+ string | undefined
+ >();
+
+ const messageListFromChatContext = useMemo(
+ () => chatContext.messageList ?? [],
+ [chatContext.messageList]
+ );
+
+ const onEditMessage = (messageId: string) => {
+ const selectedMessage = messageListFromChatContext.find(
+ (message) => !message.isAnswer && message.id === messageId
+ )?.content;
+ setCurrentUserMessage(selectedMessage);
+ };
+
+ const isEmpty = messageListFromChatContext.length === 0;
+
+ return (
+
+
+
+
+
+
+ {agentDetails.name ? (
+
+
+
+ {agentDetails.name}
+
+
+ ) : (
+
+
+
+ Agent Name
+
+
+ )}
+
+ }
+ onClick={newThread}
+ >
+ New Chat
+
+
+
+
+
+ {/* Settings Panel */}
+
+ {isLoadingChatHistory ? (
+
+
+
+
+ {agentDetails.name}
+
+ How can I help you today?
+
+ )}
+
+ {!isEmpty ? (
+
+ );
+}
diff --git a/.azd-setup/src/frontend/src/components/agents/AssistantMessage.module.css b/.azd-setup/src/frontend/src/components/agents/AssistantMessage.module.css
new file mode 100644
index 0000000..ae0c0bb
--- /dev/null
+++ b/.azd-setup/src/frontend/src/components/agents/AssistantMessage.module.css
@@ -0,0 +1,87 @@
+.assistantMessageContainer {
+ display: flex;
+ flex-direction: column;
+ padding: 16px;
+ margin-bottom: 16px;
+ background-color: var(--colorNeutralBackground1);
+ border-radius: 8px;
+ box-shadow: 0 2px 4px rgba(0, 0, 0, 0.1);
+}
+
+.messageHeader {
+ display: flex;
+ justify-content: space-between;
+ align-items: center;
+ margin-bottom: 12px;
+}
+
+.avatarAndName {
+ display: flex;
+ align-items: center;
+}
+
+.avatar {
+ width: 32px;
+ height: 32px;
+ margin-right: 8px;
+ border-radius: 50%;
+ overflow: hidden;
+ background-color: var(--colorNeutralBackground3);
+ display: flex;
+ align-items: center;
+ justify-content: center;
+}
+
+.avatarImage {
+ max-width: 100%;
+ max-height: 100%;
+}
+
+.botName {
+ font-weight: 600;
+ color: var(--colorNeutralForeground1);
+}
+
+.actions {
+ display: flex;
+}
+
+.messageContent {
+ margin-bottom: 12px;
+}
+
+.messageFootnote {
+ margin-top: 12px;
+ padding-top: 12px;
+ border-top: 1px solid var(--colorNeutralStroke2);
+ font-size: 12px;
+}
+
+.references {
+ margin-bottom: 8px;
+}
+
+.referenceList {
+ display: flex;
+ flex-wrap: wrap;
+ gap: 8px;
+}
+
+.reference {
+ background-color: var(--colorNeutralBackground3);
+ padding: 4px 8px;
+ border-radius: 4px;
+ font-size: 12px;
+ cursor: pointer;
+}
+
+.reference:hover {
+ background-color: var(--colorNeutralBackground4);
+}
+
+.disclaimer {
+ font-size: 12px;
+ color: var(--colorNeutralForeground3);
+ margin-top: 12px;
+ font-style: italic;
+}
\ No newline at end of file
diff --git a/.azd-setup/src/frontend/src/components/agents/AssistantMessage.tsx b/.azd-setup/src/frontend/src/components/agents/AssistantMessage.tsx
new file mode 100644
index 0000000..0080ee8
--- /dev/null
+++ b/.azd-setup/src/frontend/src/components/agents/AssistantMessage.tsx
@@ -0,0 +1,87 @@
+import { Button, Spinner } from "@fluentui/react-components";
+import { bundleIcon, DeleteFilled, DeleteRegular } from "@fluentui/react-icons";
+import { CopilotMessageV2 as CopilotMessage } from "@fluentui-copilot/react-copilot-chat";
+import {
+ ReferenceListV2 as ReferenceList,
+ ReferenceOverflowButton,
+} from "@fluentui-copilot/react-reference";
+import { Suspense } from "react";
+
+import { Markdown } from "../core/Markdown";
+import { UsageInfo } from "./UsageInfo";
+import { IAssistantMessageProps } from "./chatbot/types";
+
+import styles from "./AgentPreviewChatBot.module.css";
+import { AgentIcon } from "./AgentIcon";
+
+const DeleteIcon = bundleIcon(DeleteFilled, DeleteRegular);
+
+export function AssistantMessage({
+ message,
+ agentLogo,
+ loadingState,
+ agentName,
+ showUsageInfo,
+ onDelete,
+}: IAssistantMessageProps): React.JSX.Element {
+ const hasAnnotations = message.annotations && message.annotations.length > 0;
+ const references = hasAnnotations
+ ? message.annotations?.map((annotation, index) => (
+
+ {messageListFromChatContext.map((message, index, messageList) =>
+ message.isAnswer ? (
+
+ ) : (
+ // Empty div needed for proper animation when transitioning to non-empty state
+
+ )}
+
+
+
+ {annotation.text || annotation.file_name}
+
+ ))
+ : [];
+
+ return (
+
+
+ );
+}
diff --git a/.azd-setup/src/frontend/src/components/agents/UsageInfo.module.css b/.azd-setup/src/frontend/src/components/agents/UsageInfo.module.css
new file mode 100644
index 0000000..c297b84
--- /dev/null
+++ b/.azd-setup/src/frontend/src/components/agents/UsageInfo.module.css
@@ -0,0 +1,77 @@
+.usageInfoContainer {
+ position: relative;
+ font-size: 12px;
+ color: var(--colorNeutralForeground2);
+}
+
+.usageSummary {
+ display: flex;
+ align-items: center;
+ gap: 8px;
+}
+
+.divider {
+ color: var(--colorNeutralForeground3);
+}
+
+.infoButton {
+ background: none;
+ border: none;
+ padding: 0;
+ margin: 0;
+ cursor: pointer;
+ display: flex;
+ align-items: center;
+ justify-content: center;
+ color: var(--colorBrandForeground1);
+}
+
+.infoIcon {
+ font-size: 14px;
+}
+
+.usageDetails {
+ display: none;
+ position: absolute;
+ bottom: 24px;
+ right: 0;
+ background-color: var(--colorNeutralBackground1);
+ border-radius: 4px;
+ box-shadow: 0 4px 8px rgba(0, 0, 0, 0.1);
+ padding: 12px;
+ width: 200px;
+ z-index: 100;
+}
+
+.infoButton:focus + .usageDetails,
+.infoButton:hover + .usageDetails,
+.usageDetails:hover {
+ display: block;
+}
+
+.detailsDivider {
+ margin: 8px 0;
+}
+
+.detailsList {
+ display: flex;
+ flex-direction: column;
+ gap: 8px;
+}
+
+.detailsItem {
+ display: flex;
+ justify-content: space-between;
+ align-items: center;
+}
+
+.detailLabel {
+ font-size: 12px;
+ color: var(--colorNeutralForeground2);
+}
+
+.detailValue {
+ font-size: 12px;
+ font-weight: 600;
+ color: var(--colorNeutralForeground1);
+}
\ No newline at end of file
diff --git a/.azd-setup/src/frontend/src/components/agents/UsageInfo.tsx b/.azd-setup/src/frontend/src/components/agents/UsageInfo.tsx
new file mode 100644
index 0000000..67e1fe6
--- /dev/null
+++ b/.azd-setup/src/frontend/src/components/agents/UsageInfo.tsx
@@ -0,0 +1,51 @@
+import { Body1, Divider, Text } from '@fluentui/react-components';
+import { InfoRegular } from '@fluentui/react-icons';
+
+import styles from './UsageInfo.module.css';
+
+interface ITokenUsageInfo {
+ prompt_tokens: number;
+ completion_tokens: number;
+ total_tokens: number;
+}
+
+interface IUsageInfoProps {
+ info: ITokenUsageInfo;
+ duration?: number;
+}
+
+export function UsageInfo({ info, duration }: IUsageInfoProps): React.ReactElement {
+ return (
+
+
+ {agentName ? `Hello! I'm ${agentName}` : "Hello! How can I help you today?"}
+
+ {agentDescription && (
+ {agentDescription}
+ )}
+
+
+ {onPromptClick && (
+
+ {defaultStarterPrompts.map((prompt, index) => (
+
+ ))}
+
+ )}
+
+
+ );
+}
\ No newline at end of file
diff --git a/.azd-setup/src/frontend/src/components/agents/UserMessage.module.css b/.azd-setup/src/frontend/src/components/agents/UserMessage.module.css
new file mode 100644
index 0000000..e330028
--- /dev/null
+++ b/.azd-setup/src/frontend/src/components/agents/UserMessage.module.css
@@ -0,0 +1,86 @@
+.userMessageContainer {
+ display: flex;
+ flex-direction: column;
+ padding: 16px;
+ margin-bottom: 16px;
+ background-color: var(--colorNeutralBackground2);
+ border-radius: 8px;
+}
+
+.userMessageHeader {
+ display: flex;
+ justify-content: space-between;
+ align-items: center;
+ margin-bottom: 12px;
+}
+
+.userInfo {
+ display: flex;
+ align-items: center;
+ gap: 8px;
+}
+
+.userAvatar {
+ width: 32px;
+ height: 32px;
+ border-radius: 50%;
+ background-color: var(--colorBrandBackground);
+ color: var(--colorNeutralForegroundOnBrand);
+ display: flex;
+ align-items: center;
+ justify-content: center;
+ font-size: 12px;
+ font-weight: 600;
+}
+
+.timestamp {
+ font-size: 12px;
+ color: var(--colorNeutralForeground3);
+}
+
+.messageActions {
+ display: flex;
+}
+
+.messageContent {
+ width: 100%;
+}
+
+.attachments {
+ display: flex;
+ flex-wrap: wrap;
+ gap: 8px;
+ margin-top: 12px;
+}
+
+.attachment {
+ display: flex;
+ align-items: center;
+ background-color: var(--colorNeutralBackground3);
+ padding: 6px 10px;
+ border-radius: 4px;
+ gap: 8px;
+}
+
+.attachmentName {
+ font-size: 12px;
+ color: var(--colorBrandForeground1);
+ cursor: pointer;
+ text-decoration: underline;
+}
+
+.removeButton {
+ background: none;
+ border: none;
+ color: var(--colorNeutralForeground3);
+ cursor: pointer;
+ padding: 0;
+ font-size: 12px;
+ display: flex;
+ align-items: center;
+ justify-content: center;
+}
+
+.removeButton:hover {
+ color: var(--colorNeutralForeground1);
+}
\ No newline at end of file
diff --git a/.azd-setup/src/frontend/src/components/agents/UserMessage.tsx b/.azd-setup/src/frontend/src/components/agents/UserMessage.tsx
new file mode 100644
index 0000000..5f9ac76
--- /dev/null
+++ b/.azd-setup/src/frontend/src/components/agents/UserMessage.tsx
@@ -0,0 +1,44 @@
+import { Spinner, ToolbarButton } from "@fluentui/react-components";
+import { bundleIcon, EditFilled, EditRegular } from "@fluentui/react-icons";
+import { UserMessageV2 as CopilotUserMessage } from "@fluentui-copilot/react-copilot-chat";
+import { Suspense } from "react";
+
+import { useFormatTimestamp } from "./hooks/useFormatTimestamp";
+import { IUserMessageProps } from "./chatbot/types";
+
+import { Markdown } from "../core/Markdown";
+
+import styles from "./AgentPreviewChatBot.module.css";
+
+const EditIcon = bundleIcon(EditFilled, EditRegular);
+
+export function UserMessage({
+ message,
+ onEditMessage,
+}: IUserMessageProps): JSX.Element {
+ const formatTimestamp = useFormatTimestamp();
+
+ return (
+
+ {duration !== undefined && (
+ <>
+ {`${duration.toFixed(0)}ms`}
+ |
+
+ )}
+ {`${info.total_tokens} tokens`}
+
+
+
+ Usage Information
+
+
+
+
+ Input
+ {info.prompt_tokens}
+
+
+ Output
+ {info.completion_tokens}
+
+
+ * {isMotionReduced
+ * ?
+ * );
+ * ```
+ */
+export function useIsMotionReduced(): boolean {
+ // Media query to detect if motion is NOT reduced
+ // If this query matches, the user has not requested reduced motion
+ // We invert the logic - if "no-preference" matches, motion is NOT reduced.
+ // This is for backward compatibility with older browsers that may not support the media query
+ // and to ensure we default to reduced motion when SSR is involved.
+ const mediaQuery = '(prefers-reduced-motion: no-preference)';
+
+ return !useMediaQuery(mediaQuery);
+}
diff --git a/.azd-setup/src/frontend/src/components/core/Markdown.module.css b/.azd-setup/src/frontend/src/components/core/Markdown.module.css
new file mode 100644
index 0000000..2632deb
--- /dev/null
+++ b/.azd-setup/src/frontend/src/components/core/Markdown.module.css
@@ -0,0 +1,122 @@
+.markdown {
+ font-size: 14px;
+ line-height: 1.5;
+ color: var(--colorNeutralForeground1);
+}
+
+.markdown p {
+ margin-bottom: 16px;
+}
+
+.markdown h1,
+.markdown h2,
+.markdown h3,
+.markdown h4,
+.markdown h5,
+.markdown h6 {
+ margin-top: 24px;
+ margin-bottom: 16px;
+ font-weight: 600;
+ line-height: 1.25;
+}
+
+.markdown h1 {
+ font-size: 2em;
+}
+
+.markdown h2 {
+ font-size: 1.5em;
+}
+
+.markdown h3 {
+ font-size: 1.25em;
+}
+
+.markdown ul,
+.markdown ol {
+ padding-left: 2em;
+ margin-bottom: 16px;
+}
+
+.markdown li {
+ margin-bottom: 4px;
+}
+
+.markdown blockquote {
+ padding: 0 1em;
+ color: var(--colorNeutralForeground2);
+ border-left: 4px solid var(--colorNeutralStroke2);
+ margin: 0 0 16px;
+}
+
+.link {
+ color: var(--colorBrandForeground1);
+ text-decoration: none;
+}
+
+.link:hover {
+ text-decoration: underline;
+}
+
+.inlineCode {
+ padding: 0.2em 0.4em;
+ margin: 0;
+ font-size: 85%;
+ background-color: rgba(0, 0, 0, 0.05);
+ border-radius: 6px;
+ font-family: monospace;
+}
+
+.codeBlock {
+ margin: 16px 0;
+ border-radius: 6px;
+ overflow: hidden;
+ border: 1px solid var(--colorNeutralStroke2);
+}
+
+.codeHeader {
+ display: flex;
+ justify-content: space-between;
+ align-items: center;
+ padding: 8px 16px;
+ background-color: var(--colorNeutralBackground3);
+ border-bottom: 1px solid var(--colorNeutralStroke2);
+}
+
+.alignRight {
+ margin-left: auto;
+}
+
+.copyButton {
+ display: flex;
+ align-items: center;
+ gap: 6px;
+ background-color: transparent;
+ border: none;
+ cursor: pointer;
+}
+
+.copyButton:hover {
+ background-color: var(--colorNeutralBackground4);
+}
+
+.markdown table {
+ border-collapse: collapse;
+ width: 100%;
+ margin-bottom: 16px;
+}
+
+.markdown th,
+.markdown td {
+ padding: 8px 12px;
+ border: 1px solid var(--colorNeutralStroke2);
+}
+
+.markdown th {
+ background-color: var(--colorNeutralBackground3);
+ text-align: left;
+}
+
+.markdown tr:nth-child(even) {
+ background-color: var(--colorNeutralBackground2);
+}
\ No newline at end of file
diff --git a/.azd-setup/src/frontend/src/components/core/Markdown.tsx b/.azd-setup/src/frontend/src/components/core/Markdown.tsx
new file mode 100644
index 0000000..d608f86
--- /dev/null
+++ b/.azd-setup/src/frontend/src/components/core/Markdown.tsx
@@ -0,0 +1,334 @@
+import type {
+ AnchorHTMLAttributes,
+ ClassAttributes,
+ HTMLAttributes,
+ PropsWithChildren,
+} from "react";
+import type { ExtraProps } from "react-markdown";
+
+import { Text } from "@fluentui/react-components";
+import { CopyRegular } from "@fluentui/react-icons";
+import copy from "copy-to-clipboard";
+import { Fragment, isValidElement, memo, useMemo } from "react";
+import ReactMarkdown from "react-markdown";
+import SyntaxHighlighter from "react-syntax-highlighter";
+import { docco } from "react-syntax-highlighter/dist/esm/styles/hljs";
+import RehypeKatex from "rehype-katex";
+import RehypeRaw from "rehype-raw";
+import rehypeSanitize, { defaultSchema } from "rehype-sanitize";
+import rehypeStringify from "rehype-stringify";
+import RemarkBreaks from "remark-breaks";
+import RemarkGfm from "remark-gfm";
+import RemarkMath from "remark-math";
+import remarkParse from "remark-parse";
+import supersub from "remark-supersub";
+
+import { Button } from "@fluentui/react-components";
+
+import { ThinkBlock } from "./ThinkBlock";
+
+import styles from "./Markdown.module.css";
+
+interface ICitation extends React.JSX.Element {
+ props: {
+ "data-replace"?: string;
+ [key: string]: unknown;
+ };
+}
+
+interface IMarkdownProps {
+ citations?: ICitation[] | undefined;
+ content: string;
+ className?: string;
+ customDisallowedElements?: string[];
+}
+
+interface IRehypeNode {
+ type: string;
+ tagName: string;
+ properties?: { ref?: unknown; [key: string]: unknown };
+ children?: IRehypeNode[];
+ value?: string;
+}
+
+function Hyperlink({
+ node,
+ children,
+ ...linkProps
+}: ClassAttributes with special attributes
+const preprocessThinkTag = (content: string): string => {
+ const thinkTagRegex = /\n([\s\S]*?)\n<\/think>/g;
+
+ // Replace tags with
only if there's content inside
+ return content.replaceAll(
+ thinkTagRegex,
+ (_match: string, innerContent: string) => {
+ // If the inner content is empty or only whitespace, return empty string
+ if (!innerContent.trim()) {
+ return "";
+ }
+ // Otherwise, replace with details tag
+ return `(
+ ({ inline, className, children, ...props }) => {
+ const match = /language-(\w+)/.exec(className ?? "");
+
+ if (inline || !match) {
+ return (
+ (
+ (
+ {
+ menuButtonText,
+ menuItems,
+ menuProps,
+ menuButtonProps,
+ menuTriggerProps,
+ menuListProps,
+ menuPopoverProps,
+ },
+ ref
+ ): ReactNode => {
+ const handleMenuButtonClick = useCallback(
+ (event: MouseEvent) => {
+ if (menuButtonProps?.onClick) {
+ if (event.currentTarget instanceof HTMLButtonElement) {
+ (menuButtonProps.onClick as MouseEventHandler)(
+ event as MouseEvent
+ );
+ } else if (event.currentTarget instanceof HTMLAnchorElement) {
+ (menuButtonProps.onClick as MouseEventHandler)(
+ event as MouseEvent
+ );
+ }
+ }
+ },
+ [menuButtonProps]
+ );
+
+ const handleMenuItemClick = useCallback(
+ (
+ event: MouseEvent,
+ onClick: MouseEventHandler | undefined
+ ) => {
+ onClick?.(event);
+ },
+ []
+ );
+
+ const {
+ shape = "circular",
+ appearance = "secondary",
+ className,
+ ...restMenuButtonProps
+ } = menuButtonProps ?? {};
+
+ return (
+
+ );
+ }
+);
+MenuButton.displayName = "MenuButton";
diff --git a/.azd-setup/src/frontend/src/components/core/SettingsPanel.module.css b/.azd-setup/src/frontend/src/components/core/SettingsPanel.module.css
new file mode 100644
index 0000000..8700d1b
--- /dev/null
+++ b/.azd-setup/src/frontend/src/components/core/SettingsPanel.module.css
@@ -0,0 +1,13 @@
+.panel {
+ width: 320px;
+}
+
+.content {
+ display: flex;
+ flex-direction: column;
+ gap: 24px;
+}
+
+.settingsButton {
+ margin: 8px;
+}
\ No newline at end of file
diff --git a/.azd-setup/src/frontend/src/components/core/SettingsPanel.tsx b/.azd-setup/src/frontend/src/components/core/SettingsPanel.tsx
new file mode 100644
index 0000000..8ae875e
--- /dev/null
+++ b/.azd-setup/src/frontend/src/components/core/SettingsPanel.tsx
@@ -0,0 +1,54 @@
+import type { JSX } from "react";
+import {
+ Button,
+ Drawer,
+ DrawerBody,
+ DrawerHeader,
+ DrawerHeaderTitle,
+} from "@fluentui/react-components";
+import { Dismiss24Regular } from "@fluentui/react-icons";
+
+import styles from "./SettingsPanel.module.css";
+import { ThemePicker } from "./theme/ThemePicker";
+
+export interface ISettingsPanelProps {
+ isOpen: boolean;
+ onOpenChange: (isOpen: boolean) => void;
+}
+
+export function SettingsPanel({
+ isOpen = false,
+ onOpenChange,
+}: ISettingsPanelProps): JSX.Element {
+ return (
+ {
+ onOpenChange(open);
+ }}
+ open={isOpen}
+ position="end"
+ >
+
+
+ }
+ onClick={() => {
+ onOpenChange(false);
+ }}
+ />
+
+ }
+ >
+ Settings
+
+ {" "}
+
+
+
+ );
+}
diff --git a/.azd-setup/src/frontend/src/components/core/ThinkBlock.module.css b/.azd-setup/src/frontend/src/components/core/ThinkBlock.module.css
new file mode 100644
index 0000000..c19506b
--- /dev/null
+++ b/.azd-setup/src/frontend/src/components/core/ThinkBlock.module.css
@@ -0,0 +1,32 @@
+.thinkBlock {
+ margin: 12px 0;
+ border-radius: 6px;
+ background-color: rgba(0, 0, 0, 0.05);
+ overflow: hidden;
+}
+
+.thinkSummary {
+ padding: 8px 12px;
+ cursor: pointer;
+}
+
+.thinkSummary::-webkit-details-marker {
+ display: none;
+}
+
+.thinkHeader {
+ display: flex;
+ flex-direction: column;
+ gap: 6px;
+}
+
+.thinkLabel {
+ font-size: 14px;
+ color: #666;
+ font-weight: 500;
+}
+
+.thinkContent {
+ padding: 8px 12px 12px;
+ border-top: 1px solid rgba(0, 0, 0, 0.1);
+}
\ No newline at end of file
diff --git a/.azd-setup/src/frontend/src/components/core/ThinkBlock.tsx b/.azd-setup/src/frontend/src/components/core/ThinkBlock.tsx
new file mode 100644
index 0000000..986fc34
--- /dev/null
+++ b/.azd-setup/src/frontend/src/components/core/ThinkBlock.tsx
@@ -0,0 +1,108 @@
+import type { ClassAttributes, DetailsHTMLAttributes } from 'react';
+import type { ExtraProps } from 'react-markdown';
+
+import { ProgressBar } from '@fluentui/react-components';
+import { cloneElement, isValidElement, useEffect, useRef, useState } from 'react';
+
+import styles from './ThinkBlock.module.css';
+
+const hasEndThink = (
+ children:
+ | React.ReactNode
+ | React.ReactElement<{ props?: { children?: React.ReactNode } }>,
+): boolean => {
+ if (typeof children === 'string') {
+ return children.includes('[ENDTHINKFLAG]');
+ }
+
+ if (Array.isArray(children)) {
+ return children.some(child => hasEndThink(child as React.ReactNode));
+ }
+
+ if (isValidElement(children) && children.props?.children != null) {
+ return hasEndThink(children.props.children as React.ReactNode);
+ }
+
+ return false;
+};
+
+const removeEndThink = (children: React.ReactNode): React.ReactNode => {
+ if (typeof children === 'string') {
+ return children.replace('[ENDTHINKFLAG]', '');
+ }
+
+ if (Array.isArray(children)) {
+ return children.map(child => removeEndThink(child as React.ReactNode));
+ }
+
+ if (isValidElement(children) && children.props?.children != null) {
+ return cloneElement(children, {
+ ...children.props,
+ children: removeEndThink(children.props.children),
+ });
+ }
+
+ return children;
+};
+
+const useThinkTimer = (children: React.ReactNode) => {
+ const startTime = useRef(Date.now());
+ const [elapsedTime, setElapsedTime] = useState(0);
+ const [isComplete, setIsComplete] = useState(false);
+ const timerRef = useRef();
+
+ useEffect(() => {
+ timerRef.current = window.setInterval(() => {
+ if (!isComplete) {
+ setElapsedTime(Math.floor((Date.now() - startTime.current) / 100) / 10);
+ }
+ }, 100);
+
+ return () => {
+ window.clearInterval(timerRef.current as NodeJS.Timeout);
+ };
+ }, [isComplete]);
+
+ useEffect(() => {
+ if (hasEndThink(children)) {
+ setIsComplete(true);
+ window.clearInterval(timerRef.current as NodeJS.Timeout);
+ }
+ }, [children]);
+
+ return { elapsedTime, isComplete };
+};
+
+interface IThinkBlockProps extends DetailsHTMLAttributes {
+ 'data-think'?: boolean;
+}
+
+export function ThinkBlock({
+ children,
+ ...props
+}: ClassAttributes &
+ IThinkBlockProps &
+ ExtraProps): React.ReactNode {
+ const { elapsedTime, isComplete } = useThinkTimer(children);
+ const displayContent = removeEndThink(children);
+
+ if (!(props['data-think'] ?? false)) {
+ return ({
+ theme: "Light",
+ savedTheme: "Light",
+ currentTheme: "Light",
+ themeStyles: lightTheme,
+ setTheme(theme: Theme) {
+ console.log(`Theme set to ${theme}`);
+ },
+ isDarkMode: false,
+});
+
+export function useThemeContext(): IThemeContextValue {
+ const context = useContext(ThemeContext);
+ if (!context) {
+ throw new Error("useThemeContext must be used within a ThemeProvider");
+ }
+ return context;
+}
diff --git a/.azd-setup/src/frontend/src/components/core/theme/ThemePicker.tsx b/.azd-setup/src/frontend/src/components/core/theme/ThemePicker.tsx
new file mode 100644
index 0000000..9fb7bd5
--- /dev/null
+++ b/.azd-setup/src/frontend/src/components/core/theme/ThemePicker.tsx
@@ -0,0 +1,67 @@
+import React, { useMemo } from "react";
+import { Dropdown, Option, Label } from "@fluentui/react-components";
+import { Theme, useThemeContext } from "./ThemeContext";
+
+interface IDropdownItem {
+ key: Theme;
+ value: Theme;
+ text: string;
+}
+
+export const ThemePicker: React.FC = () => {
+ const { savedTheme, setTheme } = useThemeContext();
+
+ const options: IDropdownItem[] = useMemo(
+ () => [
+ {
+ key: "Light",
+ value: "Light",
+ text: "Light",
+ },
+ {
+ key: "Dark",
+ value: "Dark",
+ text: "Dark",
+ },
+ {
+ key: "System",
+ value: "System",
+ text: "System",
+ },
+ ],
+ []
+ );
+
+ const selectedThemeText = useMemo(
+ () =>
+ options.find((opt) => opt.key === (savedTheme ?? "Light"))?.text ??
+ "Light",
+ [savedTheme, options]
+ );
+
+ const selectedOptions = useMemo(
+ () => (savedTheme ? [savedTheme] : []),
+ [savedTheme]
+ );
+ return (
+ <>
+
+ {
+ if (optionValue !== undefined) {
+ setTheme(optionValue as Theme);
+ }
+ }}
+ selectedOptions={selectedOptions}
+ value={selectedThemeText}
+ >
+ {options.map((option) => (
+
+ ))}
+
+
+ );
+};
diff --git a/.azd-setup/src/frontend/src/components/core/theme/ThemeProvider.tsx b/.azd-setup/src/frontend/src/components/core/theme/ThemeProvider.tsx
new file mode 100644
index 0000000..1c8b709
--- /dev/null
+++ b/.azd-setup/src/frontend/src/components/core/theme/ThemeProvider.tsx
@@ -0,0 +1,16 @@
+import { PropsWithChildren } from "react";
+import { FluentProvider } from "@fluentui/react-components";
+import { ThemeContext } from "./ThemeContext";
+import { useThemeProvider } from "./useThemeProvider";
+
+export function ThemeProvider({ children }: PropsWithChildren): JSX.Element {
+ const themeContext = useThemeProvider();
+
+ return (
+
+
+ {children}
+
+
+ );
+}
diff --git a/.azd-setup/src/frontend/src/components/core/theme/themes.ts b/.azd-setup/src/frontend/src/components/core/theme/themes.ts
new file mode 100644
index 0000000..06ec558
--- /dev/null
+++ b/.azd-setup/src/frontend/src/components/core/theme/themes.ts
@@ -0,0 +1,37 @@
+import {
+ BrandVariants,
+ createDarkTheme,
+ createLightTheme,
+ Theme,
+} from "@fluentui/react-components";
+
+// Define our brand colors for the theme
+const brandColors: BrandVariants = {
+ 10: "#010306",
+ 20: "#071926",
+ 30: "#002A41",
+ 40: "#003653",
+ 50: "#004365",
+ 60: "#005078",
+ 70: "#005E8B",
+ 80: "#007BB4",
+ 90: "#007BB4",
+ 100: "#008AC9",
+ 110: "#0099DE",
+ 120: "#00A8F4",
+ 130: "#3FB6FF",
+ 140: "#73C3FF",
+ 150: "#98D0FF",
+ 160: "#B8DEFF",
+};
+
+export const lightTheme: Theme = {
+ ...createLightTheme(brandColors),
+};
+
+export const darkTheme: Theme = {
+ ...createDarkTheme(brandColors),
+ colorBrandForeground1: brandColors[110],
+ colorBrandForeground2: brandColors[120],
+ colorBrandForegroundLink: brandColors[140],
+};
diff --git a/.azd-setup/src/frontend/src/components/core/theme/useThemeProvider.ts b/.azd-setup/src/frontend/src/components/core/theme/useThemeProvider.ts
new file mode 100644
index 0000000..8712ea7
--- /dev/null
+++ b/.azd-setup/src/frontend/src/components/core/theme/useThemeProvider.ts
@@ -0,0 +1,83 @@
+import { useCallback, useEffect, useState } from "react";
+import { IThemeContextValue, Theme } from "./ThemeContext";
+import { darkTheme, lightTheme } from "./themes";
+
+const LOCAL_STORAGE_THEME_KEY = "get-started-with-agents-app-theme-preference";
+
+export function useMediaQuery(query: string): boolean {
+ const [matches, setMatches] = useState(() => {
+ if (typeof window !== "undefined") {
+ return window.matchMedia(query).matches;
+ }
+ return false;
+ });
+
+ useEffect(() => {
+ if (typeof window !== "undefined") {
+ const mediaQuery = window.matchMedia(query);
+ const updateMatches = () => {
+ setMatches(mediaQuery.matches);
+ };
+
+ mediaQuery.addEventListener("change", updateMatches);
+
+ updateMatches();
+ return () => {
+ mediaQuery.removeEventListener("change", updateMatches);
+ };
+ }
+ return () => {
+ // Cleanup if needed
+ };
+ }, [query]);
+
+ return matches;
+}
+
+export const useThemeProvider = (): IThemeContextValue => {
+ const prefersDark = useMediaQuery("(prefers-color-scheme: dark)");
+
+ const [savedTheme, setSavedTheme] = useState(() => {
+ if (typeof localStorage !== "undefined") {
+ const storedTheme = localStorage.getItem(
+ LOCAL_STORAGE_THEME_KEY
+ ) as Theme;
+ if (storedTheme && ["Light", "Dark", "System"].includes(storedTheme)) {
+ return storedTheme;
+ }
+ }
+ return "System";
+ });
+
+ const isDarkMode =
+ savedTheme === "System" ? prefersDark : savedTheme === "Dark";
+
+ const currentTheme = isDarkMode ? "Dark" : "Light";
+
+ const themeStyles = isDarkMode ? darkTheme : lightTheme;
+
+ const setTheme = useCallback((newTheme: Theme) => {
+ setSavedTheme(newTheme);
+ if (typeof localStorage !== "undefined") {
+ localStorage.setItem(LOCAL_STORAGE_THEME_KEY, newTheme);
+ }
+ }, []);
+
+ useEffect(() => {
+ // Update document color scheme for browser UI
+ if (typeof document !== "undefined") {
+ document.documentElement.style.colorScheme = isDarkMode
+ ? "dark"
+ : "light";
+ }
+ }, [isDarkMode]);
+
+ return {
+ theme: savedTheme,
+ savedTheme,
+ currentTheme,
+ themeStyles,
+ setTheme,
+ isDarkMode,
+ };
+};
diff --git a/.azd-setup/src/frontend/src/components/icons/AIFoundryLogo.tsx b/.azd-setup/src/frontend/src/components/icons/AIFoundryLogo.tsx
new file mode 100644
index 0000000..08eb5dd
--- /dev/null
+++ b/.azd-setup/src/frontend/src/components/icons/AIFoundryLogo.tsx
@@ -0,0 +1,32 @@
+import { ReactNode } from "react";
+
+interface AIFoundryLogoProps {
+ width?: number | string;
+ height?: number | string;
+ className?: string;
+}
+
+export function AIFoundryLogo({
+ width = 24,
+ height = 24,
+ className
+}: AIFoundryLogoProps): ReactNode {
+ return (
+
+ );
+}
diff --git a/.azd-setup/src/frontend/src/css-modules.d.ts b/.azd-setup/src/frontend/src/css-modules.d.ts
new file mode 100644
index 0000000..1336d3b
--- /dev/null
+++ b/.azd-setup/src/frontend/src/css-modules.d.ts
@@ -0,0 +1,4 @@
+declare module '*.module.css' {
+ const classes: { [key: string]: string };
+ export default classes;
+}
\ No newline at end of file
diff --git a/.azd-setup/src/frontend/src/main.tsx b/.azd-setup/src/frontend/src/main.tsx
new file mode 100644
index 0000000..b328593
--- /dev/null
+++ b/.azd-setup/src/frontend/src/main.tsx
@@ -0,0 +1,16 @@
+import React from 'react';
+import ReactDOM from 'react-dom/client';
+import App from './components/App';
+
+// Mount the React app to a div with id "react-root" that we'll add to the HTML
+const rootElement = document.getElementById('react-root');
+
+if (rootElement) {
+ ReactDOM.createRoot(rootElement).render(
+
+
+ );
+} else {
+ console.error('Failed to find the react-root element');
+}
\ No newline at end of file
diff --git a/.azd-setup/src/frontend/src/svg.d.ts b/.azd-setup/src/frontend/src/svg.d.ts
new file mode 100644
index 0000000..5bca898
--- /dev/null
+++ b/.azd-setup/src/frontend/src/svg.d.ts
@@ -0,0 +1,6 @@
+declare module '*.svg' {
+ import * as React from 'react';
+
+ const ReactComponent: React.FunctionComponent>;
+ export default ReactComponent;
+}
\ No newline at end of file
diff --git a/.azd-setup/src/frontend/src/types/chat.ts b/.azd-setup/src/frontend/src/types/chat.ts
new file mode 100644
index 0000000..aa2d4f6
--- /dev/null
+++ b/.azd-setup/src/frontend/src/types/chat.ts
@@ -0,0 +1,25 @@
+export interface IFileEntity {
+ id: string;
+ name: string;
+ contentType: string;
+ size?: number;
+ url?: string;
+}
+
+export interface IMessage {
+ id: string;
+ content: string;
+ role: 'user' | 'assistant';
+ message_files?: IFileEntity[];
+ annotations?: any[];
+ fileReferences?: Map;
+ duration?: number;
+ usageInfo?: {
+ prompt_tokens: number;
+ completion_tokens: number;
+ total_tokens: number;
+ };
+ more?: {
+ time?: string;
+ };
+}
\ No newline at end of file
diff --git a/.azd-setup/src/frontend/tsconfig.json b/.azd-setup/src/frontend/tsconfig.json
new file mode 100644
index 0000000..d330af1
--- /dev/null
+++ b/.azd-setup/src/frontend/tsconfig.json
@@ -0,0 +1,27 @@
+{
+ "compilerOptions": {
+ "target": "ES2022",
+ "useDefineForClassFields": true,
+ "lib": ["DOM", "DOM.Iterable", "ES2022"],
+ "module": "ESNext",
+ "skipLibCheck": true,
+ "moduleResolution": "bundler",
+ "allowImportingTsExtensions": true,
+ "resolveJsonModule": true,
+ "isolatedModules": true,
+ "noEmit": true,
+ "jsx": "react-jsx",
+ "strict": true,
+ "noUnusedLocals": true,
+ "noUnusedParameters": true,
+ "noFallthroughCasesInSwitch": true,
+ "allowSyntheticDefaultImports": true,
+ "esModuleInterop": true,
+ "baseUrl": ".",
+ "paths": {
+ "~/*": ["./src/*"]
+ }
+ },
+ "include": ["src"],
+ "references": [{ "path": "./tsconfig.node.json" }]
+}
\ No newline at end of file
diff --git a/.azd-setup/src/frontend/tsconfig.node.json b/.azd-setup/src/frontend/tsconfig.node.json
new file mode 100644
index 0000000..099658c
--- /dev/null
+++ b/.azd-setup/src/frontend/tsconfig.node.json
@@ -0,0 +1,10 @@
+{
+ "compilerOptions": {
+ "composite": true,
+ "skipLibCheck": true,
+ "module": "ESNext",
+ "moduleResolution": "bundler",
+ "allowSyntheticDefaultImports": true
+ },
+ "include": ["vite.config.ts"]
+}
\ No newline at end of file
diff --git a/.azd-setup/src/frontend/vite.config.ts b/.azd-setup/src/frontend/vite.config.ts
new file mode 100644
index 0000000..523b6f9
--- /dev/null
+++ b/.azd-setup/src/frontend/vite.config.ts
@@ -0,0 +1,33 @@
+import { defineConfig } from "vite";
+import react from "@vitejs/plugin-react";
+import { resolve } from "path";
+
+export default defineConfig({
+ plugins: [react()],
+ resolve: {
+ alias: {
+ "~": resolve(__dirname, "./src"),
+ },
+ },
+ build: {
+ outDir: "../api/static/react",
+ emptyOutDir: true,
+ manifest: true,
+ cssCodeSplit: false,
+ rollupOptions: {
+ input: {
+ main: "./src/main.tsx",
+ },
+ output: {
+ entryFileNames: "assets/main-react-app.js",
+ chunkFileNames: "assets/[name].js",
+ assetFileNames: (assetInfo) => {
+ if (assetInfo.name === "style.css") {
+ return "assets/main-react-app.css";
+ }
+ return "assets/[name][extname]";
+ },
+ },
+ },
+ },
+});
diff --git a/.azd-setup/src/gunicorn.conf.py b/.azd-setup/src/gunicorn.conf.py
new file mode 100644
index 0000000..c32dce2
--- /dev/null
+++ b/.azd-setup/src/gunicorn.conf.py
@@ -0,0 +1,256 @@
+# Copyright (c) Microsoft. All rights reserved.
+# Licensed under the MIT license.
+# See LICENSE file in the project root for full license information.
+from typing import Dict, List
+
+import asyncio
+import csv
+import json
+import logging
+import multiprocessing
+import os
+import sys
+
+from azure.ai.projects.aio import AIProjectClient
+from azure.ai.agents.models import (
+ Agent,
+ AsyncToolSet,
+ AzureAISearchTool,
+ FilePurpose,
+ FileSearchTool,
+ Tool,
+)
+from azure.ai.projects.models import ConnectionType, ApiKeyCredentials
+from azure.identity.aio import DefaultAzureCredential
+from azure.core.credentials_async import AsyncTokenCredential
+
+from dotenv import load_dotenv
+
+from logging_config import configure_logging
+
+load_dotenv()
+
+logger = configure_logging(os.getenv("APP_LOG_FILE", ""))
+
+
+agentID = os.environ.get("AZURE_EXISTING_AGENT_ID") if os.environ.get(
+ "AZURE_EXISTING_AGENT_ID") else os.environ.get(
+ "AZURE_AI_AGENT_ID")
+
+proj_endpoint = os.environ.get("AZURE_EXISTING_AIPROJECT_ENDPOINT")
+
+def list_files_in_files_directory() -> List[str]:
+ # Get the absolute path of the 'files' directory
+ files_directory = os.path.abspath(os.path.join(os.path.dirname(__file__), 'files'))
+
+ # List all files in the 'files' directory
+ files = [f for f in os.listdir(files_directory) if os.path.isfile(os.path.join(files_directory, f))]
+
+ return files
+
+FILES_NAMES = list_files_in_files_directory()
+
+
+async def create_index_maybe(
+ ai_client: AIProjectClient, creds: AsyncTokenCredential) -> None:
+ """
+ Create the index and upload documents if the index does not exist.
+
+ This code is executed only once, when called on_starting hook is being
+ called. This code ensures that the index is being populated only once.
+ rag.create_index return True if the index was created, meaning that this
+ docker node have started first and must populate index.
+
+ :param ai_client: The project client to be used to create an index.
+ :param creds: The credentials, used for the index.
+ """
+ from api.search_index_manager import SearchIndexManager
+ endpoint = os.environ.get('AZURE_AI_SEARCH_ENDPOINT')
+ embedding = os.getenv('AZURE_AI_EMBED_DEPLOYMENT_NAME')
+ if endpoint and embedding:
+ try:
+ aoai_connection = await ai_client.connections.get_default(
+ connection_type=ConnectionType.AZURE_OPEN_AI, include_credentials=True)
+ except ValueError as e:
+ logger.error("Error creating index: {e}")
+ return
+
+ embed_api_key = None
+ if aoai_connection.credentials and isinstance(aoai_connection.credentials, ApiKeyCredentials):
+ embed_api_key = aoai_connection.credentials.api_key
+
+ search_mgr = SearchIndexManager(
+ endpoint=endpoint,
+ credential=creds,
+ index_name=os.getenv('AZURE_AI_SEARCH_INDEX_NAME'),
+ dimensions=None,
+ model=embedding,
+ deployment_name=embedding,
+ embedding_endpoint=aoai_connection.target,
+ embed_api_key=embed_api_key
+ )
+ # If another application instance already have created the index,
+ # do not upload the documents.
+ if await search_mgr.create_index(
+ vector_index_dimensions=int(
+ os.getenv('AZURE_AI_EMBED_DIMENSIONS'))):
+ embeddings_path = os.path.join(
+ os.path.dirname(__file__), 'data', 'embeddings.csv')
+
+ assert embeddings_path, f'File {embeddings_path} not found.'
+ await search_mgr.upload_documents(embeddings_path)
+ await search_mgr.close()
+
+
+def _get_file_path(file_name: str) -> str:
+ """
+ Get absolute file path.
+
+ :param file_name: The file name.
+ """
+ return os.path.abspath(
+ os.path.join(os.path.dirname(__file__),
+ 'files',
+ file_name))
+
+
+async def get_available_tool(
+ project_client: AIProjectClient,
+ creds: AsyncTokenCredential) -> Tool:
+ """
+ Get the toolset and tool definition for the agent.
+
+ :param ai_client: The project client to be used to create an index.
+ :param creds: The credentials, used for the index.
+ :return: The tool set, available based on the environment.
+ """
+ # File name -> {"id": file_id, "path": file_path}
+ file_ids: List[str] = []
+ # First try to get an index search.
+ conn_id = ""
+ if os.environ.get('AZURE_AI_SEARCH_INDEX_NAME'):
+ conn_list = project_client.connections.list()
+ async for conn in conn_list:
+ if conn.type == ConnectionType.AZURE_AI_SEARCH:
+ conn_id = conn.id
+ break
+
+ toolset = AsyncToolSet()
+ if conn_id:
+ await create_index_maybe(project_client, creds)
+
+ return AzureAISearchTool(
+ index_connection_id=conn_id,
+ index_name=os.environ.get('AZURE_AI_SEARCH_INDEX_NAME'))
+ else:
+ logger.info(
+ "agent: index was not initialized, falling back to file search.")
+
+ # Upload files for file search
+ for file_name in FILES_NAMES:
+ file_path = _get_file_path(file_name)
+ file = await project_client.agents.files.upload_and_poll(
+ file_path=file_path, purpose=FilePurpose.AGENTS)
+ # Store both file id and the file path using the file name as key.
+ file_ids.append(file.id)
+
+ # Create the vector store using the file IDs.
+ vector_store = await project_client.agents.vector_stores.create_and_poll(
+ file_ids=file_ids,
+ name="sample_store"
+ )
+ logger.info("agent: file store and vector store success")
+
+ return FileSearchTool(vector_store_ids=[vector_store.id])
+
+
+async def create_agent(ai_client: AIProjectClient,
+ creds: AsyncTokenCredential) -> Agent:
+ logger.info("Creating new agent with resources")
+ tool = await get_available_tool(ai_client, creds)
+ toolset = AsyncToolSet()
+ toolset.add(tool)
+
+ instructions = "Use AI Search always. Avoid to use base knowledge." if isinstance(tool, AzureAISearchTool) else "Use File Search always. Avoid to use base knowledge."
+
+ agent = await ai_client.agents.create_agent(
+ model=os.environ["AZURE_AI_AGENT_DEPLOYMENT_NAME"],
+ name=os.environ["AZURE_AI_AGENT_NAME"],
+ instructions=instructions,
+ toolset=toolset
+ )
+ return agent
+
+
+async def initialize_resources():
+ try:
+ async with DefaultAzureCredential(
+ exclude_shared_token_cache_credential=True) as creds:
+ async with AIProjectClient(
+ credential=creds,
+ endpoint=proj_endpoint
+ ) as ai_client:
+ # If the environment already has AZURE_AI_AGENT_ID or AZURE_EXISTING_AGENT_ID, try
+ # fetching that agent
+ if agentID is not None:
+ try:
+ agent = await ai_client.agents.get_agent(
+ agentID)
+ logger.info(f"Found agent by ID: {agent.id}")
+ return
+ except Exception as e:
+ logger.warning(
+ "Could not retrieve agent by AZURE_EXISTING_AGENT_ID = "
+ f"{agentID}, error: {e}")
+
+ # Check if an agent with the same name already exists
+ agent_list = ai_client.agents.list_agents()
+ if agent_list:
+ async for agent_object in agent_list:
+ if agent_object.name == os.environ[
+ "AZURE_AI_AGENT_NAME"]:
+ logger.info(
+ "Found existing agent named "
+ f"'{agent_object.name}'"
+ f", ID: {agent_object.id}")
+ os.environ["AZURE_EXISTING_AGENT_ID"] = agent_object.id
+ return
+
+ # Create a new agent
+ agent = await create_agent(ai_client, creds)
+ os.environ["AZURE_EXISTING_AGENT_ID"] = agent.id
+ logger.info(f"Created agent, agent ID: {agent.id}")
+
+ except Exception as e:
+ logger.info("Error creating agent: {e}", exc_info=True)
+ raise RuntimeError(f"Failed to create the agent: {e}")
+
+
+def on_starting(server):
+ """This code runs once before the workers will start."""
+ asyncio.get_event_loop().run_until_complete(initialize_resources())
+
+
+max_requests = 1000
+max_requests_jitter = 50
+log_file = "-"
+bind = "0.0.0.0:50505"
+
+if not os.getenv("RUNNING_IN_PRODUCTION"):
+ reload = True
+
+# Load application code before the worker processes are forked.
+# Needed to execute on_starting.
+# Please see the documentation on gunicorn
+# https://docs.gunicorn.org/en/stable/settings.html
+preload_app = True
+num_cpus = multiprocessing.cpu_count()
+workers = (num_cpus * 2) + 1
+worker_class = "uvicorn.workers.UvicornWorker"
+
+timeout = 120
+
+if __name__ == "__main__":
+ print("Running initialize_resources directly...")
+ asyncio.run(initialize_resources())
+ print("initialize_resources finished.")
\ No newline at end of file
diff --git a/.azd-setup/src/logging_config.py b/.azd-setup/src/logging_config.py
new file mode 100644
index 0000000..ef2b5a0
--- /dev/null
+++ b/.azd-setup/src/logging_config.py
@@ -0,0 +1,37 @@
+# Copyright (c) Microsoft. All rights reserved.
+# Licensed under the MIT license. See LICENSE.md file in the project root for full license information.
+
+import logging
+import sys
+from typing import Optional
+
+def configure_logging(log_file_name: Optional[str] = None, logger_name: str = "azureaiapp") -> logging.Logger:
+ """
+ Configure and return a logger with both stream (stdout) and optional file handlers.
+
+ :param log_file_name: The path to the log file. If provided, logs will also be written to this file.
+ :type log_file_name: Optional[str]
+ :param logger_name: The name of the logger to configure.
+ :type logger_name: str
+ :return: The configured logger instance.
+ :rtype: logging.Logger
+ """
+ logger = logging.getLogger(logger_name)
+ logger.setLevel(logging.INFO)
+
+ # Stream handler (stdout)
+ stream_handler = logging.StreamHandler(sys.stdout)
+ stream_handler.setLevel(logging.INFO)
+ stream_formatter = logging.Formatter("%(asctime)s [%(levelname)s] %(name)s: %(message)s")
+ stream_handler.setFormatter(stream_formatter)
+ logger.addHandler(stream_handler)
+
+ # File handler if a log file is specified
+ if log_file_name:
+ file_handler = logging.FileHandler(log_file_name)
+ file_handler.setLevel(logging.INFO)
+ file_formatter = logging.Formatter("%(asctime)s [%(levelname)s] %(name)s: %(message)s")
+ file_handler.setFormatter(file_formatter)
+ logger.addHandler(file_handler)
+
+ return logger
\ No newline at end of file
diff --git a/.azd-setup/src/pyproject.toml b/.azd-setup/src/pyproject.toml
new file mode 100644
index 0000000..09bb7d1
--- /dev/null
+++ b/.azd-setup/src/pyproject.toml
@@ -0,0 +1,20 @@
+[project]
+name = "api"
+version = "1.0.0"
+description = "Create a simple chat app using Quart and Azure AI Agents"
+dependencies = [
+ "fastapi==0.111.0",
+ "gunicorn==22.0.0",
+ "uvicorn[standard]==0.29.0",
+ "opentelemetry-sdk",
+ "azure-identity==1.19.0",
+ "aiohttp==3.11.1",
+ "azure-ai-projects",
+ "azure-core-tracing-opentelemetry",
+ "azure-monitor-opentelemetry>=1.6.9",
+ "azure-search-documents"
+ ]
+
+[build-system]
+requires = ["flit_core<4"]
+build-backend = "flit_core.buildapi"
diff --git a/.azd-setup/src/requirements.txt b/.azd-setup/src/requirements.txt
new file mode 100644
index 0000000..2aaced5
--- /dev/null
+++ b/.azd-setup/src/requirements.txt
@@ -0,0 +1,17 @@
+fastapi==0.115.13
+uvicorn[standard]==0.29.0
+gunicorn==23.0.0
+azure-identity==1.19.0
+aiohttp==3.11.1
+
+azure_ai_agents==1.0.0
+azure_ai_projects==1.0.0b11
+
+azure-core==1.34.0 # other versions might not compatible
+azure-core-tracing-opentelemetry
+azure-monitor-opentelemetry==1.6.9 # version such as 1.6.11 isn't compatible
+azure-search-documents
+opentelemetry-sdk
+setuptools==80.9.0
+starlette>=0.40.0 # fix vulnerability
+jinja2 # new dependent of fastapi
\ No newline at end of file
diff --git a/.azd-setup/tests/test_search_index_manager.py b/.azd-setup/tests/test_search_index_manager.py
new file mode 100644
index 0000000..e17a7b3
--- /dev/null
+++ b/.azd-setup/tests/test_search_index_manager.py
@@ -0,0 +1,307 @@
+# Copyright (c) Microsoft. All rights reserved.
+# Licensed under the MIT license.
+# See LICENSE file in the project root for full license information.
+import csv
+import json
+import os
+import tempfile
+import unittest
+from unittest.mock import AsyncMock, patch
+from azure.identity.aio import DefaultAzureCredential
+
+from search_index_manager import SearchIndexManager
+from azure.ai.projects.aio import AIProjectClient
+from azure.ai.projects.models._enums import ConnectionType
+from azure.core.exceptions import HttpResponseError
+
+from ddt import ddt, data
+
+connection_string = os.environ.get("AZURE_EXISTING_AIPROJECT_CONNECTION_STRING") if os.environ.get("AZURE_EXISTING_AIPROJECT_CONNECTION_STRING") else os.environ.get("AZURE_AIPROJECT_CONNECTION_STRING")
+
+class MockAsyncIterator:
+
+ def __init__(self, list_data):
+ assert list_data and isinstance(list_data, list)
+ self._data = list_data
+
+ async def __aiter__(self):
+ for dt in self._data:
+ yield dt
+
+
+@ddt
+class TestSearchIndexManager(unittest.IsolatedAsyncioTestCase):
+ """Tests for the RAG helper."""
+
+ INPUT_DIR = os.path.join(
+ os.path.dirname(os.path.dirname(os.path.dirname(__file__))), 'files')
+ # INPUT_DIR = os.path.join(
+ # os.path.dirname(
+ # os.path.dirname(
+ # os.path.dirname(os.path.dirname(__file__)))), 'data_')
+ EMBEDDINGS_FILE = os.path.join(os.path.dirname(os.path.dirname(os.path.dirname(__file__))),
+ 'data', 'embeddings.csv')
+
+ @classmethod
+ def setUpClass(cls) -> None:
+ super(TestSearchIndexManager, cls).setUpClass()
+
+ def setUp(self) -> None:
+ self.search_endpoint = os.environ["SEARCH_ENDPOINT"]
+ self.index_name = "test_index"
+ self.embed_key = os.environ['EMBED_API_KEY']
+ self.model = "text-embedding-3-small"
+ unittest.TestCase.setUp(self)
+
+ async def test_create_delete_mock(self):
+ """Test that if index is deleteed the appropriate error is raised."""
+ mock_ix_client = AsyncMock()
+ mock_aenter = AsyncMock()
+ with patch(
+ 'search_index_manager.SearchIndexClient',
+ return_value=mock_ix_client):
+ mock_ix_client.__aenter__.return_value = mock_aenter
+ rag = self._get_mock_rag(AsyncMock())
+ self.assertTrue(await rag.create_index())
+ mock_aenter.create_index.assert_called_once()
+ mock_aenter.get_index.assert_not_called()
+ mock_aenter.create_index.reset_mock()
+ mock_aenter.create_index.side_effect = HttpResponseError(
+ 'Mock http error')
+ self.assertFalse(await rag.create_index())
+ mock_aenter.create_index.assert_called_once()
+ mock_aenter.get_index.assert_called_once()
+ with self.assertRaisesRegex(HttpResponseError, 'Mock http error'):
+ await rag.create_index(raise_on_error=True)
+ await rag.delete_index()
+ mock_aenter.create_index.side_effect = ValueError(
+ 'Mock value error')
+ with self.assertRaisesRegex(ValueError, 'Mock value error'):
+ await rag.create_index()
+
+ mock_aenter.delete_index.assert_called_once()
+ with self.assertRaisesRegex(
+ ValueError,
+ "Unable to perform the operation "
+ "as the index is absent.+"):
+ await rag.delete_index()
+
+ async def test_exception_no_dinmensions(self):
+ """Test the exception shown if no dimensions were provided."""
+ rag = SearchIndexManager(
+ endpoint=self.search_endpoint,
+ credential=AsyncMock(),
+ index_name=self.index_name,
+ dimensions=None,
+ model=self.model,
+ deployment_name="mock_embedding_model",
+ embedding_endpoint="",
+ embedding_client=AsyncMock(),
+ embed_api_key=self.embed_key,
+ )
+ with self.assertRaisesRegex(
+ ValueError, "No embedding dimensions were provided.+"):
+ await rag.create_index(vector_index_dimensions=None)
+
+ async def test_exception_different_dimmensions(self):
+ """Test the exception shown if dimensions
+ and dinensions_override are different."""
+ rag = SearchIndexManager(
+ endpoint=self.search_endpoint,
+ credential=AsyncMock(),
+ index_name=self.index_name,
+ dimensions=41,
+ model=self.model,
+ embedding_client=AsyncMock(),
+ deployment_name=self.model,
+ embedding_endpoint=self.search_endpoint,
+ embed_api_key=self.embed_key,
+ )
+ with self.assertRaisesRegex(
+ ValueError,
+ "vector_index_dimensions is different "
+ "from dimensions provided to constructor."):
+ await rag.create_index(vector_index_dimensions=42)
+
+ @unittest.skip("Only for live tests.")
+ async def test_e2e(self):
+ """Run search end to end."""
+ async with DefaultAzureCredential() as creds:
+ async with AIProjectClient.from_connection_string(
+ credential=creds,
+ conn_str=connection_string,
+ ) as project:
+ aoai_connection = await project.connections.get_default(
+ connection_type=ConnectionType.AZURE_OPEN_AI,
+ include_credentials=True)
+ self.assertIsNotNone(aoai_connection)
+ rag = SearchIndexManager(
+ endpoint=self.search_endpoint,
+ credential=creds,
+ index_name=self.index_name,
+ dimensions=100,
+ model=self.model,
+ deployment_name=self.model,
+ embedding_endpoint=aoai_connection.endpoint_url,
+ embed_api_key=aoai_connection.key,
+ )
+ self.assertTrue(await rag.create_index(raise_on_error=True))
+ await rag.upload_documents(
+ os.path.join(
+ os.path.dirname(
+ os.path.dirname(
+ __file__)), 'data', 'embeddings.csv'))
+
+ result = await rag.search(
+ "What is the temperature rating "
+ "of the cozynights sleeping bag?")
+ result_semantic = await rag.semantic_search(
+ "What is the temperature rating "
+ "of the cozynights sleeping bag?")
+ await rag.delete_index()
+ await rag.close()
+ self.assertTrue(bool(result), "The regular search is empty.")
+ self.assertTrue(bool(result_semantic), "The semantic search is empty.")
+
+ async def test_life_cycle_mock(self):
+ """Test create, upload, search and delete"""
+ mock_ix_client = AsyncMock()
+ mock_aenter = AsyncMock()
+ mock_serch_client = AsyncMock()
+ mock_serch_client.search.return_value = MockAsyncIterator([
+ {'token': 'a', 'title': 'a.txt'},
+ {'token': 'b', 'title': 'b.txt'}
+ ])
+ with patch(
+ 'search_index_manager.SearchIndexClient',
+ return_value=mock_ix_client):
+ with patch(
+ 'search_index_manager.SearchClient',
+ return_value=mock_serch_client):
+ mock_ix_client.__aenter__.return_value = mock_aenter
+ rag = self._get_mock_rag(AsyncMock())
+ self.assertTrue(await rag.create_index())
+
+ # Upload documents.
+ await rag.upload_documents(
+ TestSearchIndexManager.EMBEDDINGS_FILE)
+ mock_serch_client.upload_documents.assert_called_once()
+
+ search_result = await rag.search('test')
+ mock_serch_client.search.assert_called_once()
+ self.assertEqual(search_result,
+ "a, source: a.txt\n------\nb, source: b.txt")
+
+ @data(2, 4)
+ async def test_build_embeddings_file_mock(self, sentences_per_embedding):
+ """Use this test to build
+ the new embeddings file in the data directory."""
+ embedding_client = AsyncMock()
+ embedding_client.embed.retun_value = {'data': [[0, 0], [1, 1], [
+ 2, 2]] if sentences_per_embedding == 4 else [[0, 0], [1, 1]]}
+ rag = SearchIndexManager(
+ endpoint=self.search_endpoint,
+ credential=AsyncMock(),
+ index_name=self.index_name,
+ dimensions=2,
+ model=self.model,
+ deployment_name=self.model,
+ embedding_endpoint=self.search_endpoint,
+ embed_api_key=self.embed_key,
+ embedding_client=embedding_client
+ )
+ sentences = [
+ f"This is {v} sentence" for v in [
+ 'first', 'second', 'third', 'forth', 'fifth']]
+ with tempfile.TemporaryDirectory() as d:
+ data = ' '.join(sentences)
+ input_file = os.path.join(d, 'input.csv')
+ with open(input_file, 'w') as f:
+ f.write(data)
+ out_file = os.path.join(d, 'embeddings.csv')
+ await rag.build_embeddings_file(
+ input_directory=input_file,
+ output_file=out_file,
+ sentences_per_embedding=sentences_per_embedding
+ )
+ index = 1
+ with open(out_file, newline='') as fp:
+ reader = csv.DictReader(fp)
+ for row in reader:
+ self.assertEqual(
+ ' '.join(
+ sentences[
+ index * sentences_per_embedding: (
+ index + 1) * sentences_per_embedding]))
+ self.assertListEqual(
+ json.loads(
+ row['embedding']), [
+ index, index])
+ self.assertEqual(row['document_reference'], 'input.csv')
+ index += 1
+
+ @unittest.skip("Only for live tests.")
+ async def test_build_embeddings_file(self):
+ """Use this test to build the new
+ embeddings file in the data directory."""
+ async with DefaultAzureCredential() as creds:
+ async with AIProjectClient.from_connection_string(
+ credential=creds,
+ conn_str=connection_string,
+ ) as project:
+ aoai_connection = await project.connections.get_default(
+ connection_type=ConnectionType.AZURE_OPEN_AI)
+ self.assertIsNotNone(aoai_connection)
+ async with (
+ await project.inference.get_embeddings_client()) as embed:
+ rag = SearchIndexManager(
+ endpoint=self.search_endpoint,
+ credential=creds,
+ index_name=self.index_name,
+ dimensions=100,
+ model=self.model,
+ deployment_name=self.model,
+ embedding_endpoint=aoai_connection.endpoint_url,
+ embed_api_key=self.embed_key,
+ embedding_client=embed
+ )
+ await rag.build_embeddings_file(
+ input_directory=TestSearchIndexManager.INPUT_DIR,
+ output_file=TestSearchIndexManager.EMBEDDINGS_FILE,
+ sentences_per_embedding=10
+ )
+
+ @unittest.skip("Only for live tests.")
+ async def test_get_or_create(self):
+ """Test index_name creation."""
+ async with DefaultAzureCredential() as cred:
+ self.AssertTrue(await SearchIndexManager.create_index(
+ endpoint=self.search_endpoint,
+ credential=cred,
+ index_name=self.index_name,
+ dimensions=100))
+ self.AssertFalse(await SearchIndexManager.create_index(
+ endpoint=self.search_endpoint,
+ credential=cred,
+ index_name=self.index_name,
+ dimensions=100500))
+
+ def _get_mock_rag(self, embedding_client):
+ """Return the mock RAG """
+ return SearchIndexManager(
+ endpoint=self.search_endpoint,
+ credential=AsyncMock(),
+ index_name=self.index_name,
+ dimensions=100,
+ model="mock_embedding_model",
+ deployment_name="mock_embedding_model",
+ embedding_client=embedding_client,
+ embedding_endpoint="",
+ embed_api_key=self.embed_key
+
+ )
+
+
+if __name__ == "__main__":
+ # import sys;sys.argv = ['', 'Test.testName']
+ unittest.main()
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..e10acbf
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,54 @@
+# Azure Developer CLI
+.azure/
+
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# IDEs
+.vscode/
+.idea/
+*.swp
+*.swo
+*~
+
+# OS
+.DS_Store
+.DS_Store?
+._*
+.Spotlight-V100
+.Trashes
+ehthumbs.db
+Thumbs.db
+
+# Temporary files
+*.tmp
+*.temp
\ No newline at end of file
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
new file mode 100644
index 0000000..6257f2e
--- /dev/null
+++ b/CODE_OF_CONDUCT.md
@@ -0,0 +1,9 @@
+# Microsoft Open Source Code of Conduct
+
+This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
+
+Resources:
+
+- [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/)
+- [Microsoft Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/)
+- Contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with questions or concerns
\ No newline at end of file
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..7965606
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,21 @@
+ MIT License
+
+ Copyright (c) Microsoft Corporation.
+
+ Permission is hereby granted, free of charge, to any person obtaining a copy
+ of this software and associated documentation files (the "Software"), to deal
+ in the Software without restriction, including without limitation the rights
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ copies of the Software, and to permit persons to whom the Software is
+ furnished to do so, subject to the following conditions:
+
+ The above copyright notice and this permission notice shall be included in all
+ copies or substantial portions of the Software.
+
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ SOFTWARE
\ No newline at end of file
diff --git a/README.md b/README.md
index 4ba7319..51cff85 100644
--- a/README.md
+++ b/README.md
@@ -1,51 +1,46 @@
-# For Beginners: The Demo Template
+
+**Level:** Beginner to Intermediate + +Let's Go! 🚀 + + + diff --git a/docs/workshop/index.md b/docs/workshop/index.md deleted file mode 100644 index e58e637..0000000 --- a/docs/workshop/index.md +++ /dev/null @@ -1 +0,0 @@ -# Workshop diff --git a/scripts/.env.sample b/scripts/.env.sample new file mode 100644 index 0000000..4218821 --- /dev/null +++ b/scripts/.env.sample @@ -0,0 +1,19 @@ +# .... Azure +AZURE_SUBSCRIPTION_ID= +AZURE_RESOURCE_GROUP= + +# .... Azure AI Foundry +AZURE_OPENAI_API_KEY= +AZURE_OPENAI_ENDPOINT= +AZURE_OPENAI_API_VERSION= # "2025-02-01-preview" +AZURE_AI_FOUNDRY_NAME= # name of ai services resource in resource group +AZURE_AI_PROJECT_NAME= # name of project resource in resource group + +# .... Azure AI Foundry Deployment +AZURE_OPENAI_DEPLOYMENT= # "gpt-4.1" +AZURE_OPENAI_MODEL_VERSION= # "2025-04-14" + +# .... Azure AI Search +AZURE_AISEARCH_ENDPOINT= # from the Azure AI Search resource overview page +AZURE_AISEARCH_API_KEY= # from the Azure AI Search resource "Keys and Endpoint" page +AZURE_AISEARCH_INDEX= # index you are creating e.g., "zava-products" \ No newline at end of file diff --git a/scripts/0-additional-models b/scripts/0-additional-models new file mode 100755 index 0000000..665b847 --- /dev/null +++ b/scripts/0-additional-models @@ -0,0 +1,158 @@ +#!/bin/bash + +# 0-additional-models +# Script to add additional model deployments to the azd infrastructure template +# Usage: ./scripts/0-additional-models + +set -e + +# Colors for output +RED='\033[0;31m' +GREEN='\033[0;32m' +YELLOW='\033[1;33m' +BLUE='\033[0;34m' +NC='\033[0m' # No Color + +# Configuration +SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)" +REPO_ROOT="$DIR/.." +INFRA_DIR="$REPO_ROOT/.azd-setup/infra" +CONFIG_FILE="$SCRIPT_DIR/0-additional-models.json" +MAIN_BICEP="$INFRA_DIR/main.bicep" +PARAMS_FILE="$INFRA_DIR/main.parameters.json" + +echo -e "${BLUE}=== Adding Additional Model Deployments ===${NC}" + +# Check if configuration file exists +if [[ ! -f "$CONFIG_FILE" ]]; then + echo -e "${RED}Error: Configuration file not found: $CONFIG_FILE${NC}" + echo "Please create the configuration file with your model deployment details." + exit 1 +fi + +# Check if infrastructure directory exists +if [[ ! -d "$INFRA_DIR" ]]; then + echo -e "${RED}Error: Infrastructure directory not found: $INFRA_DIR${NC}" + echo "Please run './scripts/2-setup-azd' first to set up the infrastructure template." + exit 1 +fi + +# Validate JSON configuration +echo -e "${YELLOW}Validating configuration file...${NC}" +if ! jq empty "$CONFIG_FILE" 2>/dev/null; then + echo -e "${RED}Error: Invalid JSON in configuration file: $CONFIG_FILE${NC}" + exit 1 +fi + +echo -e "${GREEN}✓ Configuration file is valid${NC}" + +# Read additional models from config file +ADDITIONAL_MODELS=$(cat "$CONFIG_FILE") +echo -e "${BLUE}Models to add:${NC}" +echo "$ADDITIONAL_MODELS" | jq -r '.[] | " - \(.name) (\(.model.name) \(.model.version))"' + +# Backup original files +echo -e "${YELLOW}Creating backups...${NC}" +cp "$MAIN_BICEP" "$MAIN_BICEP.backup.$(date +%Y%m%d-%H%M%S)" +cp "$PARAMS_FILE" "$PARAMS_FILE.backup.$(date +%Y%m%d-%H%M%S)" +echo -e "${GREEN}✓ Backups created${NC}" + +# Step 1: Add parameter to main.bicep if not already present +echo -e "${YELLOW}Step 1: Adding parameter to main.bicep...${NC}" +if grep -q "additionalModelDeployments" "$MAIN_BICEP"; then + echo -e "${GREEN}✓ Parameter already exists in main.bicep${NC}" +else + # Find the line after embedDeploymentCapacity parameter and add our parameter + TEMP_FILE=$(mktemp) + awk ' + /param embedDeploymentCapacity int = 30/ { + print $0 + print "" + print "@description(\"Additional model deployments to create\")" + print "param additionalModelDeployments array = []" + next + } + {print} + ' "$MAIN_BICEP" > "$TEMP_FILE" + mv "$TEMP_FILE" "$MAIN_BICEP" + echo -e "${GREEN}✓ Added additionalModelDeployments parameter${NC}" +fi + +# Step 2: Update aiDeployments variable in main.bicep +echo -e "${YELLOW}Step 2: Updating aiDeployments variable...${NC}" +if grep -q "additionalModelDeployments" "$MAIN_BICEP" && grep -A5 -B5 "var aiDeployments" "$MAIN_BICEP" | grep -q "additionalModelDeployments"; then + echo -e "${GREEN}✓ aiDeployments variable already includes additionalModelDeployments${NC}" +else + # Find and replace the aiDeployments variable + TEMP_FILE=$(mktemp) + awk ' + /^var aiDeployments = concat\(/ { + print "var aiDeployments = concat(" + print " aiChatModel," + print " useSearchService ? aiEmbeddingModel : []," + print " additionalModelDeployments" + print ")" + # Skip the original concat block + while (getline && $0 !~ /^\)/) continue + next + } + {print} + ' "$MAIN_BICEP" > "$TEMP_FILE" + mv "$TEMP_FILE" "$MAIN_BICEP" + echo -e "${GREEN}✓ Updated aiDeployments variable${NC}" +fi + +# Step 3: Add parameter to main.parameters.json +echo -e "${YELLOW}Step 3: Adding parameter to main.parameters.json...${NC}" +if grep -q "additionalModelDeployments" "$PARAMS_FILE"; then + echo -e "${GREEN}✓ Parameter already exists in main.parameters.json${NC}" +else + # Add the parameter before the closing brace + TEMP_FILE=$(mktemp) + jq '. + { + "parameters": (.parameters + { + "additionalModelDeployments": { + "value": "${ADDITIONAL_MODEL_DEPLOYMENTS=[]}" + } + }) + }' "$PARAMS_FILE" > "$TEMP_FILE" + mv "$TEMP_FILE" "$PARAMS_FILE" + echo -e "${GREEN}✓ Added parameter to main.parameters.json${NC}" +fi + +# Step 4: Set environment variable for azd +echo -e "${YELLOW}Step 4: Setting up environment variable...${NC}" +ENV_FILE="$REPO_ROOT/.azd-setup/.azure/AI-AGENTS-AZD/.env" + +if [[ -f "$ENV_FILE" ]]; then + # Convert JSON to string format for environment variable + MODELS_ENV_VALUE=$(echo "$ADDITIONAL_MODELS" | jq -c .) + + # Check if the environment variable already exists + if grep -q "^ADDITIONAL_MODEL_DEPLOYMENTS=" "$ENV_FILE"; then + # Update existing value + sed -i "s|^ADDITIONAL_MODEL_DEPLOYMENTS=.*|ADDITIONAL_MODEL_DEPLOYMENTS='$MODELS_ENV_VALUE'|" "$ENV_FILE" + echo -e "${GREEN}✓ Updated ADDITIONAL_MODEL_DEPLOYMENTS in .env file${NC}" + else + # Add new environment variable + echo "" >> "$ENV_FILE" + echo "# Additional model deployments" >> "$ENV_FILE" + echo "ADDITIONAL_MODEL_DEPLOYMENTS='$MODELS_ENV_VALUE'" >> "$ENV_FILE" + echo -e "${GREEN}✓ Added ADDITIONAL_MODEL_DEPLOYMENTS to .env file${NC}" + fi +else + echo -e "${YELLOW}⚠ Environment file not found: $ENV_FILE${NC}" + echo -e "${YELLOW} The environment variable will need to be set manually or after running 'azd up'${NC}" +fi + +echo -e "${GREEN}=== Additional Model Deployments Setup Complete ===${NC}" +echo "" +echo -e "${BLUE}Next Steps:${NC}" +echo "1. Review the changes made to the infrastructure files" +echo "2. Navigate to the .azd-setup directory: cd .azd-setup" +echo "3. Run 'azd provision' to deploy the additional models" +echo "" +echo -e "${BLUE}Models that will be deployed:${NC}" +echo "$ADDITIONAL_MODELS" | jq -r '.[] | " • \(.name) - \(.model.name) \(.model.version) (Capacity: \(.sku.capacity))"' +echo "" +echo -e "${YELLOW}Note: Make sure your Azure subscription has sufficient quota for these models in the selected region.${NC}" \ No newline at end of file diff --git a/scripts/0-additional-models.json b/scripts/0-additional-models.json new file mode 100644 index 0000000..2866e0b --- /dev/null +++ b/scripts/0-additional-models.json @@ -0,0 +1,110 @@ +[ + { + "name": "model-router", + "model": { + "format": "OpenAI", + "name": "model-router", + "version": "2025-05-19" + }, + "sku": { + "name": "GlobalStandard", + "capacity": 50 + } + }, + { + "name": "gpt-4.1", + "model": { + "format": "OpenAI", + "name": "gpt-4.1", + "version": "2025-04-14" + }, + "sku": { + "name": "GlobalStandard", + "capacity": 50 + } + }, + { + "name": "gpt-4o", + "model": { + "format": "OpenAI", + "name": "gpt-4o", + "version": "2024-11-20" + }, + "sku": { + "name": "GlobalStandard", + "capacity": 50 + } + }, + { + "name": "gpt-4o-mini", + "model": { + "format": "OpenAI", + "name": "gpt-4o-mini", + "version": "2024-07-18" + }, + "sku": { + "name": "GlobalStandard", + "capacity": 50 + } + }, + { + "name": "gpt-4.1-mini", + "model": { + "format": "OpenAI", + "name": "gpt-4.1-mini", + "version": "2025-04-14" + }, + "sku": { + "name": "GlobalStandard", + "capacity": 50 + } + }, + { + "name": "gpt-4.1-nano", + "model": { + "format": "OpenAI", + "name": "gpt-4.1-nano", + "version": "2025-04-14" + }, + "sku": { + "name": "GlobalStandard", + "capacity": 50 + } + }, + { + "name": "o3-mini", + "model": { + "format": "OpenAI", + "name": "o3-mini", + "version": "2025-01-31" + }, + "sku": { + "name": "GlobalStandard", + "capacity": 50 + } + }, + { + "name": "o4-mini", + "model": { + "format": "OpenAI", + "name": "o4-mini", + "version": "2025-04-16" + }, + "sku": { + "name": "GlobalStandard", + "capacity": 50 + } + }, + { + "name": "text-embedding-3-large", + "model": { + "format": "OpenAI", + "name": "text-embedding-3-large", + "version": "1" + }, + "sku": { + "name": "Standard", + "capacity": 50 + } + } +] \ No newline at end of file diff --git a/scripts/1-setup-auth b/scripts/1-setup-auth new file mode 100755 index 0000000..12b25e1 --- /dev/null +++ b/scripts/1-setup-auth @@ -0,0 +1,119 @@ +#!/bin/bash + +# Setup Authentication Script +# Authentication setup script for AI agents lab + +set -e # Exit on any error + +# Colors for output +GREEN='\033[0;32m' +YELLOW='\033[1;33m' +RED='\033[0;31m' +NC='\033[0m' # No Color + +print_success() { + echo -e "${GREEN}✓${NC} $1" +} + +print_warning() { + echo -e "${YELLOW}⚠${NC} $1" +} + +print_error() { + echo -e "${RED}✗${NC} $1" +} + +# --------------------- +# Check Prerequisites +# --------------------- + +echo "→ Checking prerequisites..." + +# Check if azd is installed +if ! command -v azd >/dev/null 2>&1; then + print_error "Azure Developer CLI (azd) is not installed" + echo "Please install azd first: https://learn.microsoft.com/azure/developer/azure-developer-cli/install-azd" + exit 1 +else + azd_version=$(azd version | head -n 1) + print_success "Azure Developer CLI found: $azd_version" +fi + +# Check if az is installed +if ! command -v az >/dev/null 2>&1; then + print_error "Azure CLI (az) is not installed" + echo "Please install Azure CLI first: https://docs.microsoft.com/cli/azure/install-azure-cli" + exit 1 +else + az_version=$(az version --query '"azure-cli"' -o tsv) + print_success "Azure CLI found: $az_version" +fi + +# --------------------- +# Azure CLI Authentication +# --------------------- + +echo "→ Setting up Azure CLI authentication..." + +# Check if already logged in to Azure CLI +if az account show >/dev/null 2>&1; then + print_warning "Already logged in to Azure CLI" + current_account=$(az account show --query 'name' -o tsv) + print_success "Current Azure CLI account: $current_account" +else + echo "Logging in to Azure CLI..." + az login + current_account=$(az account show --query 'name' -o tsv) + print_success "Successfully logged in to Azure CLI: $current_account" +fi + +# --------------------- +# Azure Developer CLI Authentication +# --------------------- + +echo "→ Setting up Azure Developer CLI authentication..." + +# Check if already logged in to Azure Developer CLI +if azd auth login --check-status >/dev/null 2>&1; then + print_warning "Already logged in to Azure Developer CLI" + print_success "Azure Developer CLI authentication verified" +else + echo "Logging in to Azure Developer CLI..." + azd auth login + print_success "Successfully logged in to Azure Developer CLI" +fi + +# --------------------- +# Display Login Status +# --------------------- + +echo "" +echo "→ Current authentication status:" + +# Azure CLI status +echo "" +echo "Azure CLI:" +if az account show >/dev/null 2>&1; then + account_name=$(az account show --query 'name' -o tsv) + subscription_id=$(az account show --query 'id' -o tsv) + tenant_id=$(az account show --query 'tenantId' -o tsv) + user_name=$(az account show --query 'user.name' -o tsv) + + print_success "Logged in as: $user_name" + print_success "Subscription: $account_name ($subscription_id)" + print_success "Tenant ID: $tenant_id" +else + print_error "Not logged in to Azure CLI" +fi + +# Azure Developer CLI status +echo "" +echo "Azure Developer CLI:" +if azd auth login --check-status >/dev/null 2>&1; then + print_success "Authentication verified" +else + print_error "Not logged in to Azure Developer CLI" +fi + +echo "" +print_success "Authentication setup complete!" \ No newline at end of file diff --git a/scripts/2-setup-azd b/scripts/2-setup-azd new file mode 100755 index 0000000..c97c572 --- /dev/null +++ b/scripts/2-setup-azd @@ -0,0 +1,174 @@ +#!/bin/bash + +# Setup Azure Developer CLI (azd) Script +# Simple setup script for AI agents lab + +set -e # Exit on any error + +# Colors for output +GREEN='\033[0;32m' +YELLOW='\033[1;33m' +RED='\033[0;31m' +NC='\033[0m' # No Color + +print_success() { + echo -e "${GREEN}✓${NC} $1" +} + +print_warning() { + echo -e "${YELLOW}⚠${NC} $1" +} + +print_error() { + echo -e "${RED}✗${NC} $1" +} + +# --------------------- +# Check Prerequisites +# --------------------- + +echo "→ Checking prerequisites..." + +# Check if azd is installed +if ! command -v azd >/dev/null 2>&1; then + print_error "Azure Developer CLI (azd) is not installed" + echo "Please install azd first: https://learn.microsoft.com/azure/developer/azure-developer-cli/install-azd" + exit 1 +else + azd_version=$(azd version | head -n 1) + print_success "Azure Developer CLI found: $azd_version" +fi + +# Check if az is installed +if ! command -v az >/dev/null 2>&1; then + print_error "Azure CLI (az) is not installed" + echo "Please install Azure CLI first: https://docs.microsoft.com/cli/azure/install-azure-cli" + exit 1 +else + az_version=$(az version --query '"azure-cli"' -o tsv) + print_success "Azure CLI found: $az_version" +fi + +# --------------------- +# Setup .azd-setup Directory +# --------------------- + +echo "→ Setting up .azd-setup directory..." + +if [ ! -d ".azd-setup" ]; then + mkdir -p .azd-setup + print_success "Created .azd-setup directory" +else + print_success ".azd-setup directory already exists" +fi + +# --------------------- +# Initialize AI Agents Template +# --------------------- + +echo "→ Initializing AI agents template..." + +cd .azd-setup + +# Initialize with the AI agents template using AI-AGENTS-AZD as environment name +azd init -t get-started-with-ai-agents -e AI-AGENTS-AZD + +print_success "AI agents template initialized successfully with environment: AI-AGENTS-AZD" + +# Enable Azure Monitor tracing +azd env set ENABLE_AZURE_MONITOR_TRACING true + +print_success "Azure Monitor tracing enabled" + +# Enable Azure tracing Gen AI content recording +azd env set AZURE_TRACING_GEN_AI_CONTENT_RECORDING_ENABLED true + +print_success "Azure tracing Gen AI content recording enabled" + +# Set Azure location +azd env set AZURE_LOCATION swedencentral + +print_success "Azure location set to swedencentral" + +# Set Azure AI agent model configuration +azd env set AZURE_AI_AGENT_MODEL_NAME gpt-4.1 +azd env set AZURE_AI_AGENT_MODEL_VERSION 2025-04-14 +azd env set AZURE_AI_AGENT_DEPLOYMENT_NAME gpt-4.1 + +print_success "Azure AI agent model configured: gpt-4.1 (version: 2025-04-14)" + +# Set Azure AI agent deployment capacity +azd env set AZURE_AI_AGENT_DEPLOYMENT_CAPACITY 100 +azd env set AZURE_AI_EMBED_DEPLOYMENT_CAPACITY 50 + +print_success "Azure AI agent deployment capacity set to 100" +print_success "Azure AI embed deployment capacity set to 50" + +# Set Azure AI Search configuration +azd env set USE_AZURE_AI_SEARCH_SERVICE true +azd env set AZURE_AI_SEARCH_INDEX_NAME "zava-products" +azd env set AZURE_AI_EMBED_DEPLOYMENT_NAME "text-embedding-3-large" +azd env set AZURE_AI_EMBED_MODEL_NAME "text-embedding-3-large" + +print_success "Azure AI Search configuration set" + +# --------------------- +# Install Python Dependencies +# --------------------- + +echo "→ Installing Python dependencies..." + +# Go back to the root directory +cd .. + +# Check if the .azd-setup requirements exist before installing +if [ -f ".azd-setup/requirements-dev.txt" ]; then + pip install -r .azd-setup/requirements-dev.txt + print_success "Installed .azd-setup/requirements-dev.txt dependencies" +else + print_warning ".azd-setup/requirements-dev.txt not found, skipping" +fi + +# Check if the .azd-setup src directory exists before installing in editable mode +if [ -d ".azd-setup/src" ]; then + pip install -e .azd-setup/src + print_success "Installed .azd-setup/src in editable mode" +else + print_warning ".azd-setup/src directory not found, skipping editable install" +fi + +# --------------------- +# Update Bicep File for Key-Based Authentication +# --------------------- + +echo "→ Updating cognitiveservices.bicep for key-based AOAI authentication..." + +BICEP_FILE=".azd-setup/infra/core/ai/cognitiveservices.bicep" + +if [ -f "$BICEP_FILE" ]; then + # 1. Change disableLocalAuth from true to false + sed -i 's/param disableLocalAuth bool = true/param disableLocalAuth bool = false/' "$BICEP_FILE" + print_success "Updated disableLocalAuth parameter to false" + + # 2. Change authType from 'AAD' to 'ApiKey' in aiServiceConnection + sed -i "/resource aiServiceConnection/,/^}$/ s/authType: 'AAD'/authType: 'ApiKey'/" "$BICEP_FILE" + print_success "Updated aiServiceConnection authType to 'ApiKey'" + + # 3. Add credentials section to aiServiceConnection + # First, find the line with metadata and add credentials before it + # Create temporary file with proper credentials block + sed "/resource aiServiceConnection/,/^}$/ { + /metadata: {/ i\\ + credentials: {\\ + key: account.listKeys().key1\\ + } + }" "$BICEP_FILE" > "${BICEP_FILE}.tmp" && mv "${BICEP_FILE}.tmp" "$BICEP_FILE" + print_success "Added credentials section to aiServiceConnection" + + print_success "cognitiveservices.bicep updated for key-based AOAI authentication" +else + print_warning "cognitiveservices.bicep file not found at $BICEP_FILE" +fi + +echo "" +print_success "Setup complete! You can now work with the AI agents template with key-based AOAI authentication." \ No newline at end of file diff --git a/scripts/3-teardown-azd b/scripts/3-teardown-azd new file mode 100755 index 0000000..904847f --- /dev/null +++ b/scripts/3-teardown-azd @@ -0,0 +1,166 @@ +#!/bin/bash + +# Teardown Azure Developer CLI (azd) Script +# Clean up script for AI agents lab + +set -e # Exit on any error + +# Colors for output +GREEN='\033[0;32m' +YELLOW='\033[1;33m' +RED='\033[0;31m' +BLUE='\033[0;34m' +NC='\033[0m' # No Color + +print_success() { + echo -e "${GREEN}✓${NC} $1" +} + +print_warning() { + echo -e "${YELLOW}⚠${NC} $1" +} + +print_error() { + echo -e "${RED}✗${NC} $1" +} + +print_info() { + echo -e "${BLUE}ℹ${NC} $1" +} + +# Function to ask for user confirmation +confirm() { + while true; do + read -p "$1 (y/n): " yn + case $yn in + [Yy]* ) return 0;; + [Nn]* ) return 1;; + * ) echo "Please answer yes (y) or no (n).";; + esac + done +} + +# --------------------- +# Check Prerequisites +# --------------------- + +echo "→ Starting teardown process..." + +# Check if azd is installed +if ! command -v azd >/dev/null 2>&1; then + print_error "Azure Developer CLI (azd) is not installed" + exit 1 +fi + +# Check if .azd-setup directory exists +if [ ! -d ".azd-setup" ]; then + print_warning ".azd-setup directory not found - nothing to clean up" + azd_directory_exists=false +else + azd_directory_exists=true +fi + +# --------------------- +# Check for Deployment and Run azd down --purge +# --------------------- + +if [ "$azd_directory_exists" = true ]; then + cd .azd-setup + + # Check if there was a deployment by looking for .azure directory AND environment folders with .env files + deployment_found=false + + if [ -d ".azure" ]; then + print_info "Found .azure directory, checking for environment configurations..." + + # Look for environment subfolders with .env files containing resource group definitions + for env_dir in .azure/*/; do + if [ -d "$env_dir" ]; then + env_name=$(basename "$env_dir") + env_file="$env_dir/.env" + + if [ -f "$env_file" ]; then + # Check if the .env file contains a resource group definition + if grep -q "AZURE_RESOURCE_GROUP" "$env_file" || grep -q "resourceGroup" "$env_file"; then + print_info "Found deployment environment: $env_name with resource group configuration" + deployment_found=true + break + fi + fi + fi + done + + if [ "$deployment_found" = true ]; then + echo "→ Deployment detected - cleaning up Azure resources..." + + print_info "Running 'azd down --purge' to remove all Azure resources..." + print_warning "This will permanently delete all deployed resources!" + + if azd down --purge; then + print_success "Azure resources cleaned up successfully" + else + print_error "Failed to clean up Azure resources" + print_warning "You may need to manually clean up resources in the Azure portal" + fi + else + print_info "No active deployment found (no environment with resource group configuration)" + print_success "No Azure resources to clean up" + fi + else + print_info "No deployment found (.azure directory not present)" + print_success "No Azure resources to clean up" + fi + + cd .. + + # --------------------- + # Confirm Directory Deletion + # --------------------- + + echo "→ Directory detected - starting cleanup" + print_warning "The .azd-setup directory contains local configuration and state files." + + if confirm "Do you want to delete the .azd-setup directory?"; then + rm -rf .azd-setup + print_success "Deleted .azd-setup directory" + echo "" + print_success "Teardown complete! All resources and local files have been removed." + else + print_info "Keeping .azd-setup directory with local configuration" + echo "" + print_success "Teardown complete! Azure resources removed, local files preserved." + fi +fi + +# --------------------- +# Logout from Azure CLI and Azure Developer CLI +# --------------------- + +echo "→ Logging out from Azure CLI and Azure Developer CLI..." + +# Logout from Azure CLI +if command -v az >/dev/null 2>&1; then + print_info "Logging out from Azure CLI..." + if az logout >/dev/null 2>&1; then + print_success "Successfully logged out from Azure CLI" + else + print_warning "Failed to logout from Azure CLI or already logged out" + fi +else + print_warning "Azure CLI not found - skipping logout" +fi + +# Logout from Azure Developer CLI +if command -v azd >/dev/null 2>&1; then + print_info "Logging out from Azure Developer CLI..." + if azd auth logout >/dev/null 2>&1; then + print_success "Successfully logged out from Azure Developer CLI" + else + print_warning "Failed to logout from Azure Developer CLI or already logged out" + fi +else + print_warning "Azure Developer CLI not found - skipping logout" +fi + +echo "" +print_success "Complete teardown finished! All resources removed and logged out from Azure services." \ No newline at end of file diff --git a/scripts/README.md b/scripts/README.md index 8c06428..60fd551 100644 --- a/scripts/README.md +++ b/scripts/README.md @@ -33,31 +33,63 @@ Run this command from the root of repo: ``` This script will: -1. Create the `.infra-setup` directory +1. Create the `.azd-setup` directory 2. Initialize the AI agents template from Azure Samples 3. Configure environment variables for the lab 4. **Install Python dependencies** from the template (requirements-dev.txt and editable src package) #### **Python Dependencies**: -The script automatically installs Python dependencies after the `.infra-setup` directory is created: -- `pip install -r .infra-setup/requirements-dev.txt` (if file exists) -- `pip install -e .infra-setup/src` (if directory exists) +The script automatically installs Python dependencies after the `.azd-setup` directory is created: +- `pip install -r .azd-setup/requirements-dev.txt` (if file exists) +- `pip install -e .azd-setup/src` (if directory exists) These dependencies are installed conditionally only after the template is set up, which is why they're commented out in the main `requirements.txt` file. #### **Recommendation**: -Once the `.azure/MSIGNITE25-LAB516/.env` is created, specify `AZURE_LOCATION="swedencentral"` proactively to have it pick up that location. This may not always show as an option if run using default `azd up` +Once the `.azure/AI-AGENTS-AZD/.env` is created, specify `AZURE_LOCATION="swedencentral"` proactively to have it pick up that location. This may not always show as an option if run using default `azd up` #### **Execution**: -Once the setup is complete, you can deploy: +Once the setup is complete, change to the template directory: + +```bash +cd .azd-setup +``` + +Then deploy the application and infrastructure in one command: ```bash -cd .infra-setup azd up ``` -### 1.3. Do Customizations +You may be prompted to log into azd as shown: + +```bash +WARNING: You must be logged into Azure perform this action +? Would you like to log in now? (Y/n) +``` + +Accept the default "Y" response. This will trigger the device-code based auth flow shown below. You exact code will vary. + +```bash +? Would you like to log in now? Yes + +Start by copying the next code: F8X72PR73 +Then press enter and continue to log in from your browser... +``` + +Complete the workflow using the Azure account you had logged into for the previous authentication step. Then select the active subscription to use for the deployment (from the provided list). If you had only 1 subscription, it will be selected as a default. + +Let the process complete. You should see continuous updates in the console. On completion, you will see a success message like this: + +```bash +SUCCESS: Your up workflow to provision and deploy to Azure completed in 12 minutes 31 seconds. +``` + + +### 1.3. Do More Customization + +> 🚨 TODO: This section needs to be tested!! 🚨 First, add any additional models required for the project with 2 steps: @@ -65,12 +97,31 @@ First, add any additional models required for the project with 2 steps: 1. Run `scripts/0-additional-models` to update azd template with these details 1. Run `azd provision` to update the infrastructure provisioning -_Note:_ Doing "azd up" will also deploy the app again. If you didn't change the app source code, then azd provision is the best command to minimize overheads. +_Note:_ + +1. Doing "azd up" will also deploy the app again. If you didn't change the app source code, then azd provision is the best command to minimize overheads. +1. Some "customizations" may need to be done in the first install (i.e., during setup-azd step) and will not be enforced in subsequent reprovisionins. Read the base template documentation to understand what those constraints are. ### 1.4. Teardown Template -Run this command from the root of repo: +Once you are done with testing or learning, it is a good idea to tear down the template to reduce costs. There are 2 options: + +**Option 1: Delete Infrastructure** + +Run this command from the `.azd-setup/` folder from which you did the `azd up` previously. This will delete the resource group and release model quota. + +``` +azd down --purge +``` + +**Option 2: Delete Infrastructure & Template** + +Use this option only if you want to delete the default template in this repository and rebuild a new one using scripts. This is useful for maintainers (pull latest versions of base template) or learners (to understand how scripts work). + +_It is not recommended if you are currently doing a workshop with this repo and need to use the provided custom template version. In that case, use Option 1_. + +To use this teardown-everything option, run this command: ```bash ./scripts/3-teardown-azd
\n${innerContent}\n[ENDTHINKFLAG]
`;
+ }
+ );
+};
+
+const CodeBlock = memo
+ {children}
+
+ );
+ }
+
+ const language = match[1];
+ const content = String(children)
+ .replace(/\n$/, "")
+ .replaceAll(" ", "");
+
+ return (
+
+
+ {content}
+
+
+ );
+ }
+);
+
+CodeBlock.displayName = "CodeBlock";
+
+function Paragraph({
+ children,
+ className,
+}: PropsWithChildren<{
+ className?: string;
+}>) {
+ return {children} ;
+}
+
+export function Markdown({
+ citations,
+ content,
+ className,
+ customDisallowedElements,
+}: IMarkdownProps): React.ReactElement {
+ const segments = useMemo(() => {
+ if (!citations || citations.length === 0) {
+ return [
+ {
+ type: "text" as const,
+ content: preprocessThinkTag(preprocessLaTeX(content)),
+ },
+ ];
+ }
+
+ const parts: {
+ type: "text" | "citation";
+ content: string | React.JSX.Element;
+ }[] = [];
+ let lastIndex = 0;
+
+ for (const citation of citations) {
+ const replaceText = String(citation.props["data-replace"] ?? "");
+ const index = content.indexOf(replaceText, lastIndex);
+
+ if (index !== -1) {
+ if (index > lastIndex) {
+ const textContent = content.slice(lastIndex, index);
+ parts.push({
+ type: "text",
+ content: preprocessThinkTag(preprocessLaTeX(textContent)),
+ });
+ }
+
+ parts.push({
+ type: "citation",
+ content: citation,
+ });
+
+ lastIndex = index + replaceText.length;
+ }
+ }
+
+ if (lastIndex < content.length) {
+ const textContent = content.slice(lastIndex);
+ parts.push({
+ type: "text",
+ content: preprocessThinkTag(preprocessLaTeX(textContent)),
+ });
+ }
+
+ return parts;
+ }, [content, citations]);
+
+ return (
+
+ {language}
+
+
+ }
+ onClick={() => {
+ copy(content);
+ }}
+ >
+ Copy
+
+
+
+ {segments.map((segment, idx) => (
+
+ {segment.type === "text" ? (
+ (tree: { children: IRehypeNode[] }) => {
+ const iterate = (node: IRehypeNode) => {
+ if (
+ node.type === "element" &&
+ node.properties !== undefined &&
+ "ref" in node.properties
+ ) {
+ delete node.properties.ref;
+ }
+
+ if (
+ node.type === "element" &&
+ !/^[a-z][a-z0-9]*$/i.test(node.tagName)
+ ) {
+ node.type = "text";
+ node.value = `<${node.tagName}`;
+ }
+
+ if (node.children) {
+ for (const child of node.children) {
+ iterate(child);
+ }
+ }
+ };
+
+ for (const child of tree.children) {
+ iterate(child);
+ }
+ },
+ ]}
+ remarkPlugins={[
+ RemarkGfm,
+ [RemarkMath, { singleDollarTextMath: false }],
+ RemarkBreaks,
+ supersub,
+ remarkParse,
+ ]}
+ >
+ {segment.content as string}
+
+ ) : (
+ segment.content
+ )}
+
+ ))}
+
+ );
+}
diff --git a/.azd-setup/src/frontend/src/components/core/MenuButton/MenuButton.module.css b/.azd-setup/src/frontend/src/components/core/MenuButton/MenuButton.module.css
new file mode 100644
index 0000000..308c98e
--- /dev/null
+++ b/.azd-setup/src/frontend/src/components/core/MenuButton/MenuButton.module.css
@@ -0,0 +1,3 @@
+.secondary:not(:disabled, :active, :hover) {
+ background-color: var(--colorNeutralBackground2);
+}
diff --git a/.azd-setup/src/frontend/src/components/core/MenuButton/MenuButton.tsx b/.azd-setup/src/frontend/src/components/core/MenuButton/MenuButton.tsx
new file mode 100644
index 0000000..4b02edc
--- /dev/null
+++ b/.azd-setup/src/frontend/src/components/core/MenuButton/MenuButton.tsx
@@ -0,0 +1,122 @@
+/* eslint-disable react/jsx-props-no-spreading -- This is a wrapper component */
+import type {
+ MenuButtonProps as FluentMenuButtonProps,
+ MenuItemProps,
+ MenuListProps,
+ MenuPopoverProps,
+ MenuProps,
+ MenuTriggerProps,
+} from "@fluentui/react-components";
+import type { Key, MouseEvent, MouseEventHandler, ReactNode } from "react";
+
+import {
+ MenuButton as FluentMenuButton,
+ Menu,
+ MenuItem,
+ MenuList,
+ MenuPopover,
+ MenuTrigger,
+} from "@fluentui/react-components";
+import clsx from "clsx";
+import { forwardRef, useCallback } from "react";
+
+import styles from "./MenuButton.module.css";
+
+export interface IMenuItemConfig extends MenuItemProps {
+ key: Key;
+}
+
+export interface IMenuButtonProps {
+ menuButtonText: string;
+ menuItems: IMenuItemConfig[];
+ menuProps?: MenuProps;
+ menuButtonProps?: FluentMenuButtonProps;
+ menuTriggerProps?: MenuTriggerProps;
+ menuListProps?: MenuListProps;
+ menuPopoverProps?: MenuPopoverProps;
+}
+
+export const MenuButton = forwardRef{children}
;
+ }
+
+ return (
+
+
+
+
+ );
+}
\ No newline at end of file
diff --git a/.azd-setup/src/frontend/src/components/core/theme/ThemeContext.ts b/.azd-setup/src/frontend/src/components/core/theme/ThemeContext.ts
new file mode 100644
index 0000000..04fce89
--- /dev/null
+++ b/.azd-setup/src/frontend/src/components/core/theme/ThemeContext.ts
@@ -0,0 +1,33 @@
+import { createContext, useContext } from "react";
+import { Theme as FluentTheme } from "@fluentui/react-components";
+import { lightTheme } from "./themes";
+
+export type Theme = "Light" | "Dark" | "System";
+
+export interface IThemeContextValue {
+ theme: Theme;
+ savedTheme: Theme;
+ currentTheme: "Light" | "Dark";
+ themeStyles: FluentTheme;
+ setTheme: (theme: Theme) => void;
+ isDarkMode: boolean;
+}
+
+export const ThemeContext = createContext
+
+ {!isComplete &&
+ {displayContent}
+
+
-> [!IMPORTANT]
-> **THIS REPOSITORY IS CURRENTLY UNDER DEVELOPMENT FOR AN UPCOMING WORKSHOP. Please do not file any issues at this time since the repository will be actively updated for the next few weeks
->
-
-
-> This is a customized version of the [Get Started With AI Agents](https://github.com/nitya/get-started-with-ai-agents) template recommended by Azure AI Foundry. The [original README](./README.azd.md) provides the documentation for the template itself. However _this_ repository contains a [WORKSHOP](./workshop/README.md) resource that will help guide you through setup and experimentation with the template, with a specific view on supporting the [Models For Beginners](https://aka.ms/models-for-beginners), [Model Mondays](https://aka.ms/model-mondays) and related 1P workshops focused on model selection, customization and optimization.
-
-## What It Provides
-
-This repository streamlines the _infrastructure setup_ for relevant open-source curricula
-
-This repository provides an actionable templat for delivering open-source curriculum or providing repo-hosted workshops in conjunction with Azure Samples projects, by taking advantage of the built-in GitHub Pages hosting in the source repository.
-
-1. The projects will use [Mkdocs Material](https://github.com/squidfunk/mkdocs-material) for the documentation setup
-3. The projects will use [AI Quickstart Templates](https://ai.azure.com/templates) for infrastructure setup
+> [!IMPORTANT]
+>
+> 🚨 **This repository is under active development and is not meant for public use - yet. This notice will be removed once we hit a stable version (ETA: Oct 17, 2025). Please wait to file issues until that time.**
-## How To Use It
+## For Beginners: Template
-This template is ideally suited to "For Beginners" projects that have labs that require Azure AI Foundry usage. This template provides learners with the guidance for setting up, configuring, and customizing various aspects of the default Azure AI Foundry quickstart template for AI Agents.
+This project contains setup scripts and a customized version of the [get-started-with-ai-agents](https://github.com/Azure-Samples/get-started-with-ai-agents/tree/main) starter template for Azure AI Foundry.
-This decouples infrastructure setup from curriculum usage, allowing projects like "Models For Beginners" to focus on lessons and labs that simply expect environment variables set to a pre-deployed infra. This has two benefits:
+Our objectives are:
-1. Learners can manually provision infra using Azure AI Foundry portal, CLI or SDK, working through this per lesson, or per curricula.
-1. Learners can use this template to provision infra with azd (using our built-in guidance and extensions) for multiple lessons (or curricula) at one shot.
+1. Create scripts to customize the base template for our 1P workshops (with Skillable)
+1. Maintain a customized template for reuse in our {AZD/Models}-For-Beginners curricula
+1. Maintain event-specific branches that freeze stable versions for a given workshop.
-**The First Testbed for this will be the upcoming Models For Beginners curriculum with emphasis on using the new Foundry Architecture**.
+Note that this means the version of the template here may be different from the base starter template in terms of the default configuration used.
+_We encourage the community to fork and extend this repository for their own Azure AI Foundry workshops or learning journeys - and file issues with bugs or feedback._
-## Personas
+## AZD For Beginners: Workshop
-Each project will adhere to a consistent format for documentation to enhacne the learning experience for AI engineers and beginners alike. We expect three kinds of personas to use these projects, and want to make sure experience is optimized for all
+Not familiar with [AZD templates](https://learn.microsoft.com/azure/developer/azure-developer-cli/azd-templates?tabs=csharp)? Explore the new [AZD For Beginners](https://github.com/microsoft/azd-for-beginners) curriculum for a step-by-step introduction to the [Azure Developer CLI](https://aka.ms/azd) and fundamentals of AZD templates.
-1. **Beginner** - new to the topic - interested in concepts to code.
-2. **Developer** - comfortable with code - interested in tools & techniques.
-3. **AI Engineer** - building intelligent apps - interested in E2E solutions.
+This _For Beginners Template_ project also powers the [AZD For AI Developers](https://github.com/microsoft/AZD-for-beginners/tree/main/workshop) workshop that is part of that curriculum. This of this template as a _learning sandbox_ where you can deconstruct a completely functioning template to figure out how it works. Then reconstruct it with your data, and customize it to your specific scenario or requirements!
-## Calls To Action
+## Related Resources
-To complement the journey, we ask each template user to add these three calls to action to their README.md
+1. [Azure Developer CLI](https://learn.microsoft.com/azure/developer/azure-developer-cli/) - documentation & reference
+1. [Awesome AZD](https://aka.ms/awesome-azd) - template gallery for Azure
+1. [AI App Templates](https://ai.azure.com/templates) - curated for Azure AI Foundry
+1. [AZD For Beginners](https://github.com/microsoft/azd-for-beginners) - open-source curriculum
-1. [**Bookmark the Learn Collection** 📚](https://learn.microsoft.com/en-us/collections/7d2wswpx0d02qj) - and use it to discover other resources
-1. [**Join the AI Discord**](https://discord.gg/zxKYvhSnVp) 💬 - connect with experts & builders online around AI!
-1. [**Join the Global AI Community**](https://globalai.community/) - connect with experts & builders in your region!
## Contributing
diff --git a/SUPPORT.md b/SUPPORT.md
index 2c42db0..2a5fcde 100644
--- a/SUPPORT.md
+++ b/SUPPORT.md
@@ -3,11 +3,13 @@
## How to file issues and get help
This project uses GitHub Issues to track bugs and feature requests. Please search the existing
-issues before filing new issues to avoid duplicates. For new issues, file your bug or
+issues before filing new issues to avoid duplicates. For new issues, file your bug or
feature request as a new Issue.
-For help and questions about using this project, please submit an issue on this repository.
+For help and questions about using this project, please:
+- Check the [Azure AI Foundry Discord](https://discord.com/invite/QR3kaErCRx) where experts and fellow developers gather
+- Use the [Azure AI Foundry Forum](https://github.com/orgs/azure-ai-foundry/discussions) to get help and view related discussions
## Microsoft Support Policy
-Support for this repository is limited to the resources listed above.
\ No newline at end of file
+Support for the ForBeginners project is limited to the resources listed above.
\ No newline at end of file
diff --git a/docs/workshop/01-Introduction/index.md b/docs/guide/01-Introduction/index.md
similarity index 100%
rename from docs/workshop/01-Introduction/index.md
rename to docs/guide/01-Introduction/index.md
diff --git a/docs/workshop/02-Exploration/index.md b/docs/guide/02-Exploration/index.md
similarity index 100%
rename from docs/workshop/02-Exploration/index.md
rename to docs/guide/02-Exploration/index.md
diff --git a/docs/workshop/03-Development/index.md b/docs/guide/03-Development/index.md
similarity index 100%
rename from docs/workshop/03-Development/index.md
rename to docs/guide/03-Development/index.md
diff --git a/docs/workshop/04-Customization/index.md b/docs/guide/04-Customization/index.md
similarity index 100%
rename from docs/workshop/04-Customization/index.md
rename to docs/guide/04-Customization/index.md
diff --git a/docs/guide/index.md b/docs/guide/index.md
new file mode 100644
index 0000000..3655d61
--- /dev/null
+++ b/docs/guide/index.md
@@ -0,0 +1,11 @@
+# Workshop
+
+## What We'll Build
+
+
+## What We'll Need
+
+## What We'll Build
+
+
+## What We'll Learn
\ No newline at end of file
diff --git a/docs/index.md b/docs/index.md
new file mode 100644
index 0000000..9725693
--- /dev/null
+++ b/docs/index.md
@@ -0,0 +1,24 @@
+---
+title: Introduction
+description: This workshop teaches you how to discover, deploy, customize, and use, AI App templates from Azure AI Foundry using the Azure Developer CLI.
+author: Nitya Narasimhan
+date: 2024-10-13
+template: main.html
+---
+
+# Introduction
+
+
+!!! info "AZD For AI Developers: A Hands-on Workshop"
+
+Want to build AI Agentic applications on Azure AI Foundry but don't know where to start? What if you could start with a fully-functioning solution architecture - then deconstruct it to understand key features and workflows - and reconstruct it with your custom data and requirements.
+
+This is the **deconstruct and learn** approach we'll follow in this workshop. We'll use the [Getting Started With AI Agents](https://github.com/Azure-Samples/get-started-with-ai-agents) template with the [Azure Developer CLI](https://aka.ms/azd) commandline tool - to accelerate our journey from idea to infrastructure & implementation _in a reproducible and efficient way_.
+
+**Duration:** 3-4 hours + For Beginners: An AZD Project +
++ A customized "Getting Started with AI Agents" template for learners +
++**Level:** Beginner to Intermediate + +Let's Go! 🚀 + + + diff --git a/docs/workshop/index.md b/docs/workshop/index.md deleted file mode 100644 index e58e637..0000000 --- a/docs/workshop/index.md +++ /dev/null @@ -1 +0,0 @@ -# Workshop diff --git a/scripts/.env.sample b/scripts/.env.sample new file mode 100644 index 0000000..4218821 --- /dev/null +++ b/scripts/.env.sample @@ -0,0 +1,19 @@ +# .... Azure +AZURE_SUBSCRIPTION_ID= +AZURE_RESOURCE_GROUP= + +# .... Azure AI Foundry +AZURE_OPENAI_API_KEY= +AZURE_OPENAI_ENDPOINT= +AZURE_OPENAI_API_VERSION= # "2025-02-01-preview" +AZURE_AI_FOUNDRY_NAME= # name of ai services resource in resource group +AZURE_AI_PROJECT_NAME= # name of project resource in resource group + +# .... Azure AI Foundry Deployment +AZURE_OPENAI_DEPLOYMENT= # "gpt-4.1" +AZURE_OPENAI_MODEL_VERSION= # "2025-04-14" + +# .... Azure AI Search +AZURE_AISEARCH_ENDPOINT= # from the Azure AI Search resource overview page +AZURE_AISEARCH_API_KEY= # from the Azure AI Search resource "Keys and Endpoint" page +AZURE_AISEARCH_INDEX= # index you are creating e.g., "zava-products" \ No newline at end of file diff --git a/scripts/0-additional-models b/scripts/0-additional-models new file mode 100755 index 0000000..665b847 --- /dev/null +++ b/scripts/0-additional-models @@ -0,0 +1,158 @@ +#!/bin/bash + +# 0-additional-models +# Script to add additional model deployments to the azd infrastructure template +# Usage: ./scripts/0-additional-models + +set -e + +# Colors for output +RED='\033[0;31m' +GREEN='\033[0;32m' +YELLOW='\033[1;33m' +BLUE='\033[0;34m' +NC='\033[0m' # No Color + +# Configuration +SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)" +REPO_ROOT="$DIR/.." +INFRA_DIR="$REPO_ROOT/.azd-setup/infra" +CONFIG_FILE="$SCRIPT_DIR/0-additional-models.json" +MAIN_BICEP="$INFRA_DIR/main.bicep" +PARAMS_FILE="$INFRA_DIR/main.parameters.json" + +echo -e "${BLUE}=== Adding Additional Model Deployments ===${NC}" + +# Check if configuration file exists +if [[ ! -f "$CONFIG_FILE" ]]; then + echo -e "${RED}Error: Configuration file not found: $CONFIG_FILE${NC}" + echo "Please create the configuration file with your model deployment details." + exit 1 +fi + +# Check if infrastructure directory exists +if [[ ! -d "$INFRA_DIR" ]]; then + echo -e "${RED}Error: Infrastructure directory not found: $INFRA_DIR${NC}" + echo "Please run './scripts/2-setup-azd' first to set up the infrastructure template." + exit 1 +fi + +# Validate JSON configuration +echo -e "${YELLOW}Validating configuration file...${NC}" +if ! jq empty "$CONFIG_FILE" 2>/dev/null; then + echo -e "${RED}Error: Invalid JSON in configuration file: $CONFIG_FILE${NC}" + exit 1 +fi + +echo -e "${GREEN}✓ Configuration file is valid${NC}" + +# Read additional models from config file +ADDITIONAL_MODELS=$(cat "$CONFIG_FILE") +echo -e "${BLUE}Models to add:${NC}" +echo "$ADDITIONAL_MODELS" | jq -r '.[] | " - \(.name) (\(.model.name) \(.model.version))"' + +# Backup original files +echo -e "${YELLOW}Creating backups...${NC}" +cp "$MAIN_BICEP" "$MAIN_BICEP.backup.$(date +%Y%m%d-%H%M%S)" +cp "$PARAMS_FILE" "$PARAMS_FILE.backup.$(date +%Y%m%d-%H%M%S)" +echo -e "${GREEN}✓ Backups created${NC}" + +# Step 1: Add parameter to main.bicep if not already present +echo -e "${YELLOW}Step 1: Adding parameter to main.bicep...${NC}" +if grep -q "additionalModelDeployments" "$MAIN_BICEP"; then + echo -e "${GREEN}✓ Parameter already exists in main.bicep${NC}" +else + # Find the line after embedDeploymentCapacity parameter and add our parameter + TEMP_FILE=$(mktemp) + awk ' + /param embedDeploymentCapacity int = 30/ { + print $0 + print "" + print "@description(\"Additional model deployments to create\")" + print "param additionalModelDeployments array = []" + next + } + {print} + ' "$MAIN_BICEP" > "$TEMP_FILE" + mv "$TEMP_FILE" "$MAIN_BICEP" + echo -e "${GREEN}✓ Added additionalModelDeployments parameter${NC}" +fi + +# Step 2: Update aiDeployments variable in main.bicep +echo -e "${YELLOW}Step 2: Updating aiDeployments variable...${NC}" +if grep -q "additionalModelDeployments" "$MAIN_BICEP" && grep -A5 -B5 "var aiDeployments" "$MAIN_BICEP" | grep -q "additionalModelDeployments"; then + echo -e "${GREEN}✓ aiDeployments variable already includes additionalModelDeployments${NC}" +else + # Find and replace the aiDeployments variable + TEMP_FILE=$(mktemp) + awk ' + /^var aiDeployments = concat\(/ { + print "var aiDeployments = concat(" + print " aiChatModel," + print " useSearchService ? aiEmbeddingModel : []," + print " additionalModelDeployments" + print ")" + # Skip the original concat block + while (getline && $0 !~ /^\)/) continue + next + } + {print} + ' "$MAIN_BICEP" > "$TEMP_FILE" + mv "$TEMP_FILE" "$MAIN_BICEP" + echo -e "${GREEN}✓ Updated aiDeployments variable${NC}" +fi + +# Step 3: Add parameter to main.parameters.json +echo -e "${YELLOW}Step 3: Adding parameter to main.parameters.json...${NC}" +if grep -q "additionalModelDeployments" "$PARAMS_FILE"; then + echo -e "${GREEN}✓ Parameter already exists in main.parameters.json${NC}" +else + # Add the parameter before the closing brace + TEMP_FILE=$(mktemp) + jq '. + { + "parameters": (.parameters + { + "additionalModelDeployments": { + "value": "${ADDITIONAL_MODEL_DEPLOYMENTS=[]}" + } + }) + }' "$PARAMS_FILE" > "$TEMP_FILE" + mv "$TEMP_FILE" "$PARAMS_FILE" + echo -e "${GREEN}✓ Added parameter to main.parameters.json${NC}" +fi + +# Step 4: Set environment variable for azd +echo -e "${YELLOW}Step 4: Setting up environment variable...${NC}" +ENV_FILE="$REPO_ROOT/.azd-setup/.azure/AI-AGENTS-AZD/.env" + +if [[ -f "$ENV_FILE" ]]; then + # Convert JSON to string format for environment variable + MODELS_ENV_VALUE=$(echo "$ADDITIONAL_MODELS" | jq -c .) + + # Check if the environment variable already exists + if grep -q "^ADDITIONAL_MODEL_DEPLOYMENTS=" "$ENV_FILE"; then + # Update existing value + sed -i "s|^ADDITIONAL_MODEL_DEPLOYMENTS=.*|ADDITIONAL_MODEL_DEPLOYMENTS='$MODELS_ENV_VALUE'|" "$ENV_FILE" + echo -e "${GREEN}✓ Updated ADDITIONAL_MODEL_DEPLOYMENTS in .env file${NC}" + else + # Add new environment variable + echo "" >> "$ENV_FILE" + echo "# Additional model deployments" >> "$ENV_FILE" + echo "ADDITIONAL_MODEL_DEPLOYMENTS='$MODELS_ENV_VALUE'" >> "$ENV_FILE" + echo -e "${GREEN}✓ Added ADDITIONAL_MODEL_DEPLOYMENTS to .env file${NC}" + fi +else + echo -e "${YELLOW}⚠ Environment file not found: $ENV_FILE${NC}" + echo -e "${YELLOW} The environment variable will need to be set manually or after running 'azd up'${NC}" +fi + +echo -e "${GREEN}=== Additional Model Deployments Setup Complete ===${NC}" +echo "" +echo -e "${BLUE}Next Steps:${NC}" +echo "1. Review the changes made to the infrastructure files" +echo "2. Navigate to the .azd-setup directory: cd .azd-setup" +echo "3. Run 'azd provision' to deploy the additional models" +echo "" +echo -e "${BLUE}Models that will be deployed:${NC}" +echo "$ADDITIONAL_MODELS" | jq -r '.[] | " • \(.name) - \(.model.name) \(.model.version) (Capacity: \(.sku.capacity))"' +echo "" +echo -e "${YELLOW}Note: Make sure your Azure subscription has sufficient quota for these models in the selected region.${NC}" \ No newline at end of file diff --git a/scripts/0-additional-models.json b/scripts/0-additional-models.json new file mode 100644 index 0000000..2866e0b --- /dev/null +++ b/scripts/0-additional-models.json @@ -0,0 +1,110 @@ +[ + { + "name": "model-router", + "model": { + "format": "OpenAI", + "name": "model-router", + "version": "2025-05-19" + }, + "sku": { + "name": "GlobalStandard", + "capacity": 50 + } + }, + { + "name": "gpt-4.1", + "model": { + "format": "OpenAI", + "name": "gpt-4.1", + "version": "2025-04-14" + }, + "sku": { + "name": "GlobalStandard", + "capacity": 50 + } + }, + { + "name": "gpt-4o", + "model": { + "format": "OpenAI", + "name": "gpt-4o", + "version": "2024-11-20" + }, + "sku": { + "name": "GlobalStandard", + "capacity": 50 + } + }, + { + "name": "gpt-4o-mini", + "model": { + "format": "OpenAI", + "name": "gpt-4o-mini", + "version": "2024-07-18" + }, + "sku": { + "name": "GlobalStandard", + "capacity": 50 + } + }, + { + "name": "gpt-4.1-mini", + "model": { + "format": "OpenAI", + "name": "gpt-4.1-mini", + "version": "2025-04-14" + }, + "sku": { + "name": "GlobalStandard", + "capacity": 50 + } + }, + { + "name": "gpt-4.1-nano", + "model": { + "format": "OpenAI", + "name": "gpt-4.1-nano", + "version": "2025-04-14" + }, + "sku": { + "name": "GlobalStandard", + "capacity": 50 + } + }, + { + "name": "o3-mini", + "model": { + "format": "OpenAI", + "name": "o3-mini", + "version": "2025-01-31" + }, + "sku": { + "name": "GlobalStandard", + "capacity": 50 + } + }, + { + "name": "o4-mini", + "model": { + "format": "OpenAI", + "name": "o4-mini", + "version": "2025-04-16" + }, + "sku": { + "name": "GlobalStandard", + "capacity": 50 + } + }, + { + "name": "text-embedding-3-large", + "model": { + "format": "OpenAI", + "name": "text-embedding-3-large", + "version": "1" + }, + "sku": { + "name": "Standard", + "capacity": 50 + } + } +] \ No newline at end of file diff --git a/scripts/1-setup-auth b/scripts/1-setup-auth new file mode 100755 index 0000000..12b25e1 --- /dev/null +++ b/scripts/1-setup-auth @@ -0,0 +1,119 @@ +#!/bin/bash + +# Setup Authentication Script +# Authentication setup script for AI agents lab + +set -e # Exit on any error + +# Colors for output +GREEN='\033[0;32m' +YELLOW='\033[1;33m' +RED='\033[0;31m' +NC='\033[0m' # No Color + +print_success() { + echo -e "${GREEN}✓${NC} $1" +} + +print_warning() { + echo -e "${YELLOW}⚠${NC} $1" +} + +print_error() { + echo -e "${RED}✗${NC} $1" +} + +# --------------------- +# Check Prerequisites +# --------------------- + +echo "→ Checking prerequisites..." + +# Check if azd is installed +if ! command -v azd >/dev/null 2>&1; then + print_error "Azure Developer CLI (azd) is not installed" + echo "Please install azd first: https://learn.microsoft.com/azure/developer/azure-developer-cli/install-azd" + exit 1 +else + azd_version=$(azd version | head -n 1) + print_success "Azure Developer CLI found: $azd_version" +fi + +# Check if az is installed +if ! command -v az >/dev/null 2>&1; then + print_error "Azure CLI (az) is not installed" + echo "Please install Azure CLI first: https://docs.microsoft.com/cli/azure/install-azure-cli" + exit 1 +else + az_version=$(az version --query '"azure-cli"' -o tsv) + print_success "Azure CLI found: $az_version" +fi + +# --------------------- +# Azure CLI Authentication +# --------------------- + +echo "→ Setting up Azure CLI authentication..." + +# Check if already logged in to Azure CLI +if az account show >/dev/null 2>&1; then + print_warning "Already logged in to Azure CLI" + current_account=$(az account show --query 'name' -o tsv) + print_success "Current Azure CLI account: $current_account" +else + echo "Logging in to Azure CLI..." + az login + current_account=$(az account show --query 'name' -o tsv) + print_success "Successfully logged in to Azure CLI: $current_account" +fi + +# --------------------- +# Azure Developer CLI Authentication +# --------------------- + +echo "→ Setting up Azure Developer CLI authentication..." + +# Check if already logged in to Azure Developer CLI +if azd auth login --check-status >/dev/null 2>&1; then + print_warning "Already logged in to Azure Developer CLI" + print_success "Azure Developer CLI authentication verified" +else + echo "Logging in to Azure Developer CLI..." + azd auth login + print_success "Successfully logged in to Azure Developer CLI" +fi + +# --------------------- +# Display Login Status +# --------------------- + +echo "" +echo "→ Current authentication status:" + +# Azure CLI status +echo "" +echo "Azure CLI:" +if az account show >/dev/null 2>&1; then + account_name=$(az account show --query 'name' -o tsv) + subscription_id=$(az account show --query 'id' -o tsv) + tenant_id=$(az account show --query 'tenantId' -o tsv) + user_name=$(az account show --query 'user.name' -o tsv) + + print_success "Logged in as: $user_name" + print_success "Subscription: $account_name ($subscription_id)" + print_success "Tenant ID: $tenant_id" +else + print_error "Not logged in to Azure CLI" +fi + +# Azure Developer CLI status +echo "" +echo "Azure Developer CLI:" +if azd auth login --check-status >/dev/null 2>&1; then + print_success "Authentication verified" +else + print_error "Not logged in to Azure Developer CLI" +fi + +echo "" +print_success "Authentication setup complete!" \ No newline at end of file diff --git a/scripts/2-setup-azd b/scripts/2-setup-azd new file mode 100755 index 0000000..c97c572 --- /dev/null +++ b/scripts/2-setup-azd @@ -0,0 +1,174 @@ +#!/bin/bash + +# Setup Azure Developer CLI (azd) Script +# Simple setup script for AI agents lab + +set -e # Exit on any error + +# Colors for output +GREEN='\033[0;32m' +YELLOW='\033[1;33m' +RED='\033[0;31m' +NC='\033[0m' # No Color + +print_success() { + echo -e "${GREEN}✓${NC} $1" +} + +print_warning() { + echo -e "${YELLOW}⚠${NC} $1" +} + +print_error() { + echo -e "${RED}✗${NC} $1" +} + +# --------------------- +# Check Prerequisites +# --------------------- + +echo "→ Checking prerequisites..." + +# Check if azd is installed +if ! command -v azd >/dev/null 2>&1; then + print_error "Azure Developer CLI (azd) is not installed" + echo "Please install azd first: https://learn.microsoft.com/azure/developer/azure-developer-cli/install-azd" + exit 1 +else + azd_version=$(azd version | head -n 1) + print_success "Azure Developer CLI found: $azd_version" +fi + +# Check if az is installed +if ! command -v az >/dev/null 2>&1; then + print_error "Azure CLI (az) is not installed" + echo "Please install Azure CLI first: https://docs.microsoft.com/cli/azure/install-azure-cli" + exit 1 +else + az_version=$(az version --query '"azure-cli"' -o tsv) + print_success "Azure CLI found: $az_version" +fi + +# --------------------- +# Setup .azd-setup Directory +# --------------------- + +echo "→ Setting up .azd-setup directory..." + +if [ ! -d ".azd-setup" ]; then + mkdir -p .azd-setup + print_success "Created .azd-setup directory" +else + print_success ".azd-setup directory already exists" +fi + +# --------------------- +# Initialize AI Agents Template +# --------------------- + +echo "→ Initializing AI agents template..." + +cd .azd-setup + +# Initialize with the AI agents template using AI-AGENTS-AZD as environment name +azd init -t get-started-with-ai-agents -e AI-AGENTS-AZD + +print_success "AI agents template initialized successfully with environment: AI-AGENTS-AZD" + +# Enable Azure Monitor tracing +azd env set ENABLE_AZURE_MONITOR_TRACING true + +print_success "Azure Monitor tracing enabled" + +# Enable Azure tracing Gen AI content recording +azd env set AZURE_TRACING_GEN_AI_CONTENT_RECORDING_ENABLED true + +print_success "Azure tracing Gen AI content recording enabled" + +# Set Azure location +azd env set AZURE_LOCATION swedencentral + +print_success "Azure location set to swedencentral" + +# Set Azure AI agent model configuration +azd env set AZURE_AI_AGENT_MODEL_NAME gpt-4.1 +azd env set AZURE_AI_AGENT_MODEL_VERSION 2025-04-14 +azd env set AZURE_AI_AGENT_DEPLOYMENT_NAME gpt-4.1 + +print_success "Azure AI agent model configured: gpt-4.1 (version: 2025-04-14)" + +# Set Azure AI agent deployment capacity +azd env set AZURE_AI_AGENT_DEPLOYMENT_CAPACITY 100 +azd env set AZURE_AI_EMBED_DEPLOYMENT_CAPACITY 50 + +print_success "Azure AI agent deployment capacity set to 100" +print_success "Azure AI embed deployment capacity set to 50" + +# Set Azure AI Search configuration +azd env set USE_AZURE_AI_SEARCH_SERVICE true +azd env set AZURE_AI_SEARCH_INDEX_NAME "zava-products" +azd env set AZURE_AI_EMBED_DEPLOYMENT_NAME "text-embedding-3-large" +azd env set AZURE_AI_EMBED_MODEL_NAME "text-embedding-3-large" + +print_success "Azure AI Search configuration set" + +# --------------------- +# Install Python Dependencies +# --------------------- + +echo "→ Installing Python dependencies..." + +# Go back to the root directory +cd .. + +# Check if the .azd-setup requirements exist before installing +if [ -f ".azd-setup/requirements-dev.txt" ]; then + pip install -r .azd-setup/requirements-dev.txt + print_success "Installed .azd-setup/requirements-dev.txt dependencies" +else + print_warning ".azd-setup/requirements-dev.txt not found, skipping" +fi + +# Check if the .azd-setup src directory exists before installing in editable mode +if [ -d ".azd-setup/src" ]; then + pip install -e .azd-setup/src + print_success "Installed .azd-setup/src in editable mode" +else + print_warning ".azd-setup/src directory not found, skipping editable install" +fi + +# --------------------- +# Update Bicep File for Key-Based Authentication +# --------------------- + +echo "→ Updating cognitiveservices.bicep for key-based AOAI authentication..." + +BICEP_FILE=".azd-setup/infra/core/ai/cognitiveservices.bicep" + +if [ -f "$BICEP_FILE" ]; then + # 1. Change disableLocalAuth from true to false + sed -i 's/param disableLocalAuth bool = true/param disableLocalAuth bool = false/' "$BICEP_FILE" + print_success "Updated disableLocalAuth parameter to false" + + # 2. Change authType from 'AAD' to 'ApiKey' in aiServiceConnection + sed -i "/resource aiServiceConnection/,/^}$/ s/authType: 'AAD'/authType: 'ApiKey'/" "$BICEP_FILE" + print_success "Updated aiServiceConnection authType to 'ApiKey'" + + # 3. Add credentials section to aiServiceConnection + # First, find the line with metadata and add credentials before it + # Create temporary file with proper credentials block + sed "/resource aiServiceConnection/,/^}$/ { + /metadata: {/ i\\ + credentials: {\\ + key: account.listKeys().key1\\ + } + }" "$BICEP_FILE" > "${BICEP_FILE}.tmp" && mv "${BICEP_FILE}.tmp" "$BICEP_FILE" + print_success "Added credentials section to aiServiceConnection" + + print_success "cognitiveservices.bicep updated for key-based AOAI authentication" +else + print_warning "cognitiveservices.bicep file not found at $BICEP_FILE" +fi + +echo "" +print_success "Setup complete! You can now work with the AI agents template with key-based AOAI authentication." \ No newline at end of file diff --git a/scripts/3-teardown-azd b/scripts/3-teardown-azd new file mode 100755 index 0000000..904847f --- /dev/null +++ b/scripts/3-teardown-azd @@ -0,0 +1,166 @@ +#!/bin/bash + +# Teardown Azure Developer CLI (azd) Script +# Clean up script for AI agents lab + +set -e # Exit on any error + +# Colors for output +GREEN='\033[0;32m' +YELLOW='\033[1;33m' +RED='\033[0;31m' +BLUE='\033[0;34m' +NC='\033[0m' # No Color + +print_success() { + echo -e "${GREEN}✓${NC} $1" +} + +print_warning() { + echo -e "${YELLOW}⚠${NC} $1" +} + +print_error() { + echo -e "${RED}✗${NC} $1" +} + +print_info() { + echo -e "${BLUE}ℹ${NC} $1" +} + +# Function to ask for user confirmation +confirm() { + while true; do + read -p "$1 (y/n): " yn + case $yn in + [Yy]* ) return 0;; + [Nn]* ) return 1;; + * ) echo "Please answer yes (y) or no (n).";; + esac + done +} + +# --------------------- +# Check Prerequisites +# --------------------- + +echo "→ Starting teardown process..." + +# Check if azd is installed +if ! command -v azd >/dev/null 2>&1; then + print_error "Azure Developer CLI (azd) is not installed" + exit 1 +fi + +# Check if .azd-setup directory exists +if [ ! -d ".azd-setup" ]; then + print_warning ".azd-setup directory not found - nothing to clean up" + azd_directory_exists=false +else + azd_directory_exists=true +fi + +# --------------------- +# Check for Deployment and Run azd down --purge +# --------------------- + +if [ "$azd_directory_exists" = true ]; then + cd .azd-setup + + # Check if there was a deployment by looking for .azure directory AND environment folders with .env files + deployment_found=false + + if [ -d ".azure" ]; then + print_info "Found .azure directory, checking for environment configurations..." + + # Look for environment subfolders with .env files containing resource group definitions + for env_dir in .azure/*/; do + if [ -d "$env_dir" ]; then + env_name=$(basename "$env_dir") + env_file="$env_dir/.env" + + if [ -f "$env_file" ]; then + # Check if the .env file contains a resource group definition + if grep -q "AZURE_RESOURCE_GROUP" "$env_file" || grep -q "resourceGroup" "$env_file"; then + print_info "Found deployment environment: $env_name with resource group configuration" + deployment_found=true + break + fi + fi + fi + done + + if [ "$deployment_found" = true ]; then + echo "→ Deployment detected - cleaning up Azure resources..." + + print_info "Running 'azd down --purge' to remove all Azure resources..." + print_warning "This will permanently delete all deployed resources!" + + if azd down --purge; then + print_success "Azure resources cleaned up successfully" + else + print_error "Failed to clean up Azure resources" + print_warning "You may need to manually clean up resources in the Azure portal" + fi + else + print_info "No active deployment found (no environment with resource group configuration)" + print_success "No Azure resources to clean up" + fi + else + print_info "No deployment found (.azure directory not present)" + print_success "No Azure resources to clean up" + fi + + cd .. + + # --------------------- + # Confirm Directory Deletion + # --------------------- + + echo "→ Directory detected - starting cleanup" + print_warning "The .azd-setup directory contains local configuration and state files." + + if confirm "Do you want to delete the .azd-setup directory?"; then + rm -rf .azd-setup + print_success "Deleted .azd-setup directory" + echo "" + print_success "Teardown complete! All resources and local files have been removed." + else + print_info "Keeping .azd-setup directory with local configuration" + echo "" + print_success "Teardown complete! Azure resources removed, local files preserved." + fi +fi + +# --------------------- +# Logout from Azure CLI and Azure Developer CLI +# --------------------- + +echo "→ Logging out from Azure CLI and Azure Developer CLI..." + +# Logout from Azure CLI +if command -v az >/dev/null 2>&1; then + print_info "Logging out from Azure CLI..." + if az logout >/dev/null 2>&1; then + print_success "Successfully logged out from Azure CLI" + else + print_warning "Failed to logout from Azure CLI or already logged out" + fi +else + print_warning "Azure CLI not found - skipping logout" +fi + +# Logout from Azure Developer CLI +if command -v azd >/dev/null 2>&1; then + print_info "Logging out from Azure Developer CLI..." + if azd auth logout >/dev/null 2>&1; then + print_success "Successfully logged out from Azure Developer CLI" + else + print_warning "Failed to logout from Azure Developer CLI or already logged out" + fi +else + print_warning "Azure Developer CLI not found - skipping logout" +fi + +echo "" +print_success "Complete teardown finished! All resources removed and logged out from Azure services." \ No newline at end of file diff --git a/scripts/README.md b/scripts/README.md index 8c06428..60fd551 100644 --- a/scripts/README.md +++ b/scripts/README.md @@ -33,31 +33,63 @@ Run this command from the root of repo: ``` This script will: -1. Create the `.infra-setup` directory +1. Create the `.azd-setup` directory 2. Initialize the AI agents template from Azure Samples 3. Configure environment variables for the lab 4. **Install Python dependencies** from the template (requirements-dev.txt and editable src package) #### **Python Dependencies**: -The script automatically installs Python dependencies after the `.infra-setup` directory is created: -- `pip install -r .infra-setup/requirements-dev.txt` (if file exists) -- `pip install -e .infra-setup/src` (if directory exists) +The script automatically installs Python dependencies after the `.azd-setup` directory is created: +- `pip install -r .azd-setup/requirements-dev.txt` (if file exists) +- `pip install -e .azd-setup/src` (if directory exists) These dependencies are installed conditionally only after the template is set up, which is why they're commented out in the main `requirements.txt` file. #### **Recommendation**: -Once the `.azure/MSIGNITE25-LAB516/.env` is created, specify `AZURE_LOCATION="swedencentral"` proactively to have it pick up that location. This may not always show as an option if run using default `azd up` +Once the `.azure/AI-AGENTS-AZD/.env` is created, specify `AZURE_LOCATION="swedencentral"` proactively to have it pick up that location. This may not always show as an option if run using default `azd up` #### **Execution**: -Once the setup is complete, you can deploy: +Once the setup is complete, change to the template directory: + +```bash +cd .azd-setup +``` + +Then deploy the application and infrastructure in one command: ```bash -cd .infra-setup azd up ``` -### 1.3. Do Customizations +You may be prompted to log into azd as shown: + +```bash +WARNING: You must be logged into Azure perform this action +? Would you like to log in now? (Y/n) +``` + +Accept the default "Y" response. This will trigger the device-code based auth flow shown below. You exact code will vary. + +```bash +? Would you like to log in now? Yes + +Start by copying the next code: F8X72PR73 +Then press enter and continue to log in from your browser... +``` + +Complete the workflow using the Azure account you had logged into for the previous authentication step. Then select the active subscription to use for the deployment (from the provided list). If you had only 1 subscription, it will be selected as a default. + +Let the process complete. You should see continuous updates in the console. On completion, you will see a success message like this: + +```bash +SUCCESS: Your up workflow to provision and deploy to Azure completed in 12 minutes 31 seconds. +``` + + +### 1.3. Do More Customization + +> 🚨 TODO: This section needs to be tested!! 🚨 First, add any additional models required for the project with 2 steps: @@ -65,12 +97,31 @@ First, add any additional models required for the project with 2 steps: 1. Run `scripts/0-additional-models` to update azd template with these details 1. Run `azd provision` to update the infrastructure provisioning -_Note:_ Doing "azd up" will also deploy the app again. If you didn't change the app source code, then azd provision is the best command to minimize overheads. +_Note:_ + +1. Doing "azd up" will also deploy the app again. If you didn't change the app source code, then azd provision is the best command to minimize overheads. +1. Some "customizations" may need to be done in the first install (i.e., during setup-azd step) and will not be enforced in subsequent reprovisionins. Read the base template documentation to understand what those constraints are. ### 1.4. Teardown Template -Run this command from the root of repo: +Once you are done with testing or learning, it is a good idea to tear down the template to reduce costs. There are 2 options: + +**Option 1: Delete Infrastructure** + +Run this command from the `.azd-setup/` folder from which you did the `azd up` previously. This will delete the resource group and release model quota. + +``` +azd down --purge +``` + +**Option 2: Delete Infrastructure & Template** + +Use this option only if you want to delete the default template in this repository and rebuild a new one using scripts. This is useful for maintainers (pull latest versions of base template) or learners (to understand how scripts work). + +_It is not recommended if you are currently doing a workshop with this repo and need to use the provided custom template version. In that case, use Option 1_. + +To use this teardown-everything option, run this command: ```bash ./scripts/3-teardown-azd