updates

Author: slister1001

scenarios/evaluate/AI_RedTeaming/AI_RedTeaming.ipynb

@@ -14,20 +14,43 @@
     "\n",
     "## Before you begin\n",
     "\n",
+    "### Prerequisite\n",
+    "The AI Red Teaming Agent requires an Azure AI Foundry project configuration and Azure credentials. Your project configuration will be used to log red teaming scan results after the run is finished.\n",
+    "\n",
+    "**Important**: Make sure to authenticate to Azure using `az login` in your terminal before running this notebook.\n",
+    "\n",
     "### Installation\n",
-    "Execute the following cells in a terminal window. Install the following packages required to execute this notebook, then use the virtual environment created as kernel to run the remainder of this notebook."
+    "From a terminal window, navigate to your working directory which contains this sample notebook, and execute the following.\n",
+    "```bash\n",
+    "python -m venv .venv\n",
+    "```\n",
+    "\n",
+    "Then, activate the virtual environment created:\n",
+    "\n",
+    "```bash\n",
+    "# %source .venv/bin/activate # If using Mac/Linux OS\n",
+    ".venv/Scripts/activate # If using Windows OS\n",
+    "```\n",
+    "\n",
+    "With your virtual environment activated, install the following packages required to execute this notebook:\n",
+    "\n",
+    "```bash\n",
+    "pip install uv\n",
+    "uv pip install azure-ai-evaluation[redteam] termcolor==2.5.0 azure-identity openai\n",
+    "```\n",
+    "\n",
+    "\n",
+    "Now open VSCode with the following command, and ensure your virtual environment is used as kernel to run the remainder of this notebook.\n",
+    "```bash\n",
+    "code .\n",
+    "```"
    ]
   },
   {
-   "cell_type": "code",
-   "execution_count": null,
+   "cell_type": "markdown",
    "metadata": {},
-   "outputs": [],
    "source": [
-    "%%python -m venv .venv\n",
-    "# %source .venv/bin/activate # If using Mac/Linux OS\n",
-    "%.venv/Scripts/activate # If using Windows OS\n",
-    "%pip install uv"
+    "### Imports"
    ]
   },
   {
@@ -36,8 +59,18 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "# install the packages\n",
-    "%uv pip install azure-ai-evaluation[redteam] termcolor==2.5.0 azure-identity openai"
+    "from typing import Optional, Dict, Any\n",
+    "import os\n",
+    "\n",
+    "# Azure imports\n",
+    "from azure.identity import DefaultAzureCredential, get_bearer_token_provider\n",
+    "from azure.ai.evaluation import RedTeam, RiskCategory, AttackStrategy\n",
+    "\n",
+    "# OpenAI imports\n",
+    "from openai import AzureOpenAI\n",
+    "\n",
+    "# Initialize Azure credentials\n",
+    "credential = DefaultAzureCredential()"
    ]
   },
   {
@@ -77,8 +110,6 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "import os\n",
-    "\n",
     "# Azure AI Project information\n",
     "azure_ai_project = {\n",
     "    \"subscription_id\": os.environ.get(\"AZURE_SUBSCRIPTION_ID\"),\n",
@@ -95,35 +126,6 @@
     "azure_openai_api_version = \"2023-12-01-preview\"  # Use the latest API version"
    ]
   },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "### Configuration\n",
-    "The AI Red Teaming Agent requires an Azure AI Foundry project configuration and Azure credentials. Your project configuration will be used to log red teaming scan results after the run is finished.\n",
-    "\n",
-    "**Important**: Make sure to authenticate to Azure using `az login` in your terminal before running this notebook."
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "from typing import Optional, Dict, Any\n",
-    "\n",
-    "# Azure imports\n",
-    "from azure.identity import DefaultAzureCredential, get_bearer_token_provider\n",
-    "from azure.ai.evaluation import RedTeam, RiskCategory, AttackStrategy\n",
-    "\n",
-    "# OpenAI imports\n",
-    "from openai import AzureOpenAI\n",
-    "\n",
-    "# Initialize Azure credentials\n",
-    "credential = DefaultAzureCredential()"
-   ]
-  },
   {
    "cell_type": "markdown",
    "metadata": {},
@@ -199,7 +201,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "# Create the RedTeam instance with minimal configurations\n",
+    "# Create the `RedTeam` instance with minimal configurations\n",
     "red_team = RedTeam(\n",
     "    azure_ai_project=azure_ai_project,\n",
     "    credential=credential,\n",
@@ -219,7 +221,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "Now let's run a simple red team evaluation using the fixed response target. We'll test against two risk categories and one attack strategy for simplicity."
+    "Now let's run a simple automated scan using the `RedTeam` with the fixed response target. We'll test against two risk categories and one attack strategy for simplicity."
    ]
   },
   {