人物の照合

VPC環境で利用できます。

アップロードしたサムネイル画像を基準に、ワークスペースに登録されている人物の中から顔が類似している人物を推薦します。人物を新規登録する前に同一人物が既に登録されているか確認したり、匿名人物に名前を指定する際に候補人物を確認する用途として活用できます。

リクエストの前に人物サムネイル Presigned URLの発行で発行された URLに画像をアップロードし、人物サムネイルアップロード状態の照会でアップロード完了の有無をご確認ください。

参考

推薦人物リストが空の配列で返された場合、基準類似度以上で一致する登録人物がないことを意味し、人物の登録を行うことができます。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド	URI
POST	/api/v1/workspaces/{workspace_name}/persons/recommend-by-thumbnail

リクエストヘッダ

Media Intelligence APIで共通して使用されるヘッダの詳細は、Media Intelligenceのリクエストヘッダをご参照ください。

リクエストパスパラメータ

リクエストパスパラメータの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`workspace_name`	String	Required	ワークスペース名

リクエストボディ

リクエストボディの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`thumbnailKey`	String	Required	アップロードされたサムネイルのキー値人物サムネイル Presigned URLの発行で発行したキーアップロード後24時間で期限切れ <例> `persons/thumbnails/hong.jpg`
`personCount`	Integer	Optional	照会する推薦人物数 1~10 (デフォルト: 3)
`scoreThreshold`	Integer	Optional	類似人物と判断するための基準類似度 80~100 (デフォルト: 80)

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request POST 'https://mi.apigw.ntruss.com/api/v1/workspaces/my-workspace/persons/recommend-by-thumbnail' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json' \
--data '{
  "thumbnailKey": "persons/thumbnails/hong.jpg",
  "personCount": 3,
  "scoreThreshold": 80
}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`code`	String	-	API処理結果コード
`message`	String	-	API処理結果メッセージ
`result`	Object	-	人物照合の結果
`result.thumbnailKey`	String	-	リクエストで使用したサムネイルキー
`result.recommendPersons`	Array	-	推薦人物リスト: recommendPersons 類似度の降順条件に合致する人物がいない場合は空の配列
`result.totalRecommendPersons`	Integer	-	基準類似度以上の候補人物の総数

`recommendPersons`

recommendPersonsの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`personId`	Integer	-	推薦人物の人物 ID
`name`	String	-	推薦人物の名前匿名人物は nullとして表示
`score`	Number	-	リクエストされたサムネイルとの類似度 0~100
`assetCount`	Integer	-	推薦人物が登場するアセットの数

レスポンスステータスコード

Media Intelligence APIで共通して使用されるレスポンスステータスコードの詳細は、Media Intelligenceのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
  "code": "0",
  "message": "success",
  "result": {
    "thumbnailKey": "persons/thumbnails/hong.jpg",
    "recommendPersons": [
      {
        "personId": 1001,
        "name": "ホンギルドン",
        "score": 93.42,
        "assetCount": 12
      }
    ],
    "totalRecommendPersons": 1
  }
}