Add new strictness setting for search (microsoft#270)

Co-authored-by: Sarah Widder <[email protected]>

Author: sarah-widder

.env.sample

@@ -13,6 +13,7 @@ AZURE_SEARCH_URL_COLUMN=
 AZURE_SEARCH_VECTOR_COLUMNS=
 AZURE_SEARCH_QUERY_TYPE=simple
 AZURE_SEARCH_PERMITTED_GROUPS_COLUMN=
+AZURE_SEARCH_STRICTNESS=3
 AZURE_OPENAI_RESOURCE=
 AZURE_OPENAI_MODEL=
 AZURE_OPENAI_KEY=

README.md

@@ -64,6 +64,7 @@ Please see the [section below](#add-an-identity-provider) for important informat
     - `AZURE_SEARCH_VECTOR_COLUMNS`
     - `AZURE_SEARCH_QUERY_TYPE`
     - `AZURE_SEARCH_PERMITTED_GROUPS_COLUMN`
+    - `AZURE_SEARCH_STRICTNESS`
     - `AZURE_OPENAI_EMBEDDING_ENDPOINT`
     - `AZURE_OPENAI_EMBEDDING_KEY`
 
@@ -142,6 +143,7 @@ Note: settings starting with `AZURE_SEARCH` are only needed when using Azure Ope
 |AZURE_SEARCH_URL_COLUMN||Field from your Azure Cognitive Search index that contains a URL for the document, e.g. an Azure Blob Storage URI. This value is not currently used.|
 |AZURE_SEARCH_VECTOR_COLUMNS||List of fields in your Azure Cognitive Search index that contain vector embeddings of your documents to use when formulating a bot response. Represent these as a string joined with "|", e.g. `"product_description|product_manual"`|
 |AZURE_SEARCH_PERMITTED_GROUPS_COLUMN||Field from your Azure Cognitive Search index that contains AAD group IDs that determine document-level access control.|
+|AZURE_SEARCH_STRICTNESS|3|Integer from 1 to 5 specifying the strictness for the model limiting responses to your data.|
 |AZURE_OPENAI_RESOURCE||the name of your Azure OpenAI resource|
 |AZURE_OPENAI_MODEL||The name of your model deployment|
 |AZURE_OPENAI_ENDPOINT||The endpoint of your Azure OpenAI resource.|

app.py

@@ -43,6 +43,7 @@ def assets(path):
 AZURE_SEARCH_VECTOR_COLUMNS = os.environ.get("AZURE_SEARCH_VECTOR_COLUMNS")
 AZURE_SEARCH_QUERY_TYPE = os.environ.get("AZURE_SEARCH_QUERY_TYPE")
 AZURE_SEARCH_PERMITTED_GROUPS_COLUMN = os.environ.get("AZURE_SEARCH_PERMITTED_GROUPS_COLUMN")
+AZURE_SEARCH_STRICTNESS = os.environ.get("AZURE_SEARCH_STRICTNESS", 3)
 
 # AOAI Integration Settings
 AZURE_OPENAI_RESOURCE = os.environ.get("AZURE_OPENAI_RESOURCE")
@@ -187,7 +188,8 @@ def prepare_body_headers_with_data(request):
                     "roleInformation": AZURE_OPENAI_SYSTEM_MESSAGE,
                     "embeddingEndpoint": AZURE_OPENAI_EMBEDDING_ENDPOINT,
                     "embeddingKey": AZURE_OPENAI_EMBEDDING_KEY,
-                    "filter": filter
+                    "filter": filter,
+                    "strictness": int(AZURE_SEARCH_STRICTNESS)
                 }
             }
         ]

infrastructure/deployment.json

@@ -230,6 +230,20 @@
                 "description": "Azure Search Permitted Groups Field"
             }
         },
+        "AzureSearchStrictness": {
+            "type": "int",
+            "defaultValue": 3,
+            "allowedValues": [
+                1,
+                2,
+                3,
+                4,
+                5
+            ],
+            "metadata": {
+                "description": "Azure Search Strictness"
+            }
+        },
         "AzureOpenAIEmbeddingEndpoint": {
             "type": "string",
             "defaultValue": "",
@@ -398,6 +412,10 @@
                             "name": "AZURE_SEARCH_PERMITTED_GROUPS_COLUMN",
                             "value": "[parameters('AzureSearchPermittedGroupsField')]"
                         },
+                        {
+                            "name": "AZURE_SEARCH_STRICTNESS",
+                            "value": "[parameters('AzureSearchStrictness')]"
+                        },
                         {
                             "name": "AZURE_OPENAI_EMBEDDING_ENDPOINT",
                             "value": "[parameters('AzureOpenAIEmbeddingEndpoint')]"