Skip to content

Commit a1aa021

Browse files
VishalS-MicrosoftVishalS-Microsoft
authored
feat: added new paths (#489)
* added new paths * docker file changes
1 parent 055801e commit a1aa021

14 files changed

+75
-75
lines changed

‎docs/AIFoundryDeployment.md

Lines changed: 30 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -4,68 +4,68 @@ Please follow the steps below to configure the Prompt flow endpoint in App servi
44
## Step 1: OpenAI Foundry Project
55
1. Launch the [AI Foundry](https://ai.azure.com/) and select `project` under Jump into a project in Azure AI Foundry, If not found click on View all projects from the top menu.
66

7-
![Home](/ResearchAssistant/Deployment/images/aiStudio/Home.png)
7+
![Home](/docs/images/aiStudio/Home.png)
88

99
2. Click on the project with name `ai_project_{your deployment prefix}`.
1010

1111
## Step 2: Import Prompt Flow and Deploy
1212

1313
1. Click on `PromptFlow` button from left menu under `Build and customize`.
1414

15-
![Prompt Flow](/ResearchAssistant/Deployment/images/aiStudio/PromptFlow.png)
15+
![Prompt Flow](/docs/images/aiStudio/PromptFlow.png)
1616

1717
2. Click on `Create` button. Then click on `Upload` button from `Upload From Local` option from the last row.
1818

19-
![Upload](/ResearchAssistant/Deployment/images/aiStudio/UploadFromLocal.png)
19+
![Upload](/docs/images/aiStudio/UploadFromLocal.png)
2020

21-
3. Click on `Zip File` radio button. Then click on `Browse` to select the file `DraftFlow.zip` from the cloned/downloaded GitHub repository folder. The file will be located at `<Your Download Folder Path>/ResearchAssistant/Deployment/scripts/ai_hub_scripts/flows/`.
21+
3. Click on `Zip File` radio button. Then click on `Browse` to select the file `DraftFlow.zip` from the cloned/downloaded GitHub repository folder. The file will be located at `<Your Download Folder Path>/infra/scripts/aihub_scripts/flows/`.
2222

23-
![Select Local File](/ResearchAssistant/Deployment/images/aiStudio/SelectLocalFile.png)
23+
![Select Local File](/docs/images/aiStudio/SelectLocalFile.png)
2424

2525
4. Once the DraftFlow.zip file is uploaded, change folder name to `DraftFlow` and Select Flow type as `Chat Flow` and click on `Upload` button.
2626

27-
![Upload Local File](/ResearchAssistant/Deployment/images/aiStudio/UploadLocalFile.png)
27+
![Upload Local File](/docs/images/aiStudio/UploadLocalFile.png)
2828

2929

3030
5. Click on `Start compute session` and click on `Start compute session` from the drop-down list. It can take few minutes for the runtime to start.
3131

32-
![Select Runtime](/ResearchAssistant/Deployment/images/aiStudio/SelectRunTime.png)
32+
![Select Runtime](/docs/images/aiStudio/SelectRunTime.png)
3333

3434
6. Click on `Deploy` button once it is enabled. Enter a unique name for Endpoint Name field.
3535
>IMPORTANT: This name has to be unique across all endpoints in your Azure subscription.
3636
3737
You can leave the Deployment name, Virtual machine type, and Instace count as populated and click on `Review + Create`. Optionally you can choose a different VM type/size and increase/decrease the Instance count as needed. Then review details and click on `Create` in the next screen.
3838

39-
![Deploy Draft Flow](/ResearchAssistant/Deployment/images/aiStudio/DeployDraftFlow.png)
39+
![Deploy Draft Flow](/docs/images/aiStudio/DeployDraftFlow.png)
4040

4141
7. It will take few minutes for the flow to be validated and deployed. Click on `Models + endpoints` from left menu. You might only see the Default_AzureOpenAI deployments in the page until the deployment is completed. Please wait and click on `Refresh` after few minutes.
4242

43-
![Deployments Page](/ResearchAssistant/Deployment/images/aiStudio/BlankDeploymentsPage.png)
43+
![Deployments Page](/docs/images/aiStudio/BlankDeploymentsPage.png)
4444

4545

4646
8. Click on the deployed endpoint with name `ai-project-bycra-jzxzb-1`.
47-
![Drafts Endpoint](/ResearchAssistant/Deployment/images/aiStudio/DraftsEndpoint.png)
47+
![Drafts Endpoint](/docs/images/aiStudio/DraftsEndpoint.png)
4848

4949
9. Click on `Consume` from the top menu. Copy below details to use later in step 3.6.
5050
- Deployment
5151
- REST endpoint
5252
- Primary key
5353

54-
![Drafts Endpoint Consume](/ResearchAssistant/Deployment/images/aiStudio/DraftsEndpointConsume.png)
54+
![Drafts Endpoint Consume](/docs/images/aiStudio/DraftsEndpointConsume.png)
5555

5656
## Step 3: Update the deployment keys in Azure App Service configuration
5757
1. Launch the Azure Portal [Azure Portal](https://portal.azure.com/).
5858
2. Enter `Resource Groups` in the top search bar.
5959

60-
![Search Resource Groups](/ResearchAssistant/Deployment/images/aiStudio/AzurePortalResourceGroups.png)
60+
![Search Resource Groups](/docs/images/aiStudio/AzurePortalResourceGroups.png)
6161

6262
3. Locate your Resource Group you selected/created during one-click deployment and click on it.
6363

6464
4. Locate the App Service in the Resource Group and click on it.
6565

6666
5. Click on `Environment Variables` from left menu under `Settings`.
6767

68-
![Application Environment Variables](/ResearchAssistant/Deployment/images/aiStudio/AppEnvironmentVariables.png)
68+
![Application Environment Variables](/docs/images/aiStudio/AppEnvironmentVariables.png)
6969

7070
6. Modify the below variables with values collected in step 2.9 above.
7171
- AI_STUDIO_DRAFT_FLOW_ENDPOINT
@@ -74,64 +74,64 @@ Please follow the steps below to configure the Prompt flow endpoint in App servi
7474

7575
7. Click on `Apply` button at the bottom of the screen. Then click on `Confirm` in the pop-up.
7676

77-
![Application Environment Variables Confirm](/ResearchAssistant/Deployment/images/aiStudio/AppEnvironmentVariablesConfirm.png)
77+
![Application Environment Variables Confirm](/docs/images/aiStudio/AppEnvironmentVariablesConfirm.png)
7878

7979
8. Click on `Overview` from the left menu. Then click on `Restart` button in the top menu. Then click on `Yes` in the pop-up message.
8080

81-
![Application Restart](/ResearchAssistant/Deployment/images/aiStudio/AppServiceRestart.png)
81+
![Application Restart](/docs/images/aiStudio/AppServiceRestart.png)
8282

8383

8484
## Step 4: Add Authentication in Azure App Service configuration
8585

8686
1. Click on `Authentication` from left menu.
8787

88-
![Authentication](/ResearchAssistant/Deployment/images/aiStudio/AppAuthentication.png)
88+
![Authentication](/docs/images/aiStudio/AppAuthentication.png)
8989

9090
2. Click on `+ Add Provider` to see a list of identity providers.
9191

92-
![Authentication Identity](/ResearchAssistant/Deployment/images/aiStudio/AppAuthenticationIdentity.png)
92+
![Authentication Identity](/docs/images/aiStudio/AppAuthenticationIdentity.png)
9393

9494
3. Click on `+ Add Provider` to see a list of identity providers.
9595

96-
![Add Provider](/ResearchAssistant/Deployment/images/aiStudio/AppAuthIdentityProvider.png)
96+
![Add Provider](/docs/images/aiStudio/AppAuthIdentityProvider.png)
9797

98-
4. Select the first option `Microsoft Entra Id` from the drop-down list. If `Create new app registration` is disabled, go to [Step 4a](https://github.com/microsoft/Build-your-own-AI-Assistant-Solution-Accelerator/blob/PSL-Authenticate-Doc/ResearchAssistant/Deployment/AIStudioDeployment.md#step-4a-creating-a-new-app-registration)
98+
4. Select the first option `Microsoft Entra Id` from the drop-down list. If `Create new app registration` is disabled, go to [Step 4a](https://github.com/microsoft/Build-your-own-AI-Assistant-Solution-Accelerator/blob/PSL-Authenticate-Doc/docs/AIStudioDeployment.md#step-4a-creating-a-new-app-registration)
9999

100-
![Add Provider](/ResearchAssistant/Deployment/images/aiStudio/AppAuthIdentityProviderAdd.png)
100+
![Add Provider](/docs/images/aiStudio/AppAuthIdentityProviderAdd.png)
101101

102102
5. Accept the default values and click on `Add` button to go back to the previous page with the identify provider added.
103103

104-
![Add Provider](/ResearchAssistant/Deployment/images/aiStudio/AppAuthIdentityProviderAdded.png)
104+
![Add Provider](/docs/images/aiStudio/AppAuthIdentityProviderAdded.png)
105105

106106
### Step 4a: Creating a new App Registration
107107
1. Click on `Home` and select `Microsoft Entra ID`.
108108

109-
![Microsoft Entra ID](/ResearchAssistant/Deployment/images/aiStudio/MicrosoftEntraID.png)
109+
![Microsoft Entra ID](/docs/images/aiStudio/MicrosoftEntraID.png)
110110

111111
2. Click on `App registrations`.
112112

113-
![App registrations](/ResearchAssistant/Deployment/images/aiStudio/Appregistrations.png)
113+
![App registrations](/docs/images/aiStudio/Appregistrations.png)
114114

115115
3. Click on `+ New registration`.
116116

117-
![New Registrations](/ResearchAssistant/Deployment/images/aiStudio/NewRegistration.png)
117+
![New Registrations](/docs/images/aiStudio/NewProject.png)
118118

119119
4. Provide the `Name`, select supported account types as `Accounts in this organizational directory only(Contoso only - Single tenant)`, select platform as `Web`, enter/select the `URL` and register.
120120

121-
![Add Details](/ResearchAssistant/Deployment/images/aiStudio/AddDetails.png)
121+
![Add Details](/docs/images/aiStudio/AddDetails.png)
122122

123123
5. After application is created sucessfully, then click on `Add a Redirect URL`.
124124

125-
![Redirect URL](/ResearchAssistant/Deployment/images/aiStudio/AddRedirectURL.png)
125+
![Redirect URL](/docs/images/aiStudio/AddRedirectURL.png)
126126

127127
6. Click on `+ Add a platform`.
128128

129-
![+ Add platform](/ResearchAssistant/Deployment/images/aiStudio/AddPlatform.png)
129+
![+ Add platform](/docs/images/aiStudio/AddPlatform.png)
130130

131131
7. Click on `Web`.
132132

133-
![Web](/ResearchAssistant/Deployment/images/aiStudio/Web.png)
133+
![Web](/docs/images/aiStudio/Web.png)
134134

135-
8. Enter the `web app URL` (Provide the app service name in place of XXXX) and Save. Then go back to [Step 4](https://github.com/microsoft/Build-your-own-AI-Assistant-Solution-Accelerator/blob/PSL-Authenticate-Doc/ResearchAssistant/Deployment/AIStudioDeployment.md#step-4-add-authentication-in-azure-app-service-configuration) and follow from _Point 4_ choose `Pick an existing app registration in this directory` from the Add an Identity Provider page and provide the newly registered App Name.
135+
8. Enter the `web app URL` (Provide the app service name in place of XXXX) and Save. Then go back to [Step 4](https://github.com/microsoft/Build-your-own-AI-Assistant-Solution-Accelerator/blob/PSL-Authenticate-Doc/docs/AIStudioDeployment.md#step-4-add-authentication-in-azure-app-service-configuration) and follow from _Point 4_ choose `Pick an existing app registration in this directory` from the Add an Identity Provider page and provide the newly registered App Name.
136136

137-
![Add Details](/ResearchAssistant/Deployment/images/aiStudio/WebAppURL.png)
137+
![Add Details](/docs/images/aiStudio/WebAppURL.png)

‎docs/FabricDeployment.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,22 +3,22 @@ Please follow the steps below to set up the Fabric Workspace and collect the id
33

44
1. Launch Microsoft Fabric Data Engineering experience [Data Engineering](https://app.fabric.microsoft.com/home?experience=data-engineering).
55
2. Click on `Workspaces` from the left menu and click on `New Workspace` at the bottom of the menu.
6-
![Create Workspace](/ResearchAssistant/Deployment/images/fabric/workspaces.png)
6+
![Create Workspace](/docs/images/fabric/workspaces.png)
77

88
3. Enter a Workspace Name and click on `Apply`.
9-
![New Workspace](/ResearchAssistant/Deployment/images/fabric/CreateWorkspace.png)
9+
![New Workspace](/docs/images/fabric/CreateWorkspace.png)
1010

1111
4. On the next page, click on `Import`.
12-
![Create Workspace](/ResearchAssistant/Deployment/images/fabric/WorkspaceGuid.png)
12+
![Create Workspace](/docs/images/fabric/WorkspaceGuid.png)
1313

1414
5. Click on `Notebook`.
1515

16-
![Create Workspace](/ResearchAssistant/Deployment/images/fabric/ImportNotebooks.png)
16+
![Create Workspace](/docs/images/fabric/ImportNotebooks.png)
1717

18-
5. Navigate to the local folder where you cloned/downloaded this repository and select notebooks shown in screenshot from path `<Your Download Folder Path>/ResearchAssistant/Deployment/scripts/fabric_scripts/`.
19-
![Create Workspace](/ResearchAssistant/Deployment/images/fabric/SelectNotebooks.png)
18+
5. Navigate to the local folder where you cloned/downloaded this repository and select notebooks shown in screenshot from path `<Your Download Folder Path>/infra/scripts/fabric_scripts/`.
19+
![Create Workspace](/docs/images/fabric/SelectNotebooks.png)
2020

2121
6. Downloaded Notebooks appear in the workspace.
22-
![Create Workspace](/ResearchAssistant/Deployment/images/fabric/Notebooks.png)
22+
![Create Workspace](/blob/byoc-researcher/docs/images/fabric/Notebooks.png)
2323

2424
7. You can Click on each notebook to see the code. These notebooks can be scheduled to run periodically if you plan to upload new documents to the storage account.

‎docs/PromptFlowEvaluation.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -17,34 +17,34 @@ In prompt flow, you can customize or create your own evaluation flow and metrics
1717

1818

1919
2. Locate your AI project under recent projects.
20-
![image1](/ResearchAssistant/Deployment/images/evaluation/image1.png)
20+
![image1](/docs/images/evaluation/image1.png)
2121

2222
2323
3. Once inside your project, select Evaluation from the left dropdown menu.
24-
![image2](/ResearchAssistant/Deployment/images/evaluation/image2.png)
24+
![image2](/docs/images/evaluation/image2.png)
2525

2626

2727
4. From your Evaluation view, select New evaluation in the middle of the page.
28-
![imag3](/ResearchAssistant/Deployment/images/evaluation/image3.png)
28+
![imag3](/docs/images/evaluation/image3.png)
2929

3030
5. From here you can create, name a new evaluation and select your scenario.
31-
![image4](/ResearchAssistant/Deployment/images/evaluation/image4.png)
31+
![image4](/docs/images/evaluation/image4.png)
3232
6. Select the flow you want to evaluate. (To evaluate the DraftFlow select DraftFlow here)
33-
![image5](/ResearchAssistant/Deployment/images/evaluation/image5.png)
33+
![image5](/docs/images/evaluation/image5.png)
3434
7. Select metrics you would like to use. Also, be sure to select an active Connection and active Deployment name/Model.
35-
![image6](/ResearchAssistant/Deployment/images/evaluation/image6.png)
35+
![image6](/docs/images/evaluation/image6.png)
3636
8. Use an existing dataset or upload a dataset to use in evaluation. (Upload the provided dataset found in \Deployment\data\EvaluationDataset.csv)
37-
![image7](/ResearchAssistant/Deployment/images/evaluation/image7.png)
37+
![image7](/docs/images/evaluation/image7.png)
3838

3939
9. Lastly, map the inputs from your dataset and click submit.
40-
![image8](/ResearchAssistant/Deployment/images/evaluation/image8.png)
40+
![image8](/docs/images/evaluation/image8.png)
4141

4242

4343
### Results
4444

4545
Once the flow has been ran successfully, the metrics will be displayed showing a 1-5 score of each respective metric. From here, you can click into the evaluation flow to get a better understanding of the scores.
46-
![image9](/ResearchAssistant/Deployment/images/evaluation/image9.png)
47-
![image10](/ResearchAssistant/Deployment/images/evaluation/image10.png)
46+
![image9](/docs/images/evaluation/image9.png)
47+
![image10](/docs/images/evaluation/image10.png)
4848

4949

5050

‎docs/PromptFlowSafetyEvaluation.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Safety Evaluation Flow Guide
22
Please follow the steps below to generate Adversarial data and set up the evaluation flow.
33

4-
1. Open the notebook `simulate_and_evaluate_flow.ipynb` in path `<Your Download Folder Path>/ResearchAssistant/Deployment/scripts/evaluation_scripts/` in Visual Studio Code or your choice of notebook editor.
4+
1. Open the notebook `simulate_and_evaluate_flow.ipynb` in path `<Your Download Folder Path>//infra/scripts/evaluation_scripts/` in Visual Studio Code or your choice of notebook editor.
55

66
2. Update the parameters like Key Vault Name, AI Studio Project Name and AI Studio Deployment URL, Key and Name parameters and run all the cells in the notebook.
77

@@ -11,7 +11,7 @@ Please follow the steps below to generate Adversarial data and set up the evalua
1111

1212
5. Click on the flow created from the notebook to see the results.
1313

14-
![Evaluation Results](/ResearchAssistant/Deployment/images/evaluation/safety_evaluation.png)
14+
![Evaluation Results](/docs/images/evaluation/safety_evaluation.png)
1515

1616

1717

‎infra/bicep/deploy_aihub_scripts.bicep

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ resource create_index 'Microsoft.Resources/deploymentScripts@2020-10-01' = {
2020
}
2121
properties: {
2222
azCliVersion: '2.52.0'
23-
primaryScriptUri: '${baseUrl}ResearchAssistant/Deployment/scripts/run_create_aihub_scripts.sh'
23+
primaryScriptUri: '${baseUrl}infra/scripts/run_create_aihub_scripts.sh'
2424
arguments: '${baseUrl} ${keyVaultName} ${solutionName} ${resourceGroupName} ${subscriptionId} ${solutionLocation}' // Specify any arguments for the script
2525
timeout: 'PT1H' // Specify the desired timeout duration
2626
retentionInterval: 'PT1H' // Specify the desired retention interval

‎infra/bicep/deploy_fabric_scripts.bicep

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ resource create_index 'Microsoft.Resources/deploymentScripts@2020-10-01' = {
1818
}
1919
properties: {
2020
azCliVersion: '2.52.0'
21-
primaryScriptUri: '${baseUrl}ResearchAssistant/Deployment/scripts/run_fabric_items_scripts.sh'
21+
primaryScriptUri: '${baseUrl}infra/scripts/run_fabric_items_scripts.sh'
2222
arguments: '${baseUrl} ${keyVaultName} ${fabricWorkspaceId}' // Specify any arguments for the script
2323
timeout: 'PT1H' // Specify the desired timeout duration
2424
retentionInterval: 'PT1H' // Specify the desired retention interval

‎infra/bicep/deploy_index_scripts.bicep

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ resource create_index 'Microsoft.Resources/deploymentScripts@2020-10-01' = {
1717
}
1818
properties: {
1919
azCliVersion: '2.52.0'
20-
primaryScriptUri: '${baseUrl}ResearchAssistant/Deployment/scripts/run_create_index_scripts.sh'
20+
primaryScriptUri: '${baseUrl}infra/scripts/run_create_index_scripts.sh'
2121
arguments: '${baseUrl} ${keyVaultName}' // Specify any arguments for the script
2222
timeout: 'PT1H' // Specify the desired timeout duration
2323
retentionInterval: 'PT1H' // Specify the desired retention interval

‎infra/bicep/deploy_upload_files_script.bicep

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ resource copy_demo_Data 'Microsoft.Resources/deploymentScripts@2020-10-01' = {
1919
}
2020
properties: {
2121
azCliVersion: '2.50.0'
22-
primaryScriptUri: '${baseUrl}ResearchAssistant/Deployment/scripts/copy_kb_files.sh' // deploy-azure-synapse-pipelines.sh
22+
primaryScriptUri: '${baseUrl}infra/scripts/copy_kb_files.sh' // deploy-azure-synapse-pipelines.sh
2323
arguments: '${storageAccountName} ${containerName} ${baseUrl}' // Specify any arguments for the script
2424
timeout: 'PT1H' // Specify the desired timeout duration
2525
retentionInterval: 'PT1H' // Specify the desired retention interval

‎infra/bicep/main.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -634,7 +634,7 @@
634634
},
635635
"properties": {
636636
"azCliVersion": "2.50.0",
637-
"primaryScriptUri": "[format('{0}ResearchAssistant/Deployment/scripts/copy_kb_files.sh', parameters('baseUrl'))]",
637+
"primaryScriptUri": "[format('{0}infra/scripts/copy_kb_files.sh', parameters('baseUrl'))]",
638638
"arguments": "[format('{0} {1} {2}', parameters('storageAccountName'), parameters('containerName'), parameters('baseUrl'))]",
639639
"timeout": "PT1H",
640640
"retentionInterval": "PT1H",
@@ -1223,7 +1223,7 @@
12231223
},
12241224
"properties": {
12251225
"azCliVersion": "2.52.0",
1226-
"primaryScriptUri": "[format('{0}ResearchAssistant/Deployment/scripts/run_create_index_scripts.sh', parameters('baseUrl'))]",
1226+
"primaryScriptUri": "[format('{0}infra/scripts/run_create_index_scripts.sh', parameters('baseUrl'))]",
12271227
"arguments": "[format('{0} {1}', parameters('baseUrl'), parameters('keyVaultName'))]",
12281228
"timeout": "PT1H",
12291229
"retentionInterval": "PT1H",
@@ -1321,7 +1321,7 @@
13211321
},
13221322
"properties": {
13231323
"azCliVersion": "2.52.0",
1324-
"primaryScriptUri": "[format('{0}ResearchAssistant/Deployment/scripts/run_create_aihub_scripts.sh', parameters('baseUrl'))]",
1324+
"primaryScriptUri": "[format('{0}infra/scripts/run_create_aihub_scripts.sh', parameters('baseUrl'))]",
13251325
"arguments": "[format('{0} {1} {2} {3} {4} {5}', parameters('baseUrl'), parameters('keyVaultName'), parameters('solutionName'), parameters('resourceGroupName'), parameters('subscriptionId'), parameters('solutionLocation'))]",
13261326
"timeout": "PT1H",
13271327
"retentionInterval": "PT1H",

‎infra/scripts/copy_kb_files.sh

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,15 @@ baseUrl="$3"
77

88
zipFileName1="demodata1.zip"
99
extractedFolder1="demodata"
10-
zipUrl1=${baseUrl}"ResearchAssistant/Deployment/data/demodata1.zip"
10+
zipUrl1=${baseUrl}"infra/data/demodata1.zip"
1111

1212
zipFileName2="demodata2.zip"
1313
extractedFolder2="demodata2"
14-
zipUrl2=${baseUrl}"ResearchAssistant/Deployment/data/demodata2.zip"
14+
zipUrl2=${baseUrl}"infra/data/demodata2.zip"
1515

1616
zipFileName3="demodata3.zip"
1717
extractedFolder3="demodata3"
18-
zipUrl3=${baseUrl}"ResearchAssistant/Deployment/data/demodata3.zip"
18+
zipUrl3=${baseUrl}"infra/data/demodata3.zip"
1919

2020

2121
# Download the zip file

0 commit comments

Comments
 (0)