PersonGroupOperations クラス

  • リファレンス

PersonGroupOperations 操作。

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

継承
builtins.object
PersonGroupOperations

コンストラクター

PersonGroupOperations(client, config, serializer, deserializer)

パラメーター

client
必須

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

config
必須

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

serializer
必須

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

deserializer
必須

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

メソッド

create

指定された personGroupId、name、ユーザー指定の userData と recognitionModel を使用して新しい人物グループを作成します。
人物グループは、顔認識機能を含む、アップロードされた人物データのコンテナーです。
作成後、 PersonGroup Person - Create を使用してグループにユーザーを追加し、 PersonGroup - Train を呼び出して、このグループを Face - Identify の準備にします。
イメージは保存されません。 PersonGroup Person - Delete または PersonGroup - Delete が呼び出されるまで、ユーザーの抽出された顔機能と userData のみがサーバーに格納されます。
このユーザー グループに関連付けるには、'recognitionModel' を指定する必要があります。 'recognitionModel' の既定値は 'recognition_01' です。最新のモデルが必要な場合は、このパラメーターで必要なモデルを明示的に指定してください。 既存の人物グループに追加された新しい顔は、コレクションに既に関連付けられている認識モデルを使用します。 ユーザー グループ内の既存の顔の特徴を、別のバージョンの認識モデルによって抽出された特徴に更新することはできません。 個人グループのクォータ:

  • Free レベルのサブスクリプション クォータ: 1,000 人のグループ。 それぞれ最大 1,000 人を収容できます。
  • S0 レベルのサブスクリプション クォータ: 1,000,000 人のユーザー グループ。 それぞれ最大 10,000 人を収容できます。
  • 大規模な顔識別の問題を処理するには、 LargePersonGroup の使用を検討してください。
delete

既存のユーザー グループを削除します。 個人グループ内のすべてのユーザーの永続的な顔機能も削除されます。
get

人物グループの name、userData および recognitionModel を取得します。 この personGroup のユーザー情報を取得するには、 PersonGroup Person - List を使用します。
get_training_status

個人グループのトレーニング状態 (完了または進行中) を取得します。
list

ユーザー グループの personGroupId、名前、userData、recognitionModel を一覧表示します。

  • ユーザー グループは、personGroupId のアルファベット順に格納されます。
  • "start" パラメーター (string, optional) は、文字列比較によって返されるエントリの ID が大きいユーザー指定の personGroupId 値です。 "start" は空に設定され、最初の項目からの戻り値を示します。
  • "top" パラメーター (int, optional) は、返されるエントリの数を指定します。 最大 1000 エントリを 1 回の呼び出しで返すことができます。 さらにフェッチするには、現在の呼び出しの最後に返されたエントリの ID で "start" を指定できます。
    たとえば、"group1"、...、"group5" の合計 5 人のグループです。
    "start=&top=" は、5 つのグループすべてを返します。
    "start=&top=2" は "group1"、"group2" を返します。
    "start=group2&top=3" は、"group3"、"group4"、"group5" を返します。 .
train

個人グループのトレーニング タスクをキューに入れます。トレーニング タスクはすぐには開始されない場合があります。
update

既存のユーザー グループの表示名と userData を更新します。 要求本文に表示されないプロパティは更新されません。

create

指定された personGroupId、name、ユーザー指定の userData と recognitionModel を使用して新しい人物グループを作成します。
人物グループは、顔認識機能を含む、アップロードされた人物データのコンテナーです。
作成後、 PersonGroup Person - Create を使用してグループにユーザーを追加し、 PersonGroup - Train を呼び出して、このグループを Face - Identify の準備にします。
イメージは保存されません。 PersonGroup Person - Delete または PersonGroup - Delete が呼び出されるまで、ユーザーの抽出された顔機能と userData のみがサーバーに格納されます。
このユーザー グループに関連付けるには、'recognitionModel' を指定する必要があります。 'recognitionModel' の既定値は 'recognition_01' です。最新のモデルが必要な場合は、このパラメーターで必要なモデルを明示的に指定してください。 既存の人物グループに追加された新しい顔は、コレクションに既に関連付けられている認識モデルを使用します。 ユーザー グループ内の既存の顔の特徴を、別のバージョンの認識モデルによって抽出された特徴に更新することはできません。 個人グループのクォータ:

  • Free レベルのサブスクリプション クォータ: 1,000 人のグループ。 それぞれ最大 1,000 人を収容できます。
  • S0 レベルのサブスクリプション クォータ: 1,000,000 人のユーザー グループ。 それぞれ最大 10,000 人を収容できます。
  • 大規模な顔識別の問題を処理するには、 LargePersonGroup の使用を検討してください。
create(person_group_id, name, user_data=None, recognition_model='recognition_01', custom_headers=None, raw=False, **operation_config)

パラメーター

person_group_id
str
必須

特定のユーザー グループを参照する ID。

name
str
必須

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

user_data
str
既定値: None

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

recognition_model
str または RecognitionModel
既定値: recognition_01

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

custom_headers
dict
既定値: None

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

raw
bool
既定値: False

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

operation_config
必須

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

戻り値

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

の戻り値の型 :

None,
ClientRawResponse

例外

APIErrorException

delete

既存のユーザー グループを削除します。 個人グループ内のすべてのユーザーの永続的な顔機能も削除されます。

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

パラメーター

person_group_id
str
必須

特定のユーザー グループを参照する ID。

custom_headers
dict
既定値: None

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

raw
bool
既定値: False

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

operation_config
必須

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

戻り値

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

の戻り値の型 :

None,
ClientRawResponse

例外

APIErrorException

get

人物グループの name、userData および recognitionModel を取得します。 この personGroup のユーザー情報を取得するには、 PersonGroup Person - List を使用します。

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

パラメーター

person_group_id
str
必須

特定のユーザー グループを参照する ID。

return_recognition_model
bool
既定値: False

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

custom_headers
dict
既定値: None

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

raw
bool
既定値: False

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

operation_config
必須

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

戻り値

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

の戻り値の型 :

PersonGroup,
ClientRawResponse

例外

APIErrorException

get_training_status

個人グループのトレーニング状態 (完了または進行中) を取得します。

get_training_status(person_group_id, custom_headers=None, raw=False, **operation_config)

パラメーター

person_group_id
str
必須

特定のユーザー グループを参照する ID。

custom_headers
dict
既定値: None

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

raw
bool
既定値: False

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

operation_config
必須

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

戻り値

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

の戻り値の型 :

TrainingStatus,
ClientRawResponse

例外

APIErrorException

list

ユーザー グループの personGroupId、名前、userData、recognitionModel を一覧表示します。

  • ユーザー グループは、personGroupId のアルファベット順に格納されます。
  • "start" パラメーター (string, optional) は、文字列比較によって返されるエントリの ID が大きいユーザー指定の personGroupId 値です。 "start" は空に設定され、最初の項目からの戻り値を示します。
  • "top" パラメーター (int, optional) は、返されるエントリの数を指定します。 最大 1000 エントリを 1 回の呼び出しで返すことができます。 さらにフェッチするには、現在の呼び出しの最後に返されたエントリの ID で "start" を指定できます。
    たとえば、"group1"、...、"group5" の合計 5 人のグループです。
    "start=&top=" は、5 つのグループすべてを返します。
    "start=&top=2" は "group1"、"group2" を返します。
    "start=group2&top=3" は、"group3"、"group4"、"group5" を返します。 .
list(start=None, top=1000, return_recognition_model=False, custom_headers=None, raw=False, **operation_config)

パラメーター

start
str
既定値: None

"開始" より大きい最小 personGroupId のユーザー グループを一覧表示します。

top
int
既定値: 1000

一覧表示するユーザー グループの数。

return_recognition_model
bool
既定値: False

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

custom_headers
dict
既定値: None

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

raw
bool
既定値: False

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

operation_config
必須

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

戻り値

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

の戻り値の型 :

list[PersonGroup],
ClientRawResponse

例外

APIErrorException

train

個人グループのトレーニング タスクをキューに入れます。トレーニング タスクはすぐには開始されない場合があります。

train(person_group_id, custom_headers=None, raw=False, **operation_config)

パラメーター

person_group_id
str
必須

特定のユーザー グループを参照する ID。

custom_headers
dict
既定値: None

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

raw
bool
既定値: False

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

operation_config
必須

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

戻り値

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

の戻り値の型 :

None,
ClientRawResponse

例外

APIErrorException

update

既存のユーザー グループの表示名と userData を更新します。 要求本文に表示されないプロパティは更新されません。

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

パラメーター

person_group_id
str
必須

特定のユーザー グループを参照する ID。

name
str
既定値: None

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

user_data
str
既定値: None

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

custom_headers
dict
既定値: None

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

raw
bool
既定値: False

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

operation_config
必須

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

戻り値

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

の戻り値の型 :

None,
ClientRawResponse

例外

APIErrorException

属性

models 

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