Skip to content

Commit

Permalink
made a few minor edits to RAG Sharepoint tutorial
Browse files Browse the repository at this point in the history
  • Loading branch information
@kyleoconnell-NIH
kyleoconnell-NIH committed Apr 9, 2024
1 parent 5dbf7c6 commit 506c453
Showing 1 changed file with 22 additions and 14 deletions.
36 changes: 22 additions & 14 deletions notebooks/GenAI/notebooks/sharepoint_RAG_bot.ipynb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
"id": "2a156351-e155-47f0-ba98-ef38817889a0",
"metadata": {},
"source": [
"In previous tutorials we have learned how to create chatbots by connecting to multiple Azure services such as Azure AI Search and Azure SQL Databases. For this tutorial we learn how to create a SharePoint chatbot by indexing a that SharePoint site using Azure AI Search."
"In previous tutorials we have learned how to create chatbots by connecting to multiple Azure services such as Azure AI Search and Azure SQL Databases. For this tutorial we learn how to create a SharePoint chatbot by indexing that SharePoint site using Azure AI Search."
]
},
{
Expand Down Expand Up @@ -121,7 +121,7 @@
"id": "b782a912-371c-467a-bc09-702f92bb24bc",
"metadata": {},
"source": [
"For this tutorial we will be downloading scientific articles related to COVID, which our model will then use as references to answer our questions."
"For this tutorial we will be downloading scientific articles from the [NIH RECOVER program](https://recovercovid.org/publications), which our model will then use as references to answer our questions about COVID."
]
},
{
Expand Down Expand Up @@ -172,10 +172,9 @@
"source": [
"In order for us to index documents in a SharePoint site the documents must be located in a document library or a subsite. You can create your document library in two ways directly via a **SharePoint site** or **Microsoft Teams channel.**\n",
"\n",
"If you would like to create a **SharePoint site** to index and you are a NIH user follow the section below for instructions. If you are a non-NIH user follow the instructions listed [here](https://support.microsoft.com/en-us/office/create-a-site-in-sharepoint-4d1e11bf-8ddc-499d-b889-2b48d10b1ce8). Once your SharePoint site is up upload the articles we just downloaded.\n",
"\n",
"If you have a **Microsoft Teams channel** click on the three dots to open the channel as a SharePoint site. If your articles are not already in a document library you can create one by clicking `+ New` then select `Document Library`. Give your library a name then upload the articles we just downloaded.\n",
"If you would like to create a **SharePoint site** to index and you are a NIH user follow the section below for instructions. If you are a non-NIH user follow the instructions listed [here](https://support.microsoft.com/en-us/office/create-a-site-in-sharepoint-4d1e11bf-8ddc-499d-b889-2b48d10b1ce8). Once your SharePoint site is runnning, upload the articles we just downloaded.\n",
"\n",
"If you have a **Microsoft Teams channel** click on the three dots to open the channel [as a SharePoint site](https://learn.microsoft.com/en-us/sharepoint/teams-connected-sites#when-do-teams-and-sharepoint-get-connected), or go to `Files`, click the three dots along the top to the right, and then select `Open in SharePoint`. If your articles are not already in a document library you can create one by clicking `+ New` then select `Document Library`. Give your library a name then upload the articles we just downloaded.\n",
"\n",
"Otherwise if you already have a SharePoint site feel free to skip to the next section."
]
Expand All @@ -193,7 +192,7 @@
"id": "836578a5-249a-49c9-9c29-2c6a92d9a1b3",
"metadata": {},
"source": [
"Submit a ticket through the IT Service Desk to create a new SharePoint site by going to Request a Service and under Collaboration and Conferencing go to `Microsoft 365 Services > SharePoint Request`. Once you are on the SharePoint form under `Select request type` select **Provision new SharePoint Online Site** then fillout the rest of the necessary information."
"Submit a ticket through the IT Service Desk to create a new SharePoint site by going to `Request a Service`. Under `Collaboration and Conferencing` go to `Microsoft 365 Services > SharePoint Request`. Once you are on the SharePoint form under `Select request type` select `Provision new SharePoint Online Site` then fill out the rest of the necessary information."
]
},
{
Expand All @@ -209,7 +208,7 @@
"id": "b3dff463-ed82-4286-bcf5-9815cb2e2ed7",
"metadata": {},
"source": [
"Enter in the name you would like for your AI Search service and index along with the name of your resource group and the location you would like your index to be held in."
"Enter the name you would like for your AI Search service and index along with the name of your resource group and the location you would like your index to be held in."
]
},
{
Expand Down Expand Up @@ -247,7 +246,7 @@
"id": "f2c94e07-fb3e-4472-9e56-3c81527d5b0c",
"metadata": {},
"source": [
"Create your Azure AI Search service. We will be using the free tier that holds 50MB of memory and allows you to create up to 3 indexes."
"Create your Azure AI Search service. We will be using the free tier that holds 50 MB of storage and allows you to create up to 3 indexes."
]
},
{
Expand Down Expand Up @@ -312,7 +311,7 @@
"\n",
"3. Select **+ New registration**:\n",
"\n",
"4. Provide a name for your app. NIH users must structure their app name like so `Your-NIH-IC-Name App-Name`\n",
"4. Provide a name for your app. NIH users must structure their app name as `Your-NIH-IC-Name App-Name`\n",
"5. Select **Single tenant**.\n",
"6. Skip the URI designation step. No redirect URI required.\n",
"7. Select **Register**.\n",
Expand Down Expand Up @@ -431,7 +430,7 @@
"id": "6fdeb437-f023-4826-aa53-6de3bdbff0c2",
"metadata": {},
"source": [
"Finally we will link our datastore and index by creating a **indexer** which will sync our data to our index. Notice that the indexer excludes image file this is because they are not supported in this index."
"Finally we will link our datastore and index by creating an **indexer** which will sync our data to our index. Notice that the indexer excludes image files because they are not supported in this index."
]
},
{
Expand Down Expand Up @@ -481,7 +480,7 @@
"id": "8932e34e-658e-48bb-a430-5733bc1a89b4",
"metadata": {},
"source": [
"While the command above is running **run the command below in another notebook within 10 min** of running the first command.\n",
"While the command above is running **run the command below in another notebook (or Cloud Shell) within 10 min** of running the first command.\n",
"Read the outputted error message and click on the supplied URL to enter the code the message has given you."
]
},
Expand Down Expand Up @@ -545,7 +544,7 @@
"metadata": {},
"outputs": [],
"source": [
"query = \"What is COVID?\""
"query = \"What are common symptoms of COVID?\""
]
},
{
Expand All @@ -555,7 +554,16 @@
"metadata": {},
"outputs": [],
"source": [
"query = \"what are treatments for COVID?\""
"query = \"what are some of the predictors of long COVID?\""
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {},
"outputs": [],
"source": [
"query = \"what are some research questions that remain unanswered related to long COVID?\""
]
},
{
Expand Down Expand Up @@ -650,7 +658,7 @@
"id": "e3097534-b676-460a-9371-b4d5bf19cb9c",
"metadata": {},
"source": [
"In this notebook you learned how to create a SharePoint index, datastore, and indexer and connected it to your model creating a SharePoint chatbot!"
"In this notebook you learned how to create a research assistant that summarizes articles using a SharePoint index, datastore, and indexer and connected it to your model creating a SharePoint chatbot!"
]
},
{
Expand Down

0 comments on commit 506c453

Please sign in to comment.