Person Group Person - List

Ссылка

Service:: Cognitive Services - Face

API Version:: 1.0

Вывод списка всех пользователей в группе пользователей и получение сведений о пользователе (включая personId, имя, userData и persistedFaceIds зарегистрированных лиц пользователя).

GET {Endpoint}/face/v1.0/persongroups/{personGroupId}/persons

With optional parameters:

GET {Endpoint}/face/v1.0/persongroups/{personGroupId}/persons?start={start}&top={top}

Параметры URI

Name	In	Required	Type	Description
Endpoint	path	True	string	Поддерживаемые конечные точки Cognitive Services (например, https://westus.api.cognitive.microsoft.comимя протокола и узла).
personGroupId	path	True	string	Идентификатор, ссылающийся на определенную группу пользователей. Regex pattern: `^[a-z0-9-_]+$`
start	query		string	Начальный идентификатор пользователя для возврата (используется для перечисления диапазона лиц).
top	query		integer	Число лиц, возвращаемых начиная с идентификатора пользователя, указанного параметром start.

Заголовок запроса

Name	Required	Type	Description
Ocp-Apim-Subscription-Key	True	string

Ответы

Name	Type	Description
200 OK	Person[]	Успешный вызов возвращает массив сведений о человеке, принадлежащих группе пользователей.
Other Status Codes	APIError	Ответ на ошибку.

Безопасность

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Примеры

List persons in person group

Sample Request

HTTP

GET {Endpoint}/face/v1.0/persongroups/abc/persons?start=25985303-c537-4467-b41d-bdb45cd95ca1&top=2

Sample Response

Status code:: 200

[
  {
    "personId": "25985303-c537-4467-b41d-bdb45cd95ca1",
    "name": "Ryan",
    "userData": "User-provided data attached to the person",
    "persistedFaceIds": [
      "015839fb-fbd9-4f79-ace9-7675fc2f1dd9",
      "fce92aed-d578-4d2e-8114-068f8af4492e",
      "b64d5e15-8257-4af2-b20a-5a750f8940e7"
    ]
  },
  {
    "personId": "2ae4935b-9659-44c3-977f-61fac20d0538",
    "name": "David",
    "userData": "User-provided data attached to the person",
    "persistedFaceIds": [
      "30ea1073-cc9e-4652-b1e3-d08fb7b95315",
      "fbd2a038-dbff-452c-8e79-2ee81b1aa84e"
    ]
  }
]

Определения

APIError	Сведения об ошибке, возвращаемые API
Error	Текст ошибки.
Person	Объект Person.

APIError

Сведения об ошибке, возвращаемые API

Name	Type	Description
error	Error	Текст ошибки.

Error

Текст ошибки.

Name	Type	Description
code	string
message	string

Person

Объект Person.

Name	Type	Description
name	string	Определяемое пользователем имя, максимальная длина — 128.
persistedFaceIds	string[]	PersistedFaceIds зарегистрированных лиц в человеке. Эти сохраненные идентификаторыFaceId возвращаются из Person — добавить лицо пользователя и не истечет.
personId	string	PersonId целевого списка лиц.
userData	string	Указанные пользователем данные. Длина не должна превышать 16 КБ.