LargePersonGroupOperations クラス

  • リファレンス

LargePersonGroupOperations 操作。

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

継承
builtins.object
LargePersonGroupOperations

コンストラクター

LargePersonGroupOperations(client, config, serializer, deserializer)

パラメーター

client
必須

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

config
必須

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

serializer
必須

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

deserializer
必須

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

メソッド

create

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

  • Free レベルのサブスクリプション クォータ: 1,000 の大規模なユーザー グループ。
  • S0 レベルのサブスクリプション クォータ: 1,000,000 の大規模なユーザー グループ。
delete

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

大規模人物グループの情報を、name、userData、recognitionModel も含めて取得します。 この API は、大きな人物グループ情報のみを返します。代わりに LargePersonGroup Person - List を使用して、大きな人物グループのユーザー情報を取得します。 .
get_training_status

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

既存のすべての大きな人物グループの largePersonGroupId、name、userData、recognitionModel を一覧表示します。

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

大規模なユーザー グループのトレーニング タスクをキューに入れます。トレーニング タスクをすぐに開始できない場合があります。
update

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

create

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

  • Free レベルのサブスクリプション クォータ: 1,000 の大規模なユーザー グループ。
  • S0 レベルのサブスクリプション クォータ: 1,000,000 の大規模なユーザー グループ。
create(large_person_group_id, name, user_data=None, recognition_model='recognition_01', custom_headers=None, raw=False, **operation_config)

パラメーター

large_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
必須

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

戻り値

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

の戻り値の型 :

None,
ClientRawResponse

例外

APIErrorException

delete

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

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

パラメーター

large_person_group_id
str
必須

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

custom_headers
dict
既定値: None

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

raw
bool
既定値: False

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

operation_config
必須

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

戻り値

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

の戻り値の型 :

None,
ClientRawResponse

例外

APIErrorException

get

大規模人物グループの情報を、name、userData、recognitionModel も含めて取得します。 この API は、大きな人物グループ情報のみを返します。代わりに LargePersonGroup Person - List を使用して、大きな人物グループのユーザー情報を取得します。 .

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

パラメーター

large_person_group_id
str
必須

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

return_recognition_model
bool
既定値: False

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

custom_headers
dict
既定値: None

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

raw
bool
既定値: False

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

operation_config
必須

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

戻り値

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

の戻り値の型 :

LargePersonGroup,
ClientRawResponse

例外

APIErrorException

get_training_status

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

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

パラメーター

large_person_group_id
str
必須

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

custom_headers
dict
既定値: None

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

raw
bool
既定値: False

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

operation_config
必須

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

戻り値

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

の戻り値の型 :

TrainingStatus,
ClientRawResponse

例外

APIErrorException

list

既存のすべての大きな人物グループの largePersonGroupId、name、userData、recognitionModel を一覧表示します。

  • 大きな人物グループは、largePersonGroupId のアルファベット順に格納されます。
  • "start" パラメーター (string、 省略可能) は、文字列比較によって返されるエントリの ID が大きい、ユーザー指定の largePersonGroupId 値です。 "start" を空に設定すると、最初の項目からの戻り値が示されます。
  • "top" パラメーター (int, optional) は、返されるエントリの数を指定します。 1 回の呼び出しで最大 1000 エントリを返すことができます。 さらにフェッチするには、現在の呼び出しの最後に返されたエントリの 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

"start" より大きい最も大きいPersonGroupId から大規模なユーザー グループを一覧表示します。

top
int
既定値: 1000

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

return_recognition_model
bool
既定値: False

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

custom_headers
dict
既定値: None

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

raw
bool
既定値: False

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

operation_config
必須

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

戻り値

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

の戻り値の型 :

list[LargePersonGroup],
ClientRawResponse

例外

APIErrorException

train

大規模なユーザー グループのトレーニング タスクをキューに入れます。トレーニング タスクをすぐに開始できない場合があります。

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

パラメーター

large_person_group_id
str
必須

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

custom_headers
dict
既定値: None

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

raw
bool
既定値: False

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

operation_config
必須

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

戻り値

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

の戻り値の型 :

None,
ClientRawResponse

例外

APIErrorException

update

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

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

パラメーター

large_person_group_id
str
必須

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

name
str
既定値: None

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

user_data
str
既定値: None

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

custom_headers
dict
既定値: None

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

raw
bool
既定値: False

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

operation_config
必須

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

戻り値

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

の戻り値の型 :

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'>