Face List Operations - Get Large Face List Training Status

Service:

Azure AI Services

API Version:

v1.1-preview.1

Чтобы проверка состояние обучения большого списка лиц завершено или продолжается. Обучение по списку лиц большого размера — это асинхронная операция, активируемая "Обучение большого списка лиц".

Время обучения зависит от количества записей лиц в большом списке лиц. Это может быть за секунды или до получасов для 1 000 000 лиц.

GET {endpoint}/face/{apiVersion}/largefacelists/{largeFaceListId}/training

Параметры URI

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

Ответы

Имя	Тип	Описание
200 OK	TrainingResult	При успешном вызове возвращается состояние обучения для большого списка лиц.
Other Status Codes	FaceErrorResponse	Непредвиденное сообщение об ошибке. Headers x-ms-error-code: string

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

Ocp-Apim-Subscription-Key

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

Type: apiKey
In: header

AADToken

Поток OAuth2 в Azure Active Directory

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

Scopes

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

Примеры

Get Training Status of LargeFaceList

Sample Request

HTTP

GET {endpoint}/face/v1.1-preview.1/largefacelists/your_large_face_list_id/training

Sample Response

Status code:

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	Состояние обучения контейнера.