Person Group Operations - Get Person Group Training Status

Служба:

Azure AI Services

Версия API:

v1.2-preview.1

Проверка состояния обучения группы пользователей завершена или продолжается. Обучение группы пользователей — это асинхронная операция, активируется API train Person Group.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
apiVersion	path	True	string	Версия API
endpoint	path	True	string uri	Поддерживаемые конечные точки Cognitive Services (протокол и имя узла, например https://{имя ресурса}.cognitiveservices.azure.com).
personGroupId	path	True	string	Идентификатор контейнера. Шаблон регулярного выражения: ^[a-z0-9-_]+$

Ответы

Имя	Тип	Описание
200 OK	TrainingResult	Успешный вызов возвращает состояние обучения группы пользователей.
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

Примеры

Get Training Status of PersonGroup

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

HTTP

GET {endpoint}/face/v1.2-preview.1/persongroups/your_person_group_id/training

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

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

200

{
  "status": "notStarted",
  "createdDateTime": "2024-03-05T11:07:58.371Z",
  "lastActionDateTime": "2024-03-05T11:07:58.371Z",
  "lastSuccessfulTrainingDateTime": "2024-03-05T11:07:58.371Z",
  "message": null
}

Определения

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

FaceError

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

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

FaceErrorResponse

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

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

OperationStatus

Состояние длительной операции.

Имя	Тип	Описание
failed	string	Операция завершается ошибкой.
notStarted	string	Операция не запущена.
running	string	Операция по-прежнему выполняется.
succeeded	string	Операция выполнена успешно.

TrainingResult

Результат обучения контейнера

Имя	Тип	Описание
createdDateTime	string	Объединенная строка даты и времени в формате UTC, описывающая время создания группы пользователей, группы крупных пользователей или большого списка лиц.
lastActionDateTime	string	Объединенная строка даты и времени UTC, описывающая время последнего изменения группы пользователей, группы крупных пользователей или большого списка лиц, может иметь значение NULL, если группа не успешно обучена.
lastSuccessfulTrainingDateTime	string	Объединенная строка даты и времени в формате UTC, описывающая последнее успешное обучение группы пользователей, группы крупных пользователей или большого списка лиц.
message	string	Отображение сообщения об ошибке при сбое обучения (опущено при успешном обучении).
status	OperationStatus	Состояние обучения контейнера.