3 or 5 days POC VBD powered by: Azure Search + Azure OpenAI + Bot Framework + Langchain + Azure SQL + CosmosDB + Bing Search API
Your organization requires a Multi-Channel Smart Chatbot and a search engine capable of comprehending diverse types of data scattered across various locations. Additionally, the conversational chatbot should be able to provide answers to inquiries, along with the source and an explanation of how and where the answer was obtained. In other words, you want private and secured ChatGPT for your organization that can interpret, comprehend, and answer questions about your business data.
The goal of the MVP POC is to show/prove the value of a GPT Virtual Assistant built with Azure Services, with your own data in your own environment. The deliverables are:
- Backend Bot API built with Bot Framework and exposed to multiple channels (Web Chat, MS Teams, SMS, Email, Slack, etc)
- Frontend web application with a Search and a Bot UI.
The repo is made to teach you step-by-step on how to build a OpenAI based Smart Search Engine. Each Notebook builds on top of each other and ends in building the two applications.
For Microsoft FTEs: This is a customer funded VBD, below the assets for the delivery.
| Item | Description | Link |
|---|---|---|
| VBD SKU Info and Datasheet | CSAM must dispatch it as "Customer Invested" against credits/hours of Unified Support Contract. Customer decides if 3 or 5 days. | ESXP SKU page |
| VBD Accreditation for CSAs | Links for CSAs to get the Accreditation needed to deliver the workshop | Link 1 , Link 2 |
| VBD 3-5 day POC Asset (IP) | The MVP to be delivered (this GitHub repo) | Azure-Cognitive-Search-Azure-OpenAI-Accelerator |
| VBD Workshop Deck | The deck introducing and explaining the workshop | Intro AOAI GPT Azure Smart Search Engine Accelerator.pptx |
| CSA Training Video | 2 Hour Training for Microsoft CSA's | POC VBD Training Recording |
Prerequisites Client 3-5 Days POC
- Azure subscription
- Accepted Application to Azure Open AI, including GPT-4 (mandatory)
- Microsoft members need to be added as Guests in clients Azure AD
- A Resource Group (RG) needs to be set for this Workshop POC, in the customer Azure tenant
- The customer team and the Microsoft team must have Contributor permissions to this resource group so they can set everything up 2 weeks prior to the workshop
- A storage account must be set in place in the RG.
- Data/Documents must be uploaded to the blob storage account, at least two weeks prior to the workshop date
- For IDE collaboration during workshop, Jupyper Lab will be used, for this, Azure Machine Learning Workspace must be deployed in the RG
- Note: Please ensure you have enough core compute quota in your Azure Machine Learning workspace
Architecture
Flow
- The user asks a question.
- In the app, an OpenAI LLM uses a clever prompt to determine which source contains the answer to the question.
- Four types of sources are available:
- 3a. Azure SQL Database - contains COVID-related statistics in the US.
- 3b. Azure Bing Search API - provides access to the internet allowing scenerios like: QnA on public websites .
- 3c. Azure Cognitive Search - contains AI-enriched documents from Blob Storage (10k PDFs and 52k articles).
- 3c.1. Uses an LLM (OpenAI) to vectorize the top K document chunks from 3c.
- 3c.2. Uses in-memory cosine similarity to get the top N chunks.
- 3c.3. Uses an OpenAI GPT model to craft the response from the Cog Search Engine (3c) by combining the question and the top N chunks.
- 3d. CSV Tabular File - contains COVID-related statistics in the US.
- The app retrieves the result from the source and crafts the answer.
- The tuple (Question and Answer) is saved to CosmosDB to keep a record of the interaction.
- The answer is delivered to the user.
Demo
https://gptsmartsearch.azurewebsites.net/
To open the Bot in MS Teams, click HERE
π§Features
- Uses Bot Framework and Bot Service to Host the Bot API Backend and to expose it to multiple channels including MS Teams.
- 100% Python.
- Uses Azure Cognitive Services to index and enrich unstructured documents: Detect Language, OCR images, Key-phrases extraction, entity recognition (persons, emails, addresses, organizations, urls).
- Uses LangChain as a wrapper for interacting with Azure OpenAI , vector stores, constructing prompts and creating agents.
- Multi-Lingual (ingests, indexes and understand any language)
- Multi-Index -> multiple search indexes
- Tabular Data Q&A with CSV files and SQL Databases
- Uses Bing Search API to power internet searches in the bot
- Uses CosmosDB as persistent memory to save user's conversations.
- Uses Streamlit to build the Frontend web application in python.
Steps to Run the POC/Accelerator
Note: (Pre-requisite) You need to have an Azure OpenAI service already created
- Fork this repo to your Github account.
- In Azure OpenAI studio, deploy these two models: Make sure that the deployment name is the same as the model name.
- "gpt-35-turbo" for the model "gpt-35-turbo (0301)". If you have "gpt-4", use it (it is definitely better)
- "text-embedding-ada-002"
- 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.
- ClICK BELOW to create all the Azure Infrastructure needed to run the Notebooks (Azure Cognitive Search, Cognitive Services, SQL Database, CosmosDB, Bing Search API):
Note: If you have never created a Cognitive 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.
-
Make sure that Semantic Search is enabled on your Azure Cognitive Search Service:
- On the left-nav pane, select Semantic Search (Preview).
- If not already selected, select either the Free plan or the Standard plan. You can switch between the free plan and the standard plan at any time.
-
Clone your Forked repo to your local machine or AML Compute Instance. If your repo is private, see below in Troubleshooting section how to clone a private repo.
-
Make sure you run the notebooks on a Python 3.10 conda enviroment
-
Install the dependencies on your machine (make sure you do the below pip comand on the same conda environment that you are going to run the notebooks. For example, in AZML compute instance run:
conda activate azureml_py310_sdkv2
pip install -r ./common/requirements.txt
- Edit the file
credentials.envwith your own values from the services created in step 4. - Run the Notebooks in order. They build up on top of each other.
FAQs
FAQs
- Why the vector similarity is done in memory using FAISS versus having a separate vector database like RedisSearch or Pinecone?
A: True, doing the embeddings of the documents pages everytime that there is a query is not efficient. The ideal scenario is to vectorize the docs chunks once (first time they are needed) and then retrieve them from a database the next time they are needed. For this a special vector database is necessary. The ideal scenario though, is Azure Search to save and retreive the vectors as part of the search results, along with the document chunks. Azure Search will soon allow this in a few months, let's wait for it. As of right now the embedding process doesn't take that much time or money, so it is worth the wait versus using another database just for vectors. Once Azure Cog Search gets vector capabilities, the search/retrieval/answer process will be a lot faster.
- Why use Azure Cognitive Search engine to provide the context for the LLM and not fine tune the LLM instead?
A: Quoting the OpenAI documentation: "GPT-3 has been pre-trained on a vast amount of text from the open internet. When given a prompt with just a few examples, it can often intuit what task you are trying to perform and generate a plausible completion. This is often called "few-shot learning. Fine-tuning improves on few-shot learning by training on many more examples than can fit in the prompt, letting you achieve better results on a wide number of tasks. Once a model has been fine-tuned, you won't need to provide examples in the prompt anymore. This saves costs and enables lower-latency requests"
However, fine-tuning the model requires providing hundreds or thousands of Prompt and Completion tuples, which are essentially query-response samples. The purpose of fine-tuning is not to give the LLM knowledge of the company's data but to provide it with examples so it can perform tasks really well without requiring examples on every prompt.
There are cases where fine-tuning is necessary, such as when the examples contain proprietary data that should not be exposed in prompts or when the language used is highly specialized, as in healthcare, pharmacy, or other industries or use cases where the language used is not commonly found on the internet.
Troubleshooting
Troubleshooting
Steps to clone a private repo:
- On your Terminal, Paste the text below, substituting in your GitHub email address. Generate a new SSH key.
ssh-keygen -t ed25519 -C "[email protected]"- Copy the SSH public key to your clipboard. Add a new SSH key.
cat ~/.ssh/id_ed25519.pub
# Then select and copy the contents of the id_ed25519.pub file
# displayed in the terminal to your clipboard- On GitHub, go to Settings-> SSH and GPG Keys-> New SSH Key
- In the "Title" field, add a descriptive label for the new key. "AML Compute". In the "Key" field, paste your public key.
- Clone your private repo
git clone [email protected]:YOUR-USERNAME/YOUR-REPOSITORY.git