Add Vector Based Text2SQL Code and Approach (#14)

* Add deployment for text2sql index

* Add entities for new version

* Work in progress

* Add deployment for text2sql index

* Add entities for new version

* Work in progress

* refactor the location

* Update envs

* Update the envs

* Update envs

* Finish indexer building

* Update the location of the dictionary

* Update data dictionary

* Update the plugin to load jsonl

* Update content

* Move to use a skillset for indexing

* Update the scripts

* Improve the readme

* Update the naming

* Fix bad replacement

* Update the readmes

* Update readme

* Update the readme

* Run the vector example

* Update the env

* Update the code

* Update readme

* Update main readme

Author: BenConstable9

README.md

@@ -6,11 +6,13 @@ It is intended that the plugins and skills provided in this repository, are adap
 
 ## Components
 
-- `./text2sql` contains an Multi-Shot implementation for Text2SQL generation and querying which can be used to answer questions backed by a database as a knowledge base.
-- `./ai_search_with_adi_function_app` contains code for linking Azure Document Intelligence with AI Search to process complex documents with charts and images, and uses multi-modal models (gpt4o) to interpret and understand these.
-- `./deploy_ai_search` provides an easy Python based utility for deploying an index, indexer and corresponding skillset for AI Search.
+- `./text_2_sql` contains an two Multi-Shot implementation for Text2SQL generation and querying which can be used to answer questions backed by a database as a knowledge base. A prompt based and vector based approach are shown, both of which exhibit great performance in answering sql queries. With these plugins, your RAG application can now access and pull data from any SQL table exposed to it to answer questions.
+- `./adi_function_app` contains code for linking Azure Document Intelligence with AI Search to process complex documents with charts and images, and uses multi-modal models (gpt4o) to interpret and understand these. With this custom skill, the RAG application can draw insights from complex charts and images during the vector search.
+- `./deploy_ai_search` provides an easy Python based utility for deploying an index, indexer and corresponding skillset for AI Search and for Text2SQL.
 
-The above components have been successfully used on production RAG projects to increase the quality of responses. The code provided in this repo is a sample of the implementation and should be adjusted before being used in production.
+The above components have been successfully used on production RAG projects to increase the quality of responses.
+
+_The code provided in this repo is a sample of the implementation and should be adjusted before being used in production._
 
 ## High Level Implementation
 

adi_function_app/.env

@@ -0,0 +1,12 @@
+FunctionApp__ClientId=<clientId of the function app if using user assigned managed identity>
+IdentityType=<identityType> # system_assigned or user_assigned or key
+OpenAI__ApiKey=<openAIKey if using non managed identity>
+OpenAI__Endpoint=<openAIEndpoint>
+OpenAI__MultiModalDeployment=<openAIEmbeddingDeploymentId>
+OpenAI__ApiVersion=<openAIApiVersion>
+AIService__DocumentIntelligence__Endpoint=<documentIntelligenceEndpoint>
+AIService__DocumentIntelligence__Key=<documentIntelligenceKey if not using identity>
+AIService__Language__Endpoint=<languageEndpoint>
+AIService__Language__Key=<languageKey if not using identity>
+StorageAccount__Endpoint=<Endpoint if using identity based connections>
+StorageAccount__ConnectionString=<connectionString if using non managed identity>

adi_function_app/README.md

@@ -43,11 +43,11 @@ The properties returned from the ADI Custom Skill are then used to perform the f
 
 ## Deploying AI Search Setup
 
-To deploy the pre-built index and associated indexer / skillset setup, see instructions in `./ai_search/README.md`.
+To deploy the pre-built index and associated indexer / skillset setup, see instructions in `./deploy_ai_search/README.md`.
 
 ## ADI Custom Skill
 
-Deploy the associated function app and required resources. You can then experiment with the custom skill by sending an HTTP request in the AI Search JSON format to the `/adi_2_deploy_ai_search` HTTP endpoint.
+Deploy the associated function app and required resources. You can then experiment with the custom skill by sending an HTTP request in the AI Search JSON format to the `/adi_2_ai_search` HTTP endpoint.
 
 To use with an index, either use the utility to configure a indexer in the provided form, or integrate the skill with your skillset pipeline.
 

adi_function_app/adi_2_ai_search.py

@@ -188,11 +188,11 @@ async def understand_image_with_gptv(image_base64, caption, tries_left=3):
                         "role": "user",
                         "content": [
                             {
-                                "type": "text",
+                                "Type": "text",
                                 "text": user_input,
                             },
                             {
-                                "type": "image_url",
+                                "Type": "image_url",
                                 "image_url": {
                                     "url": f"data:image/png;base64,{image_base64}"
                                 },
@@ -371,10 +371,12 @@ async def analyse_document(file_path: str) -> AnalyzeResult:
             managed_identity_client_id=os.environ["FunctionApp__ClientId"]
         )
     else:
-        credential = AzureKeyCredential(os.environ["AIService__Services__Key"])
+        credential = AzureKeyCredential(
+            os.environ["AIService__DocumentIntelligence__Key"]
+        )
 
     async with DocumentIntelligenceClient(
-        endpoint=os.environ["AIService__Services__Endpoint"],
+        endpoint=os.environ["AIService__DocumentIntelligence__Endpoint"],
         credential=credential,
     ) as document_intelligence_client:
         poller = await document_intelligence_client.begin_analyze_document(

adi_function_app/key_phrase_extraction.py

@@ -45,9 +45,9 @@ async def extract_key_phrases_from_text(
             managed_identity_client_id=os.environ.get("FunctionApp__ClientId")
         )
     else:
-        credential = AzureKeyCredential(os.environ.get("AIService__Services__Key"))
+        credential = AzureKeyCredential(os.environ.get("AIService__Language__Key"))
     text_analytics_client = TextAnalyticsClient(
-        endpoint=os.environ.get("AIService__Services__Endpoint"),
+        endpoint=os.environ.get("AIService__Language__Endpoint"),
         credential=credential,
     )
 

deploy_ai_search/.env

@@ -0,0 +1,22 @@
+FunctionApp__Endpoint=<functionAppEndpoint>
+FunctionApp__Key=<functionAppKey>
+FunctionApp__PreEmbeddingCleaner__FunctionName=pre_embedding_cleaner
+FunctionApp__ADI__FunctionName=adi_2_ai_search
+FunctionApp__KeyPhraseExtractor__FunctionName=key_phrase_extractor
+FunctionApp__AppRegistrationResourceId=<App registration in form api://appRegistrationclientId if using identity based connections>
+IdentityType=<identityType> # system_assigned or user_assigned or key
+AIService__AzureSearchOptions__Endpoint=<searchServiceEndpoint>
+AIService__AzureSearchOptions__Identity__ClientId=<clientId if using user assigned identity>
+AIService__AzureSearchOptions__Key=<searchServiceKey if not using identity>
+AIService__AzureSearchOptions__UsePrivateEndpoint=<true/false>
+AIService__AzureSearchOptions__Identity__FQName=<fully qualified name of the identity if using user assigned identity>
+StorageAccount__FQEndpoint=<Fully qualified endpoint in form ResourceId=resourceId if using identity based connections>
+StorageAccount__ConnectionString=<connectionString if using non managed identity>
+StorageAccount__RagDocuments__Container=<containerName>
+StorageAccount__Text2Sql__Container=<containerName>
+OpenAI__ApiKey=<openAIKey if using non managed identity>
+OpenAI__Endpoint=<openAIEndpoint>
+OpenAI__EmbeddingModel=<openAIEmbeddingModelName>
+OpenAI__EmbeddingDeployment=<openAIEmbeddingDeploymentId>
+OpenAI__EmbeddingDimensions=1536
+Text2Sql__DatabaseName=<databaseName>

deploy_ai_search/README.md

@@ -1,18 +1,28 @@
-# AI Search Indexing with Azure Document Intelligence - Pre-built Index Setup
+# AI Search Indexing Pre-built Index Setup
 
 The associated scripts in this portion of the repository contains pre-built scripts to deploy the skillset with Azure Document Intelligence.
 
-## Steps
+## Steps for Rag Documents Index Deployment
 
 1. Update `.env` file with the associated values. Not all values are required dependent on whether you are using System / User Assigned Identities or a Key based authentication.
 2. Adjust `rag_documents.py` with any changes to the index / indexer. The `get_skills()` method implements the skills pipeline. Make any adjustments here in the skills needed to enrich the data source.
 3. Run `deploy.py` with the following args:
 
-    - `indexer_type rag`. This selects the `rag_documents` sub class.
+    - `indexer_type rag`. This selects the `RagDocumentsAISearch` sub class.
     - `enable_page_chunking True`. This determines whether page wise chunking is applied in ADI, or whether the inbuilt skill is used for TextSplit. **Page wise analysis in ADI is recommended to avoid splitting tables / figures across multiple chunks, when the chunking is performed.**
     - `rebuild`. Whether to delete and rebuild the index.
     - `suffix`. Optional parameter that will apply a suffix onto the deployed index and indexer. This is useful if you want deploy a test version, before overwriting the main version.
 
+## Steps for Text2SQL Index Deployment
+
+1. Update `.env` file with the associated values. Not all values are required dependent on whether you are using System / User Assigned Identities or a Key based authentication.
+2. Adjust `text_2_sql.py` with any changes to the index / indexer. The `get_skills()` method implements the skills pipeline. Make any adjustments here in the skills needed to enrich the data source.
+3. Run `deploy.py` with the following args:
+
+    - `indexer_type text_2_sql`. This selects the `Text2SQLAISearch` sub class.
+    - `rebuild`. Whether to delete and rebuild the index.
+    - `suffix`. Optional parameter that will apply a suffix onto the deployed index and indexer. This is useful if you want deploy a test version, before overwriting the main version.
+
 ## ai_search.py & environment.py
 
 This includes a variety of helper files and scripts to deploy the index setup. This is useful for CI/CD to avoid having to write JSON files manually or use the UI to deploy the pipeline.

deploy_ai_search/ai_search.py

@@ -25,6 +25,7 @@
     SynonymMap,
     SplitSkill,
     SearchIndexerIndexProjections,
+    BlobIndexerParsingMode,
 )
 from azure.core.exceptions import HttpResponseError
 from azure.search.documents.indexes import SearchIndexerClient, SearchIndexClient
@@ -66,12 +67,16 @@ def __init__(
         self.environment = AISearchEnvironment(indexer_type=self.indexer_type)
 
         self._search_indexer_client = SearchIndexerClient(
-            self.environment.ai_search_endpoint, self.environment.ai_search_credential
+            endpoint=self.environment.ai_search_endpoint,
+            credential=self.environment.ai_search_credential,
         )
         self._search_index_client = SearchIndexClient(
-            self.environment.ai_search_endpoint, self.environment.ai_search_credential
+            endpoint=self.environment.ai_search_endpoint,
+            credential=self.environment.ai_search_credential,
         )
 
+        self.parsing_mode = BlobIndexerParsingMode.DEFAULT
+
     @property
     def indexer_name(self):
         """Get the indexer name for the indexer."""
@@ -156,7 +161,16 @@ def get_data_source(self) -> SearchIndexerDataSourceConnection:
         if self.get_indexer() is None:
             return None
 
-        data_deletion_detection_policy = NativeBlobSoftDeleteDeletionDetectionPolicy()
+        if self.parsing_mode in [
+            BlobIndexerParsingMode.DEFAULT,
+            BlobIndexerParsingMode.TEXT,
+            BlobIndexerParsingMode.JSON,
+        ]:
+            data_deletion_detection_policy = (
+                NativeBlobSoftDeleteDeletionDetectionPolicy()
+            )
+        else:
+            data_deletion_detection_policy = None
 
         data_change_detection_policy = HighWaterMarkChangeDetectionPolicy(
             high_water_mark_column_name="metadata_storage_last_modified"
@@ -268,6 +282,10 @@ def get_text_split_skill(self, context, source) -> SplitSkill:
     def get_adi_skill(self, chunk_by_page=False) -> WebApiSkill:
         """Get the custom skill for adi.
 
+        Args:
+        -----
+            chunk_by_page (bool, optional): Whether to chunk by page. Defaults to False.
+
         Returns:
         --------
             WebApiSkill: The custom skill for adi"""
@@ -528,6 +546,11 @@ def run_indexer(self):
 
     def reset_indexer(self):
         """This function runs the indexer."""
+
+        if self.get_indexer() is None:
+            logging.warning("Indexer not defined. Skipping reset operation.")
+
+            return
         self._search_indexer_client.reset_indexer(self.indexer_name)
 
         logging.info("%s reset.", self.indexer_name)

deploy_ai_search/deploy.py

@@ -2,6 +2,7 @@
 # Licensed under the MIT License.
 import argparse
 from rag_documents import RagDocumentsAISearch
+from text_2_sql import Text2SqlAISearch
 
 
 def deploy_config(arguments: argparse.Namespace):
@@ -15,6 +16,10 @@ def deploy_config(arguments: argparse.Namespace):
             rebuild=arguments.rebuild,
             enable_page_by_chunking=arguments.enable_page_chunking,
         )
+    elif arguments.indexer_type == "text_2_sql":
+        index_config = Text2SqlAISearch(
+            suffix=arguments.suffix, rebuild=arguments.rebuild
+        )
     else:
         raise ValueError("Invalid Indexer Type")
 

deploy_ai_search/environment.py

@@ -12,6 +12,7 @@ class IndexerType(Enum):
     """The type of the indexer"""
 
     RAG_DOCUMENTS = "rag-documents"
+    TEXT_2_SQL = "text-2-sql"
 
 
 class IdentityType(Enum):