Person Group Operations - Get Person Group Training Status

Služba:

Azure AI Services

Verze rozhraní API:

v1.2-preview.1

Pokud chcete zkontrolovat stav školení skupiny osob, je dokončený nebo stále probíhá. Trénování skupiny osob je asynchronní operace aktivovaná rozhraním API "Train Person Group".

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
apiVersion	path	True	string	Verze rozhraní API
endpoint	path	True	string uri	Podporované koncové body služeb Cognitive Services (protokol a název hostitele, například: https://{název_prostředku}.cognitiveservices.azure.com).
personGroupId	path	True	string	ID kontejneru. Vzor regulárního výrazu: ^[a-z0-9-_]+$

Odpovědi

Name	Typ	Description
200 OK	TrainingResult	Úspěšné volání vrátí stav trénování skupiny osob.
Other Status Codes	FaceErrorResponse	Neočekávaná chybová odpověď Hlavičky x-ms-error-code: string

Zabezpečení

Ocp-Apim-Subscription-Key

Tajný klíč předplatného Azure AI Face.

Typ: apiKey
V: header

AADToken

Tok Azure Active Directory OAuth2

Typ: oauth2
Tok: accessCode
URL autorizace: https://api.example.com/oauth2/authorize
URL tokenu: https://api.example.com/oauth2/token

Rozsahy

Name	Description
https://cognitiveservices.azure.com/.default

Příklady

Get Training Status of PersonGroup

Ukázkový požadavek

HTTP

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

Ukázková odpověď

Stavový kód:

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
}

Definice

Name	Description
FaceError	Objekt chyby. Podrobné informace o kódech chyb a zprávách vrácených službou Rozpoznávání tváře najdete na následujícím odkazu: https://aka.ms/face-error-codes-and-messages.
FaceErrorResponse	Odpověď obsahující podrobnosti o chybě.
OperationStatus	Stav dlouhotrvající operace.
TrainingResult	Trénování výsledku kontejneru

FaceError

Objekt chyby. Podrobné informace o kódech chyb a zprávách vrácených službou Rozpoznávání tváře najdete na následujícím odkazu: https://aka.ms/face-error-codes-and-messages.

Name	Typ	Description
code	string	Jedna ze serverově definovaných kódů chyb.
message	string	Čitelné znázornění chyby člověkem.

FaceErrorResponse

Odpověď obsahující podrobnosti o chybě.

Name	Typ	Description
error	FaceError	Objekt chyby.

OperationStatus

Stav dlouhotrvající operace.

Name	Typ	Description
failed	string	Operace se nezdařila.
notStarted	string	Operace není spuštěna.
running	string	Operace je stále spuštěná.
succeeded	string	Operace byla úspěšná.

TrainingResult

Trénování výsledku kontejneru

Name	Typ	Description
createdDateTime	string	Kombinovaný řetězec data a času UTC, který popisuje vytvořený čas skupiny osob, velké skupiny osob nebo velkého seznamu tváří.
lastActionDateTime	string	Kombinovaný řetězec data a času UTC, který popisuje čas poslední úpravy skupiny osob, velké skupiny osob nebo velkého seznamu tváří, může mít hodnotu null, pokud se skupina úspěšně nenatrénuje.
lastSuccessfulTrainingDateTime	string	Kombinovaný řetězec data a času UTC, který popisuje čas posledního úspěšného trénování skupiny osob, velké skupiny osob nebo velkého seznamu tváří.
message	string	Zobrazí zprávu o selhání, když se trénování nezdařilo (vynecháno při úspěšném trénování).
status	OperationStatus	Stav trénování kontejneru