Setup Documentation¶
This directory contains comprehensive setup guides for the Azure AI Search Handbook.
📋 Setup Guides¶
🚀 Azure AI Search Service Setup¶
Complete guide for setting up your Azure AI Search service with multiple deployment options: - Azure Portal setup (recommended for beginners) - Azure CLI setup (for advanced users) - ARM template deployment (for automation) - Security best practices and troubleshooting
⚡ Quick Reference¶
Essential commands, configuration templates, and troubleshooting tips for quick access.
🛠️ Setup Scripts¶
Interactive Setup¶
Environment Setup¶
# Set up development environment
python3 setup/environment_setup.py
# Or use CLI
python3 setup/setup_cli.py setup --validate
📁 Deployment Resources¶
ARM Templates¶
- azure-search-template.json: Azure Resource Manager template for automated deployment
- Supports all pricing tiers and configuration options
- Includes managed identity setup
Configuration Files¶
- .env.template: Environment variables template
- requirements.txt: Python dependencies
🔍 Verification¶
After setup, verify everything works:
# Check environment status
python3 setup/setup_cli.py status
# Test Azure connection
python3 scripts/test_connection.py
# Generate and test notebooks
python3 setup/setup_cli.py notebooks
jupyter notebook
🆘 Getting Help¶
- Setup Issues: Check the troubleshooting section
- Connection Problems: Run
python3 setup/setup_cli.py status - Azure Service Issues: Check the Azure portal
- Environment Issues: See the main README
📚 Next Steps¶
Once setup is complete:
- Start Learning: Module 1 - Introduction and Setup
- Generate Sample Data:
python3 scripts/generate_sample_data.py - Explore Notebooks: Open any
.ipynbfile in thedocs/directory - Join the Community: Check the main repository for discussion links
Need help? Check the Quick Reference or the detailed Azure AI Search Setup Guide.