[API] Create Person
http://localhost:8800/face/person/create
描述
建立人員資料,經由Local API Server回傳的person_id代表該人員ID,參數分為group_id、face_id、feature_list,都是可選擇性加入,一個人員可加入多張人臉(face_id或feature_list)及群組(group_id),一個人員最多可加入10個(face_id或feature_list)。建立人員數量上限由序號決定。(如果同時加face_id與feature_list,Server優先選擇face_id,face_id與feature_list只能擇一加入) - 2016/01/07-更新
參數
"face_id"
- 欲加入該人員的人臉(face_id),用逗點隔開,可一次加入多個。(可選擇)
"group_id"
- 欲將該人員加入的群組(group_id),用逗點隔開,可一次加入多個。(可選擇)
"feature_list"
- (JSON格式的字串)(可選擇) - 2016/01/07
{
"features":[{
"face_id": 42780824c8ff4906913c095cbc4941f2,
"featureData": BASE64_STRING
}]
}
回傳值
"namespace"
- Local API Server尚未開放此功能。
"added_face_count"
- 成功一次將多張人臉(face_id)加入該人員(person_id)的數量。
"added_group_count"
- 成功一次將人員(person_id)加入多個群組(group_id)的數量。
"person_id"
- 由Local API Server回傳一組person_id代表這個人員ID(唯一)。
"state"
- 回傳狀態
- STATE_SUCCESSFUL 執行成功
- STATE_FAIL 尚未分類的錯誤
- STATE_REQUEST_METHOD_ERROR Request方式不是使用POST
- STATE_PROCESS_ERROR 建立人員person_id發生錯誤
JSON格式
{
"namespace":"default",
"added_face_count":1,
"added_group_count":0,
"person_id":"549815412873ba1170394bcc",
"state":1000
}
[API] Delete Person
http://localhost:8800/face/person/delete
描述
刪除人員資料,將人員(person_id)的相關資料從Local API Server上刪除。
參數
"person_id"
- 欲刪除的人員(person_id),用逗點隔開,可一次刪除多個。
回傳值
"namespace"
- Local API Server尚未開放此功能。
"delete_count"
- 成功一次將多個人員(person_id)刪除的數量。
"state"
- 回傳狀態
- STATE_SUCCESSFUL 執行成功
- STATE_FAIL 尚未分類的錯誤
- STATE_REQUEST_METHOD_ERROR Request方式不是使用POST
- STATE_PARAMETER_ERROR Request少給參數或給錯參數
- STATE_PROCESS_ERROR 刪除人員person_id發生錯誤
JSON格式
{
"namespace":"default",
"delete_count":1,
"state":1000
}
[API] Add Face to Person
http://localhost:8800/face/person/update/add
描述
加入新的人臉(face_id或feature_list)至已存在的人員資料(person_id),可一次加入多張人臉(face_id或feature_list),一個人員最多可加入10個(face_id或feature_list)。(如果同時加face_id與feature_list,Server優先選擇face_id,face_id與feature_list只能擇一加入) - 2016/01/07 - 更新
參數
"person_id"
- 欲新增人臉的person_id。
"face_id"
- 欲加入該人員的人臉(face_id),用逗點隔開,可一次加入多個。(可選擇)
"feature_list"
- (JSON格式的字串)(可選擇) - 2016/01/07 - 更新
{
"features":[{
"face_id": 42780824c8ff4906913c095cbc4941f2,
"featureData": BASE64_STRING
}]
}
回傳值
"namespace"
- Local API Server尚未開放此功能。
"added_face_count"
- 成功一次將多個人臉(face_id)加入該人員(person_id)的數量。
"state"
- 回傳狀態
- STATE_SUCCESSFUL 執行成功
- STATE_FAIL 尚未分類的錯誤
- STATE_REQUEST_METHOD_ERROR Request方式不是使用POST
- STATE_PARAMETER_ERROR Request少給參數或給錯參數
- STATE_PROCESS_ERROR 新增人臉face_id至person_id發生錯誤
JSON格式
{
"added_face_count":1,
"namespace":"default",
"state":1000
}
[API] Remove Face from Person
http://localhost:8800/face/person/update/remove
描述
移除人員(person_id)中指定的人臉(face_id),用逗點隔開,可一次移除多張人臉(face_id)。
參數
"person_id"
- 欲進行操作的人員(person_id)。
"face_id"
- 欲移除的人臉(face_id),用逗點隔開,可一次移除多個。
回傳值
"namespace"
- Local API Server尚未開放此功能。
"removed_face_count"
- 成功一次將多個face_id移除的數量。
"state"
- 回傳狀態
- STATE_SUCCESSFUL 執行成功
- STATE_FAIL 尚未分類的錯誤
- STATE_REQUEST_METHOD_ERROR Request方式不是使用POST
- STATE_PARAMETER_ERROR Request少給參數或給錯參數
- STATE_PROCESS_ERROR 從人員person_id移除人臉face_id發生錯誤
JSON格式
{
"removed_face_count":1,
"namespace":"default",
"state":1000
}
[API] Get Person Information
http://localhost:8800/face/person/info/get
描述
查詢人員(person_id)的資料,包含已加入的人臉(face_id)及已歸類的群組(group_id)。
參數
"person_id"
- 欲查詢的person_id。
回傳值
"namespace"
- Local API Server尚未開放此功能。
"faces"
- 該人員(person_id)已加入的人臉(face_id)。
"groups"
- 該人員(person_id)已加入的群組(group_id)。
"person_id"
- 該筆資料查詢的人員(person_id)。
"state"
- 回傳狀態
- STATE_SUCCESSFUL 執行成功
- STATE_FAIL 尚未分類的錯誤
- STATE_REQUEST_METHOD_ERROR Request方式不是使用POST
- STATE_PARAMETER_ERROR Request少給參數或給錯參數
- STATE_PROCESS_ERROR 查詢人員資料時發生錯誤
JSON格式
{
"faces":["2219a13f5id892219025q5d8"],
"groups":["6819a13f5id892219025q557"],
"person_id":"549815412873ba1170394bcc",
"namespace":"default",
"state":1000
}
[API] Query Person List
http://localhost:8800/face/query/person_list
描述
查詢Local API Server中所有的人員(person_id)列表資訊。
參數
回傳值
"namespace"
- Local API Server尚未開放此功能。
"persons"
- 已儲存於Local API Server中的人員(person_id)列表。
"state"
- 回傳狀態
- STATE_SUCCESSFUL 執行成功
- STATE_FAIL 尚未分類的錯誤
- STATE_REQUEST_METHOD_ERROR Request方式不是使用POST或GET
- STATE_PARAMETER_ERROR Request少給參數或給錯參數
- STATE_PROCESS_ERROR 查詢所有人員資料發生錯誤
JSON格式
{
"namespace":"default",
"persons":["54aca13f559ad2219025a5a8","54aca3fe559ad2219025a5a9"],
"state":1000
}
[API] Person Verify
http://localhost:8800/face/person/verify
描述
人員辨識,比對該人臉是否為該人員的信心程度。(如果同時加face_id與feature_data,Server優先選擇face_id,face_id與feature_data只能擇一加入) - 2016/01/07 - 更新
參數
"person_id"
- 欲比對的人員(person_id)。
"face_id"
- 欲比對的人臉(face_id)。(可選擇)
"feature_data"
- (Base64的字串)(可選擇) - 2016/01/07 - 更新
回傳值
"namespace"
- Local API Server尚未開放此功能。
"session_id"
- Local API Server尚未開放此功能。
"confidence"
- 該人臉face_id與人員person_id的相似分數。
"state"
- 回傳狀態
- STATE_SUCCESSFUL 執行成功
- STATE_FAIL 尚未分類的錯誤
- STATE_REQUEST_METHOD_ERROR Request方式不是使用POST
- STATE_PARAMETER_ERROR Request少給參數或給錯參數
- STATE_PROCESS_ERROR 人臉與人員比對時發生錯誤
JSON格式
{
"namespace":"default",
"session_id":"default",
"confidence":589,
"state":1000
}
[API] Image Person Verify
http://localhost:8800/face/person/image/verify
描述
上傳影像,並調用人臉偵測後直接人員辨識。可省略多次的API http request。
參數
"image"
- 上傳欲比對的圖片。
"person_id"
- 欲比對的人員列表,用逗點隔開,可一次比對多個。
回傳值
"featureScore"
- 人臉特徵信心值,供參考人臉影像品質,分數越高後續辨識結果越值得信賴,反之,誤判較高。
"age"
- 預估年齡,範圍介於1~99之間。因影像品質關係,辨識的結果誤差正負5~10歲。
"gender"
- 預估性別,男生為1,女生為0。
"expression"
- 預估表情(neutral、happiness、surprise、anger、sadness共5種)。
"angleLeftRight"
- 預估人臉左右角度。
"angleRoll"
- 預估人臉旋轉角度。
"angleUpDown"
- 預估人臉上下角度。
"detectPos"
- 人臉於影像中的區域,影像座標系的(0,0)於左上角。
"points"
- 人臉特徵位置,兩眼、鼻子及嘴巴位置,影像座標系的(0,0)於左上角。
"persons"
- 相似人員列表。
"person_id"
- 相似人員 person_id。
"similarity"
- 與該人員的相似度。
"state"
- 回傳狀態
- STATE_SUCCESSFUL 執行成功
- STATE_FAIL 尚未分類的錯誤
- STATE_REQUEST_METHOD_ERROR Request方式不是使用POST
- STATE_PARAMETER_ERROR Request少給參數或給錯參數
- STATE_PROCESS_ERROR 人臉偵測錯誤
JSON格式
{
"faces": [{
"age": 28,
"angleLeftRight": 1,
"angleRoll": 7,
"angleUpDown": 3,
"detectPos": [
[139, 383],
[907, 383],
[907, 1151],
[139, 1151]
],
"expression": "neutral",
"featureScore": 680,
"gender": 1,
"points": {
"leftEye": {
"x": -1,
"y": -1
},
"mouth": {
"x": -1,
"y": -1
},
"nose": {
"x": -1,
"y": -1
},
"rightEye": {
"x": -1,
"y": -1
}
},
"persons": [{
"person_id": "54cf41e30441ae19cc756ecd",
"similarity": 700
}]
}],
"state": 1000
}