Format

specification/ai/DocumentIntelligence/routes.tsp

@@ -52,9 +52,9 @@ model DocumentModelAnalyzeRequestParams {
   pages?: string;
 
   @doc("""
-  Locale hint for text recognition and document analysis.  Value may contain only
-  the language code (ex. \"en\", \"fr\") or BCP 47 language tag (ex. \"en-US\").
-  """)
+    Locale hint for text recognition and document analysis.  Value may contain only
+    the language code (ex. \"en\", \"fr\") or BCP 47 language tag (ex. \"en-US\").
+    """)
   @query
   locale?: string;
 
@@ -208,9 +208,9 @@ interface DocumentModels {
 
   #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "Doesn't fit standard ops"
   @doc("""
-  Generates authorization to copy a document model to this location with
-  specified modelId and optional description.
-  """)
+    Generates authorization to copy a document model to this location with
+    specified modelId and optional description.
+    """)
   @route("/documentModels:authorizeCopy")
   @post
   authorizeModelCopy is DocumentIntelligenceOperation<

specification/ai/Face/main.tsp

@@ -23,9 +23,9 @@ using TypeSpec.Versioning;
   "Azure AI Face API",
   {
     @doc("""
-Supported Cognitive Services endpoints (protocol and hostname, for example:
-https://{resource-name}.cognitiveservices.azure.com).
-""")
+      Supported Cognitive Services endpoints (protocol and hostname, for example:
+      https://{resource-name}.cognitiveservices.azure.com).
+      """)
     endpoint: url,
 
     @doc("API Version")

specification/ai/Face/models.common.tsp

@@ -259,30 +259,30 @@ model GroupingResult {
 }
 
 alias AddFaceDescriptionInList = """
->
-*
-  * Higher face image quality means better recognition precision. Please consider high-quality faces: frontal, clear, and face size is 200x200 pixels (100 pixels between eyes) or bigger.
-  * Each person entry can hold up to 248 faces.
-  * JPEG, PNG, GIF (the first frame), and BMP format are supported. The allowed image file size is from 1KB to 6MB.
-  * "targetFace" rectangle should contain one face. Zero or multiple faces will be regarded as an error. If the provided "targetFace" rectangle is not returned from \"Detect\", there's no guarantee to detect and add the face successfully.
-  * Out of detectable face size (36x36 - 4096x4096 pixels), large head-pose, or large occlusions will cause failures.
-  * The minimum detectable face size is 36x36 pixels in an image no larger than 1920x1080 pixels. Images with dimensions higher than 1920x1080 pixels will need a proportionally larger minimum face size.
-  * Different 'detectionModel' values can be provided. To use and compare different detection models, please refer to https://learn.microsoft.com/azure/ai-services/computer-vision/how-to/specify-detection-model
-""";
+  >
+  *
+    * Higher face image quality means better recognition precision. Please consider high-quality faces: frontal, clear, and face size is 200x200 pixels (100 pixels between eyes) or bigger.
+    * Each person entry can hold up to 248 faces.
+    * JPEG, PNG, GIF (the first frame), and BMP format are supported. The allowed image file size is from 1KB to 6MB.
+    * "targetFace" rectangle should contain one face. Zero or multiple faces will be regarded as an error. If the provided "targetFace" rectangle is not returned from \"Detect\", there's no guarantee to detect and add the face successfully.
+    * Out of detectable face size (36x36 - 4096x4096 pixels), large head-pose, or large occlusions will cause failures.
+    * The minimum detectable face size is 36x36 pixels in an image no larger than 1920x1080 pixels. Images with dimensions higher than 1920x1080 pixels will need a proportionally larger minimum face size.
+    * Different 'detectionModel' values can be provided. To use and compare different detection models, please refer to https://learn.microsoft.com/azure/ai-services/computer-vision/how-to/specify-detection-model
+  """;
 
 alias ListRequestOptionsDescriptionInList = """
->
-*
-  * "start" parameter (string, optional) specifies an ID value from which returned entries will have larger IDs based on string comparison. Setting "start" to an empty value indicates that entries should be returned starting from the first item.
-  * "top" parameter (int, optional) determines the maximum number of entries to be returned, with a limit of up to 1000 entries per call. To retrieve additional entries beyond this limit, specify "start" with the personId of the last entry returned in the current call.
-
-> [!TIP]
->
-> * For example, there are total 5 items with their IDs: "itemId1", ..., "itemId5".
->   * "start=&top=" will return all 5 items.
->   * "start=&top=2" will return "itemId1", "itemId2".
->   * "start=itemId2&top=3" will return "itemId3", "itemId4", "itemId5".
-""";
+  >
+  *
+    * "start" parameter (string, optional) specifies an ID value from which returned entries will have larger IDs based on string comparison. Setting "start" to an empty value indicates that entries should be returned starting from the first item.
+    * "top" parameter (int, optional) determines the maximum number of entries to be returned, with a limit of up to 1000 entries per call. To retrieve additional entries beyond this limit, specify "start" with the personId of the last entry returned in the current call.
+  
+  > [!TIP]
+  >
+  > * For example, there are total 5 items with their IDs: "itemId1", ..., "itemId5".
+  >   * "start=&top=" will return all 5 items.
+  >   * "start=&top=2" will return "itemId1", "itemId2".
+  >   * "start=itemId2&top=3" will return "itemId3", "itemId4", "itemId5".
+  """;
 
 @doc("The error object. For comprehensive details on error codes and messages returned by the Face Service, please refer to the following link: https://aka.ms/face-error-codes-and-messages.")
 model FaceError {

specification/ai/Face/routes.detection.tsp

@@ -15,21 +15,21 @@ namespace Face;
 
 @summary("Detect human faces in an image, return face rectangles, and optionally with faceIds, landmarks, and attributes.")
 @doc("""
-> [!IMPORTANT]
-> To mitigate potential misuse that can subject people to stereotyping, discrimination, or unfair denial of services, we are retiring Face API attributes that predict emotion, gender, age, smile, facial hair, hair, and makeup. Read more about this decision https://azure.microsoft.com/blog/responsible-ai-investments-and-safeguards-for-facial-recognition/.
-
-*
-  * No image will be stored. Only the extracted face feature(s) will be stored on server. The faceId is an identifier of the face feature and will be used in \"Identify\", \"Verify\", and \"Find Similar\". The stored face features will expire and be deleted at the time specified by faceIdTimeToLive after the original detection call.
-  * Optional parameters include faceId, landmarks, and attributes. Attributes include headPose, glasses, occlusion, accessories, blur, exposure, noise, mask, and qualityForRecognition. Some of the results returned for specific attributes may not be highly accurate.
-  * JPEG, PNG, GIF (the first frame), and BMP format are supported. The allowed image file size is from 1KB to 6MB.
-  * The minimum detectable face size is 36x36 pixels in an image no larger than 1920x1080 pixels. Images with dimensions higher than 1920x1080 pixels will need a proportionally larger minimum face size.
-  * Up to 100 faces can be returned for an image. Faces are ranked by face rectangle size from large to small.
-  * For optimal results when querying \"Identify\", \"Verify\", and \"Find Similar\" ('returnFaceId' is true), please use faces that are: frontal, clear, and with a minimum size of 200x200 pixels (100 pixels between eyes).
-  * Different 'detectionModel' values can be provided. To use and compare different detection models, please refer to https://learn.microsoft.com/azure/ai-services/computer-vision/how-to/specify-detection-model
-    * 'detection_02': Face attributes and landmarks are disabled if you choose this detection model.
-    * 'detection_03': Face attributes (mask, blur, and headPose) and landmarks are supported if you choose this detection model.
-  * Different 'recognitionModel' values are provided. If follow-up operations like \"Verify\", \"Identify\", \"Find Similar\" are needed, please specify the recognition model with 'recognitionModel' parameter. The default value for 'recognitionModel' is 'recognition_01', if latest model needed, please explicitly specify the model you need in this parameter. Once specified, the detected faceIds will be associated with the specified recognition model. More details, please refer to https://learn.microsoft.com/azure/ai-services/computer-vision/how-to/specify-recognition-model.
-""")
+  > [!IMPORTANT]
+  > To mitigate potential misuse that can subject people to stereotyping, discrimination, or unfair denial of services, we are retiring Face API attributes that predict emotion, gender, age, smile, facial hair, hair, and makeup. Read more about this decision https://azure.microsoft.com/blog/responsible-ai-investments-and-safeguards-for-facial-recognition/.
+  
+  *
+    * No image will be stored. Only the extracted face feature(s) will be stored on server. The faceId is an identifier of the face feature and will be used in \"Identify\", \"Verify\", and \"Find Similar\". The stored face features will expire and be deleted at the time specified by faceIdTimeToLive after the original detection call.
+    * Optional parameters include faceId, landmarks, and attributes. Attributes include headPose, glasses, occlusion, accessories, blur, exposure, noise, mask, and qualityForRecognition. Some of the results returned for specific attributes may not be highly accurate.
+    * JPEG, PNG, GIF (the first frame), and BMP format are supported. The allowed image file size is from 1KB to 6MB.
+    * The minimum detectable face size is 36x36 pixels in an image no larger than 1920x1080 pixels. Images with dimensions higher than 1920x1080 pixels will need a proportionally larger minimum face size.
+    * Up to 100 faces can be returned for an image. Faces are ranked by face rectangle size from large to small.
+    * For optimal results when querying \"Identify\", \"Verify\", and \"Find Similar\" ('returnFaceId' is true), please use faces that are: frontal, clear, and with a minimum size of 200x200 pixels (100 pixels between eyes).
+    * Different 'detectionModel' values can be provided. To use and compare different detection models, please refer to https://learn.microsoft.com/azure/ai-services/computer-vision/how-to/specify-detection-model
+      * 'detection_02': Face attributes and landmarks are disabled if you choose this detection model.
+      * 'detection_03': Face attributes (mask, blur, and headPose) and landmarks are supported if you choose this detection model.
+    * Different 'recognitionModel' values are provided. If follow-up operations like \"Verify\", \"Identify\", \"Find Similar\" are needed, please specify the recognition model with 'recognitionModel' parameter. The default value for 'recognitionModel' is 'recognition_01', if latest model needed, please explicitly specify the model you need in this parameter. Once specified, the detected faceIds will be associated with the specified recognition model. More details, please refer to https://learn.microsoft.com/azure/ai-services/computer-vision/how-to/specify-recognition-model.
+  """)
 @returnsDoc("A successful call returns an array of face entries ranked by face rectangle size in descending order. An empty response indicates no faces detected.")
 @post
 @sharedRoute

specification/ai/Face/routes.facelist.tsp

@@ -14,17 +14,17 @@ namespace Face;
 alias AddFaceListFaceSummary = "Add a face to a specified Face List, up to 1,000 faces.";
 alias AddFaceListFaceDescription = """
   To deal with an image containing multiple faces, input face can be specified as an image with a targetFace rectangle. It returns a persistedFaceId representing the added face. No image will be stored. Only the extracted face feature(s) will be stored on server until \"Delete Face List Face\" or \"Delete Face List\" is called.
-
+  
   Note that persistedFaceId is different from faceId generated by \"Detect\".
   ${AddFaceDescriptionInList}
   """;
 alias AddLargeFaceListFaceSummary = "Add a face to a specified Large Face List, up to 1,000,000 faces.";
 alias AddLargeFaceListFaceDescription = """
   To deal with an image containing multiple faces, input face can be specified as an image with a targetFace rectangle. It returns a persistedFaceId representing the added face. No image will be stored. Only the extracted face feature(s) will be stored on server until \"Delete Large Face List Face\" or \"Delete Large Face List\" is called.
-
+  
   Note that persistedFaceId is different from faceId generated by \"Detect\".
   ${AddFaceDescriptionInList}
-
+  
   > [!NOTE]
   >
   > *
@@ -36,13 +36,13 @@ interface FaceListOperations {
   @summary("Create an empty Face List with user-specified faceListId, name, an optional userData and recognitionModel.")
   @doc("""
     Up to 64 Face Lists are allowed in one subscription.
-
+    
     Face List is a list of faces, up to 1,000 faces, and used by \"Find Similar From Face List\".
-
+    
     After creation, user should use \"Add Face List Face\" to import the faces. No image will be stored. Only the extracted face feature(s) will be stored on server until \"Delete Face List\" is called.
-
+    
     \"Find Similar\" is used for scenario like finding celebrity-like faces, similar face filtering, or as a light way face identification. But if the actual use is to identify person, please use Person Group / Large Person Group and \"Identify\".
-
+    
     Please consider Large Face List when the face number is large. It can support up to 1,000,000 faces.
     """)
   @returnsDoc(SuccessfulCallWithEmptyBody)
@@ -62,7 +62,7 @@ interface FaceListOperations {
 
   @doc("""
     List Face Lists' faceListId, name, userData and recognitionModel.
-
+    
     To get face information inside Face List use \"Get Face List\".
     """)
   @returnsDoc("A successful call returns an array of Face Lists.")
@@ -93,11 +93,11 @@ interface FaceListOperations {
   @summary("Create an empty Large Face List with user-specified largeFaceListId, name, an optional userData and recognitionModel.")
   @doc("""
     Large Face List is a list of faces, up to 1,000,000 faces, and used by \"Find Similar From Large Face List\".
-
+    
     After creation, user should use Add Large Face List Face to import the faces and Train Large Face List to make it ready for \"Find Similar\". No image will be stored. Only the extracted face feature(s) will be stored on server until Delete Large Face List is called.
-
+    
     \"Find Similar\" is used for scenario like finding celebrity-like faces, similar face filtering, or as a light way face identification. But if the actual use is to identify person, please use Person Group / Large Person Group and \"Identify\".
-
+    
     > [!NOTE]
     >
     > *
@@ -121,14 +121,12 @@ interface FaceListOperations {
   updateLargeFaceList is FaceResourceUpdateOperation<LargeFaceList>;
 
   @summary("List Large Face Lists' information of largeFaceListId, name, userData and recognitionModel.")
-  @doc(
-    """
+  @doc("""
     To get face information inside largeFaceList use \"Get Large Face List Face\".
-
+    
     Large Face Lists are stored in alphabetical order of largeFaceListId.
     ${ListRequestOptionsDescriptionInList}
-    """
-  )
+    """)
   @returnsDoc("A successful call returns an array of Large Face Lists and their information (largeFaceListId, name and userData).")
   getLargeFaceLists is FaceResourceListOperation<
     LargeFaceList,
@@ -138,17 +136,17 @@ interface FaceListOperations {
 
   @doc("""
     To check the Large Face List training status completed or still ongoing. Large Face List training is an asynchronous operation triggered by \"Train Large Face List\".
-
+    
     Training time depends on the number of face entries in a Large Face List. It could be in seconds, or up to half an hour for 1,000,000 faces.
     """)
   @returnsDoc("A successful call returns the Large Face List's training status.")
   getLargeFaceListTrainingStatus is FaceResourceGetTrainingStatus<LargeFaceList>;
 
   @summary("Submit a Large Face List training task.")
   @doc("""
-
+    
     Training is a crucial step that only a trained Large Face List can be used by \"Find Similar From Large Face List\".
-
+    
     The training task is an asynchronous task. Training time depends on the number of face entries in a Large Face List. It could be in seconds, or up to half an hour for 1,000,000 faces. To check training completion, please use \"Get Large Face List Training Status\".
     """)
   @returnsDoc(SuccessfulCallWithEmptyBody)
@@ -182,12 +180,10 @@ interface FaceListOperations {
   >;
 
   @summary("List faces' persistedFaceId and userData in a specified Large Face List.")
-  @doc(
-    """
+  @doc("""
     Faces are stored in alphabetical order of persistedFaceId created in \"Add Large Face List Face\".
     ${ListRequestOptionsDescriptionInList}
-    """
-  )
+    """)
   @returnsDoc("A successful call returns an array of persisted faces and their information (persistedFaceId and userData).")
   getLargeFaceListFaces is FaceResourceListOperation<LargeFaceListFace>;
 }