Person Group Operations - Get Person Group Persons

Service:

Azure AI Services

API Version:

v1.1-preview.1

List all persons' information in the specified Person Group, including personId, name, userData and persistedFaceIds of registered person faces.
Persons are stored in alphabetical order of personId created in "Create Person Group Person".

• • "start" parameter (string, optional) specifies an ID value from which returned entries will have larger IDs based on string comparison. Setting "start" to an empty value indicates that entries should be returned starting from the first item.
  • "top" parameter (int, optional) determines the maximum number of entries to be returned, with a limit of up to 1000 entries per call. To retrieve additional entries beyond this limit, specify "start" with the personId of the last entry returned in the current call.

Tip

• For example, there are total 5 items with their IDs: "itemId1", ..., "itemId5".
  • "start=&top=" will return all 5 items.
  • "start=&top=2" will return "itemId1", "itemId2".
  • "start=itemId2&top=3" will return "itemId3", "itemId4", "itemId5".

GET {endpoint}/face/{apiVersion}/persongroups/{personGroupId}/persons

With optional parameters:

GET {endpoint}/face/{apiVersion}/persongroups/{personGroupId}/persons?start={start}&top={top}

URI Parameters

Name	In	Required	Type	Description
apiVersion	path	True	string	API Version
endpoint	path	True	string uri	Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com).
personGroupId	path	True	string	ID of the container. Regex pattern: ^[a-z0-9-_]+$
start	query		string	List resources greater than the "start". It contains no more than 64 characters. Default is empty.
top	query		integer int32	The number of items to list, ranging in [1, 1000]. Default is 1000.

Responses

Name	Type	Description
200 OK	PersonGroupPerson[]	A successful call returns an array of person information that belong to the Person Group.
Other Status Codes	FaceErrorResponse	An unexpected error response. Headers x-ms-error-code: string

Security

Ocp-Apim-Subscription-Key

The secret key for your Azure AI Face subscription.

Type: apiKey
In: header

AADToken

The Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: accessCode
Authorization URL: https://api.example.com/oauth2/authorize
Token URL: https://api.example.com/oauth2/token

Scopes

Name	Description
https://cognitiveservices.azure.com/.default

Examples

Get Persons from PersonGroup

Sample request

HTTP

GET {endpoint}/face/v1.1-preview.1/persongroups/your_person_group_id/persons?start=00000000-0000-0000-0000-000000000000&top=20

Sample response

Status code:

200

[
  {
    "personId": "25985303-c537-4467-b41d-bdb45cd95ca1",
    "name": "your_person_group_person_name",
    "userData": "your_user_data",
    "persistedFaceIds": [
      "43897a75-8d6f-42cf-885e-74832febb055"
    ]
  }
]

Definitions

Name	Description
FaceError	The error object. For comprehensive details on error codes and messages returned by the Face Service, please refer to the following link: https://aka.ms/face-error-codes-and-messages.
FaceErrorResponse	A response containing error details.
PersonGroupPerson	The person in a specified person group. To add face to this person, please call "Add Large Person Group Person Face".

FaceError

The error object. For comprehensive details on error codes and messages returned by the Face Service, please refer to the following link: https://aka.ms/face-error-codes-and-messages.

Name	Type	Description
code	string	One of a server-defined set of error codes.
message	string	A human-readable representation of the error.

FaceErrorResponse

A response containing error details.

Name	Type	Description
error	FaceError	The error object.

PersonGroupPerson

The person in a specified person group. To add face to this person, please call "Add Large Person Group Person Face".

Name	Type	Description
name	string	User defined name, maximum length is 128.
persistedFaceIds	string[]	Face ids of registered faces in the person.
personId	string	ID of the person.
userData	string	Optional user defined data. Length should not exceed 16K.