|
4 | 4 |
|
5 | 5 | --- |
6 | 6 |
|
| 7 | +## Overview |
| 8 | + |
7 | 9 | This document provides guidance on post-deployment steps after deploying the Conversation Knowledge Mining solution accelerator from the [AVM (Azure Verified Modules) repository](https://github.com/Azure/bicep-registry-modules/tree/main/avm/ptn/sa/conversation-knowledge-mining). |
8 | 10 |
|
| 11 | +--- |
| 12 | + |
9 | 13 | ## Prerequisites |
10 | 14 |
|
11 | | -- **Deployed Infrastructure** - A successful Conversation Knowledge Mining solution accelerator deployment from the [AVM repository](https://github.com/Azure/bicep-registry-modules/tree/main/avm/ptn/sa/conversation-knowledge-mining) |
| 15 | +Before proceeding, ensure you have the following: |
| 16 | + |
| 17 | +### 1. Azure Subscription & Permissions |
| 18 | + |
| 19 | +You need access to an [Azure subscription](https://azure.microsoft.com/free/) with permissions to: |
| 20 | +- Create resource groups and resources |
| 21 | +- Create app registrations |
| 22 | +- Assign roles at the resource group level (Contributor + RBAC) |
| 23 | + |
| 24 | +📖 Follow the steps in [Azure Account Set Up](./AzureAccountSetUp.md) for detailed instructions. |
| 25 | + |
| 26 | +### 2. Deployed Infrastructure |
| 27 | + |
| 28 | +A successful Conversation Knowledge Mining solution accelerator deployment from the [AVM repository](https://github.com/Azure/bicep-registry-modules/tree/main/avm/ptn/sa/conversation-knowledge-mining). |
| 29 | + |
| 30 | +### 3. Required Tools |
| 31 | + |
| 32 | +Ensure the following tools are installed on your machine: |
| 33 | + |
| 34 | +| Tool | Version | Download Link | |
| 35 | +|------|---------|---------------| |
| 36 | +| PowerShell | v7.0+ | [Install PowerShell](https://learn.microsoft.com/en-us/powershell/scripting/install/installing-powershell?view=powershell-7.5) | |
| 37 | +| Azure Developer CLI (azd) | v1.18.0+ | [Install azd](https://aka.ms/install-azd) | |
| 38 | +| Python | 3.9+ | [Download Python](https://www.python.org/downloads/) | |
| 39 | +| Docker Desktop | Latest | [Download Docker](https://www.docker.com/products/docker-desktop/) | |
| 40 | +| Git | Latest | [Download Git](https://git-scm.com/downloads) | |
| 41 | +| Microsoft ODBC Driver | 18 | [Download ODBC Driver](https://learn.microsoft.com/en-us/sql/connect/odbc/download-odbc-driver-for-sql-server?view=sql-server-ver16) | |
| 42 | + |
| 43 | +--- |
| 44 | + |
| 45 | +## Post-Deployment Steps |
| 46 | + |
| 47 | +### Step 1: Clone the Repository |
| 48 | + |
| 49 | +Clone this repository to access the post-deployment scripts and sample data: |
| 50 | + |
| 51 | +```powershell |
| 52 | +git clone https://github.com/microsoft/Conversation-Knowledge-Mining-Solution-Accelerator.git |
| 53 | +``` |
| 54 | + |
| 55 | +```powershell |
| 56 | +cd Conversation-Knowledge-Mining-Solution-Accelerator |
| 57 | +``` |
| 58 | + |
| 59 | +--- |
12 | 60 |
|
13 | | -## Post Deployment Steps |
| 61 | +### Step 2: Run the Data Processing Script |
14 | 62 |
|
15 | | -### 1. Access the Application |
| 63 | +#### 2.1 Login to Azure |
| 64 | + |
| 65 | +```shell |
| 66 | +az login |
| 67 | +``` |
| 68 | + |
| 69 | +> 💡 **Tip**: If using VS Code Web, use device code authentication: |
| 70 | +> ```shell |
| 71 | +> az login --use-device-code |
| 72 | +> ``` |
| 73 | +
|
| 74 | +#### 2.2 Execute the Script |
| 75 | +
|
| 76 | +Run the bash script from the output of the AVM deployment: |
| 77 | +
|
| 78 | +```bash |
| 79 | +bash ./infra/scripts/process_sample_data.sh <Resource-Group-Name> |
| 80 | +``` |
| 81 | +
|
| 82 | +> ⚠️ **Important**: Replace `<Resource-Group-Name>` with your actual resource group name from the deployment. |
| 83 | +
|
| 84 | +--- |
| 85 | + |
| 86 | +### Step 3: Access the Application |
16 | 87 |
|
17 | 88 | 1. Navigate to the [Azure Portal](https://portal.azure.com) |
18 | | -2. Open the resource group created during deployment |
19 | | -3. Locate the App Service with name starting with `app-` |
| 89 | +2. Open the **resource group** created during deployment |
| 90 | +3. Locate the **App Service** with name starting with `app-` |
20 | 91 | 4. Copy the **URL** from the Overview page |
21 | 92 | 5. Open the URL in your browser to access the application |
22 | 93 |
|
23 | | -### 2. Configure Authentication (Optional) |
| 94 | +--- |
24 | 95 |
|
25 | | -If you want to enable authentication, configure it by following the [App Authentication Guide](./AppAuthentication.md). |
| 96 | +### Step 4: Configure Authentication (Optional) |
26 | 97 |
|
27 | | -### 3. Verify Data Processing |
| 98 | +If you want to enable authentication for your application, follow the [App Authentication Guide](./AppAuthentication.md). |
28 | 99 |
|
29 | | -- Check that sample data has been uploaded to the storage account |
30 | | -- Verify that the AI Search index has been created and populated |
31 | | -- Confirm that the application loads without errors |
| 100 | +--- |
| 101 | + |
| 102 | +### Step 5: Verify Data Processing |
| 103 | + |
| 104 | +Confirm your deployment is working correctly: |
| 105 | + |
| 106 | +| Check | Location | |
| 107 | +|-------|----------| |
| 108 | +| ✅ Sample data uploaded | Storage Account | |
| 109 | +| ✅ AI Search index created and populated | Azure AI Search | |
| 110 | +| ✅ Application loads without errors | App Service URL | |
| 111 | + |
| 112 | +--- |
32 | 113 |
|
33 | 114 | ## Getting Started |
34 | 115 |
|
35 | 116 | ### Sample Questions |
36 | 117 |
|
37 | | -Try these questions in the application to explore the solution capabilities: |
| 118 | +To help you get started, here are some [Sample Questions](./SampleQuestions.md) you can follow to try it out. |
| 119 | + |
| 120 | +--- |
| 121 | + |
| 122 | +## Troubleshooting |
38 | 123 |
|
39 | | -- "Total number of calls by date for the last 7 days" |
40 | | -- "Show average handling time by topics in minutes" |
41 | | -- "What are the top 7 challenges users reported?" |
42 | | -- "Give a summary of billing issues" |
43 | | -- "When customers call in about unexpected charges, what types of charges are they seeing?" |
| 124 | +If you encounter issues, refer to the [Troubleshooting Guide](./TroubleShootingSteps.md). |
0 commit comments