Update sample code after testing

Author: Zhi Zhou

notebooks/build_person_directory.ipynb

@@ -80,13 +80,14 @@
    "outputs": [],
    "source": [
     "import os\n",
+    "import uuid\n",
     "folder_path = \"../data/face/enrollment_data\"  # Replace with the path to your folder containing subfolders of images\n",
     "\n",
     "# Create a person directory\n",
-    "person_directory_id = \"person_directory_id\"\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",
     "\n",
-    "person_ids = []\n",
     "# Iterate through all subfolders in the folder_path\n",
     "for subfolder_name in os.listdir(folder_path):\n",
     "    subfolder_path = os.path.join(folder_path, subfolder_name)\n",
@@ -96,22 +97,18 @@
     "        person = client.add_person(person_directory_id, tags={\"name\": person_name})\n",
     "        print(f\"Created person {person_name} with person_id: {person['personId']}\")\n",
     "        if person:\n",
-    "            person_ids.append(person['personId'])\n",
-    "        # Iterate through all images in the subfolder\n",
-    "        for filename in os.listdir(subfolder_path):\n",
-    "            if filename.lower().endswith(('.png', '.jpg', '.jpeg')):\n",
-    "                image_path = os.path.join(subfolder_path, filename)\n",
-    "                # Convert image to base64\n",
-    "                image_data = AzureContentUnderstandingFaceClient.read_file_to_base64(image_path)\n",
-    "                # 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",
-    "                else:\n",
-    "                    print(f\"Failed to add face from {filename} to person_id: {person['personId']}\")\n",
-    "\n",
-    "# Output the person IDs created\n",
-    "print(f\"Person IDs: {person_ids}\")\n",
+    "            # Iterate through all images in the subfolder\n",
+    "            for filename in os.listdir(subfolder_path):\n",
+    "                if filename.lower().endswith(('.png', '.jpg', '.jpeg')):\n",
+    "                    image_path = os.path.join(subfolder_path, filename)\n",
+    "                    # Convert image to base64\n",
+    "                    image_data = AzureContentUnderstandingFaceClient.read_file_to_base64(image_path)\n",
+    "                    # 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",
+    "                    else:\n",
+    "                        print(f\"Failed to add face from {filename} to person_id: {person['personId']}\")\n",
     "\n",
     "print(\"Done\")"
    ]
@@ -135,15 +132,14 @@
     "test_image_path = \"../data/face/family.jpg\"  # Path to the test image\n",
     "\n",
     "# Detect faces in the test image\n",
-    "with open(test_image_path, \"rb\") as image_file:\n",
-    "    image_data = AzureContentUnderstandingFaceClient.read_file_to_base64(image_file)\n",
-    "    detected_faces = client.detect_faces(person_directory_id, image_data)\n",
-    "    for face in detected_faces:\n",
-    "        identified_persons = client.identify_person(person_directory_id, image_data, face['boundingBox'])\n",
-    "        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",
+    "image_data = AzureContentUnderstandingFaceClient.read_file_to_base64(test_image_path)\n",
+    "detected_faces = client.detect_faces(data=image_data)\n",
+    "for face in detected_faces['detectedFaces']:\n",
+    "    identified_persons = client.identify_person(person_directory_id, image_data, face['boundingBox'])\n",
+    "    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",
     "\n",
     "print(\"Done\")"
    ]
@@ -170,9 +166,9 @@
     "# Convert the new face image to base64\n",
     "image_data = AzureContentUnderstandingFaceClient.read_file_to_base64(new_face_image_path)\n",
     "# Add the new face to the person directory and associate it with the existing person\n",
-    "face_id = client.add_face(person_directory_id, image_data, person['personId'])\n",
-    "if face_id:\n",
-    "    print(f\"Added face from {new_face_image_path} with face_id: {face_id} to person_id: {existing_person_id}\")\n",
+    "face = client.add_face(person_directory_id, image_data, person['personId'])\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",
     "else:\n",
     "    print(f\"Failed to add face from {new_face_image_path} to person_id: {existing_person_id}\")"
    ]
@@ -220,11 +216,15 @@
     "existing_face_id = \"existing_face_id\"  # The unique ID of the face.\n",
     "\n",
     "# Remove the association of the existing face ID from the person\n",
-    "client.update_face(person_directory_id, existing_face_id, person_id=\"null\") # The person_id is set to \"null\" to remove the association\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",
     "\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)"
+    "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"
    ]
   },
   {
@@ -253,17 +253,19 @@
     "    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",
     "\n",
     "# Update the tags for an individual person\n",
     "existing_person_id = \"existing_person_id\"  # The unique ID of the person to update.\n",
-    "person_tags = {\"role\": \"tester\", \"department\": \"engineering\"}\n",
+    "person_tags = {\"role\": \"tester\", \"department\": \"engineering\", \"name\": \"\"} # This will remove the name tag from the person.\n",
     "\n",
     "client.update_person(\n",
     "    person_directory_id,\n",
     "    existing_person_id,\n",
     "    tags=person_tags\n",
     ")\n",
-    "print(f\"Updated person with person_id: {existing_person_id} with tags: {person_tags}\")"
+    "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"
    ]
   },
   {
@@ -284,10 +286,8 @@
    "source": [
     "existing_face_id = \"existing_face_id\" # The unique ID of the face to delete.\n",
     "\n",
-    "if client.delete_face(person_directory_id, existing_face_id):\n",
-    "    print(f\"Deleted face with face_id: {existing_face_id}\")\n",
-    "else:\n",
-    "    print(f\"Failed to delete face with face_id: {existing_face_id}\")"
+    "client.delete_face(person_directory_id, existing_face_id)\n",
+    "print(f\"Deleted face with face_id: {existing_face_id}\")"
    ]
   },
   {
@@ -308,10 +308,9 @@
    "outputs": [],
    "source": [
     "existing_person_id = \"existing_person_id\"  # The unique ID of the person to delete.\n",
-    "if client.delete_person(person_directory_id, existing_person_id):\n",
-    "    print(f\"Deleted person with person_id: {existing_person_id}\")\n",
-    "else:\n",
-    "    print(f\"Failed to delete person with person_id: {existing_person_id}\")"
+    "\n",
+    "client.delete_person(person_directory_id, existing_person_id)\n",
+    "print(f\"Deleted person with person_id: {existing_person_id}\")"
    ]
   },
   {
@@ -339,16 +338,12 @@
     "\n",
     "# Delete each face associated with the person\n",
     "for face_id in face_ids:\n",
-    "    if client.delete_face(person_directory_id, face_id):\n",
-    "        print(f\"Deleted face with face_id: {face_id}\")\n",
-    "    else:\n",
-    "        print(f\"Failed to delete face with face_id: {face_id}\")\n",
+    "    print(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",
-    "if client.delete_person(person_directory_id, existing_person_id):\n",
-    "    print(f\"Deleted person with person_id: {existing_person_id}\")\n",
-    "else:\n",
-    "    print(f\"Failed to delete person with person_id: {existing_person_id}\")"
+    "client.delete_person(person_directory_id, existing_person_id)\n",
+    "print(f\"Deleted person with person_id: {existing_person_id} and all associated faces.\")"
    ]
   }
  ],

python/content_understanding_face_client.py

@@ -60,7 +60,7 @@ def _handle_response(self, response: Response, action: str):
         if response.status_code == 204:
             self._logger.info(f"{action} completed successfully with status 204.")
             return None
-        if response.status_code != 200:
+        if response.status_code != 200 and response.status_code != 201:
             self._logger.error(
                 f"Error in {action}: {response.status_code} - {response.text}"
             )
@@ -141,14 +141,14 @@ def delete_person_directory(self, person_directory_id: str):
         )
         return self._handle_response(response, "delete_person_directory")
 
-    def get_persons(self, person_directory_id: str):
+    def list_persons(self, person_directory_id: str):
         response = requests.get(
             self._get_person_directory_url(
                 self._endpoint, self._api_version, f"{person_directory_id}/persons"
             ),
             headers=self._headers,
         )
-        return self._handle_response(response, "get_persons")
+        return self._handle_response(response, "list_persons")
 
     def get_person(self, person_directory_id: str, person_id: str):
         response = requests.get(
@@ -209,7 +209,7 @@ def delete_person(self, person_directory_id: str, person_id: str):
         )
         return self._handle_response(response, "delete_person")
 
-    def get_faces(self, person_directory_id: str):
+    def list_faces(self, person_directory_id: str):
         response = requests.get(
             self._get_person_directory_url(
                 self._endpoint,
@@ -218,7 +218,7 @@ def get_faces(self, person_directory_id: str):
             ),
             headers=self._headers,
         )
-        return self._handle_response(response, "get_faces")
+        return self._handle_response(response, "list_faces")
 
     def get_face(self, person_directory_id: str, face_id: str):
         response = requests.get(