Large Person Group - List

服务:

Azure AI Services

API 版本:

1.0

列出所有现有大型人员组的 largePersonGroupId、name、userData 和 recognitionModel。

• 大型人员组按字母顺序存储 largePersonGroupId。
• “start”参数（字符串，可选）是用户提供的 largePersonGroupId 值，返回的条目通过字符串比较具有较大的 ID。 “start”设置为空，指示从第一个项目返回。
• “top”参数（int，可选）指定要返回的条目数。 一次调用中可以返回 1000 个条目的最大值。 若要提取更多内容，可以使用上次返回条目的当前调用 ID 指定“start”。
  例如，总共 5 个大人员组：“group1”、“...”、“group5”。
  “start=&top=”将返回所有 5 个组。
  “start=&top=2”将返回“group1”、“group2”。
  “start=group2&top=3”将返回“group3”、“group4”、“group5”。

GET {Endpoint}/face/v1.0/largepersongroups

具有可选参数:

GET {Endpoint}/face/v1.0/largepersongroups?start={start}&top={top}&returnRecognitionModel={returnRecognitionModel}

URI 参数

名称	在	必需	类型	说明
Endpoint	path	True	string	支持的认知服务终结点（协议和主机名，例如：https://westus.api.cognitive.microsoft.com）。
returnRecognitionModel	query		boolean	一个值，该值指示作是否应在响应中返回“recognitionModel”。
start	query		string maxLength: 64	列出大于“start”的最小 largePersonGroupId 中的大型人员组。
top	query		integer minimum: 1 maximum: 1000	要列出的大型人员组数。

请求头

名称	必需	类型	说明
Ocp-Apim-Subscription-Key	True	string

响应

名称	类型	说明
200 OK	LargePersonGroup[]	成功的呼叫返回一组大型人员组及其信息。
Other Status Codes	APIError	错误响应。

安全性

Ocp-Apim-Subscription-Key

类型: apiKey
在: header

示例

List large person groups example

示例请求

HTTP

GET {Endpoint}/face/v1.0/largepersongroups?start=sample_group&top=2&returnRecognitionModel=True

示例响应

状态代码:

200

[
  {
    "largePersonGroupId": "f92f6f1b-3258-4444-8fa2-c2df505cc7ac",
    "name": "large-person-group-name1",
    "userData": "User-provided data attached to the large person group.",
    "recognitionModel": "recognition_01"
  },
  {
    "largePersonGroupId": "c76f7f13-0ed3-4d00-8a3e-2ad3d78f6c37",
    "name": "large-person-group-name2",
    "userData": "User-provided data attached to the large person group.",
    "recognitionModel": "recognition_01"
  }
]

定义

名称	说明
APIError	API 返回的错误信息
Error	错误正文。
LargePersonGroup	大型人员组对象。
RecognitionModel	识别模型的名称。 提取人脸特征并与检测到的 faceId、（Large）FaceList 或 （Large）PersonGroup 相关联时，将使用识别模型。 执行人脸 - 检测或 （大型）FaceList - 创建或 （大型）PersonGroup - 创建时，可以提供识别模型名称。 默认值为“recognition_01”，如果需要最新模型，请显式指定所需的模型。

APIError

Object

API 返回的错误信息

名称	类型	说明
error	Error	错误正文。

Error

Object

错误正文。

名称	类型	说明
code	string
message	string

LargePersonGroup

Object

大型人员组对象。

名称	类型	默认值	说明
largePersonGroupId	string maxLength: 64 pattern: ^[a-z0-9-_]+$		目标大型人员组的 LargePersonGroupId
name	string minLength: 1 maxLength: 128		用户定义的名称，最大长度为 128。
recognitionModel	RecognitionModel	recognition_01	识别模型的名称。 提取人脸特征并与检测到的 faceId、（Large）FaceList 或 （Large）PersonGroup 相关联时，将使用识别模型。 执行人脸 - 检测或 （大型）FaceList - 创建或 （大型）PersonGroup - 创建时，可以提供识别模型名称。 默认值为“recognition_01”，如果需要最新模型，请显式指定所需的模型。
userData	string maxLength: 16384		用户指定的数据。 长度不应超过 16KB。

RecognitionModel

枚举

识别模型的名称。 提取人脸特征并与检测到的 faceId、（Large）FaceList 或 （Large）PersonGroup 相关联时，将使用识别模型。 执行人脸 - 检测或 （大型）FaceList - 创建或 （大型）PersonGroup - 创建时，可以提供识别模型名称。 默认值为“recognition_01”，如果需要最新模型，请显式指定所需的模型。

值	说明
recognition_01
recognition_02
recognition_03
recognition_04