Skip to content

Azure-Samples/image-search-aisearch

Repository files navigation

Image search with Azure AI Search

This project creates an image search web application and an MCP (Model Context Protocol) server, both backed by Azure AI Search. They allow you to search for images using natural language queries, leveraging multimodal embeddings from the Azure AI Vision API and image descriptions generated by the Azure OpenAI Service.

The web app frontend is built with TypeScript/React and the backend with Python/Quart. The MCP server is built with Python/FastMCP, and includes two tools that can be used by any MCP client, such as VS Code GitHub Copilot. The image_search tool returns a list of search results with thumbnail previews and descriptions, and the display_image_files tool renders images using MCP apps.

This project uses the sample nature data set from Vision Studio.

Azure account requirements

IMPORTANT: In order to deploy and run this example, you'll need:

  • Azure account. If you're new to Azure, get an Azure account for free.
  • Azure account permissions:
    • Your Azure account must have Microsoft.Authorization/roleAssignments/write permissions, such as Role Based Access Control Administrator, User Access Administrator, or Owner. If you don't have subscription-level permissions, you must be granted RBAC for an existing resource group and deploy to an existing resource group.
    • Your Azure account also needs Microsoft.Resources/deployments/write permissions on the subscription level.

Azure deployment

Cost estimation

Pricing varies per region and usage, so it isn't possible to predict exact costs for your usage. However, you can try the Azure pricing calculator for the resources below.

  • Azure Container Apps: Consumption plan. Pricing per hour and per request. Pricing
  • Azure AI Search: Standard tier, 1 replica. Pricing per hour. Pricing
  • Azure Blob Storage: Standard tier with ZRS (Zone-redundant storage). Pricing per storage and read operations. Pricing
  • Azure Monitor: Pay-as-you-go tier. Costs based on data ingested. Pricing

To reduce costs, you can switch to free SKUs for various services, but those SKUs may have limitations.

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

Project setup

Local environment

First install the required tools:

  • Azure Developer CLI
  • Python 3.10 or later
    • Important: Python and the pip package manager must be in the path in Windows for the setup scripts to work.
    • Important: Ensure you can run python --version from console. On Ubuntu, you might need to run sudo apt install python-is-python3 to link python to python3.
  • Node.js 14+
  • Git
  • Powershell 7+ (pwsh) - For Windows users only.
    • Important: Ensure you can run pwsh.exe from a PowerShell terminal. If this fails, you likely need to upgrade PowerShell.

Then bring down the project code:

  1. Create a new folder and switch to it in the terminal
  2. Run azd auth login
  3. Run azd init -t image-search-aisearch
    • note that this command will initialize a git repository and you do not need to clone this repository

Deploying from scratch

Execute the following command, if you don't have any pre-existing Azure services and want to start from a fresh deployment.

  1. Run azd up - This will provision Azure resources and deploy this sample to those resources, including building the search index based on the files found under pictures/.
    • Important: Beware that the resources created by this command will incur immediate costs, primarily from the AI Search resource. These resources may accrue costs even if you interrupt the command before it is fully executed. You can run azd down or delete the resources manually to avoid unnecessary spending.
  2. After the application has been successfully deployed you will see a URL printed to the console. Click that URL to interact with the application in your browser.

How the indexer works

When setup_search_service.py runs (automatically during azd up, or manually), it sets up an Azure AI Search indexing pipeline:

  1. Blob upload – Images from the pictures/ folder are uploaded to an Azure Blob Storage container. Only files placed directly under pictures/ are uploaded.
  2. Data source – A Search data source is configured to point at that blob container.
  3. Skillset – Two skills are applied to each image:
    • VisionVectorizeSkill generates a 1024-dimensional multimodal embedding using Azure AI Vision.
    • ChatCompletionSkill (optional) produces a natural-language description of each image, stored as verbalized_image.
  4. Index – Results are written to a Search index with an embedding vector field backed by an HNSW algorithm, plus a built-in AI Vision vectorizer so that query text is embedded at search time without extra code.
  5. Indexer – Runs the pipeline: blob → normalized images → skills → index projections. Each image within a blob becomes its own indexed document.

At query time, the search service vectorizes the text query using the same AI Vision model and performs an approximate nearest-neighbor search over the stored embeddings.

Running locally

You can only run locally after having successfully run the azd up command. If you haven't yet, follow the steps in Azure deployment above.

Web app

  1. Run azd auth login
  2. Change dir to app and run ./start.ps1 or ./start.sh depending on your OS.
  3. Open a browser and navigate to http://localhost:50505

MCP server

  1. Run azd auth login
  2. Run python app/backend/mcp_server.py
  3. The server starts on http://localhost:8001. Add it to your MCP client configuration (e.g. VS Code or Claude Desktop) pointing at that URL.

To connect to a deployed MCP server instead, update .vscode/mcp.json with your deployed Container App hostname and append /mcp (for example, using the SERVICE_MCP_URI output from azd up).

Adding new images

To add new images to the search index after the initial deployment:

  1. Place new JPEG image files directly under the pictures/ folder. Convert to JPEG first if needed.

  2. Run the setup script inside the Python environment to upload and re-index:

    python ./app/backend/setup_search_service.py

The script skips blobs that already exist, so only new files will be uploaded. The indexer will then vectorize and index the new images.

Clean up

To clean up all the resources created by this sample:

  1. Run azd down
  2. When asked if you are sure you want to continue, enter y
  3. When asked if you want to permanently delete the resources, enter y

The resource group and all the resources will be deleted.

About

An image search application using multimodal embeddings and Azure AI search vector search.

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors