LargePersonGroupPersonOperations クラス

  • リファレンス

LargePersonGroupPersonOperations 操作。

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

継承
builtins.object
LargePersonGroupPersonOperations

コンストラクター

LargePersonGroupPersonOperations(client, config, serializer, deserializer)

パラメーター

名前 説明
client
必須

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

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

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

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

メソッド

add_face_from_stream

顔識別または顔検証のために、人物の顔を大規模人物グループに追加します。 画像に複数の顔が含まれている場合に対処するには、入力面を targetFace 四角形を持つイメージとして指定できます。 追加された顔を表す persistedFaceId を返します。 イメージは保存されません。 LargePersonGroup PersonFace - Delete、LargePersonGroup Person - Delete、または LargePersonGroup - Delete が呼び出されるまで、抽出された顔機能のみがサーバーに格納されます。
メモ persistedFaceId は、[Face] によって生成された faceId とは異なります

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

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

顔識別または顔検証のために、人物の顔を大規模人物グループに追加します。 画像に複数の顔が含まれている場合に対処するには、入力面を targetFace 四角形を持つイメージとして指定できます。 追加された顔を表す persistedFaceId を返します。 イメージは保存されません。 LargePersonGroup PersonFace - Delete、LargePersonGroup Person - Delete、または LargePersonGroup - Delete が呼び出されるまで、抽出された顔機能のみがサーバーに格納されます。
メモ persistedFaceId は、[Face] によって生成された faceId とは異なります

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

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

指定された大規模人物グループに新しい人物を作成します。
delete

大規模人物グループから既存の人物を削除します。 person エントリの persistedFaceId、userData、person name、face 機能はすべて削除されます。
delete_face

指定された largePersonGroupId、personId および persistedFaceId に基づいて大規模人物グループの人物から顔を削除します。
同じユーザーに対して顔を追加または削除すると、順番に処理されます。 異なる人物に対する顔の追加/削除は、並行して処理されます。
get

ユーザーの名前と userData、および登録済み人物の顔機能を表す永続化された faceId を取得します。
get_face

永続化された顔 (persistedFaceId、personId、およびその属する largePersonGroupId で指定) に関する情報を取得します。
list

大規模な人物グループ内のすべての人物を一覧表示し、人物情報 (personId、名前、userData、その人物の登録済み顔の永続FaceId を含む) を取得します。
update

人物の name または userData を更新します。
update_face

人物の永続化された顔の userData フィールドを更新します。

add_face_from_stream

顔識別または顔検証のために、人物の顔を大規模人物グループに追加します。 画像に複数の顔が含まれている場合に対処するには、入力面を targetFace 四角形を持つイメージとして指定できます。 追加された顔を表す persistedFaceId を返します。 イメージは保存されません。 LargePersonGroup PersonFace - Delete、LargePersonGroup Person - Delete、または LargePersonGroup - Delete が呼び出されるまで、抽出された顔機能のみがサーバーに格納されます。
メモ persistedFaceId は、[Face] によって生成された faceId とは異なります

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

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

パラメーター

名前 説明
large_person_group_id
必須
str

特定の大きな人物グループを参照する ID。
person_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

顔識別または顔検証のために、人物の顔を大規模人物グループに追加します。 画像に複数の顔が含まれている場合に対処するには、入力面を targetFace 四角形を持つイメージとして指定できます。 追加された顔を表す persistedFaceId を返します。 イメージは保存されません。 LargePersonGroup PersonFace - Delete、LargePersonGroup Person - Delete、または LargePersonGroup - Delete が呼び出されるまで、抽出された顔機能のみがサーバーに格納されます。
メモ persistedFaceId は、[Face] によって生成された faceId とは異なります

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

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

パラメーター

名前 説明
large_person_group_id
必須
str

特定の大きな人物グループを参照する ID。
person_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

指定された大規模人物グループに新しい人物を作成します。

create(large_person_group_id, name=None, user_data=None, custom_headers=None, raw=False, **operation_config)

パラメーター

名前 説明
large_person_group_id
必須
str

特定の大きな人物グループを参照する ID。
name
str

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

既定値: None
user_data
str

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

既定値: None
custom_headers
dict

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

既定値: None
raw
bool

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

既定値: False
operation_config
必須

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

戻り値

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

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

例外

型 説明
APIErrorException

delete

大規模人物グループから既存の人物を削除します。 person エントリの persistedFaceId、userData、person name、face 機能はすべて削除されます。

delete(large_person_group_id, person_id, custom_headers=None, raw=False, **operation_config)

パラメーター

名前 説明
large_person_group_id
必須
str

特定の大きな人物グループを参照する ID。
person_id
必須
str

特定のユーザーを参照する ID。
custom_headers
dict

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

既定値: None
raw
bool

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

既定値: False
operation_config
必須

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

戻り値

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

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

例外

型 説明
APIErrorException

delete_face

指定された largePersonGroupId、personId および persistedFaceId に基づいて大規模人物グループの人物から顔を削除します。
同じユーザーに対して顔を追加または削除すると、順番に処理されます。 異なる人物に対する顔の追加/削除は、並行して処理されます。

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

パラメーター

名前 説明
large_person_group_id
必須
str

特定の大きな人物グループを参照する ID。
person_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

ユーザーの名前と userData、および登録済み人物の顔機能を表す永続化された faceId を取得します。

get(large_person_group_id, person_id, custom_headers=None, raw=False, **operation_config)

パラメーター

名前 説明
large_person_group_id
必須
str

特定の大きな人物グループを参照する ID。
person_id
必須
str

特定のユーザーを参照する ID。
custom_headers
dict

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

既定値: None
raw
bool

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

既定値: False
operation_config
必須

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

戻り値

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

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

例外

型 説明
APIErrorException

get_face

永続化された顔 (persistedFaceId、personId、およびその属する largePersonGroupId で指定) に関する情報を取得します。

get_face(large_person_group_id, person_id, persisted_face_id, custom_headers=None, raw=False, **operation_config)

パラメーター

名前 説明
large_person_group_id
必須
str

特定の大きな人物グループを参照する ID。
person_id
必須
str

特定のユーザーを参照する ID。
persisted_face_id
必須
str

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

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

既定値: None
raw
bool

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

既定値: False
operation_config
必須

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

戻り値

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

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

例外

型 説明
APIErrorException

list

大規模な人物グループ内のすべての人物を一覧表示し、人物情報 (personId、名前、userData、その人物の登録済み顔の永続FaceId を含む) を取得します。

list(large_person_group_id, start=None, top=None, custom_headers=None, raw=False, **operation_config)

パラメーター

名前 説明
large_person_group_id
必須
str

特定の大きな人物グループを参照する ID。
start
str

返される開始ユーザー ID (ユーザーの範囲を一覧表示するために使用されます)。

既定値: None
top
int

'start' パラメーターで示される人物 ID で始まる、返されるユーザーの数。

既定値: None
custom_headers
dict

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

既定値: None
raw
bool

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

既定値: False
operation_config
必須

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

戻り値

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

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

例外

型 説明
APIErrorException

update

人物の name または userData を更新します。

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

パラメーター

名前 説明
large_person_group_id
必須
str

特定の大きな人物グループを参照する ID。
person_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

update_face

人物の永続化された顔の userData フィールドを更新します。

update_face(large_person_group_id, person_id, persisted_face_id, user_data=None, custom_headers=None, raw=False, **operation_config)

パラメーター

名前 説明
large_person_group_id
必須
str

特定の大きな人物グループを参照する ID。
person_id
必須
str

特定のユーザーを参照する ID。
persisted_face_id
必須
str

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

顔にアタッチされたユーザー指定のデータ。 サイズ制限は 1 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'>