Merge pull request #34 from Azure-Samples/chienyuanchang/classify_samples

Add sample for classifier

Author: chienyuanchang

README.md

@@ -71,7 +71,7 @@ Once you click the link above, please follow the steps below to set up the Codes
 ## Configure Azure AI service resource
 ### (Option 1) Use `azd` commands to auto create temporal resources to run sample
 1. Make sure you have permission to grant roles under subscription
-1. Login Azure
+2. Login Azure
     ```shell
     azd auth login
     ```
@@ -80,12 +80,11 @@ Once you click the link above, please follow the steps below to set up the Codes
     azd auth login --use-device-code
     ```
 
-1. Setting up environment, following prompts to choose location
+3. Setting up environment, following prompts to choose location
     ```shell
     azd up
     ```
 
-
 ### (Option 2) Manually create resources and set environment variables
 1. Create [Azure AI Services resource](docs/create_azure_ai_service.md)
 2. Go to `Access Control (IAM)` in resource, grant yourself role `Cognitive Services User`
@@ -97,6 +96,21 @@ Once you click the link above, please follow the steps below to set up the Codes
    azd auth login
    ```
 
+### (Option 3) Use Endpoint and Key (No `azd` Required)
+> ⚠️ Note: Using a subscription key works, but using a token provider with Azure Active Directory (AAD) is much safer and is highly recommended for production environments.
+1. Create [Azure AI Services resource](docs/create_azure_ai_service.md)
+2. Copy `notebooks/.env.sample` to `notebooks/.env`
+    ```bash
+    cp notebooks/.env.sample notebooks/.env
+    ```
+3. Update `.env` with your credentials
+    - Edit notebooks/.env and set the following values:
+      ```
+      AZURE_AI_ENDPOINT=https://<your-resource-name>.services.ai.azure.com/
+      AZURE_AI_API_KEY=<your-azure-ai-api-key>
+      ```
+    - Replace <your-resource-name> and <your-azure-ai-api-key> with your actual values. You can find them in your AI Services resource under `Resource Management`/`Keys and Endpoint`
+
 ## Open a Jupyter notebook and follow the step-by-step guidance
 
 Navigate to the `notebooks` directory and select the sample notebook you are interested in. Since the Dev Container (in Codespaces or in your local enviornment) is pre-configured with the necessary environment, you can directly execute each step in the notebook.
@@ -119,11 +133,12 @@ Azure AI Content Understanding is a new Generative AI-based [Azure AI service](h
 | File | Description |
 | --- | --- |
 | [content_extraction.ipynb](notebooks/content_extraction.ipynb) | In this sample we will show content understanding API can help you get semantic information from your file. For example OCR with table in document, audio transcription, and face analysis in video. |
-| [field_extraction.ipynb](notebooks/field_extraction.ipynb) | In this sample we will show how to create an analyzer to extract fields in your file. For example invoice amount in the document, how many people in an image, names mentioned in an audio, or summary of a video. You can customize the fields by creating your own analyzer template.  |
+| [field_extraction.ipynb](notebooks/field_extraction.ipynb) | In this sample we will show how to create an analyzer to extract fields in your file. For example invoice amount in the document, how many people in an image, names mentioned in an audio, or summary of a video. You can customize the fields by creating your own analyzer template. |
+| [classifier.ipynb](notebooks/classifier.ipynb) | This sample will demo how to (1) create a classifier to categorize documents, (2) create a custom analyzer to extract specific fields, and (3) combine classifier and analyzers to classify, optionally split, and analyze documents in a flexible processing pipeline. |
 | [conversational_field_extraction.ipynb](notebooks/conversational_field_extraction.ipynb) | This sample shows you how to evaluate conversational audio data that has previously been transcribed with Content Understanding or Azure AI Speech in in an efficient way to optimize processing quality. This also allows you to re-analyze data in a cost-efficient way. This sample is based on the [field_extraction.ipynb](notebooks/field_extraction.ipynb) sample. |
 | [analyzer_training.ipynb](notebooks/analyzer_training.ipynb) | If you want to futher boost the performance for field extraction, we can do training when you provide few labeled samples to the API. Note: This feature is available to document scenario now. |
 | [management.ipynb](notebooks/management.ipynb) | This sample will demo how to create a minimal analyzer, list all the analyzers in your resource, and delete the analyzer you don't need. |
-| [build_person_directory.ipynb](notebooks/build_person_directory.ipynb) | This sample will demo how to enroll people’s faces from images and build a Person Directory. | |
+| [build_person_directory.ipynb](notebooks/build_person_directory.ipynb) | This sample will demo how to enroll people’s faces from images and build a Person Directory. |
 
 ## More Samples using Azure Content Understanding
 [Azure Search with Content Understanding](https://github.com/Azure-Samples/azure-ai-search-with-content-understanding-python)

data/mixed_financial_docs.pdf

@@ -60,7 +60,14 @@
    "metadata": {},
    "source": [
     "## Create Azure content understanding client\n",
-    ">The [AzureContentUnderstandingClient](../python/content_understanding_client.py) is utility Class which contain the functions to interact with the Content Understanding server. Before Content Understanding SDK release, we can regard it as a lightweight SDK. Fill the constant **AZURE_AI_ENDPOINT**, **AZURE_AI_API_VERSION**, **AZURE_AI_API_KEY** with the information from your Azure AI Service."
+    "> The [AzureContentUnderstandingClient](../python/content_understanding_client.py) is utility Class which contain the functions to interact with the Content Understanding server. Before Content Understanding SDK release, we can regard it as a lightweight SDK. Fill the constant **AZURE_AI_ENDPOINT**, **AZURE_AI_API_VERSION**, **AZURE_AI_API_KEY** with the information from your Azure AI Service.\n",
+    "\n",
+    "> ⚠️ Important:\n",
+    "You must update the code below to match your Azure authentication method.\n",
+    "Look for the `# IMPORTANT` comments and modify those sections accordingly.\n",
+    "If you skip this step, the sample may not run correctly.\n",
+    "\n",
+    "> ⚠️ Note: Using a subscription key works, but using a token provider with Azure Active Directory (AAD) is much safer and is highly recommended for production environments."
    ]
   },
   {
@@ -91,7 +98,10 @@
     "client = AzureContentUnderstandingClient(\n",
     "    endpoint=os.getenv(\"AZURE_AI_ENDPOINT\"),\n",
     "    api_version=os.getenv(\"AZURE_AI_API_VERSION\", \"2025-05-01-preview\"),\n",
+    "    # IMPORTANT: Comment out token_provider if using subscription key\n",
     "    token_provider=token_provider,\n",
+    "    # IMPORTANT: Uncomment this if using subscription key\n",
+    "    # subscription_key=os.getenv(\"AZURE_AI_API_KEY\"),\n",
     "    x_ms_useragent=\"azure-ai-content-understanding-python/analyzer_training\", # This header is used for sample usage telemetry, please comment out this line if you want to opt out.\n",
     ")"
    ]

notebooks/analyzer_training.ipynb

@@ -28,7 +28,14 @@
    "metadata": {},
    "source": [
     "## Create Azure content understanding face client\n",
-    ">The [AzureContentUnderstandingFaceClient](../python/content_understanding_face_client.py) is a utility class for interacting with the Content Understanding Face service. Before the official SDK is released, this acts as a lightweight SDK. Set the constants **AZURE_AI_ENDPOINT**, **AZURE_AI_API_VERSION**, and **AZURE_AI_API_KEY** with your Azure AI Service information."
+    "> The [AzureContentUnderstandingFaceClient](../python/content_understanding_face_client.py) is a utility class for interacting with the Content Understanding Face service. Before the official SDK is released, this acts as a lightweight SDK. Set the constants **AZURE_AI_ENDPOINT**, **AZURE_AI_API_VERSION**, and **AZURE_AI_API_KEY** with your Azure AI Service information.\n",
+    "\n",
+    "> ⚠️ Important:\n",
+    "You must update the code below to match your Azure authentication method.\n",
+    "Look for the `# IMPORTANT` comments and modify those sections accordingly.\n",
+    "If you skip this step, the sample may not run correctly.\n",
+    "\n",
+    "> ⚠️ Note: Using a subscription key works, but using a token provider with Azure Active Directory (AAD) is much safer and is highly recommended for production environments."
    ]
   },
   {
@@ -59,7 +66,10 @@
     "client = AzureContentUnderstandingFaceClient(\n",
     "    endpoint=os.getenv(\"AZURE_AI_ENDPOINT\"),\n",
     "    api_version=os.getenv(\"AZURE_AI_API_VERSION\", \"2025-05-01-preview\"),\n",
+    "    # IMPORTANT: Comment out token_provider if using subscription key\n",
     "    token_provider=token_provider,\n",
+    "    # IMPORTANT: Uncomment this if using subscription key\n",
+    "    # subscription_key=os.getenv(\"AZURE_AI_API_KEY\"),\n",
     "    x_ms_useragent=\"azure-ai-content-understanding-python/build_person_directory\", # This header is used for sample usage telemetry, please comment out this line if you want to opt out.\n",
     ")"
    ]