你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Large Person Group Person - List
列出大型人员组中的所有人员,并检索人员信息 (包括人员) 的已注册人脸的 personId、姓名、userData 和 persistedFaceIds。
GET {Endpoint}/face/v1.0/largepersongroups/{largePersonGroupId}/persons
GET {Endpoint}/face/v1.0/largepersongroups/{largePersonGroupId}/persons?start={start}&top={top}
URI 参数
名称 | 在 | 必需 | 类型 | 说明 |
---|---|---|---|---|
Endpoint
|
path | True |
string |
支持的认知服务终结点 (协议和主机名,例如: https://westus.api.cognitive.microsoft.com) 。 |
large
|
path | True |
string |
引用特定大型人员组的 ID。 Regex pattern: |
start
|
query |
string |
启动人员 ID 以返回用于列出) 人员范围的 (。 |
|
top
|
query |
integer |
以“start”参数指示的人员 ID 开始返回的人员数。 |
请求头
名称 | 必需 | 类型 | 说明 |
---|---|---|---|
Ocp-Apim-Subscription-Key | True |
string |
响应
名称 | 类型 | 说明 |
---|---|---|
200 OK |
Person[] |
成功的调用将返回属于大型人员组的人员信息数组。 |
Other Status Codes |
错误响应。 |
安全性
Ocp-Apim-Subscription-Key
Type:
apiKey
In:
header
示例
List persons in person group
Sample Request
GET {Endpoint}/face/v1.0/largepersongroups/abc/persons?start=25985303-c537-4467-b41d-bdb45cd95ca1&top=2
Sample Response
[
{
"personId": "25985303-c537-4467-b41d-bdb45cd95ca1",
"name": "person-name1",
"userData": "User-provided data attached to the person.",
"persistedFaceIds": [
"015839fb-fbd9-4f79-ace9-7675fc2f1dd9",
"fce92aed-d578-4d2e-8114-068f8af4492e",
"b64d5e15-8257-4af2-b20a-5a750f8940e7"
]
},
{
"personId": "2ae4935b-9659-44c3-977f-61fac20d0538",
"name": "person-name2",
"userData": "User-provided data attached to the person.",
"persistedFaceIds": [
"30ea1073-cc9e-4652-b1e3-d08fb7b95315",
"fbd2a038-dbff-452c-8e79-2ee81b1aa84e"
]
}
]
定义
名称 | 说明 |
---|---|
APIError |
API 返回的错误信息 |
Error |
错误正文。 |
Person |
Person 对象。 |
APIError
API 返回的错误信息
名称 | 类型 | 说明 |
---|---|---|
error |
错误正文。 |
Error
错误正文。
名称 | 类型 | 说明 |
---|---|---|
code |
string |
|
message |
string |
Person
Person 对象。
名称 | 类型 | 说明 |
---|---|---|
name |
string |
用户定义的名称,最大长度为 128。 |
persistedFaceIds |
string[] |
人员中已注册人脸的 PersistedFaceIds。 这些 persistedFaceId 从 Person - Add a Person Face 返回,并且不会过期。 |
personId |
string |
目标人脸列表的 PersonId。 |
userData |
string |
用户指定的数据。 长度不应超过 16KB。 |