Skip to content

Commit ec1b178

Browse files
committed
update quote
1 parent 75ecf36 commit ec1b178

File tree

2 files changed

+73
-58
lines changed

2 files changed

+73
-58
lines changed

documentation/DeploymentGuide.md

Lines changed: 72 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ This will allow the scripts to run for the current session without permanently c
3131
Pick from the options below to see step-by-step instructions for GitHub Codespaces, VS Code Dev Containers, Local Environments, and Bicep deployments.
3232

3333
| [![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/microsoft/Multi-Agent-Custom-Automation-Engine-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/Multi-Agent-Custom-Automation-Engine-Solution-Accelerator) |
34-
|---|---|
34+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
3535

3636
<details>
3737
<summary><b>Deploy in GitHub Codespaces</b></summary>
@@ -42,7 +42,7 @@ You can run this solution using GitHub Codespaces. The button will open a web-ba
4242

4343
1. Open the solution accelerator (this may take several minutes):
4444

45-
[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/microsoft/Multi-Agent-Custom-Automation-Engine-Solution-Accelerator)
45+
[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/microsoft/Multi-Agent-Custom-Automation-Engine-Solution-Accelerator)
4646

4747
2. Accept the default values on the create Codespaces page.
4848
3. Open a terminal window if it is not already open.
@@ -60,7 +60,7 @@ You can run this solution in VS Code Dev Containers, which will open the project
6060
1. Start Docker Desktop (install it if not already installed).
6161
2. Open the project:
6262

63-
[![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/Multi-Agent-Custom-Automation-Engine-Solution-Accelerator)
63+
[![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/Multi-Agent-Custom-Automation-Engine-Solution-Accelerator)
6464

6565
3. In the VS Code window that opens, once the project files show up (this may take several minutes), open a terminal window.
6666
4. Continue with the [deploying steps](#deploying-with-azd).
@@ -75,17 +75,18 @@ You can run this solution in VS Code Dev Containers, which will open the project
7575
If you're not using one of the above options for opening the project, then you'll need to:
7676

7777
1. Make sure the following tools are installed:
78-
- [PowerShell](https://learn.microsoft.com/en-us/powershell/scripting/install/installing-powershell?view=powershell-7.5) <small>(v7.0+)</small> - available for Windows, macOS, and Linux.
79-
- [Azure Developer CLI (azd)](https://aka.ms/install-azd)
80-
- [Python 3.9+](https://www.python.org/downloads/)
81-
- [Docker Desktop](https://www.docker.com/products/docker-desktop/)
82-
- [Git](https://git-scm.com/downloads)
78+
79+
- [PowerShell](https://learn.microsoft.com/en-us/powershell/scripting/install/installing-powershell?view=powershell-7.5) <small>(v7.0+)</small> - available for Windows, macOS, and Linux.
80+
- [Azure Developer CLI (azd)](https://aka.ms/install-azd)
81+
- [Python 3.9+](https://www.python.org/downloads/)
82+
- [Docker Desktop](https://www.docker.com/products/docker-desktop/)
83+
- [Git](https://git-scm.com/downloads)
8384

8485
2. Clone the repository or download the project code via command-line:
8586

86-
```shell
87-
azd init -t microsoft/Multi-Agent-Custom-Automation-Engine-Solution-Accelerator/
88-
```
87+
```shell
88+
azd init -t microsoft/Multi-Agent-Custom-Automation-Engine-Solution-Accelerator/
89+
```
8990

9091
3. Open the project folder in your terminal or editor.
9192
4. Continue with the [deploying steps](#deploying-with-azd).
@@ -101,20 +102,21 @@ Consider the following settings during your deployment to modify specific settin
101102

102103
When you start the deployment, most parameters will have **default values**, but you can update the following settings:
103104

104-
| **Setting** | **Description** | **Default value** |
105-
|-------------|-----------------|-------------------|
106-
| **Azure Region** | The region where resources will be created. | East US |
107-
| **Secondary Location** | A **less busy** region for **Azure Cosmos DB**, useful in case of availability constraints. | eastus2 |
108-
| **Deployment Type** | Select from a drop-down list. | GlobalStandard |
109-
| **GPT Model** | Choose from **gpt-4, gpt-4o, gpt-4o-mini**. | gpt-4o |
110-
| **GPT Model Deployment Capacity** | Configure capacity for **GPT models**. | 100k |
105+
| **Setting** | **Description** | **Default value** |
106+
| --------------------------------- | ------------------------------------------------------------------------------------------- | ----------------- |
107+
| **Azure Region** | The region where resources will be created. | East US |
108+
| **Secondary Location** | A **less busy** region for **Azure Cosmos DB**, useful in case of availability constraints. | eastus2 |
109+
| **Deployment Type** | Select from a drop-down list. | GlobalStandard |
110+
| **GPT Model** | Choose from **gpt-4, gpt-4o, gpt-4o-mini**. | gpt-4o |
111+
| **GPT Model Deployment Capacity** | Configure capacity for **GPT models**. | 100k |
111112

112113
</details>
113114

114115
<details>
115116
<summary><b>[Optional] Quota Recommendations</b></summary>
116117

117-
By default, the **GPT model capacity** in deployment is set to **30k tokens**.
118+
By default, the **GPT model capacity** in deployment is set to **140k tokens**.
119+
118120
> **We recommend increasing the capacity to 100k tokens for optimal performance.**
119121
120122
To adjust quota settings, follow these [steps](./AzureGPTQuotaSettings.md).
@@ -129,26 +131,27 @@ Once you've opened the project in [Codespaces](#github-codespaces), [Dev Contain
129131

130132
1. Login to Azure:
131133

132-
```shell
133-
azd auth login
134-
```
134+
```shell
135+
azd auth login
136+
```
135137

136-
#### To authenticate with Azure Developer CLI (`azd`), use the following command with your **Tenant ID**:
138+
#### To authenticate with Azure Developer CLI (`azd`), use the following command with your **Tenant ID**:
137139

138-
```sh
139-
azd auth login --tenant-id <tenant-id>
140-
```
140+
```sh
141+
azd auth login --tenant-id <tenant-id>
142+
```
141143

142144
2. Provision and deploy all the resources:
143145

144-
```shell
145-
azd up
146-
```
146+
```shell
147+
azd up
148+
```
147149

148150
3. Provide an `azd` environment name (e.g., "macaeapp").
149-
4. Select a subscription from your Azure account and choose a location that has quota for all the resources.
150-
- This deployment will take *4-6 minutes* to provision the resources in your account and set up the solution with sample data.
151-
- If you encounter an error or timeout during deployment, changing the location may help, as there could be availability constraints for the resources.
151+
4. Select a subscription from your Azure account and choose a location that has quota for all the resources.
152+
153+
- This deployment will take _4-6 minutes_ to provision the resources in your account and set up the solution with sample data.
154+
- If you encounter an error or timeout during deployment, changing the location may help, as there could be availability constraints for the resources.
152155

153156
5. Once the deployment has completed successfully, open the [Azure Portal](https://portal.azure.com/), go to the deployed resource group, find the App Service, and get the app URL from `Default domain`.
154157

@@ -161,6 +164,7 @@ If you need to rebuild the source code and push the updated container to the dep
161164
1. Set the environment variable `USE_LOCAL_BUILD` to `True`:
162165

163166
- **Linux/macOS**:
167+
164168
```bash
165169
export USE_LOCAL_BUILD=True
166170
```
@@ -169,7 +173,9 @@ If you need to rebuild the source code and push the updated container to the dep
169173
```powershell
170174
$env:USE_LOCAL_BUILD = $true
171175
```
176+
172177
2. Run the `az login` command
178+
173179
```bash
174180
az login
175181
```
@@ -195,16 +201,16 @@ The easiest way to run this accelerator is in a VS Code Dev Containers, which wi
195201

196202
1. Start Docker Desktop (install it if not already installed)
197203
1. Open the project:
198-
[![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/Multi-Agent-Custom-Automation-Engine-Solution-Accelerator)
204+
[![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/Multi-Agent-Custom-Automation-Engine-Solution-Accelerator)
199205

200206
1. In the VS Code window that opens, once the project files show up (this may take several minutes), open a terminal window
201207

202208
## Detailed Development Container setup instructions
203209

204210
The solution contains a [development container](https://code.visualstudio.com/docs/remote/containers) with all the required tooling to develop and deploy the accelerator. To deploy the Chat With Your Data accelerator using the provided development container you will also need:
205211

206-
* [Visual Studio Code](https://code.visualstudio.com)
207-
* [Remote containers extension for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers)
212+
- [Visual Studio Code](https://code.visualstudio.com)
213+
- [Remote containers extension for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers)
208214

209215
If you are running this on Windows, we recommend you clone this repository in [WSL](https://code.visualstudio.com/docs/remote/wsl)
210216

@@ -219,7 +225,7 @@ code .
219225
```
220226

221227
!!! tip
222-
Visual Studio Code should recognize the available development container and ask you to open the folder using it. For additional details on connecting to remote containers, please see the [Open an existing folder in a container](https://code.visualstudio.com/docs/remote/containers#_quick-start-open-an-existing-folder-in-a-container) quickstart.
228+
Visual Studio Code should recognize the available development container and ask you to open the folder using it. For additional details on connecting to remote containers, please see the [Open an existing folder in a container](https://code.visualstudio.com/docs/remote/containers#_quick-start-open-an-existing-folder-in-a-container) quickstart.
223229

224230
When you start the development container for the first time, the container will be built. This usually takes a few minutes. **Please use the development container for all further steps.**
225231

@@ -258,58 +264,67 @@ The files for the dev container are located in `/.devcontainer/` folder.
258264
az deployment group create -g <resource-group-name> -f deploy/macae-dev.bicep --query 'properties.outputs'
259265
```
260266
- **Note**: You will be prompted for a `principalId`, which is the ObjectID of your user in Entra ID. To find it, use the Azure Portal or run:
267+
261268
```bash
262269
az ad signed-in-user show --query id -o tsv
263270
```
264-
You will also be prompted for locations for Cosmos and OpenAI services. This is to allow separate regions where there may be service quota restrictions.
271+
272+
You will also be prompted for locations for Cosmos and OpenAI services. This is to allow separate regions where there may be service quota restrictions.
265273
266274
- **Additional Notes**:
267275
268276
**Role Assignments in Bicep Deployment:**
269-
270-
The **macae-dev.bicep** deployment includes the assignment of the appropriate roles to AOAI and Cosmos services. If you want to modify an existing implementation—for example, to use resources deployed as part of the simple deployment for local debugging—you will need to add your own credentials to access the Cosmos and AOAI services. You can add these permissions using the following commands:
277+
278+
The **macae-dev.bicep** deployment includes the assignment of the appropriate roles to AOAI and Cosmos services. If you want to modify an existing implementation—for example, to use resources deployed as part of the simple deployment for local debugging—you will need to add your own credentials to access the Cosmos and AOAI services. You can add these permissions using the following commands:
279+
271280
```bash
272281
az cosmosdb sql role assignment create --resource-group <solution-accelerator-rg> --account-name <cosmos-db-account-name> --role-definition-name "Cosmos DB Built-in Data Contributor" --principal-id <aad-user-object-id> --scope /subscriptions/<subscription-id>/resourceGroups/<solution-accelerator-rg>/providers/Microsoft.DocumentDB/databaseAccounts/<cosmos-db-account-name>
273282
```
274283
275284
```bash
276285
az role assignment create --assignee <aad-user-upn> --role "Cognitive Services OpenAI User" --scope /subscriptions/<subscription-id>/resourceGroups/<solution-accelerator-rg>/providers/Microsoft.CognitiveServices/accounts/<azure-openai-account-name>
277286
```
278-
**Using a Different Database in Cosmos:**
279287
280-
You can set the solution up to use a different database in Cosmos. For example, you can name it something like macae-dev. To do this:
281-
1. Change the environment variable **COSMOSDB_DATABASE** to the new database name.
282-
2. You will need to create the database in the Cosmos DB account. You can do this from the Data Explorer pane in the portal, click on the drop down labeled "_+ New Container_" and provide all the necessary details.
288+
**Using a Different Database in Cosmos:**
289+
290+
You can set the solution up to use a different database in Cosmos. For example, you can name it something like macae-dev. To do this:
283291
284-
6. **Create a `.env` file:**
292+
1. Change the environment variable **COSMOSDB_DATABASE** to the new database name.
293+
2. You will need to create the database in the Cosmos DB account. You can do this from the Data Explorer pane in the portal, click on the drop down labeled "_+ New Container_" and provide all the necessary details.
294+
295+
5. **Create a `.env` file:**
285296
286297
- Navigate to the `src` folder and create a `.env` file based on the provided `.env.sample` file.
287298
288-
7. **Fill in the `.env` file:**
299+
6. **Fill in the `.env` file:**
289300
290301
- Use the output from the deployment or check the Azure Portal under "Deployments" in the resource group.
291302
292-
8. **(Optional) Set up a virtual environment:**
303+
7. **(Optional) Set up a virtual environment:**
293304
294305
- If you are using `venv`, create and activate your virtual environment for both the frontend and backend folders.
295306
296-
9. **Install requirements - frontend:**
307+
8. **Install requirements - frontend:**
297308
298309
- In each of the frontend and backend folders -
299310
Open a terminal in the `src` folder and run:
300311
```bash
301312
pip install -r requirements.txt
302313
```
303314
304-
10. **Run the application:**
305-
- From the src/backend directory:
306-
```bash
307-
python app.py
308-
```
309-
- In a new terminal from the src/frontend directory
310-
```bash
311-
python frontend_server.py
312-
```
315+
9. **Run the application:**
316+
317+
- From the src/backend directory:
318+
319+
```bash
320+
python app.py
321+
```
322+
323+
- In a new terminal from the src/frontend directory
324+
325+
```bash
326+
python frontend_server.py
327+
```
313328
314329
10. Open a browser and navigate to `http://localhost:3000`
315330
11. To see swagger API documentation, you can navigate to `http://localhost:8000/docs`
@@ -329,6 +344,7 @@ You can debug the API backend running locally with VSCode using the following la
329344
"jinja": true
330345
}
331346
```
347+
332348
To debug the python server in the frontend directory (frontend_server.py) and related, add the following launch.json entry:
333349
334350
```
@@ -342,4 +358,3 @@ To debug the python server in the frontend directory (frontend_server.py) and re
342358
"jinja": true
343359
}
344360
```
345-

infra/main.bicep

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ param resourceSize {
5656
maxReplicas: 1
5757
}
5858
}
59-
param capacity int = 40
59+
param capacity int = 140
6060

6161
var modelVersion = '2024-08-06'
6262
var aiServicesName = '${prefix}-aiservices'

0 commit comments

Comments
 (0)