[API] Create Group
http://localhost:8800/face/group/create
描述
建立群組資料,經由Local API Server回傳的group_id代表該群組ID,資料組成包括人員(person_id),一個群組可加入多個人員(person_id)。
參數
"person_id"
- 欲加入群組的人員(person_id),用逗點隔開,可一次加入多個。(可選擇)
回傳值
"namespace"
- Local API Server尚未開放此功能。
"added_person_count"
- 成功一次將多個人員(person_id)加入該群組(group_id)的數量。
"group_id"
- 得到一組group_id代表這個群組。
"state"
- 回傳狀態
- STATE_SUCCESSFUL 執行成功
- STATE_FAIL 尚未分類的錯誤
- STATE_REQUEST_METHOD_ERROR Request方式不是使用POST
- STATE_PARAMETER_ERROR Request少給參數或給錯參數
- STATE_PROCESS_ERROR 建立群組group_id發生錯誤
JSON格式
{
"added_person_count":1,
"group_id":"549aa998a7a57d145ce67609",
"namespace":"default",
"state":1000
}
[API] Delete Group
http://localhost:8800/face/group/delete
描述
刪除群組,將群組(group_id)的相關資料從Local API Server上刪除。
參數
"group_id"
- 欲刪除的群組(group_id),用逗點隔開,可一次刪除多個。
回傳值
"namespace"
- Local API Server尚未開放此功能。
"delete_count"
- 成功一次將多個群組(group_id)刪除的數量。
"state"
- 回傳狀態
- STATE_SUCCESSFUL 執行成功
- STATE_FAIL 尚未分類的錯誤
- STATE_REQUEST_METHOD_ERROR Request方式不是使用POST
- STATE_PARAMETER_ERROR Request少給參數或給錯參數
- STATE_PROCESS_ERROR 刪除群組group_id發生錯誤
JSON格式
{
"namespace":"default",
"delete_count":1,
"state":1000
}
[API] Add Person to Group
http://localhost:8800/face/group/update/add
描述
新增人員(person_id)至指定群組(group_id),可一次加入多個人員(person_id)。
參數
"group_id"
- 欲新增人員的群組(group_id)。
"person_id"
- 欲加入該群組的人員(person_id),用逗點隔開,可一次加入多個。
回傳值
"namespace"
- Local API Server尚未開放此功能。
"added_person_count"
- 成功一次將多個人員(person_id)加入此群組(group_id)的數量。
"state"
- 回傳狀態
- STATE_SUCCESSFUL 執行成功
- STATE_FAIL 尚未分類的錯誤
- STATE_REQUEST_METHOD_ERROR Request方式不是使用POST
- STATE_PARAMETER_ERROR Request少給參數或給錯參數
- STATE_PROCESS_ERROR 新增人員person_id至群組group_id發生錯誤
JSON格式
{
"added_person_count":1,
"namespace":"default",
"state":1000
}
[API] Remove Person from Group
http://localhost:8800/face/group/update/remove
描述
將群組(group_id)上的人員(person_id)資料移除,可一次移除多個人員(person_id)。
參數
"group_id"
- 欲刪除人員的group_id。
"person_id"
- 欲移除該群組的人員(person_id),用逗點隔開,可一次移除多個。
回傳值
"namespace"
- Local API Server尚未開放此功能。
"removed_person_count"
- 成功一次將多個person_id移除的數量。
"state"
- 回傳狀態
- STATE_SUCCESSFUL 執行成功
- STATE_FAIL 尚未分類的錯誤
- STATE_REQUEST_METHOD_ERROR Request方式不是使用POST
- STATE_PARAMETER_ERROR Request少給參數或給錯參數
- STATE_PROCESS_ERROR 從群組group_id移除人員person_id發生錯誤
JSON格式
{
"removed_person_count":1,
"namespace":"default",
"state":1000
}
[API] Get Group Information
http://localhost:8800/face/group/info/get
描述
查詢指定群組(group_id)的資料,包含已建立的人員(person_id)。
參數
"group_id"
- 欲查詢的群組(group_id)。
回傳值
"namespace"
- Local API Server尚未開放此功能。
"persons"
- 該群組(group_id)已建立的人員(person_id)資訊。
"group_id"
- 被查詢的群組(group_id)。
"state"
- 回傳狀態
- STATE_SUCCESSFUL 執行成功
- STATE_FAIL 尚未分類的錯誤
- STATE_REQUEST_METHOD_ERROR Request方式不是使用POST
- STATE_PARAMETER_ERROR Request少給參數或給錯參數
- STATE_PROCESS_ERROR 查詢群組資料時發生錯誤
JSON格式
{
"group_id":"54c09970984cd31cd44ff91f",
"namespace":"default",
"persons":[
{"person_id":"54c0997d984cd31cd44ff920"},
{"person_id":"54c0a40c984cd31cd44ff922"}],
"state":1000
}
[API] Query Group List
http://localhost:8800/face/query/group_list
描述
查詢Local API Server中所有的群組(group_id)列表資訊。
參數
回傳值
"namespace"
- Local API Server尚未開放此功能。
"groups"
- 已儲存於Local API Server中的群組(group_id)列表。
"state"
- 回傳狀態
- STATE_SUCCESSFUL 執行成功
- STATE_FAIL 尚未分類的錯誤
- STATE_REQUEST_METHOD_ERROR Request方式不是使用POST
- STATE_PARAMETER_ERROR Request少給參數或給錯參數
- STATE_PROCESS_ERROR 查詢所有群組資料發生錯誤
JSON格式
{
"namespace":"default",
"groups":["54aca13f559ad2219025a5a8","54aca3fe559ad2219025a5a9"],
"state":1000
}
[API] Group Identify
http://localhost:8800/face/group/identify
描述
人臉辨識,比對該人臉(face_id或feature_data)與群組(group_id)的所有人員相似程度。(如果同時加face_id與feature_data,Server優先選擇face_id,face_id與feature_data只能擇一加入) - 2016/01/07 - 更新
參數
"group_id"
- 欲比對的群組group_id。
"face_id"
- 欲比對的人員face_id。(可選擇)
"feature_data"
- (Base64的字串)(可選擇) - 2016/01/07 - 更新
回傳值
"namespace"
- Local API Server尚未開放此功能。
"session_id"
- Local API Server尚未開放此功能。
"similarity"
- 該人員(face_id)與群組(group_id)中某個人員(person_id)的相似分數。
"person_id"
- 群組某個人員(person_id)。
"persons"
- 與群組所有人員的比對資料
"state"
- 回傳狀態
- STATE_SUCCESSFUL 執行成功
- STATE_FAIL 尚未分類的錯誤
- STATE_REQUEST_METHOD_ERROR Request方式不是使用POST
- STATE_PARAMETER_ERROR Request少給參數或給錯參數
- STATE_PROCESS_ERROR 人員與群組比對時發生錯誤
JSON格式
{
"namespace":"default",
"persons":[{
"person_id":"54cf41e30441ae19cc756ecd",
"similarity":619}],
"session_id":"",
"state":1000
}
[API] Group Identify Clear Catch
http://localhost:8800/face/group/buffer/clear
描述
如果有重新新增Person至Group,或Import Feature Data至Group時,必須調用此API,Local API Server將會重載Group相關人員Feature。
參數
"group_id"
- 欲重載的群組group_id。(沒填寫則全部Group重載)
回傳值
"namespace"
- Local API Server尚未開放此功能。
"state"
- 回傳狀態
- STATE_SUCCESSFUL 執行成功
- STATE_FAIL 尚未分類的錯誤
```