查询指定人物名单中的人物和特征
1. 请求
1.1 请求地址
区域 | 请求地址 |
---|---|
国内 | https://api.open.tuputech.com/v3/management/person-library/feature/search/<secretId> |
提示
<secretId>
需替换为您的应用 SID
,请联系客户经理为您开通及配置。关于 SID
详见 常见问题(FAQ)。
1.2 请求方法
POST
1.3 请求头
请求头名称 | 取值 | 是否必需 | 示例 | 说明 |
---|---|---|---|---|
Content-Type | application/json | 是 | Content-Type: application/json | 请求数据类型为 JSON |
X-API-Key | <API Key> | 是 | X-API-Key: <API Key> | API Key 用于接口鉴权。请访问控制台 - 数字证书 获取 API Key |
1.4 请求参数
参数名称 | 类型 | 是否必需 | 说明 |
---|---|---|---|
personLibraryId | String | 是 | 人物名单 id |
timestamp | Int | 否 | 当前服务器的 Unix 时间戳。 当前已废弃,仅保持兼容(采用该鉴权方式的调用不受影响)。新接入请使用 API Key 接口鉴权 |
nonce | Float | 否 | 随机数(建议使用 Unix 时间戳或若干位随机整数)。 当前已废弃,仅保持兼容(采用该鉴权方式的调用不受影响)。新接入请使用 API Key 接口鉴权 |
signature | String | 否 |
|
1.5 请求示例
{
"personLibraryId": "<personLibraryId>",
"timestamp": "<timestamp>",
"nonce": "<nonce>",
"signature": "<signature>",
}
2. 响应
2.1 响应内容
参数名称 | 类型 | 说明 |
---|---|---|
json | String | 响应内容 JSON 转义后的字符串 |
signature | String | 响应内容签名 |
2.2 响应参数
参数名称 | 类型 | 是否可能为空 | 说明 |
---|---|---|---|
code | Int | 否 | 状态码 |
nonce | Float | 否 | 随机数(建议使用 Unix 时间戳或若干位随机整数) |
message | String | 否 | 相关信息 |
timestamp | Int | 否 | 时间戳 |
person | Array<Person> | 否 | 名单信息,详见 Person 说明 |
Person 说明
参数名称 | 类型 | 是否可能为空 | 说明 |
---|---|---|---|
personId | String | 否 | 人物 id |
features | Array<Feature> | 否 | 特征信息,详见 Feature 参数说明 |
Feature 参数说明
参数名称 | 类型 | 是否可能为空 | 说明 |
---|---|---|---|
feature_id | String | 否 | 特征 ID |
person_id | String | 否 | 人物 id |
path | String | 否 | 图片 uri |
location | String | 否 | 人脸方框坐标以图片左上角为原点,分别是 [左上角坐标 ,右上角坐标 ,右下角坐标 ,左下角坐标 ], 坐标值是相对于图片大小的百分比形式 |
status | String | 否 | 特征上下线状态; 1 : 已上线,2 : 已下线 |
feature | Array[Int] | 否 | 特征值 |
threshold | Array[Int] | 否 | 特征阈值 |
2.3 响应示例
{
"code": 0,
"message": "success",
"nonce": 0.865335013001561,
"person": [
{
"person_id": "xxx",
"features": [
{
"feature_id": "xxx",
"person_id": "64c76b89b37935001de659ea",
"origin_path": "xxx.png",
"path": "xxx.png",
"location": [
[
0.36888570255703396,
0.41559216380119324
],
[
0.7482205496893989,
0.41559216380119324
],
[
0.7482205496893989,
0.6865880489349365
],
[
0.36888570255703396,
0.6865880489349365
]
],
"feature": [
-0.017939381,
0.07351213
],
"status": 1,
"threshold": [
0.1,
0.6
]
}
]
}
],
"timestamp": 1691736228
}
3. 更新日志
日期 | 说明 |
---|---|
2025-06-17 | 新增 API Key 接口鉴权方式,简化接口鉴权。废弃签名鉴权方式,仅保持兼容(采用签名鉴权方式的调用不受影响) |