Face List Operations - Get Large Face List Training Status

サービス:

Azure AI Services

API バージョン:

v1.2-preview.1

Large Face List トレーニングの状態を確認するには、完了しているか、まだ進行中です。 Large Face List トレーニングは、"Train Large Face List" によってトリガーされる非同期操作です。

トレーニング時間は、大規模な顔リスト内の顔エントリの数によって異なります。 1,000,000 個の顔の場合は、秒単位または最大 30 分です。

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

URI パラメーター

名前	/	必須	型	説明
apiVersion	path	True	string	API バージョン
endpoint	path	True	string uri	サポートされている Cognitive Services エンドポイント (プロトコルとホスト名。例: https://{resource-name}.cognitiveservices.azure.com)。
largeFaceListId	path	True	string	有効な文字は小文字、数字、'-' または '_' の文字で、最大長は 64 です。 正規表現パターン: ^[a-z0-9-_]+$

応答

名前	型	説明
200 OK	TrainingResult	呼び出しが成功すると、Large Face List のトレーニング状態が返されます。
Other Status Codes	FaceErrorResponse	予期しないエラー応答。 ヘッダー x-ms-error-code: string

セキュリティ

Ocp-Apim-Subscription-Key

Azure AI Face サブスクリプションの秘密鍵。

型: apiKey
/: header

AADToken

Azure Active Directory OAuth2 フロー

型: oauth2
フロー: accessCode
Authorization URL (承認 URL): https://api.example.com/oauth2/authorize
Token URL (トークン URL): https://api.example.com/oauth2/token

スコープ

名前	説明
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
}

定義

名前	説明
FaceError	エラー オブジェクト。 Face サービスによって返されるエラー コードとメッセージの詳細については、次のリンクを参照してください: https://aka.ms/face-error-codes-and-messages。
FaceErrorResponse	エラーの詳細を含む応答。
OperationStatus	実行時間の長い操作の状態。
TrainingResult	コンテナーのトレーニング結果

FaceError

エラー オブジェクト。 Face サービスによって返されるエラー コードとメッセージの詳細については、次のリンクを参照してください: https://aka.ms/face-error-codes-and-messages。

名前	型	説明
code	string	サーバー定義の一連のエラー コードの 1 つ。
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	コンテナーのトレーニング状態。