Person Group Person - Create

Service:

Cognitive Services - Face

API Version:

1.0

Создание нового пользователя в указанной группе пользователей.

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

Параметры 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-_]+$

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

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

Текст запроса

Name	Type	Description
name	string	Определяемое пользователем имя, максимальная длина — 128.
userData	string	Указанные пользователем данные. Длина не должна превышать 16 КБ.

Ответы

Name	Type	Description
200 OK	Person	Успешный вызов возвращает созданный идентификатор пользователя.
Other Status Codes	APIError	Ответ на ошибку.

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

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Примеры

Create new person for person group example

Sample Request

HTTP

POST {Endpoint}/face/v1.0/persongroups/abc/persons


{
  "name": "mike",
  "userData": "{additional data associated with mike}"
}

Sample Response

Status code:

200

{
  "personId": "4caa25ee-3bc6-4e88-adf8-12455ce7aab0"
}

Определения

APIError	Сведения об ошибке, возвращаемые API
Error	Текст ошибки.
NameAndUserDataContract	Сочетание определяемых пользователем имен и пользовательских данных для пользователя, largePersonGroup/personGroup и largeFaceList/faceList.
Person	Объект Person.

APIError

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

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

Error

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

Name	Type	Description
code	string
message	string

NameAndUserDataContract

Сочетание определяемых пользователем имен и пользовательских данных для пользователя, largePersonGroup/personGroup и largeFaceList/faceList.

Name	Type	Description
name	string	Определяемое пользователем имя, максимальная длина — 128.
userData	string	Указанные пользователем данные. Длина не должна превышать 16 КБ.

Person

Объект Person.

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