6. 顔検出・比較機能関連インターフェース

6.1 単一の顔画像の検出

インターフェースの説明

インターフェースのURL	https://${ip}:${port}/api/form
リクエストメソッド	POST
リクエストパラメーター形式	FORM
インターフェースの説明	単一の顔画像を検出します。

リクエストパラメーター

パラメーター	型	説明	必須	例
msg_id	string	“769”	Yes
img	file	顔画像	Yes

レスポンスパラメーター

パラメーター	型	説明
code	int	結果コード（0：成功）
data	json	戻りデータ
msg	string	結果の説明

フィールド情報(データ)

パラメーター	型	説明
quality	int	品質スコア 値の範囲：[0,100］
coordinate	string	顔画像内の生体座標（x1,y1,x2,y2は、それぞれ矩形の左端、上端、右端、下端の境界線の座標を示す）
attribute	json	顔属性（詳細は付録Bを参照）

リクエストの例

{
    "msg_id":"769",
    "img":test.jpg
}

レスポンスの例

{
    "code": 0,
    "data": {
        "attribute": {
            "cap_style": "hat_style_type_none",
            "gender_code": "male",
            "glass_style":"glasses_style_type_none",
            "mustache_style": "mustache_style_type_none",
            "st_respirator": "st_respirator_mouth",
            "respirator_color": "color_type_none",
            "st_age": "st_adult",
            "st_age_value": "24.000000",
            "st_expression": "st_calm"
        },
        "quality": 67,
        "coordinate": "56,10,432,678"
    },
    "msg": ""
}

6.2 多数の顔画像の検出

インターフェースの説明

インターフェースのURL	https://${ip}:${port}/api/form
リクエストメソッド	POST
リクエストパラメーター形式	FORM
インターフェースの説明	多数の顔画像を検出します。

リクエストパラメーター

パラメーター	型	説明	必須	例
msg_id	string	“782”	Yes
img	file	顔画像	Yes

レスポンスパラメーター

パラメーター	型	説明
code	int	結果コード（0：成功）
data	json list	戻りデータ
msg	string	結果の説明

フィールド情報(データ)

パラメーター	型	説明
quality	int	品質スコア 値の範囲：[0,100］
coordinate	string	顔画像内の顔座標（x1,y1,x2,y2は、それぞれ矩形の左端、上端、右端、下端の境界線の座標を示す）
img_path	string	顔画像のパス
attribute	json	顔属性（詳細は付録Bを参照）

リクエストの例

{
    "msg_id":"782",
    "img":test.jpg
}

レスポンスの例

{
    "code": 0,
    "data": [
        {
            "attribute": {
                "cap_style": "hat_style_type_none",
                "gender_code": "male",
                "glass_style": "glasses_style_type_none",
                "mustache_style": "mustache_style_type_none",
                "st_respirator": "st_respirator_mouth",
                "respirator_color": "color_type_none",
                "st_age": "st_adult",
                "st_age_value": "24.000000",
                "st_expression": "st_calm"
            },
            "quality": 67,
            "img_path": "tmp/943f95bc-c7df-408f-bae8-c3285557f3ef.jpg",
            "coordinate": "56,10,432,678"
        }
    ],
    "msg": ""
}

6.3 単一の顔情報の検出（Base64エンコード）

インターフェースの説明

インターフェースのURL	https://${ip}:${port}/api/json
リクエストメソッド	POST
リクエストパラメーター形式	JSON
インターフェースの説明	単一の顔情報を検出します。

リクエストパラメーター

パラメーター	型	説明	必須	例
msg_id	string	“779”	Yes
img	json	顔画像	Yes

フィールド情報(img)

パラメーター	型	説明
filename	string	ファイル名
data	string	base64エンコーディングデータ

レスポンスパラメーター

パラメーター	型	説明
code	int	結果コード（0：成功）
data	json	戻りデータ
msg	string	結果の説明

フィールド情報(データ)

パラメーター	型	説明
quality	int	品質スコア 値の範囲：[0,100］
coordinate	string	顔画像内の顔座標（x1,y1,x2,y2は、それぞれ矩形の左端、上端、右端、下端の境界線の座標を示す）
attribute	json	顔属性（詳細は付録Bを参照）

リクエストの例

{
    "msg_id":"779",
    "img": {
        "filename":"haha.jpg",
        "data":"data:image/jpg;base64,/9jxxxxx4EpB/9k="
    }
}

レスポンスの例

{
    "code": 0,
    "data": {
        "attribute": {
            "cap_style": "hat_style_type_none",
            "gender_code": "male",
            "glass_style":"glasses_style_type_none",
            "mustache_style": "mustache_style_type_none",
            "st_respirator": "st_respirator_mouth",
            "respirator_color": "color_type_none",
            "st_age": "st_adult",
            "st_age_value": "24.000000",
            "st_expression": "st_calm"
        },
        "quality": 67,
        "coordinate": "56,10,432,678"
    },
    "msg": ""
}

6.4 1:Nの顔画像の比較

インターフェースの説明

インターフェースのURL	https://${ip}:${port}/api/form
リクエストメソッド	POST
リクエストパラメーター形式	FORM
インターフェースの説明	単一の画像を入力し、指定された顔情報データベースのデータと比較することができます。返される結果は、一致した上位1～50件のレコード、顔座標、画像品質スコア、N名の属性（氏名、年齢、性別、ID）です。

リクエストパラメーター

パラメーター	型	説明	必須	例
msg_id	string	“772”	Yes
threshold	int	比較の閾値 値の範囲：[0,100］、デフォルト値：0	No
img	file	比較する顔画像のフォーマット（xxx.jpg）	Yes
lib_ids	string	比較対象となる顔情報データベース。データベースIDは最大50個まで入力でき、カンマ（,）で区切って入力。	Yes
topk	int	返される上位N個のレコード数 最大で上位50のレコードを返すことができる、値の範囲：[1,50]	No
n_topk	int	返されたレコードの上位N件のうち、n番目のレコード 値の範囲：[1,top k]、デフォルト値：1	No

レスポンスパラメーター

パラメーター	型	説明
code	int	結果コード（0：成功）
data	json	戻りデータ
msg	string	結果の説明

フィールド情報(データ)

パラメーター	型	説明
n_topn	json	N_topkパラメータで決定される、返された上位N件のレコードのn番目の値
topn	json list	返された最初の上位N件のレコード
In_pic	json	オリジナル属性を入力

フィールド情報(n_topn)

パラメーター	型	説明
img_id	string	ランキングをマッピングしたソースデータベースの生体ID
img_path	string	ランキングをマッピングしたソースデータベース内の顔画像のパス
lib_id	int	ランキングをマッピングしたデータベースのID
lib_name	string	ランキングをマッピングしたデータベースの名前
lib_type	int	ランキングをマッピングする顔データベースの種類
ranking	int	ランキング
similarity	int	ランキングをマッピングした顔画像の一致度係数 値の範囲：[0,100]
id	string	ランキングをマッピングしたソースデータベースの人のID
name	string	ランキングをマッピングするソースデータベースの人の名前
gender	string	ランキングをマッピングするソースデータベースの人の性別 0：女性 1：男性
age	string	ランキングをマッピングするソースデータベースの人の年齢
address	string	ランキングをマッピングするソースデータベースの顔情報の住所
wanderdeviceid	string	チャンネル番号をキャプチャーしたランクに対応する未登録者
wandertrigger	string	ランキングに対応する未登録者のキャプチャー時間

フィールド情報(topn)

パラメーター	型	説明
img_id	string	ランキングをマッピングしたソースデータベースの顔のID
img_path	string	ランキングをマッピングしたソースデータベース内の顔画像のパス
lib_id	int	ランキングをマッピングしたデータベースのID
lib_name	string	ランキングをマッピングしたデータベースの名前
lib_type	int	ランキングをマッピングする顔データベースの種類
ranking	int	ランキング
similarity	int	ランキングをマッピングした顔画像の一致度 値の範囲：[0,100]
id	string	ランキングをマッピングしたソースデータベースの人のID
name	string	ランキングをマッピングするソースデータベースの人の名
gender	string	ランキングをマッピングするソースデータベースの人の性別 0：女性 1：男性
age	string	ランキングをマッピングするソースデータベースの人の年齢
address	string	ランキングをマッピングするソースデータベースの顔情報の住所
wanderdeviceid	string	チャンネル番号をキャプチャーしたランクに対応する未登録者
wandertrigger	string	ランキングに対応する未登録者のキャプチャー時間

フィールド情報(In_pic)

パラメーター	型	説明
pos_top	int	入力画像内の入力顔情報の上端座標
pos_bottom	int	入力画像内の入力顔情報の下端座標
pos_left	int	入力画像内の入力顔情報の左座標
pos_right	int	入力画像内の入力顔情報の右座標
quality	int	品質スコア 値の範囲：[0,100］

リクエストの例

Input : files
{
    'img':  name='1542712163434643.jpg'
}
    "lib_ids":"1",
    "threshold":0,
    "topk":3,
    "msg_id":"772",
    "n_topk":1

レスポンスの例

{
    "code": 0,
    "data": {
        "in_pic": {
            "pos_top":255,
            "pos_bottom":400,
            "pos_left":100,
            "pos_right":300,
            "quality":95,
        },
        "n_topn": {
            "img_id": "deab1032-b90a-4d02-9f9f-a1a25907b467",
            "img_path": "img/1_deab1032-b90a-4d02-9f9f-a1a25907b467.jpg",
            "lib_id": 1,
            "lib_name": "blacklib",
            "lib_type": 1,
            "ranking": 1,
            "similarity": 36,
            "id":4259541481123111,
            "name":Mike,
            "gender":0,
            "age":18,
            "address":Address,
            "wanderdeviceid": ""
            "wandertrigger": ""
        },
        "topn": [
            {
               "img_id": "deab1032-b90a-4d02-9f9f-a1a25907b467",
                "img_path": "img/1_deab1032-b90a-4d02-9f9f-a1a25907b467.jpg",
                "lib_id": 1,
                "lib_name": "blacklib",
                "lib_type": 1,
                "ranking": 1,
                "similarity": 36,
                "id":4259541481123111,
                "name":Mike,
                "gender":0,
                "age":18,
                "address":Address1
                "wanderdeviceid": ""
                "wandertrigger": ""
            },
            {
                "img_id": "a068b878-95cb-4aa7-aba6-af95cd5b36b3",
                "img_path": "img/1_a068b878-95cb-4aa7-aba6-af95cd5b36b3.jpg",
                "lib_id": 1,
                "lib_name": "blacklib",
                "lib_type": 1,
                "ranking": 2,
                "similarity": 33,
                "id":4259541481123111,
                "name":John,
                "gender":0,
                "age":18,
                "address":Address2
                "wanderdeviceid": ""
                "wandertrigger": ""
            },
            {
                "address": "******"
                "age": ""
                "gender": ""
                "id": "******"
                "img_id": "v214_1626681187_1214_0"
                "img_path": ""
                "lib_id": 2147483647
                "lib_name": ""
                "lib_type": 0
                "name": ""
                "ranking": 1
                "similarity": 40
                "wanderdeviceid": "111"
                "wandertrigger": "2021-07-19 15:53:07"
            }
        ]
    },
    "msg": ""
}

6.5 1:1 顔画像の比較

インターフェースの説明

インターフェースのURL	https://${ip}:${port}/api/form
リクエストメソッド	POST
リクエストパラメーター形式	FORM
インターフェースの説明	1つの顔情報と1つの顔画像を比較します。

リクエストパラメーター

パラメーター	型	説明	必須	例
msg_id	string	“771”	Yes
img_1	file	最初に入力された顔情報	Yes
img_2	file	2番目に入力された顔情報	Yes

レスポンスパラメーター

パラメーター	型	説明
code	int	結果コード（0：成功）
data	json	戻りデータ
msg	string	結果の説明

フィールド情報(データ)

パラメーター	型	説明
FaceImg1to1Rsp_Score	int	2つの顔の一致度

リクエストの例

Input : files
{
    "msg_id"："771"
    'img_1': name='1542712163434643.jpg'
    'img_2': name='54646644544635.jpg'
}

レスポンスの例

{
    "code": 0,
    "data": {
        "FaceImg1to1Rsp_Score": 30
    },
    "msg": ""
}

6.6 1:Nの顔画像の比較（Base64エンコード）

インターフェースの説明

インターフェースのURL	https://${ip}:${port}/api/json
リクエストメソッド	POST
リクエストパラメーター形式	JSON
インターフェースの説明	単一の画像を入力し、指定された顔データベースのデータと比較することができます。返される結果は、一致した上位1～50件のレコード、生体座標、画像品質スコア、N名の属性（氏名、年齢、性別、ID）です。

リクエストパラメーター

パラメーター	型	説明	必須	例
msg_id	string	“780”	Yes
threshold	int	比較閾値 値の範囲：[0,100］、デフォルト値：0	No
img	json	比較対象となる顔画像	Yes
lib_ids	string	比較対象となる顔情報データベース データベースIDは最大50個まで入力でき、カンマ（,）で区切って入力します。	Yes
topk	int	返される上位Nレコードの数 最大で上位50レコードを返すことができる、値の範囲：[1,50]、デフォルト値：1	No
n_topk	int	返されたレコードの上位N件のうち、n番目のレコード 値の範囲：[1,top k]、デフォルト値：1	No

フィールド情報(img)

パラメーター	型	説明
filename	string	ファイル名
data	string	base64エンコーディングデータ

レスポンスパラメーター

パラメーター	型	説明
code	int	結果コード（0：成功）
data	json	戻りデータ
msg	string	結果の説明

フィールド情報(データ)

パラメーター	型	説明
n_topn	json	N_topkパラメータで決定される、返された上位N件のレコードのn番目の値
topn	json list	返された最初の上位N件のレコード
In_pic	json	オリジナル属性を入力

フィールド情報(n_topn)

パラメーター	型	説明
img_id	string	ランキングをマッピングしたソースデータベースの顔のID
img_path	string	ランキングをマッピングしたソースデータベース内の顔画像のパス
lib_id	int	ランキングをマッピングしたデータベースのID
lib_name	string	ランキングをマッピングしたデータベースの名前
lib_type	int	ランキングをマッピングする顔データベースの種類
ranking	int	ランキング
similarity	int	ランキングをマッピングした顔画像の一致度係数 値の範囲：[0,100]
id	string	ランキングをマッピングしたソースデータベースの人のID
name	string	ランキングをマッピングするソースデータベースの人の名前
gender	string	ランキングをマッピングするソースデータベースの人の性別 0：女性 1：男性
age	string	ランキングをマッピングするソースデータベースの人の年齢
address	string	ランキングをマッピングするソースデータベースの顔情報の住所

フィールド情報(topn)

パラメーター	型	説明
img_id	string	ランキングをマッピングしたソースデータベースの生体ID
img_path	string	ランキングをマッピングしたソースデータベース内の顔画像のパス
lib_id	int	ランキングをマッピングしたデータベースのID
lib_name	string	ランキングをマッピングしたデータベースの名前
lib_type	int	ランキングをマッピングする顔データベースの種類
ranking	int	ランキング
similarity	int	ランキングをマッピングした顔画像の一致度係数 値の範囲：[0,100]
id	string	ランキングをマッピングしたソースデータベースの人のID
name	string	ランキングをマッピングするソースデータベースの人の名前
gender	string	ランキングをマッピングするソースデータベースの人の性別 0：女性 1：男性
age	string	ランキングをマッピングするソースデータベースの人の年齢
address	string	ランキングをマッピングするソースデータベースの顔情報の住所

フィールド情報(In_pic)

パラメーター	型	説明
pos_top	int	入力画像内の入力顔情報の上端座標
pos_bottom	int	入力画像内の入力顔情報の下端座標
pos_left	int	入力画像内の入力顔情報の左座標
pos_right	int	入力画像内の入力顔情報の右座標
quality	int	品質スコア 値の範囲：[0,100］

リクエストの例

Input : files
{
    "msg_id":"780",
    "lib_ids":"1",
    "threshold":0,
    "topk":3,
    "n_topk":1,
    "img": {
    	"filename":"haha.jpg",
    	"data":"data:image/jpg;base64,/9jxxxxx4EpB/9k="
    }
}

レスポンスの例

{
    "code": 0,
    "data": {
        "in_pic": {
            "pos_top":255,
            "pos_bottom":400,
            "pos_left":100,
            "pos_right":300,
            "quality":95,
        },
        "n_topn": {
            "img_id": "deab1032-b90a-4d02-9f9f-a1a25907b467",
            "img_path": "img/1_deab1032-b90a-4d02-9f9f-a1a25907b467.jpg",
            "lib_id": 1,
            "lib_name": "blacklib",
            "lib_type": 1,
            "ranking": 1,
            "similarity": 36,
            "id":4259541481123111,
            "name":zhang,
            "gender":0,
            "age":18,
            "address":add,
        },
        "topn": [
            {
               "img_id": "deab1032-b90a-4d02-9f9f-a1a25907b467",
                "img_path": "img/1_deab1032-b90a-4d02-9f9f-a1a25907b467.jpg",
                "lib_id": 1,
                "lib_name": "blacklib",
                "lib_type": 1,
                "ranking": 1,
                "similarity": 36,
                "id":4259541481123111,
                "name":zhang,
                "gender":0,
                "age":18,
                "address":add1
            },
            {
                "img_id": "a068b878-95cb-4aa7-aba6-af95cd5b36b3",
                "img_path": "img/1_a068b878-95cb-4aa7-aba6-af95cd5b36b3.jpg",
                "lib_id": 1,
                "lib_name": "blacklib",
                "lib_type": 1,
                "ranking": 2,
                "similarity": 33,
                "id":4259541481123111,
                "name":si,
                "gender":0,
                "age":18,
                "address":add2
            },
            {
                "img_id": "fb7dcd8b-bfee-4e47-b7cd-5cc4e6d09d60",
                "img_path": "img/1_fb7dcd8b-bfee-4e47-b7cd-5cc4e6d09d60.jpg",
                "lib_id": 1,
                "lib_name": "blacklib",
                "lib_type": 1,
                "ranking": 3,
                "similarity": 31,
                "pos_top":255,
                "pos_bottom":400,
                "pos_left":100,
                "pos_right":300,
                "quality":95,
                "id":4259541481123111,
                "name":wu,
                "gender":0,
                "age":18,
                "address":add3
            }
        ]
    },
    "msg": ""
}

6.7 1:1の顔画像の比較（Base64エンコード）

インターフェースの説明

インターフェースのURL	https://${ip}:${port}/api/json
リクエストメソッド	POST
リクエストパラメーター形式	JSON
インターフェースの説明	1つの顔情報と1つの顔画像を比較します。

リクエストパラメーター

パラメーター	型	説明	必須	例
msg_id	string	“781”	Yes
img_1	json	最初に入力された顔画像	Yes
img_2	json	２番目に入力された顔画像	Yes

フィールド情報(img)

パラメーター	型	説明
filename	string	ファイル名
data	string	base64エンコーディングデータ

レスポンスパラメーター

パラメーター	型	説明
code	int	結果コード（0：成功）
data	json	戻りデータ
msg	string	結果の説明

フィールド情報(データ)

パラメーター	型	説明
FaceImg1to1Rsp_Score	int	2つの顔の一致度

リクエストの例

Input : files
{
    "msg_id"："781",
    "img_1": {
    	"filename":"haha1.jpg",
    	"data":"data:image/jpg;base64,/9jxxxxx4EpB/9k="
    },
    "img_2": {
    	"filename":"haha2.jpg",
    	"data":"data:image/jpg;base64,/9jxxxxx4EpB/9k="
    }
}

レスポンスの例

{
    "code": 0,
    "data": {
        "FaceImg1to1Rsp_Score": 30
    },
    "msg": ""
}