Add async batch image APIs in 2024-01-30-preview

specification/cognitiveservices/ContentSafety/models.tsp

@@ -40,6 +40,32 @@ enum AnalyzeImageOutputType {
   FourSeverityLevels,
 }
 
+@added(ContentSafety.Versions.v2024_01_30_Preview)
+@doc("The type of batch results storage mode.")
+enum BatchResultsStorageMode {
+  @doc("Merge each result into one file.")
+  CollectiveResultFile,
+
+  @doc("Store each result in a single file.")
+  IndividualResultFiles,
+}
+
+@added(ContentSafety.Versions.v2024_01_30_Preview)
+@doc("The type of batch analysis task status.")
+enum BatchTaskStatus {
+  @doc("The task has not started yet.")
+  NotStarted,
+
+  @doc("The task is in progress.")
+  Running,
+
+  @doc("The task has failed.")
+  Failed,
+
+  @doc("The task has been succeeded.")
+  Succeeded,
+}
+
 @added(ContentSafety.Versions.v2024_01_30_Preview)
 enum ModelStatus {
   created,
@@ -213,6 +239,51 @@ model ImageCategoriesAnalysis {
   severity?: int32;
 }
 
+@added(ContentSafety.Versions.v2024_01_30_Preview)
+@doc("The image batch analysis request.")
+model BatchAnalyzeImagesOptions {
+  @doc("The URL of the Azure Storage Blob containing all the images to be analyzed in the batch task.")
+  imagesBlobFolderUrl: url;
+
+  @doc("The URL of the Azure Storage Blob where the batch task results will be written.")
+  analysisResultsBlobFolderUrl: url;
+
+  @doc("The storage mode for the batch task results, either 'CollectiveResultFile' or 'IndividualResultFiles'.")
+  resultsStorageMode?: BatchResultsStorageMode = BatchResultsStorageMode.CollectiveResultFile;
+
+  @doc("The categories will be analyzed. If they are not assigned, a default set of analysis results for the categories will be returned.")
+  categories?: ImageCategory[];
+
+  @doc("This refers to the type of image analysis output. If no value is assigned, the default value will be \"FourSeverityLevels\".")
+  outputType?: AnalyzeImageOutputType = AnalyzeImageOutputType.FourSeverityLevels;
+
+  @doc("The incidents to detect.")
+  incidents?: IncidentOptions;
+}
+
+@added(ContentSafety.Versions.v2024_01_30_Preview)
+@doc("Image batch analyze task.")
+@resource("image/batchAnalyzeTasks")
+model ImageBatchTaskDetail {
+  @doc("The id of image batch analysis task.")
+  @key("taskId")
+  @visibility("read")
+  @maxLength(64)
+  taskId: string;
+
+  @doc("The status of the batch image analysis task.")
+  status: BatchTaskStatus;
+
+  @doc("The progress of the batch image analysis task, represented as a percentage (0-100).")
+  progressPercentage: float64;
+
+  @doc("The timestamp of when batch image analysis task was created.")
+  taskCreatedTime: utcDateTime;
+
+  @doc("Return error detail when the task failed.")
+  error?: Azure.Core.Foundations.Error;
+}
+
 @doc("Text Blocklist.")
 @resource("text/blocklists")
 model TextBlocklist {

specification/cognitiveservices/ContentSafety/routes.tsp

@@ -81,6 +81,41 @@ interface ImageOperations {
   >;
 }
 
+interface ImageBatchOperations {
+  @added(ContentSafety.Versions.v2024_01_30_Preview)
+  @summary("Start Batch Analyze Images")
+  @doc("An asynchronous API for the batch analysis of potentially harmful image content. Currently, it supports four categories: Hate, SelfHarm, Sexual, and Violence.")
+  @route("/image:batchAnalyze")
+  batchAnalyzeImage is ImageLongRunningRpcOperation<
+    {
+      @body
+      @doc("The image batch analysis request.")
+      body: BatchAnalyzeImagesOptions;
+    },
+    ImageBatchTaskDetail
+  >;
+
+  @added(ContentSafety.Versions.v2024_01_30_Preview)
+  @summary("Get Batch Analyze Status")
+  @doc("Check the status of a batch image analysis task.")
+  getBatchTaskStatus is Azure.Core.ResourceRead<ImageBatchTaskDetail>;
+}
+
+@doc("Long running RPC operation template")
+op ImageLongRunningRpcOperation<
+  TParams extends TypeSpec.Reflection.Model,
+  TResponse extends TypeSpec.Reflection.Model
+> is Azure.Core.Foundations.Operation<
+  TParams,
+  Azure.Core.Foundations.AcceptedResponse & TResponse,
+  Azure.Core.Foundations.ErrorResponse
+>;
+
+interface BatchOps
+  extends Azure.Core.ResourceOperations<NoRepeatableRequests &
+      NoConditionalRequests &
+      NoClientRequestId> {}
+
 interface BlockOps
   extends Azure.Core.ResourceOperations<NoRepeatableRequests &
       NoConditionalRequests &

specification/cognitiveservices/data-plane/ContentSafety/preview/2024-01-30-preview/contentsafety.json

@@ -59,6 +59,46 @@
   },
   "tags": [],
   "paths": {
+    "/image/batchAnalyzeTasks/{taskId}": {
+      "get": {
+        "operationId": "ImageBatchOperations_GetBatchTaskStatus",
+        "summary": "Get Batch Analyze Status",
+        "description": "Check the status of a batch image analysis task.",
+        "parameters": [
+          {
+            "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
+          },
+          {
+            "name": "taskId",
+            "in": "path",
+            "description": "The id of image batch analysis task.",
+            "required": true,
+            "type": "string",
+            "maxLength": 64
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "The request has succeeded.",
+            "schema": {
+              "$ref": "#/definitions/ImageBatchTaskDetail"
+            }
+          },
+          "default": {
+            "description": "An unexpected error response.",
+            "schema": {
+              "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse"
+            },
+            "headers": {
+              "x-ms-error-code": {
+                "type": "string",
+                "description": "String error code indicating what went wrong."
+              }
+            }
+          }
+        }
+      }
+    },
     "/image/incidents": {
       "get": {
         "operationId": "ImageIncidents_ListIncidents",
@@ -475,6 +515,47 @@
         }
       }
     },
+    "/image:batchAnalyze": {
+      "post": {
+        "operationId": "ImageBatchOperations_BatchAnalyzeImage",
+        "summary": "Start Batch Analyze Images",
+        "description": "An asynchronous API for the batch analysis of potentially harmful image content. Currently, it supports four categories: Hate, SelfHarm, Sexual, and Violence.",
+        "parameters": [
+          {
+            "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
+          },
+          {
+            "name": "body",
+            "in": "body",
+            "description": "The image batch analysis request.",
+            "required": true,
+            "schema": {
+              "$ref": "#/definitions/BatchAnalyzeImagesOptions"
+            }
+          }
+        ],
+        "responses": {
+          "202": {
+            "description": "The request has been accepted for processing, but processing has not yet completed.",
+            "schema": {
+              "$ref": "#/definitions/ImageBatchTaskDetail"
+            }
+          },
+          "default": {
+            "description": "An unexpected error response.",
+            "schema": {
+              "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse"
+            },
+            "headers": {
+              "x-ms-error-code": {
+                "type": "string",
+                "description": "String error code indicating what went wrong."
+              }
+            }
+          }
+        }
+      }
+    },
     "/imageWithText:analyze": {
       "post": {
         "operationId": "ImageWithTextOperations_AnalyzeImageWithText",
@@ -2335,6 +2416,107 @@
         }
       }
     },
+    "BatchAnalyzeImagesOptions": {
+      "type": "object",
+      "description": "The image batch analysis request.",
+      "properties": {
+        "imagesBlobFolderUrl": {
+          "type": "string",
+          "format": "uri",
+          "description": "The URL of the Azure Storage Blob containing all the images to be analyzed in the batch task."
+        },
+        "analysisResultsBlobFolderUrl": {
+          "type": "string",
+          "format": "uri",
+          "description": "The URL of the Azure Storage Blob where the batch task results will be written."
+        },
+        "resultsStorageMode": {
+          "$ref": "#/definitions/BatchResultsStorageMode",
+          "description": "The storage mode for the batch task results, either 'CollectiveResultFile' or 'IndividualResultFiles'.",
+          "default": "CollectiveResultFile"
+        },
+        "categories": {
+          "type": "array",
+          "description": "The categories will be analyzed. If they are not assigned, a default set of analysis results for the categories will be returned.",
+          "items": {
+            "$ref": "#/definitions/ImageCategory"
+          }
+        },
+        "outputType": {
+          "$ref": "#/definitions/AnalyzeImageOutputType",
+          "description": "This refers to the type of image analysis output. If no value is assigned, the default value will be \"FourSeverityLevels\".",
+          "default": "FourSeverityLevels"
+        },
+        "incidents": {
+          "$ref": "#/definitions/IncidentOptions",
+          "description": "The incidents to detect."
+        }
+      },
+      "required": [
+        "imagesBlobFolderUrl",
+        "analysisResultsBlobFolderUrl"
+      ]
+    },
+    "BatchResultsStorageMode": {
+      "type": "string",
+      "description": "The type of batch results storage mode.",
+      "enum": [
+        "CollectiveResultFile",
+        "IndividualResultFiles"
+      ],
+      "x-ms-enum": {
+        "name": "BatchResultsStorageMode",
+        "modelAsString": true,
+        "values": [
+          {
+            "name": "CollectiveResultFile",
+            "value": "CollectiveResultFile",
+            "description": "Merge each result into one file."
+          },
+          {
+            "name": "IndividualResultFiles",
+            "value": "IndividualResultFiles",
+            "description": "Store each result in a single file."
+          }
+        ]
+      }
+    },
+    "BatchTaskStatus": {
+      "type": "string",
+      "description": "The type of batch analysis task status.",
+      "enum": [
+        "NotStarted",
+        "Running",
+        "Failed",
+        "Succeeded"
+      ],
+      "x-ms-enum": {
+        "name": "BatchTaskStatus",
+        "modelAsString": true,
+        "values": [
+          {
+            "name": "NotStarted",
+            "value": "NotStarted",
+            "description": "The task has not started yet."
+          },
+          {
+            "name": "Running",
+            "value": "Running",
+            "description": "The task is in progress."
+          },
+          {
+            "name": "Failed",
+            "value": "Failed",
+            "description": "The task has failed."
+          },
+          {
+            "name": "Succeeded",
+            "value": "Succeeded",
+            "description": "The task has been succeeded."
+          }
+        ]
+      }
+    },
     "Class": {
       "type": "object",
       "description": "Label definition.",
@@ -2482,6 +2664,42 @@
         "deploymentName"
       ]
     },
+    "ImageBatchTaskDetail": {
+      "type": "object",
+      "description": "Image batch analyze task.",
+      "properties": {
+        "taskId": {
+          "type": "string",
+          "description": "The id of image batch analysis task.",
+          "maxLength": 64,
+          "readOnly": true
+        },
+        "status": {
+          "$ref": "#/definitions/BatchTaskStatus",
+          "description": "The status of the batch image analysis task."
+        },
+        "progressPercentage": {
+          "type": "number",
+          "format": "double",
+          "description": "The progress of the batch image analysis task, represented as a percentage (0-100)."
+        },
+        "taskCreatedTime": {
+          "type": "string",
+          "format": "date-time",
+          "description": "The timestamp of when batch image analysis task was created."
+        },
+        "error": {
+          "$ref": "#/definitions/Azure.Core.Foundations.Error",
+          "description": "Return error detail when the task failed."
+        }
+      },
+      "required": [
+        "taskId",
+        "status",
+        "progressPercentage",
+        "taskCreatedTime"
+      ]
+    },
     "ImageCategoriesAnalysis": {
       "type": "object",
       "description": "Image analysis result.",