注意:
个体创建
接口描述
接口请求域名:https://recognition.image.myqcloud.com/face/newperson
本接口(newperson)用于创建一个 person,并将 person 放置到 group_ids 指定的组当中,不存在的 group_id 会自动创建。
注意:
- 本接口支持 HTTPS 协议,如果您现在使用的是 HTTP 协议,为了保障您的数据安全,请切换至 HTTPS。
输入参数
请求头 header
参数名 | 必选 | 值 | 描述 |
---|---|---|---|
host | 是 | recognition.image.myqcloud.com | 腾讯云人脸识别服务器域名 |
content-length | 否 | 包体总长度 | 整个请求包体内容的总长度,单位:字节(Byte) |
content-type | 是 | application/json 或 multipart/form-data | 据不同接口选择: 1. 使用 application/json 格式,参数为 url,其值为图片的 url ; 2. 使用 multipart/form-data 格式,参数为 image,其值为图片的二进制内容。 |
authorization | 是 | 鉴权签名 | 多次有效签名,用于鉴权,生成方式见 鉴权签名方法 |
注意:选择 multipart/form-data,请使用 HTTP 框架/库推荐的方式设置请求的 content-type,不推荐直接调用 setHeader 等方法设置,否则可能导致 boundary 缺失引起请求失败。
请求参数
使用 application/json 格式,参数选择 url ;使用 multipart/form-data 格式,参数选择 image。
参数名 | 必选 | 类型 | 参数说明 |
---|---|---|---|
AppId | 是 | String | 接入项目的唯一标识,可在 账号信息 或 云 API 密钥 中查看 |
group_ids | 是 | Array(String) | 加入到组的列表 |
person_id | 是 | String | 指定的个体 ID |
image | 否 | binary | 图片内容 |
url | 否 | String | 图片的 url、image提供一个即可;如果都提供,只使用 url |
person_name | 否 | String | 名字 |
tag | 否 | String | 备注信息 |
输出参数
字段 | 类型 | 说明 |
---|---|---|
data.session_id | String | 相应请求的 session 标识符 |
data.suc_group | Int | 成功被加入的 group 数量 |
data.suc_face | Int | 成功加入的 face 数量 |
data.person_id | String | 相应 person 的 ID |
data.face_id | String | 创建所用图片生成的 face_id |
data.group_ids | Array(string) | 加入成功的组 ID |
code | Int | 返回码 |
message | String | 返回错误消息 |
示例
输入示例
使用 url 的输入示例:
POST /face/newperson HTTP/1.1
Authorization: FCHXdPTEwMDAwMzc5Jms9QUtJRGVRZDBrRU1yM2J4ZjhRckJi==
Host: recognition.image.myqcloud.com
Content-Length: 187
Content-Type: application/json
{
"appid":"123456",
"group_ids":[ "tencent", "qq" ],
"person_id":"person0",
"url":"http://test-123456.image.myqcloud.com/test.jpg"
}
使用 image 的输入示例:
POST /face/newperson HTTP/1.1
Authorization: FCHXdPTEwMDAwMzc5Jms9QUtJRGVRZDBrRU1yM2J4ZjhRckJi==
Host: recognition.image.myqcloud.com
Content-Length: 735
Content-Type: multipart/form-data;boundary=--------------acebdf13572468
----------------acebdf13572468
Content-Disposition: form-data; name="appid";
123456
----------------acebdf13572468
Content-Disposition: form-data; name="group_ids[0]";
tencent
----------------acebdf13572468
Content-Disposition: form-data; name="group_ids[1]";
qq
----------------acebdf13572468
Content-Disposition: form-data; name="person_id";
person0
----------------acebdf13572468
Content-Disposition: form-data; name="image"; filename="test.jpg"
Content-Type: image/jpeg
xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
----------------acebdf13572468--
返回示例
HTTP/1.1 200 OK
Connection: keep-alive
Content-Length: 204
Content-Type: application/json
{
"data":{
"person_id":"person0",
"suc_group":2,
"suc_face":1,
"session_id":"",
"face_id":"1009550071676600319",
"group_ids":["tencent", "qq"]
},
"code":0,
"message":"OK"
}
删除个体
接口描述
接口请求示例:https://recognition.image.myqcloud.com/face/delperson
本接口(delperson)用于删除一个 Person。
注意:
- 本接口支持 HTTPS 协议,如果您现在使用的是 HTTP 协议,为了保障您的数据安全,请切换至 HTTPS。
- 如果开发者使用的是原域名(service.image.myqcloud.com)且已产生调用,则无需更换域名。
输入参数
请求头 header
参数名 | 必选 | 值 | 描述 |
---|---|---|---|
host | 是 | recognition.image.myqcloud.com | 腾讯云人脸识别服务器域名 |
content-length | 否 | 包体总长度 | 整个请求包体内容的总长度,单位:字节(Byte) |
content-type | 是 | application/json 或 multipart/form-data | 据不同接口选择: 1. 使用 application/json 格式,参数为 url,其值为图片的 url ; 2. 使用 multipart/form-data 格式,参数为 image,其值为图片的二进制内容。 |
authorization | 是 | 鉴权签名 | 多次有效签名,用于鉴权,生成方式见 鉴权签名方法 |
注意:选择 multipart/form-data,请使用 HTTP 框架/库推荐的方式设置请求的 content-type,不推荐直接调用 setHeader 等方法设置,否则可能导致 boundary 缺失引起请求失败。
请求参数
使用 application/json 格式
参数名 | 必选 | 类型 | 参数说明 |
---|---|---|---|
AppId | 是 | String | 项目 ID |
person_id | 是 | String | 待删除个体 ID |
输出参数
字段 | 类型 | 说明 |
---|---|---|
data.session_id | String | 相应请求的 session 标识符 |
data.person_id | String | 成功删除的 person_id |
data.deleted | Int | 成功删除的 person 数量 |
code | Int | 返回状态码 |
message | String | 返回错误消息 |
示例
输入示例
POST /face/delperson HTTP/1.1
Authorization: FCHXdPTEwMDAwMzc5Jms9QUtJRGVRZDBrRU1yM2J4ZjhRckJi==
Host: recognition.image.myqcloud.com
Content-Length: 66
Content-Type: application/json
{
"appid":"123456",
"person_id":"person0"
}
输出示例
HTTP/1.1 200 OK
Connection: keep-alive
Content-Length: 114
Content-Type: application/json
{
"data":{
"deleted": 1,
"person_id": "person0",
"session_id":""
},
"code":0,
"message":"OK"
}
增加人脸
接口描述
接口请求域名:https://recognition.image.myqcloud.com/face/addface
本接口(addface)用于将一组 face 加入到一个 person 中。一个 person 最多允许包含 20 个 face 。
注意:
- 加入相似度为[99%-100%]的人脸会返回错误。
- 本接口支持 HTTPS 协议,如果您现在使用的是 HTTP 协议,为了保障您的数据安全,请切换至 HTTPS。
- 如果开发者使用的是原域名(service.image.myqcloud.com)且已产生调用,则无需更换域名。
输入参数
请求头 header
参数名 | 必选 | 值 | 描述 |
---|---|---|---|
host | 是 | recognition.image.myqcloud.com | 腾讯云人脸识别服务器域名 |
content-length | 否 | 包体总长度 | 整个请求包体内容的总长度,单位:字节(Byte) |
content-type | 是 | application/json 或 multipart/form-data | 据不同接口选择: 1. 使用 application/json 格式,参数为 url,其值为图片的 url ; 2. 使用 multipart/form-data 格式,参数为 image,其值为图片的二进制内容。 |
authorization | 是 | 鉴权签名 | 鉴权签名,详见 签名与鉴权 |
注意:选择 multipart/form-data,请使用 HTTP 框架/库推荐的方式设置请求的 content-type,不推荐直接调用 setHeader 等方法设置,否则可能导致 boundary 缺失引起请求失败。
请求参数
使用 application/json 格式,参数选择 url ;使用multipart/form-data 格式,参数选择 image。
参数名 | 必选 | 类型 | 参数说明 |
---|---|---|---|
AppId | 是 | String | 接入项目的唯一标识,可在 账号信息 或 云 API 密钥 中查看。 |
person_id | 是 | String | 待增加人脸的个体 ID |
images | 否 | Array(Binary) | 图片内容 |
urls | 否 | String | 图片的 urls、image提供一个即可;如果都提供,只使用 urls |
tag | 否 | String | 备注信息 |
输出参数
字段 | 类型 | 说明 |
---|---|---|
data.session_id | String | 相应请求的 session 标识符 |
data.added | Int | 成功加入的 face 数量 |
data.face_ids | Array(String) | 增加的人脸 ID 列表 |
data.ret_codes | array(Int) | 每张图片增加人脸的返回码 |
code | Int | 返回状态码 |
message | String | 返回错误消息 |
示例
输入示例
使用 url 的输入示例:
POST /face/addface HTTP/1.1
Authorization: FCHXdPTEwMDAwMzc5Jms9QUtJRGVRZDBrRU1yM2J4ZjhRckJi==
Host: recognition.image.myqcloud.com
Content-Length: 191
Content-Type: application/json
{
"appid":"123456",
"person_id":"person0",
"urls":[
"http://test-123456.image.myqcloud.com/face1.jpg",
"http://test-123456.image.myqcloud.com/face2.jpg"
]
}
使用 image 的输入示例:
POST /face/addface HTTP/1.1
Authorization: FCHXdPTEwMDAwMzc5Jms9QUtJRGVRZDBrRU1yM2J4ZjhRckJi==
Host: recognition.image.myqcloud.com
Content-Length: 641
Content-Type: multipart/form-data;boundary=--------------acebdf13572468
----------------acebdf13572468
Content-Disposition: form-data; name="appid";
123456
----------------acebdf13572468
Content-Disposition: form-data; name="person_id";
person0
----------------acebdf13572468
Content-Disposition: form-data; name="images[0]"; filename="face1.jpg"
Content-Type: image/jpeg
yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy
----------------acebdf13572468
Content-Disposition: form-data; name="images[1]"; filename="face2.jpg"
Content-Type: image/jpeg
xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
----------------acebdf13572468--
输出示例
HTTP/1.1 200 OK
Connection: keep-alive
Content-Length: 168
Content-Type: application/json
{
"data":{
"added":2,
"session_id":"",
"face_ids":["1009550071676600319","109387462576600319"],
"ret_codes":[0, 0]
},
"code":0,
"message":"OK"
}
删除人脸
接口描述
接口请求域名:https://recognition.image.myqcloud.com/face/delface
本接口(delface)用于删除一个 person 下的 face ,包括特征、属性和 face id。
注意:
- 本接口支持 HTTPS 协议,如果您现在使用的是 HTTP 协议,为了保障您的数据安全,请切换至 HTTPS。
- 如果开发者使用的是原域名(service.image.myqcloud.com)且已产生调用,则无需更换域名。
输入参数
请求头 header
参数名 | 必选 | 值 | 描述 |
---|---|---|---|
host | 是 | recognition.image.myqcloud.com | 腾讯云人脸识别服务器域名 |
content-length | 否 | 包体总长度 | 整个请求包体内容的总长度,单位:字节(Byte) |
content-type | 是 | application/json 或 multipart/form-data | 据不同接口选择: 1. 使用 application/json 格式,参数为 url,其值为图片的 url ; 2. 使用 multipart/form-data 格式,参数为 image,其值为图片的二进制内容。 |
authorization | 是 | 鉴权签名 | 鉴权签名,详见 签名与鉴权 |
注意:选择 multipart/form-data,请使用 HTTP 框架/库推荐的方式设置请求的 content-type,不推荐直接调用 setHeader 等方法设置,否则可能导致 boundary 缺失引起请求失败。
请求参数
使用 application/json 格式
参数名 | 必选 | 类型 | 参数说明 |
---|---|---|---|
AppId | 是 | String | 项目 ID |
person_id | 是 | String | 待删除人脸的 person id |
face_ids | 是 | Array(String) | 删除人脸 ID 的列表 |
输出参数
字段 | 类型 | 说明 |
---|---|---|
data.session_id | String | 相应请求的 session 标识符 |
data.deleted | Int | 成功删除的 face 数量 |
data.face_ids | Array(String) | 成功删除的 face_id 列表 |
code | Int | 返回状态码 |
message | String | 返回错误消息 |
示例
输入示例
POST /face/delface HTTP/1.1
Authorization: FCHXdPTEwMDAwMzc5Jms9QUtJRGVRZDBrRU1yM2J4ZjhRckJi==
Host: recognition.image.myqcloud.com
Content-Length: 125
Content-Type: application/json
{
"appid":"123456",
"person_id":"person0",
"face_ids":[
"199d1efd19ce4ee67a7ec7655f859b1a"
]
}
输出示例
HTTP/1.1 200 OK
Connection: keep-alive
Content-Length: 150
Content-Type: application/json
{
"data":{
"deleted": 1,
"face_ids":[
"199d1efd19ce4ee67a7ec7655f859b1a"
],
"session_id":""
},
"code":0,
"message":"OK"
}
设置信息
接口描述
接口请求域名:https://recognition.image.myqcloud.com/face/setinfo
本接口(setinfo)用于设置 person 的 name 。
注意:
- 本接口支持 HTTPS 协议,如果您现在使用的是 HTTP 协议,为了保障您的数据安全,请切换至 HTTPS。
- 如果开发者使用的是原域名(service.image.myqcloud.com)且已产生调用,则无需更换域名。
输入参数
请求头 header
参数名 | 必选 | 值 | 描述 |
---|---|---|---|
host | 是 | recognition.image.myqcloud.com | 腾讯云人脸识别服务器域名 |
content-length | 否 | 包体总长度 | 整个请求包体内容的总长度,单位:字节(Byte) |
content-type | 是 | application/json 或 multipart/form-data | 据不同接口选择: 1. 使用 application/json 格式,参数为 url,其值为图片的 url ; 2. 使用 multipart/form-data 格式,参数为 image,其值为图片的二进制内容。 |
authorization | 是 | 鉴权签名 | 鉴权签名,详见 签名与鉴权 |
注意:选择 multipart/form-data,请使用 HTTP 框架/库推荐的方式设置请求的 content-type,不推荐直接调用 setHeader 等方法设置,否则可能导致 boundary 缺失引起请求失败。
请求参数
使用 application/json 格式
参数名 | 必选 | 类型 | 参数说明 |
---|---|---|---|
AppId | 是 | String | 项目 ID |
person_id | 是 | String | 相应 person 的 ID |
person_name | 否 | String | 新的 name |
tag | 否 | String | 备注信息 |
输出参数
字段 | 类型 | 说明 |
---|---|---|
data.session_id | String | 相应请求的 session 标识符 |
data.person_id | String | 相应 person 的 ID |
code | Int | 返回状态码 |
message | String | 返回错误消息 |
示例
输入示例
POST /face/setinfo HTTP/1.1
Authorization: FCHXdPTEwMDAwMzc5Jms9QUtJRGVRZDBrRU1yM2J4ZjhRckJi==
Host: recognition.image.myqcloud.com
Content-Length: 97
Content-Type: application/json
{
"appid":"123456",
"person_id":"person0",
"person_name":"NicolasCage"
}
输出示例
HTTP/1.1 200 OK
Connection: keep-alive
Content-Length: 96
Content-Type: application/json
{
"data":{
"person_id": "person0",
"session_id":""
},
"code":0,
"message":"OK"
}
获取信息
接口描述
接口请求域名:https://recognition.image.myqcloud.com/face/getinfo
本接口(getinfo)用于获取一个 person 的信息, 包括 name , ID , tag , 相关的 face , 以及 groups 等信息。
注意:
- 本接口支持 HTTPS 协议,如果您现在使用的是 HTTP 协议,为了保障您的数据安全,请切换至 HTTPS。
- 如果开发者使用的是原域名(service.image.myqcloud.com)且已产生调用,则无需更换域名。
输入参数
请求头 header
参数名 | 必选 | 值 | 描述 |
---|---|---|---|
host | 是 | recognition.image.myqcloud.com | 腾讯云人脸识别服务器域名 |
content-length | 否 | 包体总长度 | 整个请求包体内容的总长度,单位:字节(Byte) |
content-type | 是 | application/json 或 multipart/form-data | 据不同接口选择: 1. 使用 application/json 格式,参数为 url,其值为图片的 url ; 2. 使用 multipart/form-data 格式,参数为 image,其值为图片的二进制内容。 |
authorization | 是 | 鉴权签名 | 鉴权签名,详见 签名与鉴权 |
注意:选择 multipart/form-data,请使用 HTTP 框架/库推荐的方式设置请求的 content-type,不推荐直接调用 setHeader 等方法设置,否则可能导致 boundary 缺失引起请求失败。
请求参数
使用 application/json 格式
参数名 | 必选 | 类型 | 参数说明 |
---|---|---|---|
AppId | 是 | String | 项目 ID |
person_id | 是 | String | 待查询个体的 ID |
输出参数
字段 | 类型 | 说明 |
---|---|---|
data.person_name | String | 相应 person 的 name |
data.person_id | String | 相应 person 的 ID |
data.face_ids | Array(String) | 包含的人脸列表 |
data.group_ids | Array(String) | 包含此个体的组 ID |
data.session_id | String | 相应请求的 session 标识符 |
data.tag | String | 为此个体设置的备注信息 |
code | Int | 返回状态码 |
message | String | 返回错误消息 |
示例
输入示例
POST /face/getinfo HTTP/1.1
Authorization: FCHXdPTEwMDAwMzc5Jms9QUtJRGVRZDBrRU1yM2J4ZjhRckJi==
Host: recognition.image.myqcloud.com
Content-Length: 66
Content-Type: application/json
{
"appid":"123456",
"person_id":"person0"
}
输出示例
HTTP/1.1 200 OK
Connection: keep-alive
Content-Length: 293
Content-Type: application/json
{
"data":{
"person_id": "person0",
"person_name": "NicolasCage",
"face_ids": [
"199d1efd19ce4ee67a7ec7655f859b1a",
"19321efd19ce4ee67a7127655f85934a"
],
"group_ids":[
"tencent"
],
"tag":"",
"session_id":""
},
"code":0,
"message":"OK"
}
获取组列表
接口描述
接口请求域名:https://recognition.image.myqcloud.com/face/getgroupids
本接口(getgroupids)用于获取一个 AppID 下所有 group 列表。
注意:
- 本接口支持 HTTPS 协议,如果您现在使用的是 HTTP 协议,为了保障您的数据安全,请切换至 HTTPS。
- 如果开发者使用的是原域名(service.image.myqcloud.com)且已产生调用,则无需更换域名。
输入参数
请求头 header
参数名 | 必选 | 值 | 描述 |
---|---|---|---|
host | 是 | recognition.image.myqcloud.com | 腾讯云人脸识别服务器域名 |
content-length | 否 | 包体总长度 | 整个请求包体内容的总长度,单位:字节(Byte) |
content-type | 是 | application/json 或 multipart/form-data | 据不同接口选择: 1. 使用 application/json 格式,参数为 url,其值为图片的 url ; 2. 使用 multipart/form-data 格式,参数为 image,其值为图片的二进制内容。 |
authorization | 是 | 鉴权签名 | 鉴权签名,详见 签名与鉴权 |
注意:选择 multipart/form-data,请使用 HTTP 框架/库推荐的方式设置请求的 content-type,不推荐直接调用 setHeader 等方法设置,否则可能导致 boundary 缺失引起请求失败。
请求参数
使用 application/json 格式
参数名 | 必选 | 类型 | 参数说明 |
---|---|---|---|
AppId | 是 | String | 项目 ID |
输出参数
字段 | 类型 | 说明 |
---|---|---|
data.group_ids | Array(String) | 相应 AppId 的 group_id 列表 |
code | Int | 返回状态码 |
message | String | 返回错误消息 |
示例
输入示例
POST /face/getgroupids HTTP/1.1
Authorization: FCHXdPTEwMDAwMzc5Jms9QUtJRGVRZDBrRU1yM2J4ZjhRckJi==
Host: recognition.image.myqcloud.com
Content-Length: 41
Content-Type: application/json
{
"appid":"123456"
}
输出示例
HTTP/1.1 200 OK
Connection: keep-alive
Content-Length: 136
Content-Type: application/json
{
"data":{
"group_ids": [
"tencent",
"tencent-beijing",
"tencent-shanghai"
]
},
"code":0,
"message":"OK"
}
获取人列表
接口描述
接口请求域名:https://recognition.image.myqcloud.com/face/getpersonids
本接口(getpersonids)用于获取一个组 group 中所有 person 列表。
注意:
- 本接口支持 HTTPS 协议,如果您现在使用的是 HTTP 协议,为了保障您的数据安全,请切换至 HTTPS。
- 如果开发者使用的是原域名(service.image.myqcloud.com)且已产生调用,则无需更换域名。
输入参数
请求头 header
参数名 | 必选 | 值 | 描述 |
---|---|---|---|
host | 是 | recognition.image.myqcloud.com | 腾讯云人脸识别服务器域名 |
content-length | 否 | 包体总长度 | 整个请求包体内容的总长度,单位:字节(Byte) |
content-type | 是 | application/json 或 multipart/form-data | 据不同接口选择: 1. 使用 application/json 格式,参数为 url,其值为图片的 url ; 2. 使用 multipart/form-data 格式,参数为 image,其值为图片的二进制内容。 |
authorization | 是 | 鉴权签名 | 鉴权签名,详见 签名与鉴权 |
注意:选择 multipart/form-data,请使用 HTTP 框架/库推荐的方式设置请求的 content-type,不推荐直接调用 setHeader 等方法设置,否则可能导致 boundary 缺失引起请求失败。
请求参数
使用 application/json 格式
参数名 | 必选 | 类型 | 参数说明 |
---|---|---|---|
AppId | 是 | String | 项目 ID |
group_id | 是 | String | 组 ID |
输出参数
字段 | 类型 | 说明 |
---|---|---|
data.person_ids | Array(String) | 相应 person 的 ID 列表 |
code | Int | 返回状态码 |
message | String | 返回错误消息 |
示例
输入示例
POST /face/getpersonids HTTP/1.1
Authorization: FCHXdPTEwMDAwMzc5Jms9QUtJRGVRZDBrRU1yM2J4ZjhRckJi==
Host: recognition.image.myqcloud.com
Content-Length: 65
Content-Type: application/json
{
"appid":"123456",
"group_id":"tencent"
}
输出示例
HTTP/1.1 200 OK
Connection: keep-alive
Content-Length: 120
Content-Type: application/json
{
"data":{
"person_ids": [
"person0",
"person1",
"person2"
]
},
"code":0,
"message":"OK"
}
获取人脸列表
接口描述
接口请求域名:https://recognition.image.myqcloud.com/face/getfaceids
本接口(getfaceids)用于获取一个组 person 中所有 face 列表。
注意:
- 本接口支持 HTTPS 协议,如果您现在使用的是 HTTP 协议,为了保障您的数据安全,请切换至 HTTPS。
- 如果开发者使用的是原域名(service.image.myqcloud.com)且已产生调用,则无需更换域名。
输入参数
请求头 header
参数名 | 必选 | 值 | 描述 |
---|---|---|---|
host | 是 | recognition.image.myqcloud.com | 腾讯云人脸识别服务器域名 |
content-length | 否 | 包体总长度 | 整个请求包体内容的总长度,单位:字节(Byte) |
content-type | 是 | application/json 或 multipart/form-data | 据不同接口选择: 1. 使用 application/json 格式,参数为 url,其值为图片的 url ; 2. 使用 multipart/form-data 格式,参数为 image,其值为图片的二进制内容。 |
authorization | 是 | 鉴权签名 | 鉴权签名,详见 签名与鉴权 |
注意:选择 multipart/form-data,请使用 HTTP 框架/库推荐的方式设置请求的 content-type,不推荐直接调用 setHeader 等方法设置,否则可能导致 boundary 缺失引起请求失败。
请求参数
使用 application/json 格式
参数名 | 必选 | 类型 | 参数说明 |
---|---|---|---|
AppId | 是 | String | 项目 ID |
person_id | 是 | String | 个体 ID |
输出参数
字段 | 类型 | 说明 |
---|---|---|
data.face_ids | Array(String) | 相应 face 的 ID 列表 |
code | Int | 返回状态码 |
message | String | 返回错误消息 |
示例
输入示例
POST /face/getfaceids HTTP/1.1
Authorization: FCHXdPTEwMDAwMzc5Jms9QUtJRGVRZDBrRU1yM2J4ZjhRckJi==
Host: recognition.image.myqcloud.com
Content-Length: 66
Content-Type: application/json
{
"appid":"123456",
"person_id":"person1"
}
输出示例
HTTP/1.1 200 OK
Connection: keep-alive
Content-Length: 154
Content-Type: application/json
{
"data":{
"face_ids": [
"1005338790489817087",
"1005338790489817088",
"1005338790489817089"
]
},
"code":0,
"message":"OK"
}
获取人脸信息
接口描述
接口请求域名:https://recognition.image.myqcloud.com/face/getfaceinfo
本接口(getfaceinfo)用于获取一个 face 的相关特征信息。
注意:
- 本接口支持 HTTPS 协议,如果您现在使用的是 HTTP 协议,为了保障您的数据安全,请切换至 HTTPS。
- 如果开发者使用的是原域名(service.image.myqcloud.com)且已产生调用,则无需更换域名。
输入参数
请求头 header
参数名 | 必选 | 值 | 描述 |
---|---|---|---|
host | 是 | recognition.image.myqcloud.com | 腾讯云人脸识别服务器域名 |
content-length | 否 | 包体总长度 | 整个请求包体内容的总长度,单位:字节(Byte) |
content-type | 是 | application/json 或 multipart/form-data | 据不同接口选择: 1. 使用 application/json 格式,参数为 url,其值为图片的 url ; 2. 使用 multipart/form-data 格式,参数为 image,其值为图片的二进制内容。 |
authorization | 是 | 鉴权签名 | 鉴权签名,详见 签名与鉴权 |
注意:选择 multipart/form-data,请使用 HTTP 框架/库推荐的方式设置请求的 content-type,不推荐直接调用 setHeader 等方法设置,否则可能导致 boundary 缺失引起请求失败。
请求参数
使用 application/json 格式
参数名 | 必选 | 类型 | 参数说明 |
---|---|---|---|
AppId | 是 | String | 项目 ID |
face_id | 是 | String | 人脸 ID |
输出参数
字段 | 类型 | 说明 |
---|---|---|
data.face_info | faceItem | 人脸信息 |
code | Int | 返回状态码 |
message | String | 返回错误消息 |
faceItem 说明
字段 | 类型 | 说明 |
---|---|---|
face_id | String | 人脸标识 |
x | Int | 人脸框左上角 x |
y | Int | 人脸框左上角 y |
width | Float | 人脸框宽度 |
height | Float | 人脸框高度 |
gender | Int | 性别 [0(female)~100(male)] |
age | Int | 年龄 [0~100] |
expression | Int | 微笑[0(normal) |
glass | Bool | 是否有眼镜 [true,false] |
pitch | Int | 上下偏移[-30,30] |
yaw | Int | 左右偏移[-30,30] |
roll | Int | 平面旋转[-180,180] |
示例
输入示例
POST /face/getfaceinfo HTTP/1.1
Authorization: FCHXdPTEwMDAwMzc5Jms9QUtJRGVRZDBrRU1yM2J4ZjhRckJi==
Host: recognition.image.myqcloud.com
Content-Length: 76
Content-Type: application/json
{
"appid":"123456",
"face_id":"1005338790489817087"
}
输出示例
HTTP/1.1 200 OK
Connection: keep-alive
Content-Length: 313
Content-Type: application/json
{
"data":{
"face_info": {
"face_id": "1005338790489817087",
"x": 44,
"y": 33,
"height": 64.0,
"width": 64.0,
"pitch": 5,
"roll": 0,
"yaw": 6,
"age": 37,
"gender": 99,
"glass": true,
"expression": 6
}
},
"code":0,
"message":"OK"
}
Person 新增组信息
接口描述
接口请求域名:https://recognition.image.myqcloud.com/face/addgroupids
本接口(addgroupids)用于为一个 person 新增 group_id。
注意:
- 本接口支持 HTTPS 协议,如果您现在使用的是 HTTP 协议,为了保障您的数据安全,请切换至 HTTPS。
- 如果开发者使用的是原域名(service.image.myqcloud.com)且已产生调用,则无需更换域名。
输入参数
请求头 header
参数名 | 必选 | 值 | 描述 |
---|---|---|---|
host | 是 | recognition.image.myqcloud.com | 腾讯云人脸识别服务器域名 |
content-length | 否 | 包体总长度 | 整个请求包体内容的总长度,单位:字节(Byte) |
content-type | 是 | application/json 或 multipart/form-data | 据不同接口选择: 1. 使用 application/json 格式,参数为 url,其值为图片的 url ; 2. 使用 multipart/form-data 格式,参数为 image,其值为图片的二进制内容。 |
authorization | 是 | 鉴权签名 | 多次有效签名,用于鉴权,生成方式见 鉴权签名方法 |
注意:选择 multipart/form-data,请使用 HTTP 框架/库推荐的方式设置请求的 content-type,不推荐直接调用 setHeader 等方法设置,否则可能导致 boundary 缺失引起请求失败。
请求参数
使用 application/json 格式
参数名 | 必选 | 类型 | 参数说明 |
---|---|---|---|
AppId | 是 | String | 项目 ID |
person_id | 是 | String | 人脸 ID |
group_ids | 是 | Array | group ID |
session_id | 否 | String | 会话 ID |
输出参数
字段 | 类型 | 说明 |
---|---|---|
data | groupsAddItem | 结果信息 |
code | Int | 返回状态码 |
message | String | 返回错误消息 |
groupsAddItem 说明
字段 | 类型 | 说明 |
---|---|---|
person_id | String | person ID |
added | Int | 成功新增组数 |
group_ids | Array | 当前人所在组信息 |
session_id | String | 会话 ID |
Person 删除组信息
接口描述
接口请求域名:https://recognition.image.myqcloud.com/face/delgroupids
本接口(delgroupids)用于为一个 person 删除 group_id。
注意:
- 本接口支持 HTTPS 协议,如果您现在使用的是 HTTP 协议,为了保障您的数据安全,请切换至 HTTPS。
- 如果开发者使用的是原域名(service.image.myqcloud.com)且已产生调用,则无需更换域名。
输入参数
请求头 header
参数名 | 必选 | 值 | 描述 |
---|---|---|---|
host | 是 | recognition.image.myqcloud.com | 腾讯云人脸识别服务器域名 |
content-length | 否 | 包体总长度 | 整个请求包体内容的总长度,单位:字节(Byte) |
content-type | 是 | application/json 或 multipart/form-data | 据不同接口选择: 1. 使用 application/json 格式,参数为 url,其值为图片的 url ; 2. 使用 multipart/form-data 格式,参数为 image,其值为图片的二进制内容。 |
authorization | 是 | 鉴权签名 | 鉴权签名,详见 签名与鉴权 |
注意:选择 multipart/form-data,请使用 HTTP 框架/库推荐的方式设置请求的 content-type,不推荐直接调用 setHeader 等方法设置,否则可能导致 boundary 缺失引起请求失败。
请求参数
使用 application/json 格式
参数名 | 必选 | 类型 | 参数说明 |
---|---|---|---|
AppId | 是 | String | 项目 ID |
person_id | 是 | String | 人脸 ID |
group_ids | 是 | Array | group ID |
session_id | 否 | String | 会话 ID |
输出参数
字段 | 类型 | 说明 |
---|---|---|
data | groupsadditem | 结果信息 |
code | Int | 返回状态码 |
message | String | 返回错误消息 |
Groupsadditem 说明
字段 | 类型 | 说明 |
---|---|---|
person_id | String | personId |
deleted | Int | 成功删除组数 |
group_ids | Array | 当前人所在组信息 |
session_id | String | 会话 ID |
错误码
错误码 | 含义 |
---|---|
3 | 错误的请求;其中 message:account abnormal,errorno is:2为账号欠费停服 |
4 | 签名为空 |
5 | 签名串错误 |
6 | 签名中的 AppID/存储桶与操作目标不匹配 |
9 | 签名过期 |
10 | AppID 不存在 |
11 | SecretId 不存在 |
12 | APPID 和 SecretId 不匹配 |
13 | 重放攻击 |
14 | 签名校验失败 |
15 | 操作太频繁,触发频控 |
16 | 存储桶不存在 |
21 | 无效参数 |
23 | 请求包体过大 |
24 | 本接口即将下线,请使用 新版人脸识别 |
107 | 鉴权服务不可用 |
108 | 鉴权服务不可用 |
213 | 内部错误 |
-1101 | 人脸检测失败 |
-1102 | 图片解码失败 |
-1103 | 特征处理失败 |
-1104 | 提取轮廓错误 |
-1105 | 提取性别错误 |
-1106 | 提取表情错误 |
-1107 | 提取年龄错误 |
-1108 | 提取姿态错误 |
-1109 | 提取眼镜错误 |
-1200 | 特征存储错误 |
-1300 | 图片为空 |
-1301 | 参数为空 |
-1302 | 个体已存在 |
-1303 | 个体不存在 |
-1304 | 参数过长 |
-1305 | 人脸不存在 |
-1306 | 组不存在 |
-1307 | 组列表不存在 |
-1308 | url 图片下载失败 |
-1309 | 人脸个数超过限制 |
-1310 | 个体个数超过限制 |
-1311 | 组个数超过限制 |
-1312 | 对个体添加了相似度为99%及以上的人脸 |
-1313 | 参数不合法(特殊字符例如空格、斜线、tab、换行符) |
-1400 | 非法的图片格式 |
-1403 | 图片下载失败 |
更多其他 API 错误码请查看 错误码说明 。