Face List Operations - Get Large Face List Training Status

Tjänst:

Azure AI Services

API-version:

v1.2-preview.1

Kontrollera träningsstatusen för den stora ansiktslistan som har slutförts eller fortfarande pågår. Träning med stor ansiktslista är en asynkron åtgärd som utlöses av "Träna stor ansiktslista".

Träningstiden beror på antalet ansiktsposter i en stor ansiktslista. Det kan vara i sekunder, eller upp till en halvtimme för 1 000 000 ansikten.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
apiVersion	path	True	string	API-version
endpoint	path	True	string uri	Cognitive Services-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://{resource-name}.cognitiveservices.azure.com).
largeFaceListId	path	True	string	Giltigt tecken är bokstav i gemener eller siffror eller "-" eller "_", maximal längd är 64. Reguljärt uttrycksmönster: ^[a-z0-9-_]+$

Svar

Name	Typ	Description
200 OK	TrainingResult	Ett lyckat anrop returnerar träningsstatusen för den stora ansiktslistan.
Other Status Codes	FaceErrorResponse	Ett oväntat felsvar. Sidhuvuden x-ms-error-code: string

Säkerhet

Ocp-Apim-Subscription-Key

Den hemliga nyckeln för din Azure AI Face-prenumeration.

Typ: apiKey
I: header

AADToken

The Azure Active Directory OAuth2 Flow

Typ: oauth2
Flow: accessCode
Auktoriseringswebbadress: https://api.example.com/oauth2/authorize
Token-webbadress: https://api.example.com/oauth2/token

Omfattningar

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

Exempel

Get Training Status of LargeFaceList

Exempelbegäran

HTTP

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

Exempelsvar

Statuskod:

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
}

Definitioner

Name	Description
FaceError	Felobjektet. Mer information om felkoder och meddelanden som returneras av ansiktstjänsten finns i följande länk: https://aka.ms/face-error-codes-and-messages.
FaceErrorResponse	Ett svar som innehåller felinformation.
OperationStatus	Status för tidskrävande åtgärd.
TrainingResult	Träningsresultat för en container

FaceError

Felobjektet. Mer information om felkoder och meddelanden som returneras av ansiktstjänsten finns i följande länk: https://aka.ms/face-error-codes-and-messages.

Name	Typ	Description
code	string	En av en serverdefinierad uppsättning felkoder.
message	string	En mänsklig läsbar representation av felet.

FaceErrorResponse

Ett svar som innehåller felinformation.

Name	Typ	Description
error	FaceError	Felobjektet.

OperationStatus

Status för tidskrävande åtgärd.

Name	Typ	Description
failed	string	Åtgärden misslyckades.
notStarted	string	Åtgärden har inte startats.
running	string	Åtgärden körs fortfarande.
succeeded	string	Åtgärden har slutförts.

TrainingResult

Träningsresultat för en container

Name	Typ	Description
createdDateTime	string	En kombinerad UTC-datum- och tidssträng som beskriver den skapade tiden för persongruppen, den stora persongruppen eller den stora ansiktslistan.
lastActionDateTime	string	En kombinerad UTC-datum- och tidssträng som beskriver den senaste ändringstiden för persongruppen, stor persongrupp eller stor ansiktslista, kan vara null-värde när gruppen inte har tränats.
lastSuccessfulTrainingDateTime	string	En kombinerad UTC-datum- och tidssträng som beskriver den senaste lyckade träningstiden för persongruppen, stor persongrupp eller stor ansiktslista.
message	string	Visa felmeddelande när träningen misslyckades (utelämnas när träningen lyckades).
status	OperationStatus	Träningsstatus för containern.