FaceListOperations クラス

  • リファレンス

FaceListOperations 操作。

このクラスを直接インスタンス化するのではなく、クライアント インスタンスを作成して属性としてアタッチします。

継承
builtins.object
FaceListOperations

コンストラクター

FaceListOperations(client, config, serializer, deserializer)

パラメーター

名前 説明
client
必須

サービス要求のクライアント。
config
必須

サービス クライアントの構成。
serializer
必須

オブジェクト モデル シリアライザー。
deserializer
必須

オブジェクト モデル逆シリアライザー。

メソッド

add_face_from_stream

指定された顔リストに顔を追加します (最大 1,000 個)。
複数の顔を含む画像を処理するには、入力面を targetFace 四角形を含む画像として指定できます。 追加された顔を表す persistedFaceId を返します。 イメージは保存されません。 FaceList - Delete Face または FaceList - Delete が呼び出されるまで、抽出された顔機能のみがサーバーに格納されます。
メモ persistedFaceId は、[Face] によって生成された faceId とは異なります

Detect](https://docs.microsoft.com/rest/api/faceapi/face/detectwithurl)。

  • 顔の画質が高いほど、検出と認識の精度が向上します。 正面、透明、顔のサイズは 200 x 200 ピクセル (目の間に 100 ピクセル) 以上の高品質の顔を検討してください。
  • JPEG、PNG、GIF (最初のフレーム)、BMP 形式がサポートされています。 許可されるイメージ ファイルのサイズは 1 KB から 6 MB です。
  • "targetFace" 四角形には、1 つの顔が含まれている必要があります。 0 個または複数の面はエラーと見なされます。 指定された "targetFace" 四角形が Face - Detect から返されない場合、顔を正常に検出して追加する保証はありません。
  • 検出可能な顔サイズ (36 x 36 ~ 4096 x 4096 ピクセル)、大きな頭部姿勢、または大きなオクルージョンが原因でエラーが発生します。
  • 同じ顔リストとの間で顔を追加/削除すると、順番に処理され、異なる顔リストとの間で並列に処理されます。
  • 検出可能な顔の最小サイズは、1920x1080 ピクセル以下の画像では 36 x 36 ピクセルです。 1920x1080 ピクセルより大きいサイズの画像では、顔の最小サイズが比例的に大きくなります。
  • さまざまな 'detectionModel' 値を指定できます。 さまざまな検出モデルを使用して比較するには、「 検出モデルを指定する方法」を参照してください。
add_face_from_url

指定された顔リストに顔を追加します (最大 1,000 個)。
複数の顔を含む画像を処理するには、入力面を targetFace 四角形を含む画像として指定できます。 追加された顔を表す persistedFaceId を返します。 イメージは保存されません。 FaceList - Delete Face または FaceList - Delete が呼び出されるまで、抽出された顔機能のみがサーバーに格納されます。
メモ persistedFaceId は、[Face] によって生成された faceId とは異なります

Detect](https://docs.microsoft.com/rest/api/faceapi/face/detectwithurl)。

  • 顔の画質が高いほど、検出と認識の精度が向上します。 正面、透明、顔のサイズは 200 x 200 ピクセル (目の間に 100 ピクセル) 以上の高品質の顔を検討してください。
  • JPEG、PNG、GIF (最初のフレーム)、BMP 形式がサポートされています。 許可されるイメージ ファイルのサイズは 1 KB から 6 MB です。
  • "targetFace" 四角形には、1 つの顔が含まれている必要があります。 0 個または複数の面はエラーと見なされます。 指定された "targetFace" 四角形が Face - Detect から返されない場合、顔を正常に検出して追加する保証はありません。
  • 検出可能な顔サイズ (36 x 36 ~ 4096 x 4096 ピクセル)、大きな頭部姿勢、または大きなオクルージョンが原因でエラーが発生します。
  • 同じ顔リストとの間で顔を追加/削除すると、順番に処理され、異なる顔リストとの間で並列に処理されます。
  • 検出可能な顔の最小サイズは、1920x1080 ピクセル以下の画像では 36 x 36 ピクセルです。 1920x1080 ピクセルより大きいサイズの画像では、顔の最小サイズが比例的に大きくなります。
  • さまざまな 'detectionModel' 値を指定できます。 さまざまな検出モデルを使用して比較するには、「 検出モデルを指定する方法」を参照してください。
create

ユーザーが指定した faceListId、name、および省略可能な userData と recognitionModel を使用して空の顔リストを作成します。 1 つのサブスクリプションで最大 64 個の顔リストを使用できます。
顔リストは、最大 1,000 個の顔の顔のリストであり、 Face - Find Similar で使用されます。
作成後、ユーザーは FaceList - Add Face を使用して顔をインポートする必要があります。 イメージは保存されません。 FaceList - Delete が呼び出されるまで、抽出された顔の特徴のみがサーバーに格納されます。
Find Similar は、有名人のような顔の検索、似た顔のフィルター処理、または明るい方法での顔識別などのシナリオに使用されます。 ただし、実際に個人を識別する場合は、PersonGroupLargePersonGroup / と Face - Identify を使用してください。
顔番号が大きい場合は LargeFaceList を検討してください。 最大 1,000,000 人の顔をサポートできます。
この顔リストに関連付けるには、'recognitionModel' を指定する必要があります。 'recognitionModel' の既定値は 'recognition_01' です。最新のモデルが必要な場合は、このパラメーターで必要なモデルを明示的に指定してください。 既存の顔リストに追加された新しい顔は、コレクションに既に関連付けられている認識モデルを使用します。 顔リスト内の既存の顔の特徴を、別のバージョンの認識モデルによって抽出された特徴に更新することはできません。 顔認識モデルの指定に関するページを参照してください。
delete

指定された顔リストを削除します。
delete_face

指定された faceListId と persistedFaceId に基づいて顔リストから顔を削除します。
同じ顔リストとの間で顔を追加または削除すると、順番に処理され、異なる顔リストとの間で並行して処理されます。
get

顔リストの faceListId、name、userData、recognitionModel、および顔リスト内の顔を取得します。 .
list

顔リストの faceListId、名前、userData、recognitionModel を一覧表示します。
faceList 内で顔情報を取得するには、 FaceList - Get を使用します。
update

顔リストの情報を更新します。

add_face_from_stream

指定された顔リストに顔を追加します (最大 1,000 個)。
複数の顔を含む画像を処理するには、入力面を targetFace 四角形を含む画像として指定できます。 追加された顔を表す persistedFaceId を返します。 イメージは保存されません。 FaceList - Delete Face または FaceList - Delete が呼び出されるまで、抽出された顔機能のみがサーバーに格納されます。
メモ persistedFaceId は、[Face] によって生成された faceId とは異なります

Detect](https://docs.microsoft.com/rest/api/faceapi/face/detectwithurl)。

  • 顔の画質が高いほど、検出と認識の精度が向上します。 正面、透明、顔のサイズは 200 x 200 ピクセル (目の間に 100 ピクセル) 以上の高品質の顔を検討してください。
  • JPEG、PNG、GIF (最初のフレーム)、BMP 形式がサポートされています。 許可されるイメージ ファイルのサイズは 1 KB から 6 MB です。
  • "targetFace" 四角形には、1 つの顔が含まれている必要があります。 0 個または複数の面はエラーと見なされます。 指定された "targetFace" 四角形が Face - Detect から返されない場合、顔を正常に検出して追加する保証はありません。
  • 検出可能な顔サイズ (36 x 36 ~ 4096 x 4096 ピクセル)、大きな頭部姿勢、または大きなオクルージョンが原因でエラーが発生します。
  • 同じ顔リストとの間で顔を追加/削除すると、順番に処理され、異なる顔リストとの間で並列に処理されます。
  • 検出可能な顔の最小サイズは、1920x1080 ピクセル以下の画像では 36 x 36 ピクセルです。 1920x1080 ピクセルより大きいサイズの画像では、顔の最小サイズが比例的に大きくなります。
  • さまざまな 'detectionModel' 値を指定できます。 さまざまな検出モデルを使用して比較するには、「 検出モデルを指定する方法」を参照してください。
add_face_from_stream(face_list_id, image, user_data=None, target_face=None, detection_model='detection_01', custom_headers=None, raw=False, callback=None, **operation_config)

パラメーター

名前 説明
face_list_id
必須
str

特定の顔リストを参照する ID。
image
必須
Generator

イメージ ストリーム。
user_data
str

任意の目的で顔に関するユーザー指定のデータ。 最大長は 1 KB です。

既定値: None
target_face
list[int]

"targetFace=left,top,width,height" の形式でユーザーに追加する対象の顔を指定する顔の四角形。 例: "targetFace=10,10,100,100" イメージに複数の顔がある場合は、追加する顔を指定するために targetFace が必要です。 targetFace は、画像全体で検出された顔が 1 つだけであることを意味します。

既定値: None
detection_model
str または DetectionModel

検出モデルの名前。 検出モデルは、送信された画像内の顔を検出するために使用されます。 検出モデル名は、Face - Detect または (Large)FaceList - Add Face or (Large)PersonGroup - Add Face を実行するときに指定できます。 既定値は 'detection_01' です。別のモデルが必要な場合は、明示的に指定してください。 指定できる値は、'detection_01'、'detection_02'、'detection_03' です。

既定値: detection_01
custom_headers
dict

要求に追加されるヘッダー

既定値: None
raw
bool

は、逆シリアル化された応答と共に直接応答を返します

既定値: False
callback
Callable[<xref:Bytes>, <xref:response=None>]

を指定すると、ストリーミングされるデータの各チャンクで が呼び出されます。 コールバックは、データの現在のチャンクのバイトと応答オブジェクトの 2 つの引数を受け取る必要があります。 データがアップロードされている場合、応答は None になります。

既定値: None
operation_config
必須

操作構成のオーバーライド。

戻り値

型 説明
PersistedFace,
<xref:msrest.pipeline.ClientRawResponse>

persistedFace または ClientRawResponse (raw=true の場合)

例外

型 説明
APIErrorException

add_face_from_url

指定された顔リストに顔を追加します (最大 1,000 個)。
複数の顔を含む画像を処理するには、入力面を targetFace 四角形を含む画像として指定できます。 追加された顔を表す persistedFaceId を返します。 イメージは保存されません。 FaceList - Delete Face または FaceList - Delete が呼び出されるまで、抽出された顔機能のみがサーバーに格納されます。
メモ persistedFaceId は、[Face] によって生成された faceId とは異なります

Detect](https://docs.microsoft.com/rest/api/faceapi/face/detectwithurl)。

  • 顔の画質が高いほど、検出と認識の精度が向上します。 正面、透明、顔のサイズは 200 x 200 ピクセル (目の間に 100 ピクセル) 以上の高品質の顔を検討してください。
  • JPEG、PNG、GIF (最初のフレーム)、BMP 形式がサポートされています。 許可されるイメージ ファイルのサイズは 1 KB から 6 MB です。
  • "targetFace" 四角形には、1 つの顔が含まれている必要があります。 0 個または複数の面はエラーと見なされます。 指定された "targetFace" 四角形が Face - Detect から返されない場合、顔を正常に検出して追加する保証はありません。
  • 検出可能な顔サイズ (36 x 36 ~ 4096 x 4096 ピクセル)、大きな頭部姿勢、または大きなオクルージョンが原因でエラーが発生します。
  • 同じ顔リストとの間で顔を追加/削除すると、順番に処理され、異なる顔リストとの間で並列に処理されます。
  • 検出可能な顔の最小サイズは、1920x1080 ピクセル以下の画像では 36 x 36 ピクセルです。 1920x1080 ピクセルより大きいサイズの画像では、顔の最小サイズが比例的に大きくなります。
  • さまざまな 'detectionModel' 値を指定できます。 さまざまな検出モデルを使用して比較するには、「 検出モデルを指定する方法」を参照してください。
add_face_from_url(face_list_id, url, user_data=None, target_face=None, detection_model='detection_01', custom_headers=None, raw=False, **operation_config)

パラメーター

名前 説明
face_list_id
必須
str

特定の顔リストを参照する ID。
url
必須
str

イメージのパブリックに到達可能な URL
user_data
str

任意の目的で顔に関するユーザー指定のデータ。 最大長は 1 KB です。

既定値: None
target_face
list[int]

"targetFace=left,top,width,height" の形式でユーザーに追加する対象の顔を指定する顔の四角形。 例: "targetFace=10,10,100,100" イメージに複数の顔がある場合は、追加する顔を指定するために targetFace が必要です。 targetFace は、画像全体で検出された顔が 1 つだけであることを意味します。

既定値: None
detection_model
str または DetectionModel

検出モデルの名前。 検出モデルは、送信された画像内の顔を検出するために使用されます。 検出モデル名は、Face - Detect または (Large)FaceList - Add Face or (Large)PersonGroup - Add Face を実行するときに指定できます。 既定値は 'detection_01' です。別のモデルが必要な場合は、明示的に指定してください。 指定できる値は、'detection_01'、'detection_02'、'detection_03' です。

既定値: detection_01
custom_headers
dict

要求に追加されるヘッダー

既定値: None
raw
bool

は、逆シリアル化された応答と共に直接応答を返します

既定値: False
operation_config
必須

操作構成のオーバーライド。

戻り値

型 説明
PersistedFace,
<xref:msrest.pipeline.ClientRawResponse>

persistedFace または ClientRawResponse (raw=true の場合)

例外

型 説明
APIErrorException

create

ユーザーが指定した faceListId、name、および省略可能な userData と recognitionModel を使用して空の顔リストを作成します。 1 つのサブスクリプションで最大 64 個の顔リストを使用できます。
顔リストは、最大 1,000 個の顔の顔のリストであり、 Face - Find Similar で使用されます。
作成後、ユーザーは FaceList - Add Face を使用して顔をインポートする必要があります。 イメージは保存されません。 FaceList - Delete が呼び出されるまで、抽出された顔の特徴のみがサーバーに格納されます。
Find Similar は、有名人のような顔の検索、似た顔のフィルター処理、または明るい方法での顔識別などのシナリオに使用されます。 ただし、実際に個人を識別する場合は、PersonGroupLargePersonGroup / と Face - Identify を使用してください。
顔番号が大きい場合は LargeFaceList を検討してください。 最大 1,000,000 人の顔をサポートできます。
この顔リストに関連付けるには、'recognitionModel' を指定する必要があります。 'recognitionModel' の既定値は 'recognition_01' です。最新のモデルが必要な場合は、このパラメーターで必要なモデルを明示的に指定してください。 既存の顔リストに追加された新しい顔は、コレクションに既に関連付けられている認識モデルを使用します。 顔リスト内の既存の顔の特徴を、別のバージョンの認識モデルによって抽出された特徴に更新することはできません。 顔認識モデルの指定に関するページを参照してください。

create(face_list_id, name, user_data=None, recognition_model='recognition_01', custom_headers=None, raw=False, **operation_config)

パラメーター

名前 説明
face_list_id
必須
str

特定の顔リストを参照する ID。
name
必須
str

ユーザー定義名、最大長は 128 です。
user_data
str

ユーザー指定のデータ。 長さは 16 KB を超えないようにしてください。

既定値: None
recognition_model
str または RecognitionModel

指定できる値は、'recognition_01'、'recognition_02'、'recognition_03'、'recognition_04' です。

既定値: recognition_01
custom_headers
dict

要求に追加されるヘッダー

既定値: None
raw
bool

は、逆シリアル化された応答と共に直接応答を返します

既定値: False
operation_config
必須

操作構成のオーバーライド。

戻り値

型 説明
None,
<xref:msrest.pipeline.ClientRawResponse>

none または ClientRawResponse (raw=true の場合)

例外

型 説明
APIErrorException

delete

指定された顔リストを削除します。

delete(face_list_id, custom_headers=None, raw=False, **operation_config)

パラメーター

名前 説明
face_list_id
必須
str

特定の顔リストを参照する ID。
custom_headers
dict

要求に追加されるヘッダー

既定値: None
raw
bool

は、逆シリアル化された応答と共に直接応答を返します

既定値: False
operation_config
必須

操作の構成がオーバーライドされます。

戻り値

型 説明
None,
<xref:msrest.pipeline.ClientRawResponse>

raw=true の場合は None または ClientRawResponse

例外

型 説明
APIErrorException

delete_face

指定された faceListId と persistedFaceId に基づいて顔リストから顔を削除します。
同じ顔リストとの間で顔を追加または削除すると、順番に処理され、異なる顔リストとの間で並行して処理されます。

delete_face(face_list_id, persisted_face_id, custom_headers=None, raw=False, **operation_config)

パラメーター

名前 説明
face_list_id
必須
str

特定の顔リストを参照する ID。
persisted_face_id
必須
str

既存の顔の特定の永続化されたFaceIdを参照する ID。
custom_headers
dict

要求に追加されるヘッダー

既定値: None
raw
bool

は、逆シリアル化された応答と共に直接応答を返します

既定値: False
operation_config
必須

操作の構成がオーバーライドされます。

戻り値

型 説明
None,
<xref:msrest.pipeline.ClientRawResponse>

raw=true の場合は None または ClientRawResponse

例外

型 説明
APIErrorException

get

顔リストの faceListId、name、userData、recognitionModel、および顔リスト内の顔を取得します。 .

get(face_list_id, return_recognition_model=False, custom_headers=None, raw=False, **operation_config)

パラメーター

名前 説明
face_list_id
必須
str

特定の顔リストを参照する ID。
return_recognition_model
bool

操作が応答で 'recognitionModel' を返す必要があるかどうかを示す値。

既定値: False
custom_headers
dict

要求に追加されるヘッダー

既定値: None
raw
bool

は、逆シリアル化された応答と共に直接応答を返します

既定値: False
operation_config
必須

操作の構成がオーバーライドされます。

戻り値

型 説明
FaceList,
<xref:msrest.pipeline.ClientRawResponse>

faceList または ClientRawResponse (raw=true の場合)

例外

型 説明
APIErrorException

list

顔リストの faceListId、名前、userData、recognitionModel を一覧表示します。
faceList 内で顔情報を取得するには、 FaceList - Get を使用します。

list(return_recognition_model=False, custom_headers=None, raw=False, **operation_config)

パラメーター

名前 説明
return_recognition_model
bool

操作が応答で 'recognitionModel' を返す必要があるかどうかを示す値。

既定値: False
custom_headers
dict

要求に追加されるヘッダー

既定値: None
raw
bool

は、逆シリアル化された応答と共に直接応答を返します

既定値: False
operation_config
必須

操作の構成がオーバーライドされます。

戻り値

型 説明
list[FaceList],
<xref:msrest.pipeline.ClientRawResponse>

raw=true の場合は list または ClientRawResponse

例外

型 説明
APIErrorException

update

顔リストの情報を更新します。

update(face_list_id, name=None, user_data=None, custom_headers=None, raw=False, **operation_config)

パラメーター

名前 説明
face_list_id
必須
str

特定の顔リストを参照する ID。
name
str

ユーザー定義の名前。最大長は 128 です。

既定値: None
user_data
str

ユーザーが指定したデータ。 長さは 16 KB を超えないようにしてください。

既定値: None
custom_headers
dict

要求に追加されるヘッダー

既定値: None
raw
bool

は、逆シリアル化された応答と共に直接応答を返します

既定値: False
operation_config
必須

操作の構成がオーバーライドされます。

戻り値

型 説明
None,
<xref:msrest.pipeline.ClientRawResponse>

raw=true の場合は None または ClientRawResponse

例外

型 説明
APIErrorException

属性

models 

models = <module 'azure.cognitiveservices.vision.face.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\cognitiveservices\\vision\\face\\models\\__init__.py'>