Person Group Operations - Create Person Group Person

  • リファレンス
サービス:
Azure AI Services
API バージョン:
v1.2-preview.1

指定した人物グループに新しいユーザーを作成します。 このユーザーに顔を追加するには、"Add Person Group Person Face" を呼び出してください。

手記

    • Free レベルのサブスクリプション クォータ:
      • すべての人物グループで 1,000 人。
    • S0 レベルのサブスクリプション クォータ:
      • 個人グループあたり 10,000 人。
      • 1,000,000 人のグループ。
      • すべての人物グループで 100,000,000 人。
POST {endpoint}/face/{apiVersion}/persongroups/{personGroupId}/persons

URI パラメーター

名前 / 必須 型 説明
apiVersion
 path True

string

API バージョン
endpoint
 path True

string

uri

サポートされている Cognitive Services エンドポイント (プロトコルとホスト名。例: https://{resource-name}.cognitiveservices.azure.com)。
personGroupId
 path True

string

コンテナーの ID。

正規表現パターン: ^[a-z0-9-_]+$

要求本文

名前 必須 型 説明
name True

string

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

string

省略可能なユーザー定義データ。 長さは 16K を超えないようにしてください。

応答

名前 型 説明
200 OK

CreatePersonResult

呼び出しが成功すると、作成された新しい personId が返されます。
Other Status Codes

FaceErrorResponse

予期しないエラー応答。

ヘッダー

x-ms-error-code: string

セキュリティ

Ocp-Apim-Subscription-Key

Azure AI Face サブスクリプションの秘密鍵。

型: apiKey
/: header

AADToken

Azure Active Directory OAuth2 フロー

型: oauth2
フロー: accessCode
Authorization URL (承認 URL): https://api.example.com/oauth2/authorize
Token URL (トークン URL): https://api.example.com/oauth2/token

スコープ

名前 説明
https://cognitiveservices.azure.com/.default

例

Create Person in PersonGroup

要求のサンプル

POST {endpoint}/face/v1.2-preview.1/persongroups/your_person_group_id/persons

{
  "name": "your_person_group_person_name",
  "userData": "your_user_data"
}

応答のサンプル

状態コード:
200 
{
  "personId": "25985303-c537-4467-b41d-bdb45cd95ca1"
}

定義

名前 説明
CreatePersonResult

ユーザーの作成の応答。
FaceError

エラー オブジェクト。 Face サービスによって返されるエラー コードとメッセージの詳細については、次のリンクを参照してください: https://aka.ms/face-error-codes-and-messages。
FaceErrorResponse

エラーの詳細を含む応答。

CreatePersonResult

ユーザーの作成の応答。

名前 型 説明
personId

string

ユーザーのユーザー ID。

FaceError

エラー オブジェクト。 Face サービスによって返されるエラー コードとメッセージの詳細については、次のリンクを参照してください: https://aka.ms/face-error-codes-and-messages。

名前 型 説明
code

string

サーバー定義の一連のエラー コードの 1 つ。
message

string

エラーの人間が判読できる表現。

FaceErrorResponse

エラーの詳細を含む応答。

名前 型 説明
error

FaceError

エラー オブジェクト。