Skip to content

Commit 18cd448

Browse files
2 parents 999d6cc + 7bb9ebc commit 18cd448

File tree

144 files changed

+169
-440
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

144 files changed

+169
-440
lines changed

.github/workflows/deploy.yml

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
# name: Deploy MkDocs site to GitHub Pages
2+
3+
# on:
4+
# push:
5+
# branches:
6+
# - main
7+
8+
# jobs:
9+
# deploy:
10+
# runs-on: ubuntu-latest
11+
12+
# steps:
13+
# # Checkout the repo
14+
# - name: Checkout repo
15+
# uses: actions/checkout@v3
16+
17+
# # Set up Python environment
18+
# - name: Set up Python
19+
# uses: actions/setup-python@v4
20+
# with:
21+
# python-version: '3.x'
22+
23+
# # Install MkDocs and Material theme
24+
# - name: Install MkDocs & Material theme
25+
# run: |
26+
# pip install mkdocs-material mkdocs-jupyter
27+
28+
# # Build the MkDocs site
29+
# - name: Build the site
30+
# run: |
31+
# cd workshop
32+
# mkdocs build
33+
# touch site/.nojekyll # Disable Jekyll
34+
35+
# # Deploy to GitHub Pages
36+
# - name: Deploy to GitHub Pages
37+
# uses: peaceiris/actions-gh-pages@v3
38+
# with:
39+
# github_token: ${{ secrets.GITHUB_TOKEN }}
40+
# publish_dir: workshop/site
41+
42+
name: Deploy MkDocs site to GitHub Pages
43+
44+
on:
45+
push:
46+
branches:
47+
- main
48+
49+
jobs:
50+
build-and-deploy:
51+
runs-on: ubuntu-latest
52+
53+
steps:
54+
- name: Checkout repo
55+
uses: actions/checkout@v3
56+
57+
- name: Set up Python
58+
uses: actions/setup-python@v4
59+
with:
60+
python-version: '3.x'
61+
62+
- name: Install MkDocs and dependencies
63+
run: |
64+
pip install mkdocs-material mkdocs-jupyter
65+
66+
- name: Build MkDocs site
67+
working-directory: docs/workshop
68+
run: |
69+
mkdocs build
70+
touch site/.nojekyll # Disable Jekyll processing
71+
72+
- name: Deploy to GitHub Pages
73+
uses: peaceiris/actions-gh-pages@v3
74+
with:
75+
github_token: ${{ secrets.GITHUB_TOKEN }}
76+
publish_dir: docs/workshop/site
77+
# optionally set the branch to deploy to:
78+
# publish_branch: gh-pages

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -15,19 +15,19 @@ Analysts working with large volumes of conversational data can use this solution
1515
</div>
1616
<br/>
1717

18-
<h2><img src="./docs/images/readme/solution-overview.png" width="48" />
18+
<h2><img src="./documents/Images/ReadMe/solution-overview.png" width="48" />
1919
Solution overview
2020
</h2>
2121

2222
Leverages Azure AI Content Understanding, Azure AI Search, Azure OpenAI Service, Semantic Kernel, Azure SQL Database, and Cosmos DB to process large volumes of conversational data. Audio and text inputs are analyzed through event-driven pipelines to extract and vectorize key information, orchestrate intelligent responses, and power an interactive web front-end for exploring insights using natural language.
2323

2424
### Solution architecture
25-
|![image](./docs/images/readme/solution-architecture.png)|
25+
|![image](./documents/Images/ReadMe/solution-architecture.png)|
2626
|---|
2727

2828
### Additional resources
2929

30-
[Technical Architecture](./docs/TechnicalArchitecture.md)
30+
[Technical Architecture](./documents/TechnicalArchitecture.md)
3131

3232
<br/>
3333

@@ -55,14 +55,14 @@ Summarized conversations, topic generation, and key phrase extraction support fa
5555

5656

5757
<br /><br />
58-
<h2><img src="./docs/images/readme/quick-deploy.png" width="48" />
58+
<h2><img src="./documents/Images/ReadMe/quick-deploy.png" width="48" />
5959
Quick deploy
6060
</h2>
6161

6262
### How to install or deploy
6363
Follow the quick deploy steps on the deployment guide to deploy this solution to your own Azure subscription.
6464

65-
[Click here to launch the deployment guide](./docs/DeploymentGuide.md)
65+
[Click here to launch the deployment guide](./documents/DeploymentGuide.md)
6666
<br/><br/>
6767

6868

@@ -114,12 +114,12 @@ _Note: This is not meant to outline all costs as selected SKUs, scaled use, cust
114114
either by deleting the resource group in the Portal or running `azd down`.
115115

116116
<br /><br />
117-
<h2><img src="./docs/images/readme/business-scenario.png" width="48" />
117+
<h2><img src="./documents/Images/ReadMe/business-scenario.png" width="48" />
118118
Business scenario
119119
</h2>
120120

121121

122-
|![image](./docs/images/readme/ui.png)|
122+
|![image](./documents/Images/ReadMe/ui.png)|
123123
|---|
124124

125125
<br/>
@@ -152,7 +152,7 @@ Clear, contextual insights empower employees to take meaningful action based on
152152

153153
<br /><br />
154154

155-
<h2><img src="./docs/images/readme/supporting-documentation.png" width="48" />
155+
<h2><img src="./documents/Images/ReadMe/supporting-documentation.png" width="48" />
156156
Supporting documentation
157157
</h2>
158158

docs/workshop/README.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# Conversation Knowledge Mining Solution Accelerator: Hands-on Workshop
2+
3+
| [![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/microsoft/Conversation-Knowledge-Mining-Solution-Accelerator) | [![Open in Dev Containers](https://img.shields.io/static/v1?style=for-the-badge&label=Dev%20Containers&message=Open&color=blue&logo=visualstudiocode)](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/microsoft/Conversation-Knowledge-Mining-Solution-Accelerator) |
4+
|---|---|
5+
6+
7+
8+
### About the Conversation Knowledge Mining Solution Accelerator
9+
10+
Gain actionable insights from large volumes of conversational data by identifying key themes, patterns, and relationships. Using Azure AI Foundry, Azure AI Content Understanding, Azure OpenAI Service, and Azure AI Search, this solution analyzes unstructured dialogue and maps it to meaningful, structured insights.
11+
12+
Capabilities such as topic modeling, key phrase extraction, speech-to-text transcription, and interactive chat enable users to explore data naturally and make faster, more informed decisions.
13+
14+
Analysts working with large volumes of conversational data can use this solution to extract insights through natural language interaction. It supports tasks like identifying customer support trends, improving contact center quality, and uncovering operational intelligence—enabling teams to spot patterns, act on feedback, and make informed decisions faster.
15+
16+
### Solution architecture
17+
![High-level architecture diagram for the solution](./docs/workshop/img/ReadMe/techkeyfeatures.png)
18+
19+
### Workshop Guide
20+
21+
The current repository is instrumented with a `workshop/docs` folder that contains the step-by-step lab guide for developers, covering the entire workflow from resource provisioning to ideation, evaluation, deployment, and usage.
22+
23+
You can **preview and extend** the workshop directly from this source by running the [MKDocs](https://www.mkdocs.org/) pages locally:
24+
25+
1. Install the `mkdocs-material` package
26+
27+
```bash
28+
pip install mkdocs-material
29+
```
30+
31+
2. Run the `mkdocs serve` command from the `workshop` folder
32+
33+
```bash
34+
cd workshop/docs
35+
mkdocs serve -a localhost:5000
36+
```
37+
38+
This should run the dev server with a preview of the workshop guide on the specified local address. Simply open a browser and navigate to `http://localhost:5000` to view the content.
39+
40+
(Optional) If you want to deploy the workshop guide to a live site, you can use the `mkdocs gh-deploy` command to push the content to a GitHub Pages site.
File renamed without changes.
File renamed without changes.

workshop/docs/workshop/Challenge-0/CU-Challenge.md renamed to docs/workshop/docs/workshop/Challenge-0/CU-Challenge.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,18 +3,19 @@
33
## Step 1: Create a Content Understanding Project
44

55
- Navigate to the [AI Foundry homepage](https://ai.azure.com) and select Try Content Understanding.
6+
> **Note**: You will need to create a project in one of the following regions: westus, swedencentral, or australiaeast
67
78
![AI Foundry Homepage](../img/ai-services-landing-page.png)
89

910
- Select + Create to create a new Content Understand project.
1011

11-
![CU Landing Page](../img/cu-create-project.png)
12+
![CU Landing Page](../img/cu-landing-page.png)
1213

1314
- Provide a name for your project (i.e. call_analyzer), select create a new hub, keep the default Azure AI service connection and select Next
1415
![create project](../img/create_project.png)
1516
- Keep the default storage account, select next and select Create project.
1617

17-
- Select Browse file to upload the [sample audio file](../data/convo_2c703f97-6657-4a15-b8b2-db6b96630b2d_2024-12-06%2006_00_00.wav).
18+
- Select Browse file to upload the sample audio file included in this [workshop](../data/convo_2c703f97-6657-4a15-b8b2-db6b96630b2d_2024-12-06%2006_00_00.wav).
1819

1920
![CU upload document](../img/cu-upload-document.png)
2021

File renamed without changes.

workshop/docs/workshop/Challenge-1/data-explore.md renamed to docs/workshop/docs/workshop/Challenge-1/Code_Walkthrough/01_Data_Explore.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,20 +7,20 @@ To access and explore the ingested data:
77
2. Locate the Resource Group where the solution is deployed
88

99
3. Click on the Storage Account associated with the solution
10-
![image](../img/storage-blob.png)
10+
![image](../../img/storage-blob.png)
1111

1212
4. Navigate to Containers section
13-
![image](../img/storage-container.png)
13+
![image](../../img/storage-container.png)
1414

1515
5. Open the container named data
1616

1717
You’ll see two folders:
1818

1919
- audiodata → Contains uploaded call recordings
20-
![image](../img/audio-folder.png)
20+
![image](../../img/audio-folder.png)
2121

2222
call_transcripts → Stores the transcript text used for AI processing
23-
![image](../img/call_transcripts.png)
23+
![image](../../img/call_transcripts.png)
2424
<!-- The Sample dataset used for this solution contains customer interactions categorized into various topics. Each entry includes:
2525
2626
- **ConversationId**: Unique identifier for each conversation.

workshop/docs/workshop/Challenge-1/Frontend.md renamed to docs/workshop/docs/workshop/Challenge-1/Code_Walkthrough/02_Frontend.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
The frontend is a **React-based web interface** that allows users to explore insights from conversations, interact with an AI-powered chatbot, and view dynamic visualizations.
77

8-
![image](../support-docs/Images/ReadMe/ckm-ui.png)
8+
![image](../../../../../../documents/Images/ReadMe/ui.png)
99

1010
### Features
1111

0 commit comments

Comments
 (0)