Add app setting for default system role information

Author: jelledruyts

azuredeploy-webapp.json

@@ -55,6 +55,7 @@
         "searchIndexNameBlobDocuments": "blob-documents",
         "searchIndexNameBlobChunks": "blob-chunks",
         "searchIndexerScheduleMinutes": 5,
+        "defaultSystemRoleInformation": "You are an AI assistant that helps people find information.",
         "disableUploadDocuments": false,
         "disableResetSearchConfiguration": false
     },
@@ -364,6 +365,10 @@
                             "name": "InitialDocumentUrls",
                             "value": "[parameters('initialDocumentUrls')]"
                         },
+                        {
+                            "name": "DefaultSystemRoleInformation",
+                            "value": "[variables('defaultSystemRoleInformation')]"
+                        },
                         {
                             "name": "DisableUploadDocuments",
                             "value": "[variables('disableUploadDocuments')]"
@@ -458,6 +463,10 @@
             "type": "string",
             "value": "[parameters('initialDocumentUrls')]"
         },
+        "defaultSystemRoleInformation": {
+            "type": "string",
+            "value": "[variables('defaultSystemRoleInformation')]"
+        },
         "disableUploadDocuments": {
             "type": "bool",
             "value": "[variables('disableUploadDocuments')]"

src/Azure.AISearch.WebApp/AppSettings.cs

@@ -22,6 +22,7 @@ public class AppSettings
     public string? SearchIndexNameBlobChunks { get; set; }
     public int? SearchIndexerScheduleMinutes { get; set; } // If unspecified, will be set to 5 minutes.
     public string? InitialDocumentUrls { get; set; }
+    public string? DefaultSystemRoleInformation { get; set; } = "You are an AI assistant that helps people find information.";
     public bool DisableUploadDocuments { get; set; } // If true, the Upload Documents functionality will be disabled.
     public bool DisableResetSearchConfiguration { get; set; } // If true, the Reset Search Configuration functionality will be disabled.
 }

src/Azure.AISearch.WebApp/Constants.cs

@@ -15,9 +15,4 @@ public static class ConfigurationNames
         public const string SemanticConfigurationNameDefault = "default";
         public const string VectorSearchConfigurationNameDefault = "default";
     }
-
-    public static class SystemRoleInformations
-    {
-        public const string Default = "You are an AI assistant that helps people find information.";
-    }
 }

src/Azure.AISearch.WebApp/Models/SearchRequest.cs

@@ -9,7 +9,7 @@ public class SearchRequest
     public QueryType QueryType { get; set; } = QueryType.TextStandard;
     public DataSourceType DataSource { get; set; } = DataSourceType.None;
     public bool LimitToDataSource { get; set; } = true; // "Limit responses to your data content"
-    public string SystemRoleInformation { get; set; } = Constants.SystemRoleInformations.Default; // Give the model instructions about how it should behave and any context it should reference when generating a response. You can describe the assistant’s personality, tell it what it should and shouldn’t answer, and tell it how to format responses. There’s no token limit for this section, but it will be included with every API call, so it counts against the overall token limit.
+    public string? SystemRoleInformation { get; set; } // Give the model instructions about how it should behave and any context it should reference when generating a response. You can describe the assistant’s personality, tell it what it should and shouldn’t answer, and tell it how to format responses. There’s no token limit for this section, but it will be included with every API call, so it counts against the overall token limit.
 
     public bool IsVectorSearch => QueryType == Models.QueryType.Vector || QueryType == Models.QueryType.HybridStandard || QueryType == Models.QueryType.HybridSemantic;
     public bool IsSemanticSearch => QueryType == Models.QueryType.TextSemantic || QueryType == Models.QueryType.HybridSemantic;

src/Azure.AISearch.WebApp/Pages/Index.cshtml.cs

@@ -6,19 +6,24 @@ namespace Azure.AISearch.WebApp.Pages;
 
 public class IndexModel : PageModel
 {
+    private readonly AppSettings settings;
     private readonly SearchRequestHandler searchRequestHandler;
     private readonly SearchScenarioProvider searchScenarioProvider;
 
     public IList<SearchScenario> Scenarios { get; set; }
     public SearchRequest SearchRequest { get; set; }
     public SearchResponse? SearchResponse { get; set; }
 
-    public IndexModel(SearchRequestHandler searchRequestHandler, SearchScenarioProvider searchScenarioProvider)
+    public IndexModel(AppSettings settings, SearchRequestHandler searchRequestHandler, SearchScenarioProvider searchScenarioProvider)
     {
+        this.settings = settings;
         this.searchRequestHandler = searchRequestHandler;
         this.searchScenarioProvider = searchScenarioProvider;
         this.Scenarios = this.searchScenarioProvider.GetSearchScenarios();
-        this.SearchRequest = new SearchRequest();
+        this.SearchRequest = new SearchRequest
+        {
+            SystemRoleInformation = this.settings.DefaultSystemRoleInformation
+        };
     }
 
     public async Task OnPost(SearchRequest searchRequest)

src/Azure.AISearch.WebApp/Services/SearchScenarioProvider.cs

@@ -109,7 +109,8 @@ public IList<SearchScenario> GetSearchScenarios()
                 SearchRequest = new SearchRequest
                 {
                     Engine = EngineType.AzureOpenAI,
-                    DataSource = DataSourceType.None
+                    DataSource = DataSourceType.None,
+                    SystemRoleInformation = this.settings.DefaultSystemRoleInformation
                 }
             },
             new SearchScenario
@@ -120,9 +121,10 @@ public IList<SearchScenario> GetSearchScenarios()
                 SearchRequest = new SearchRequest
                 {
                     Engine = EngineType.AzureOpenAI,
+                    DataSource = DataSourceType.AzureCognitiveSearch,
+                    SystemRoleInformation = this.settings.DefaultSystemRoleInformation,
                     SearchIndex = SearchIndexType.Chunks, // As a built-in scenario, always use the chunks index for best results
                     QueryType = QueryType.TextSemantic, // As a built-in scenario, always use semantic search for best results
-                    DataSource = DataSourceType.AzureCognitiveSearch,
                     LimitToDataSource = true
                 }
             }