You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+78-48Lines changed: 78 additions & 48 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -116,61 +116,91 @@ This is a **customer-funded Value-Based Delivery (VBD)**. Below, you'll find all
116
116
- Uses [Bot Framework](https://dev.botframework.com/) and [Bot Service](https://azure.microsoft.com/en-us/products/bot-services/) to Host the Bot API Backend and to expose it to multiple channels including MS Teams.
117
117
- Uses also FastAPI to deploy an alternative backend API with streaming capabilites
118
118
119
-
120
119
---
121
120
122
121
## **Steps to Run the POC/Accelerator**
123
122
124
-
Note: (Pre-requisite) You need to have an Azure OpenAI service already created
125
-
126
-
1. Fork this repo to your Github account.
127
-
2. In Azure OpenAI studio, deploy these models (older models than the ones stated below won't work):
128
-
- "gpt-4o"
129
-
- "gpt-4o-mini"
130
-
- "text-embedding-3-large"
131
-
- "tts"
132
-
- "whisper"
133
-
3. Create a Resource Group where all the assets of this accelerator are going to be. Azure OpenAI can be in different RG or a different Subscription.
134
-
4. ClICK BELOW to create all the Azure Infrastructure needed to run the Notebooks (Azure AI Search, Cognitive Services, etc):
135
-
136
-
[](https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2Fpablomarin%2FGPT-Azure-Search-Engine%2Fmain%2Fazuredeploy.json)
137
-
138
-
**Note**: If you have never created a `Azure AI Services Multi-Service account` before, please create one manually in the azure portal to read and accept the Responsible AI terms. Once this is deployed, delete this and then use the above deployment button.
139
-
140
-
## Preferred Development Environment - Azure Machine Learning
141
-
142
-
1. Clone your Forked repo to your AML Compute Instance. If your repo is private, see below in Troubleshooting section how to clone a private repo.
143
-
2. Install the dependencies on your machine (make sure you do the below pip comand on the same Python 3.12 conda environment that you are going to run the notebooks.) For example, in AZML compute instance run:
## Alternate Development Environment - Visual Studio Code
155
-
156
-
1. Create a python virtual environment (.venv)
157
-
a. When you create the virtual environment, select the /common/requirements.txt
158
-
159
-
Or manually
160
-
161
-
pip install -r ./common/requirements.txt
162
-
163
-
2. .venv\scripts\activate
164
-
165
-
3. Pip install ipykernel
166
-
167
-
5. Edit the file `credentials.env` with your own values from the services created in step 4.
168
-
- For BLOB_SAS_TOKEN and BLOB_CONNECTION_STRING. Go to Storage Account -> Security + networking -> Shared access signature>Generate SAS
169
-
6.**Run the Notebooks in order** using the "GPTSearch (Python 3.12)" kernel(AML) or .venv kernel(vscode). They build up on top of each other.
170
-
123
+
### **Pre-requisite**
124
+
You must have an **Azure OpenAI Service** already created.
125
+
126
+
### **1. Fork the Repository**
127
+
- Fork this repository to your GitHub account.
128
+
129
+
### **2. Deploy Required Models**
130
+
In **Azure OpenAI Studio**, deploy the following models:
131
+
*(Note: Older versions of these models will not work)*
132
+
133
+
-`gpt-4o`
134
+
-`gpt-4o-mini`
135
+
-`text-embedding-3-large`
136
+
-`tts`
137
+
-`whisper`
138
+
139
+
### **3. Create a Resource Group**
140
+
- Create a **Resource Group (RG)** to house all the assets for this accelerator.
141
+
- Note: Azure OpenAI services can exist in a different RG or even a different subscription.
142
+
143
+
### **4. Deploy Azure Infrastructure**
144
+
Click the button below to deploy all necessary Azure infrastructure (e.g., Azure AI Search, Cognitive Services, etc.):
145
+
146
+
[](https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2Fpablomarin%2FGPT-Azure-Search-Engine%2Fmain%2Fazuredeploy.json)
147
+
148
+
**Important:**
149
+
If this is your first time creating an **Azure AI Services Multi-Service Account**, do the following manually:
150
+
1. Go to the Azure portal.
151
+
2. Create the account.
152
+
3. Read and accept the **Responsible AI Terms**.
153
+
Once done, delete this manually created account and then use the above deployment button.
1.**Clone** your forked repository to your AML Compute Instance.
159
+
- If your repository is private, refer to the **Troubleshooting** section for guidance on cloning private repos.
160
+
2. Install the dependencies in a Conda environment. Run the following commands on the **Python 3.12 Conda environment** you plan to use for the notebooks:
0 commit comments