Description

Chat with your Data is a reference .NET application implementing an Chat application based on documents content with search features using Semantic Search with Vector Database and Azure AI Search.

• Features
• Architecture diagram
• Getting started
• Deploying to Azure
• Run solution
  • Run locally
  • Run the solution
  • .NET Aspire Azure Resources creation-
  • Analyze the Vector Store in Azure AI Search
  • Local dev using existing services
  • Telemetry with .NET Aspire and Azure Application Insights
• Solution Overview
  • Upload Document
  • Process an Uploaded Document
  • Chat steps for each question
• Resources
• Video Recordings
• Guidance
  • Costs
  • Security Guidelines
• Resources

Features

GitHub CodeSpaces: This project is designed to be opened in GitHub Codespaces as an easy way for anyone to deploy the solution entirely in the browser.

This is the Chat Application running answering questions based on documents content:

This is the Document Manager application. this application serves as an example on how to add or update new documents to the document database.

The Aspire Dashboard to check the running services:

The Azure Resource Group with all the deployed services:

The Application Insights Application Map view of the solution:

Architecture diagram

WIP

Getting Started

The solution is in the ./src folder, the main solution is Chat-With-Y-Data.sln.

Deploying

Once you've opened the project in Codespaces, or locally, you can deploy it to Azure.

From a Terminal window, open the folder with the clone of this repo and run the following commands.

1. Login to Azure:

   azd auth login

2. Provision and deploy all the resources:

   azd up

   It will prompt you to provide an azd environment name (like "chat=with-your-data"), select a subscription from your Azure account, and select a location where Azure AI Search and the OpenAI models gpt-4o and ADA-002 are available (like "eastus2").

3. When azd has finished deploying, you'll see the list of resources created in Azure and a set of URIs in the command output.

4. Visit the uichatapp URI, and you should see the Chat application! 🎉

5. Visit the uidocsmngr URI, and you should see the Document Manager Application! 🎉

6. This is an example of the command output:

1. Coming Soon! You can check this video with a 5 minutes overview of the deploy process from Codespaces: Deploy Your Chat with your Data to Azure in Minutes!.

Note: The deploy files are located in the ./src/ChatWYData.AppHost/infra/ folder. They are generated by the Aspire AppHost project.

GitHub CodeSpaces

• Create a new Codespace using the Code button at the top of the repository.

  

• The Codespace creation process can take a couple of minutes.

• Once the Codespace is loaded, it should have all the necessary requirements to deploy the solution.

Run Locally

To run the project locally, you'll need to make sure the following tools are installed:

• .NET 9
• Git
• Azure Developer CLI (azd)
• Visual Studio Code or Visual Studio
  • If using Visual Studio Code, install the C# Dev Kit
• .NET Aspire workload: Installed with the Visual Studio installer or the .NET CLI workload.
• An OCI compliant container runtime, such as:
  • Docker Desktop or Podman.

Run the solution

Follow these steps to run the project, locally or in CodeSpaces:

• Navigate to the Aspire Host folder project using the command:

  cd ./src/ChatWYData.AppHost

• If you are running the project in Codespaces, you need to run this command:

  dotnet dev-certs https --trust

• By default the AppHost project creates the necessary resources on Azure. Check the .NET Aspire Azure Resources creation section to learn how to configure the project to create Azure resources.

• Run the project:

  dotnet run

Check the Video Resources for a step-by-step on how to run this project.

.NET Aspire Azure Resources creation

When utilizing Azure resources in your local development environment, you need to:

• Authenticate to the Azure Tenant where the resources will be created. Run the following command to connect with your Azure tenant:

  az login 

• Provide the necessary Configuration values are specified under the Azure section in the ChatWYData.AppHost project:

  • CredentialSource: Delegates to the AzureCliCredential.
  • SubscriptionId: The Azure subscription ID.
  • AllowResourceGroupCreation: A boolean value that indicates whether to create a new resource group.
  • ResourceGroup: The name of the resource group to use.
  • Location: The Azure region to use.

Consider the following example for the appsettings.json file in the ChatWYData.AppHost project configuration:

{
  "Azure": {
    "CredentialSource": "AzureCli",
    "SubscriptionId": "<Your subscription id>",
    "AllowResourceGroupCreation": true,
    "ResourceGroup": "<Valid resource group name>",
    "Location": "<Valid Azure location>"
  }
}

Check .NET Aspire Azure hosting integrations for more information on how .NET Aspire create the necessary cloud resources for local development.

Analyze the Vector Store in Azure AI Search

Once you upload documents using the Document Manager Application, the solution will store the documents information in an Azure AI Search index.

When you use the Chat Application, the user questions will be processed and answered using a gpt-4o model, and also the information from the Azure AI Search index.

Local development using an existing services

In order to use existing Azure AI Search Services and existing Azure OpenAI models, like gpt-4o and text-embedding-ada-002, you need to make changes in several project:

Aspire AppHost

Open the program.cs in .\src\ChatWYData.AppHost\, and comment the main aspire lines, and uncomment the lines to work in DEV MODE.

API Projects

Edit and define specific connection strings in the projects"

• ChatWYData.DescriptionApi
• ChatWYData.VectorStoreAzureAISearch

Add a user secret running these commands in each project. In example, for the DescriptionApi project:

cd src/ChatWYData.DescriptionApi
dotnet user-secrets set "ConnectionStrings:openai" "Endpoint=https://<endpoint>.openai.azure.com/;Key=<Azure OpenAI Service key>;"
dotnet user-secrets set "ConnectionStrings:azureaisearch" "Endpoint=https://<endpoint>.search.windows.net/;Key=<Azure AI Search key>;"

Telemetry with .NET Aspire and Azure Application Insights

The Chat with your Data solution leverages the Aspire Dashboard and Azure Application Insights to provide comprehensive telemetry and monitoring capabilities

The .NET Aspire Dashboard offers a centralized view of the application's performance, health, and usage metrics. It integrates seamlessly with the Azure OpenAI services, allowing developers to monitor the performance of the gpt-4o and text-embedding-ada-002 models. The dashboard provides real-time insights into the application's behavior, helping to identify and resolve issues quickly.

Azure Application Insights complements the Aspire Dashboard by offering deep diagnostic capabilities and advanced analytics. It collects detailed telemetry data, including request rates, response times, and failure rates, enabling developers to understand how the application is performing under different conditions. Application Insights also provides powerful querying and visualization tools, making it easier to analyze trends and detect anomalies.

By combining the Aspire Dashboard with Azure Application Insights, the Chat With Your Data solution ensures robust monitoring and diagnostics, enhancing the overall reliability and performance of the application.

Guidance

Costs

For Azure OpenAI Services, pricing varies per region and usage, so it isn't possible to predict exact costs for your usage. Same applies to Azure AI Search. The majority of the Azure resources used in this infrastructure are on usage-based pricing tiers. However, Azure Container Registry has a fixed cost per registry per day.

You can try the Azure pricing calculator for the resources:

• Azure OpenAI Service: S0 tier, gpt-4o and text-embedding-ada-002 models. Pricing is based on token count. Pricing
• 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
• Azure Container Registry: Basic tier. Pricing
• Log analytics: Pay-as-you-go tier. Costs based on data ingested. Pricing
• Azure AI Search: Basic tier. You can edit the bicep files to change for the free tier.
• Azure Application Insights pricing is based on a Pay-As-You-Go model. Pricing.

⚠️ 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

Samples in this templates uses Azure OpenAI Services with ApiKey and Managed Identity for authenticating to the Azure OpenAI service.

The Main Sample uses Managed Identity](https://learn.microsoft.com/entra/identity/managed-identities-azure-resources/overview) for authenticating to the Azure OpenAI service.

Additionally, we have added a GitHub Action that scans the infrastructure-as-code files and generates a report containing any detected issues. 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 setting is enabled.

You may want to consider additional security measures, such as:

• Protecting the Azure Container Apps instance with a firewall and/or Virtual Network.

Resources

• eShopLite Semantic Search is a reference .NET application implementing an eCommerce site with Search features using Keyword Search and Semantic Search.

• eShopLite Semantic Search Azure AI Search is a reference .NET application implementing an eCommerce site with Search features using Keyword Search and Semantic Search with Azure AI Search.

• Deploy a .NET Aspire project to Azure Container Apps using the Azure Developer CLI (in-depth guide)

• Aspiring .NET Applications with Azure OpenAI