> For the complete documentation index, see [llms.txt](https://maqsoftware.gitbook.io/events-assistant-technical-documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://maqsoftware.gitbook.io/events-assistant-technical-documentation/readme.md).

# Events Assistant — Technical Documentation

AI-powered event attendee copilot on Azure with hybrid AI Search, Redis caching, and admin portal.

Welcome to the comprehensive guide for installing, configuring, and operating the **Events Assistant** solution. Events Assistant is delivered as an **Azure Marketplace Managed Application** — the customer installs it from the Marketplace, completes a guided ARM template wizard, and the platform provisions every Azure resource (with the right identities, role assignments, secrets, and code) automatically.

## What Events Assistant Does

Events Assistant is a conversational AI copilot that answers attendee questions about an event — sessions, speakers, sponsors/partners, and FAQs. It is built as a sequential 2-agent pipeline (Classifier → Responder) backed by Azure AI Search (hybrid keyword + vector + semantic reranking), Azure OpenAI, Cosmos DB, Redis cache, and Azure AI Content Safety. It ships with a React admin portal for full self-service configuration of events, intents, prompts, FAQ, data sources, search indexes, safety policies, access control, and a kill switch.

## How This Guide is Organised

The documentation follows a sequential four-step framework. Read in order on first install.

| # | Section                                                                          | Purpose                                                                                                                                                     |
| - | -------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 1 | [Prerequisites](/events-assistant-technical-documentation/01-prerequisites.md)   | Azure subscription, RBAC permissions, and admin account you need before opening the Marketplace listing                                                     |
| 2 | [Pre-deployment](/events-assistant-technical-documentation/02-pre-deployment.md) | Information to gather (event name, region, admin email, etc.) so the ARM template wizard can be completed in one pass                                       |
| 3 | [Deploy](/events-assistant-technical-documentation/03-deploy.md)                 | Walk through the Marketplace Managed Application wizard end-to-end                                                                                          |
| 4 | [Configure](/events-assistant-technical-documentation/04-configure.md)           | Post-deploy — run the AI Search index setup script, then use the admin portal to register events, load content, configure intents/prompts/FAQ/safety/access |

## Solution at a Glance

Everything below is provisioned and configured for you by the Marketplace deployment. You do not need to provision them yourself.

**Application components**

* **Backend Function App** — Python Azure Functions hosting `/api/chat`, `/api/init`, `/api/health`, the full `/api/mgmt/*` admin surface, and `/external/push/*` hook
* **Admin Portal** — React SPA with Microsoft Entra (MSAL) authentication, hosted on Azure App Service
* **Chat UI** — React SPA, hosted on Azure App Service; embeddable in any host page via an iframe + `postMessage` handshake

**Azure services provisioned by the Marketplace template**

Azure Functions, Azure App Service, Azure Cosmos DB, Azure AI Search, Azure Cache for Redis, Azure OpenAI, Azure AI Content Safety, Azure Storage (Tables + Queues), Azure Key Vault, Managed Identities, Application Insights.

**Post-deploy script**

`cosmos_indexer_setup.ps1` — Creates the AI Search indexes, datasources, and indexers wired to Cosmos DB via the change feed. Run once per environment after the Marketplace deployment completes.

## Audience

* **Customer cloud / IT engineer** installing the Marketplace offer
* **Event operators** registering events and managing content/FAQ
* **Solution administrators** managing access control, kill switch, and safety policies

## How to Use This Guide

1. On first install, work through Sections 1 → 4 in order.
2. For day-2 operations (adding events, updating FAQ, rotating access), jump directly to [Configure](/events-assistant-technical-documentation/04-configure.md).
3. The Marketplace upgrade flow handles future application code updates — you do not redeploy manually.