VPC環境で利用できます。
指定した人物と顔が類似している人物を類似度順に照会します。照会の結果は人物の統合の候補として利用できます。
参考
サムネイルが登録されておらず顔特徴情報がない人物は、類似人物を照会できません。登録済みの画像基準ではなく、新しい画像を基準に類似人物を確認したい場合は人物の照合をご使用ください。
リクエスト
リクエスト形式を説明します。リクエスト形式は次の通りです。
| メソッド | URI |
|---|---|
| GET | /api/v1/workspaces/{workspace_name}/persons/{person_id}/similar |
リクエストヘッダ
Media Intelligence APIで共通して使用されるヘッダの詳細は、Media Intelligenceのリクエストヘッダをご参照ください。
リクエストパスパラメータ
リクエストパスパラメータの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
workspace_name |
String | Required | ワークスペース名 |
person_id |
String | Required | 基準人物 ID
|
リクエストクエリパラメータ
リクエストクエリパラメータの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
personCount |
Integer | Optional | 照会する類似人物数
|
scoreThreshold |
Integer | Optional | 類似人物と判断するための基準類似度
|
リクエスト例
リクエストのサンプルコードは次の通りです。
curl --location --request GET 'https://mi.apigw.ntruss.com/api/v1/workspaces/my-workspace/persons/1001/similar?personCount=3&scoreThreshold=80' \
--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'
レスポンス
レスポンス形式を説明します。
レスポンスボディ
レスポンスボディの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
code |
String | - | API処理結果コード |
message |
String | - | API処理結果メッセージ |
result |
Object | - | 類似人物照会結果 |
result.personId |
Integer | - | 基準人物 ID |
result.similarPersons |
Array | - | 類似人物リスト: similarPersons
|
similarPersons
similarPersonsの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
personId |
Integer | - | 類似人物の人物 ID |
name |
String | - | 類似人物の名前
|
score |
Number | - | 基準人物との類似度
|
assetCount |
Integer | - | 類似人物が登場するアセット数 |
レスポンスステータスコード
Media Intelligence APIで共通して使用されるレスポンスステータスコードの詳細は、Media Intelligenceのレスポンスステータスコードをご参照ください。
レスポンス例
レスポンスのサンプルコードは次の通りです。
{
"code": "0",
"message": "success",
"result": {
"personId": 1001,
"similarPersons": [
{
"personId": 1002,
"name": null,
"score": 93.42,
"assetCount": 3
},
{
"personId": 1003,
"name": "ホンギルスン",
"score": 82.13,
"assetCount": 1
}
]
}
}