Face List Operations - Get Large Face List Training Status

服務:

Azure AI Services

API 版本:

v1.2-preview.1

若要檢查大型臉部清單訓練狀態已完成或仍在進行中。 大型臉部清單定型是由「定型大型臉部清單」所觸發的異步操作。

定型時間取決於大型臉部清單中的臉部項目數目。 它可以是秒，或長達半小時，1,000,000 張臉。

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

URI 參數

名稱	位於	必要	類型	Description
apiVersion	path	True	string	API 版本
endpoint	path	True	string uri	支持的認知服務端點（通訊協定和主機名，例如：https://{resource-name}.cognitiveservices.azure.com）。
largeFaceListId	path	True	string	有效字元為小寫或數位或 '-' 或 '_'，最大長度為 64。 Regex 模式: ^[a-z0-9-_]+$

回應

名稱	類型	Description
200 OK	TrainingResult	成功的呼叫會傳回大型臉部清單的訓練狀態。
Other Status Codes	FaceErrorResponse	未預期的錯誤回應。 標題 x-ms-error-code: string

安全性

Ocp-Apim-Subscription-Key

Azure AI 臉部訂用帳戶的秘密密鑰。

類型: apiKey
位於: header

AADToken

Azure Active Directory OAuth2 流程

類型: oauth2
Flow: accessCode
授權 URL: https://api.example.com/oauth2/authorize
權杖 URL: https://api.example.com/oauth2/token

範圍

名稱	Description
https://cognitiveservices.azure.com/.default

範例

Get Training Status of LargeFaceList

範例要求

HTTP

GET {endpoint}/face/v1.2-preview.1/largefacelists/your_large_face_list_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
}

定義

名稱	Description
FaceError	error 物件。 如需臉部服務所傳回錯誤碼和訊息的完整詳細數據，請參閱下列連結：https://aka.ms/face-error-codes-and-messages。
FaceErrorResponse	包含錯誤詳細數據的回應。
OperationStatus	長時間執行作業的狀態。
TrainingResult	容器的定型結果

FaceError

error 物件。 如需臉部服務所傳回錯誤碼和訊息的完整詳細數據，請參閱下列連結：https://aka.ms/face-error-codes-and-messages。

名稱	類型	Description
code	string	其中一組伺服器定義的錯誤碼。
message	string	錯誤的人類可讀取表示法。

FaceErrorResponse

包含錯誤詳細數據的回應。

名稱	類型	Description
error	FaceError	error 物件。

OperationStatus

長時間執行作業的狀態。

名稱	類型	Description
failed	string	作業失敗。
notStarted	string	作業未啟動。
running	string	作業仍在執行中。
succeeded	string	作業成功。

TrainingResult

容器的定型結果

名稱	類型	Description
createdDateTime	string	合併的 UTC 日期和時間字串，描述人員群組、大型人員群組或大型臉部清單的建立時間。
lastActionDateTime	string	描述人員群組、大型人員群組或大型臉部清單上次修改時間的合併 UTC 日期和時間字串，在群組未成功定型時，可能是 Null 值。
lastSuccessfulTrainingDateTime	string	合併的UTC日期和時間字串，描述人員群組、大型人員群組或大型臉部清單的最後成功訓練時間。
message	string	顯示定型失敗時的失敗訊息（定型成功時省略）。
status	OperationStatus	容器的定型狀態。