Person Directory Operations - Create Person

Служба:: Azure AI Services

Версия API:: v1.2-preview.1

Создает нового пользователя в каталоге Person. Чтобы добавить лицо к этому лицу, вызовите каталог Person "Add Person Face".

POST {endpoint}/face/{apiVersion}/persons

Параметры URI

Имя	В	Обязательно	Тип	Описание
apiVersion	path	True	string	Версия API
endpoint	path	True	string (uri)	Поддерживаемые конечные точки Cognitive Services (протокол и имя узла, например https://{имя ресурса}.cognitiveservices.azure.com).

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

Имя	Обязательно	Тип	Описание
name	True	string minLength: 1 maxLength: 128	Определяемое пользователем имя, максимальная длина — 128.
userData		string maxLength: 16384	Необязательные пользовательские данные. Длина не должна превышать 16 КБ.

Ответы

Имя	Тип	Описание
202 Accepted	CreatePersonResult	Успешный вызов возвращает пустой текст ответа. Служба приняла запрос и начнет обработку в ближайшее время. Клиент может запрашивать состояние операции и результат, используя URL-адрес, указанный в заголовке ответа Operation-Location. Срок действия URL-адреса истекает через 48 часов. Заголовки Location: string operation-Location: string
Other Status Codes	FaceErrorResponse	Непредвиденное сообщение об ошибке. Заголовки x-ms-error-code: string

Имя

Тип

Описание

202 Accepted

CreatePersonResult

Успешный вызов возвращает пустой текст ответа. Служба приняла запрос и начнет обработку в ближайшее время. Клиент может запрашивать состояние операции и результат, используя URL-адрес, указанный в заголовке ответа Operation-Location. Срок действия URL-адреса истекает через 48 часов.

Заголовки

Location: string
operation-Location: string

Other Status Codes

FaceErrorResponse

Непредвиденное сообщение об ошибке.

Заголовки

x-ms-error-code: string

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

Ocp-Apim-Subscription-Key

Секретный ключ для подписки Azure AI Face.

Тип: apiKey
В: header

AADToken

Поток OAuth2 Azure Active Directory

Тип: oauth2
Flow: accessCode
URL-адрес авторизации: https://api.example.com/oauth2/authorize
URL-адрес токена: https://api.example.com/oauth2/token

Области

Имя	Описание
https://cognitiveservices.azure.com/.default

Примеры

Create Person in PersonDirectory

Образец запроса

HTTP

POST {endpoint}/face/v1.2-preview.1/persons

{
  "name": "your_person_name",
  "userData": "your_user_data"
}

Пример ответа

Код состояния:: 202

location: https://contoso.com/operationstatus
operation-Location: https://contoso.com/operationstatus

{
  "personId": "85c0c630-c9c9-40f8-8a4e-f9ae4f926ea5"
}

Определения

Имя	Описание
CreatePersonResult	Ответ на создание пользователя.
FaceError	Объект ошибки. Подробные сведения о кодах ошибок и сообщениях, возвращаемых службой распознавания лиц, см. по следующей ссылке: https://aka.ms/face-error-codes-and-messages.
FaceErrorResponse	Ответ, содержащий сведения об ошибке.
UserDefinedFields	Определяемые пользователем поля для создания объекта.

CreatePersonResult

Object

Ответ на создание пользователя.

Имя	Тип	Описание
personId	string (uuid)	Идентификатор пользователя.

FaceError

Object

Объект ошибки. Подробные сведения о кодах ошибок и сообщениях, возвращаемых службой распознавания лиц, см. по следующей ссылке: https://aka.ms/face-error-codes-and-messages.

Имя	Тип	Описание
code	string	Один из определяемых сервером кодов ошибок.
message	string	Читаемое пользователем представление ошибки.

FaceErrorResponse

Object

Ответ, содержащий сведения об ошибке.

Имя	Тип	Описание
error	FaceError	Объект ошибки.

UserDefinedFields

Object

Определяемые пользователем поля для создания объекта.

Имя	Тип	Описание
name	string minLength: 1 maxLength: 128	Определяемое пользователем имя, максимальная длина — 128.
userData	string maxLength: 16384	Необязательные пользовательские данные. Длина не должна превышать 16 КБ.