get-started-with-ai-agents  by Azure-Samples

AI agents for web apps with document RAG and monitoring

Created 1 year ago
261 stars

Top 97.5% on SourcePulse

GitHubView on GitHub
Project Summary

This project provides a foundational sample for deploying a web-based AI agent application leveraging Azure AI Foundry and SDKs. It targets developers and power users seeking to quickly implement AI agents capable of knowledge retrieval from uploaded documents, complete with response citations and integrated monitoring for troubleshooting. The primary benefit is a streamlined path to deploying a functional, customizable AI agent solution on Azure.

How It Works

The solution deploys an AI agent within Azure Container Apps, utilizing the Azure AI Agent service. Knowledge retrieval is powered by Azure AI Search, enabling the agent to access information from uploaded files and generate responses with citations. Integrated monitoring, including Azure Monitor and Application Insights, provides tracing and logging for easier troubleshooting and performance optimization.

Quick Start & Requirements

  • Primary install/run command: Execute azd up in the terminal after environment setup.
  • Prerequisites: An Azure subscription and region selection are required. The Azure Developer CLI (azd) must be installed. Deployment can be initiated via GitHub Codespaces, VS Code Dev Containers, or a local environment.
  • Estimated setup time: Deployment typically takes 5-20 minutes.
  • Relevant links: A full deployment guide is referenced for detailed instructions.

Highlighted Details

  • AI agent employs file search or Azure AI Search for knowledge retrieval from uploaded documents.
  • Supports customizable AI model deployment (e.g., gpt-4o-mini) with configurable retrieval methods.
  • Features integrated monitoring and tracing via Azure Monitor and Application Insights for debugging.
  • Includes capabilities for agent evaluation and an AI Red Teaming Agent for automated safety and security scans.

Maintenance & Community

No specific details regarding maintainers, community channels, or sponsorships are provided in the README.

Licensing & Compatibility

No explicit open-source license is stated. As a Microsoft sample, it is subject to Azure service terms. Extensive disclaimers advise against direct production use without implementing additional security features and highlight that the solution is not intended for medical, financial, or high-risk applications.

Limitations & Caveats

This sample is explicitly not designed for production environments without significant additional security implementations. It carries strong disclaimers against use in high-risk scenarios where failure could lead to severe harm, and is not intended as a substitute for professional medical or financial advice.

Health Check
Last Commit

6 days ago

Responsiveness

Inactive

Pull Requests (30d)
10
Issues (30d)
1
Star History
21 stars in the last 30 days

Explore Similar Projects

Feedback? Help us improve.