Skip to content

fix: resolved conflict and updated readme #257

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Avijit-Microsoft merged 5 commits into from
Feb 25, 2025
Merged

fix: resolved conflict and updated readme #257

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
e1b3d20
Update README.md
Roopan-Microsoft Feb 22, 2025
1875109
Update README.md
Roopan-Microsoft Feb 23, 2025
2bf21d5
Update README.md
Roopan-Microsoft Feb 24, 2025
233bf68
Update README.md
Roopan-Microsoft Feb 24, 2025
7c3afcf
Merge branch 'dev' of https://github.com/microsoft/Conversation-Knowl…
Rohini-Microsoft Feb 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
86 changes: 49 additions & 37 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,71 +39,83 @@ The sample data used in this repository is synthetic and generated using Azure O
QUICK DEPLOY
</h2>

[![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)
[![Deploy to Azure](https://aka.ms/deploytoazurebutton)](https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2Fmicrosoft%2FConversation-Knowledge-Mining-Solution-Accelerator%2Fmain%2Finfra%2Fmain.json)
| [![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) | **┃** | [![Deploy to Azure](https://aka.ms/deploytoazurebutton)](https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2Fmicrosoft/Conversation-Knowledge-Mining-Solution-Accelerator%2Fmain%2Finfra%2Fmain.json) |
|---|---|---|---|---|



### **Prerequisites**

To deploy this solution accelerator, you will need access to an [Azure subscription](https://azure.microsoft.com/free/) with permission to create resource groups and resources.
To deploy this solution accelerator, ensure you have access to an [Azure subscription](https://azure.microsoft.com/free/) with the necessary permissions to create **resource groups and resources**.

Please check the link [Azure Products by Region](https://azure.microsoft.com/en-us/explore/global-infrastructure/products-by-region/?products=all&regions=all) and choose a region where Azure AI Foundry, Azure OpenAI Services, Azure AI Search, Azure AI Content Understanding, Embedding Deployment Capacity and GPT Model Capacity are available. Recommended regions are eastus, eastus2.
Check the [Azure Products by Region](https://azure.microsoft.com/en-us/explore/global-infrastructure/products-by-region/?products=all&regions=all) page and select a **region** where the following services are available:

> When you start the deployment using one of the options below, most parameters will have a default name set already. You can update the following settings:
- **Azure AI Foundry**
- **Azure OpenAI Services**
- **Azure AI Search**
- **Azure Semantic Search**
- **Azure AI Content Understanding**
- **Embedding Deployment Capacity**
- **GPT Model Capacity**

- Azure region where the resources will be created in
#### **Recommended Deployment Regions**

- Environment name, a 3-20 characters alphanumeric value that will be used to prefix resources
> ✅ **eastus** (East US)
> ✅ **eastus2** (East US 2)

- Content Understanding location from the drop-down list of values
#### **Configurable Deployment Settings**

- Secondary location, a less busy location for Azure SQL and CosmoDB resources if you run into any availability constraints
When you start the deployment, most parameters will have **default values**, but you can update the following:

- Deployment type from the drop-down list of values
| **Setting** | **Description** |
|------------|----------------|
| **Azure Region** | The region where resources will be created. |
| **Environment Name** | A **3-10 character alphanumeric value** used to prefix resources. |
| **Content Understanding Location** | Select from a **drop-down list** of values. |
| **Secondary Location** | A **less busy** region for **Azure SQL and CosmosDB**, useful in case of availability constraints. |
| **Deployment Type** | Select from a **drop-down list**. |
| **GPT Model** | Choose from **GPT-4, GPT-4o, GPT-4o Mini**. <br> **Default models:** GPT-4o Mini and text-embedding-ada-002. |
| **GPT Model Deployment Capacity** | Configure capacity for **GPT models**. |
| **Embedding Model** | Default: **text-embedding-ada-002**. |
| **Embedding Model Capacity** | Set the capacity for **embedding models**. |

- GPT model from the drop-down list of values

- GPT model deployment capacity (GPT-4, GPT-4o, and GPT-4o Mini)

- Embedding model from the drop-down list of values (text-embedding-ada-002)
---

- Embedding model capacity
### **[Optional] Quota Recommendations**

By default, the **GPT model capacity** in deployment is set to **30k tokens**.

### Checking Resource Availability by Region
#### **Recommended Quota for Optimal Performance**

Before deploying, ensure that the required Azure services are available in your region. Below are links to check service availability:
| **Model Type** | **Default Capacity** | **Recommended Capacity** |
|----------------------|--------------------|--------------------|
| **GPT Model** | 30k tokens | 100k tokens |

- [Azure Products by Region](https://azure.microsoft.com/en-us/explore/global-infrastructure/products-by-region/)
- [Semantic Search Availability](https://learn.microsoft.com/en-us/azure/search/search-region-support)
To adjust quota settings, follow these steps:

## **Steps to Check Semantic Search Availability**
1. Open the [Semantic Search Availability](https://learn.microsoft.com/en-us/azure/search/search-region-support) page.
2. Scroll down to the **"Availability by Region"** section.
3. Use the table to find supported regions for **Azure AI Search** and its **Semantic Search** feature.
4. If your target region is not listed, choose a supported region for deployment.
#### **How to Check & Update Quota**

📌 **Note:** Some features may only be available in specific regions, so ensure compatibility before proceeding.
1. **Navigate** to the [Azure AI Foundry portal](https://portal.azure.com/).
2. **Select** the AI Project associated with this accelerator.
3. **Go to** the `Management Center` from the bottom-left navigation menu.
4. Select `Quota`
- Click on the `GlobalStandard` dropdown.
- Select the required **GPT model** (`GPT-4, GPT-4o, GPT-4o Mini`) or **Embeddings model** (`text-embedding-ada-002`).
- Choose the **region** where the deployment is hosted.
5. Request More Quota or delete any unused model deployments as needed.
<br>

### [Optional]: Quota Recommendations
- The default for the GPT model capacity in deployment is **30k tokens**.
- For optimal performance, it is recommended to increase to **100k tokens**.
- Navigate to the [Azure AI Foundry portal](https://ai.azure.com/)
- Select the AI Project you are using for this accelerator if you are not already in the project.
- Select `Management center` from the bottom left navigation menu
- Select `Quota`, click the `GlobalStandard` dropdown and select the GPT model (`GPT-4 / GPT-4o / GPT-4o mini`) or embeddings model (`text-embedding-ada-002`) and region you are using for this accelerator to see your available quota. Please note `GPT-4o mini` and `text-embedding-ada-002` are used as default.
**⚠️ Warning:** **Insufficient quota can cause deployment issues.** Ensure you have the recommended capacity.

- Request more quota or delete any unused model deployments as needed.

---

### **Options**
Pick from the options below to see step-by-step instructions for: GitHub Codespaces, VS Code Dev Containers, Local Environments, and Bicep deployments.

<details>
<summary><b>Deploy in GitHub Codespaces</b></summary>

### GitHub Codpespaces
### GitHub Codpespaces

You can run this solution accelerator virtually by using GitHub Codespaces. The button will open a web-based VS Code instance in your browser:

Expand Down
Loading