Merge pull request #61 from jr-MS/content-safety-louise-update

Custom categories update after dev review

Author: PatrickFarley

articles/ai-services/content-safety/concepts/custom-categories.md

@@ -61,15 +61,15 @@ Then, you collect a balanced dataset with **positive** and (optionally) **negati
 
 ### Step 2: Model training
 
-Once your dataset is ready, the Azure AI Content Safety service uses it to train a new machine learning model. During training, the AI analyzes the data and learns to distinguish between content that matches the category and content that doesn't.
+After you prepare your dataset and define categories, the Azure AI Content Safety service trains a new machine learning model. This model uses your definitions and uploaded dataset to perform data augmentation using a large language model. As a result, the training dataset is made larger and of higher quality. During training, the AI model analyzes the data and learns to differentiate between content that aligns with the specified category and content that does not.
 
 ### Step 3: Model inferencing
 
 After training, you need to evaluate the model to ensure it meets your accuracy requirements. Test the model with new content that it hasn't received before. The evaluation phase helps you identify any potential adjustments you need to make deploying the model into a production environment.
 
 ### Step 4: Model usage
 
-You use the **analyzeCustomCategory** API to analyze text content and determine whether it matches the custom category you've defined. The service will return a score indicating the likelihood that the content matches the category.
+You use the **analyzeCustomCategory** API to analyze text content and determine whether it matches the custom category you've defined. The service will return a Boolean indicating whether the content aligns with the specified category
 
 #### [Custom categories (rapid) API](#tab/rapid)
 

articles/ai-services/content-safety/how-to/custom-categories.md

@@ -86,8 +86,20 @@ curl -X PUT "<your_endpoint>/contentsafety/text/categories/<your_category_name>?
 
 ### Start the category build process:
 
+After you receive the response, store the operation ID (referred to as `id`) in a temporary. You need this ID to retrieve the build status using the **Get status** API.
+
 ```bash
-curl -X POST "<your_endpoint>/contentsafety/text/categories/<your_category_name>:build?api-version=2024-02-15-preview" \
+curl -X POST "<your_endpoint>/contentsafety/text/categories/<your_category_name>:build?api-version=2024-02-15-preview&version={version}" \
+     -H "Ocp-Apim-Subscription-Key: <your_api_key>" \
+     -H "Content-Type: application/json"
+```
+
+### Get the category build status:
+
+To retrieve the status, utilize the `id` obtained from the previous API response and place it in the path of the API below.
+
+```bash
+curl -X GET "<your_endpoint>/contentsafety/text/categories/operations/<id>?api-version=2024-02-15-preview" \
      -H "Ocp-Apim-Subscription-Key: <your_api_key>" \
      -H "Content-Type: application/json"
 ```
@@ -172,6 +184,22 @@ result = trigger_category_build_process(category_name, version)
 print(result)
 ```
 
+### Get the category build status:
+
+To retrieve the status, utilize the `id` obtained from the previous response.
+
+```python
+def get_build_status(id):
+    url = f"{ENDPOINT}/contentsafety/text/categories/operations/{id}?api-version=2024-02-15-preview"
+    response = requests.get(url, headers=headers)
+    return response.status_code
+
+# Replace the parameter with your own value
+id = "your-operation-id"
+
+result = get_build_status(id)
+print(result)
+```
 
 ## Analyze text with a customized category
 

articles/ai-services/content-safety/includes/storage-account-access.md

@@ -16,10 +16,10 @@ Next, you need to give your Content Safety resource access to read from the Azur
 
     :::image type="content" source="/azure/ai-services/content-safety/media/role-assignment.png" alt-text="Screenshot of Azure portal enabling managed identity.":::
 
-1. Assign the role of **Storage Blob Data Contributor/Owner/Reader** to the Managed identity. Any roles highlighted below should work.
+1. Assign the role of **Storage Blob Data Contributor/Owner** to the Managed identity. Any roles highlighted below should work.
 
     :::image type="content" source="/azure/ai-services/content-safety/media/add-role-assignment.png" alt-text="Screenshot of the Add role assignment screen in Azure portal.":::
 
     :::image type="content" source="/azure/ai-services/content-safety/media/assigned-roles.png" alt-text="Screenshot of assigned roles in the Azure portal.":::
 
-    :::image type="content" source="/azure/ai-services/content-safety/media/managed-identity-role.png" alt-text="Screenshot of the managed identity role.":::
+    :::image type="content" source="/azure/ai-services/content-safety/media/managed-identity-role.png" alt-text="Screenshot of the managed identity role.":::

articles/ai-services/content-safety/overview.md

@@ -124,6 +124,8 @@ See the following list for the input requirements for each feature.
 - **Protected material detection (preview)**: 
   - Default maximum length: 1K characters.
   - Default minimum length: 110 characters (for scanning LLM completions, not user prompts).
+- **Custom categories (standard)**:
+  - Maximum inference input length: 1K characters.
 
 
 ### Language support

articles/ai-services/content-safety/quickstart-custom-categories.md

@@ -69,13 +69,22 @@ curl -X PUT "<your_endpoint>/contentsafety/text/categories/survival-advice?api-v
 
 ### Start the category build process:
 
-Replace `<your_api_key>` and `<your_endpoint>` with your own values. Allow enough time for model training: the end-to-end execution of custom category training can take from around five hours to ten hours. Plan your moderation pipeline accordingly.
+Replace `<your_api_key>` and `<your_endpoint>` with your own values. Allow enough time for model training: the end-to-end execution of custom category training can take from around five hours to ten hours. Plan your moderation pipeline accordingly. After you receive the response, store the operation ID (referred to as `id`) in a temporary location. This ID will be necessary for retrieving the build status using the **Get status** API in the next section.
 
 ```bash
 curl -X POST "<your_endpoint>/contentsafety/text/categories/survival-advice:build?api-version=2024-02-15-preview" \
      -H "Ocp-Apim-Subscription-Key: <your_api_key>" \
      -H "Content-Type: application/json"
 ```
+### Get the category build status:
+
+To retrieve the status, utilize the `id` obtained from the previous API response and place it in the path of the API below.
+
+```bash
+curl -X GET "<your_endpoint>/contentsafety/text/categories/operations/<id>?api-version=2024-02-15-preview" \
+     -H "Ocp-Apim-Subscription-Key: <your_api_key>" \
+     -H "Content-Type: application/json"
+```
 
 ## Analyze text with a customized category
 
@@ -141,7 +150,7 @@ print(result)
 
 ### Start the category build process
 
-You can start the category build process with the *category name* and *version number*. Allow enough time for model training: the end-to-end execution of custom category training can take from around five hours to ten hours. Plan your moderation pipeline accordingly.
+You can start the category build process with the *category name* and *version number*. Allow enough time for model training: the end-to-end execution of custom category training can take from around five hours to ten hours. Plan your moderation pipeline accordingly. After receiving the response, ensure that you store the operation ID (referred to as `id`) somewhere like your notebook. This ID will be necessary for retrieving the build status using the ‘get_build_status’ function in the next section.
 
 ```python
 def trigger_category_build_process(category_name, version):
@@ -157,6 +166,23 @@ result = trigger_category_build_process(category_name, version)
 print(result)
 ```
 
+### Get the category build status:
+
+To retrieve the status, utilize the `id` obtained from the previous response.
+
+```python
+def get_build_status(id):
+    url = f"{ENDPOINT}/contentsafety/text/categories/operations/{id}?api-version=2024-02-15-preview"
+    response = requests.get(url, headers=headers)
+    return response.status_code
+
+# Replace the parameter with your own value
+id = "your-operation-id"
+
+result = get_build_status(id)
+print(result)
+```
+
 
 ## Analyze text with a customized category