Added NLQ to OpenAI version of T-SQL script

Author: happyadam73

README.md

@@ -62,7 +62,7 @@ The SQL Script should look similar to the screenshot below - once you've pasted
 > Expected costs for running this demonstration are around $2.30/day:
 > - Azure SQL Database (Standard S0): ~ $20/month
 > - Azure API Management (Developer SKU): ~ $50/month
-> - OpenAI Costs not included (but may be covered by Free/ChatGPT Plus subscriptions)
+> - OpenAI Costs not included (typically $10/month for 100K tokens/day)
 
 
 ## Pre-requisites

sql/TSqlChatGPT.sql

@@ -1,45 +1,70 @@
---/	
---/ Product:			TSqlChatGPT
---/ Description:		Call ChatGPT from Azure SQL Database, and describe objects within the database
---/	
---/ Author:				Adam Buckley, Microsoft
---/ Creation Date:		March 2023
---/	
---/ Revision History:	1.4 (Error handling improved, and no longer need to find/replace APIM URL)
---/	
---/ 
---/ DISCLAIMER: 
---/ THIS SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A 
---/ PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, 
---/ TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
---/
---/ IMPORTANT: This will currently only work on Azure SQL Database (not on SQL Server or Azure SQL Managed Instance)
---/
---/ Provide your API key for OpenAI service (this is for OpenAI, not Azure OpenAI service)
---/ And also the subscription key for the Azure API Manager API
---/ The APIM URL Paramater needs to match the API Manager Service URL (e.g. https://myapimanagerresourcename.azure-api.net)
---/
---/ Usage Examples:
---/ 
---/		EXEC [dbo].[usp_AskChatGPT] 'Generate a CREATE TABLE script for Customer data';
---/		EXEC [dbo].[usp_AskChatGPT] 'Generate a SQL function to calculate how many days until a specified date';
---/		EXEC [dbo].[usp_AskChatGPT] 'Explain this code: SELECT DATEDIFF(DAY,GETDATE(),DATEFROMPARTS(2023,12,25))';
---/
---/		EXEC [dbo].[usp_ExplainObject] 'dbo.uspLogError';
---/		EXEC [dbo].[usp_ExplainObject] '[SalesLT].[vProductAndDescription]';
---/
---/		EXEC [dbo].[usp_GenerateTestDataForTable] '[SalesLT].[Address]'
---/
---/		EXEC [dbo].[usp_GenerateUnitTestForObject] 'dbo.ufnGetSalesOrderStatusText';
---/
---/		EXEC [dbo].[usp_DescribeTableColumns] '[SalesLT].[SalesOrderDetail]';
---/
+--	
+-- Product:			    TSqlChatGPT
+-- Description:		    Call ChatGPT from Azure SQL Database, and describe objects within the database
+--	
+-- Author:				Adam Buckley, Microsoft
+-- Creation Date:		March 2023
+--	
+-- Revision History:    1.1 (Error handling improved, and no longer need to find/replace APIM URL)
+--                      1.2 (AWB, 17/08/2023) - Added natural query language support with the usp_ExecuteNaturalQuery stored procedure
+--	
+-- 
+-- DISCLAIMER: 
+-- THIS SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A 
+-- PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, 
+-- TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+--
+-- IMPORTANT: This will currently only work on Azure SQL Database (not on SQL Server or Azure SQL Managed Instance)
+--
+-- Provide your API key for OpenAI service (this is for OpenAI, not Azure OpenAI service)
+-- And also the subscription key for the Azure API Manager API
+-- The APIM URL Paramater needs to match the API Manager Service URL (e.g. https://myapimanagerresourcename.azure-api.net)
+--
+-- Usage Examples:
+-- 
+--		EXEC [dbo].[usp_AskChatGPT] 'Generate a CREATE TABLE script for Customer data';
+--		EXEC [dbo].[usp_AskChatGPT] 'Generate a SQL function to calculate how many days until a specified date';
+--		EXEC [dbo].[usp_AskChatGPT] 'Explain this code: SELECT DATEDIFF(DAY,GETDATE(),DATEFROMPARTS(2023,12,25))';
+--
+--      EXEC [dbo].[usp_ExecuteNaturalQuery] 'What were the most ordered products in June 2008'
+--      EXEC [dbo].[usp_ExecuteNaturalQuery] 'Which product category has the most products'
+--      EXEC [dbo].[usp_ExecuteNaturalQuery] 'List all the red or black products and include the product model and category name'
+--
+--      -- These natural language queries work with the much larger AdventureWorksDW database
+--      EXEC [dbo].[usp_ExecuteNaturalQuery] 'Return a 7-day rolling average number of sales grouped by territory, product and date ordered by date for any sales in 2012';
+--      EXEC [dbo].[usp_ExecuteNaturalQuery] 'List salaried employees with the highest amount of sick leave and include their manager''s name in the list';
+--      EXEC [dbo].[usp_ExecuteNaturalQuery] 'Which promotions, excluding "No Discount", had the largest total sales in the second quarter of 2012';
+--
+--		EXEC [dbo].[usp_ExplainObject] 'dbo.uspLogError';
+--		EXEC [dbo].[usp_ExplainObject] '[SalesLT].[vProductAndDescription]';
+--
+--		EXEC [dbo].[usp_GenerateTestDataForTable] '[SalesLT].[Address]'
+--
+--		EXEC [dbo].[usp_GenerateUnitTestForObject] 'dbo.ufnGetSalesOrderStatusText';
+--
+--		EXEC [dbo].[usp_DescribeTableColumns] '[SalesLT].[SalesOrderDetail]';
+--
 
 DECLARE @openai_api_key			NVARCHAR(255) = 'sk-XXXXXXXXXXXXXXXXXXXXXXXXXXXX',
 		@apim_subscription_key	NVARCHAR(255) = 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx',
 		@apim_url				NVARCHAR(255) = 'https://<your APIM resource name>.azure-api.net',
+		@chatgpt_model_name	    VARCHAR(255)  = 'gpt-3.5-turbo',
 		@sql_cmd				NVARCHAR(MAX);
 
+-- (OPTIONAL): Customise your chat agent here
+-- Do not remove the CODEONLY instruction if you plan on using the Natural Language Query feature
+DECLARE @system_message NVARCHAR(MAX) = N'
+You are a helpful database administrator and developer.  
+Your responses should always be for Transact SQL (or T-SQL).  
+When asked to generate a database object, you should generate the T-SQL script required to do this.  
+All T-SQL scripts should be formatted in the same way including data types are capitalised, column names are enclosed in square brackets.  
+For scripts containing a CREATE statement, make sure the script includes a check to see if that object already exists.  
+Only create the object if it doesn''t exist.  
+Scripts should only use dynamic SQL if required.  
+Try to avoid using sp_executesql.
+If the request begins with CODEONLY, then the response must only contain T-SQL code and do not add any text before or after the T-SQL code - remove the term CODEONLY from the response.
+';
+
 -- Create Database Master Key; it's Azure SQL DB, so no password required
 IF NOT EXISTS(SELECT * FROM sys.symmetric_keys WHERE [name] = '##MS_DatabaseMasterKey##') 
     CREATE MASTER KEY;
@@ -73,6 +98,26 @@ END
 ';
 EXEC sp_executesql @sql_cmd;
 
+-- ChatGPT Model function so that this can be references from other procs/functions
+SET @sql_cmd = N'
+CREATE OR ALTER FUNCTION dbo.OpenAIChatGPTModel()
+RETURNS SYSNAME AS
+BEGIN
+	RETURN N''' + @chatgpt_model_name + ''';
+END
+';
+EXEC sp_executesql @sql_cmd;
+
+-- System Message function so that this can be referenced from other procs/functions
+SET @sql_cmd = N'
+CREATE OR ALTER FUNCTION dbo.OpenAIChatSystemMessage()
+RETURNS NVARCHAR(MAX) AS
+BEGIN
+	RETURN N''' + STRING_ESCAPE(REPLACE(REPLACE(REPLACE(REPLACE(@system_message, N'''', N''''''), CHAR(9), N'\t'), CHAR(10), N'\n'), CHAR(13), N'\r'), 'json') + ''';
+END
+';
+EXEC sp_executesql @sql_cmd;
+
 -- Drop/Create proc to Print long strings (useful given size of response from ChatGPT)
 IF EXISTS (SELECT * FROM sys.objects WHERE type = 'P' AND OBJECT_ID = OBJECT_ID('dbo.usp_PrintMax'))
     DROP PROCEDURE [dbo].[usp_PrintMax];
@@ -112,7 +157,8 @@ CREATE PROCEDURE [dbo].[usp_AskChatGPT]
 	@response		NVARCHAR(MAX)   = NULL OUTPUT,
 	@apim_url		NVARCHAR(255)	= NULL,  -- If not provided, then default value retrieved using dbo.ApiManagementInstanceUrl()
 	@timeout		INT				= 60,
-	@print_response	BIT				= 1
+	@print_response	BIT				= 1,
+    @debug          BIT             = 0
 AS
 BEGIN
 	SET NOCOUNT ON;
@@ -122,19 +168,35 @@ BEGIN
 				@apim_openai_endpoint	NVARCHAR(1000),
 				@sql_cmd				NVARCHAR(MAX),
 				@status_code			INT,
-				@status_description		NVARCHAR(4000);
+				@status_description		NVARCHAR(4000),
+                @chatgpt_model          VARCHAR(255),
+                @system_message			NVARCHAR(MAX),
+                @debug_message          NVARCHAR(MAX);
+
+        -- Print request (non prompt injected) if in debug mode
+        IF @debug = 1
+        BEGIN
+            SET @debug_message = FORMAT(GETDATE(),'HH:mm:ss.ff') + ' - Request: ' + @message;
+            EXEC [dbo].[usp_PrintMax] @debug_message;
+        END
 
 		-- If no APIM URL provided, then set to default
 		SELECT @apim_url = ISNULL(@apim_url, dbo.ApiManagementInstanceUrl())
 
 		-- Configure APIM API endpoint
 		SET @apim_openai_endpoint = @apim_url + N'/chat/completions';
 
+		-- Get ChatGPT model name
+		SELECT @chatgpt_model = dbo.OpenAIChatGPTModel();
+
+		-- Get System Message 
+		SELECT @system_message = ISNULL(dbo.OpenAIChatSystemMessage(),'You are an AI assistant that helps people find information.');
+
 		-- Now make sure the message is a single line; escape characters such as tab, newline and quote, and escape characters to ensure valid JSON
 		SET @message = STRING_ESCAPE(REPLACE(REPLACE(REPLACE(REPLACE(@message, N'''', N''''''), CHAR(9), N'\t'), CHAR(10), N'\n'), CHAR(13), N'\r'), 'json');
 
 		-- Inject the message into the request payload using the gpt-3.5 model
-		SET @request = N'{"model": "gpt-3.5-turbo","messages": [{"role": "user", "content": "' + @message + '"}]}'
+		SET @request = N'{"model": "' + @chatgpt_model + '","messages": [{"role": "system", "content": "' + @system_message + '"},{"role": "user", "content": "' + @message + '"}]}'
 
 		-- Invoke APIM endpoint which wraps the OpenAI chat completion API 
 		EXEC sp_invoke_external_rest_endpoint
@@ -173,9 +235,17 @@ BEGIN
 		IF @response IS NULL
 			THROW 50000, 'It was not possible to extract a message response from the OpenAI Chat API', 1;
 
-		-- Print response if required
-		IF @print_response = 1
+		-- Print response if required (and not in debug mode)
+		IF @print_response = 1 AND @debug = 0
 			EXEC [dbo].[usp_PrintMax] @response;
+
+        -- Print request (non prompt injected) if in debug mode
+        IF @debug = 1
+        BEGIN
+            SET @debug_message = FORMAT(GETDATE(),'HH:mm:ss.ff') + ' - Response: ' + @response;
+            EXEC [dbo].[usp_PrintMax] @debug_message;
+        END
+
 	END TRY
 	BEGIN CATCH
 
@@ -460,3 +530,180 @@ BEGIN
 	DEALLOCATE procCursor;
 END;
 GO
+
+-- Drop Proc if already exists
+IF EXISTS (SELECT * FROM sys.objects WHERE type = 'P' AND OBJECT_ID = OBJECT_ID('dbo.usp_GetRelevantTablePromptForNaturalQuery'))
+    DROP PROCEDURE [dbo].[usp_GetRelevantTablePromptForNaturalQuery];
+GO
+
+-- Return part of a ChatGPT prompt which contains a list of CREATE TABLE statements for all the tables relevant to a natural language query
+-- ChatGPT is fed the names of all the database tables as well as the natural languge query and asked to decide on what is relevant
+CREATE PROCEDURE [dbo].[usp_GetRelevantTablePromptForNaturalQuery]
+	@query		    NVARCHAR(MAX),
+	@table_prompt	NVARCHAR(MAX)   = NULL OUTPUT,
+	@print_response	BIT				= 1,
+    @debug          BIT             = 0
+AS
+BEGIN
+	SET NOCOUNT ON;
+
+	BEGIN TRY
+		DECLARE @request				NVARCHAR(MAX),
+                @response               NVARCHAR(MAX),
+                @full_table_list        NVARCHAR(MAX),
+                @table_name             NVARCHAR(512),
+                @create_table_sql       NVARCHAR(MAX);
+
+        -- Get comma separated list of ALL database schemas/tables
+        SELECT @full_table_list = STRING_AGG(QUOTENAME(TABLE_SCHEMA) + '.' + QUOTENAME(TABLE_NAME),', ') 
+        FROM INFORMATION_SCHEMA.TABLES
+        WHERE TABLE_TYPE = 'BASE TABLE';
+
+        -- Formulate request for LLM
+        SET @request = N'
+Here is a comma separated list of all the tables within a database:
+' + @full_table_list + '
+
+To answer the following question, "' + @query + '", which of those tables listed would you expect to need in a SQL query to answer the question.
+
+Your response should contain only the names of the tables requires in a single comma separated list.  The list should also include tables that might be helpful or useful in answering the response.
+'
+        -- Get LLM response
+        EXEC [dbo].[usp_AskChatGPT] @request, @full_table_list OUTPUT, @print_response = 0, @debug = @debug;
+
+        -- Now create a cursor for each of the tables returned in the list
+        SET @table_prompt = N'';
+        DECLARE table_cursor CURSOR FOR
+        SELECT LTRIM(RTRIM([value])) FROM STRING_SPLIT(@full_table_list, ',');
+
+        OPEN table_cursor;
+        FETCH NEXT FROM table_cursor INTO @table_name;
+
+        WHILE @@FETCH_STATUS = 0
+        BEGIN
+            -- Generate the Create table script and append to the prompt
+            EXEC dbo.usp_Generate_Create_Table_Sql @table_name, @create_table_sql OUTPUT;
+            SET @table_prompt = @table_prompt + @create_table_sql + CHAR(13) + CHAR(10);
+    
+            FETCH NEXT FROM table_cursor INTO @table_name;
+        END
+
+        CLOSE table_cursor;
+        DEALLOCATE table_cursor;
+
+		-- Print response if required
+		IF @print_response = 1 AND @debug = 0
+			EXEC [dbo].[usp_PrintMax] @table_prompt;
+
+	END TRY
+	BEGIN CATCH
+
+		DECLARE @error_message	NVARCHAR(4000)	= ERROR_MESSAGE(),
+				@error_severity	INT				= ERROR_SEVERITY(),
+				@error_state	INT				= ERROR_STATE();
+
+		RAISERROR (@error_message, @error_severity, @error_state);
+
+	END CATCH
+
+END;
+GO
+
+-- Drop Proc if already exists
+IF EXISTS (SELECT * FROM sys.objects WHERE type = 'P' AND OBJECT_ID = OBJECT_ID('dbo.usp_ExecuteNaturalQuery'))
+    DROP PROCEDURE [dbo].[usp_ExecuteNaturalQuery];
+GO
+
+-- WARNING!!!
+-- This Stored Procedure may cause unintended consequences - by default this stored procedure will execute SQL generated by AI
+-- Avoid using on any production systems - or set the @execute_sql parameter to 0
+--
+-- Generate and execute a T-SQL statement based on natural language query
+-- Since ChatGPT can either ignore certain instructions, or hallucinate, the T-SQL generated may be invalid.
+-- Therefore the stored procedure runs through a number of retries until the query responds successfully.
+CREATE PROCEDURE [dbo].[usp_ExecuteNaturalQuery]
+	@query		            NVARCHAR(MAX),
+	@sql	                NVARCHAR(MAX)   = NULL OUTPUT,
+	@print_response	        BIT				= 1,
+    @execute_sql            BIT             = 1,
+    @execute_sql_retries    INT             = 10,
+    @debug                  BIT             = 0
+AS
+BEGIN
+	SET NOCOUNT ON;
+
+	BEGIN TRY
+		DECLARE @request				NVARCHAR(MAX),
+                @response               NVARCHAR(MAX),
+                @create_table_prompt    NVARCHAR(MAX),
+                @query_succeeded        BIT,
+                @attempt                INT,
+                @debug_message          NVARCHAR(MAX);
+
+        -- Get Create Table SQL prompt based on query
+        EXEC [dbo].[usp_GetRelevantTablePromptForNaturalQuery] @query, @create_table_prompt OUTPUT, @print_response = 0, @debug = @debug;
+
+        -- Formulate request for ChatGPT based on CREATE TABLE scripts for all relevant tables to answer the query
+        -- We use "CODEONLY" to tell ChatGPT to only return code (this is an instruction provided through the System Message)
+        SET @request = N'
+CODEONLY
+A database contains the following tables and columns:
+' + @create_table_prompt + '
+Generate a T-SQL query to answer the question: "' + @query + '" - the query should only reference table names and column names that appear in this request.
+For example, if the request contains the following CREATE TABLE statements:
+CREATE TABLE Table1 (Column1 VARCHAR(255), Column2 VARCHAR(255))
+CREATE TABLE Table2 (Column3 VARCHAR(255), Column4 VARCHAR(255))
+Then you should only reference Tables Table1 and Table2 and the query should only reference columns Column1, Column2, Column3 and Column4
+'
+        -- Get ChatGPT response
+        EXEC [dbo].[usp_AskChatGPT] @request, @sql OUTPUT, @print_response = 0, @debug = @debug;
+
+        -- Execute SQL if required
+        IF @execute_sql = 1
+        BEGIN
+            SET @query_succeeded = 0;
+            SET @attempt = 1
+
+            -- We keep trying until we either get a successful query response or we've exhaused all specified retry attempts
+            WHILE (@query_succeeded = 0) AND (@attempt <= @execute_sql_retries)
+            BEGIN
+                BEGIN TRY
+                    EXEC sp_executesql @sql;
+                    SET @query_succeeded = 1;
+                END TRY
+                BEGIN CATCH
+                    -- Ignore error
+                    IF @debug = 1
+                        PRINT FORMAT(GETDATE(),'HH:mm:ss.ff') + ' - Error Occurred: ' + ERROR_MESSAGE()
+                END CATCH
+                IF @debug = 1
+                BEGIN
+                    SET @debug_message = FORMAT(GETDATE(),'HH:mm:ss.ff') + ' - Attempt: ' + CAST(@attempt AS VARCHAR(10)) + ' ' + IIF(@query_succeeded = 0, 'Failed', 'Succeeded');
+                    EXEC [dbo].[usp_PrintMax] @debug_message;
+                END
+                SET @attempt = @attempt + 1;
+
+                -- We need to try again!
+                IF (@query_succeeded = 0) AND (@attempt <= @execute_sql_retries)
+                    EXEC [dbo].[usp_AskChatGPT] @request, @sql OUTPUT, @print_response = 0, @debug = @debug;
+                    
+            END
+        END
+
+		-- Print response if required (suppress this if we're in debug mode)
+		IF @print_response = 1 AND @debug = 0
+			EXEC [dbo].[usp_PrintMax] @sql;
+
+	END TRY
+	BEGIN CATCH
+
+		DECLARE @error_message	NVARCHAR(4000)	= ERROR_MESSAGE(),
+				@error_severity	INT				= ERROR_SEVERITY(),
+				@error_state	INT				= ERROR_STATE();
+
+		RAISERROR (@error_message, @error_severity, @error_state);
+
+	END CATCH
+
+END;
+GO