このオペレーションを呼び出して、個人に顔画像のグループを追加できます。
個人には最大 20 個の顔画像を含めることができます。
顔画像を追加してから 1 年以内に人間の顔検索インターフェース(カスタム顔検索を参照)を呼び出していない場合、顔画像と顔グループはクリアされます。
リクエスト構文
POST /green/sface/face/add HTTPS|HTTPリクエストヘッダー
このオペレーションでは、共通リクエストヘッダーのみを使用します。 詳細については、「共通リクエストヘッダー」をご参照ください。
リクエストパラメーター
パラメーター | タイプ | 必須 | 例 | 説明 |
clientInfo | JSONObject | いいえ | {"userId":"120234234","userNick":"Mike","userType":"others"} | JSON 形式で ClientInfo 構造体からシリアル化されたクライアント情報。この情報には、クライアントの一意のマシン識別子(UMID)と国際モバイル機器識別子(IMEI)が含まれます。 詳細については、「ClientInfo」をご参照ください。 |
RequestBody
個人と顔画像の情報を指定するには、RequestBody に次のパラメーターも指定する必要があります。
パラメーター | タイプ | 必須 | 例 | 説明 |
bizType | String | いいえ | edu | ビジネスシナリオのタイプ。 |
personId | String | はい | person1 | 対象の個人の ID。 説明 /green/sface/group/persons を呼び出して、すべての個人の ID を取得できます。 |
urls | StringArray | はい | ["http://xxx/xxx01.jpg","http://xxx/xxx02.jpg"] | 追加する顔画像の URL リスト。 |
レスポンスパラメーター
すべての要求に対して JSON 形式のデータが返されます。 共通レスポンスパラメーターの詳細については、「共通レスポンスパラメーター」をご参照ください。 レスポンスの data パラメーターは、ビジネス関連のデータを返すために使用されます。 一般に、このパラメーターの値は JSON 構造体または配列です。
エラーが発生した場合、data パラメーターは空の場合があります。
data フィールドで返されるパラメーターを次の表に示します。
パラメーター | タイプ | 例 | 説明 |
code | Integer | 200 | 返された HTTP ステータスコード。 詳細については、「共通エラーコード」をご参照ください。 |
groupId | StringArray | ["foreign1"] | 個人が属する個人グループの ID。 |
personId | String | person1 | 個人の ID。 |
faceImageItems | JSONArray | 追加された顔の情報。 構造体の詳細については、faceImageItem を参照してください。 |
表 1. faceImageItem
パラメーター | タイプ | 例 | 説明 |
faceId | Float | 23088737259260929 | 認識された顔の ID。 |
success | Boolean | true | 顔が正常に追加されたかどうかを示します。有効な値:
|
例
リクエストの例
POST /green/sface/face/add HTTP/1.1
Common request headers
{
"personId": "person1",
"urls": [
"http://xxx/xxx01.jpg",
"http://xxx/xxx02.jpg"
]
}成功レスポンスの例
{
"msg": "OK",
"code": 200,
"requestId": "36D384DA-8023-4E84-BCFD-0C5581352C16",
"data": {
"code": 200,
"groupIds": [
"foreign1"
],
"personId": "person1",
"faceImageItems": [
{
"success": true,
"faceId": 23088737259260929
}
]
}
}エラーコード
エラーコードの一覧については、サービスエラーコード を参照してください。