| Метод | Описание | |
|---|---|---|
| FaceDetect ( this operations, bool returnFaceId = true, bool returnFaceLandmarks = false, string returnFaceAttributes = default(string), string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string) ) : void |
Detect human faces in an image and returns face locations, and optionally with faceIds, landmarks, and attributes. <ul> <li>Optional parameters for returning faceId, landmarks, and attributes. Attributes include age, gender, smile intensity, facial hair, head pose and glasses. faceId is for other APIs use including <a href="/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395239">Face - Identify</a>, <a href="/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f3039523a">Face - Verify</a>, and <a href="/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395237">Face - Find Similar</a>. The faceId will expire in 24 hours after detection call.</li> <ul> <li>JPEG, PNG, GIF(the first frame), and BMP are supported. The image file size should be larger than or equal to 1KB but no larger than 4MB.</li> <li>The detectable face size is between 36x36 to 4096x4096 pixels. The faces out of this range will not be detected.</li> <li>A maximum of 64 faces could be returned for an image. The returned faces are ranked by face rectangle size in descending order.</li> <li>Some faces may not be detected for technical challenges, e.g. very large face angles (head-pose) or large occlusion. Frontal and near-frontal faces have the best results.</li> <li>Attributes (age, gender, headPose, smile, facialHair, and glasses) are still experimental and may not be very accurate. HeadPose's pitch value is a reserved field and will always return 0.</li> </ul> </li> </ul> <h4>Http Method</h4> POST
|
|
| FaceDetectAsync ( this operations, bool returnFaceId = true, bool returnFaceLandmarks = false, string returnFaceAttributes = default(string), string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string), System cancellationToken = default(System.Threading.CancellationToken) ) : System.Threading.Tasks.Task |
Detect human faces in an image and returns face locations, and optionally with faceIds, landmarks, and attributes. <ul> <li>Optional parameters for returning faceId, landmarks, and attributes. Attributes include age, gender, smile intensity, facial hair, head pose and glasses. faceId is for other APIs use including <a href="/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395239">Face - Identify</a>, <a href="/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f3039523a">Face - Verify</a>, and <a href="/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395237">Face - Find Similar</a>. The faceId will expire in 24 hours after detection call.</li> <ul> <li>JPEG, PNG, GIF(the first frame), and BMP are supported. The image file size should be larger than or equal to 1KB but no larger than 4MB.</li> <li>The detectable face size is between 36x36 to 4096x4096 pixels. The faces out of this range will not be detected.</li> <li>A maximum of 64 faces could be returned for an image. The returned faces are ranked by face rectangle size in descending order.</li> <li>Some faces may not be detected for technical challenges, e.g. very large face angles (head-pose) or large occlusion. Frontal and near-frontal faces have the best results.</li> <li>Attributes (age, gender, headPose, smile, facialHair, and glasses) are still experimental and may not be very accurate. HeadPose's pitch value is a reserved field and will always return 0.</li> </ul> </li> </ul> <h4>Http Method</h4> POST
|
|
| FaceFindSimilar ( this operations, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string) ) : void |
Given query face's faceId, to search the similar-looking faces from a faceId array or a faceListId. faceId array contains the faces created by <a href="/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395236">Face - Detect</a>, which will expire in 24 hours after creation. While "faceListId" is created by <a href="/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f3039524b">Face List - Create a Face List</a> containing persistedFaceIds that will not expire. Depending on the input the returned similar faces list contains faceIds or persistedFaceIds ranked by similarity. <br/><br/> Find similar has two working modes, "matchPerson" and "matchFace". "matchPerson" is the default mode that it tries to find faces of the same person as possible by using internal same-person thresholds. It is useful to find a known person's other photos. Note that an empty list will be returned if no faces pass the internal thresholds. "matchFace" mode ignores same-person thresholds and returns ranked similar faces anyway, even the similarity is low. It can be used in the cases like searching celebrity-looking faces. <h4>Http Method</h4> POST
|
|
| FaceFindSimilarAsync ( this operations, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string), System cancellationToken = default(System.Threading.CancellationToken) ) : System.Threading.Tasks.Task |
Given query face's faceId, to search the similar-looking faces from a faceId array or a faceListId. faceId array contains the faces created by <a href="/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395236">Face - Detect</a>, which will expire in 24 hours after creation. While "faceListId" is created by <a href="/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f3039524b">Face List - Create a Face List</a> containing persistedFaceIds that will not expire. Depending on the input the returned similar faces list contains faceIds or persistedFaceIds ranked by similarity. <br/><br/> Find similar has two working modes, "matchPerson" and "matchFace". "matchPerson" is the default mode that it tries to find faces of the same person as possible by using internal same-person thresholds. It is useful to find a known person's other photos. Note that an empty list will be returned if no faces pass the internal thresholds. "matchFace" mode ignores same-person thresholds and returns ranked similar faces anyway, even the similarity is low. It can be used in the cases like searching celebrity-looking faces. <h4>Http Method</h4> POST
|
|
| FaceGroup ( this operations, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string) ) : void |
Divide candidate faces into groups based on face similarity. <br/> <ul> <li>The output is one or more disjointed face groups and a messyGroup. A face group contains faces that have similar looking, often of the same person. Face groups are ranked by group size, i.e. number of faces. Notice that faces belonging to a same person might be split into several groups in the result. </li> <li>MessyGroup is a special face group containing faces that cannot find any similar counterpart face from original faces. The messyGroup will not appear in the result if all faces found their counterparts.</li> <li>Group API needs at least 2 candidate faces and 1000 at most. We suggest to try <a href="/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f3039523a">Face - Verify</a> when you only have 2 candidate faces.</li> </ul> <h4>Http Method</h4> POST
|
|
| FaceGroupAsync ( this operations, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string), System cancellationToken = default(System.Threading.CancellationToken) ) : System.Threading.Tasks.Task |
Divide candidate faces into groups based on face similarity. <br/> <ul> <li>The output is one or more disjointed face groups and a messyGroup. A face group contains faces that have similar looking, often of the same person. Face groups are ranked by group size, i.e. number of faces. Notice that faces belonging to a same person might be split into several groups in the result. </li> <li>MessyGroup is a special face group containing faces that cannot find any similar counterpart face from original faces. The messyGroup will not appear in the result if all faces found their counterparts.</li> <li>Group API needs at least 2 candidate faces and 1000 at most. We suggest to try <a href="/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f3039523a">Face - Verify</a> when you only have 2 candidate faces.</li> </ul> <h4>Http Method</h4> POST
|
|
| FaceIdentify ( this operations, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string) ) : void |
Identify unknown faces from a person group. <br/><br/> For each face in the faceIds array, Face Identify will compute similarities between the query face and all the faces in the person group (given by personGroupId), and returns candidate person(s) for that face ranked by similarity confidence. The person group should be trained to make it ready for identification. See more in <a href="/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395249">Person Group - Train Person Group</a>. <br/><br/> Remarks: <ul> <li>The algorithm allows more than one face to be identified independently at the same request, but the no more than 10 faces.</li> <li>Each person in the person group could have more than one face, but no more than 248 faces.</li> <li>Identification works well for frontal faces and near-frontal faces.</li> <li>Number of candidates returned is restricted by maxNumOfCandidatesReturned and confidenceThreshold. If no person is identified, the candidate returned will be an empty array.</li> <li>Try <a href="/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395237">Face - Find Similar</a> when you need to identify similar faces from a face list instead of a person group.</li> </ul> <h4>Http Method</h4> POST
|
|
| FaceIdentifyAsync ( this operations, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string), System cancellationToken = default(System.Threading.CancellationToken) ) : System.Threading.Tasks.Task |
Identify unknown faces from a person group. <br/><br/> For each face in the faceIds array, Face Identify will compute similarities between the query face and all the faces in the person group (given by personGroupId), and returns candidate person(s) for that face ranked by similarity confidence. The person group should be trained to make it ready for identification. See more in <a href="/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395249">Person Group - Train Person Group</a>. <br/><br/> Remarks: <ul> <li>The algorithm allows more than one face to be identified independently at the same request, but the no more than 10 faces.</li> <li>Each person in the person group could have more than one face, but no more than 248 faces.</li> <li>Identification works well for frontal faces and near-frontal faces.</li> <li>Number of candidates returned is restricted by maxNumOfCandidatesReturned and confidenceThreshold. If no person is identified, the candidate returned will be an empty array.</li> <li>Try <a href="/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395237">Face - Find Similar</a> when you need to identify similar faces from a face list instead of a person group.</li> </ul> <h4>Http Method</h4> POST
|
|
| FaceListAddaFacetoaFaceList ( this operations, string faceListId, string userData = default(string), string targetFace = default(string), string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string) ) : void |
<p>Add a face to a face list. The input face is specified as an image with a targetFace rectangle. It returns a persistedFaceId representing the added face, and persistedFaceId will not expire. Note persistedFaceId is different from faceId which represents the detected face by <a href="/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395236">Face - Detect</a>. <ul> <li>The persistedFaceId of face list is used in <a href="/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395251">Face List - Delete a Face from a Face List</a> to remove face from a face list, or the output JSON of <a href="/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395237">Face - Find Similar</a> </li> <li>JPEG, PNG, GIF(the first frame), and BMP are supported. The image file size should be larger than or equal to 1KB but no larger than 4MB.</li> <li>The detectable face size is between 36x36 to 4096x4096 pixels. The faces out of this range will not be detected.</li> <li>Rectangle specified by targetFace should contain exactly one face. Zero or multiple faces will be regarded as an error. Out of detectable face size, large head-pose, or very large occlusions will also result in fail to add a person face.</li> <li>The given rectangle specifies both face location and face size at the same time. There is no guarantee of correct result if you are using rectangle which are not returned from <a href="/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395236">Face - Detect</a>. </li> </ul> <p> Face list is a group of faces, and these faces will not expire. Face list is used as a parameter of source faces in <a href="/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395237">Face - Find Similar</a>. Face List is useful when to find similar faces in a fixed face set very often, e.g. to find a similar face in a face list of celebrities, friends, or family members.</p> <p> A face list can have a maximum of 1000 faces. </p> <h4>Http Method</h4> POST
|
|
| FaceListAddaFacetoaFaceListAsync ( this operations, string faceListId, string userData = default(string), string targetFace = default(string), string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string), System cancellationToken = default(System.Threading.CancellationToken) ) : System.Threading.Tasks.Task |
<p>Add a face to a face list. The input face is specified as an image with a targetFace rectangle. It returns a persistedFaceId representing the added face, and persistedFaceId will not expire. Note persistedFaceId is different from faceId which represents the detected face by <a href="/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395236">Face - Detect</a>. <ul> <li>The persistedFaceId of face list is used in <a href="/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395251">Face List - Delete a Face from a Face List</a> to remove face from a face list, or the output JSON of <a href="/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395237">Face - Find Similar</a> </li> <li>JPEG, PNG, GIF(the first frame), and BMP are supported. The image file size should be larger than or equal to 1KB but no larger than 4MB.</li> <li>The detectable face size is between 36x36 to 4096x4096 pixels. The faces out of this range will not be detected.</li> <li>Rectangle specified by targetFace should contain exactly one face. Zero or multiple faces will be regarded as an error. Out of detectable face size, large head-pose, or very large occlusions will also result in fail to add a person face.</li> <li>The given rectangle specifies both face location and face size at the same time. There is no guarantee of correct result if you are using rectangle which are not returned from <a href="/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395236">Face - Detect</a>. </li> </ul> <p> Face list is a group of faces, and these faces will not expire. Face list is used as a parameter of source faces in <a href="/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395237">Face - Find Similar</a>. Face List is useful when to find similar faces in a fixed face set very often, e.g. to find a similar face in a face list of celebrities, friends, or family members.</p> <p> A face list can have a maximum of 1000 faces. </p> <h4>Http Method</h4> POST
|
|
| FaceListCreateaFaceList ( this operations, string faceListId, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string) ) : void |
<p>Create an empty face list with user-specified faceListId, name and an optional userData. Up to 64 face lists are allowed to exist in one subscription.</p> <p> Face list is a group of faces, and these faces will not expire. Face list is used as a parameter of source faces in <a href="/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395237">Face - Find Similar</a>. Face List is useful when to find similar faces in a fixed face set very often, e.g. to find a similar face in a face list of celebrities, friends, or family members. </p> <p>A face list can have a maximum of 1000 faces.</p> <h4>Http Method</h4> PUT
|
|
| FaceListCreateaFaceListAsync ( this operations, string faceListId, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string), System cancellationToken = default(System.Threading.CancellationToken) ) : System.Threading.Tasks.Task |
<p>Create an empty face list with user-specified faceListId, name and an optional userData. Up to 64 face lists are allowed to exist in one subscription.</p> <p> Face list is a group of faces, and these faces will not expire. Face list is used as a parameter of source faces in <a href="/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395237">Face - Find Similar</a>. Face List is useful when to find similar faces in a fixed face set very often, e.g. to find a similar face in a face list of celebrities, friends, or family members. </p> <p>A face list can have a maximum of 1000 faces.</p> <h4>Http Method</h4> PUT
|
|
| FaceListDeleteaFaceList ( this operations, string faceListId, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string) ) : void |
Delete an existing face list according to faceListId. Persisted face images in the face list will also be deleted. <h4>Http Method</h4> DELETE
|
|
| FaceListDeleteaFaceListAsync ( this operations, string faceListId, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string), System cancellationToken = default(System.Threading.CancellationToken) ) : System.Threading.Tasks.Task |
Delete an existing face list according to faceListId. Persisted face images in the face list will also be deleted. <h4>Http Method</h4> DELETE
|
|
| FaceListDeleteaFacefromaFaceList ( this operations, string faceListId, string persistedFaceId, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string) ) : void |
Delete an existing face from a face list (given by a persisitedFaceId and a faceListId). Persisted image related to the face will also be deleted. <h4>Http Method</h4> DELETE
|
|
| FaceListDeleteaFacefromaFaceListAsync ( this operations, string faceListId, string persistedFaceId, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string), System cancellationToken = default(System.Threading.CancellationToken) ) : System.Threading.Tasks.Task |
Delete an existing face from a face list (given by a persisitedFaceId and a faceListId). Persisted image related to the face will also be deleted. <h4>Http Method</h4> DELETE
|
|
| FaceListGetaFaceList ( this operations, string faceListId, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string) ) : void |
Retrieve a face list's information, including faceListId, name, userData and faces in the face list. Face list simply represents a list of faces, and could be treated as a searchable data source in <a href="/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395237">Face - Find Similar</a>. <h4>Http Method</h4> GET
|
|
| FaceListGetaFaceListAsync ( this operations, string faceListId, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string), System cancellationToken = default(System.Threading.CancellationToken) ) : System.Threading.Tasks.Task |
Retrieve a face list's information, including faceListId, name, userData and faces in the face list. Face list simply represents a list of faces, and could be treated as a searchable data source in <a href="/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395237">Face - Find Similar</a>. <h4>Http Method</h4> GET
|
|
| FaceListListFaceLists ( this operations, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string) ) : void |
Retrieve information about all existing face lists. Only faceListId, name and userData will be returned. Try <a href="/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f3039524c">Face List - Get a Face List</a> to retrieve face information inside faceList. <h4>Http Method</h4> GET
|
|
| FaceListListFaceListsAsync ( this operations, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string), System cancellationToken = default(System.Threading.CancellationToken) ) : System.Threading.Tasks.Task |
Retrieve information about all existing face lists. Only faceListId, name and userData will be returned. Try <a href="/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f3039524c">Face List - Get a Face List</a> to retrieve face information inside faceList. <h4>Http Method</h4> GET
|
|
| FaceListUpdateaFaceList ( this operations, string faceListId, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string) ) : void |
Update information of a face list, including name and userData. Face List simply represents a list of persisted faces, and could be treated as a searchable data source in <a href="/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395237">Face - Find Similar</a>. <h4>Http Method</h4> PATCH
|
|
| FaceListUpdateaFaceListAsync ( this operations, string faceListId, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string), System cancellationToken = default(System.Threading.CancellationToken) ) : System.Threading.Tasks.Task |
Update information of a face list, including name and userData. Face List simply represents a list of persisted faces, and could be treated as a searchable data source in <a href="/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395237">Face - Find Similar</a>. <h4>Http Method</h4> PATCH
|
|
| FaceVerify ( this operations, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string) ) : void |
Verify whether two faces belong to a same person or whether one face belongs to a person. <br/><br/> Remarks: <ul> <li>This API works well for frontal and near-frontal faces. </li> <li>For the scenarios that are sensitive to accuracy please make your own judgment.</li> </ul> <h4>Http Method</h4> POST
|
|
| FaceVerifyAsync ( this operations, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string), System cancellationToken = default(System.Threading.CancellationToken) ) : System.Threading.Tasks.Task |
Verify whether two faces belong to a same person or whether one face belongs to a person. <br/><br/> Remarks: <ul> <li>This API works well for frontal and near-frontal faces. </li> <li>For the scenarios that are sensitive to accuracy please make your own judgment.</li> </ul> <h4>Http Method</h4> POST
|
|
| PersonAddaPersonFace ( this operations, string personGroupId, string personId, string userData = default(string), string targetFace = default(string), string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string) ) : void |
<p>Add a representative face to a person for identification. The input face is specified as an image with a targetFace rectangle. It returns a persistedFaceId representing the added face and this persistedFaceId will not expire. Note persistedFaceId is different from faceId which represents the detected face by <a href="/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395236">Face - Detect</a>.</p> <ul> <li>The persistedFaceId of person is used in <a href="/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f3039523e">Person - Delete a Person Face</a> to remove a face from a person. </li> <li>Each person has a maximum of 248 faces.</li> <li>JPEG, PNG, GIF(the first frame), and BMP are supported. The image file size should be larger than or equal to 1KB but no larger than 4MB.</li> <li>The detectable face size is between 36x36 to 4096x4096 pixels. The faces out of this range will not be detected.</li> <li>Rectangle specified by targetFace should contain exactly one face. Zero or multiple faces will be regarded as an error. Out of detectable face size, large head-pose, or very large occlusions will also result in fail to add a person face.</li> <li>The given rectangle specifies both face location and face size at the same time. There is no guarantee of correct result if you are using rectangle which is not returned from <a href="/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395236">Face - Detect</a>. </li> </ul> <h4>Http Method</h4> POST
|
|
| PersonAddaPersonFaceAsync ( this operations, string personGroupId, string personId, string userData = default(string), string targetFace = default(string), string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string), System cancellationToken = default(System.Threading.CancellationToken) ) : System.Threading.Tasks.Task |
<p>Add a representative face to a person for identification. The input face is specified as an image with a targetFace rectangle. It returns a persistedFaceId representing the added face and this persistedFaceId will not expire. Note persistedFaceId is different from faceId which represents the detected face by <a href="/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395236">Face - Detect</a>.</p> <ul> <li>The persistedFaceId of person is used in <a href="/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f3039523e">Person - Delete a Person Face</a> to remove a face from a person. </li> <li>Each person has a maximum of 248 faces.</li> <li>JPEG, PNG, GIF(the first frame), and BMP are supported. The image file size should be larger than or equal to 1KB but no larger than 4MB.</li> <li>The detectable face size is between 36x36 to 4096x4096 pixels. The faces out of this range will not be detected.</li> <li>Rectangle specified by targetFace should contain exactly one face. Zero or multiple faces will be regarded as an error. Out of detectable face size, large head-pose, or very large occlusions will also result in fail to add a person face.</li> <li>The given rectangle specifies both face location and face size at the same time. There is no guarantee of correct result if you are using rectangle which is not returned from <a href="/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395236">Face - Detect</a>. </li> </ul> <h4>Http Method</h4> POST
|
|
| PersonCreateaPerson ( this operations, string personGroupId, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string) ) : void |
Create a new person in a specified person group. A newly created person have no registered face, you can call <a href="/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f3039523b ">Person - Add a Person Face</a> API to add faces to the person. <br/><br/> The number of persons has a subscription level limit and person group level limit. Person group level limit is 1000 for both free and paid tier subscriptions. Subscription level limit is 1000 for free tier subscription and can be greater in paid tier subscriptions. <h4>Http Method</h4> POST
|
|
| PersonCreateaPersonAsync ( this operations, string personGroupId, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string), System cancellationToken = default(System.Threading.CancellationToken) ) : System.Threading.Tasks.Task |
Create a new person in a specified person group. A newly created person have no registered face, you can call <a href="/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f3039523b ">Person - Add a Person Face</a> API to add faces to the person. <br/><br/> The number of persons has a subscription level limit and person group level limit. Person group level limit is 1000 for both free and paid tier subscriptions. Subscription level limit is 1000 for free tier subscription and can be greater in paid tier subscriptions. <h4>Http Method</h4> POST
|
|
| PersonDeleteaPerson ( this operations, string personGroupId, string personId, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string) ) : void |
Delete an existing person from a person group. Persisted face images of the person will also be deleted. <h4>Http Method</h4> DELETE
|
|
| PersonDeleteaPersonAsync ( this operations, string personGroupId, string personId, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string), System cancellationToken = default(System.Threading.CancellationToken) ) : System.Threading.Tasks.Task |
Delete an existing person from a person group. Persisted face images of the person will also be deleted. <h4>Http Method</h4> DELETE
|
|
| PersonDeleteaPersonFace ( this operations, string personGroupId, string personId, string persistedFaceId, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string) ) : void |
Delete a face from a person. Relative image for the persisted face will also be deleted. <h4>Http Method</h4> DELETE
|
|
| PersonDeleteaPersonFaceAsync ( this operations, string personGroupId, string personId, string persistedFaceId, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string), System cancellationToken = default(System.Threading.CancellationToken) ) : System.Threading.Tasks.Task |
Delete a face from a person. Relative image for the persisted face will also be deleted. <h4>Http Method</h4> DELETE
|
|
| PersonGetaPerson ( this operations, string personGroupId, string personId, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string) ) : void |
Retrieve a person's information, including registered persisted faces, name and userData. <h4>Http Method</h4> GET
|
|
| PersonGetaPersonAsync ( this operations, string personGroupId, string personId, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string), System cancellationToken = default(System.Threading.CancellationToken) ) : System.Threading.Tasks.Task |
Retrieve a person's information, including registered persisted faces, name and userData. <h4>Http Method</h4> GET
|
|
| PersonGetaPersonFace ( this operations, string personGroupId, string personId, string persistedFaceId, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string) ) : void |
Retrieve information about a persisted face (specified by persistedFaceId, personId and its belonging personGroupId). <h4>Http Method</h4> GET
|
|
| PersonGetaPersonFaceAsync ( this operations, string personGroupId, string personId, string persistedFaceId, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string), System cancellationToken = default(System.Threading.CancellationToken) ) : System.Threading.Tasks.Task |
Retrieve information about a persisted face (specified by persistedFaceId, personId and its belonging personGroupId). <h4>Http Method</h4> GET
|
|
| PersonGroupCreateaPersonGroup ( this operations, string personGroupId, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string) ) : void |
Create a new person group with specified personGroupId, name and user-provided userData. <br/><br/> A person group is one of the most important parameters for the <a href="/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395239">Face - Identify</a> API. The Identify searches person faces in a specified person group. <h4>Http Method</h4> PUT
|
|
| PersonGroupCreateaPersonGroupAsync ( this operations, string personGroupId, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string), System cancellationToken = default(System.Threading.CancellationToken) ) : System.Threading.Tasks.Task |
Create a new person group with specified personGroupId, name and user-provided userData. <br/><br/> A person group is one of the most important parameters for the <a href="/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395239">Face - Identify</a> API. The Identify searches person faces in a specified person group. <h4>Http Method</h4> PUT
|
|
| PersonGroupDeleteaPersonGroup ( this operations, string personGroupId, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string) ) : void |
Delete an existing person group. Persisted face images of all people in the person group will also be deleted. <h4>Http Method</h4> DELETE
|
|
| PersonGroupDeleteaPersonGroupAsync ( this operations, string personGroupId, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string), System cancellationToken = default(System.Threading.CancellationToken) ) : System.Threading.Tasks.Task |
Delete an existing person group. Persisted face images of all people in the person group will also be deleted. <h4>Http Method</h4> DELETE
|
|
| PersonGroupGetPersonGroupTrainingStatus ( this operations, string personGroupId, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string) ) : void |
Retrieve the training status of a person group (completed or ongoing). Training can be triggered by the <a href="/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395249">Person Group - Train Person Group</a> API. The training will process for a while on the server side.. <h4>Http Method</h4> GET
|
|
| PersonGroupGetPersonGroupTrainingStatusAsync ( this operations, string personGroupId, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string), System cancellationToken = default(System.Threading.CancellationToken) ) : System.Threading.Tasks.Task |
Retrieve the training status of a person group (completed or ongoing). Training can be triggered by the <a href="/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395249">Person Group - Train Person Group</a> API. The training will process for a while on the server side.. <h4>Http Method</h4> GET
|
|
| PersonGroupGetaPersonGroup ( this operations, string personGroupId, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string) ) : void |
Retrieve the information of a person group, including its name and userData. This API returns person group information only, use <a href="/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395241">Person - List Persons in a Person Group</a> instead to retrieve person information under the person group. <h4>Http Method</h4> GET
|
|
| PersonGroupGetaPersonGroupAsync ( this operations, string personGroupId, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string), System cancellationToken = default(System.Threading.CancellationToken) ) : System.Threading.Tasks.Task |
Retrieve the information of a person group, including its name and userData. This API returns person group information only, use <a href="/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395241">Person - List Persons in a Person Group</a> instead to retrieve person information under the person group. <h4>Http Method</h4> GET
|
|
| PersonGroupListPersonGroups ( this operations, string start = default(string), int top = 1000, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string) ) : void |
List person groups and their information. <ul> <li> Optional string parameter "start" and int parameter "top" are adopted to specify the starting point and total number of person groups to return. All of the person groups are stored in alphabetical order of personGroupId. And the list starting point is defined as the first person group whose personGroupId is greater than the "start". Beginning from this starting point, this API returns the first "top" person groups. <ul> <li> Defaults to return the first 1000 person groups, where the value of "start" is empty and "top" is 1000. Empty array returned indicates that there is no person group whose personGroupId is lager than the "start". E.g., given two person groups: "first_group" and "second_group", these two groups are returned with default parameter, "second_group" is returned if specify "first_group" as "start", and if specify "second_group" as "start", empty array is returned. <ul> <li> The last personGroupId returned by current call can be used as the "start" of the next call to continuously list the person groups. </ul> </ul> </ul> <h4>Http Method</h4> GET
|
|
| PersonGroupListPersonGroupsAsync ( this operations, string start = default(string), int top = 1000, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string), System cancellationToken = default(System.Threading.CancellationToken) ) : System.Threading.Tasks.Task |
List person groups and their information. <ul> <li> Optional string parameter "start" and int parameter "top" are adopted to specify the starting point and total number of person groups to return. All of the person groups are stored in alphabetical order of personGroupId. And the list starting point is defined as the first person group whose personGroupId is greater than the "start". Beginning from this starting point, this API returns the first "top" person groups. <ul> <li> Defaults to return the first 1000 person groups, where the value of "start" is empty and "top" is 1000. Empty array returned indicates that there is no person group whose personGroupId is lager than the "start". E.g., given two person groups: "first_group" and "second_group", these two groups are returned with default parameter, "second_group" is returned if specify "first_group" as "start", and if specify "second_group" as "start", empty array is returned. <ul> <li> The last personGroupId returned by current call can be used as the "start" of the next call to continuously list the person groups. </ul> </ul> </ul> <h4>Http Method</h4> GET
|
|
| PersonGroupTrainPersonGroup ( this operations, string personGroupId, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string) ) : void |
Queue a person group training task, the training task may not be started immediately. <br/><br/> Any updates to person group will not take effect in <a href="/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395239">Face - Identify</a> until person group is successfully trained. You can query the training status by calling <a href="/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395247">Person Group - Get Person Group Training Status</a> API. <h4>Http Method</h4> POST
|
|
| PersonGroupTrainPersonGroupAsync ( this operations, string personGroupId, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string), System cancellationToken = default(System.Threading.CancellationToken) ) : System.Threading.Tasks.Task |
Queue a person group training task, the training task may not be started immediately. <br/><br/> Any updates to person group will not take effect in <a href="/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395239">Face - Identify</a> until person group is successfully trained. You can query the training status by calling <a href="/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f30395247">Person Group - Get Person Group Training Status</a> API. <h4>Http Method</h4> POST
|
|
| PersonGroupUpdateaPersonGroup ( this operations, string personGroupId, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string) ) : void |
Update an existing person group's display name and userData. The properties which does not appear in request body will not be updated. <h4>Http Method</h4> PATCH
|
|
| PersonGroupUpdateaPersonGroupAsync ( this operations, string personGroupId, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string), System cancellationToken = default(System.Threading.CancellationToken) ) : System.Threading.Tasks.Task |
Update an existing person group's display name and userData. The properties which does not appear in request body will not be updated. <h4>Http Method</h4> PATCH
|
|
| PersonListPersonsinaPersonGroup ( this operations, string personGroupId, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string) ) : void |
List all persons in a person group, and retrieve person information (including personId, name, userData and persistedFaceIds of registered faces of the person). <h4>Http Method</h4> GET
|
|
| PersonListPersonsinaPersonGroupAsync ( this operations, string personGroupId, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string), System cancellationToken = default(System.Threading.CancellationToken) ) : System.Threading.Tasks.Task |
List all persons in a person group, and retrieve person information (including personId, name, userData and persistedFaceIds of registered faces of the person). <h4>Http Method</h4> GET
|
|
| PersonUpdateaPerson ( this operations, string personGroupId, string personId, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string) ) : void |
Update name or userData of a person. <h4>Http Method</h4> PATCH
|
|
| PersonUpdateaPersonAsync ( this operations, string personGroupId, string personId, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string), System cancellationToken = default(System.Threading.CancellationToken) ) : System.Threading.Tasks.Task |
Update name or userData of a person. <h4>Http Method</h4> PATCH
|
|
| PersonUpdateaPersonFace ( this operations, string personGroupId, string personId, string persistedFaceId, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string) ) : void |
Update a person persisted face's userData field. <h4>Http Method</h4> PATCH
|
|
| PersonUpdateaPersonFaceAsync ( this operations, string personGroupId, string personId, string persistedFaceId, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string), System cancellationToken = default(System.Threading.CancellationToken) ) : System.Threading.Tasks.Task |
Update a person persisted face's userData field. <h4>Http Method</h4> PATCH
|
| public static FaceDetect ( this operations, bool returnFaceId = true, bool returnFaceLandmarks = false, string returnFaceAttributes = default(string), string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string) ) : void | ||
| operations | this | /// The operations group for this extension method. /// |
| returnFaceId | bool | /// Return faceIds of the detected faces or not. The default value is true. /// |
| returnFaceLandmarks | bool | /// Return face landmarks of the detected faces or not. The default value is /// false. /// |
| returnFaceAttributes | string | /// Analyze and return the one or more specified face attributes in the /// comma-separated string like "returnFaceAttributes=age,gender". Supported /// face attributes include age, gender, headPose, smile, facialHair, and /// glasses. Note that each face attribute analysis has additional /// computational and time cost. /// |
| subscriptionKey | string | /// subscription key in url /// |
| ocpApimSubscriptionKey | string | /// subscription key in header /// |
| Результат | void | |
| public static FaceDetectAsync ( this operations, bool returnFaceId = true, bool returnFaceLandmarks = false, string returnFaceAttributes = default(string), string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string), System cancellationToken = default(System.Threading.CancellationToken) ) : System.Threading.Tasks.Task | ||
| operations | this | /// The operations group for this extension method. /// |
| returnFaceId | bool | /// Return faceIds of the detected faces or not. The default value is true. /// |
| returnFaceLandmarks | bool | /// Return face landmarks of the detected faces or not. The default value is /// false. /// |
| returnFaceAttributes | string | /// Analyze and return the one or more specified face attributes in the /// comma-separated string like "returnFaceAttributes=age,gender". Supported /// face attributes include age, gender, headPose, smile, facialHair, and /// glasses. Note that each face attribute analysis has additional /// computational and time cost. /// |
| subscriptionKey | string | /// subscription key in url /// |
| ocpApimSubscriptionKey | string | /// subscription key in header /// |
| cancellationToken | System | /// The cancellation token. /// |
| Результат | System.Threading.Tasks.Task | |
| public static FaceFindSimilar ( this operations, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string) ) : void | ||
| operations | this | /// The operations group for this extension method. /// |
| subscriptionKey | string | /// subscription key in url /// |
| ocpApimSubscriptionKey | string | /// subscription key in header /// |
| Результат | void | |
| public static FaceFindSimilarAsync ( this operations, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string), System cancellationToken = default(System.Threading.CancellationToken) ) : System.Threading.Tasks.Task | ||
| operations | this | /// The operations group for this extension method. /// |
| subscriptionKey | string | /// subscription key in url /// |
| ocpApimSubscriptionKey | string | /// subscription key in header /// |
| cancellationToken | System | /// The cancellation token. /// |
| Результат | System.Threading.Tasks.Task | |
| public static FaceGroup ( this operations, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string) ) : void | ||
| operations | this | /// The operations group for this extension method. /// |
| subscriptionKey | string | /// subscription key in url /// |
| ocpApimSubscriptionKey | string | /// subscription key in header /// |
| Результат | void | |
| public static FaceGroupAsync ( this operations, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string), System cancellationToken = default(System.Threading.CancellationToken) ) : System.Threading.Tasks.Task | ||
| operations | this | /// The operations group for this extension method. /// |
| subscriptionKey | string | /// subscription key in url /// |
| ocpApimSubscriptionKey | string | /// subscription key in header /// |
| cancellationToken | System | /// The cancellation token. /// |
| Результат | System.Threading.Tasks.Task | |
| public static FaceIdentify ( this operations, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string) ) : void | ||
| operations | this | /// The operations group for this extension method. /// |
| subscriptionKey | string | /// subscription key in url /// |
| ocpApimSubscriptionKey | string | /// subscription key in header /// |
| Результат | void | |
| public static FaceIdentifyAsync ( this operations, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string), System cancellationToken = default(System.Threading.CancellationToken) ) : System.Threading.Tasks.Task | ||
| operations | this | /// The operations group for this extension method. /// |
| subscriptionKey | string | /// subscription key in url /// |
| ocpApimSubscriptionKey | string | /// subscription key in header /// |
| cancellationToken | System | /// The cancellation token. /// |
| Результат | System.Threading.Tasks.Task | |
| public static FaceListAddaFacetoaFaceList ( this operations, string faceListId, string userData = default(string), string targetFace = default(string), string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string) ) : void | ||
| operations | this | /// The operations group for this extension method. /// |
| faceListId | string | /// Valid character is letter in lower case or digit or '-' or '_', maximum /// length is 64. /// |
| userData | string | /// User-specified data about the face list for any purpose. The maximum /// length is 1KB. /// |
| targetFace | string | /// A face rectangle to specify the target face to be added into the face /// list, 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. /// |
| subscriptionKey | string | /// subscription key in url /// |
| ocpApimSubscriptionKey | string | /// subscription key in header /// |
| Результат | void | |
| public static FaceListAddaFacetoaFaceListAsync ( this operations, string faceListId, string userData = default(string), string targetFace = default(string), string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string), System cancellationToken = default(System.Threading.CancellationToken) ) : System.Threading.Tasks.Task | ||
| operations | this | /// The operations group for this extension method. /// |
| faceListId | string | /// Valid character is letter in lower case or digit or '-' or '_', maximum /// length is 64. /// |
| userData | string | /// User-specified data about the face list for any purpose. The maximum /// length is 1KB. /// |
| targetFace | string | /// A face rectangle to specify the target face to be added into the face /// list, 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. /// |
| subscriptionKey | string | /// subscription key in url /// |
| ocpApimSubscriptionKey | string | /// subscription key in header /// |
| cancellationToken | System | /// The cancellation token. /// |
| Результат | System.Threading.Tasks.Task | |
| public static FaceListCreateaFaceList ( this operations, string faceListId, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string) ) : void | ||
| operations | this | /// The operations group for this extension method. /// |
| faceListId | string | /// Valid character is letter in lower case or digit or '-' or '_', maximum /// length is 64. /// /// |
| subscriptionKey | string | /// subscription key in url /// |
| ocpApimSubscriptionKey | string | /// subscription key in header /// |
| Результат | void | |
| public static FaceListCreateaFaceListAsync ( this operations, string faceListId, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string), System cancellationToken = default(System.Threading.CancellationToken) ) : System.Threading.Tasks.Task | ||
| operations | this | /// The operations group for this extension method. /// |
| faceListId | string | /// Valid character is letter in lower case or digit or '-' or '_', maximum /// length is 64. /// /// |
| subscriptionKey | string | /// subscription key in url /// |
| ocpApimSubscriptionKey | string | /// subscription key in header /// |
| cancellationToken | System | /// The cancellation token. /// |
| Результат | System.Threading.Tasks.Task | |
| public static FaceListDeleteaFaceList ( this operations, string faceListId, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string) ) : void | ||
| operations | this | /// The operations group for this extension method. /// |
| faceListId | string | /// Valid character is letter in lower case or digit or '-' or '_', maximum /// length is 64. /// |
| subscriptionKey | string | /// subscription key in url /// |
| ocpApimSubscriptionKey | string | /// subscription key in header /// |
| Результат | void | |
| public static FaceListDeleteaFaceListAsync ( this operations, string faceListId, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string), System cancellationToken = default(System.Threading.CancellationToken) ) : System.Threading.Tasks.Task | ||
| operations | this | /// The operations group for this extension method. /// |
| faceListId | string | /// Valid character is letter in lower case or digit or '-' or '_', maximum /// length is 64. /// |
| subscriptionKey | string | /// subscription key in url /// |
| ocpApimSubscriptionKey | string | /// subscription key in header /// |
| cancellationToken | System | /// The cancellation token. /// |
| Результат | System.Threading.Tasks.Task | |
| public static FaceListDeleteaFacefromaFaceList ( this operations, string faceListId, string persistedFaceId, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string) ) : void | ||
| operations | this | /// The operations group for this extension method. /// |
| faceListId | string | /// faceListId of an existing face list. Valid character is letter in lower /// case or digit or '-' or '_', maximum length is 64. /// |
| persistedFaceId | string | /// persistedFaceId of an existing face. Valid character is letter in lower /// case or digit or '-' or '_', maximum length is 64. /// |
| subscriptionKey | string | /// subscription key in url /// |
| ocpApimSubscriptionKey | string | /// subscription key in header /// |
| Результат | void | |
| public static FaceListDeleteaFacefromaFaceListAsync ( this operations, string faceListId, string persistedFaceId, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string), System cancellationToken = default(System.Threading.CancellationToken) ) : System.Threading.Tasks.Task | ||
| operations | this | /// The operations group for this extension method. /// |
| faceListId | string | /// faceListId of an existing face list. Valid character is letter in lower /// case or digit or '-' or '_', maximum length is 64. /// |
| persistedFaceId | string | /// persistedFaceId of an existing face. Valid character is letter in lower /// case or digit or '-' or '_', maximum length is 64. /// |
| subscriptionKey | string | /// subscription key in url /// |
| ocpApimSubscriptionKey | string | /// subscription key in header /// |
| cancellationToken | System | /// The cancellation token. /// |
| Результат | System.Threading.Tasks.Task | |
| public static FaceListGetaFaceList ( this operations, string faceListId, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string) ) : void | ||
| operations | this | /// The operations group for this extension method. /// |
| faceListId | string | /// Valid character is letter in lower case or digit or '-' or '_', maximum /// length is 64. /// |
| subscriptionKey | string | /// subscription key in url /// |
| ocpApimSubscriptionKey | string | /// subscription key in header /// |
| Результат | void | |
| public static FaceListGetaFaceListAsync ( this operations, string faceListId, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string), System cancellationToken = default(System.Threading.CancellationToken) ) : System.Threading.Tasks.Task | ||
| operations | this | /// The operations group for this extension method. /// |
| faceListId | string | /// Valid character is letter in lower case or digit or '-' or '_', maximum /// length is 64. /// |
| subscriptionKey | string | /// subscription key in url /// |
| ocpApimSubscriptionKey | string | /// subscription key in header /// |
| cancellationToken | System | /// The cancellation token. /// |
| Результат | System.Threading.Tasks.Task | |
| public static FaceListListFaceLists ( this operations, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string) ) : void | ||
| operations | this | /// The operations group for this extension method. /// |
| subscriptionKey | string | /// subscription key in url /// |
| ocpApimSubscriptionKey | string | /// subscription key in header /// |
| Результат | void | |
| public static FaceListListFaceListsAsync ( this operations, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string), System cancellationToken = default(System.Threading.CancellationToken) ) : System.Threading.Tasks.Task | ||
| operations | this | /// The operations group for this extension method. /// |
| subscriptionKey | string | /// subscription key in url /// |
| ocpApimSubscriptionKey | string | /// subscription key in header /// |
| cancellationToken | System | /// The cancellation token. /// |
| Результат | System.Threading.Tasks.Task | |
| public static FaceListUpdateaFaceList ( this operations, string faceListId, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string) ) : void | ||
| operations | this | /// The operations group for this extension method. /// |
| faceListId | string | /// Valid character is letter in lower case or digit or '-' or '_', maximum /// length is 64. /// |
| subscriptionKey | string | /// subscription key in url /// |
| ocpApimSubscriptionKey | string | /// subscription key in header /// |
| Результат | void | |
| public static FaceListUpdateaFaceListAsync ( this operations, string faceListId, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string), System cancellationToken = default(System.Threading.CancellationToken) ) : System.Threading.Tasks.Task | ||
| operations | this | /// The operations group for this extension method. /// |
| faceListId | string | /// Valid character is letter in lower case or digit or '-' or '_', maximum /// length is 64. /// |
| subscriptionKey | string | /// subscription key in url /// |
| ocpApimSubscriptionKey | string | /// subscription key in header /// |
| cancellationToken | System | /// The cancellation token. /// |
| Результат | System.Threading.Tasks.Task | |
| public static FaceVerify ( this operations, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string) ) : void | ||
| operations | this | /// The operations group for this extension method. /// |
| subscriptionKey | string | /// subscription key in url /// |
| ocpApimSubscriptionKey | string | /// subscription key in header /// |
| Результат | void | |
| public static FaceVerifyAsync ( this operations, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string), System cancellationToken = default(System.Threading.CancellationToken) ) : System.Threading.Tasks.Task | ||
| operations | this | /// The operations group for this extension method. /// |
| subscriptionKey | string | /// subscription key in url /// |
| ocpApimSubscriptionKey | string | /// subscription key in header /// |
| cancellationToken | System | /// The cancellation token. /// |
| Результат | System.Threading.Tasks.Task | |
| public static PersonAddaPersonFace ( this operations, string personGroupId, string personId, string userData = default(string), string targetFace = default(string), string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string) ) : void | ||
| operations | this | /// The operations group for this extension method. /// |
| personGroupId | string | /// Specifying the person group containing the target person. /// |
| personId | string | /// Target person that the face is added to. /// |
| userData | string | /// User-specified data about the target face to add for any purpose. The /// maximum length is 1KB. /// |
| targetFace | string | /// 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. /// |
| subscriptionKey | string | /// subscription key in url /// |
| ocpApimSubscriptionKey | string | /// subscription key in header /// |
| Результат | void | |
| public static PersonAddaPersonFaceAsync ( this operations, string personGroupId, string personId, string userData = default(string), string targetFace = default(string), string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string), System cancellationToken = default(System.Threading.CancellationToken) ) : System.Threading.Tasks.Task | ||
| operations | this | /// The operations group for this extension method. /// |
| personGroupId | string | /// Specifying the person group containing the target person. /// |
| personId | string | /// Target person that the face is added to. /// |
| userData | string | /// User-specified data about the target face to add for any purpose. The /// maximum length is 1KB. /// |
| targetFace | string | /// 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. /// |
| subscriptionKey | string | /// subscription key in url /// |
| ocpApimSubscriptionKey | string | /// subscription key in header /// |
| cancellationToken | System | /// The cancellation token. /// |
| Результат | System.Threading.Tasks.Task | |
| public static PersonCreateaPerson ( this operations, string personGroupId, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string) ) : void | ||
| operations | this | /// The operations group for this extension method. /// |
| personGroupId | string | /// Specifying the target person group to create the person. /// |
| subscriptionKey | string | /// subscription key in url /// |
| ocpApimSubscriptionKey | string | /// subscription key in header /// |
| Результат | void | |
| public static PersonCreateaPersonAsync ( this operations, string personGroupId, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string), System cancellationToken = default(System.Threading.CancellationToken) ) : System.Threading.Tasks.Task | ||
| operations | this | /// The operations group for this extension method. /// |
| personGroupId | string | /// Specifying the target person group to create the person. /// |
| subscriptionKey | string | /// subscription key in url /// |
| ocpApimSubscriptionKey | string | /// subscription key in header /// |
| cancellationToken | System | /// The cancellation token. /// |
| Результат | System.Threading.Tasks.Task | |
| public static PersonDeleteaPerson ( this operations, string personGroupId, string personId, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string) ) : void | ||
| operations | this | /// The operations group for this extension method. /// |
| personGroupId | string | /// Specifying the person group containing the person. /// |
| personId | string | /// The target personId to delete. /// |
| subscriptionKey | string | /// subscription key in url /// |
| ocpApimSubscriptionKey | string | /// subscription key in header /// |
| Результат | void | |
| public static PersonDeleteaPersonAsync ( this operations, string personGroupId, string personId, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string), System cancellationToken = default(System.Threading.CancellationToken) ) : System.Threading.Tasks.Task | ||
| operations | this | /// The operations group for this extension method. /// |
| personGroupId | string | /// Specifying the person group containing the person. /// |
| personId | string | /// The target personId to delete. /// |
| subscriptionKey | string | /// subscription key in url /// |
| ocpApimSubscriptionKey | string | /// subscription key in header /// |
| cancellationToken | System | /// The cancellation token. /// |
| Результат | System.Threading.Tasks.Task | |
| public static PersonDeleteaPersonFace ( this operations, string personGroupId, string personId, string persistedFaceId, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string) ) : void | ||
| operations | this | /// The operations group for this extension method. /// |
| personGroupId | string | /// Specifying the person group containing the target person. /// |
| personId | string | /// Specifying the person that the target persisted face belong to. /// |
| persistedFaceId | string | /// The persisted face to remove. This persistedFaceId is returned from <a /// href="/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f3039523b">Person /// - Add a Person Face</a>. /// |
| subscriptionKey | string | /// subscription key in url /// |
| ocpApimSubscriptionKey | string | /// subscription key in header /// |
| Результат | void | |
| public static PersonDeleteaPersonFaceAsync ( this operations, string personGroupId, string personId, string persistedFaceId, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string), System cancellationToken = default(System.Threading.CancellationToken) ) : System.Threading.Tasks.Task | ||
| operations | this | /// The operations group for this extension method. /// |
| personGroupId | string | /// Specifying the person group containing the target person. /// |
| personId | string | /// Specifying the person that the target persisted face belong to. /// |
| persistedFaceId | string | /// The persisted face to remove. This persistedFaceId is returned from <a /// href="/docs/services/563879b61984550e40cbbe8d/operations/563879b61984550f3039523b">Person /// - Add a Person Face</a>. /// |
| subscriptionKey | string | /// subscription key in url /// |
| ocpApimSubscriptionKey | string | /// subscription key in header /// |
| cancellationToken | System | /// The cancellation token. /// |
| Результат | System.Threading.Tasks.Task | |
| public static PersonGetaPerson ( this operations, string personGroupId, string personId, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string) ) : void | ||
| operations | this | /// The operations group for this extension method. /// |
| personGroupId | string | /// Specifying the person group containing the target person. /// |
| personId | string | /// Specifying the target person. /// |
| subscriptionKey | string | /// subscription key in url /// |
| ocpApimSubscriptionKey | string | /// subscription key in header /// |
| Результат | void | |
| public static PersonGetaPersonAsync ( this operations, string personGroupId, string personId, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string), System cancellationToken = default(System.Threading.CancellationToken) ) : System.Threading.Tasks.Task | ||
| operations | this | /// The operations group for this extension method. /// |
| personGroupId | string | /// Specifying the person group containing the target person. /// |
| personId | string | /// Specifying the target person. /// |
| subscriptionKey | string | /// subscription key in url /// |
| ocpApimSubscriptionKey | string | /// subscription key in header /// |
| cancellationToken | System | /// The cancellation token. /// |
| Результат | System.Threading.Tasks.Task | |
| public static PersonGetaPersonFace ( this operations, string personGroupId, string personId, string persistedFaceId, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string) ) : void | ||
| operations | this | /// The operations group for this extension method. /// |
| personGroupId | string | /// Specifying the person group containing the target person. /// |
| personId | string | /// Specifying the target person that the face belongs to. /// |
| persistedFaceId | string | /// The persistedFaceId of the target persisted face of the person. /// |
| subscriptionKey | string | /// subscription key in url /// |
| ocpApimSubscriptionKey | string | /// subscription key in header /// |
| Результат | void | |
| public static PersonGetaPersonFaceAsync ( this operations, string personGroupId, string personId, string persistedFaceId, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string), System cancellationToken = default(System.Threading.CancellationToken) ) : System.Threading.Tasks.Task | ||
| operations | this | /// The operations group for this extension method. /// |
| personGroupId | string | /// Specifying the person group containing the target person. /// |
| personId | string | /// Specifying the target person that the face belongs to. /// |
| persistedFaceId | string | /// The persistedFaceId of the target persisted face of the person. /// |
| subscriptionKey | string | /// subscription key in url /// |
| ocpApimSubscriptionKey | string | /// subscription key in header /// |
| cancellationToken | System | /// The cancellation token. /// |
| Результат | System.Threading.Tasks.Task | |
| public static PersonGroupCreateaPersonGroup ( this operations, string personGroupId, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string) ) : void | ||
| operations | this | /// The operations group for this extension method. /// |
| personGroupId | string | /// User-provided personGroupId as a string. The valid characters include /// numbers, English letters in lower case, '-' and '_'. The maximum length /// of the personGroupId is 64. /// /// |
| subscriptionKey | string | /// subscription key in url /// |
| ocpApimSubscriptionKey | string | /// subscription key in header /// |
| Результат | void | |
| public static PersonGroupCreateaPersonGroupAsync ( this operations, string personGroupId, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string), System cancellationToken = default(System.Threading.CancellationToken) ) : System.Threading.Tasks.Task | ||
| operations | this | /// The operations group for this extension method. /// |
| personGroupId | string | /// User-provided personGroupId as a string. The valid characters include /// numbers, English letters in lower case, '-' and '_'. The maximum length /// of the personGroupId is 64. /// /// |
| subscriptionKey | string | /// subscription key in url /// |
| ocpApimSubscriptionKey | string | /// subscription key in header /// |
| cancellationToken | System | /// The cancellation token. /// |
| Результат | System.Threading.Tasks.Task | |
| public static PersonGroupDeleteaPersonGroup ( this operations, string personGroupId, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string) ) : void | ||
| operations | this | /// The operations group for this extension method. /// |
| personGroupId | string | /// The personGroupId of the person group to be deleted. /// |
| subscriptionKey | string | /// subscription key in url /// |
| ocpApimSubscriptionKey | string | /// subscription key in header /// |
| Результат | void | |
| public static PersonGroupDeleteaPersonGroupAsync ( this operations, string personGroupId, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string), System cancellationToken = default(System.Threading.CancellationToken) ) : System.Threading.Tasks.Task | ||
| operations | this | /// The operations group for this extension method. /// |
| personGroupId | string | /// The personGroupId of the person group to be deleted. /// |
| subscriptionKey | string | /// subscription key in url /// |
| ocpApimSubscriptionKey | string | /// subscription key in header /// |
| cancellationToken | System | /// The cancellation token. /// |
| Результат | System.Threading.Tasks.Task | |
| public static PersonGroupGetPersonGroupTrainingStatus ( this operations, string personGroupId, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string) ) : void | ||
| operations | this | /// The operations group for this extension method. /// |
| personGroupId | string | /// personGroupId of target person group. /// |
| subscriptionKey | string | /// subscription key in url /// |
| ocpApimSubscriptionKey | string | /// subscription key in header /// |
| Результат | void | |
| public static PersonGroupGetPersonGroupTrainingStatusAsync ( this operations, string personGroupId, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string), System cancellationToken = default(System.Threading.CancellationToken) ) : System.Threading.Tasks.Task | ||
| operations | this | /// The operations group for this extension method. /// |
| personGroupId | string | /// personGroupId of target person group. /// |
| subscriptionKey | string | /// subscription key in url /// |
| ocpApimSubscriptionKey | string | /// subscription key in header /// |
| cancellationToken | System | /// The cancellation token. /// |
| Результат | System.Threading.Tasks.Task | |
| public static PersonGroupGetaPersonGroup ( this operations, string personGroupId, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string) ) : void | ||
| operations | this | /// The operations group for this extension method. /// |
| personGroupId | string | /// personGroupId of the target person group. /// |
| subscriptionKey | string | /// subscription key in url /// |
| ocpApimSubscriptionKey | string | /// subscription key in header /// |
| Результат | void | |
| public static PersonGroupGetaPersonGroupAsync ( this operations, string personGroupId, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string), System cancellationToken = default(System.Threading.CancellationToken) ) : System.Threading.Tasks.Task | ||
| operations | this | /// The operations group for this extension method. /// |
| personGroupId | string | /// personGroupId of the target person group. /// |
| subscriptionKey | string | /// subscription key in url /// |
| ocpApimSubscriptionKey | string | /// subscription key in header /// |
| cancellationToken | System | /// The cancellation token. /// |
| Результат | System.Threading.Tasks.Task | |
| public static PersonGroupListPersonGroups ( this operations, string start = default(string), int top = 1000, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string) ) : void | ||
| operations | this | /// The operations group for this extension method. /// |
| start | string | /// List person groups from the least personGroupId greater than the "start". /// It contains no more than 64 characters. Default is empty. . Possible /// values include: '' /// |
| top | int | /// The number of person groups to list, ranging in [1, 1000]. Default is /// 1000. /// |
| subscriptionKey | string | /// subscription key in url /// |
| ocpApimSubscriptionKey | string | /// subscription key in header /// |
| Результат | void | |
| public static PersonGroupListPersonGroupsAsync ( this operations, string start = default(string), int top = 1000, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string), System cancellationToken = default(System.Threading.CancellationToken) ) : System.Threading.Tasks.Task | ||
| operations | this | /// The operations group for this extension method. /// |
| start | string | /// List person groups from the least personGroupId greater than the "start". /// It contains no more than 64 characters. Default is empty. . Possible /// values include: '' /// |
| top | int | /// The number of person groups to list, ranging in [1, 1000]. Default is /// 1000. /// |
| subscriptionKey | string | /// subscription key in url /// |
| ocpApimSubscriptionKey | string | /// subscription key in header /// |
| cancellationToken | System | /// The cancellation token. /// |
| Результат | System.Threading.Tasks.Task | |
| public static PersonGroupTrainPersonGroup ( this operations, string personGroupId, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string) ) : void | ||
| operations | this | /// The operations group for this extension method. /// |
| personGroupId | string | /// Target person group to be trained. /// |
| subscriptionKey | string | /// subscription key in url /// |
| ocpApimSubscriptionKey | string | /// subscription key in header /// |
| Результат | void | |
| public static PersonGroupTrainPersonGroupAsync ( this operations, string personGroupId, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string), System cancellationToken = default(System.Threading.CancellationToken) ) : System.Threading.Tasks.Task | ||
| operations | this | /// The operations group for this extension method. /// |
| personGroupId | string | /// Target person group to be trained. /// |
| subscriptionKey | string | /// subscription key in url /// |
| ocpApimSubscriptionKey | string | /// subscription key in header /// |
| cancellationToken | System | /// The cancellation token. /// |
| Результат | System.Threading.Tasks.Task | |
| public static PersonGroupUpdateaPersonGroup ( this operations, string personGroupId, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string) ) : void | ||
| operations | this | /// The operations group for this extension method. /// |
| personGroupId | string | /// personGroupId of the person group to be updated. /// |
| subscriptionKey | string | /// subscription key in url /// |
| ocpApimSubscriptionKey | string | /// subscription key in header /// |
| Результат | void | |
| public static PersonGroupUpdateaPersonGroupAsync ( this operations, string personGroupId, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string), System cancellationToken = default(System.Threading.CancellationToken) ) : System.Threading.Tasks.Task | ||
| operations | this | /// The operations group for this extension method. /// |
| personGroupId | string | /// personGroupId of the person group to be updated. /// |
| subscriptionKey | string | /// subscription key in url /// |
| ocpApimSubscriptionKey | string | /// subscription key in header /// |
| cancellationToken | System | /// The cancellation token. /// |
| Результат | System.Threading.Tasks.Task | |
| public static PersonListPersonsinaPersonGroup ( this operations, string personGroupId, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string) ) : void | ||
| operations | this | /// The operations group for this extension method. /// |
| personGroupId | string | /// personGroupId of the target person group. /// |
| subscriptionKey | string | /// subscription key in url /// |
| ocpApimSubscriptionKey | string | /// subscription key in header /// |
| Результат | void | |
| public static PersonListPersonsinaPersonGroupAsync ( this operations, string personGroupId, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string), System cancellationToken = default(System.Threading.CancellationToken) ) : System.Threading.Tasks.Task | ||
| operations | this | /// The operations group for this extension method. /// |
| personGroupId | string | /// personGroupId of the target person group. /// |
| subscriptionKey | string | /// subscription key in url /// |
| ocpApimSubscriptionKey | string | /// subscription key in header /// |
| cancellationToken | System | /// The cancellation token. /// |
| Результат | System.Threading.Tasks.Task | |
| public static PersonUpdateaPerson ( this operations, string personGroupId, string personId, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string) ) : void | ||
| operations | this | /// The operations group for this extension method. /// |
| personGroupId | string | /// Specifying the person group containing the target person. /// |
| personId | string | /// personId of the target person. /// |
| subscriptionKey | string | /// subscription key in url /// |
| ocpApimSubscriptionKey | string | /// subscription key in header /// |
| Результат | void | |
| public static PersonUpdateaPersonAsync ( this operations, string personGroupId, string personId, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string), System cancellationToken = default(System.Threading.CancellationToken) ) : System.Threading.Tasks.Task | ||
| operations | this | /// The operations group for this extension method. /// |
| personGroupId | string | /// Specifying the person group containing the target person. /// |
| personId | string | /// personId of the target person. /// |
| subscriptionKey | string | /// subscription key in url /// |
| ocpApimSubscriptionKey | string | /// subscription key in header /// |
| cancellationToken | System | /// The cancellation token. /// |
| Результат | System.Threading.Tasks.Task | |
| public static PersonUpdateaPersonFace ( this operations, string personGroupId, string personId, string persistedFaceId, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string) ) : void | ||
| operations | this | /// The operations group for this extension method. /// |
| personGroupId | string | /// Specifying the person group containing the target person. /// |
| personId | string | /// personId of the target person. /// |
| persistedFaceId | string | /// persistedFaceId of target face, which is persisted and will not expire. /// |
| subscriptionKey | string | /// subscription key in url /// |
| ocpApimSubscriptionKey | string | /// subscription key in header /// |
| Результат | void | |
| public static PersonUpdateaPersonFaceAsync ( this operations, string personGroupId, string personId, string persistedFaceId, string subscriptionKey = default(string), string ocpApimSubscriptionKey = default(string), System cancellationToken = default(System.Threading.CancellationToken) ) : System.Threading.Tasks.Task | ||
| operations | this | /// The operations group for this extension method. /// |
| personGroupId | string | /// Specifying the person group containing the target person. /// |
| personId | string | /// personId of the target person. /// |
| persistedFaceId | string | /// persistedFaceId of target face, which is persisted and will not expire. /// |
| subscriptionKey | string | /// subscription key in url /// |
| ocpApimSubscriptionKey | string | /// subscription key in header /// |
| cancellationToken | System | /// The cancellation token. /// |
| Результат | System.Threading.Tasks.Task | |
