次の方法で共有


Large Person Group - 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" を返します。
GET {Endpoint}/face/v1.0/largepersongroups
GET {Endpoint}/face/v1.0/largepersongroups?start={start}&top={top}&returnRecognitionModel={returnRecognitionModel}

URI パラメーター

名前 / 必須 説明
Endpoint
path True

string

サポートされている Cognitive Services エンドポイント (プロトコルとホスト名など)。 https://westus.api.cognitive.microsoft.com

returnRecognitionModel
query

boolean

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

start
query

string

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

top
query

integer

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

要求ヘッダー

名前 必須 説明
Ocp-Apim-Subscription-Key True

string

応答

名前 説明
200 OK

LargePersonGroup[]

呼び出しが成功すると、大きな人物グループとその情報の配列が返されます。

Other Status Codes

APIError

エラー応答。

セキュリティ

Ocp-Apim-Subscription-Key

型: apiKey
/: header

List large person groups example

要求のサンプル

GET {Endpoint}/face/v1.0/largepersongroups?start=sample_group&top=2&returnRecognitionModel=True

応答のサンプル

[
  {
    "largePersonGroupId": "f92f6f1b-3258-4444-8fa2-c2df505cc7ac",
    "name": "large-person-group-name1",
    "userData": "User-provided data attached to the large person group.",
    "recognitionModel": "recognition_01"
  },
  {
    "largePersonGroupId": "c76f7f13-0ed3-4d00-8a3e-2ad3d78f6c37",
    "name": "large-person-group-name2",
    "userData": "User-provided data attached to the large person group.",
    "recognitionModel": "recognition_01"
  }
]

定義

名前 説明
APIError

API によって返されるエラー情報

Error

エラー本文。

LargePersonGroup

大きな人物グループ オブジェクト。

RecognitionModel

認識モデルの名前。 認識モデルは、顔の特徴が抽出され、検出された faceId、(Large)FaceList または (Large)PersonGroup に関連付けられるときに使用されます。 認識モデル名は、Face - Detect または (Large)FaceList - Create または (Large)PersonGroup - Createの実行時に指定できます。 既定値は "recognition_01" です。最新のモデルが必要な場合は、必要なモデルを明示的に指定してください。

APIError

API によって返されるエラー情報

名前 説明
error

Error

エラー本文。

Error

エラー本文。

名前 説明
code

string

message

string

LargePersonGroup

大きな人物グループ オブジェクト。

名前 規定値 説明
largePersonGroupId

string

ターゲットの大きなユーザー グループの LargePersonGroupId

name

string

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

recognitionModel

RecognitionModel

recognition_01

認識モデルの名前。 認識モデルは、顔の特徴が抽出され、検出された faceId、(Large)FaceList または (Large)PersonGroup に関連付けられるときに使用されます。 認識モデル名は、Face - Detect または (Large)FaceList - Create または (Large)PersonGroup - Createの実行時に指定できます。 既定値は "recognition_01" です。最新のモデルが必要な場合は、必要なモデルを明示的に指定してください。

userData

string

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

RecognitionModel

認識モデルの名前。 認識モデルは、顔の特徴が抽出され、検出された faceId、(Large)FaceList または (Large)PersonGroup に関連付けられるときに使用されます。 認識モデル名は、Face - Detect または (Large)FaceList - Create または (Large)PersonGroup - Createの実行時に指定できます。 既定値は "recognition_01" です。最新のモデルが必要な場合は、必要なモデルを明示的に指定してください。

名前 説明
recognition_01

string

recognition_02

string

recognition_03

string

recognition_04

string