azure-search-openai-demo

(★ 7,741)

A sample app for the Retrieval-Augmented Generation pattern running in Azure, using Azure AI Search for retrieval and Azure OpenAI large language models to power ChatGPT-style and Q&A experiences.

File Explorer

  • .gitattributes
  • .gitignore
  • .markdownlint-cli2.jsonc
  • .pre-commit-config.yaml
  • AGENTS.md
  • azure.yaml
  • CONTRIBUTING.md
  • LICENSE
  • locustfile.py
  • package-lock.json
  • ps-rule.yaml
  • pyproject.toml
  • README.md
  • requirements-dev.txt
  • SECURITY.md

# Installation Guide

python
Prerequisites

Setup Steps

git clone https://github.com/Azure-Samples/azure-search-openai-demo.git

Clone the project source code locally.

azd auth login

Log in to your Azure account using Azure Developer CLI.

azd up

Provision Azure resources and deploy the application.

Video Guides

RAG chat app with Azure OpenAI and Azure AI Search Overview

Key Commands

azd up

Provision Azure resources, build, and deploy all in one command.

pip install -r app/backend/requirements.txt

Install Python package dependencies for the backend.

npm install --prefix app/frontend

Install Node.js package dependencies for the frontend.

Local execution requires backend/frontend configuration and Azure OpenAI service connection.

# Use via CDN

jsDelivr

jsDelivr serves any public GitHub repository as a CDN with zero setup. Pick a version and a file to get a ready-to-paste link and snippet.

Release Timeline

Actively Maintained

Command Glossary

Commands referenced in this DOCs, explained below.

🔍

python

View Details ▼

Python language interpreter.

python

Start a REPL (interactive shell):

python {{path/to/file.py}}

Execute a specific Python file:

python -i {{path/to/file.py}}

Execute a specific Python file and start a REPL:

🔍

python3

View Details ▼

This command is an alias of `python`.

tldr python

View documentation for the original command:

🔍

apt install

View Details ▼

Install packages for Debian-based distributions.

sudo apt install {{package}}

Install a package, or update it to the latest version:

sudo apt install {{[-V|--verbose-versions]}} {{package}}

Display verbose package version information during installation or update:

// repository documentation