Address comments from Paul

Zhi Zhou · Zhi Zhou · commit b60f8e920cc7 · 2025-05-19T15:57:22.000-07:00
diff --git a/README.md b/README.md
@@ -17,7 +17,7 @@ Azure AI Content Understanding is a new Generative AI-based [Azure AI service](h
 | [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 person’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. | |
 
 ## Getting started
 ### GitHub Codespaces
diff --git a/notebooks/build_person_directory.ipynb b/notebooks/build_person_directory.ipynb
@@ -15,7 +15,7 @@
    "source": [
     "## Objective\n",
     "\n",
-    " This script builds a Person Directory by enrolling multiple faces for each person from a directory where each subfolder represents a different person. It creates a person for each subfolder and adds all face images within that subfolder to the created person.\n",
+    " This notebook demonstrates how to build a Person Directory by enrolling multiple faces for each person. Each subfolder in a specified directory represents a different person. The script creates a person for each subfolder and adds all face images within that subfolder to the corresponding person\n",
     "\n",
     "| Enrollment | Searching |\n",
     "| :-: | :-: |\n",
@@ -28,7 +28,7 @@
    "metadata": {},
    "source": [
     "## Create Azure content understanding face client\n",
-    ">The [AzureContentUnderstandingFaceClient](../python/content_understanding_face_client.py) is utility Class which contain the functions to interact with the Content Understanding face 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 [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."
    ]
   },
   {
@@ -46,7 +46,7 @@
     "from azure.identity import DefaultAzureCredential, get_bearer_token_provider\n",
     "\n",
     "# import utility package from python samples root directory\n",
-    "parent_dir = Path(Path.cwd()).parent\n",
+    "parent_dir = Path.cwd().parent\n",
     "sys.path.append(str(parent_dir))\n",
     "from python.content_understanding_face_client import AzureContentUnderstandingFaceClient\n",
     "\n",
@@ -86,7 +86,7 @@
     "# Create a person directory\n",
     "person_directory_id = f\"person_directory_id_{uuid.uuid4().hex[:8]}\"\n",
     "client.create_person_directory(person_directory_id)\n",
-    "print(f\"Created person directory with ID: {person_directory_id}\")\n",
+    "logging.info(f\"Created person directory with ID: {person_directory_id}\")\n",
     "\n",
     "# Iterate through all subfolders in the folder_path\n",
     "for subfolder_name in os.listdir(folder_path):\n",
@@ -95,7 +95,7 @@
     "        person_name = subfolder_name\n",
     "        # Add a person for each subfolder\n",
     "        person = client.add_person(person_directory_id, tags={\"name\": person_name})\n",
-    "        print(f\"Created person {person_name} with person_id: {person['personId']}\")\n",
+    "        logging.info(f\"Created person {person_name} with person_id: {person['personId']}\")\n",
     "        if person:\n",
     "            # Iterate through all images in the subfolder\n",
     "            for filename in os.listdir(subfolder_path):\n",
@@ -106,11 +106,11 @@
     "                    # Add a face to the Person Directory and associate it to the added person\n",
     "                    face = client.add_face(person_directory_id, image_data, person['personId'])\n",
     "                    if face:\n",
-    "                        print(f\"Added face from {filename} with face_id: {face['faceId']} to person_id: {person['personId']}\")\n",
+    "                        logging.info(f\"Added face from {filename} with face_id: {face['faceId']} to person_id: {person['personId']}\")\n",
     "                    else:\n",
-    "                        print(f\"Failed to add face from {filename} to person_id: {person['personId']}\")\n",
+    "                        logging.warning(f\"Failed to add face from {filename} to person_id: {person['personId']}\")\n",
     "\n",
-    "print(\"Done\")"
+    "logging.info(\"Done\")"
    ]
   },
   {
@@ -119,7 +119,7 @@
    "metadata": {},
    "source": [
     "### Identifying person\n",
-    "Detect multiple faces in an image and identify each one by matching it against enrolled persons in a Person Directory."
+    "Detect multiple faces in an image and identify each one by matching it against enrolled persons in the Person Directory."
    ]
   },
   {
@@ -139,9 +139,9 @@
     "    if identified_persons.get(\"personCandidates\"):\n",
     "        person = identified_persons[\"personCandidates\"][0]\n",
     "        name = person.get(\"tags\", {}).get(\"name\", \"Unknown\")\n",
-    "        print(f\"Detected person: {name} with confidence: {person.get('confidence', 0)} at bounding box: {face['boundingBox']}\")\n",
+    "        logging.info(f\"Detected person: {name} with confidence: {person.get('confidence', 0)} at bounding box: {face['boundingBox']}\")\n",
     "\n",
-    "print(\"Done\")"
+    "logging.info(\"Done\")"
    ]
   },
   {
@@ -150,7 +150,7 @@
    "metadata": {},
    "source": [
     "### Adding and associating a new face\n",
-    "You can add an additional face to a Person Directory and associate it with an already enrolled person."
+    "You can add a new face to the Person Directory and associate it with an existing person."
    ]
   },
   {
@@ -168,9 +168,9 @@
     "# Add the new face to the person directory and associate it with the existing person\n",
     "face = client.add_face(person_directory_id, image_data, existing_person_id)\n",
     "if face:\n",
-    "    print(f\"Added face from {new_face_image_path} with face_id: {face['faceId']} to person_id: {existing_person_id}\")\n",
+    "    logging.info(f\"Added face from {new_face_image_path} with face_id: {face['faceId']} to person_id: {existing_person_id}\")\n",
     "else:\n",
-    "    print(f\"Failed to add face from {new_face_image_path} to person_id: {existing_person_id}\")"
+    "    logging.warning(f\"Failed to add face from {new_face_image_path} to person_id: {existing_person_id}\")"
    ]
   },
   {
@@ -180,7 +180,7 @@
    "source": [
     "### Associating a list of already enrolled faces\n",
     "\n",
-    "You can associate a list of already enrolled faces in the Person Directory with their respective persons. This can be useful when you have existing face IDs and want to associate them to specific persons in the directory."
+    "You can associate a list of already enrolled faces in the Person Directory with their respective persons. This is useful if you have existing face IDs to link to specific persons."
    ]
   },
   {
@@ -217,14 +217,14 @@
     "\n",
     "# Remove the association of the existing face ID from the person\n",
     "client.update_face(person_directory_id, existing_face_id, person_id=\"\") # The person_id is set to \"\" to remove the association\n",
-    "print(f\"Removed association of face_id: {existing_face_id} from the existing person_id\")\n",
-    "print(client.get_face(person_directory_id, existing_face_id)) # This will return the face information without the person association\n",
+    "logging.info(f\"Removed association of face_id: {existing_face_id} from the existing person_id\")\n",
+    "logging.info(client.get_face(person_directory_id, existing_face_id)) # This will return the face information without the person association\n",
     "\n",
     "# Associate the existing face ID with a person\n",
     "existing_person_id = \"existing_person_id\"  # The unique ID of the person to be associated with the face.\n",
     "client.update_face(person_directory_id, existing_face_id, person_id=existing_person_id)\n",
-    "print(f\"Associated face_id: {existing_face_id} with person_id: {existing_person_id}\")\n",
-    "print(client.get_face(person_directory_id, existing_face_id)) # This will return the face information with the new person association"
+    "logging.info(f\"Associated face_id: {existing_face_id} with person_id: {existing_person_id}\")\n",
+    "logging.info(client.get_face(person_directory_id, existing_face_id)) # This will return the face information with the new person association"
    ]
   },
   {
@@ -233,7 +233,7 @@
    "metadata": {},
    "source": [
     "### Updating metadata (tags and descriptions)\n",
-    "You can add or update tags for individual persons, and both descriptions and tags for the overall Person Directory. These metadata fields help you better organize, filter, and manage your directory."
+    "You can add or update tags for individual persons, and both descriptions and tags for the Person Directory. These metadata fields help organize, filter, and manage your directory."
    ]
   },
   {
@@ -252,8 +252,8 @@
     "    description=person_directory_description,\n",
     "    tags=person_directory_tags\n",
     ")\n",
-    "print(f\"Updated Person Directory with description: '{person_directory_description}' and tags: {person_directory_tags}\")\n",
-    "print(client.get_person_directory(person_directory_id)) # This will return the updated person directory information\n",
+    "logging.info(f\"Updated Person Directory with description: '{person_directory_description}' and tags: {person_directory_tags}\")\n",
+    "logging.info(client.get_person_directory(person_directory_id)) # This will return the updated person directory information\n",
     "\n",
     "# Update the tags for an individual person\n",
     "existing_person_id = \"existing_person_id\"  # The unique ID of the person to update.\n",
@@ -264,8 +264,8 @@
     "    existing_person_id,\n",
     "    tags=person_tags\n",
     ")\n",
-    "print(f\"Updated person with person_id: {existing_person_id} with tags: {person_tags}\")\n",
-    "print(client.get_person(person_directory_id, existing_person_id)) # This will return the updated person information"
+    "logging.info(f\"Updated person with person_id: {existing_person_id} with tags: {person_tags}\")\n",
+    "logging.info(client.get_person(person_directory_id, existing_person_id)) # This will return the updated person information"
    ]
   },
   {
@@ -287,7 +287,7 @@
     "existing_face_id = \"existing_face_id\" # The unique ID of the face to delete.\n",
     "\n",
     "client.delete_face(person_directory_id, existing_face_id)\n",
-    "print(f\"Deleted face with face_id: {existing_face_id}\")"
+    "logging.info(f\"Deleted face with face_id: {existing_face_id}\")"
    ]
   },
   {
@@ -310,7 +310,7 @@
     "existing_person_id = \"existing_person_id\"  # The unique ID of the person to delete.\n",
     "\n",
     "client.delete_person(person_directory_id, existing_person_id)\n",
-    "print(f\"Deleted person with person_id: {existing_person_id}\")"
+    "logging.info(f\"Deleted person with person_id: {existing_person_id}\")"
    ]
   },
   {
@@ -338,12 +338,12 @@
     "\n",
     "# Delete each face associated with the person\n",
     "for face_id in face_ids:\n",
-    "    print(f\"Deleting face with face_id: {face_id} from person_id: {existing_person_id}\")\n",
+    "    logging.info(f\"Deleting face with face_id: {face_id} from person_id: {existing_person_id}\")\n",
     "    client.delete_face(person_directory_id, face_id)\n",
     "\n",
     "# Delete the person after deleting all associated faces\n",
     "client.delete_person(person_directory_id, existing_person_id)\n",
-    "print(f\"Deleted person with person_id: {existing_person_id} and all associated faces.\")"
+    "logging.info(f\"Deleted person with person_id: {existing_person_id} and all associated faces.\")"
    ]
   }
  ],
