Skip to content

docs: Updated changes in README.md, AIStudioDeployment.md and FabricDeployment.md #296

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.

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
merged 9 commits into from
Jan 31, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
# AI Studio Deployment Guide
# AI Foundry Deployment Guide
Please follow the steps below to configure the Prompt flow endpoint in App service configuration.

## Step 1: Open AI Studio Project
1. Launch the [AI Studio](https://ai.azure.com/) and select `Build` from the top menu.
## Step 1: OpenAI Foundry Project
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.

![Home](/ResearchAssistant/Deployment/images/aiStudio/Home.png)

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

## Step 2: Import Prompt Flow and Deploy

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

![Prompt Flow](/ResearchAssistant/Deployment/images/aiStudio/PromptFlow.png)

Expand All @@ -27,7 +27,7 @@ Please follow the steps below to configure the Prompt flow endpoint in App servi
![Upload Local File](/ResearchAssistant/Deployment/images/aiStudio/UploadLocalFile.png)


5. Click on `Select runtime` and chick on `Start` from the drop-down list. It can take few minutes for the runtime to start.
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.

![Select Runtime](/ResearchAssistant/Deployment/images/aiStudio/SelectRunTime.png)

Expand All @@ -38,12 +38,12 @@ Please follow the steps below to configure the Prompt flow endpoint in App servi

![Deploy Draft Flow](/ResearchAssistant/Deployment/images/aiStudio/DeployDraftFlow.png)

7. It will take few minutes for the flow to be validated and deployed. Click on `Deployments` 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.
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.

![Deployments Page](/ResearchAssistant/Deployment/images/aiStudio/BlankDeploymentsPage.png)


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

9. Click on `Consume` from the top menu. Copy below details to use later in step 3.6.
Expand Down
4 changes: 2 additions & 2 deletions ResearchAssistant/Deployment/FabricDeployment.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,10 @@ Please follow the steps below to set up the Fabric Workspace and collect the id
3. Enter a Workspace Name and click on `Apply`.
![New Workspace](/ResearchAssistant/Deployment/images/fabric/CreateWorkspace.png)

4. On the next page, click on `New`.
4. On the next page, click on `Import`.
![Create Workspace](/ResearchAssistant/Deployment/images/fabric/WorkspaceGuid.png)

5. Click on `Import Notebook`.
5. Click on `Notebook`.

![Create Workspace](/ResearchAssistant/Deployment/images/fabric/ImportNotebooks.png)

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified ResearchAssistant/Deployment/images/aiStudio/Home.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified ResearchAssistant/Deployment/images/aiStudio/PromptFlow.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified ResearchAssistant/Deployment/images/aiStudio/SelectRunTime.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified ResearchAssistant/Deployment/images/fabric/ImportNotebooks.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified ResearchAssistant/Deployment/images/fabric/WorkspaceGuid.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified ResearchAssistant/Deployment/images/readMe/architecture.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified ResearchAssistant/Deployment/images/readMe/landing_page.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 4 additions & 4 deletions ResearchAssistant/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ For additional training and support, please see:
1. [Azure OpenAI](https://learn.microsoft.com/en-us/azure/ai-services/openai/)
2. [Azure AI Search](https://learn.microsoft.com/en-us/azure/search/)
3. [Microsoft Fabric](https://learn.microsoft.com/en-us/fabric/)
4. [Azure AI Studio](https://learn.microsoft.com/en-us/azure/ai-studio/)
4. [Azure AI Foundry](https://learn.microsoft.com/en-us/azure/ai-studio/)

### Solution accelerator architecture
![image](Deployment/images/readMe/architecture.png)
Expand All @@ -64,7 +64,7 @@ For additional training and support, please see:
### **How to install/deploy**

1. 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 Search, Semantic Ranker, Azure OpenAI Service, and Azure AI Studio are available.
https://azure.microsoft.com/en-us/explore/global-infrastructure/products-by-region/?products=all&regions=all) and choose a region where Azure AI Search, Semantic Ranker, Azure OpenAI Service, and Azure AI Foundry are available.

2. Click the following deployment button to create the required resources for this accelerator in your Azure Subscription.

Expand All @@ -74,9 +74,9 @@ https://azure.microsoft.com/en-us/explore/global-infrastructure/products-by-regi

![image](Deployment/images/readMe/armDeployment.png)

4. When Deployment is complete, follow steps in [AI Studio Deployment guide](./Deployment/AIStudioDeployment.md) to configure the grant draft proposal endpoint.
4. When Deployment is complete, follow steps in [AI Foundry Deployment guide](./Deployment/AIFoundryDeployment.md) to configure the grant draft proposal endpoint.

5. When AI Studio deployment is complete, launch the application by navigating to your Azure resource group, choosing the app service resource, and clicking on the default domain. You should bookmark this URL to have quick access to your deployed application.
5. When AI Foundry deployment is complete, launch the application by navigating to your Azure resource group, choosing the app service resource, and clicking on the default domain. You should bookmark this URL to have quick access to your deployed application.

The next steps are optional for additional learning. Not required to deploy the solution and run the Grant Writer Assistant.

Expand Down