Person Group Operations - Get Person Group Training Status

Usługa:

Azure AI Services

Wersja interfejsu API:

v1.2-preview.1

Aby sprawdzić stan trenowania grupy osób został ukończony lub nadal trwa. Trenowanie grupy osób to operacja asynchroniczna wyzwalana przez interfejs API "Train Person Group".

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
apiVersion	path	True	string	Wersja interfejsu API
endpoint	path	True	string uri	Obsługiwane punkty końcowe usług Cognitive Services (protokół i nazwa hosta, na przykład: https://{nazwa-zasobu}.cognitiveservices.azure.com).
personGroupId	path	True	string	Identyfikator kontenera. Wzorzec wyrażenia regularnego: ^[a-z0-9-_]+$

Odpowiedzi

Nazwa	Typ	Opis
200 OK	TrainingResult	Pomyślne wywołanie zwraca stan szkolenia grupy osób.
Other Status Codes	FaceErrorResponse	Nieoczekiwana odpowiedź na błąd. Nagłówki x-ms-error-code: string

Zabezpieczenia

Ocp-Apim-Subscription-Key

Klucz tajny subskrypcji rozpoznawania twarzy w usłudze Azure AI.

Typ: apiKey
W: header

AADToken

Przepływ OAuth2 usługi Azure Active Directory

Typ: oauth2
Flow: accessCode
Adres URL autoryzacji: https://api.example.com/oauth2/authorize
Adres URL tokenu: https://api.example.com/oauth2/token

Zakresy

Nazwa	Opis
https://cognitiveservices.azure.com/.default

Przykłady

Get Training Status of PersonGroup

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:

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
}

Definicje

Nazwa	Opis
FaceError	Obiekt błędu. Aby uzyskać szczegółowe informacje na temat kodów błędów i komunikatów zwracanych przez usługę rozpoznawania twarzy, zapoznaj się z następującym linkiem: https://aka.ms/face-error-codes-and-messages.
FaceErrorResponse	Odpowiedź zawierająca szczegóły błędu.
OperationStatus	Stan długotrwałej operacji.
TrainingResult	Wynik trenowania kontenera

FaceError

Obiekt błędu. Aby uzyskać szczegółowe informacje na temat kodów błędów i komunikatów zwracanych przez usługę rozpoznawania twarzy, zapoznaj się z następującym linkiem: https://aka.ms/face-error-codes-and-messages.

Nazwa	Typ	Opis
code	string	Jeden z zdefiniowanych przez serwer zestaw kodów błędów.
message	string	Czytelna dla człowieka reprezentacja błędu.

FaceErrorResponse

Odpowiedź zawierająca szczegóły błędu.

Nazwa	Typ	Opis
error	FaceError	Obiekt błędu.

OperationStatus

Stan długotrwałej operacji.

Nazwa	Typ	Opis
failed	string	Operacja nie powiodła się.
notStarted	string	Operacja nie została uruchomiona.
running	string	Operacja jest nadal uruchomiona.
succeeded	string	Operacja zakończyła się pomyślnie.

TrainingResult

Wynik trenowania kontenera

Nazwa	Typ	Opis
createdDateTime	string	Połączony ciąg daty i godziny UTC, który opisuje utworzony czas grupy osób, grupy dużej osoby lub dużej listy twarzy.
lastActionDateTime	string	Połączony ciąg daty i godziny UTC, który opisuje czas ostatniej modyfikacji grupy osób, grupy dużej osoby lub dużej listy twarzy, może mieć wartość null, gdy grupa nie została pomyślnie wytrenowana.
lastSuccessfulTrainingDateTime	string	Połączony ciąg daty i godziny UTC, który opisuje czas ostatniego pomyślnego szkolenia grupy osób, grupy dużej osoby lub dużej listy twarzy.
message	string	Pokaż komunikat o błędzie po niepowodzeniu trenowania (pominięty po pomyślnym zakończeniu trenowania).
status	OperationStatus	Stan trenowania kontenera.