diff --git a/eng/versioning/version_client.txt b/eng/versioning/version_client.txt
index a8c074bd376d..e4eb21bde1be 100644
--- a/eng/versioning/version_client.txt
+++ b/eng/versioning/version_client.txt
@@ -146,6 +146,7 @@ com.azure:azure-template-perf;1.0.0-beta.1;1.0.0-beta.1
com.azure:azure-media-videoanalyzer-edge;1.0.0-beta.5;1.0.0-beta.6
com.azure:azure-verticals-agrifood-farming;1.0.0-beta.2;1.0.0-beta.3
com.azure:perf-test-core;1.0.0-beta.1;1.0.0-beta.1
+com.azure:azure-cognitiveservices-face;1.0.0-beta.1;1.0.0-beta.1
com.microsoft.azure:spring-cloud-azure-appconfiguration-config-web;1.3.0;1.4.0-beta.1
com.microsoft.azure:spring-cloud-azure-appconfiguration-config;1.3.0;1.4.0-beta.1
com.microsoft.azure:spring-cloud-azure-feature-management-web;1.3.0;1.4.0-beta.1
diff --git a/sdk/cognitiveservices/azure-cognitiveservices-face/CHANGELOG.md b/sdk/cognitiveservices/azure-cognitiveservices-face/CHANGELOG.md
new file mode 100644
index 000000000000..d291b773784b
--- /dev/null
+++ b/sdk/cognitiveservices/azure-cognitiveservices-face/CHANGELOG.md
@@ -0,0 +1,13 @@
+# Release History
+
+## 1.0.0-beta.1 (Unreleased)
+
+- Azure FaceClient client library for Java. This package contains Microsoft Azure FaceClient client library.
+
+### Features Added
+
+### Breaking Changes
+
+### Bugs Fixed
+
+### Other Changes
diff --git a/sdk/cognitiveservices/azure-cognitiveservices-face/README.md b/sdk/cognitiveservices/azure-cognitiveservices-face/README.md
new file mode 100644
index 000000000000..6df080a259f7
--- /dev/null
+++ b/sdk/cognitiveservices/azure-cognitiveservices-face/README.md
@@ -0,0 +1,63 @@
+# Azure FaceClient client library for Java
+
+Azure FaceClient client library for Java.
+
+This package contains Microsoft Azure FaceClient client library.
+
+## Documentation
+
+Various documentation is available to help you get started
+
+- [API reference documentation][docs]
+- [Product documentation][product_documentation]
+
+## Getting started
+
+### Prerequisites
+
+- [Java Development Kit (JDK)][jdk] with version 8 or above
+- [Azure Subscription][azure_subscription]
+
+### Adding the package to your product
+
+[//]: # ({x-version-update-start;com.azure:azure-cognitiveservices-face;current})
+```xml
+
Request Body Schema + * + *
{@code
+ * {
+ * faceId: String
+ * faceListId: String
+ * largeFaceListId: String
+ * faceIds: [
+ * String
+ * ]
+ * maxNumOfCandidatesReturned: Integer
+ * mode: String(matchPerson/matchFace)
+ * }
+ * }
+ *
+ * Response Body Schema + * + *
{@code
+ * [
+ * {
+ * faceId: String
+ * persistedFaceId: String
+ * confidence: float
+ * }
+ * ]
+ * }
+ *
+ * @param body Request body for Find Similar.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return array of SimilarFace along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoRequest Body Schema + * + *
{@code
+ * {
+ * faceIds: [
+ * String
+ * ]
+ * }
+ * }
+ *
+ * Response Body Schema + * + *
{@code
+ * {
+ * groups: [
+ * [
+ * String
+ * ]
+ * ]
+ * messyGroup: [
+ * String
+ * ]
+ * }
+ * }
+ *
+ * @param body Request body for grouping.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return an array of face groups based on face similarity along with {@link Response} on successful completion of
+ * {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoRemarks:<br /> * The algorithm allows more than one face to be identified independently at the same + * request, but no more than 10 faces. * Each person in the person group/large person group could have more than one + * face, but no more than 248 faces. * Higher face image quality means better identification precision. Please + * consider high-quality faces: frontal, clear, and face size is 200x200 pixels (100 pixels between eyes) or bigger. + * * Number of candidates returned is restricted by maxNumOfCandidatesReturned and confidenceThreshold. If no person + * is identified, the returned candidates will be an empty array. * Try [Face - Find + * Similar](https://docs.microsoft.com/rest/api/faceapi/face/findsimilar) when you need to find similar faces from a + * face list/large face list instead of a person group/large person group. * The 'recognitionModel' associated with + * the query faces' faceIds should be the same as the 'recognitionModel' used by the target person group or large + * person group. + * + *
Request Body Schema + * + *
{@code
+ * {
+ * faceIds: [
+ * String
+ * ]
+ * personGroupId: String
+ * largePersonGroupId: String
+ * dynamicPersonGroupId: String
+ * personIds: [
+ * String
+ * ]
+ * maxNumOfCandidatesReturned: Integer
+ * confidenceThreshold: Float
+ * }
+ * }
+ *
+ * Response Body Schema + * + *
{@code
+ * [
+ * {
+ * faceId: String
+ * candidates: [
+ * {
+ * personId: String
+ * confidence: float
+ * }
+ * ]
+ * }
+ * ]
+ * }
+ *
+ * @param body Request body for identify operation.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return array of IdentifyResult along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoRequest Body Schema + * + *
{@code
+ * {
+ * faceId1: String
+ * faceId2: String
+ * }
+ * }
+ *
+ * Response Body Schema + * + *
{@code
+ * {
+ * isIdentical: boolean
+ * confidence: float
+ * }
+ * }
+ *
+ * @param body Request body for face to face verification.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return result of the verify operation along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public Mono* 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 [Specify a recognition + * model](https://docs.microsoft.com/azure/cognitive-services/face/face-api-how-to-topics/specify-recognition-model). + * + *
Query Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| returnFaceId | String | No | A value indicating whether the operation should return faceIds of detected faces. |
| returnFaceLandmarks | String | No | A value indicating whether the operation should return landmarks of the detected faces. |
| returnFaceAttributes | String | No | Analyze and return the one or more specified face attributes in the comma-separated string like "returnFaceAttributes=age,gender". The available attributes depends on the 'detectionModel' specified. 'detection_01' supports age, gender, headPose, smile, facialHair, glasses, emotion, hair, makeup, occlusion, accessories, blur, exposure, noise, and qualityForRecognition. While 'detection_02' does not support any attributes and 'detection_03' only supports mask and qualityForRecognition. Additionally, qualityForRecognition is only supported when the 'recognitionModel' is specified as 'recognition_03' or 'recognition_04'. Note that each face attribute analysis has additional computational and time cost. In the form of "," separated string. |
| recognitionModel | String | No | Name of recognition model. Recognition model is used when the face features are extracted and associated with detected faceIds, (Large)FaceList or (Large)PersonGroup. A recognition model name can be provided when performing Face - Detect or (Large)FaceList - Create or (Large)PersonGroup - Create. The default value is 'recognition_01', if latest model needed, please explicitly specify the model you need. |
| returnRecognitionModel | String | No | A value indicating whether the operation should return 'recognitionModel' in response. |
| detectionModel | String | No | Name of detection model. Detection model is used to detect faces in the submitted image. A detection model name can be provided when performing Face - Detect or (Large)FaceList - Add Face or (Large)PersonGroup - Add Face. The default value is 'detection_01', if another model is needed, please explicitly specify it. |
| faceIdTimeToLive | String | No | The number of seconds for the faceId being cached. Supported range from 60 seconds up to 86400 seconds. The default value is 86400 (24 hours). |
Request Body Schema + * + *
{@code
+ * {
+ * url: String
+ * }
+ * }
+ *
+ * Response Body Schema + * + *
{@code
+ * [
+ * {
+ * faceId: String
+ * recognitionModel: String(recognition_01/recognition_02/recognition_03/recognition_04)
+ * faceRectangle: {
+ * width: int
+ * height: int
+ * left: int
+ * top: int
+ * }
+ * faceLandmarks: {
+ * pupilLeft: {
+ * x: float
+ * y: float
+ * }
+ * pupilRight: (recursive schema, see pupilRight above)
+ * noseTip: (recursive schema, see noseTip above)
+ * mouthLeft: (recursive schema, see mouthLeft above)
+ * mouthRight: (recursive schema, see mouthRight above)
+ * eyebrowLeftOuter: (recursive schema, see eyebrowLeftOuter above)
+ * eyebrowLeftInner: (recursive schema, see eyebrowLeftInner above)
+ * eyeLeftOuter: (recursive schema, see eyeLeftOuter above)
+ * eyeLeftTop: (recursive schema, see eyeLeftTop above)
+ * eyeLeftBottom: (recursive schema, see eyeLeftBottom above)
+ * eyeLeftInner: (recursive schema, see eyeLeftInner above)
+ * eyebrowRightInner: (recursive schema, see eyebrowRightInner above)
+ * eyebrowRightOuter: (recursive schema, see eyebrowRightOuter above)
+ * eyeRightInner: (recursive schema, see eyeRightInner above)
+ * eyeRightTop: (recursive schema, see eyeRightTop above)
+ * eyeRightBottom: (recursive schema, see eyeRightBottom above)
+ * eyeRightOuter: (recursive schema, see eyeRightOuter above)
+ * noseRootLeft: (recursive schema, see noseRootLeft above)
+ * noseRootRight: (recursive schema, see noseRootRight above)
+ * noseLeftAlarTop: (recursive schema, see noseLeftAlarTop above)
+ * noseRightAlarTop: (recursive schema, see noseRightAlarTop above)
+ * noseLeftAlarOutTip: (recursive schema, see noseLeftAlarOutTip above)
+ * noseRightAlarOutTip: (recursive schema, see noseRightAlarOutTip above)
+ * upperLipTop: (recursive schema, see upperLipTop above)
+ * upperLipBottom: (recursive schema, see upperLipBottom above)
+ * underLipTop: (recursive schema, see underLipTop above)
+ * underLipBottom: (recursive schema, see underLipBottom above)
+ * }
+ * faceAttributes: {
+ * age: Float
+ * gender: String(male/female)
+ * smile: Float
+ * facialHair: {
+ * moustache: Float
+ * beard: Float
+ * sideburns: Float
+ * }
+ * glasses: String(noGlasses/readingGlasses/sunglasses/swimmingGoggles)
+ * headPose: {
+ * roll: Float
+ * yaw: Float
+ * pitch: Float
+ * }
+ * emotion: {
+ * anger: Float
+ * contempt: Float
+ * disgust: Float
+ * fear: Float
+ * happiness: Float
+ * neutral: Float
+ * sadness: Float
+ * surprise: Float
+ * }
+ * hair: {
+ * bald: Float
+ * invisible: Boolean
+ * hairColor: [
+ * {
+ * color: String(unknown/white/gray/blond/brown/red/black/other)
+ * confidence: Float
+ * }
+ * ]
+ * }
+ * makeup: {
+ * eyeMakeup: Boolean
+ * lipMakeup: Boolean
+ * }
+ * occlusion: {
+ * foreheadOccluded: Boolean
+ * eyeOccluded: Boolean
+ * mouthOccluded: Boolean
+ * }
+ * accessories: [
+ * {
+ * type: String(headWear/glasses/mask)
+ * confidence: Float
+ * }
+ * ]
+ * blur: {
+ * blurLevel: String(Low/Medium/High)
+ * value: Float
+ * }
+ * exposure: {
+ * exposureLevel: String(UnderExposure/GoodExposure/OverExposure)
+ * value: Float
+ * }
+ * noise: {
+ * noiseLevel: String(Low/Medium/High)
+ * value: Float
+ * }
+ * mask: {
+ * type: String(noMask/faceMask/otherMaskOrOcclusion/uncertain)
+ * noseAndMouthCovered: Boolean
+ * }
+ * qualityForRecognition: String(Low/Medium/High)
+ * }
+ * }
+ * ]
+ * }
+ *
+ * @param imageUrl A JSON document with a URL pointing to the image that is to be analyzed.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return array of DetectedFace along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoRequest Body Schema + * + *
{@code
+ * {
+ * faceId: String
+ * personGroupId: String
+ * largePersonGroupId: String
+ * personId: String
+ * }
+ * }
+ *
+ * Response Body Schema + * + *
{@code
+ * {
+ * isIdentical: boolean
+ * confidence: float
+ * }
+ * }
+ *
+ * @param body Request body for face to person verification.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return result of the verify operation along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoQuery Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| returnFaceId | String | No | A value indicating whether the operation should return faceIds of detected faces. |
| returnFaceLandmarks | String | No | A value indicating whether the operation should return landmarks of the detected faces. |
| returnFaceAttributes | String | No | Analyze and return the one or more specified face attributes in the comma-separated string like "returnFaceAttributes=age,gender". The available attributes depends on the 'detectionModel' specified. 'detection_01' supports age, gender, headPose, smile, facialHair, glasses, emotion, hair, makeup, occlusion, accessories, blur, exposure, noise, and qualityForRecognition. While 'detection_02' does not support any attributes and 'detection_03' only supports mask and qualityForRecognition. Additionally, qualityForRecognition is only supported when the 'recognitionModel' is specified as 'recognition_03' or 'recognition_04'. Note that each face attribute analysis has additional computational and time cost. In the form of "," separated string. |
| recognitionModel | String | No | Name of recognition model. Recognition model is used when the face features are extracted and associated with detected faceIds, (Large)FaceList or (Large)PersonGroup. A recognition model name can be provided when performing Face - Detect or (Large)FaceList - Create or (Large)PersonGroup - Create. The default value is 'recognition_01', if latest model needed, please explicitly specify the model you need. |
| returnRecognitionModel | String | No | A value indicating whether the operation should return 'recognitionModel' in response. |
| detectionModel | String | No | Name of detection model. Detection model is used to detect faces in the submitted image. A detection model name can be provided when performing Face - Detect or (Large)FaceList - Add Face or (Large)PersonGroup - Add Face. The default value is 'detection_01', if another model is needed, please explicitly specify it. |
| faceIdTimeToLive | String | No | The number of seconds for the faceId being cached. Supported range from 60 seconds up to 86400 seconds. The default value is 86400 (24 hours). |
Header Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| Content-Length | long | Yes | The contentLength parameter |
Request Body Schema + * + *
{@code
+ * Flux
+ * }
+ *
+ * Response Body Schema + * + *
{@code
+ * [
+ * {
+ * faceId: String
+ * recognitionModel: String(recognition_01/recognition_02/recognition_03/recognition_04)
+ * faceRectangle: {
+ * width: int
+ * height: int
+ * left: int
+ * top: int
+ * }
+ * faceLandmarks: {
+ * pupilLeft: {
+ * x: float
+ * y: float
+ * }
+ * pupilRight: (recursive schema, see pupilRight above)
+ * noseTip: (recursive schema, see noseTip above)
+ * mouthLeft: (recursive schema, see mouthLeft above)
+ * mouthRight: (recursive schema, see mouthRight above)
+ * eyebrowLeftOuter: (recursive schema, see eyebrowLeftOuter above)
+ * eyebrowLeftInner: (recursive schema, see eyebrowLeftInner above)
+ * eyeLeftOuter: (recursive schema, see eyeLeftOuter above)
+ * eyeLeftTop: (recursive schema, see eyeLeftTop above)
+ * eyeLeftBottom: (recursive schema, see eyeLeftBottom above)
+ * eyeLeftInner: (recursive schema, see eyeLeftInner above)
+ * eyebrowRightInner: (recursive schema, see eyebrowRightInner above)
+ * eyebrowRightOuter: (recursive schema, see eyebrowRightOuter above)
+ * eyeRightInner: (recursive schema, see eyeRightInner above)
+ * eyeRightTop: (recursive schema, see eyeRightTop above)
+ * eyeRightBottom: (recursive schema, see eyeRightBottom above)
+ * eyeRightOuter: (recursive schema, see eyeRightOuter above)
+ * noseRootLeft: (recursive schema, see noseRootLeft above)
+ * noseRootRight: (recursive schema, see noseRootRight above)
+ * noseLeftAlarTop: (recursive schema, see noseLeftAlarTop above)
+ * noseRightAlarTop: (recursive schema, see noseRightAlarTop above)
+ * noseLeftAlarOutTip: (recursive schema, see noseLeftAlarOutTip above)
+ * noseRightAlarOutTip: (recursive schema, see noseRightAlarOutTip above)
+ * upperLipTop: (recursive schema, see upperLipTop above)
+ * upperLipBottom: (recursive schema, see upperLipBottom above)
+ * underLipTop: (recursive schema, see underLipTop above)
+ * underLipBottom: (recursive schema, see underLipBottom above)
+ * }
+ * faceAttributes: {
+ * age: Float
+ * gender: String(male/female)
+ * smile: Float
+ * facialHair: {
+ * moustache: Float
+ * beard: Float
+ * sideburns: Float
+ * }
+ * glasses: String(noGlasses/readingGlasses/sunglasses/swimmingGoggles)
+ * headPose: {
+ * roll: Float
+ * yaw: Float
+ * pitch: Float
+ * }
+ * emotion: {
+ * anger: Float
+ * contempt: Float
+ * disgust: Float
+ * fear: Float
+ * happiness: Float
+ * neutral: Float
+ * sadness: Float
+ * surprise: Float
+ * }
+ * hair: {
+ * bald: Float
+ * invisible: Boolean
+ * hairColor: [
+ * {
+ * color: String(unknown/white/gray/blond/brown/red/black/other)
+ * confidence: Float
+ * }
+ * ]
+ * }
+ * makeup: {
+ * eyeMakeup: Boolean
+ * lipMakeup: Boolean
+ * }
+ * occlusion: {
+ * foreheadOccluded: Boolean
+ * eyeOccluded: Boolean
+ * mouthOccluded: Boolean
+ * }
+ * accessories: [
+ * {
+ * type: String(headWear/glasses/mask)
+ * confidence: Float
+ * }
+ * ]
+ * blur: {
+ * blurLevel: String(Low/Medium/High)
+ * value: Float
+ * }
+ * exposure: {
+ * exposureLevel: String(UnderExposure/GoodExposure/OverExposure)
+ * value: Float
+ * }
+ * noise: {
+ * noiseLevel: String(Low/Medium/High)
+ * value: Float
+ * }
+ * mask: {
+ * type: String(noMask/faceMask/otherMaskOrOcclusion/uncertain)
+ * noseAndMouthCovered: Boolean
+ * }
+ * qualityForRecognition: String(Low/Medium/High)
+ * }
+ * }
+ * ]
+ * }
+ *
+ * @param image An image stream.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return array of DetectedFace along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoRequest Body Schema + * + *
{@code
+ * {
+ * faceId: String
+ * faceListId: String
+ * largeFaceListId: String
+ * faceIds: [
+ * String
+ * ]
+ * maxNumOfCandidatesReturned: Integer
+ * mode: String(matchPerson/matchFace)
+ * }
+ * }
+ *
+ * Response Body Schema + * + *
{@code
+ * [
+ * {
+ * faceId: String
+ * persistedFaceId: String
+ * confidence: float
+ * }
+ * ]
+ * }
+ *
+ * @param body Request body for Find Similar.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return array of SimilarFace along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseRequest Body Schema + * + *
{@code
+ * {
+ * faceIds: [
+ * String
+ * ]
+ * }
+ * }
+ *
+ * Response Body Schema + * + *
{@code
+ * {
+ * groups: [
+ * [
+ * String
+ * ]
+ * ]
+ * messyGroup: [
+ * String
+ * ]
+ * }
+ * }
+ *
+ * @param body Request body for grouping.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return an array of face groups based on face similarity along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseRemarks:<br /> * The algorithm allows more than one face to be identified independently at the same + * request, but no more than 10 faces. * Each person in the person group/large person group could have more than one + * face, but no more than 248 faces. * Higher face image quality means better identification precision. Please + * consider high-quality faces: frontal, clear, and face size is 200x200 pixels (100 pixels between eyes) or bigger. + * * Number of candidates returned is restricted by maxNumOfCandidatesReturned and confidenceThreshold. If no person + * is identified, the returned candidates will be an empty array. * Try [Face - Find + * Similar](https://docs.microsoft.com/rest/api/faceapi/face/findsimilar) when you need to find similar faces from a + * face list/large face list instead of a person group/large person group. * The 'recognitionModel' associated with + * the query faces' faceIds should be the same as the 'recognitionModel' used by the target person group or large + * person group. + * + *
Request Body Schema + * + *
{@code
+ * {
+ * faceIds: [
+ * String
+ * ]
+ * personGroupId: String
+ * largePersonGroupId: String
+ * dynamicPersonGroupId: String
+ * personIds: [
+ * String
+ * ]
+ * maxNumOfCandidatesReturned: Integer
+ * confidenceThreshold: Float
+ * }
+ * }
+ *
+ * Response Body Schema + * + *
{@code
+ * [
+ * {
+ * faceId: String
+ * candidates: [
+ * {
+ * personId: String
+ * confidence: float
+ * }
+ * ]
+ * }
+ * ]
+ * }
+ *
+ * @param body Request body for identify operation.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return array of IdentifyResult along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseRequest Body Schema + * + *
{@code
+ * {
+ * faceId1: String
+ * faceId2: String
+ * }
+ * }
+ *
+ * Response Body Schema + * + *
{@code
+ * {
+ * isIdentical: boolean
+ * confidence: float
+ * }
+ * }
+ *
+ * @param body Request body for face to face verification.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return result of the verify operation along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public Response* 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 [Specify a recognition + * model](https://docs.microsoft.com/azure/cognitive-services/face/face-api-how-to-topics/specify-recognition-model). + * + *
Query Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| returnFaceId | String | No | A value indicating whether the operation should return faceIds of detected faces. |
| returnFaceLandmarks | String | No | A value indicating whether the operation should return landmarks of the detected faces. |
| returnFaceAttributes | String | No | Analyze and return the one or more specified face attributes in the comma-separated string like "returnFaceAttributes=age,gender". The available attributes depends on the 'detectionModel' specified. 'detection_01' supports age, gender, headPose, smile, facialHair, glasses, emotion, hair, makeup, occlusion, accessories, blur, exposure, noise, and qualityForRecognition. While 'detection_02' does not support any attributes and 'detection_03' only supports mask and qualityForRecognition. Additionally, qualityForRecognition is only supported when the 'recognitionModel' is specified as 'recognition_03' or 'recognition_04'. Note that each face attribute analysis has additional computational and time cost. In the form of "," separated string. |
| recognitionModel | String | No | Name of recognition model. Recognition model is used when the face features are extracted and associated with detected faceIds, (Large)FaceList or (Large)PersonGroup. A recognition model name can be provided when performing Face - Detect or (Large)FaceList - Create or (Large)PersonGroup - Create. The default value is 'recognition_01', if latest model needed, please explicitly specify the model you need. |
| returnRecognitionModel | String | No | A value indicating whether the operation should return 'recognitionModel' in response. |
| detectionModel | String | No | Name of detection model. Detection model is used to detect faces in the submitted image. A detection model name can be provided when performing Face - Detect or (Large)FaceList - Add Face or (Large)PersonGroup - Add Face. The default value is 'detection_01', if another model is needed, please explicitly specify it. |
| faceIdTimeToLive | String | No | The number of seconds for the faceId being cached. Supported range from 60 seconds up to 86400 seconds. The default value is 86400 (24 hours). |
Request Body Schema + * + *
{@code
+ * {
+ * url: String
+ * }
+ * }
+ *
+ * Response Body Schema + * + *
{@code
+ * [
+ * {
+ * faceId: String
+ * recognitionModel: String(recognition_01/recognition_02/recognition_03/recognition_04)
+ * faceRectangle: {
+ * width: int
+ * height: int
+ * left: int
+ * top: int
+ * }
+ * faceLandmarks: {
+ * pupilLeft: {
+ * x: float
+ * y: float
+ * }
+ * pupilRight: (recursive schema, see pupilRight above)
+ * noseTip: (recursive schema, see noseTip above)
+ * mouthLeft: (recursive schema, see mouthLeft above)
+ * mouthRight: (recursive schema, see mouthRight above)
+ * eyebrowLeftOuter: (recursive schema, see eyebrowLeftOuter above)
+ * eyebrowLeftInner: (recursive schema, see eyebrowLeftInner above)
+ * eyeLeftOuter: (recursive schema, see eyeLeftOuter above)
+ * eyeLeftTop: (recursive schema, see eyeLeftTop above)
+ * eyeLeftBottom: (recursive schema, see eyeLeftBottom above)
+ * eyeLeftInner: (recursive schema, see eyeLeftInner above)
+ * eyebrowRightInner: (recursive schema, see eyebrowRightInner above)
+ * eyebrowRightOuter: (recursive schema, see eyebrowRightOuter above)
+ * eyeRightInner: (recursive schema, see eyeRightInner above)
+ * eyeRightTop: (recursive schema, see eyeRightTop above)
+ * eyeRightBottom: (recursive schema, see eyeRightBottom above)
+ * eyeRightOuter: (recursive schema, see eyeRightOuter above)
+ * noseRootLeft: (recursive schema, see noseRootLeft above)
+ * noseRootRight: (recursive schema, see noseRootRight above)
+ * noseLeftAlarTop: (recursive schema, see noseLeftAlarTop above)
+ * noseRightAlarTop: (recursive schema, see noseRightAlarTop above)
+ * noseLeftAlarOutTip: (recursive schema, see noseLeftAlarOutTip above)
+ * noseRightAlarOutTip: (recursive schema, see noseRightAlarOutTip above)
+ * upperLipTop: (recursive schema, see upperLipTop above)
+ * upperLipBottom: (recursive schema, see upperLipBottom above)
+ * underLipTop: (recursive schema, see underLipTop above)
+ * underLipBottom: (recursive schema, see underLipBottom above)
+ * }
+ * faceAttributes: {
+ * age: Float
+ * gender: String(male/female)
+ * smile: Float
+ * facialHair: {
+ * moustache: Float
+ * beard: Float
+ * sideburns: Float
+ * }
+ * glasses: String(noGlasses/readingGlasses/sunglasses/swimmingGoggles)
+ * headPose: {
+ * roll: Float
+ * yaw: Float
+ * pitch: Float
+ * }
+ * emotion: {
+ * anger: Float
+ * contempt: Float
+ * disgust: Float
+ * fear: Float
+ * happiness: Float
+ * neutral: Float
+ * sadness: Float
+ * surprise: Float
+ * }
+ * hair: {
+ * bald: Float
+ * invisible: Boolean
+ * hairColor: [
+ * {
+ * color: String(unknown/white/gray/blond/brown/red/black/other)
+ * confidence: Float
+ * }
+ * ]
+ * }
+ * makeup: {
+ * eyeMakeup: Boolean
+ * lipMakeup: Boolean
+ * }
+ * occlusion: {
+ * foreheadOccluded: Boolean
+ * eyeOccluded: Boolean
+ * mouthOccluded: Boolean
+ * }
+ * accessories: [
+ * {
+ * type: String(headWear/glasses/mask)
+ * confidence: Float
+ * }
+ * ]
+ * blur: {
+ * blurLevel: String(Low/Medium/High)
+ * value: Float
+ * }
+ * exposure: {
+ * exposureLevel: String(UnderExposure/GoodExposure/OverExposure)
+ * value: Float
+ * }
+ * noise: {
+ * noiseLevel: String(Low/Medium/High)
+ * value: Float
+ * }
+ * mask: {
+ * type: String(noMask/faceMask/otherMaskOrOcclusion/uncertain)
+ * noseAndMouthCovered: Boolean
+ * }
+ * qualityForRecognition: String(Low/Medium/High)
+ * }
+ * }
+ * ]
+ * }
+ *
+ * @param imageUrl A JSON document with a URL pointing to the image that is to be analyzed.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return array of DetectedFace along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseRequest Body Schema + * + *
{@code
+ * {
+ * faceId: String
+ * personGroupId: String
+ * largePersonGroupId: String
+ * personId: String
+ * }
+ * }
+ *
+ * Response Body Schema + * + *
{@code
+ * {
+ * isIdentical: boolean
+ * confidence: float
+ * }
+ * }
+ *
+ * @param body Request body for face to person verification.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return result of the verify operation along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseQuery Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| returnFaceId | String | No | A value indicating whether the operation should return faceIds of detected faces. |
| returnFaceLandmarks | String | No | A value indicating whether the operation should return landmarks of the detected faces. |
| returnFaceAttributes | String | No | Analyze and return the one or more specified face attributes in the comma-separated string like "returnFaceAttributes=age,gender". The available attributes depends on the 'detectionModel' specified. 'detection_01' supports age, gender, headPose, smile, facialHair, glasses, emotion, hair, makeup, occlusion, accessories, blur, exposure, noise, and qualityForRecognition. While 'detection_02' does not support any attributes and 'detection_03' only supports mask and qualityForRecognition. Additionally, qualityForRecognition is only supported when the 'recognitionModel' is specified as 'recognition_03' or 'recognition_04'. Note that each face attribute analysis has additional computational and time cost. In the form of "," separated string. |
| recognitionModel | String | No | Name of recognition model. Recognition model is used when the face features are extracted and associated with detected faceIds, (Large)FaceList or (Large)PersonGroup. A recognition model name can be provided when performing Face - Detect or (Large)FaceList - Create or (Large)PersonGroup - Create. The default value is 'recognition_01', if latest model needed, please explicitly specify the model you need. |
| returnRecognitionModel | String | No | A value indicating whether the operation should return 'recognitionModel' in response. |
| detectionModel | String | No | Name of detection model. Detection model is used to detect faces in the submitted image. A detection model name can be provided when performing Face - Detect or (Large)FaceList - Add Face or (Large)PersonGroup - Add Face. The default value is 'detection_01', if another model is needed, please explicitly specify it. |
| faceIdTimeToLive | String | No | The number of seconds for the faceId being cached. Supported range from 60 seconds up to 86400 seconds. The default value is 86400 (24 hours). |
Header Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| Content-Length | long | Yes | The contentLength parameter |
Request Body Schema + * + *
{@code
+ * Flux
+ * }
+ *
+ * Response Body Schema + * + *
{@code
+ * [
+ * {
+ * faceId: String
+ * recognitionModel: String(recognition_01/recognition_02/recognition_03/recognition_04)
+ * faceRectangle: {
+ * width: int
+ * height: int
+ * left: int
+ * top: int
+ * }
+ * faceLandmarks: {
+ * pupilLeft: {
+ * x: float
+ * y: float
+ * }
+ * pupilRight: (recursive schema, see pupilRight above)
+ * noseTip: (recursive schema, see noseTip above)
+ * mouthLeft: (recursive schema, see mouthLeft above)
+ * mouthRight: (recursive schema, see mouthRight above)
+ * eyebrowLeftOuter: (recursive schema, see eyebrowLeftOuter above)
+ * eyebrowLeftInner: (recursive schema, see eyebrowLeftInner above)
+ * eyeLeftOuter: (recursive schema, see eyeLeftOuter above)
+ * eyeLeftTop: (recursive schema, see eyeLeftTop above)
+ * eyeLeftBottom: (recursive schema, see eyeLeftBottom above)
+ * eyeLeftInner: (recursive schema, see eyeLeftInner above)
+ * eyebrowRightInner: (recursive schema, see eyebrowRightInner above)
+ * eyebrowRightOuter: (recursive schema, see eyebrowRightOuter above)
+ * eyeRightInner: (recursive schema, see eyeRightInner above)
+ * eyeRightTop: (recursive schema, see eyeRightTop above)
+ * eyeRightBottom: (recursive schema, see eyeRightBottom above)
+ * eyeRightOuter: (recursive schema, see eyeRightOuter above)
+ * noseRootLeft: (recursive schema, see noseRootLeft above)
+ * noseRootRight: (recursive schema, see noseRootRight above)
+ * noseLeftAlarTop: (recursive schema, see noseLeftAlarTop above)
+ * noseRightAlarTop: (recursive schema, see noseRightAlarTop above)
+ * noseLeftAlarOutTip: (recursive schema, see noseLeftAlarOutTip above)
+ * noseRightAlarOutTip: (recursive schema, see noseRightAlarOutTip above)
+ * upperLipTop: (recursive schema, see upperLipTop above)
+ * upperLipBottom: (recursive schema, see upperLipBottom above)
+ * underLipTop: (recursive schema, see underLipTop above)
+ * underLipBottom: (recursive schema, see underLipBottom above)
+ * }
+ * faceAttributes: {
+ * age: Float
+ * gender: String(male/female)
+ * smile: Float
+ * facialHair: {
+ * moustache: Float
+ * beard: Float
+ * sideburns: Float
+ * }
+ * glasses: String(noGlasses/readingGlasses/sunglasses/swimmingGoggles)
+ * headPose: {
+ * roll: Float
+ * yaw: Float
+ * pitch: Float
+ * }
+ * emotion: {
+ * anger: Float
+ * contempt: Float
+ * disgust: Float
+ * fear: Float
+ * happiness: Float
+ * neutral: Float
+ * sadness: Float
+ * surprise: Float
+ * }
+ * hair: {
+ * bald: Float
+ * invisible: Boolean
+ * hairColor: [
+ * {
+ * color: String(unknown/white/gray/blond/brown/red/black/other)
+ * confidence: Float
+ * }
+ * ]
+ * }
+ * makeup: {
+ * eyeMakeup: Boolean
+ * lipMakeup: Boolean
+ * }
+ * occlusion: {
+ * foreheadOccluded: Boolean
+ * eyeOccluded: Boolean
+ * mouthOccluded: Boolean
+ * }
+ * accessories: [
+ * {
+ * type: String(headWear/glasses/mask)
+ * confidence: Float
+ * }
+ * ]
+ * blur: {
+ * blurLevel: String(Low/Medium/High)
+ * value: Float
+ * }
+ * exposure: {
+ * exposureLevel: String(UnderExposure/GoodExposure/OverExposure)
+ * value: Float
+ * }
+ * noise: {
+ * noiseLevel: String(Low/Medium/High)
+ * value: Float
+ * }
+ * mask: {
+ * type: String(noMask/faceMask/otherMaskOrOcclusion/uncertain)
+ * noseAndMouthCovered: Boolean
+ * }
+ * qualityForRecognition: String(Low/Medium/High)
+ * }
+ * }
+ * ]
+ * }
+ *
+ * @param image An image stream.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return array of DetectedFace along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseRequest Body Schema + * + *
{@code
+ * {
+ * name: String
+ * userData: String
+ * recognitionModel: String(recognition_01/recognition_02/recognition_03/recognition_04)
+ * }
+ * }
+ *
+ * @param faceListId Id referencing a particular face list.
+ * @param body Request body for creating a face list.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoQuery Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| returnRecognitionModel | String | No | A value indicating whether the operation should return 'recognitionModel' in response. |
Response Body Schema + * + *
{@code
+ * {
+ * faceListId: String
+ * name: String
+ * userData: String
+ * recognitionModel: String(recognition_01/recognition_02/recognition_03/recognition_04)
+ * persistedFaces: [
+ * {
+ * persistedFaceId: String
+ * userData: String
+ * }
+ * ]
+ * }
+ * }
+ *
+ * @param faceListId Id referencing a particular face list.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return face list object along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoRequest Body Schema + * + *
{@code
+ * {
+ * name: String
+ * userData: String
+ * }
+ * }
+ *
+ * @param faceListId Id referencing a particular face list.
+ * @param body Request body for updating a face list.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoQuery Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| returnRecognitionModel | String | No | A value indicating whether the operation should return 'recognitionModel' in response. |
Response Body Schema + * + *
{@code
+ * [
+ * {
+ * faceListId: String
+ * name: String
+ * userData: String
+ * recognitionModel: String(recognition_01/recognition_02/recognition_03/recognition_04)
+ * persistedFaces: [
+ * {
+ * persistedFaceId: String
+ * userData: String
+ * }
+ * ]
+ * }
+ * ]
+ * }
+ *
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return an array of face list results, with fields of faceListId, name and userData along with {@link Response}
+ * on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoQuery Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| userData | String | No | User-specified data about the face for any purpose. The maximum length is 1KB. |
| targetFace | String | No | A face rectangle to specify the target face to be added to a person in the format of "targetFace=left,top,width,height". E.g. "targetFace=10,10,100,100". If there is more than one face in the image, targetFace is required to specify which face to add. No targetFace means there is only one face detected in the entire image. In the form of "," separated string. |
| detectionModel | String | No | Name of detection model. Detection model is used to detect faces in the submitted image. A detection model name can be provided when performing Face - Detect or (Large)FaceList - Add Face or (Large)PersonGroup - Add Face. The default value is 'detection_01', if another model is needed, please explicitly specify it. |
Request Body Schema + * + *
{@code
+ * {
+ * url: String
+ * }
+ * }
+ *
+ * Response Body Schema + * + *
{@code
+ * {
+ * persistedFaceId: String
+ * userData: String
+ * }
+ * }
+ *
+ * @param faceListId Id referencing a particular face list.
+ * @param imageUrl A JSON document with a URL pointing to the image that is to be analyzed.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return personFace object along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoQuery Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| userData | String | No | User-specified data about the face for any purpose. The maximum length is 1KB. |
| targetFace | String | No | A face rectangle to specify the target face to be added to a person in the format of "targetFace=left,top,width,height". E.g. "targetFace=10,10,100,100". If there is more than one face in the image, targetFace is required to specify which face to add. No targetFace means there is only one face detected in the entire image. In the form of "," separated string. |
| detectionModel | String | No | Name of detection model. Detection model is used to detect faces in the submitted image. A detection model name can be provided when performing Face - Detect or (Large)FaceList - Add Face or (Large)PersonGroup - Add Face. The default value is 'detection_01', if another model is needed, please explicitly specify it. |
Header Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| Content-Length | long | Yes | The contentLength parameter |
Request Body Schema + * + *
{@code
+ * Flux
+ * }
+ *
+ * Response Body Schema + * + *
{@code
+ * {
+ * persistedFaceId: String
+ * userData: String
+ * }
+ * }
+ *
+ * @param faceListId Id referencing a particular face list.
+ * @param image An image stream.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return personFace object along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoRequest Body Schema + * + *
{@code
+ * {
+ * name: String
+ * userData: String
+ * recognitionModel: String(recognition_01/recognition_02/recognition_03/recognition_04)
+ * }
+ * }
+ *
+ * @param faceListId Id referencing a particular face list.
+ * @param body Request body for creating a face list.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseQuery Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| returnRecognitionModel | String | No | A value indicating whether the operation should return 'recognitionModel' in response. |
Response Body Schema + * + *
{@code
+ * {
+ * faceListId: String
+ * name: String
+ * userData: String
+ * recognitionModel: String(recognition_01/recognition_02/recognition_03/recognition_04)
+ * persistedFaces: [
+ * {
+ * persistedFaceId: String
+ * userData: String
+ * }
+ * ]
+ * }
+ * }
+ *
+ * @param faceListId Id referencing a particular face list.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return face list object along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseRequest Body Schema + * + *
{@code
+ * {
+ * name: String
+ * userData: String
+ * }
+ * }
+ *
+ * @param faceListId Id referencing a particular face list.
+ * @param body Request body for updating a face list.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseQuery Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| returnRecognitionModel | String | No | A value indicating whether the operation should return 'recognitionModel' in response. |
Response Body Schema + * + *
{@code
+ * [
+ * {
+ * faceListId: String
+ * name: String
+ * userData: String
+ * recognitionModel: String(recognition_01/recognition_02/recognition_03/recognition_04)
+ * persistedFaces: [
+ * {
+ * persistedFaceId: String
+ * userData: String
+ * }
+ * ]
+ * }
+ * ]
+ * }
+ *
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return an array of face list results, with fields of faceListId, name and userData along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseQuery Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| userData | String | No | User-specified data about the face for any purpose. The maximum length is 1KB. |
| targetFace | String | No | A face rectangle to specify the target face to be added to a person in the format of "targetFace=left,top,width,height". E.g. "targetFace=10,10,100,100". If there is more than one face in the image, targetFace is required to specify which face to add. No targetFace means there is only one face detected in the entire image. In the form of "," separated string. |
| detectionModel | String | No | Name of detection model. Detection model is used to detect faces in the submitted image. A detection model name can be provided when performing Face - Detect or (Large)FaceList - Add Face or (Large)PersonGroup - Add Face. The default value is 'detection_01', if another model is needed, please explicitly specify it. |
Request Body Schema + * + *
{@code
+ * {
+ * url: String
+ * }
+ * }
+ *
+ * Response Body Schema + * + *
{@code
+ * {
+ * persistedFaceId: String
+ * userData: String
+ * }
+ * }
+ *
+ * @param faceListId Id referencing a particular face list.
+ * @param imageUrl A JSON document with a URL pointing to the image that is to be analyzed.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return personFace object along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseQuery Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| userData | String | No | User-specified data about the face for any purpose. The maximum length is 1KB. |
| targetFace | String | No | A face rectangle to specify the target face to be added to a person in the format of "targetFace=left,top,width,height". E.g. "targetFace=10,10,100,100". If there is more than one face in the image, targetFace is required to specify which face to add. No targetFace means there is only one face detected in the entire image. In the form of "," separated string. |
| detectionModel | String | No | Name of detection model. Detection model is used to detect faces in the submitted image. A detection model name can be provided when performing Face - Detect or (Large)FaceList - Add Face or (Large)PersonGroup - Add Face. The default value is 'detection_01', if another model is needed, please explicitly specify it. |
Header Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| Content-Length | long | Yes | The contentLength parameter |
Request Body Schema + * + *
{@code
+ * Flux
+ * }
+ *
+ * Response Body Schema + * + *
{@code
+ * {
+ * persistedFaceId: String
+ * userData: String
+ * }
+ * }
+ *
+ * @param faceListId Id referencing a particular face list.
+ * @param image An image stream.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return personFace object along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseLarge face list quota: * Free-tier subscription quota: 64 large face lists. * S0-tier subscription quota: + * 1,000,000 large face lists. + * + *
Request Body Schema + * + *
{@code
+ * {
+ * name: String
+ * userData: String
+ * recognitionModel: String(recognition_01/recognition_02/recognition_03/recognition_04)
+ * }
+ * }
+ *
+ * @param largeFaceListId Id referencing a particular large face list.
+ * @param body Request body for creating a large face list.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoQuery Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| returnRecognitionModel | String | No | A value indicating whether the operation should return 'recognitionModel' in response. |
Response Body Schema + * + *
{@code
+ * {
+ * largeFaceListId: String
+ * name: String
+ * userData: String
+ * recognitionModel: String(recognition_01/recognition_02/recognition_03/recognition_04)
+ * }
+ * }
+ *
+ * @param largeFaceListId Id referencing a particular large face list.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return large face list object along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoRequest Body Schema + * + *
{@code
+ * {
+ * name: String
+ * userData: String
+ * }
+ * }
+ *
+ * @param largeFaceListId Id referencing a particular large face list.
+ * @param body Request body for updating a large face list.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoResponse Body Schema + * + *
{@code
+ * {
+ * status: String(nonstarted/running/succeeded/failed)
+ * created: String
+ * lastAction: String
+ * lastSuccessfulTraining: String
+ * message: String
+ * }
+ * }
+ *
+ * @param largeFaceListId Id referencing a particular large face list.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return training status object along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoQuery Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| returnRecognitionModel | String | No | A value indicating whether the operation should return 'recognitionModel' in response. |
| start | String | No | Starting large face list id to return (used to list a range of large face lists). |
| top | String | No | Number of large face lists to return starting with the large face list id indicated by the 'start' parameter. |
Response Body Schema + * + *
{@code
+ * [
+ * {
+ * largeFaceListId: String
+ * name: String
+ * userData: String
+ * recognitionModel: String(recognition_01/recognition_02/recognition_03/recognition_04)
+ * }
+ * ]
+ * }
+ *
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return an array of large face list results, with fields of largeFaceListId, name and userData along with {@link
+ * Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoResponse Body Schema + * + *
{@code
+ * {
+ * persistedFaceId: String
+ * userData: String
+ * }
+ * }
+ *
+ * @param largeFaceListId Id referencing a particular large face list.
+ * @param persistedFaceId Id referencing a particular persistedFaceId of an existing face.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return personFace object along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoRequest Body Schema + * + *
{@code
+ * {
+ * userData: String
+ * }
+ * }
+ *
+ * @param largeFaceListId Id referencing a particular large face list.
+ * @param persistedFaceId Id referencing a particular persistedFaceId of an existing face.
+ * @param body Request body for updating persisted face.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoQuota: * Free-tier subscription quota: 1,000 faces per large face list. * S0-tier subscription quota: + * 1,000,000 faces per large face list. + * + *
Query Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| userData | String | No | User-specified data about the face for any purpose. The maximum length is 1KB. |
| targetFace | String | No | A face rectangle to specify the target face to be added to a person in the format of "targetFace=left,top,width,height". E.g. "targetFace=10,10,100,100". If there is more than one face in the image, targetFace is required to specify which face to add. No targetFace means there is only one face detected in the entire image. In the form of "," separated string. |
| detectionModel | String | No | Name of detection model. Detection model is used to detect faces in the submitted image. A detection model name can be provided when performing Face - Detect or (Large)FaceList - Add Face or (Large)PersonGroup - Add Face. The default value is 'detection_01', if another model is needed, please explicitly specify it. |
Request Body Schema + * + *
{@code
+ * {
+ * url: String
+ * }
+ * }
+ *
+ * Response Body Schema + * + *
{@code
+ * {
+ * persistedFaceId: String
+ * userData: String
+ * }
+ * }
+ *
+ * @param largeFaceListId Id referencing a particular large face list.
+ * @param imageUrl A JSON document with a URL pointing to the image that is to be analyzed.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return personFace object along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoQuery Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| start | String | No | Starting face id to return (used to list a range of faces). |
| top | String | No | Number of faces to return starting with the face id indicated by the 'start' parameter. |
Response Body Schema + * + *
{@code
+ * [
+ * {
+ * persistedFaceId: String
+ * userData: String
+ * }
+ * ]
+ * }
+ *
+ * @param largeFaceListId Id referencing a particular large face list.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return an array of persisted faces within the face list or large face list along with {@link Response} on
+ * successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoQuota: * Free-tier subscription quota: 1,000 faces per large face list. * S0-tier subscription quota: + * 1,000,000 faces per large face list. + * + *
Query Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| userData | String | No | User-specified data about the face for any purpose. The maximum length is 1KB. |
| targetFace | String | No | A face rectangle to specify the target face to be added to a person in the format of "targetFace=left,top,width,height". E.g. "targetFace=10,10,100,100". If there is more than one face in the image, targetFace is required to specify which face to add. No targetFace means there is only one face detected in the entire image. In the form of "," separated string. |
| detectionModel | String | No | Name of detection model. Detection model is used to detect faces in the submitted image. A detection model name can be provided when performing Face - Detect or (Large)FaceList - Add Face or (Large)PersonGroup - Add Face. The default value is 'detection_01', if another model is needed, please explicitly specify it. |
Header Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| Content-Length | long | Yes | The contentLength parameter |
Request Body Schema + * + *
{@code
+ * Flux
+ * }
+ *
+ * Response Body Schema + * + *
{@code
+ * {
+ * persistedFaceId: String
+ * userData: String
+ * }
+ * }
+ *
+ * @param largeFaceListId Id referencing a particular large face list.
+ * @param image An image stream.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return personFace object along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoLarge face list quota: * Free-tier subscription quota: 64 large face lists. * S0-tier subscription quota: + * 1,000,000 large face lists. + * + *
Request Body Schema + * + *
{@code
+ * {
+ * name: String
+ * userData: String
+ * recognitionModel: String(recognition_01/recognition_02/recognition_03/recognition_04)
+ * }
+ * }
+ *
+ * @param largeFaceListId Id referencing a particular large face list.
+ * @param body Request body for creating a large face list.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseQuery Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| returnRecognitionModel | String | No | A value indicating whether the operation should return 'recognitionModel' in response. |
Response Body Schema + * + *
{@code
+ * {
+ * largeFaceListId: String
+ * name: String
+ * userData: String
+ * recognitionModel: String(recognition_01/recognition_02/recognition_03/recognition_04)
+ * }
+ * }
+ *
+ * @param largeFaceListId Id referencing a particular large face list.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return large face list object along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseRequest Body Schema + * + *
{@code
+ * {
+ * name: String
+ * userData: String
+ * }
+ * }
+ *
+ * @param largeFaceListId Id referencing a particular large face list.
+ * @param body Request body for updating a large face list.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseResponse Body Schema + * + *
{@code
+ * {
+ * status: String(nonstarted/running/succeeded/failed)
+ * created: String
+ * lastAction: String
+ * lastSuccessfulTraining: String
+ * message: String
+ * }
+ * }
+ *
+ * @param largeFaceListId Id referencing a particular large face list.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return training status object along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseQuery Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| returnRecognitionModel | String | No | A value indicating whether the operation should return 'recognitionModel' in response. |
| start | String | No | Starting large face list id to return (used to list a range of large face lists). |
| top | String | No | Number of large face lists to return starting with the large face list id indicated by the 'start' parameter. |
Response Body Schema + * + *
{@code
+ * [
+ * {
+ * largeFaceListId: String
+ * name: String
+ * userData: String
+ * recognitionModel: String(recognition_01/recognition_02/recognition_03/recognition_04)
+ * }
+ * ]
+ * }
+ *
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return an array of large face list results, with fields of largeFaceListId, name and userData along with {@link
+ * Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseResponse Body Schema + * + *
{@code
+ * {
+ * persistedFaceId: String
+ * userData: String
+ * }
+ * }
+ *
+ * @param largeFaceListId Id referencing a particular large face list.
+ * @param persistedFaceId Id referencing a particular persistedFaceId of an existing face.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return personFace object along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseRequest Body Schema + * + *
{@code
+ * {
+ * userData: String
+ * }
+ * }
+ *
+ * @param largeFaceListId Id referencing a particular large face list.
+ * @param persistedFaceId Id referencing a particular persistedFaceId of an existing face.
+ * @param body Request body for updating persisted face.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseQuota: * Free-tier subscription quota: 1,000 faces per large face list. * S0-tier subscription quota: + * 1,000,000 faces per large face list. + * + *
Query Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| userData | String | No | User-specified data about the face for any purpose. The maximum length is 1KB. |
| targetFace | String | No | A face rectangle to specify the target face to be added to a person in the format of "targetFace=left,top,width,height". E.g. "targetFace=10,10,100,100". If there is more than one face in the image, targetFace is required to specify which face to add. No targetFace means there is only one face detected in the entire image. In the form of "," separated string. |
| detectionModel | String | No | Name of detection model. Detection model is used to detect faces in the submitted image. A detection model name can be provided when performing Face - Detect or (Large)FaceList - Add Face or (Large)PersonGroup - Add Face. The default value is 'detection_01', if another model is needed, please explicitly specify it. |
Request Body Schema + * + *
{@code
+ * {
+ * url: String
+ * }
+ * }
+ *
+ * Response Body Schema + * + *
{@code
+ * {
+ * persistedFaceId: String
+ * userData: String
+ * }
+ * }
+ *
+ * @param largeFaceListId Id referencing a particular large face list.
+ * @param imageUrl A JSON document with a URL pointing to the image that is to be analyzed.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return personFace object along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseQuery Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| start | String | No | Starting face id to return (used to list a range of faces). |
| top | String | No | Number of faces to return starting with the face id indicated by the 'start' parameter. |
Response Body Schema + * + *
{@code
+ * [
+ * {
+ * persistedFaceId: String
+ * userData: String
+ * }
+ * ]
+ * }
+ *
+ * @param largeFaceListId Id referencing a particular large face list.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return an array of persisted faces within the face list or large face list along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseQuota: * Free-tier subscription quota: 1,000 faces per large face list. * S0-tier subscription quota: + * 1,000,000 faces per large face list. + * + *
Query Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| userData | String | No | User-specified data about the face for any purpose. The maximum length is 1KB. |
| targetFace | String | No | A face rectangle to specify the target face to be added to a person in the format of "targetFace=left,top,width,height". E.g. "targetFace=10,10,100,100". If there is more than one face in the image, targetFace is required to specify which face to add. No targetFace means there is only one face detected in the entire image. In the form of "," separated string. |
| detectionModel | String | No | Name of detection model. Detection model is used to detect faces in the submitted image. A detection model name can be provided when performing Face - Detect or (Large)FaceList - Add Face or (Large)PersonGroup - Add Face. The default value is 'detection_01', if another model is needed, please explicitly specify it. |
Header Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| Content-Length | long | Yes | The contentLength parameter |
Request Body Schema + * + *
{@code
+ * Flux
+ * }
+ *
+ * Response Body Schema + * + *
{@code
+ * {
+ * persistedFaceId: String
+ * userData: String
+ * }
+ * }
+ *
+ * @param largeFaceListId Id referencing a particular large face list.
+ * @param image An image stream.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return personFace object along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseLarge person group quota: * Free-tier subscription quota: 1,000 large person groups. * S0-tier subscription + * quota: 1,000,000 large person groups. + * + *
Request Body Schema + * + *
{@code
+ * {
+ * name: String
+ * userData: String
+ * recognitionModel: String(recognition_01/recognition_02/recognition_03/recognition_04)
+ * }
+ * }
+ *
+ * @param largePersonGroupId Id referencing a particular large person group.
+ * @param body Request body for creating new large person group.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoQuery Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| returnRecognitionModel | String | No | A value indicating whether the operation should return 'recognitionModel' in response. |
Response Body Schema + * + *
{@code
+ * {
+ * largePersonGroupId: String
+ * name: String
+ * userData: String
+ * recognitionModel: String(recognition_01/recognition_02/recognition_03/recognition_04)
+ * }
+ * }
+ *
+ * @param largePersonGroupId Id referencing a particular large person group.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return large person group object along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoRequest Body Schema + * + *
{@code
+ * {
+ * name: String
+ * userData: String
+ * }
+ * }
+ *
+ * @param largePersonGroupId Id referencing a particular large person group.
+ * @param body Request body for updating large person group.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoResponse Body Schema + * + *
{@code
+ * {
+ * status: String(nonstarted/running/succeeded/failed)
+ * created: String
+ * lastAction: String
+ * lastSuccessfulTraining: String
+ * message: String
+ * }
+ * }
+ *
+ * @param largePersonGroupId Id referencing a particular large person group.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return training status object along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoQuery Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| start | String | No | List large person groups from the least largePersonGroupId greater than the "start". |
| top | String | No | The number of large person groups to list. |
| returnRecognitionModel | String | No | A value indicating whether the operation should return 'recognitionModel' in response. |
Response Body Schema + * + *
{@code
+ * [
+ * {
+ * largePersonGroupId: String
+ * name: String
+ * userData: String
+ * recognitionModel: String(recognition_01/recognition_02/recognition_03/recognition_04)
+ * }
+ * ]
+ * }
+ *
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return an array of large person groups along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoLarge person group quota: * Free-tier subscription quota: 1,000 large person groups. * S0-tier subscription + * quota: 1,000,000 large person groups. + * + *
Request Body Schema + * + *
{@code
+ * {
+ * name: String
+ * userData: String
+ * recognitionModel: String(recognition_01/recognition_02/recognition_03/recognition_04)
+ * }
+ * }
+ *
+ * @param largePersonGroupId Id referencing a particular large person group.
+ * @param body Request body for creating new large person group.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseQuery Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| returnRecognitionModel | String | No | A value indicating whether the operation should return 'recognitionModel' in response. |
Response Body Schema + * + *
{@code
+ * {
+ * largePersonGroupId: String
+ * name: String
+ * userData: String
+ * recognitionModel: String(recognition_01/recognition_02/recognition_03/recognition_04)
+ * }
+ * }
+ *
+ * @param largePersonGroupId Id referencing a particular large person group.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return large person group object along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseRequest Body Schema + * + *
{@code
+ * {
+ * name: String
+ * userData: String
+ * }
+ * }
+ *
+ * @param largePersonGroupId Id referencing a particular large person group.
+ * @param body Request body for updating large person group.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseResponse Body Schema + * + *
{@code
+ * {
+ * status: String(nonstarted/running/succeeded/failed)
+ * created: String
+ * lastAction: String
+ * lastSuccessfulTraining: String
+ * message: String
+ * }
+ * }
+ *
+ * @param largePersonGroupId Id referencing a particular large person group.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return training status object along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseQuery Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| start | String | No | List large person groups from the least largePersonGroupId greater than the "start". |
| top | String | No | The number of large person groups to list. |
| returnRecognitionModel | String | No | A value indicating whether the operation should return 'recognitionModel' in response. |
Response Body Schema + * + *
{@code
+ * [
+ * {
+ * largePersonGroupId: String
+ * name: String
+ * userData: String
+ * recognitionModel: String(recognition_01/recognition_02/recognition_03/recognition_04)
+ * }
+ * ]
+ * }
+ *
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return an array of large person groups along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseRequest Body Schema + * + *
{@code
+ * {
+ * name: String
+ * userData: String
+ * }
+ * }
+ *
+ * Response Body Schema + * + *
{@code
+ * {
+ * name: String
+ * userData: String
+ * personId: String
+ * persistedFaceIds: [
+ * String
+ * ]
+ * }
+ * }
+ *
+ * @param largePersonGroupId Id referencing a particular large person group.
+ * @param body Request body for creating new person.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return person object along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoQuery Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| start | String | No | Starting person id to return (used to list a range of persons). |
| top | String | No | Number of persons to return starting with the person id indicated by the 'start' parameter. |
Response Body Schema + * + *
{@code
+ * [
+ * {
+ * name: String
+ * userData: String
+ * personId: String
+ * persistedFaceIds: [
+ * String
+ * ]
+ * }
+ * ]
+ * }
+ *
+ * @param largePersonGroupId Id referencing a particular large person group.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return an array of Persons along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoResponse Body Schema + * + *
{@code
+ * {
+ * name: String
+ * userData: String
+ * personId: String
+ * persistedFaceIds: [
+ * String
+ * ]
+ * }
+ * }
+ *
+ * @param largePersonGroupId Id referencing a particular large person group.
+ * @param personId Id referencing a particular person.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return person object along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoRequest Body Schema + * + *
{@code
+ * {
+ * name: String
+ * userData: String
+ * }
+ * }
+ *
+ * @param largePersonGroupId Id referencing a particular large person group.
+ * @param personId Id referencing a particular person.
+ * @param body Request body for person update operation.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoResponse Body Schema + * + *
{@code
+ * {
+ * persistedFaceId: String
+ * userData: String
+ * }
+ * }
+ *
+ * @param largePersonGroupId Id referencing a particular large person group.
+ * @param personId Id referencing a particular person.
+ * @param persistedFaceId Id referencing a particular persistedFaceId of an existing face.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return personFace object along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoRequest Body Schema + * + *
{@code
+ * {
+ * userData: String
+ * }
+ * }
+ *
+ * @param largePersonGroupId Id referencing a particular large person group.
+ * @param personId Id referencing a particular person.
+ * @param persistedFaceId Id referencing a particular persistedFaceId of an existing face.
+ * @param body Request body for updating persisted face.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoQuery Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| userData | String | No | User-specified data about the face for any purpose. The maximum length is 1KB. |
| targetFace | String | No | A face rectangle to specify the target face to be added to a person in the format of "targetFace=left,top,width,height". E.g. "targetFace=10,10,100,100". If there is more than one face in the image, targetFace is required to specify which face to add. No targetFace means there is only one face detected in the entire image. In the form of "," separated string. |
| detectionModel | String | No | Name of detection model. Detection model is used to detect faces in the submitted image. A detection model name can be provided when performing Face - Detect or (Large)FaceList - Add Face or (Large)PersonGroup - Add Face. The default value is 'detection_01', if another model is needed, please explicitly specify it. |
Request Body Schema + * + *
{@code
+ * {
+ * url: String
+ * }
+ * }
+ *
+ * Response Body Schema + * + *
{@code
+ * {
+ * persistedFaceId: String
+ * userData: String
+ * }
+ * }
+ *
+ * @param largePersonGroupId Id referencing a particular large person group.
+ * @param personId Id referencing a particular person.
+ * @param imageUrl A JSON document with a URL pointing to the image that is to be analyzed.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return personFace object along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoQuery Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| userData | String | No | User-specified data about the face for any purpose. The maximum length is 1KB. |
| targetFace | String | No | A face rectangle to specify the target face to be added to a person in the format of "targetFace=left,top,width,height". E.g. "targetFace=10,10,100,100". If there is more than one face in the image, targetFace is required to specify which face to add. No targetFace means there is only one face detected in the entire image. In the form of "," separated string. |
| detectionModel | String | No | Name of detection model. Detection model is used to detect faces in the submitted image. A detection model name can be provided when performing Face - Detect or (Large)FaceList - Add Face or (Large)PersonGroup - Add Face. The default value is 'detection_01', if another model is needed, please explicitly specify it. |
Header Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| Content-Length | long | Yes | The contentLength parameter |
Request Body Schema + * + *
{@code
+ * Flux
+ * }
+ *
+ * Response Body Schema + * + *
{@code
+ * {
+ * persistedFaceId: String
+ * userData: String
+ * }
+ * }
+ *
+ * @param largePersonGroupId Id referencing a particular large person group.
+ * @param personId Id referencing a particular person.
+ * @param image An image stream.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return personFace object along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoRequest Body Schema + * + *
{@code
+ * {
+ * name: String
+ * userData: String
+ * }
+ * }
+ *
+ * Response Body Schema + * + *
{@code
+ * {
+ * name: String
+ * userData: String
+ * personId: String
+ * persistedFaceIds: [
+ * String
+ * ]
+ * }
+ * }
+ *
+ * @param largePersonGroupId Id referencing a particular large person group.
+ * @param body Request body for creating new person.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return person object along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseQuery Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| start | String | No | Starting person id to return (used to list a range of persons). |
| top | String | No | Number of persons to return starting with the person id indicated by the 'start' parameter. |
Response Body Schema + * + *
{@code
+ * [
+ * {
+ * name: String
+ * userData: String
+ * personId: String
+ * persistedFaceIds: [
+ * String
+ * ]
+ * }
+ * ]
+ * }
+ *
+ * @param largePersonGroupId Id referencing a particular large person group.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return an array of Persons along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseResponse Body Schema + * + *
{@code
+ * {
+ * name: String
+ * userData: String
+ * personId: String
+ * persistedFaceIds: [
+ * String
+ * ]
+ * }
+ * }
+ *
+ * @param largePersonGroupId Id referencing a particular large person group.
+ * @param personId Id referencing a particular person.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return person object along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseRequest Body Schema + * + *
{@code
+ * {
+ * name: String
+ * userData: String
+ * }
+ * }
+ *
+ * @param largePersonGroupId Id referencing a particular large person group.
+ * @param personId Id referencing a particular person.
+ * @param body Request body for person update operation.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseResponse Body Schema + * + *
{@code
+ * {
+ * persistedFaceId: String
+ * userData: String
+ * }
+ * }
+ *
+ * @param largePersonGroupId Id referencing a particular large person group.
+ * @param personId Id referencing a particular person.
+ * @param persistedFaceId Id referencing a particular persistedFaceId of an existing face.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return personFace object along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseRequest Body Schema + * + *
{@code
+ * {
+ * userData: String
+ * }
+ * }
+ *
+ * @param largePersonGroupId Id referencing a particular large person group.
+ * @param personId Id referencing a particular person.
+ * @param persistedFaceId Id referencing a particular persistedFaceId of an existing face.
+ * @param body Request body for updating persisted face.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseQuery Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| userData | String | No | User-specified data about the face for any purpose. The maximum length is 1KB. |
| targetFace | String | No | A face rectangle to specify the target face to be added to a person in the format of "targetFace=left,top,width,height". E.g. "targetFace=10,10,100,100". If there is more than one face in the image, targetFace is required to specify which face to add. No targetFace means there is only one face detected in the entire image. In the form of "," separated string. |
| detectionModel | String | No | Name of detection model. Detection model is used to detect faces in the submitted image. A detection model name can be provided when performing Face - Detect or (Large)FaceList - Add Face or (Large)PersonGroup - Add Face. The default value is 'detection_01', if another model is needed, please explicitly specify it. |
Request Body Schema + * + *
{@code
+ * {
+ * url: String
+ * }
+ * }
+ *
+ * Response Body Schema + * + *
{@code
+ * {
+ * persistedFaceId: String
+ * userData: String
+ * }
+ * }
+ *
+ * @param largePersonGroupId Id referencing a particular large person group.
+ * @param personId Id referencing a particular person.
+ * @param imageUrl A JSON document with a URL pointing to the image that is to be analyzed.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return personFace object along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseQuery Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| userData | String | No | User-specified data about the face for any purpose. The maximum length is 1KB. |
| targetFace | String | No | A face rectangle to specify the target face to be added to a person in the format of "targetFace=left,top,width,height". E.g. "targetFace=10,10,100,100". If there is more than one face in the image, targetFace is required to specify which face to add. No targetFace means there is only one face detected in the entire image. In the form of "," separated string. |
| detectionModel | String | No | Name of detection model. Detection model is used to detect faces in the submitted image. A detection model name can be provided when performing Face - Detect or (Large)FaceList - Add Face or (Large)PersonGroup - Add Face. The default value is 'detection_01', if another model is needed, please explicitly specify it. |
Header Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| Content-Length | long | Yes | The contentLength parameter |
Request Body Schema + * + *
{@code
+ * Flux
+ * }
+ *
+ * Response Body Schema + * + *
{@code
+ * {
+ * persistedFaceId: String
+ * userData: String
+ * }
+ * }
+ *
+ * @param largePersonGroupId Id referencing a particular large person group.
+ * @param personId Id referencing a particular person.
+ * @param image An image stream.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return personFace object along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseQuery Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| start | String | No | The start parameter |
| top | String | No | The top parameter |
Response Body Schema + * + *
{@code
+ * [
+ * {
+ * personId: String
+ * name: String
+ * userData: String
+ * }
+ * ]
+ * }
+ *
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return array of EnrollmentResponse along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoRequest Body Schema + * + *
{@code
+ * {
+ * personId: String
+ * name: String
+ * userData: String
+ * }
+ * }
+ *
+ * Response Body Schema + * + *
{@code
+ * {
+ * personId: String
+ * }
+ * }
+ *
+ * @param body The body parameter.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the response body along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoRequest Body Schema + * + *
{@code
+ * {
+ * name: String
+ * userData: String
+ * }
+ * }
+ *
+ * @param personId The personId parameter.
+ * @param body The body parameter.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoResponse Body Schema + * + *
{@code
+ * {
+ * personId: String
+ * name: String
+ * userData: String
+ * }
+ * }
+ *
+ * @param personId Person id.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the response body along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoQuery Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| detectionModel | String | No | Detection model string. |
| userData | String | No | User data of person face. |
| targetFace | String | No | Target face. |
Response Body Schema + * + *
{@code
+ * {
+ * persistedFaceId: String
+ * recognitionModel: String
+ * userData: String
+ * }
+ * }
+ *
+ * @param personId Person id.
+ * @param recognitionModel Recognition model string.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the response body along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoResponse Body Schema + * + *
{@code
+ * {
+ * personId: String
+ * persistedFaceIds: [
+ * String
+ * ]
+ * name: String
+ * userData: String
+ * }
+ * }
+ *
+ * @param personId Target person to get persistedFaceIds from.
+ * @param recognitionModel The 'recognitionModel' associated with this persisted face.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the response body along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoResponse Body Schema + * + *
{@code
+ * {
+ * persistedFaceId: String
+ * userData: String
+ * }
+ * }
+ *
+ * @param personId Target person to get face from.
+ * @param recognitionModel The 'recognitionModel' associated with this persisted face.
+ * @param persistedFaceId Target person face id to get.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the response body along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoRequest Body Schema + * + *
{@code
+ * {
+ * detectionModel: String(detection_01/detection_02/detection_03/detection_preview_1904/ir_detection_01/expression_01)
+ * faceFeature: byte[]
+ * persistedFaceId: String
+ * userData: String
+ * }
+ * }
+ *
+ * @param personId Target person to update face from.
+ * @param recognitionModel The 'recognitionModel' associated with this persisted face.
+ * @param persistedFaceId PersistedFaceId created from Person Face Create.
+ * @param body Target person face id to update.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoRequest Body Schema + * + *
{@code
+ * {
+ * name: String
+ * userData: String
+ * addPersonIds: [
+ * String
+ * ]
+ * }
+ * }
+ *
+ * @param dynamicPersonGroupId User provided dynamic person group Id. Valid format should be a string composed by
+ * numbers, English letters in lower case, '-', '_', and no longer than 64 characters.
+ * @param body The body parameter.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoRequest Body Schema + * + *
{@code
+ * {
+ * removePersonIds: [
+ * String
+ * ]
+ * name: String
+ * userData: String
+ * addPersonIds: [
+ * String
+ * ]
+ * }
+ * }
+ *
+ * @param dynamicPersonGroupId User provided dynamic person group Id.
+ * @param body The body parameter.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoResponse Body Schema + * + *
{@code
+ * {
+ * dynamicPersonGroupId: String
+ * name: String
+ * userData: String
+ * }
+ * }
+ *
+ * @param dynamicPersonGroupId User provided dynamic person group id.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return metadata on a dynamic person group along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoQuery Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| start | String | No | List persons from the least personId greater than the "start". It contains no more than 64 characters. Default is empty. |
| top | String | No | The number of persons to list, ranging in [1, 1000]. Default is 1000. |
Response Body Schema + * + *
{@code
+ * {
+ * personIds: [
+ * String
+ * ]
+ * }
+ * }
+ *
+ * @param dynamicPersonGroupId Dynamic person group Id to list persons from.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the response body along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoQuery Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| start | String | No | List dynamicPersonGroupId from the least dynamicPersonGroupId greater than the "start". It contains no more than 64 characters. Default is empty. |
| top | String | No | The number of dynamicPersonGroups to list, ranging in [1, 1000]. Default is 1000. |
Response Body Schema + * + *
{@code
+ * [
+ * {
+ * dynamicPersonGroupId: String
+ * name: String
+ * userData: String
+ * }
+ * ]
+ * }
+ *
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return array of DynamicPersonGroupGetResponse along with {@link Response} on successful completion of {@link
+ * Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoQuery Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| start | String | No | List dynamic person group id from the least dynamicPersonGroupId greater than the "start". It contains no more than 64 characters. Default is empty. |
| top | String | No | The number of dynamicPersonGroupId to list, ranging in [1, 1000]. Default is 1000. |
Response Body Schema + * + *
{@code
+ * {
+ * personId: String
+ * dynamicPersonGroupIds: [
+ * String
+ * ]
+ * }
+ * }
+ *
+ * @param personId Valid PersonId created from Person Create.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the response body along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoQuery Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| detectionModel | String | No | Detection model string. |
| userData | String | No | User data of person face. |
| targetFace | String | No | Target face. |
Header Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| Content-Length | long | Yes | The contentLength parameter |
Request Body Schema + * + *
{@code
+ * Flux
+ * }
+ *
+ * Response Body Schema + * + *
{@code
+ * {
+ * persistedFaceId: String
+ * recognitionModel: String
+ * userData: String
+ * }
+ * }
+ *
+ * @param personId Person id.
+ * @param recognitionModel Recognition model string.
+ * @param image An image stream.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the response body along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoQuery Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| start | String | No | The start parameter |
| top | String | No | The top parameter |
Response Body Schema + * + *
{@code
+ * [
+ * {
+ * personId: String
+ * name: String
+ * userData: String
+ * }
+ * ]
+ * }
+ *
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return array of EnrollmentResponse along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseRequest Body Schema + * + *
{@code
+ * {
+ * personId: String
+ * name: String
+ * userData: String
+ * }
+ * }
+ *
+ * Response Body Schema + * + *
{@code
+ * {
+ * personId: String
+ * }
+ * }
+ *
+ * @param body The body parameter.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the response body along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseRequest Body Schema + * + *
{@code
+ * {
+ * name: String
+ * userData: String
+ * }
+ * }
+ *
+ * @param personId The personId parameter.
+ * @param body The body parameter.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseResponse Body Schema + * + *
{@code
+ * {
+ * personId: String
+ * name: String
+ * userData: String
+ * }
+ * }
+ *
+ * @param personId Person id.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the response body along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseQuery Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| detectionModel | String | No | Detection model string. |
| userData | String | No | User data of person face. |
| targetFace | String | No | Target face. |
Response Body Schema + * + *
{@code
+ * {
+ * persistedFaceId: String
+ * recognitionModel: String
+ * userData: String
+ * }
+ * }
+ *
+ * @param personId Person id.
+ * @param recognitionModel Recognition model string.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the response body along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseResponse Body Schema + * + *
{@code
+ * {
+ * personId: String
+ * persistedFaceIds: [
+ * String
+ * ]
+ * name: String
+ * userData: String
+ * }
+ * }
+ *
+ * @param personId Target person to get persistedFaceIds from.
+ * @param recognitionModel The 'recognitionModel' associated with this persisted face.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the response body along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseResponse Body Schema + * + *
{@code
+ * {
+ * persistedFaceId: String
+ * userData: String
+ * }
+ * }
+ *
+ * @param personId Target person to get face from.
+ * @param recognitionModel The 'recognitionModel' associated with this persisted face.
+ * @param persistedFaceId Target person face id to get.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the response body along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseRequest Body Schema + * + *
{@code
+ * {
+ * detectionModel: String(detection_01/detection_02/detection_03/detection_preview_1904/ir_detection_01/expression_01)
+ * faceFeature: byte[]
+ * persistedFaceId: String
+ * userData: String
+ * }
+ * }
+ *
+ * @param personId Target person to update face from.
+ * @param recognitionModel The 'recognitionModel' associated with this persisted face.
+ * @param persistedFaceId PersistedFaceId created from Person Face Create.
+ * @param body Target person face id to update.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseRequest Body Schema + * + *
{@code
+ * {
+ * name: String
+ * userData: String
+ * addPersonIds: [
+ * String
+ * ]
+ * }
+ * }
+ *
+ * @param dynamicPersonGroupId User provided dynamic person group Id. Valid format should be a string composed by
+ * numbers, English letters in lower case, '-', '_', and no longer than 64 characters.
+ * @param body The body parameter.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseRequest Body Schema + * + *
{@code
+ * {
+ * removePersonIds: [
+ * String
+ * ]
+ * name: String
+ * userData: String
+ * addPersonIds: [
+ * String
+ * ]
+ * }
+ * }
+ *
+ * @param dynamicPersonGroupId User provided dynamic person group Id.
+ * @param body The body parameter.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseResponse Body Schema + * + *
{@code
+ * {
+ * dynamicPersonGroupId: String
+ * name: String
+ * userData: String
+ * }
+ * }
+ *
+ * @param dynamicPersonGroupId User provided dynamic person group id.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return metadata on a dynamic person group along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseQuery Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| start | String | No | List persons from the least personId greater than the "start". It contains no more than 64 characters. Default is empty. |
| top | String | No | The number of persons to list, ranging in [1, 1000]. Default is 1000. |
Response Body Schema + * + *
{@code
+ * {
+ * personIds: [
+ * String
+ * ]
+ * }
+ * }
+ *
+ * @param dynamicPersonGroupId Dynamic person group Id to list persons from.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the response body along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseQuery Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| start | String | No | List dynamicPersonGroupId from the least dynamicPersonGroupId greater than the "start". It contains no more than 64 characters. Default is empty. |
| top | String | No | The number of dynamicPersonGroups to list, ranging in [1, 1000]. Default is 1000. |
Response Body Schema + * + *
{@code
+ * [
+ * {
+ * dynamicPersonGroupId: String
+ * name: String
+ * userData: String
+ * }
+ * ]
+ * }
+ *
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return array of DynamicPersonGroupGetResponse along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseQuery Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| start | String | No | List dynamic person group id from the least dynamicPersonGroupId greater than the "start". It contains no more than 64 characters. Default is empty. |
| top | String | No | The number of dynamicPersonGroupId to list, ranging in [1, 1000]. Default is 1000. |
Response Body Schema + * + *
{@code
+ * {
+ * personId: String
+ * dynamicPersonGroupIds: [
+ * String
+ * ]
+ * }
+ * }
+ *
+ * @param personId Valid PersonId created from Person Create.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the response body along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseQuery Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| detectionModel | String | No | Detection model string. |
| userData | String | No | User data of person face. |
| targetFace | String | No | Target face. |
Header Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| Content-Length | long | Yes | The contentLength parameter |
Request Body Schema + * + *
{@code
+ * Flux
+ * }
+ *
+ * Response Body Schema + * + *
{@code
+ * {
+ * persistedFaceId: String
+ * recognitionModel: String
+ * userData: String
+ * }
+ * }
+ *
+ * @param personId Person id.
+ * @param recognitionModel Recognition model string.
+ * @param image An image stream.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the response body along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponsePerson group quota: * Free-tier subscription quota: 1,000 person groups. Each holds up to 1,000 persons. * + * S0-tier subscription quota: 1,000,000 person groups. Each holds up to 10,000 persons. * to handle larger scale + * face identification problem, please consider using + * [LargePersonGroup](https://docs.microsoft.com/rest/api/faceapi/largepersongroup). + * + *
Request Body Schema + * + *
{@code
+ * {
+ * name: String
+ * userData: String
+ * recognitionModel: String(recognition_01/recognition_02/recognition_03/recognition_04)
+ * }
+ * }
+ *
+ * @param personGroupId Id referencing a particular person group.
+ * @param body Request body for creating new person group.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoQuery Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| returnRecognitionModel | String | No | A value indicating whether the operation should return 'recognitionModel' in response. |
Response Body Schema + * + *
{@code
+ * {
+ * personGroupId: String
+ * name: String
+ * userData: String
+ * recognitionModel: String(recognition_01/recognition_02/recognition_03/recognition_04)
+ * }
+ * }
+ *
+ * @param personGroupId Id referencing a particular person group.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return person group object along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoRequest Body Schema + * + *
{@code
+ * {
+ * name: String
+ * userData: String
+ * }
+ * }
+ *
+ * @param personGroupId Id referencing a particular person group.
+ * @param body Request body for updating person group.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoResponse Body Schema + * + *
{@code
+ * {
+ * status: String(nonstarted/running/succeeded/failed)
+ * created: String
+ * lastAction: String
+ * lastSuccessfulTraining: String
+ * message: String
+ * }
+ * }
+ *
+ * @param personGroupId Id referencing a particular person group.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return training status object along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoQuery Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| start | String | No | List person groups from the least personGroupId greater than the "start". |
| top | String | No | The number of person groups to list. |
| returnRecognitionModel | String | No | A value indicating whether the operation should return 'recognitionModel' in response. |
Response Body Schema + * + *
{@code
+ * [
+ * {
+ * personGroupId: String
+ * name: String
+ * userData: String
+ * recognitionModel: String(recognition_01/recognition_02/recognition_03/recognition_04)
+ * }
+ * ]
+ * }
+ *
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return an array of person groups along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoPerson group quota: * Free-tier subscription quota: 1,000 person groups. Each holds up to 1,000 persons. * + * S0-tier subscription quota: 1,000,000 person groups. Each holds up to 10,000 persons. * to handle larger scale + * face identification problem, please consider using + * [LargePersonGroup](https://docs.microsoft.com/rest/api/faceapi/largepersongroup). + * + *
Request Body Schema + * + *
{@code
+ * {
+ * name: String
+ * userData: String
+ * recognitionModel: String(recognition_01/recognition_02/recognition_03/recognition_04)
+ * }
+ * }
+ *
+ * @param personGroupId Id referencing a particular person group.
+ * @param body Request body for creating new person group.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseQuery Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| returnRecognitionModel | String | No | A value indicating whether the operation should return 'recognitionModel' in response. |
Response Body Schema + * + *
{@code
+ * {
+ * personGroupId: String
+ * name: String
+ * userData: String
+ * recognitionModel: String(recognition_01/recognition_02/recognition_03/recognition_04)
+ * }
+ * }
+ *
+ * @param personGroupId Id referencing a particular person group.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return person group object along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseRequest Body Schema + * + *
{@code
+ * {
+ * name: String
+ * userData: String
+ * }
+ * }
+ *
+ * @param personGroupId Id referencing a particular person group.
+ * @param body Request body for updating person group.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseResponse Body Schema + * + *
{@code
+ * {
+ * status: String(nonstarted/running/succeeded/failed)
+ * created: String
+ * lastAction: String
+ * lastSuccessfulTraining: String
+ * message: String
+ * }
+ * }
+ *
+ * @param personGroupId Id referencing a particular person group.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return training status object along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseQuery Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| start | String | No | List person groups from the least personGroupId greater than the "start". |
| top | String | No | The number of person groups to list. |
| returnRecognitionModel | String | No | A value indicating whether the operation should return 'recognitionModel' in response. |
Response Body Schema + * + *
{@code
+ * [
+ * {
+ * personGroupId: String
+ * name: String
+ * userData: String
+ * recognitionModel: String(recognition_01/recognition_02/recognition_03/recognition_04)
+ * }
+ * ]
+ * }
+ *
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return an array of person groups along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseRequest Body Schema + * + *
{@code
+ * {
+ * name: String
+ * userData: String
+ * }
+ * }
+ *
+ * Response Body Schema + * + *
{@code
+ * {
+ * name: String
+ * userData: String
+ * personId: String
+ * persistedFaceIds: [
+ * String
+ * ]
+ * }
+ * }
+ *
+ * @param personGroupId Id referencing a particular person group.
+ * @param body Request body for creating new person.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return person object along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoQuery Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| start | String | No | Starting person id to return (used to list a range of persons). |
| top | String | No | Number of persons to return starting with the person id indicated by the 'start' parameter. |
Response Body Schema + * + *
{@code
+ * [
+ * {
+ * name: String
+ * userData: String
+ * personId: String
+ * persistedFaceIds: [
+ * String
+ * ]
+ * }
+ * ]
+ * }
+ *
+ * @param personGroupId Id referencing a particular person group.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return an array of Persons along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoResponse Body Schema + * + *
{@code
+ * {
+ * name: String
+ * userData: String
+ * personId: String
+ * persistedFaceIds: [
+ * String
+ * ]
+ * }
+ * }
+ *
+ * @param personGroupId Id referencing a particular person group.
+ * @param personId Id referencing a particular person.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return person object along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoRequest Body Schema + * + *
{@code
+ * {
+ * name: String
+ * userData: String
+ * }
+ * }
+ *
+ * @param personGroupId Id referencing a particular person group.
+ * @param personId Id referencing a particular person.
+ * @param body Request body for person update operation.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoResponse Body Schema + * + *
{@code
+ * {
+ * persistedFaceId: String
+ * userData: String
+ * }
+ * }
+ *
+ * @param personGroupId Id referencing a particular person group.
+ * @param personId Id referencing a particular person.
+ * @param persistedFaceId Id referencing a particular persistedFaceId of an existing face.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return personFace object along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoRequest Body Schema + * + *
{@code
+ * {
+ * userData: String
+ * }
+ * }
+ *
+ * @param personGroupId Id referencing a particular person group.
+ * @param personId Id referencing a particular person.
+ * @param persistedFaceId Id referencing a particular persistedFaceId of an existing face.
+ * @param body Request body for updating persisted face.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoQuery Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| userData | String | No | User-specified data about the face for any purpose. The maximum length is 1KB. |
| targetFace | String | No | A face rectangle to specify the target face to be added to a person in the format of "targetFace=left,top,width,height". E.g. "targetFace=10,10,100,100". If there is more than one face in the image, targetFace is required to specify which face to add. No targetFace means there is only one face detected in the entire image. In the form of "," separated string. |
| detectionModel | String | No | Name of detection model. Detection model is used to detect faces in the submitted image. A detection model name can be provided when performing Face - Detect or (Large)FaceList - Add Face or (Large)PersonGroup - Add Face. The default value is 'detection_01', if another model is needed, please explicitly specify it. |
Request Body Schema + * + *
{@code
+ * {
+ * url: String
+ * }
+ * }
+ *
+ * Response Body Schema + * + *
{@code
+ * {
+ * persistedFaceId: String
+ * userData: String
+ * }
+ * }
+ *
+ * @param personGroupId Id referencing a particular person group.
+ * @param personId Id referencing a particular person.
+ * @param imageUrl A JSON document with a URL pointing to the image that is to be analyzed.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return personFace object along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoQuery Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| userData | String | No | User-specified data about the face for any purpose. The maximum length is 1KB. |
| targetFace | String | No | A face rectangle to specify the target face to be added to a person in the format of "targetFace=left,top,width,height". E.g. "targetFace=10,10,100,100". If there is more than one face in the image, targetFace is required to specify which face to add. No targetFace means there is only one face detected in the entire image. In the form of "," separated string. |
| detectionModel | String | No | Name of detection model. Detection model is used to detect faces in the submitted image. A detection model name can be provided when performing Face - Detect or (Large)FaceList - Add Face or (Large)PersonGroup - Add Face. The default value is 'detection_01', if another model is needed, please explicitly specify it. |
Header Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| Content-Length | long | Yes | The contentLength parameter |
Request Body Schema + * + *
{@code
+ * Flux
+ * }
+ *
+ * Response Body Schema + * + *
{@code
+ * {
+ * persistedFaceId: String
+ * userData: String
+ * }
+ * }
+ *
+ * @param personGroupId Id referencing a particular person group.
+ * @param personId Id referencing a particular person.
+ * @param image An image stream.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return personFace object along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoRequest Body Schema + * + *
{@code
+ * {
+ * name: String
+ * userData: String
+ * }
+ * }
+ *
+ * Response Body Schema + * + *
{@code
+ * {
+ * name: String
+ * userData: String
+ * personId: String
+ * persistedFaceIds: [
+ * String
+ * ]
+ * }
+ * }
+ *
+ * @param personGroupId Id referencing a particular person group.
+ * @param body Request body for creating new person.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return person object along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseQuery Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| start | String | No | Starting person id to return (used to list a range of persons). |
| top | String | No | Number of persons to return starting with the person id indicated by the 'start' parameter. |
Response Body Schema + * + *
{@code
+ * [
+ * {
+ * name: String
+ * userData: String
+ * personId: String
+ * persistedFaceIds: [
+ * String
+ * ]
+ * }
+ * ]
+ * }
+ *
+ * @param personGroupId Id referencing a particular person group.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return an array of Persons along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseResponse Body Schema + * + *
{@code
+ * {
+ * name: String
+ * userData: String
+ * personId: String
+ * persistedFaceIds: [
+ * String
+ * ]
+ * }
+ * }
+ *
+ * @param personGroupId Id referencing a particular person group.
+ * @param personId Id referencing a particular person.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return person object along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseRequest Body Schema + * + *
{@code
+ * {
+ * name: String
+ * userData: String
+ * }
+ * }
+ *
+ * @param personGroupId Id referencing a particular person group.
+ * @param personId Id referencing a particular person.
+ * @param body Request body for person update operation.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseResponse Body Schema + * + *
{@code
+ * {
+ * persistedFaceId: String
+ * userData: String
+ * }
+ * }
+ *
+ * @param personGroupId Id referencing a particular person group.
+ * @param personId Id referencing a particular person.
+ * @param persistedFaceId Id referencing a particular persistedFaceId of an existing face.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return personFace object along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseRequest Body Schema + * + *
{@code
+ * {
+ * userData: String
+ * }
+ * }
+ *
+ * @param personGroupId Id referencing a particular person group.
+ * @param personId Id referencing a particular person.
+ * @param persistedFaceId Id referencing a particular persistedFaceId of an existing face.
+ * @param body Request body for updating persisted face.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseQuery Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| userData | String | No | User-specified data about the face for any purpose. The maximum length is 1KB. |
| targetFace | String | No | A face rectangle to specify the target face to be added to a person in the format of "targetFace=left,top,width,height". E.g. "targetFace=10,10,100,100". If there is more than one face in the image, targetFace is required to specify which face to add. No targetFace means there is only one face detected in the entire image. In the form of "," separated string. |
| detectionModel | String | No | Name of detection model. Detection model is used to detect faces in the submitted image. A detection model name can be provided when performing Face - Detect or (Large)FaceList - Add Face or (Large)PersonGroup - Add Face. The default value is 'detection_01', if another model is needed, please explicitly specify it. |
Request Body Schema + * + *
{@code
+ * {
+ * url: String
+ * }
+ * }
+ *
+ * Response Body Schema + * + *
{@code
+ * {
+ * persistedFaceId: String
+ * userData: String
+ * }
+ * }
+ *
+ * @param personGroupId Id referencing a particular person group.
+ * @param personId Id referencing a particular person.
+ * @param imageUrl A JSON document with a URL pointing to the image that is to be analyzed.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return personFace object along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseQuery Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| userData | String | No | User-specified data about the face for any purpose. The maximum length is 1KB. |
| targetFace | String | No | A face rectangle to specify the target face to be added to a person in the format of "targetFace=left,top,width,height". E.g. "targetFace=10,10,100,100". If there is more than one face in the image, targetFace is required to specify which face to add. No targetFace means there is only one face detected in the entire image. In the form of "," separated string. |
| detectionModel | String | No | Name of detection model. Detection model is used to detect faces in the submitted image. A detection model name can be provided when performing Face - Detect or (Large)FaceList - Add Face or (Large)PersonGroup - Add Face. The default value is 'detection_01', if another model is needed, please explicitly specify it. |
Header Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| Content-Length | long | Yes | The contentLength parameter |
Request Body Schema + * + *
{@code
+ * Flux
+ * }
+ *
+ * Response Body Schema + * + *
{@code
+ * {
+ * persistedFaceId: String
+ * userData: String
+ * }
+ * }
+ *
+ * @param personGroupId Id referencing a particular person group.
+ * @param personId Id referencing a particular person.
+ * @param image An image stream.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return personFace object along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseRequest Body Schema + * + *
{@code
+ * {
+ * type: String(FaceList/LargeFaceList/LargePersonGroup/PersonGroup)
+ * objectId: String
+ * applyScope: [
+ * String
+ * ]
+ * userData: String
+ * }
+ * }
+ *
+ * @param body Request body for taking a snapshot.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoQuery Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| type | String | No | User specified object type as a search filter. |
| applyScope | String | No | User specified snapshot apply scopes as a search filter. ApplyScope is an array of the target Azure subscription ids for the snapshot, specified by the user who created the snapshot by Snapshot - Take. In the form of "," separated string. |
Response Body Schema + * + *
{@code
+ * [
+ * {
+ * id: String
+ * account: String
+ * type: String(FaceList/LargeFaceList/LargePersonGroup/PersonGroup)
+ * applyScope: [
+ * String
+ * ]
+ * userData: String
+ * createdTime: String
+ * lastUpdateTime: String
+ * }
+ * ]
+ * }
+ *
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return an array of snapshots along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoResponse Body Schema + * + *
{@code
+ * {
+ * id: String
+ * account: String
+ * type: String(FaceList/LargeFaceList/LargePersonGroup/PersonGroup)
+ * applyScope: [
+ * String
+ * ]
+ * userData: String
+ * createdTime: String
+ * lastUpdateTime: String
+ * }
+ * }
+ *
+ * @param snapshotId Id referencing a particular snapshot.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return snapshot object along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoRequest Body Schema + * + *
{@code
+ * {
+ * applyScope: [
+ * String
+ * ]
+ * userData: String
+ * }
+ * }
+ *
+ * @param snapshotId Id referencing a particular snapshot.
+ * @param body Request body for updating a snapshot.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoRequest Body Schema + * + *
{@code
+ * {
+ * objectId: String
+ * mode: String
+ * }
+ * }
+ *
+ * @param snapshotId Id referencing a particular snapshot.
+ * @param body Request body for applying a snapshot.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoResponse Body Schema + * + *
{@code
+ * {
+ * status: String(notStarted/running/succeeded/failed)
+ * createdTime: String
+ * lastActionTime: String
+ * finishedTime: String
+ * resourceLocation: String
+ * message: String
+ * }
+ * }
+ *
+ * @param operationId Id referencing a particular take/apply snapshot operation.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return status of a long running operation along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoRequest Body Schema + * + *
{@code
+ * {
+ * type: String(FaceList/LargeFaceList/LargePersonGroup/PersonGroup)
+ * objectId: String
+ * applyScope: [
+ * String
+ * ]
+ * userData: String
+ * }
+ * }
+ *
+ * @param body Request body for taking a snapshot.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseQuery Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| type | String | No | User specified object type as a search filter. |
| applyScope | String | No | User specified snapshot apply scopes as a search filter. ApplyScope is an array of the target Azure subscription ids for the snapshot, specified by the user who created the snapshot by Snapshot - Take. In the form of "," separated string. |
Response Body Schema + * + *
{@code
+ * [
+ * {
+ * id: String
+ * account: String
+ * type: String(FaceList/LargeFaceList/LargePersonGroup/PersonGroup)
+ * applyScope: [
+ * String
+ * ]
+ * userData: String
+ * createdTime: String
+ * lastUpdateTime: String
+ * }
+ * ]
+ * }
+ *
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return an array of snapshots along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseResponse Body Schema + * + *
{@code
+ * {
+ * id: String
+ * account: String
+ * type: String(FaceList/LargeFaceList/LargePersonGroup/PersonGroup)
+ * applyScope: [
+ * String
+ * ]
+ * userData: String
+ * createdTime: String
+ * lastUpdateTime: String
+ * }
+ * }
+ *
+ * @param snapshotId Id referencing a particular snapshot.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return snapshot object along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseRequest Body Schema + * + *
{@code
+ * {
+ * applyScope: [
+ * String
+ * ]
+ * userData: String
+ * }
+ * }
+ *
+ * @param snapshotId Id referencing a particular snapshot.
+ * @param body Request body for updating a snapshot.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseRequest Body Schema + * + *
{@code
+ * {
+ * objectId: String
+ * mode: String
+ * }
+ * }
+ *
+ * @param snapshotId Id referencing a particular snapshot.
+ * @param body Request body for applying a snapshot.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseResponse Body Schema + * + *
{@code
+ * {
+ * status: String(notStarted/running/succeeded/failed)
+ * createdTime: String
+ * lastActionTime: String
+ * finishedTime: String
+ * resourceLocation: String
+ * message: String
+ * }
+ * }
+ *
+ * @param operationId Id referencing a particular take/apply snapshot operation.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return status of a long running operation along with {@link Response}.
+ */
+ @Generated
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseRequest Body Schema + * + *
{@code
+ * {
+ * name: String
+ * userData: String
+ * recognitionModel: String(recognition_01/recognition_02/recognition_03/recognition_04)
+ * }
+ * }
+ *
+ * @param faceListId Id referencing a particular face list.
+ * @param body Request body for creating a face list.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the {@link Response} on successful completion of {@link Mono}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoRequest Body Schema + * + *
{@code
+ * {
+ * name: String
+ * userData: String
+ * recognitionModel: String(recognition_01/recognition_02/recognition_03/recognition_04)
+ * }
+ * }
+ *
+ * @param faceListId Id referencing a particular face list.
+ * @param body Request body for creating a face list.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @param context The context to associate with this operation.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the {@link Response} on successful completion of {@link Mono}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoRequest Body Schema + * + *
{@code
+ * {
+ * name: String
+ * userData: String
+ * recognitionModel: String(recognition_01/recognition_02/recognition_03/recognition_04)
+ * }
+ * }
+ *
+ * @param faceListId Id referencing a particular face list.
+ * @param body Request body for creating a face list.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the {@link Response}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseQuery Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| returnRecognitionModel | String | No | A value indicating whether the operation should return 'recognitionModel' in response. |
Response Body Schema + * + *
{@code
+ * {
+ * faceListId: String
+ * name: String
+ * userData: String
+ * recognitionModel: String(recognition_01/recognition_02/recognition_03/recognition_04)
+ * persistedFaces: [
+ * {
+ * persistedFaceId: String
+ * userData: String
+ * }
+ * ]
+ * }
+ * }
+ *
+ * @param faceListId Id referencing a particular face list.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return face list object along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoQuery Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| returnRecognitionModel | String | No | A value indicating whether the operation should return 'recognitionModel' in response. |
Response Body Schema + * + *
{@code
+ * {
+ * faceListId: String
+ * name: String
+ * userData: String
+ * recognitionModel: String(recognition_01/recognition_02/recognition_03/recognition_04)
+ * persistedFaces: [
+ * {
+ * persistedFaceId: String
+ * userData: String
+ * }
+ * ]
+ * }
+ * }
+ *
+ * @param faceListId Id referencing a particular face list.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @param context The context to associate with this operation.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return face list object along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoQuery Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| returnRecognitionModel | String | No | A value indicating whether the operation should return 'recognitionModel' in response. |
Response Body Schema + * + *
{@code
+ * {
+ * faceListId: String
+ * name: String
+ * userData: String
+ * recognitionModel: String(recognition_01/recognition_02/recognition_03/recognition_04)
+ * persistedFaces: [
+ * {
+ * persistedFaceId: String
+ * userData: String
+ * }
+ * ]
+ * }
+ * }
+ *
+ * @param faceListId Id referencing a particular face list.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return face list object along with {@link Response}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseRequest Body Schema + * + *
{@code
+ * {
+ * name: String
+ * userData: String
+ * }
+ * }
+ *
+ * @param faceListId Id referencing a particular face list.
+ * @param body Request body for updating a face list.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the {@link Response} on successful completion of {@link Mono}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoRequest Body Schema + * + *
{@code
+ * {
+ * name: String
+ * userData: String
+ * }
+ * }
+ *
+ * @param faceListId Id referencing a particular face list.
+ * @param body Request body for updating a face list.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @param context The context to associate with this operation.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the {@link Response} on successful completion of {@link Mono}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoRequest Body Schema + * + *
{@code
+ * {
+ * name: String
+ * userData: String
+ * }
+ * }
+ *
+ * @param faceListId Id referencing a particular face list.
+ * @param body Request body for updating a face list.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return the {@link Response}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseQuery Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| returnRecognitionModel | String | No | A value indicating whether the operation should return 'recognitionModel' in response. |
Response Body Schema + * + *
{@code
+ * [
+ * {
+ * faceListId: String
+ * name: String
+ * userData: String
+ * recognitionModel: String(recognition_01/recognition_02/recognition_03/recognition_04)
+ * persistedFaces: [
+ * {
+ * persistedFaceId: String
+ * userData: String
+ * }
+ * ]
+ * }
+ * ]
+ * }
+ *
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return an array of face list results, with fields of faceListId, name and userData along with {@link Response}
+ * on successful completion of {@link Mono}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoQuery Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| returnRecognitionModel | String | No | A value indicating whether the operation should return 'recognitionModel' in response. |
Response Body Schema + * + *
{@code
+ * [
+ * {
+ * faceListId: String
+ * name: String
+ * userData: String
+ * recognitionModel: String(recognition_01/recognition_02/recognition_03/recognition_04)
+ * persistedFaces: [
+ * {
+ * persistedFaceId: String
+ * userData: String
+ * }
+ * ]
+ * }
+ * ]
+ * }
+ *
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @param context The context to associate with this operation.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return an array of face list results, with fields of faceListId, name and userData along with {@link Response}
+ * on successful completion of {@link Mono}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoQuery Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| returnRecognitionModel | String | No | A value indicating whether the operation should return 'recognitionModel' in response. |
Response Body Schema + * + *
{@code
+ * [
+ * {
+ * faceListId: String
+ * name: String
+ * userData: String
+ * recognitionModel: String(recognition_01/recognition_02/recognition_03/recognition_04)
+ * persistedFaces: [
+ * {
+ * persistedFaceId: String
+ * userData: String
+ * }
+ * ]
+ * }
+ * ]
+ * }
+ *
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return an array of face list results, with fields of faceListId, name and userData along with {@link Response}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseQuery Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| userData | String | No | User-specified data about the face for any purpose. The maximum length is 1KB. |
| targetFace | String | No | A face rectangle to specify the target face to be added to a person in the format of "targetFace=left,top,width,height". E.g. "targetFace=10,10,100,100". If there is more than one face in the image, targetFace is required to specify which face to add. No targetFace means there is only one face detected in the entire image. In the form of "," separated string. |
| detectionModel | String | No | Name of detection model. Detection model is used to detect faces in the submitted image. A detection model name can be provided when performing Face - Detect or (Large)FaceList - Add Face or (Large)PersonGroup - Add Face. The default value is 'detection_01', if another model is needed, please explicitly specify it. |
Request Body Schema + * + *
{@code
+ * {
+ * url: String
+ * }
+ * }
+ *
+ * Response Body Schema + * + *
{@code
+ * {
+ * persistedFaceId: String
+ * userData: String
+ * }
+ * }
+ *
+ * @param faceListId Id referencing a particular face list.
+ * @param imageUrl A JSON document with a URL pointing to the image that is to be analyzed.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return personFace object along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoQuery Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| userData | String | No | User-specified data about the face for any purpose. The maximum length is 1KB. |
| targetFace | String | No | A face rectangle to specify the target face to be added to a person in the format of "targetFace=left,top,width,height". E.g. "targetFace=10,10,100,100". If there is more than one face in the image, targetFace is required to specify which face to add. No targetFace means there is only one face detected in the entire image. In the form of "," separated string. |
| detectionModel | String | No | Name of detection model. Detection model is used to detect faces in the submitted image. A detection model name can be provided when performing Face - Detect or (Large)FaceList - Add Face or (Large)PersonGroup - Add Face. The default value is 'detection_01', if another model is needed, please explicitly specify it. |
Request Body Schema + * + *
{@code
+ * {
+ * url: String
+ * }
+ * }
+ *
+ * Response Body Schema + * + *
{@code
+ * {
+ * persistedFaceId: String
+ * userData: String
+ * }
+ * }
+ *
+ * @param faceListId Id referencing a particular face list.
+ * @param imageUrl A JSON document with a URL pointing to the image that is to be analyzed.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @param context The context to associate with this operation.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return personFace object along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoQuery Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| userData | String | No | User-specified data about the face for any purpose. The maximum length is 1KB. |
| targetFace | String | No | A face rectangle to specify the target face to be added to a person in the format of "targetFace=left,top,width,height". E.g. "targetFace=10,10,100,100". If there is more than one face in the image, targetFace is required to specify which face to add. No targetFace means there is only one face detected in the entire image. In the form of "," separated string. |
| detectionModel | String | No | Name of detection model. Detection model is used to detect faces in the submitted image. A detection model name can be provided when performing Face - Detect or (Large)FaceList - Add Face or (Large)PersonGroup - Add Face. The default value is 'detection_01', if another model is needed, please explicitly specify it. |
Request Body Schema + * + *
{@code
+ * {
+ * url: String
+ * }
+ * }
+ *
+ * Response Body Schema + * + *
{@code
+ * {
+ * persistedFaceId: String
+ * userData: String
+ * }
+ * }
+ *
+ * @param faceListId Id referencing a particular face list.
+ * @param imageUrl A JSON document with a URL pointing to the image that is to be analyzed.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return personFace object along with {@link Response}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseQuery Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| userData | String | No | User-specified data about the face for any purpose. The maximum length is 1KB. |
| targetFace | String | No | A face rectangle to specify the target face to be added to a person in the format of "targetFace=left,top,width,height". E.g. "targetFace=10,10,100,100". If there is more than one face in the image, targetFace is required to specify which face to add. No targetFace means there is only one face detected in the entire image. In the form of "," separated string. |
| detectionModel | String | No | Name of detection model. Detection model is used to detect faces in the submitted image. A detection model name can be provided when performing Face - Detect or (Large)FaceList - Add Face or (Large)PersonGroup - Add Face. The default value is 'detection_01', if another model is needed, please explicitly specify it. |
Header Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| Content-Length | long | Yes | The contentLength parameter |
Request Body Schema + * + *
{@code
+ * Flux
+ * }
+ *
+ * Response Body Schema + * + *
{@code
+ * {
+ * persistedFaceId: String
+ * userData: String
+ * }
+ * }
+ *
+ * @param faceListId Id referencing a particular face list.
+ * @param image An image stream.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return personFace object along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoQuery Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| userData | String | No | User-specified data about the face for any purpose. The maximum length is 1KB. |
| targetFace | String | No | A face rectangle to specify the target face to be added to a person in the format of "targetFace=left,top,width,height". E.g. "targetFace=10,10,100,100". If there is more than one face in the image, targetFace is required to specify which face to add. No targetFace means there is only one face detected in the entire image. In the form of "," separated string. |
| detectionModel | String | No | Name of detection model. Detection model is used to detect faces in the submitted image. A detection model name can be provided when performing Face - Detect or (Large)FaceList - Add Face or (Large)PersonGroup - Add Face. The default value is 'detection_01', if another model is needed, please explicitly specify it. |
Header Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| Content-Length | long | Yes | The contentLength parameter |
Request Body Schema + * + *
{@code
+ * Flux
+ * }
+ *
+ * Response Body Schema + * + *
{@code
+ * {
+ * persistedFaceId: String
+ * userData: String
+ * }
+ * }
+ *
+ * @param faceListId Id referencing a particular face list.
+ * @param image An image stream.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @param context The context to associate with this operation.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return personFace object along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoQuery Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| userData | String | No | User-specified data about the face for any purpose. The maximum length is 1KB. |
| targetFace | String | No | A face rectangle to specify the target face to be added to a person in the format of "targetFace=left,top,width,height". E.g. "targetFace=10,10,100,100". If there is more than one face in the image, targetFace is required to specify which face to add. No targetFace means there is only one face detected in the entire image. In the form of "," separated string. |
| detectionModel | String | No | Name of detection model. Detection model is used to detect faces in the submitted image. A detection model name can be provided when performing Face - Detect or (Large)FaceList - Add Face or (Large)PersonGroup - Add Face. The default value is 'detection_01', if another model is needed, please explicitly specify it. |
Header Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| Content-Length | long | Yes | The contentLength parameter |
Request Body Schema + * + *
{@code
+ * Flux
+ * }
+ *
+ * Response Body Schema + * + *
{@code
+ * {
+ * persistedFaceId: String
+ * userData: String
+ * }
+ * }
+ *
+ * @param faceListId Id referencing a particular face list.
+ * @param image An image stream.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return personFace object along with {@link Response}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseRequest Body Schema + * + *
{@code
+ * {
+ * faceId: String
+ * faceListId: String
+ * largeFaceListId: String
+ * faceIds: [
+ * String
+ * ]
+ * maxNumOfCandidatesReturned: Integer
+ * mode: String(matchPerson/matchFace)
+ * }
+ * }
+ *
+ * Response Body Schema + * + *
{@code
+ * [
+ * {
+ * faceId: String
+ * persistedFaceId: String
+ * confidence: float
+ * }
+ * ]
+ * }
+ *
+ * @param body Request body for Find Similar.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return array of SimilarFace along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoRequest Body Schema + * + *
{@code
+ * {
+ * faceId: String
+ * faceListId: String
+ * largeFaceListId: String
+ * faceIds: [
+ * String
+ * ]
+ * maxNumOfCandidatesReturned: Integer
+ * mode: String(matchPerson/matchFace)
+ * }
+ * }
+ *
+ * Response Body Schema + * + *
{@code
+ * [
+ * {
+ * faceId: String
+ * persistedFaceId: String
+ * confidence: float
+ * }
+ * ]
+ * }
+ *
+ * @param body Request body for Find Similar.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @param context The context to associate with this operation.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return array of SimilarFace along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoRequest Body Schema + * + *
{@code
+ * {
+ * faceId: String
+ * faceListId: String
+ * largeFaceListId: String
+ * faceIds: [
+ * String
+ * ]
+ * maxNumOfCandidatesReturned: Integer
+ * mode: String(matchPerson/matchFace)
+ * }
+ * }
+ *
+ * Response Body Schema + * + *
{@code
+ * [
+ * {
+ * faceId: String
+ * persistedFaceId: String
+ * confidence: float
+ * }
+ * ]
+ * }
+ *
+ * @param body Request body for Find Similar.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return array of SimilarFace along with {@link Response}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseRequest Body Schema + * + *
{@code
+ * {
+ * faceIds: [
+ * String
+ * ]
+ * }
+ * }
+ *
+ * Response Body Schema + * + *
{@code
+ * {
+ * groups: [
+ * [
+ * String
+ * ]
+ * ]
+ * messyGroup: [
+ * String
+ * ]
+ * }
+ * }
+ *
+ * @param body Request body for grouping.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return an array of face groups based on face similarity along with {@link Response} on successful completion of
+ * {@link Mono}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoRequest Body Schema + * + *
{@code
+ * {
+ * faceIds: [
+ * String
+ * ]
+ * }
+ * }
+ *
+ * Response Body Schema + * + *
{@code
+ * {
+ * groups: [
+ * [
+ * String
+ * ]
+ * ]
+ * messyGroup: [
+ * String
+ * ]
+ * }
+ * }
+ *
+ * @param body Request body for grouping.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @param context The context to associate with this operation.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return an array of face groups based on face similarity along with {@link Response} on successful completion of
+ * {@link Mono}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoRequest Body Schema + * + *
{@code
+ * {
+ * faceIds: [
+ * String
+ * ]
+ * }
+ * }
+ *
+ * Response Body Schema + * + *
{@code
+ * {
+ * groups: [
+ * [
+ * String
+ * ]
+ * ]
+ * messyGroup: [
+ * String
+ * ]
+ * }
+ * }
+ *
+ * @param body Request body for grouping.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return an array of face groups based on face similarity along with {@link Response}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseRemarks:<br /> * The algorithm allows more than one face to be identified independently at the same + * request, but no more than 10 faces. * Each person in the person group/large person group could have more than one + * face, but no more than 248 faces. * Higher face image quality means better identification precision. Please + * consider high-quality faces: frontal, clear, and face size is 200x200 pixels (100 pixels between eyes) or bigger. + * * Number of candidates returned is restricted by maxNumOfCandidatesReturned and confidenceThreshold. If no person + * is identified, the returned candidates will be an empty array. * Try [Face - Find + * Similar](https://docs.microsoft.com/rest/api/faceapi/face/findsimilar) when you need to find similar faces from a + * face list/large face list instead of a person group/large person group. * The 'recognitionModel' associated with + * the query faces' faceIds should be the same as the 'recognitionModel' used by the target person group or large + * person group. + * + *
Request Body Schema + * + *
{@code
+ * {
+ * faceIds: [
+ * String
+ * ]
+ * personGroupId: String
+ * largePersonGroupId: String
+ * dynamicPersonGroupId: String
+ * personIds: [
+ * String
+ * ]
+ * maxNumOfCandidatesReturned: Integer
+ * confidenceThreshold: Float
+ * }
+ * }
+ *
+ * Response Body Schema + * + *
{@code
+ * [
+ * {
+ * faceId: String
+ * candidates: [
+ * {
+ * personId: String
+ * confidence: float
+ * }
+ * ]
+ * }
+ * ]
+ * }
+ *
+ * @param body Request body for identify operation.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return array of IdentifyResult along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoRemarks:<br /> * The algorithm allows more than one face to be identified independently at the same + * request, but no more than 10 faces. * Each person in the person group/large person group could have more than one + * face, but no more than 248 faces. * Higher face image quality means better identification precision. Please + * consider high-quality faces: frontal, clear, and face size is 200x200 pixels (100 pixels between eyes) or bigger. + * * Number of candidates returned is restricted by maxNumOfCandidatesReturned and confidenceThreshold. If no person + * is identified, the returned candidates will be an empty array. * Try [Face - Find + * Similar](https://docs.microsoft.com/rest/api/faceapi/face/findsimilar) when you need to find similar faces from a + * face list/large face list instead of a person group/large person group. * The 'recognitionModel' associated with + * the query faces' faceIds should be the same as the 'recognitionModel' used by the target person group or large + * person group. + * + *
Request Body Schema + * + *
{@code
+ * {
+ * faceIds: [
+ * String
+ * ]
+ * personGroupId: String
+ * largePersonGroupId: String
+ * dynamicPersonGroupId: String
+ * personIds: [
+ * String
+ * ]
+ * maxNumOfCandidatesReturned: Integer
+ * confidenceThreshold: Float
+ * }
+ * }
+ *
+ * Response Body Schema + * + *
{@code
+ * [
+ * {
+ * faceId: String
+ * candidates: [
+ * {
+ * personId: String
+ * confidence: float
+ * }
+ * ]
+ * }
+ * ]
+ * }
+ *
+ * @param body Request body for identify operation.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @param context The context to associate with this operation.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return array of IdentifyResult along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoRemarks:<br /> * The algorithm allows more than one face to be identified independently at the same + * request, but no more than 10 faces. * Each person in the person group/large person group could have more than one + * face, but no more than 248 faces. * Higher face image quality means better identification precision. Please + * consider high-quality faces: frontal, clear, and face size is 200x200 pixels (100 pixels between eyes) or bigger. + * * Number of candidates returned is restricted by maxNumOfCandidatesReturned and confidenceThreshold. If no person + * is identified, the returned candidates will be an empty array. * Try [Face - Find + * Similar](https://docs.microsoft.com/rest/api/faceapi/face/findsimilar) when you need to find similar faces from a + * face list/large face list instead of a person group/large person group. * The 'recognitionModel' associated with + * the query faces' faceIds should be the same as the 'recognitionModel' used by the target person group or large + * person group. + * + *
Request Body Schema + * + *
{@code
+ * {
+ * faceIds: [
+ * String
+ * ]
+ * personGroupId: String
+ * largePersonGroupId: String
+ * dynamicPersonGroupId: String
+ * personIds: [
+ * String
+ * ]
+ * maxNumOfCandidatesReturned: Integer
+ * confidenceThreshold: Float
+ * }
+ * }
+ *
+ * Response Body Schema + * + *
{@code
+ * [
+ * {
+ * faceId: String
+ * candidates: [
+ * {
+ * personId: String
+ * confidence: float
+ * }
+ * ]
+ * }
+ * ]
+ * }
+ *
+ * @param body Request body for identify operation.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return array of IdentifyResult along with {@link Response}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public ResponseRequest Body Schema + * + *
{@code
+ * {
+ * faceId1: String
+ * faceId2: String
+ * }
+ * }
+ *
+ * Response Body Schema + * + *
{@code
+ * {
+ * isIdentical: boolean
+ * confidence: float
+ * }
+ * }
+ *
+ * @param body Request body for face to face verification.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return result of the verify operation along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoRequest Body Schema + * + *
{@code
+ * {
+ * faceId1: String
+ * faceId2: String
+ * }
+ * }
+ *
+ * Response Body Schema + * + *
{@code
+ * {
+ * isIdentical: boolean
+ * confidence: float
+ * }
+ * }
+ *
+ * @param body Request body for face to face verification.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @param context The context to associate with this operation.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return result of the verify operation along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public MonoRequest Body Schema + * + *
{@code
+ * {
+ * faceId1: String
+ * faceId2: String
+ * }
+ * }
+ *
+ * Response Body Schema + * + *
{@code
+ * {
+ * isIdentical: boolean
+ * confidence: float
+ * }
+ * }
+ *
+ * @param body Request body for face to face verification.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return result of the verify operation along with {@link Response}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public Response* 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 [Specify a recognition + * model](https://docs.microsoft.com/azure/cognitive-services/face/face-api-how-to-topics/specify-recognition-model). + * + *
Query Parameters + * + *
| Name | Type | Required | Description |
|---|---|---|---|
| returnFaceId | String | No | A value indicating whether the operation should return faceIds of detected faces. |
| returnFaceLandmarks | String | No | A value indicating whether the operation should return landmarks of the detected faces. |
| returnFaceAttributes | String | No | Analyze and return the one or more specified face attributes in the comma-separated string like "returnFaceAttributes=age,gender". The available attributes depends on the 'detectionModel' specified. 'detection_01' supports age, gender, headPose, smile, facialHair, glasses, emotion, hair, makeup, occlusion, accessories, blur, exposure, noise, and qualityForRecognition. While 'detection_02' does not support any attributes and 'detection_03' only supports mask and qualityForRecognition. Additionally, qualityForRecognition is only supported when the 'recognitionModel' is specified as 'recognition_03' or 'recognition_04'. Note that each face attribute analysis has additional computational and time cost. In the form of "," separated string. |
| recognitionModel | String | No | Name of recognition model. Recognition model is used when the face features are extracted and associated with detected faceIds, (Large)FaceList or (Large)PersonGroup. A recognition model name can be provided when performing Face - Detect or (Large)FaceList - Create or (Large)PersonGroup - Create. The default value is 'recognition_01', if latest model needed, please explicitly specify the model you need. |
| returnRecognitionModel | String | No | A value indicating whether the operation should return 'recognitionModel' in response. |
| detectionModel | String | No | Name of detection model. Detection model is used to detect faces in the submitted image. A detection model name can be provided when performing Face - Detect or (Large)FaceList - Add Face or (Large)PersonGroup - Add Face. The default value is 'detection_01', if another model is needed, please explicitly specify it. |
| faceIdTimeToLive | String | No | The number of seconds for the faceId being cached. Supported range from 60 seconds up to 86400 seconds. The default value is 86400 (24 hours). |
Request Body Schema + * + *
{@code
+ * {
+ * url: String
+ * }
+ * }
+ *
+ * Response Body Schema + * + *
{@code
+ * [
+ * {
+ * faceId: String
+ * recognitionModel: String(recognition_01/recognition_02/recognition_03/recognition_04)
+ * faceRectangle: {
+ * width: int
+ * height: int
+ * left: int
+ * top: int
+ * }
+ * faceLandmarks: {
+ * pupilLeft: {
+ * x: float
+ * y: float
+ * }
+ * pupilRight: (recursive schema, see pupilRight above)
+ * noseTip: (recursive schema, see noseTip above)
+ * mouthLeft: (recursive schema, see mouthLeft above)
+ * mouthRight: (recursive schema, see mouthRight above)
+ * eyebrowLeftOuter: (recursive schema, see eyebrowLeftOuter above)
+ * eyebrowLeftInner: (recursive schema, see eyebrowLeftInner above)
+ * eyeLeftOuter: (recursive schema, see eyeLeftOuter above)
+ * eyeLeftTop: (recursive schema, see eyeLeftTop above)
+ * eyeLeftBottom: (recursive schema, see eyeLeftBottom above)
+ * eyeLeftInner: (recursive schema, see eyeLeftInner above)
+ * eyebrowRightInner: (recursive schema, see eyebrowRightInner above)
+ * eyebrowRightOuter: (recursive schema, see eyebrowRightOuter above)
+ * eyeRightInner: (recursive schema, see eyeRightInner above)
+ * eyeRightTop: (recursive schema, see eyeRightTop above)
+ * eyeRightBottom: (recursive schema, see eyeRightBottom above)
+ * eyeRightOuter: (recursive schema, see eyeRightOuter above)
+ * noseRootLeft: (recursive schema, see noseRootLeft above)
+ * noseRootRight: (recursive schema, see noseRootRight above)
+ * noseLeftAlarTop: (recursive schema, see noseLeftAlarTop above)
+ * noseRightAlarTop: (recursive schema, see noseRightAlarTop above)
+ * noseLeftAlarOutTip: (recursive schema, see noseLeftAlarOutTip above)
+ * noseRightAlarOutTip: (recursive schema, see noseRightAlarOutTip above)
+ * upperLipTop: (recursive schema, see upperLipTop above)
+ * upperLipBottom: (recursive schema, see upperLipBottom above)
+ * underLipTop: (recursive schema, see underLipTop above)
+ * underLipBottom: (recursive schema, see underLipBottom above)
+ * }
+ * faceAttributes: {
+ * age: Float
+ * gender: String(male/female)
+ * smile: Float
+ * facialHair: {
+ * moustache: Float
+ * beard: Float
+ * sideburns: Float
+ * }
+ * glasses: String(noGlasses/readingGlasses/sunglasses/swimmingGoggles)
+ * headPose: {
+ * roll: Float
+ * yaw: Float
+ * pitch: Float
+ * }
+ * emotion: {
+ * anger: Float
+ * contempt: Float
+ * disgust: Float
+ * fear: Float
+ * happiness: Float
+ * neutral: Float
+ * sadness: Float
+ * surprise: Float
+ * }
+ * hair: {
+ * bald: Float
+ * invisible: Boolean
+ * hairColor: [
+ * {
+ * color: String(unknown/white/gray/blond/brown/red/black/other)
+ * confidence: Float
+ * }
+ * ]
+ * }
+ * makeup: {
+ * eyeMakeup: Boolean
+ * lipMakeup: Boolean
+ * }
+ * occlusion: {
+ * foreheadOccluded: Boolean
+ * eyeOccluded: Boolean
+ * mouthOccluded: Boolean
+ * }
+ * accessories: [
+ * {
+ * type: String(headWear/glasses/mask)
+ * confidence: Float
+ * }
+ * ]
+ * blur: {
+ * blurLevel: String(Low/Medium/High)
+ * value: Float
+ * }
+ * exposure: {
+ * exposureLevel: String(UnderExposure/GoodExposure/OverExposure)
+ * value: Float
+ * }
+ * noise: {
+ * noiseLevel: String(Low/Medium/High)
+ * value: Float
+ * }
+ * mask: {
+ * type: String(noMask/faceMask/otherMaskOrOcclusion/uncertain)
+ * noseAndMouthCovered: Boolean
+ * }
+ * qualityForRecognition: String(Low/Medium/High)
+ * }
+ * }
+ * ]
+ * }
+ *
+ * @param imageUrl A JSON document with a URL pointing to the image that is to be analyzed.
+ * @param requestOptions The options to configure the HTTP request before HTTP client sends it.
+ * @throws HttpResponseException thrown if the request is rejected by server.
+ * @throws ClientAuthenticationException thrown if the request is rejected by server on status code 401.
+ * @throws ResourceNotFoundException thrown if the request is rejected by server on status code 404.
+ * @throws ResourceModifiedException thrown if the request is rejected by server on status code 409.
+ * @return array of DetectedFace along with {@link Response} on successful completion of {@link Mono}.
+ */
+ @ServiceMethod(returns = ReturnType.SINGLE)
+ public Mono* 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 [Specify a recognition + * model](https://docs.microsoft.com/azure/cognitive-services/face/face-api-how-to-topics/specify-recognition-model). + * + *
Query Parameters + * + *